<commit_before>= NuoDB/Ruby Interface

== DESCRIPTION

This is the NuoDB API module for Ruby. It integrates the NuoDB C++
library into Ruby.

== BUILDING THE GEM

To compile and test run this command:

    rake build

== INSTALLING THE GEM

    NUODB_ROOT=/Users/rbuck/tmp/nuodb gem install nuodb-1.0.0.gem

Or from the source tree:

    NUODB_ROOT=/Users/rbuck/tmp/nuodb gem install pkg/nuodb-1.0.0.gem

== TESTING THE GEM

Start up a minimal chorus as follows:

    java -jar nuoagent.jar --broker &
    ./nuodb --chorus test --password <PASSWORD> --dba-user dba --dba-password <PASSWORD> &

Create a user in the database:

    ./nuosql test@localhost --user dba --password <PASSWORD>
    > create user cloud password '<PASSWORD>';
    > exit

Run the tests:

    rake test

== INSPECTING THE GEM

It is often useful to inspect the contents of a Gem before distribution.
To do this you dump the contents of a gem thus:

    gem unpack pkg/nuodb-1.0.0.gem

== INSPECTING THE EXPORTED SYMBOLS

    nm -gU ext/nuodb/nuodb.bundle

== REFERENCES

    extensions :: http://java.ociweb.com/mark/NFJS/RubyCExtensions.pdf<commit_msg>Cleanup README formatting for the NuoDB native Ruby driver.<commit_after>= NuoDB/Ruby Interface

== DESCRIPTION

This is the NuoDB API module for Ruby. It integrates the NuoDB C++
library into Ruby.

== BUILDING THE GEM

To compile and test run this command:

    rake build

== INSTALLING THE GEM

    NUODB_ROOT=/Users/rbuck/tmp/nuodb gem install nuodb-1.0.0.gem

Or from the source tree:

    NUODB_ROOT=/Users/rbuck/tmp/nuodb gem install pkg/nuodb-1.0.0.gem

== TESTING THE GEM

Start up a minimal chorus as follows:

    java -jar nuoagent.jar --broker &
    ./nuodb --chorus test --password <PASSWORD> --dba-user dba --dba-password <PASSWORD> &

Create a user in the database:

    ./nuosql test@localhost --user dba --password <PASSWORD>
    > create user cloud password '<PASSWORD>';
    > exit

Run the tests:

    rake test

== INSPECTING THE GEM

It is often useful to inspect the contents of a Gem before distribution.
To do this you dump the contents of a gem thus:

    gem unpack pkg/nuodb-1.0.0.gem

== INSPECTING THE EXPORTED SYMBOLS

    nm -gU ext/nuodb/nuodb.bundle

== REFERENCES

extensions :: http://java.ociweb.com/mark/NFJS/RubyCExtensions.pdf
{'fraction_non_alphanumeric': 0.0937227550130776, 'fraction_numerical': 0.007846556233653008, 'mean_word_length': 3.1129032258064515, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 15, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5170824', 'n_tokens_mistral': 839, 'n_tokens_neox': 764, 'n_words': 275}