neoid 0.1.2 → 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTViMzkyM2ZlZmY5NDliZTcxN2I4ODAzODAwN2Y1ZWEzYjVkOGZiMQ==
+  data.tar.gz: !binary |-
+    MTczODYzMmJjODQzOTA5MjIxYjg2ZWY5OTBiM2I0N2JlMDg3OWE5OQ==
+SHA512:
+  metadata.gz: !binary |-
+    MWY4ZWZhZTJhMTJhN2VjZjg5ODA1NWE1ODI4NDY1OTdhNTI2M2MyOGI0MjI2
+    MmEzNjg2OTgzMzRiNDA3NDgwYjY4NWY1NzU3OWJlMTA5YjlhOTA0NjY2OWE4
+    YzY5YTIwYWU4MjQyNTgxZWE2YzYwYTkwOWE1Njc0OWY4ODExMzk=
+  data.tar.gz: !binary |-
+    ZGYyMTEwOGM5MjY0ZGVlMjljZDIzYTQ1NWQ1OTQ0ZmY4ZmUxMzFiOTk0OTYx
+    NzU1M2ZmYjhlNjQ5OWY3YzA1MTUwMTY0YzhjNDQxMTc3NjAwNmYzMDc0OWIw
+    NWM1YWQxNTc4MmY5NzRiOGM2MGM3ODVmNjNmNGI0YWY3ZTE5YWQ=

data/LICENSE

@@ -16,4 +16,4 @@ 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.
+THE SOFTWARE.

data/README.md

@@ -1,17 +1,20 @@
 # Neoid
 
-[![Build Status](https://secure.travis-ci.org/elado/neoid.png)](http://travis-ci.org/elado/neoid)
+[![Gem Version](https://badge.fury.io/rb/neoid.svg)](http://badge.fury.io/rb/neoid)
+[![Code Climate](https://codeclimate.com/github/neoid-gem/neoid.png)](https://codeclimate.com/github/neoid-gem/neoid)
+[![Build Status](https://secure.travis-ci.org/neoid-gem/neoid.png)](http://travis-ci.org/neoid-gem/neoid)
 
+__This gem is not stable. There are currently no stable versions. We're working on fixing this right now. Apologies.__
 
-Make your ActiveRecords stored and searchable on Neo4j graph database, in order to make fast graph queries that MySQL would crawl while doing them.
+Make your ActiveRecords stored and searchable on Neo4j graph database, in order to make fast graph queries that MySQL would crawl while doing them. Originally by [@elado](http://twitter.com/elado).
 
-Neoid to Neo4j is like Sunspot to Solr. You get the benefits of Neo4j speed while keeping your schema on your plain old RDBMS.
+Neoid is to Neo4j as Sunspot is to Solr. You get the benefits of Neo4j's speed while keeping your schema on your RDBMS.
 
-Neoid doesn't require JRuby. It's based on the great [Neography](https://github.com/maxdemarzi/neography) gem which uses Neo4j's REST API.
+Neoid does not require JRuby. It's based on the [Neography](https://github.com/maxdemarzi/neography) gem which uses Neo4j's REST API.
 
 Neoid offers querying Neo4j for IDs of objects and then fetch them from your RDBMS, or storing all desired data on Neo4j.
 
-**Important: Heroku Support is not available because Herokud doesn't support Gremlin. So until further notice, easiest way is to self host a Neo4j on EC2 in the same zone, and connect from your dyno to it**
+__Important: If you are hosting your application on Heroku with Neoid, [GrapheneDB](http://www.graphenedb.com/) does support Gremlin code; their add-on is [located here](https://addons.heroku.com/graphenedb). Also be reminded that the Gremlin code is actively being refactored into Cypher.__
 
 ## Changelog
 
@@ -23,16 +26,26 @@ Neoid offers querying Neo4j for IDs of objects and then fetch them from your RDB
 Add to your Gemfile and run the `bundle` command to install it.
 
 ```ruby
-gem 'neoid', '~> 0.1.1'
+gem 'neoid', '~> 0.2.0'
 ```
 
-**Requires Ruby 1.9.2 or later.**
+**Requires Ruby 1.9.3 or later and Neo4j 1.9.8.**
+
+### Installing Neo4j 1.9.8 for your project
+
+We're currently working to bump to 2.1.x land, but for now, you have to use 1.9.8. To get started, install neo4j locally in your project with:
+
+```bash
+gem install neo4j-core --pre
+rake neo4j:install[community,1.9.8]
+rake neo4j:start
+```
 
 ## Usage
 
 ### Rails app configuration:
 
-In an initializer, such as `config/initializers/01_neo4j.rb`:
+Initializer neography and neoid in an initializer that is prefixed with `01_`, such as `config/initializers/01_neo4j.rb`:
 
 ```ruby
 ENV["NEO4J_URL"] ||= "http://localhost:7474"
@@ -60,11 +73,6 @@ Neoid.configure do |c|
 end
 ```
 
-`01_` in the file name is in order to get this file loaded first, before the models (initializers are loaded alphabetically).
-
-If you have a better idea (I bet you do!) please let me know.
-
-
 ### ActiveRecord configuration
 
 #### Nodes
@@ -157,7 +165,7 @@ class Like < ActiveRecord::Base
 end
 ```
 
-Neoid adds the metohds `neo_node` and `neo_relationships` to instances of nodes and relationships, respectively.
+Neoid adds the methods `neo_node` and `neo_relationships` to instances of nodes and relationships, respectively.
 
 So you could do:
 
@@ -413,7 +421,8 @@ In order to test your app or this gem, you need a running Neo4j database, dedica
 
 I use port 7574 for testing.
 
-To run another database locally (read [here](http://docs.neo4j.org/chunked/1.9.M03/server-installation.html#_multiple_server_instances_on_one_machine) too):
+To run another database locally (read
+[here](http://docs.neo4j.org/chunked/stable/ha-setup-tutorial.html#ha-local-cluster) too):
 
 Copy the entire Neo4j database folder to a different location,
 
@@ -445,23 +454,16 @@ end
 
 ## Testing This Gem
 
-Run the Neo4j DB on port 7574, and run `rake` from the gem folder.
+Run the Neo4j DB on port 7474, and run `rake` from the gem folder.
 
 ## Contributing
 
 Please create a [new issue](https://github.com/elado/neoid/issues) if you run into any bugs. Contribute patches via pull requests. Write tests and make sure all tests pass.
 
-
-## Heroku Support
-
-Unfortunately, as for now, Neo4j add-on on Heroku doesn't support Gremlin. Therefore, this gem won't work on Heroku's add on. You should self-host a Neo4j instance on an EC2 or any other server.
-
-
 ## TO DO
 
-[TO DO](HTTPS://GITHUB.COM/ELADO/NEOID/BLOB/MASTER/TODO.MD)
-
+[TO DO](https://github.com/elado/neoid/blob/master/TODO.md)
 
 ---
 
-Developed by [@elado](http://twitter.com/elado)
+Developed by [@elado](http://twitter.com/elado) and [@BenMorganIO](http://twitter.com/BenMorganIO)

data/Rakefile

@@ -1,7 +1,7 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'neography/tasks'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task default: :spec

data/lib/neoid.rb

@@ -22,11 +22,11 @@ module Neoid
     attr_accessor :ref_node
     attr_accessor :env_loaded
     attr_reader :config
-    
+
     def node_models
       @node_models ||= []
     end
-    
+
     def relationship_models
       @relationship_models ||= []
     end
@@ -49,7 +49,7 @@ module Neoid
 
     def initialize_all
       @env_loaded = true
-      logger.info "Neoid initialize_all"
+      logger.info 'Neoid initialize_all'
       initialize_relationships
       initialize_server
     end
@@ -58,34 +58,43 @@ module Neoid
       initialize_auto_index
       initialize_subrefs
       initialize_per_model_indexes
+      # begin
+      #   @initialized_server = true
+      #   initialize_auto_index
+      #   initialize_subrefs
+      #   initialize_per_model_indexes
+      # rescue Exception => e
+      #   @initialized_server = false
+      #   logger.error "Failed to initialize neoid: #{e.message}"
+      # end
     end
-    
+
     def db
-      raise "Must set Neoid.db with a Neography::Rest instance" unless @db
+      raise 'Must set Neoid.db with a Neography::Rest instance' unless @db
+      # initialize_server unless @initialized_server
       @db
     end
 
     def batch(options={}, &block)
       Neoid::Batch.new(options, &block).run
     end
-    
+
     def logger
       @logger ||= Logger.new(ENV['NEOID_LOG'] ? ENV['NEOID_LOG_FILE'] || $stdout : '/dev/null')
     end
-    
+
     def ref_node
       @ref_node ||= Neography::Node.load(Neoid.db.get_root['self'])
     end
-    
+
     def reset_cached_variables
       initialize_subrefs
     end
-    
+
     def clean_db(confirm)
-      puts "must call with confirm: Neoid.clean_db(:yes_i_am_sure)" and return unless confirm == :yes_i_am_sure
+      puts 'must call with confirm: Neoid.clean_db(:yes_i_am_sure)' and return unless confirm == :yes_i_am_sure
       Neoid::NeoDatabaseCleaner.clean_db
     end
-    
 
     def enabled=(flag)
       Thread.current[:neoid_enabled] = flag
@@ -124,7 +133,7 @@ module Neoid
     end
 
     def search(types, term, options = {})
-      options = options.reverse_merge(limit: 15)
+      options = options.reverse_merge(limit: 15, match_type: 'AND')
 
       types = [*types]
 
@@ -139,17 +148,17 @@ module Neoid
         when String
           search_in_fields = type.neoid_config.search_options.fulltext_fields.keys
           next if search_in_fields.empty?
-          query_for_type << search_in_fields.map{ |field| generate_field_query(field, term, true) }.join(" OR ")
+          query_for_type << search_in_fields.map{ |field| generate_field_query(field, term, true, options[:match_type]) }.join(' OR ')
         when Hash
           term.each do |field, value|
             query_for_type << generate_field_query(field, value, false)
           end
         end
 
-        query << "(#{query_for_type.join(") AND (")})"
+        query << "(#{query_for_type.join(') AND (')})"
       end
 
-      query = "(#{query.join(") OR (")})"
+      query = "(#{query.join(') OR (')})"
 
       logger.info "Neoid query #{query}"
 
@@ -159,7 +168,7 @@ module Neoid
         idx = g.getRawGraph().index().forNodes('#{DEFAULT_FULLTEXT_SEARCH_INDEX_NAME}')
         hits = idx.query('#{sanitize_query_for_gremlin(query)}')
 
-        hits = #{options[:limit] ? "hits.take(#{options[:limit]})" : "hits"}
+        hits = #{options[:limit] ? "hits.take(#{options[:limit]})" : 'hits'}
 
         #{options[:after_query]}
       GREMLIN
@@ -172,65 +181,69 @@ module Neoid
     end
 
     private
-      def sanitize_term(term)
-        # TODO - case sensitive?
-        term.downcase
-      end
 
-      def sanitize_query_for_gremlin(query)
-        # TODO - case sensitive?
-        query.gsub("'", "\\\\'")
-      end
+    def sanitize_term(term)
+      # TODO - case sensitive?
+      term.downcase
+    end
 
-      def generate_field_query(field, term, fulltext = false)
-        term = term.to_s if term
-        return "" if term.nil? || term.empty?
+    def sanitize_query_for_gremlin(query)
+      # TODO - case sensitive?
+      query.gsub("'", "\\\\'")
+    end
 
-        fulltext = fulltext ? "_fulltext" : nil
+    def generate_field_query(field, term, fulltext = false, match_type = 'AND')
+      term = term.to_s if term
+      return '' if term.nil? || term.empty?
 
-        "(" + term.split(/\s+/).reject(&:empty?).map{ |t| "#{field}#{fulltext}:#{sanitize_term(t)}" }.join(" AND ") + ")"
-      end
+      fulltext = fulltext ? '_fulltext' : nil
+      valid_match_types = %w( AND OR )
+      match_type = valid_match_types.delete(match_type)
+      raise "Invalid match_type option. Valid values are #{valid_match_types.join(',')}" unless match_type
 
-      def initialize_relationships
-        logger.info "Neoid initialize_relationships"
-        relationship_models.each do |rel_model|
-          Relationship.initialize_relationship(rel_model)
-        end
+      '(' + term.split(/\s+/).reject(&:empty?).map{ |t| "#{field}#{fulltext}:#{sanitize_term(t)}" }.join(" #{match_type} ") + ')'
+    end
+
+    def initialize_relationships
+      logger.info 'Neoid initialize_relationships'
+      relationship_models.each do |rel_model|
+        Relationship.initialize_relationship(rel_model)
       end
+    end
 
-      def initialize_auto_index
-        logger.info "Neoid initialize_auto_index"
-        Neoid.db.set_node_auto_index_status(true)
-        Neoid.db.add_node_auto_index_property(UNIQUE_ID_KEY)
+    def initialize_auto_index
+      logger.info 'Neoid initialize_auto_index'
+      Neoid.db.set_node_auto_index_status(true)
+      Neoid.db.add_node_auto_index_property(UNIQUE_ID_KEY)
 
-        Neoid.db.set_relationship_auto_index_status(true)
-        Neoid.db.add_relationship_auto_index_property(UNIQUE_ID_KEY)
-      end
+      Neoid.db.set_relationship_auto_index_status(true)
+      Neoid.db.add_relationship_auto_index_property(UNIQUE_ID_KEY)
+    end
 
-      def initialize_subrefs
-        return unless config.enable_subrefs
-        
-        node_models.each do |klass|
-          klass.reset_neo_subref_node
-        end
+    def initialize_subrefs
+      return unless config.enable_subrefs
 
-        logger.info "Neoid initialize_subrefs"
-        batch do
-          node_models.each(&:neo_subref_node)
-        end.then do |results|
-          node_models.zip(results).each do |klass, subref|
-            klass.neo_subref_node = subref
-          end
+      node_models.each do |klass|
+        klass.reset_neo_subref_node
+      end
+
+      logger.info 'Neoid initialize_subrefs'
+      batch do
+        node_models.each(&:neo_subref_node)
+      end.then do |results|
+        node_models.zip(results).each do |klass, subref|
+          klass.neo_subref_node = subref
         end
       end
+    end
 
-      def initialize_per_model_indexes
-        return unless config.enable_per_model_indexes
+    def initialize_per_model_indexes
+      return unless config.enable_per_model_indexes
 
-        logger.info "Neoid initialize_subrefs"
-        batch do
-          node_models.each(&:neo_model_index)
-        end
+      logger.info 'Neoid initialize_subrefs'
+      batch do
+        node_models.each(&:neo_model_index)
       end
+    end
   end
 end

data/lib/neoid/batch.rb

@@ -67,7 +67,7 @@ module Neoid
 
       begin
         @block.call(self)
-      ensure      
+      ensure
         self.class.reset_current_batch
       end
 
@@ -79,40 +79,40 @@ module Neoid
     end
 
     private
-      def flush_batch
-        return [] if commands.empty?
-        current_results = nil
 
-        # results = Neoid.db.batch(*commands).collect { |result| result['body'] }
+    def flush_batch
+      return [] if commands.empty?
+      current_results = nil
 
-        benchmark = Benchmark.measure {
-          current_results = Neoid.db.batch(*commands).collect { |result| result['body'] }
-        }
-        Neoid.logger.info "Neoid batch (#{commands.length} commands) - #{benchmark}"
-        commands.clear
+      benchmark = Benchmark.measure {
+        current_results = Neoid.db.batch(*commands)
+        current_results.map { |result| result['body'] } if current_results.respond_to?(:map)
+      }
+      Neoid.logger.info "Neoid batch (#{commands.length} commands) - #{benchmark}"
+      commands.clear
 
-        process_results(current_results)
+      process_results(current_results)
 
-        thens.zip(current_results).each { |t, result| t.perform(result) }
+      thens.zip(current_results).each { |t, result| t.perform(result) }
 
-        thens.clear
+      thens.clear
 
-        results.concat current_results
-      end
+      results.concat current_results
+    end
 
-      def process_results(results)
-        results.map! do |result|
-          return result unless result.is_a?(Hash) && result['self'] && result['self'][%r[^https?://.*/(node|relationship)/\d+]]
+    def process_results(results)
+      results.map! do |result|
+        return result unless result.is_a?(Hash) && result['self'] && result['self'][%r[^https?://.*/(node|relationship)/\d+]]
 
-          type = case $1
-          when 'node' then Neoid::Node
-          when 'relationship' then Neoid::Relationship
-          else return result
-          end
+        type = case $1
+               when 'node' then Neoid::Node
+               when 'relationship' then Neoid::Relationship
+               else return result
+               end
 
-          type.from_hash(result)
-        end
+        type.from_hash(result)
       end
+    end
   end
 
   # returned from a full batch, after it has been executed,
@@ -140,13 +140,13 @@ module Neoid
   # it proxies all methods to the result, so in case it is returned (like in Neoid.execute_script_or_add_to_batch)
   # the result of the method will be proxied to the result from the batch. See Node#neo_save
   class SingleResultPromiseProxy
-    def initialize(*args)
+    def initialize(*)
     end
 
     attr_accessor :result
 
     def result
-      raise "Accessed result too soon" unless @result
+      raise 'Accessed result too soon' unless @result
       @result
     end