geoff 0.0.2.beta → 0.0.3.beta

data/.gitignore

@@ -16,3 +16,7 @@ tmp
 .yardoc
 _yardoc
 doc/
+*.swp
+*.swo
+lib/jars
+.DS_Store

data/.rvmrc

@@ -0,0 +1 @@
+rvm use jruby

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    geoff (0.2.4.beta)
+    geoff (0.0.3.beta)
       activesupport (~> 3.2.3)
       json
       neo4j
@@ -9,20 +9,20 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (3.2.6)
-      activemodel (= 3.2.6)
-      activesupport (= 3.2.6)
+    actionpack (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
-      journey (~> 1.0.1)
+      journey (~> 1.0.4)
       rack (~> 1.4.0)
       rack-cache (~> 1.2)
       rack-test (~> 0.6.1)
       sprockets (~> 2.1.3)
-    activemodel (3.2.6)
-      activesupport (= 3.2.6)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
       builder (~> 3.0.0)
-    activesupport (3.2.6)
+    activesupport (3.2.8)
       i18n (~> 0.6)
       multi_json (~> 1.0)
     builder (3.0.0)
@@ -48,7 +48,7 @@ GEM
       neo4j-community (>= 1.7.0)
     neo4j-wrapper (2.0.1-java)
       neo4j-core (= 2.0.1)
-    orm_adapter (0.3.0)
+    orm_adapter (0.4.0)
     pry (0.9.10)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
@@ -65,9 +65,9 @@ GEM
       rack
     rack-test (0.6.1)
       rack (>= 1.0)
-    railties (3.2.6)
-      actionpack (= 3.2.6)
-      activesupport (= 3.2.6)
+    railties (3.2.8)
+      actionpack (= 3.2.8)
+      activesupport (= 3.2.8)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)

data/README.md

@@ -1,18 +1,39 @@
 geoff
 =====
 
-Ruby Geoff DSL
+Geoff is "a declarative notation for representing graph data within concise
+human-readable text, designed specifically with Neo4j in mind"
 
+http://geoff.nigelsmall.net/
 
-Preview
-=======
+
+This gem is a Ruby DSL for
+  * generating geoff syntax files
+  * batch inserting data into Neo4j
+
+The reason for creating this gem is to:
+  * easily build data sets for tests
+  * that are readable and maintainable
+  * quickly batch insert the whole data set in one transaction
+
+Prerequesites/ Caveats
+---------------------
+  * A ruby project
+  * Gemfile with `gem 'geoff', '0.0.2.beta'`
+  * neo4j jar and geoff jar files in lib/jars (not included, but required!)
+  * Current implementation assumes usage of the neo4j wrapper gem
+  * Neo4j::Rails::Model classes or a class that includes the Neo4j::NodeMixin
+
+Usage
+-------
 
 
 ```ruby
 
 #Basic tree like structure for DSL
 #the first line generates the class nodes used by Neo4jWrapper
-Geoff(Company, Person) do
+
+Geoff(Company, Person) do # NB 'Company' and 'Person' are classes with the Neo4j::NodeMixin
   company 'Acme' do
     address "13 Something Road"
 
@@ -38,6 +59,31 @@ end
 
 ```
 
+
+###Using a ramdisk see http://neo4j.rubyforge.org/guides/configuration.html
+
+```sh
+diskutil erasevolume HFS+ "ramdisk" `hdiutil attach -nomount ram://1165430`
+```
+
+```ruby
+
+#in spec helper
+Neo4j::Config[:storage_path] = '/Volumes/ramdisk'
+
+#in rspec
+before do
+  geoff = Geoff(Company) do
+    company 'Acme' do
+      address "13 Something Road"
+    end
+  end
+
+  #Don't display output, and delete existing database
+  Geoff::Importer.import geoff, silent: false, delete: true
+end
+
+
 ```
 (ROOT)-[:Company]->(Company)
 (ROOT)-[:Person]->(Person)
@@ -122,7 +168,7 @@ end
 ```
 
 
-#Using the outer bindings scope
+#Using the outer scope
 ```ruby
 @hours = SomeFancyAttributeParser.parse <<-EOF
 Monday   09:00-15:00
@@ -131,7 +177,7 @@ Saturday 09:00-16:00
 Sunday   closed
 EOF
 
-Geoff(Company, binding: binding) do
+Geoff(Company, target: self) do
   company 'Amazon' do
     opening_hours ->{ @hours }
   end

data/lib/geoff.rb

@@ -10,3 +10,4 @@ end
 
 class Geoff::Error                  < StandardError; end
 class Geoff::MissingNodeDefinition  < Geoff::Error ; end
+class Geoff::DslSyntaxError         < Geoff::Error;  end

data/lib/geoff/children_dsl.rb

@@ -1,19 +1,23 @@
 require 'geoff/node_dsl'
 require 'geoff/container'
+require 'geoff/dsl_exception_handling'
 require 'active_support/core_ext/string'
 
 class ChildrenDsl
+  include DslExceptionHandling
+
   def initialize options, &block
     @parent_node_name = options[:parent_node_name]
     @parent_rel_type  = options[:type]
-    @outer_binding    = options[:binding]
+    @target           = options[:target]
     @outer_geoff      = options[:geoff]
 
     @write_mode = false
 
     @node_dsls = {}
     @container = options[:container] || Container.new
-    write_mode { instance_eval(&block) }
+
+    eval_with_exceptions(&block)
   end
 
   def to_geoff
@@ -51,14 +55,6 @@ class ChildrenDsl
 
   private
 
-  #prevent very confusing method_missing calls during debugging by
-  #only writing to the object when expected
-  def write_mode
-    @write_mode = true
-    yield
-    @write_mode = false
-  end
-
   # e.g.
   #company "ACME" do
   #  children "works_at" do
@@ -72,7 +68,7 @@ class ChildrenDsl
     return super unless @write_mode
     relationship, options = parse_method_missing m, *args
 
-    options.merge!(binding: @outer_binding)
+    options.merge!(target: @target)
     NodeDsl.new(options, &blk).tap do |n|
       @node_dsls[n] = relationship
     end

data/lib/geoff/dsl_exception_handling.rb

@@ -0,0 +1,52 @@
+module DslExceptionHandling
+  #prevent very confusing method_missing calls during debugging by
+  #only writing to the object when expected
+  def write_mode
+    @write_mode = true
+    yield
+    @write_mode = false
+  end
+
+  def eval_with_exceptions &block
+    write_mode do
+      begin
+        instance_eval(&block)
+
+      rescue Exception => e
+        #don't swallow exceptions further down the tree
+        raise e if e.is_a? Geoff::DslSyntaxError
+
+        lines = caller.select{|c| (c !~ /geoff\/lib\/geoff/)and (c !~ /ruby-debug/) }
+
+        file, number, method = lines.first.split ":"
+        message = "Syntax Error in #{method} in Geoff DSL block for:\n#{file}:#{number}\n"
+
+        message << lines_around(file, number) do |m|
+          "\n\n#{e.message}\n\n"
+        end
+
+        raise Geoff::DslSyntaxError, message
+      end
+
+    end
+  end
+
+  def lines_around file, number, context = 10
+    number = number.to_i
+    range = (number - context) .. (number + context)
+    lines = File.read(file).split("\n")
+
+    filtered_lines = range.inject({}) do |l, i|
+      l[i] = lines[i]
+      l
+    end
+
+    filtered_lines.map do |line_number, line|
+      if line_number == number
+        yield + ">#{line_number}  #{line}"
+      else
+        " #{line_number}  #{line}"
+      end
+    end.join "\n"
+  end
+end

data/lib/geoff/importer.rb

@@ -3,12 +3,19 @@ require 'fileutils'
 Dir["lib/jars/*"].each {|file| require file }
 
 module Geoff
-  class MissingIndexedProperty < StandardError; end
+  class Error                  < StandardError ; end
+  class MissingIndexedProperty < Geoff::Error  ; end
+  class InvalidRules           < Geoff::Error  ; end
+
+  def self.import *args
+    Importer.import *args
+  end
 
   class Importer
-    class << self
+    Subgraph = org.neo4j.geoff.Subgraph
 
-      def import_files *files, options
+    class << self
+      def import_files(*files, options)
         concatenated = files.map{|f|File.read f}.join "\n"
 
         import concatenated, options
@@ -20,10 +27,6 @@ module Geoff
       end
 
       def import(geoff, options = {})
-        db_path = options[:test] ? 'db/test' : 'db/development'
-
-        Neo4j::Config[:storage_path] = db_path
-
         geoff = geoff.to_geoff unless geoff.is_a? String
 
         geoff = geoff.split "\n" if geoff.is_a? String
@@ -39,7 +42,7 @@ module Geoff
     end
 
     def go
-      raise 'Invalid rules' unless validate_rules(@rules)
+      raise Geoff::InvalidRules.new('Invalid rules') unless validate_rules(@rules)
       delete_database if drop?
 
       log 'importing the database'
@@ -68,7 +71,7 @@ module Geoff
     end
 
     def import_geoff_rules(rules)
-      sub_graph = org.neo4j.geoff.Subgraph.new(rules)
+      sub_graph = Subgraph.new(rules)
       node_map = { '0' => root_node }
       org.neo4j.geoff.Geoff.insertIntoNeo4j(sub_graph, Neo4j.db.graph, node_map );
     end
@@ -101,12 +104,12 @@ module Geoff
 
     rescue NativeException => e
       log "-" * 80
-      message = "Exception during re-indexing #{type} with #{@current_node} and index #{@current_index}"
+      message = "#{type} missing indexed attribute #{@current_index}, on node: #{@current_node.attributes}"
       log message
       log "-" * 80
       log e.message
       log "-" * 80
-      #raise Geoff::MissingIndexedProperty, message
+      raise Geoff::MissingIndexedProperty, message
     end
 
     def tx
@@ -138,16 +141,19 @@ module Geoff
     end
 
     def validate_rules(rules)
-      invalid = Array(rules).reject{ |r| validate_rule(r) }
-      invalid.each { |r| log "Rule '#{r}' is invalid" }
-      invalid.empty?
+      @invalid = Array(rules).map do |r|
+        validate_rule(r)
+      end.compact
+
+      @invalid.each { |r, message| log "Rule '#{r}' is invalid: #{message}" }
+      @invalid.empty?
     end
 
     def validate_rule(rule)
-      org.neo4j.geoff.Subgraph.new(Array(rule))
-      true
-    rescue
-      false
+      Subgraph.new(Array(rule))
+      nil
+    rescue Exception => e
+      return [rule, e.message]
     end
 
   end

data/lib/geoff/neo4j_wrapper_dsl.rb

@@ -21,6 +21,10 @@ class Neo4jWrapperDsl
     geoff.chomp
   end
 
+  def <=> other
+    to_geoff == other.to_geoff ? 0 : -1
+  end
+
   def to_s
     to_geoff
   end

data/lib/geoff/node_dsl.rb

@@ -1,6 +1,9 @@
 require 'geoff/children_dsl'
+require 'geoff/dsl_exception_handling'
 
 class NodeDsl
+  include DslExceptionHandling
+
   attr_reader :node_name
 
   def initialize(options, &block)
@@ -8,19 +11,20 @@ class NodeDsl
     @klass_name = options[:klass_name] || 'ROOT'
     @container  = options[:container]  || Container.new
     @rel_type   = options[:rel_type]
-    @outer_binding = options[:binding]
+    @target     = options[:target]
     @properties      = {}
     @children_dsls = []
 
     @rendered = false
 
-    write_mode { instance_eval(&block) } if block_given?
+    eval_with_exceptions(&block) if block_given?
   end
 
   def to_geoff
     geoff_lines.join "\n"
   end
 
+
   def geoff_lines
     #we need this to prevent rendering same node which is rendered already
     return [] if @rendered
@@ -59,14 +63,6 @@ class NodeDsl
     end
   end
 
-  #prevent very confusing method_missing calls during debugging by
-  #only writing to the object when expected
-  def write_mode
-    @write_mode = true
-    yield
-    @write_mode = false
-  end
-
   # e.g.
   #sandwich "BLT", type: :on_menu do
   #  filling 'bacon'
@@ -80,7 +76,7 @@ class NodeDsl
     else
       return super unless @write_mode
       val = if args.first.is_a? Proc
-              eval("@#{m}", @outer_binding)
+              @target.instance_exec &args.first
             else
               args.first
             end
@@ -94,13 +90,13 @@ class NodeDsl
 
   private
 
-  def children type=nil, &block
-    options = {
+  def children type=nil, options={}, &block
+    options.merge!({
       parent_node_name: @node_name,
       type:  type,
       container: @container,
-      binding: @outer_binding
-    }
+      target: @target
+    })
 
     @children_dsls << ChildrenDsl.new(options, &block)
   end

data/lib/geoff/version.rb

@@ -1,3 +1,3 @@
 module Geoff
-  VERSION = "0.0.2.beta"
+  VERSION = "0.0.3.beta"
 end

data/spec/integration/children_dsl_spec.rb

@@ -38,9 +38,9 @@ describe ChildrenDsl do
     let(:top)    {ChildrenDsl.new(parent_node_name: 'starbucks', type: :x ){area 'Luton' } }
     let(:on_node){ChildrenDsl.new(parent_node_name: 'starbucks')           {area 'Luton', type: :x }}
 
-    specify { ->{missing }.should     raise_error ArgumentError}
-    specify { ->{ top    }.should_not raise_error ArgumentError }
-    specify { ->{ on_node}.should_not raise_error ArgumentError }
+    specify { ->{missing }.should     raise_error Geoff::DslSyntaxError}
+    specify { ->{ top    }.should_not raise_error  }
+    specify { ->{ on_node}.should_not raise_error  }
   end
 
   describe 'with special node' do

data/spec/integration/node_dsl_spec.rb

@@ -58,20 +58,20 @@ describe NodeDsl do
       strip_whitespace <<-EOS
         (starbucks) {"_classname":"Cafe"}
         (Cafe)-[:all]->(starbucks)
-        (starbucks_branch_1) {"_classname":"Branch","delay_time":15,"hours":"3"}
+        (starbucks_branch_1) {"_classname":"Branch","delay_time":15,"opening_hours":3}
         (Branch)-[:all]->(starbucks_branch_1)
         (starbucks)-[:owns]->(starbucks_branch_1) {"some":"property"}
       EOS
     end
 
     specify do
-      @hours = "3"
+      @hours = 3
 
-      node = NodeDsl.new(node_name: 'starbucks', klass_name: 'Cafe', binding: binding) do
+      node = NodeDsl.new(node_name: 'starbucks', klass_name: 'Cafe', target: self) do
         children do
           branch 'starbucks_branch_1', type: 'owns', some: 'property' do
             delay_time 15
-            hours ->{@hours}
+            opening_hours ->{@hours}
           end
         end
       end

metadata

@@ -2,7 +2,7 @@
 name: geoff
 version: !ruby/object:Gem::Version
   prerelease: 6
-  version: 0.0.2.beta
+  version: 0.0.3.beta
 platform: ruby
 authors:
 - David Rouchy
@@ -13,7 +13,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-08-10 00:00:00.000000000 Z
+date: 2012-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: neo4j
@@ -123,6 +123,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rvmrc
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -132,6 +133,7 @@ files:
 - lib/geoff.rb
 - lib/geoff/children_dsl.rb
 - lib/geoff/container.rb
+- lib/geoff/dsl_exception_handling.rb
 - lib/geoff/importer.rb
 - lib/geoff/neo4j_wrapper_dsl.rb
 - lib/geoff/neo4j_wrapper_validator.rb