neo4j_helper 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  #gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  #gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,17 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2.2)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Peter Ehrlich
+
+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.md

@@ -0,0 +1,74 @@
+# neo4j_helper
+
+This is an add-on library to https://github.com/andreasronge/neo4j
+
+I was just using mongoid, and it was great because you could throw anything at it and have it work.  This is an
+attempt to bring rails neo4j to the same accomplishment.  
+
+Read the source, its educational.
+
+
+    gem install neo4j_helper
+
+
+## Usage
+
+Methods are automatically added to Neo4j::Rails::Model.  This means once you install the gem, you can't get away from them.  If this causes issues, let me know, and maybe we can implement a mixin instead.
+
+
+### Automatic JSON serialization
+
+    # user.rb
+    property :facebook_credentials, :type => :serialize
+
+Todo: allow indexing and searching on serialized info, like mongoid.  (see: [group post](https://groups.google.com/d/msg/neo4jrb/KWxKBMbCc9E/E2XKIhzyvucJ)
+
+
+### Automatic object creation
+
+Notices a passed-in hash to a relationship, and makes the right node.  You can pass a block if it returns a model instance.
+
+    # user.rb
+    has_one(:location).to(Location)
+    accepts_hash_for :location do |attributes|
+        Location.new attributes
+    end
+
+In fact, the above is done automatically with no block, so this is just the same effect:
+
+    # user.rb
+    has_one(:location).to(Location)
+    accepts_hash_for :location
+
+### Misc
+
+
+TODO: niceties to try and bring the syntax as close as possible to mongoid;
+
+ - .limit(), .page(), and .sort(),
+ - allowing the :unique flag to be passed to indexes (like mongoid),
+ - making the difference between the Lucene query and neo4j traversal more evident, useful, or hidden
+ - looking for some syntactic sugar so that its not necessary to do a wildcard query returning a lucene search in order to run a sort.
+ - command to automatically add missing indexes
+ - whatever comes next
+
+
+
+## Contributing
+
+
+Once you've made your great commits
+
+1. Fork
+1. Pull # > git clone git://whatever
+1. Push # > git push
+1. Pull request # github's GUI
+1. \# That's it!
+
+
+
+## Contributors
+
+Peter Ehrlich [@ehrlicp](http://www.twitter.com/ehrlicp)
+<br/>
+(This rdoc written with Mou, a sweet markdown editor from [@chenluois](http://twitter.com/chenluois))

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "neo4j_helper"
+  gem.homepage = "http://github.com/pehrlich/neo4j_helper"
+  gem.license = "WTFPL"
+  gem.summary = %Q{Making neo4j gem mo' spiffy for your data-nomming needs}
+  gem.description = %Q{Attemting to minimize the syntactical learning curve from other ORMs}
+  gem.email = "peter.i.ehrlich@gmail.com"
+  gem.authors = ["Peter Ehrlich"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "neo4j_helper #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/neo4j_helper.rb

@@ -0,0 +1,3 @@
+require 'neo4j_helper/accepts_hash_for'
+require 'neo4j_helper/serialize'
+require 'neo4j_helper/misc'

data/lib/neo4j_helper/accepts_hash_for.rb

@@ -0,0 +1,64 @@
+module Neo4j
+  module Rails
+    class Model
+      class << self
+
+        # This allows anything to be thrown at a relationship and understood.
+        # usage:
+        #
+        # has_one(:location).to(Location)
+        # accepts_hash_for :location
+        #
+        # Will run Location.new with the passed in :location hash.
+        # You can also give it a block which returns a location node:
+        #
+        # accepts_hash_for :location do |location_attributes|
+        #   Location.find_or_create_by(:name => location_attributes[:name])
+        # end
+        #
+        def accepts_hash_for(prop, *block)
+          # todo: handle persistence?
+          # for working with this method, see these neo4j examples:
+          # def _add_relationship(rel_type, node)
+          # def update_nested_attributes
+          # def accepts_nested_attributes_for
+
+          rel = self._decl_rels[prop.to_sym]
+          raise "No relationship declared with has_n or has_one with type #{prop}" unless rel
+
+          if rel.has_one?
+            setter = :"#{prop}="
+            original_setter = :"#{prop}_without_accepting_hash="
+
+            define_method :"#{prop}_with_accepting_hash=" do |attributes|
+
+              node = if attributes.is_a? rel.target_class
+                       attributes
+                     elsif attributes.present?
+                       # not sure what would be to happen if a block were somehow to be given to the setter method
+                       if block_given?
+                         yield(attributes)
+                       else
+                         # todo: allow find_or_create
+                         target_class.new attributes
+                       end
+                     else
+                       nil
+                     end
+
+              send(original_setter, node)
+            end
+
+            alias_method_chain setter, :accepting_hash
+          end
+
+        else
+          # todo: has_n
+        end
+
+
+      end
+
+    end
+  end
+end

data/lib/neo4j_helper/misc.rb

@@ -0,0 +1,37 @@
+module Neo4jHelpers
+
+  extend ActiveSupport::Concern
+
+  included do
+    alias_method :properties, :attributes
+  end
+
+  module InstanceMethods
+
+  end
+
+  module ClassMethods
+
+    def find_by(options)
+      self.find(options)
+    end
+
+  end
+
+end
+
+
+=begin
+ todo:
+
+So far will mainly include niceties to try and bring the syntax as close as possible to mongoid;
+ - .limit(), .page(), and .sort(),
+ - allowing the :unique flag to be passed to indexes (like mongoid),
+ - making the difference between the Lucene query and neo4j traversal more evident, useful, or hidden
+ - looking for some syntactic sugar so that its not necessary to do a wildcard query returning a lucene search in order to run a sort.
+ - command to automatically add missing indexes
+ - figure out "title: long" vs :title => "long"
+
+ - way to obtain write lock without quitting and restarting server?
+
+=end

data/lib/neo4j_helper/serialize.rb

@@ -0,0 +1,25 @@
+module Neo4j
+  module TypeConverters
+    class SerializeConverter
+      # serializes to sting
+      class << self
+
+        def convert?(type)
+          type == :serialize
+        end
+
+        def to_java(value)
+          return nil unless value
+          JSON.generate(value).to_s
+        end
+
+        def to_ruby(value)
+          return nil unless value
+          JSON.parse(value.to_s)
+        end
+      end
+
+    end
+    converters = nil # reload converters
+  end
+end

data/neo4j_helper.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "neo4j_helper"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Peter Ehrlich"]
+  s.date = "2012-01-25"
+  s.description = "Attemting to minimize the syntactical learning curve from other ORMs"
+  s.email = "peter.i.ehrlich@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/neo4j_helper.rb",
+    "lib/neo4j_helper/accepts_hash_for.rb",
+    "lib/neo4j_helper/misc.rb",
+    "lib/neo4j_helper/serialize.rb",
+    "neo4j_helper.gemspec",
+    "test/helper.rb",
+    "test/test_neo4j_helper.rb"
+  ]
+  s.homepage = "http://github.com/pehrlich/neo4j_helper"
+  s.licenses = ["WTFPL"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.13"
+  s.summary = "Making neo4j gem mo' spiffy for your data-nomming needs"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'neo4j_helper'
+
+class Test::Unit::TestCase
+end

data/test/test_neo4j_helper.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestNeo4jHelper < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: neo4j_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Peter Ehrlich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70196155311840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70196155311840
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70196155310760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70196155310760
+description: Attemting to minimize the syntactical learning curve from other ORMs
+email: peter.i.ehrlich@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/neo4j_helper.rb
+- lib/neo4j_helper/accepts_hash_for.rb
+- lib/neo4j_helper/misc.rb
+- lib/neo4j_helper/serialize.rb
+- neo4j_helper.gemspec
+- test/helper.rb
+- test/test_neo4j_helper.rb
+homepage: http://github.com/pehrlich/neo4j_helper
+licenses:
+- WTFPL
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3732617207430592
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.13
+signing_key: 
+specification_version: 3
+summary: Making neo4j gem mo' spiffy for your data-nomming needs
+test_files: []