cadet 0.1.0-java → 0.1.1-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44c6bd53bbc5065234be58f9851fb93fb8b35030
-  data.tar.gz: e07f2a4322395961deea2586f5dcb18f3bdddd35
+  metadata.gz: ca887c03dce61ba0ba05011ce4693ff9b08c19fc
+  data.tar.gz: b028f3f77bc89d1beaa4be1f234ecb205f5abb7e
 SHA512:
-  metadata.gz: e213c75cca7e02ed89f2369b6c63e60c56a8d976601239b8963d8faf80ec741c6da071d293f0573e339ca6ab2dfb9797f4f7949e6409ac20756de0fdb9339974
-  data.tar.gz: 9053afd936989c658a6bc230f71c81864585312b9c1453e4dfb41e5f7263fc7e241d4806d2983d17a48a3451dd410a0e1e69618d11efc1fb28353a389d840ecd
+  metadata.gz: 0e43b1a700ed9798678ce7f715c6dd4b2f4d7c54a414c150c48eecf641ec22f6e1a3ef489f813ed6f15b3bc5d4ddb0294795fb2f31a33e711b3596f87e8afe81
+  data.tar.gz: 868a047761af51e5e257d3a38b9f757b5fc166ae20bae08e88559cbdf987884e5e209bcf86df8039a1b5d5ea88f5e0b35a0ad11c21cbc96287f5241865faff2f

data/.ruby-version

@@ -0,0 +1 @@
+jruby

data/README.md

@@ -7,19 +7,29 @@ Use neo4j via jruby! Nothing else needed, simply add this gem to get the power o
 
 super simple. you dont even need to download neo4j.
 
-
+##Open a session
 ```ruby
 
 require 'cadet'
 
 Cadet::Session.open "path/to/graph.db/" do
+#for a batch inserter session:
+#Cadet::BatchInserter::Session.open "path/to/graph.db/" do
+#bear in mind that, the database directory needs to be clean before establishing a BatchInserter session.
   transaction do
     Person_by_name("Javad").lives_in_to City_by_name("Chicago")
   end
 end
 
+```
 
+## beginning a transaction
+```ruby
+transaction do
+  #...
+end
 ```
+Note: transaction effictively does nothing in a BatchInserter session, as transactions are not supported in neo4j's BatchInserter (for performance reasons)
 
 ## Getting/creating a node, using label-property-value
 A node can be retrieved (and implicitly created if it does not exist) via the following syntax:
@@ -53,6 +63,15 @@ Relationship creation can also be chained:
 Person_by_name("Javad").lives_in_to(City_by_name("Chicago")).city_of_to(State_by_name("Illinois")).state_of_to(Country_by_name("United States"))
 ```
 
+A node's relationships can be iterated over via:
+```ruby
+javad.outgoing(:lives_in).each do |rel|
+  #rel is a Cadet#Relationship
+end
 
-Batch insert mode can be used by simply using Cadet::BatchInserter::Session instead of Cadet::Session!
-None of your code needs to change.
+chicago.incoming(:lives_in).each do |rel|
+  #rel is a Cadet#Relationship
+end
+```
+Note: this (relationship traversal) does not work in a batch inserter session, atleast not yet.
+The idea is a batch inserter session is used for writing data, as opposed to reading data

data/lib/cadet/batch_inserter/cadet_index/index.rb

@@ -2,9 +2,8 @@ module Cadet
   module BatchInserter
     module CadetIndex
       class Index
-        def initialize(lucene_index, name, type)
+        def initialize(lucene_index, name)
           @name = name.to_sym
-          @type = type
           @property_index = {}
           @lucene_index = lucene_index
         end
@@ -21,7 +20,7 @@ module Cadet
         end
 
         def flush
-          lucene_node_index = @lucene_index.nodeIndex(@name, @type)
+          lucene_node_index = @lucene_index.nodeIndex(@name, {"type" => "exact"})
 
           @property_index.each do |property, propval_to_node_mappings|
             propval_to_node_mappings.each do |value, nodes|

data/lib/cadet/batch_inserter/cadet_index/index_provider.rb

@@ -7,11 +7,14 @@ module Cadet
           @indexes = {}
           @lucene_index = org.neo4j.index.impl.lucene.LuceneBatchInserterIndexProviderNewImpl.new(db)
         end
-        def nodeIndex(label, type = {"type" => "exact"})
-          @indexes[label.to_sym] ||= CadetIndex::Index.new(@lucene_index, label.to_sym, type)
+
+        def [](label)
+          @indexes[label.to_sym] ||= CadetIndex::Index.new(@lucene_index, label.to_sym)
         end
         def shutdown
-          @indexes.each { |label, index| index.flush }
+          @indexes.each do |label, index|
+            index.flush
+          end
         end
       end
     end

data/lib/cadet/batch_inserter/node.rb

@@ -3,15 +3,15 @@ module Cadet
     class Node < Cadet::Node
 
       def create_outgoing(to, type, properties = {})
-        Relationship.new @db.createRelationship(@underlying, to.underlying, DynamicRelationshipType.withName(type), properties)
+        Cadet::BatchInserter::Session.current_session.create_relationship(self, to, type, properties)
       end
 
       def []= (property, value)
-        @db.setNodeProperty @underlying, property.to_java_string, value
+        Cadet::BatchInserter::Session.current_session.set_node_property(self, property, value)
       end
 
       def [] (property)
-        @db.getNodeProperties(@underlying)[property.to_java_string]
+        Cadet::BatchInserter::Session.current_session.get_node_properties(self)[property.to_s]
       end
 
       def == other_node

data/lib/cadet/batch_inserter/relationship.rb

@@ -0,0 +1,20 @@
+module Cadet
+  module BatchInserter
+    class Relationship < Cadet::Relationship
+      attr_accessor :underlying
+
+      def == other_rel
+        @underlying == other_rel
+      end
+
+      def []= (property, value)
+        Cadet::BatchInserter::Session.current_session.set_relationship_property(self, property, value)
+      end
+
+      def [] (property)
+        Cadet::BatchInserter::Session.current_session.get_relationship_properties(self)[property]
+      end
+
+    end
+  end
+end

data/lib/cadet/batch_inserter/session.rb

@@ -2,9 +2,13 @@ module Cadet
   module BatchInserter
     class Session < Cadet::Session
 
-      def initialize(db)
-        @index_provider = CadetIndex::IndexProvider.new(db)
-        @db = db
+      def initialize(underlying)
+        @index_provider = CadetIndex::IndexProvider.new(underlying)
+        @underlying = underlying
+      end
+
+      def index_on(label, property, node)
+        @index_provider[label].add(node.underlying, property, node[property])
       end
 
       def close
@@ -14,6 +18,7 @@ module Cadet
 
       def self.open(location, &block)
         new(org.neo4j.unsafe.batchinsert.BatchInserters.inserter(location)).tap do |session|
+          @@current_session = session
           if block_given?
             session.instance_exec(session, &block)
             session.close
@@ -22,28 +27,47 @@ module Cadet
       end
 
       def constraint(label, property)
-        @db.createDeferredConstraint(DynamicLabel.label(label))
+        @underlying.createDeferredConstraint(DynamicLabel.label(label))
           .assertPropertyIsUnique(property)
           .create()
       end
 
       def find_node(label, property, value)
-        index = @index_provider.nodeIndex(label)
+        (node = @index_provider[label].get(property.to_sym, value).first) ?
+          Node.new(node) : nil
+      end
 
-        (node = index.get(property.to_sym, value).first) ?
-          Node.new(node, @db) : nil
+      def create_node(label, properties)
+        Node.new(@underlying.createNode(Hash[properties.map { |k,v| [k.to_java_string, v] }], DynamicLabel.label(label)))
       end
 
-      def create_node(label, properties, indexing_property = nil)
-        Node.new(@db.createNode(properties.inject({}){|result,(k,v)| result[k.to_java_string] = v; result}, DynamicLabel.label(label)), @db).tap do |n|
-          @index_provider.nodeIndex(label).add(n.underlying, indexing_property.to_sym, properties[indexing_property]) if indexing_property
-        end
+      def get_node(label, property, value)
+        find_node(label, property, value) || create_node(label, {property.to_sym => value}).tap { |n| index_on(label, property, n); }
       end
 
       def get_transaction
         Transaction.new(self)
       end
 
+      def create_relationship(from, to, type, properties)
+        Relationship.new @underlying.createRelationship(from.underlying, to.underlying, DynamicRelationshipType.withName(type), properties)
+      end
+
+      def get_node_properties(node)
+        @underlying.getNodeProperties(node.underlying)
+      end
+
+      def set_node_property(node, property, value)
+        @underlying.setNodeProperty(node.underlying, property.to_java_string, value)
+      end
+
+      def get_relationship_properties(relationship)
+        @underlying.getRelationshipProperties(relationship.underlying)
+      end
+
+      def set_relationship_property(relationship, property, value)
+        @underlying.setRelationshipProperty(relationship.underlying, property.to_java_string, value)
+      end
     end
   end
 end

data/lib/cadet/node.rb

@@ -2,8 +2,7 @@ module Cadet
   class Node
     attr_accessor :underlying
 
-    def initialize(node, db = nil)
-      @db = db
+    def initialize(node)
       @underlying = node
     end
 

data/lib/cadet/session.rb

@@ -1,7 +1,13 @@
 module Cadet
   class Session
-    def initialize(db)
-      @db = db
+    @@current_session = nil
+
+    def self.current_session
+      @@current_session
+    end
+
+    def initialize(underlying)
+      @underlying = underlying
     end
 
     def self.open(location = nil, &block)
@@ -9,6 +15,7 @@ module Cadet
         new(org.neo4j.graphdb.factory.GraphDatabaseFactory.new.newEmbeddedDatabase(location)) :
         new(org.neo4j.test.TestGraphDatabaseFactory.new.newImpermanentDatabase))
       .tap do |session|
+        @@current_session = session
         if block_given?
           session.instance_exec(session, &block)
           session.close
@@ -17,23 +24,23 @@ module Cadet
     end
 
     def close
-      @db.shutdown
+      @underlying.shutdown
     end
 
     def create_node(label, properties, indexing_property = nil)
-      Node.new(@db.createNode).tap do |n|
+      Node.new(@underlying.createNode).tap do |n|
         n.add_label label
         properties.each { |prop, val| n[prop] = val }
       end
     end
 
     def find_node(label, property, value)
-      ( node = org.neo4j.helpers.collection.IteratorUtil.firstOrNull(@db.findNodesByLabelAndProperty(DynamicLabel.label(label), property, value)) ) ?
+      ( node = org.neo4j.helpers.collection.IteratorUtil.firstOrNull(@underlying.findNodesByLabelAndProperty(DynamicLabel.label(label), property, value)) ) ?
         Node.new(node) : nil
     end
 
     def get_node(label, property, value)
-      find_node(label, property, value) || create_node(label, {property.to_sym => value}, property)
+      find_node(label, property, value) || create_node(label, {property.to_sym => value})
     end
 
     def get_transaction
@@ -51,14 +58,14 @@ module Cadet
     end
 
     def constraint(label, property)
-      @db.schema
+      @underlying.schema
         .constraintFor(DynamicLabel.label(label))
         .assertPropertyIsUnique(property)
         .create()
     end
 
     def begin_tx
-      @db.beginTx
+      @underlying.beginTx
     end
 
     def method_missing(name, *args, &block)
@@ -72,8 +79,8 @@ module Cadet
 
         when /^create_([A-z_]*)$/
           self.class.class_eval "
-            def #{name}(value, indexing_property = nil)
-              create_node :#{$1}, value, indexing_property
+            def #{name}(value)
+              create_node :#{$1}, value
             end"
           return self.send(name, *args, &block)
         else

data/lib/cadet/version.rb

@@ -1,3 +1,3 @@
 module Cadet
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/cadet.rb

@@ -16,6 +16,7 @@ require 'cadet/transaction'
 
 require 'cadet/batch_inserter/session'
 require 'cadet/batch_inserter/node'
+require 'cadet/batch_inserter/relationship'
 require 'cadet/batch_inserter/transaction'
 
 require 'cadet/batch_inserter/cadet_index/index_provider'

data/spec/unit/batch_insert_spec.rb

@@ -7,18 +7,21 @@ describe Cadet::BatchInserter do
     Cadet::BatchInserter::Session.open(Dir.mktmpdir).class.should == Cadet::BatchInserter::Session
   end
 
-  it "it should accept multiple relationships" do
+  it "it should also work in batch insert mode" do
     at = Dir.mktmpdir
     Cadet::BatchInserter::Session.open(at) do
       self.class.should == Cadet::BatchInserter::Session
 
       transaction do
-        javad   = Person_by_name("Javad")
-        chicago = City_by_name("Chicago")
-        houston = City_by_name("Houston")
+        Person_by_name("Javad").lives_in_to City_by_name("Chicago")
+        Person_by_name("Javad").lives_in_to City_by_name("Houston")
 
-        javad.lives_in_to chicago
-        javad.lives_in_to houston
+        City_by_name("Chicago").city_of_to State_by_name("Illinois")
+        City_by_name("Houston").city_of_to State_by_name("Texas")
+
+        Person_by_name("Javad")[:birth_year]   = 1988
+        City_by_name("Chicago")[:abbreviation] = "CHI"
+        City_by_name("Houston")[:abbreviation] = "HOU"
       end
     end
 
@@ -26,7 +29,20 @@ describe Cadet::BatchInserter do
       transaction do
         Person_by_name("Javad").outgoing(:lives_in).should =~ [City_by_name("Houston"), City_by_name("Chicago")]
         Person_by_name("Javad").outgoing(:lives_in).should =~ [City_by_name("Chicago"), City_by_name("Houston")]
+
+        Person_by_name("Javad").outgoing(:lives_in).outgoing(:city_of).should == [State_by_name("Texas"), State_by_name("Illinois")]
+        Person_by_name("Javad").outgoing(:lives_in).outgoing(:city_of).to_a.should =~ [State_by_name("Illinois"), State_by_name("Texas")]
+
+        Person_by_name("Javad")[:birth_year].should     == 1988
+        City_by_name("Chicago")[:abbreviation].should == "CHI"
+        City_by_name("Houston")[:abbreviation].should == "HOU"
       end
     end
   end
+
+  it "should allow access to the cadet database session singleton object" do
+    Cadet::BatchInserter::Session.open(Dir.mktmpdir) do |session|
+      Cadet::BatchInserter::Session.current_session.should == session
+    end
+  end
 end

data/spec/unit/cadet_spec.rb

@@ -220,5 +220,13 @@ describe Cadet do
     end
   end
 
+  it "should allow access to the cadet database session singleton object" do
+    Cadet::Session.open do |session|
+      transaction do
+        Cadet::Session.current_session.should == session
+      end
+    end
+  end
+
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cadet
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: java
 authors:
 - Javad Karabi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-03-12 00:00:00.000000000 Z
+date: 2014-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -45,6 +45,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .ruby-version
 - .travis.yml
 - Gemfile
 - README.md
@@ -55,6 +56,7 @@ files:
 - lib/cadet/batch_inserter/cadet_index/index.rb
 - lib/cadet/batch_inserter/cadet_index/index_provider.rb
 - lib/cadet/batch_inserter/node.rb
+- lib/cadet/batch_inserter/relationship.rb
 - lib/cadet/batch_inserter/session.rb
 - lib/cadet/batch_inserter/transaction.rb
 - lib/cadet/direction.rb
@@ -100,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.2.0
+rubygems_version: 2.1.9
 signing_key:
 specification_version: 4
 summary: ruby wrapper to Neo4j java API