The gem is not Production Ready™.

Neoon

A simple Ruby wrapper for Neo4j with focus on Cypher and the features of Neo4j 2.0

Inspired by Neoid

Installation

Add this line to your application's Gemfile:

gem 'neoon'

And then execute:

$ bundle

Or install it yourself as:

$ gem install neoon

Usage

First you have to initialize a client:

ENV["NEO4J_URL"] ||= "http://localhost:7474"

$neo = Neoon.client ENV["NEO4J_URL"]

Set configuration:

Neoon.configure do |config|
  config.preload_models = true # (default: false) This will load your models — so to update the indexes at the (Rails) boot
end

To query using Cypher:

$neo.q("START node=node(*) RETURN node")

To your ActiveRecord model, initialize Neoon like so (with example of using properties/index):

class Topic < ActiveRecord::Base

  include Neoon::Node

  neoon do |c|
    c.property :name
    c.property :slug, :index => true do
      "#{self.id}-#{self.name.underscore}"
    end
  end

end

Indexing

This will be used internally to auto indexing the model depends on what described in the neoon model config.

Neoon.db.list 'Topic' #=> ["slug"]

Neoon.db.create 'Topic', [:name, ...]

Neoon.db.drop 'Topic' [:name, ...]

# Alternativly

Topic.neo_index_list #=> ["slug"]

Topic.neo_index_create [:name, ...]

Topic.neo_index_drop [:name, ...]

# Sync the indexes you described in model config. It returns the indexed fields.
# Remember, this will be called on each model on the boot if preload_models set to true.
Topic.neo_index_update #=> ["slug"]

The gem is still at heavy development. More to come!

TODO

1. ADD TESTS
2. ..

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