neo4j_ancestry

Neo4jAncestry

This ruby on rails gem makes it easy to store polymorphic structure information --- parents, children, ancestors, descendants, ... --- in a neo4j graph database parallel to using ActiveRecord.

All relevant information is stored in your default ActiveRecord database, including the parent-child relationships. But, in addition, the structure information is also stored in a neo4j graph database in order to use its power of fast graph traversing queries.

Usage

TODO: Write usage instructions here

Installation

Add the gem to your application's Gemfile:

# Gemfile
# ...
gem 'neo4j_ancestry'

And then execute:

# bash
bundle install

Install the neo4j database db directory and start the deamon:

# bash
bundle exec rake neo4j:install neo4j:setup neo4j:start

Next, migrate the database in order to add the neccessary tables.

# bash
bundle exec rake neo4j_ancestry:install:migrations
bundle exec rake db:migrate

Underlying Technology

• The neo4j graph database
• The neography gem is used as datbase interface.
• The neoid gem is used for database abstraction in parallel to ActiveRecord.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Running the Gem's Specs Locally

Symlink the Gemfile according to the Rails version you would like to use:

# bash
rm Gemfile Gemfile.lock
ln -s rails3.2.Gemfile Gemfile   # for Rails 3
ln -s rails4.Gemfile Gemfile     # for Rails 4  (default)

Next, install the dependencies and run the specs.

# bash
bundle install
bundle exec rake neo4j_ancestry:db:test:prepare
bundle exec rake

Author, License

(c) 2013, Sebastian Fiedlschuster

Released under the MIT License.