neo4j-rails 0.5.1

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+
+gem "rails", ">= 3.0.0.beta2"
+gem "neo4j", ">= 0.4.1"
+
+group :test do
+  gem 'rspec'
+end

data/History.txt

@@ -0,0 +1,3 @@
+=== 0.5.0  (2010-06-06)
+
+- First release to Rubygems.org.

data/LICENSE.txt

@@ -0,0 +1,23 @@
+#--
+# The MIT License
+#
+# Copyright (c) 2010 Engine Yard, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#++

data/README.markdown

@@ -0,0 +1,76 @@
+# Neo4j-Rails
+
+This is an experimental library for playing with an
+ActiveModel-charged version of the [Neo4j.rb][neo4j] Ruby library. The
+intent is to use it as a full replacement for ActiveRecord inside a
+Rails 3 application.
+
+Of course you can use Neo4j.rb as is in a Rails application, but this
+library uses ActiveModel to make the API and usage even closer to
+ActiveRecord. One example of this is the way `Model.new` works.
+
+In Neo4j.rb, `Node.new` requires a transaction and immediately stores
+the node in the database.In Neo4j-Rails, object initialization matches
+ActiveRecord-style two-step `Model.new` + `Model#save` creation. This
+makes it easier to create forms that don't touch the database if
+validation fails.
+
+# Usage
+
+Include the 'neo4j-rails' library in your Gemfile to use in your
+project.
+
+    gem "neo4j-rails"
+
+Extend Neo4j::Model to create your model node classes.
+
+    class IceCream < Neo4j::Model
+      property :flavour
+      validates_presence_of :flavour
+    end
+
+    IceCream.new.valid?  # => false
+    IceCream.new(:flavour => "vanilla").valid?  # => true
+
+Configure the location of the Neo4j database and Lucene index files on
+disk. The Lucene search index will normally be created in memory, so
+set `store_on_file = true` to save it to disk. Usually these settings
+will go in `config/application.rb` or `config/environments/*.rb`.
+
+    Rails.application.configure do
+      config.neo4j.storage_path = "/var/neo4j"
+      config.lucene.storage_path = "/var/lucene"
+      config.lucene.store_on_file = true
+    end
+
+# API
+
+Many of the familiar API methods from ActiveRecord are duplicated in
+Neo4j::Model. Neo4j::Model includes ActiveModel::Validations,
+ActiveModel::Conversions, and ActiveModel::Callbacks.
+
+    class Neo4j::Model
+      def valid?; end
+      def save; end
+      def save!; end
+      def update_attributes(attributes); end
+      def update_attributes!(attributes); end
+      def destroy; end
+      def attributes=(attrs); end
+      def reload; end
+      def self.all; end
+      def self.find(*); end
+      def self.create(attributes); end
+      def self.create!(attributes); end
+    end
+
+# License
+
+Neo4j-Rails is available under the terms of the MIT license (see
+LICENSE.txt for details).
+
+However, Neo4j-Rails also depends on the [Neo4j.rb library][neo4j], and the MIT
+license does not replace or cover the licensing terms of its own
+library or its components.
+
+[neo4j]: http://github.com/andreasronge/neo4j

data/Rakefile

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'date'
+
+require './lib/neo4j-rails/version'
+gemspec = Gem::Specification.new do |s|
+  s.name = %q{neo4j-rails}
+  s.version = Neo4jRails::VERSION
+  s.authors = ["Nick Sieger"]
+  s.date = Date.today.to_s
+  s.description = %{Adapts Neo4j for Rails 3 apps using ActiveModel}
+  s.summary = %q{Neo4j adapter for Rails 3}
+  s.email = ["nick@nicksieger.com"]
+  s.files = FileList["lib/**/*", "spec/**/*",
+                     *%w(Gemfile neo4j-rails.gemspec History.txt LICENSE.txt Rakefile README.markdown)
+                    ].select {|f| File.file?(f) }
+  s.homepage = %q{http://jruby.org}
+  s.has_rdoc = false
+  s.add_dependency('rails', ">= 3.0.0.beta2")
+  s.add_dependency('neo4j', ">= 0.4.3")
+end
+
+task :gemspec do
+  File.open("neo4j-rails.gemspec", "w") {|f| f << gemspec.to_ruby }
+end
+
+require 'rake/gempackagetask'
+Rake::GemPackageTask.new(gemspec) do |pkg|
+end
+
+task :release => :package do
+  if Neo4jRails::VERSION != ENV['VERSION']
+    abort "Versions do not match: #{Neo4jRails::VERSION.inspect} != #{ENV['VERSION'].inspect}"
+  end
+  sh "gem push pkg/neo4j-rails-#{Neo4jRails::VERSION}.gem"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new
+
+task :default => :spec

data/lib/neo4j-rails.rb

@@ -0,0 +1,2 @@
+require 'neo4j'
+require 'neo4j/rails'

data/lib/neo4j-rails/version.rb

@@ -0,0 +1,3 @@
+module Neo4jRails
+  VERSION = "0.5.1"
+end

data/lib/neo4j/delayed_save.rb

@@ -0,0 +1,67 @@
+# Extension to Neo4j::NodeMixin to delay creating/updating properties
+# until #save is called.
+module Neo4j::DelayedSave
+  def id
+    persisted? ? neo_id : nil
+  end
+
+  # Override NodeMixin#init_without_node to save the properties for
+  # when #save is called.
+  def init_without_node(props) # :nodoc:
+    raise "Can't use Neo4j::Model with anonymous classes" if self.class.name == ""
+    props[:_classname] = self.class.name
+    @_unsaved_props = props || {}
+    @persisted = false
+  end
+
+  # Ensure nodes loaded from the database are marked as persisted.
+  def init_with_node(node)
+    super
+    @persisted = true
+    @_unsaved_props = {}
+  end
+
+  # Delegate property access to temporary properties first
+  def [](key)
+    if @_unsaved_props.has_key?(key)
+      @_unsaved_props[key]
+    elsif @_java_node
+      @_java_node[key]
+    end
+  end
+
+  # Delegate property write to temporary properties
+  def []=(key, value)
+    @_unsaved_props[key] = value
+  end
+
+  def reload(*)
+    @_unsaved_props.clear
+    self
+  end
+  alias_method :reset, :reload
+
+  def save
+    if valid?
+      _run_save_callbacks do
+        if @persisted
+          _run_update_callbacks do
+            @_unsaved_props.each {|k,v| @_java_node[k] = v }
+            @_unsaved_props.clear
+          end
+        else
+          _run_create_callbacks do
+            @_java_node = Neo4j.create_node
+            @_java_node._wrapper = self
+            @_unsaved_props.each {|k,v| @_java_node[k] = v }
+            @_unsaved_props.clear
+            update_index
+            Neo4j.event_handler.node_created(self)
+            @persisted = true
+          end
+        end
+      end
+      true
+    end
+  end
+end

data/lib/neo4j/model.rb

@@ -0,0 +1,100 @@
+require 'neo4j'
+require 'neo4j/extensions/reindexer'
+require 'active_model'
+require 'neo4j/delayed_save'
+
+class Neo4j::Model
+  include Neo4j::NodeMixin
+  include Neo4j::DelayedSave
+  include ActiveModel::Conversion
+  include ActiveModel::Validations
+  extend ActiveModel::Callbacks
+  define_model_callbacks :create, :save, :update, :destroy
+
+  class RecordInvalidError < RuntimeError
+    attr_reader :record
+    def initialize(record)
+      @record = record
+      super(@record.errors.full_messages.join(", "))
+    end
+  end
+
+  def persisted?
+    @persisted
+  end
+
+  def read_attribute_for_validation(key)
+    self[key]
+  end
+
+  def attributes=(attrs)
+    attrs.each do |k,v|
+      if respond_to?("#{k}=")
+        send("#{k}=", v)
+      else
+        self[k] = v
+      end
+    end
+  end
+
+  def update_attributes(attributes)
+    self.attributes = attributes
+    save
+  end
+
+  def update_attributes!(attributes)
+    self.attributes = attributes
+    save!
+  end
+
+  def destroy
+    _run_destroy_callbacks do
+      del
+    end
+  end
+
+  def save!
+    unless save
+      raise RecordInvalidError.new(self)
+    end
+  end
+
+  def self.load(*ids)
+    result = ids.map {|id| Neo4j.load_node(id) }
+    if ids.length == 1
+      result.first
+    else
+      result
+    end
+  end
+
+  def self.all
+    super.nodes
+  end
+
+  # Handle Model.find(params[:id])
+  def self.find(*args)
+    if args.length == 1 && String === args[0] && args[0].to_i != 0
+      load(*args)
+    else
+      super
+    end
+  end
+
+  def self.create(*args)
+    new(*args).tap {|model| model.save }
+  end
+
+  def self.create!(*args)
+    new(*args).tap {|model| model.save! }
+  end
+
+  def self.inherited(subc) # :nodoc:
+    # Make subclasses of Neo4j::Model each have their own root class/indexer
+    subc.instance_eval do
+      def root_class
+        self
+      end
+    end
+  end
+end

data/lib/neo4j/rails.rb

@@ -0,0 +1,2 @@
+require 'neo4j/railtie'
+require 'neo4j/model'

data/lib/neo4j/railtie.rb

@@ -0,0 +1,21 @@
+require 'rails/railtie'
+require 'neo4j/transaction_management'
+
+module Neo4j
+  class Railtie < Rails::Railtie
+    config.neo4j = ActiveSupport::OrderedOptions.new
+    config.lucene = ActiveSupport::OrderedOptions.new
+
+    initializer "neo4j.tx" do |app|
+      app.config.middleware.use Neo4j::TransactionManagement
+    end
+
+    # Starting Neo after :load_config_initializers allows apps to
+    # register migrations in config/initializers
+    initializer "neo4j.start", :after => :load_config_initializers do |app|
+      Neo4j::Config.setup.merge!(app.config.neo4j.to_hash)
+      Lucene::Config.setup.merge!(app.config.lucene.to_hash)
+      Neo4j.start
+    end
+  end
+end

data/lib/neo4j/transaction_management.rb

@@ -0,0 +1,15 @@
+class Neo4j::TransactionManagement
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    Neo4j::Transaction.new
+    @app.call(env)
+  rescue
+    Neo4j::Transaction.failure
+    raise
+  ensure
+    Neo4j::Transaction.finish
+  end
+end

data/neo4j-rails.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{neo4j-rails}
+  s.version = "0.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nick Sieger"]
+  s.date = %q{2010-06-06}
+  s.description = %q{Adapts Neo4j for Rails 3 apps using ActiveModel}
+  s.email = ["nick@nicksieger.com"]
+  s.files = ["lib/neo4j-rails.rb", "lib/neo4j/delayed_save.rb", "lib/neo4j/model.rb", "lib/neo4j/rails.rb", "lib/neo4j/railtie.rb", "lib/neo4j/transaction_management.rb", "lib/neo4j-rails/version.rb", "spec/spec_helper.rb", "spec/neo4j/model_spec.rb", "Gemfile", "neo4j-rails.gemspec", "History.txt", "LICENSE.txt", "Rakefile", "README.markdown"]
+  s.homepage = %q{http://jruby.org}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Neo4j adapter for Rails 3}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, [">= 3.0.0.beta2"])
+      s.add_runtime_dependency(%q<neo4j>, [">= 0.4.3"])
+    else
+      s.add_dependency(%q<rails>, [">= 3.0.0.beta2"])
+      s.add_dependency(%q<neo4j>, [">= 0.4.3"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 3.0.0.beta2"])
+    s.add_dependency(%q<neo4j>, [">= 0.4.3"])
+  end
+end

data/spec/neo4j/model_spec.rb

@@ -0,0 +1,156 @@
+require File.expand_path('../../spec_helper', __FILE__)
+require 'neo4j/model'
+
+class IceCream < Neo4j::Model
+  property :flavour
+  index :flavour
+  validates_presence_of :flavour
+end
+
+describe Neo4j::Model, "new" do
+  before :each do
+    @model = Neo4j::Model.new
+  end
+  subject { @model }
+
+  it { should_not be_persisted }
+
+  it "should allow access to properties before it is saved" do
+    @model["fur"] = "none"
+    @model["fur"].should == "none"
+  end
+
+  it "should fail to save new model without a transaction" do
+    lambda { @model.save }.should raise_error
+  end
+end
+
+describe Neo4j::Model, "load" do
+  before :each do
+    txn do
+      @model = fixture(Neo4j::Model.new)
+      @model.save
+    end
+  end
+
+  it "should load a previously stored node" do
+    result = Neo4j::Model.load(@model.id)
+    result.should == @model
+    result.should be_persisted
+  end
+end
+
+describe Neo4j::Model, "save" do
+  use_transactions
+  before :each do
+    @model = fixture(IceCream.new)
+    @model.flavour = "vanilla"
+  end
+
+  it "should store the model in the database" do
+    @model.save
+    @model.should be_persisted
+    IceCream.load(@model.id).should == @model
+  end
+
+  it "should not save the model if it is invalid" do
+    @model = IceCream.new
+    @model.save.should_not be_true
+    @model.should_not be_valid
+    @model.should_not be_persisted
+    @model.id.should be_nil
+  end
+end
+
+describe Neo4j::Model, "find" do
+  before :each do
+    txn do
+      @model = fixture(IceCream.new)
+      @model.flavour = "vanilla"
+      @model.save
+    end
+  end
+  use_transactions
+
+  it "should load all nodes of that type from the database" do
+    IceCream.all.should include(@model)
+  end
+
+  it "should find a model by one of its attributes" do
+    IceCream.find(:flavour => "vanilla").to_a.should include(@model)
+  end
+end
+
+describe Neo4j::Model, "lint" do
+  before :each do
+    @model = Neo4j::Model.new
+  end
+
+  include_tests ActiveModel::Lint::Tests
+end
+
+describe Neo4j::Model, "destroy" do
+  insert_dummy_model
+
+  it "should remove the model from the database" do
+    txn { @model.destroy }
+    txn { Neo4j::Model.load(@model.id).should be_nil }
+  end
+end
+
+describe Neo4j::Model, "create" do
+  use_transactions
+
+  it "should save the model and return it" do
+    model = Neo4j::Model.create
+    model.should be_persisted
+  end
+
+  it "should accept attributes to be set" do
+    model = Neo4j::Model.create :name => "Nick"
+    model[:name].should == "Nick"
+  end
+
+  it "bang version should raise an exception if save returns false" do
+    lambda { IceCream.create! }.should raise_error(Neo4j::Model::RecordInvalidError)
+  end
+
+  it "should run before and after create callbacks" do
+    klass = model_subclass do
+      property :created, :type => DateTime
+      before_create :timestamp
+      def timestamp
+        self.created = DateTime.now
+      end
+      after_create :mark_saved
+      attr_reader :saved
+      def mark_saved
+        @saved = true
+      end
+    end
+    klass.marshal?(:created).should be_true
+    model = klass.create!
+    model.created.should_not be_nil
+    model.saved.should_not be_nil
+  end
+end
+
+describe Neo4j::Model, "update_attributes" do
+  insert_dummy_model
+
+  it "should save the attributes" do
+    txn { @model.update_attributes(:a => 1, :b => 2).should be_true }
+    txn { @model[:a].should == 1; @model[:b].should == 2 }
+  end
+
+  it "should not update the model if it is invalid" do
+    klass = model_subclass do
+      property :name
+      validates_presence_of :name
+    end
+    model = nil
+    txn { model = fixture(klass.create!(:name => "vanilla")) }
+    txn { model.update_attributes(:name => nil).should be_false }
+    txn { model.reload.name.should == "vanilla" }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,75 @@
+begin
+  require File.expand_path('../../.bundle/environment', __FILE__)
+rescue LoadError
+  require 'rubygems'
+  require 'bundler'
+  Bundler.setup
+end
+Bundler.require :default, :test
+
+require 'spec'
+require 'spec/interop/test'
+
+# Since we're using spec/interop/test, we might as well add our
+# helpers to T::U::TC
+class Test::Unit::TestCase
+  def self.use_transactions
+    before :each do
+      Neo4j::Transaction.new
+    end
+
+    after :each do
+      Neo4j::Transaction.failure
+      Neo4j::Transaction.finish
+    end
+  end
+
+  def txn(&block)
+    Neo4j::Transaction.run(&block)
+  end
+
+  # HAX: including a module of test_ methods doesn't seem to get them
+  # registered, so I'm registering them manually
+  def self.include_tests(mod)
+    include mod
+    mod.instance_methods(false).each do |m|
+      example(m, {}) {__send__ m}
+    end
+  end
+
+  after :each do
+    txn { fixtures.each { |obj| obj.del rescue nil } }
+  end
+
+  def fixtures
+    @fixtures ||= []
+  end
+
+  def fixture(obj)
+    self.fixtures << obj
+    obj
+  end
+
+  def self.insert_dummy_model
+    before :each do
+      txn do
+        @model = fixture(Neo4j::Model.new)
+        @model.save
+      end
+    end
+  end
+
+  module TempModel
+    @@_counter = 1
+    def self.set(klass)
+      name = "Model_#{@@_counter}"
+      @@_counter += 1
+      const_set(name,klass)
+      klass
+    end
+  end
+
+  def model_subclass(&block)
+    TempModel.set(Class.new(Neo4j::Model, &block))
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: neo4j-rails
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+    - 0
+    - 5
+    - 1
+  version: 0.5.1
+platform: ruby
+authors: 
+  - Nick Sieger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-06 00:00:00 -05:00
+default_executable: 
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rails
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 3
+              - 0
+              - 0
+              - beta2
+            version: 3.0.0.beta2
+    type: :runtime
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: neo4j
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+              - 4
+              - 3
+            version: 0.4.3
+    type: :runtime
+    version_requirements: *id002
+description: Adapts Neo4j for Rails 3 apps using ActiveModel
+email: 
+  - nick@nicksieger.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - lib/neo4j-rails.rb
+  - lib/neo4j/delayed_save.rb
+  - lib/neo4j/model.rb
+  - lib/neo4j/rails.rb
+  - lib/neo4j/railtie.rb
+  - lib/neo4j/transaction_management.rb
+  - lib/neo4j-rails/version.rb
+  - spec/spec_helper.rb
+  - spec/neo4j/model_spec.rb
+  - Gemfile
+  - neo4j-rails.gemspec
+  - History.txt
+  - LICENSE.txt
+  - Rakefile
+  - README.markdown
+has_rdoc: true
+homepage: http://jruby.org
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Neo4j adapter for Rails 3
+test_files: []
+