ar_indexer 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa39816650293a0f047abdb37904896c014c55bd
-  data.tar.gz: ef02ddc7309dff62fe338855594d10974aa1d51d
+  metadata.gz: e7c29be1f921a9f40f47975390cd2658ef90eb91
+  data.tar.gz: 727458d961183a7e364d625085fa29dc6a7b97ee
 SHA512:
-  metadata.gz: ee6a361b3a92fefcf3a8e633abf534ab97aac4051e0aedd1760bb91ef9ad08cd20e69f9213701abe185b1ce379466d8a756f438a62782912980e38ce4951db74
-  data.tar.gz: 43eff60e824f598b2ce6acbf71a48ba626edc14c35dd6b3aa8e1ddc37024dc112cee5937a64cc4fbcea7b57e78257aba02bb428c7f5efdb1390b0e8dd28b8e35
+  metadata.gz: bce0e4fccb1de8992adab38ee2b81957cf76004f9c7d3c396744c4eb81e385149aef13ac7463453aaaea8b5b15ed039f26561f70f2cdf4582009c6be8729a2af
+  data.tar.gz: 8f2ca453649095cdca6d52dcf862e2c54dae0b3cc8cd4ebee86f985b3309d69cbdfc8ea85dd439ec617044d49317ef91379715e91d30464839888976b2b563d8

data/README.md

@@ -10,17 +10,17 @@ Add ARIndexer to your Gemfile
     
     gem 'ar_indexer'
 
-Write a migration to add a reverse_indices table to the database (Rails migration generator coming soon)
+Write a migration to add a reverse_indices table to the database (Rails migration generator coming soon). Due to an exception encountered in Rails 4.2 (DangerousAttributes exception), the model\_name column has been renamed to model\_constant.
 
     class CreateReverseIndices < ActiveRecord::Migration
       def change
         create_table :reverse_indices do |t|
-          t.string :model_name
+          t.string :model_constant
           t.string :field_name
           t.string :word
           t.text :id_list
         end
-        add_index :reverse_indices, [:model_name, :field_name, :word], :unique => true
+        add_index :reverse_indices, [:model_constant, :field_name, :word], :unique => true
       end
     end
 
@@ -30,30 +30,56 @@ Run `rake db:migrate`
 
 ###Indexing###
 
-Have an ActiveRecord model? Want to index some text for searching? Just add the `has_reverse_index` function to your model. Call the function with no parameters and ARIndexer will index all string and text fields. You can pass an optional array of field names (as symbols), and ARIndexer will index only these fields. Also, you can pass a hash with association names as keys and a lambda to access the necessary data. Note that the lambda must accept the AR object as its sole argument and must return a string.
+Have an ActiveRecord model? Want to index some text for searching? Just add the `has_reverse_index` function to your model. Call the function with no parameters and ARIndexer will index all string and text fields. You can pass an optional hash of configuration values to customize which fields and associations are indexed, and how often each type of "field" are indexed. The default hash is below, and will be merged with the hash you pass in.
+
+    ari_configuration = {
+      fields: [],
+      associations: {},
+      index_on_create: [],
+      index_on_update: []
+    }
+
+To expand on the above configuration:
+* fields: If empty, will index all String and Text fields of the AR model. Pass an array of `Symbol` field names to only index the whitelisted fields
+* associations: If empty, will not index any associations. For each association to be indexed, add a `Symbol` key as the name of the association, pointing to a `lambda` which takes the object being indexed, and returns a string value.
+* index_on_create: If empty, will index both fields and associations as an after_create function. Add `:fields` and/or `:associations` to the array to control which are automatically indexed.
+* index_on_update: If empty, will index both fields and associations as an after_update function. Add `:fields` and/or `:associations` to the array to control which are automatically indexed.
+
+Below is an example configuration hash passed for an example `Article` model, which has a collection of `Tag` objects. In this example, we've chosen to only automatically index the fields, sometimes necessary when an AR object needs to have `reload` called on it to make sure associations are up to date. Include as many or as few options as you need.
+    
+    {
+      fields: [:title, :subtitle, :content],
+      associations: {
+        tags: lambda {|object| object.tags.collect{|tag| tag.name}.join(', ')}
+      },
+      index_on_create: [:fields],
+      index_on_update: [:fields]
+    }
+
+Now let's see some examples in the models:
 
     class Post < ActiveRecord::Base
       has_reverse_index
     end
 
     class Article < ActiveRecord::Base
-      has_reverse_index([:title, :content])
+      has_reverse_index({
+        fields: [:title, :content]
+      })
     end
 
     class Article < ActiveRecord::Base
       has_many :article_tags
       has_many :tags, :through => :article_tags
-      has_reverse_index(
-        [
-          :title,
-          :content
-        ],
-        {
-          :tags => lambda {|object| object.tags.collect{|tag| tag.name}.join(', ')}
+      has_reverse_index({
+        fields: [:title, :content],
+        associations: {
+          tags: lambda {|object| object.tags.collect{|tag| tag.name}.join(', ')}
         }
-      )
+      })
+    end
 
-At this point, ARIndexer will build and maintain a reverse index for each record under these models. If you need to reindex the object at any time, the instance methods `reindex_object`, `reindex_fields`, and `reindex_associations` are added to all ActiveRecord objects with `has_reverse_index` declared.
+At this point, ARIndexer will build and maintain a reverse index for each record under these models. If you need to reindex the object at any time, the instance methods `index_object`, `index_fields`, and `index_associations` are added to all ActiveRecord objects with `has_reverse_index` declared.
 
 ###Searching###
 

data/ar_indexer.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |spec|
   # Basic Gem Description
   spec.name          = "ar_indexer"
-  spec.version       = "0.2.2"
-  spec.date          = "2014-10-08"
+  spec.version       = "0.3.1"
+  spec.date          = "2015-02-05"
   spec.summary       = "Allows for reverse indexing selected ActiveRecord models. Handles searching and return of objects"
   spec.description   = spec.summary
   spec.authors       = ["Josh MacLachlan"]
@@ -19,5 +19,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency('fast-stemmer')
 
   # Post-Install Message
-  spec.post_install_message = "If you're upgrading from v0.1.4 to v0.2.0, read the updated documentation. Your application will throw exceptions when trying to access indexed models."
+  spec.post_install_message = "If upgrading from v0.1.x to 0.2.x or 0.2.x to 0.3.x, be sure to read the updated documentation. Major changes were made to initialization."
 end

data/lib/ar_indexer/has_reverse_index.rb

@@ -5,7 +5,12 @@ module ARIndexer
     end
 
     module ClassMethods
-      def has_reverse_index(fields = [], associations = {})
+      def has_reverse_index(indexing_opts = {})
+        if indexing_opts.nil?
+          indexing_opts = {}
+        end
+
+        fields = indexing_opts[:fields] || []
         fields.each do |field_name|
           unless self.columns_hash.keys.include?(field_name.to_s)
             unless ['string', 'text'].include?(self.columns_hash[field_name.to_s].type.to_s)
@@ -14,6 +19,7 @@ module ARIndexer
           end
         end
 
+        associations = indexing_opts[:associations] || {}
         associations.each do |association_name, access_function|
           unless access_function.class == Proc
             raise TypeError, 'Model associations must have a Proc provided in order to reach the appropriate value.'
@@ -22,10 +28,13 @@ module ARIndexer
 
         send :include, InstanceMethods
 
-        class_attribute :indexed_fields
-        class_attribute :indexed_associations
-        self.indexed_fields = fields.clone || []
-        self.indexed_associations = associations.clone || {}
+        class_attribute :ari_configuration
+        self.ari_configuration = {
+          fields: [],
+          associations: {},
+          index_on_create: [],
+          index_on_update: []
+        }.merge(indexing_opts)
 
         after_create :ar_indexer_on_create
         after_update :ar_indexer_on_update
@@ -34,26 +43,26 @@ module ARIndexer
       module_function :has_reverse_index
 
       module InstanceMethods
-        def reindex_object
+        def index_object(cleanup = false)
           values_to_index = ar_indexer_get_indexable_values
           values_to_index.each do |field_name, value|
-            Indexer.index_string(self.class.to_s.split('::').last, self.id, field_name, value, false)
+            Indexer.index_string(self.class.to_s.split('::').last, self.id, field_name, value, cleanup)
           end
         end
         
-        def reindex_fields
+        def index_fields(cleanup = false)
           values_to_index = ar_indexer_get_indexable_values
-          values_to_index.delete_if {|key, value| self.indexed_associations.keys.map{|field| field.to_s}.include?(key)}
+          values_to_index.delete_if {|key, value| self.ari_configuration[:associations].keys.map{|field| field.to_s}.include?(key)}
           values_to_index.each do |field_name, value|
-            Indexer.index_string(self.class.to_s.split('::').last, self.id, field_name, value, false)
+            Indexer.index_string(self.class.to_s.split('::').last, self.id, field_name, value, cleanup)
           end
         end
 
-        def reindex_associations
+        def index_associations(cleanup = false)
           values_to_index = ar_indexer_get_indexable_values
-          values_to_index.delete_if {|key, value| self.indexed_fields.map{|field| field.to_s}.include?(key)}
+          values_to_index.delete_if {|key, value| self.ari_configuration[:fields].map{|field| field.to_s}.include?(key)}
           values_to_index.each do |field_name, value|
-            Indexer.index_string(self.class.to_s.split('::').last, self.id, field_name, value, false)
+            Indexer.index_string(self.class.to_s.split('::').last, self.id, field_name, value, cleanup)
           end
         end
 
@@ -62,7 +71,7 @@ module ARIndexer
         def ar_indexer_get_indexable_values
           values_to_index = {}
           
-          if self.indexed_fields.empty?
+          if self.class.ari_configuration[:fields].empty?
             self.class.columns.each do |column|
               if ['string', 'text'].include? column.type.to_s
                 value = self.read_attribute(column.name)
@@ -74,7 +83,7 @@ module ARIndexer
               end
             end
           else
-            self.indexed_fields.each do |field_name|
+            self.class.ari_configuration[:fields].each do |field_name|
               value = self[field_name]
               if value.class == String
                 unless value.empty?
@@ -84,8 +93,8 @@ module ARIndexer
             end
           end
 
-          unless self.indexed_associations.empty?
-            self.indexed_associations.each do |association_name, access_function|
+          unless self.class.ari_configuration[:associations].empty?
+            self.class.ari_configuration[:associations].each do |association_name, access_function|
               value = access_function.call(self)
               if value.class == String
                 unless value.empty?
@@ -99,14 +108,30 @@ module ARIndexer
         end
 
         def ar_indexer_on_create
-          ar_indexer_get_indexable_values.each do |field_name, value|
-            Indexer.index_string(self.class.to_s.split('::').last, self.id, field_name, value, false)
+          to_index = self.class.ari_configuration[:index_on_create]
+          if to_index == []
+            self.index_object(false)
+          else
+            if to_index.include? :fields
+              self.index_fields(false)
+            end
+            if to_index.include? :associations
+              self.index_associations(false)
+            end
           end
         end
 
         def ar_indexer_on_update
-          ar_indexer_get_indexable_values.each do |field_name, value|
-            Indexer.index_string(self.class.to_s.split('::').last, self.id, field_name, value, true)
+          to_index = self.class.ari_configuration[:index_on_update]
+          if to_index == []
+            self.index_object(true)
+          else
+            if to_index.include? :fields
+              self.index_fields(true)
+            end
+            if to_index.include? :associations
+              self.index_associations(true)
+            end
           end
         end
 

data/lib/ar_indexer/index_search.rb

@@ -40,9 +40,9 @@ module ARIndexer
 
         # Execute AR query based on @options[:fields]
         if @options[:fields].empty?
-          base_results = ReverseIndex.where(:model_name => self.search_models, :word => search_terms)
+          base_results = ReverseIndex.where(:model_constant => self.search_models, :word => search_terms)
         else
-          base_results = ReverseIndex.where(:model_name => self.search_models, :field_name => @options[:fields], :word => search_terms)
+          base_results = ReverseIndex.where(:model_constant => self.search_models, :field_name => @options[:fields], :word => search_terms)
         end
 
         unless base_results.empty?
@@ -80,7 +80,7 @@ module ARIndexer
       relevancy_counts = {}
       unsorted_results = []
       search_models.each do |model|
-        model_results = base_results.where(:model_name => model)
+        model_results = base_results.where(:model_constant => model)
         unless model_results.empty?
           relevancy_counts[model] = {}
           model_results.each do |result|

data/lib/ar_indexer/indexer.rb

@@ -19,24 +19,24 @@ module ARIndexer
       return forward_index
     end
 
-    def self.index_string(model_name, object_id, field_name, value, repair_on_completion)
+    def self.index_string(model_constant, object_id, field_name, value, repair_on_completion)
       forward_index = self.break_string(value)
       forward_index.each do |word|
-        if index_record = ReverseIndex.where(:model_name => model_name, :field_name => field_name, :word => word).first
+        if index_record = ReverseIndex.where(:model_constant => model_constant, :field_name => field_name, :word => word).first
           current_id_array = index_record.retrieve_id_array
           unless current_id_array.include? object_id
             new_id_list = (current_id_array << object_id).sort.join(',')
             index_record.update(:id_list => new_id_list)
           end
         else
-          ReverseIndex.create(:model_name => model_name, :field_name => field_name, :word => word, :id_list => object_id)
+          ReverseIndex.create(:model_constant => model_constant, :field_name => field_name, :word => word, :id_list => object_id)
         end
       end
-      repair_index(model_name, object_id, field_name, forward_index) if repair_on_completion
+      repair_index(model_constant, object_id, field_name, forward_index) if repair_on_completion
     end
 
-    def self.remove_index_id(model_name, object_id)
-      index_records = ReverseIndex.where(:model_name => model_name)
+    def self.remove_index_id(model_constant, object_id)
+      index_records = ReverseIndex.where(:model_constant => model_constant)
       if index_records.count > 0
         index_records.each do |record|
           if record.id_list.match(/#{object_id},{0,1}/)
@@ -54,8 +54,8 @@ module ARIndexer
       end
     end
 
-    def self.repair_index(model_name, object_id, field_name, forward_index)
-      index_records = ReverseIndex.where(:model_name => model_name, :field_name => field_name)
+    def self.repair_index(model_constant, object_id, field_name, forward_index)
+      index_records = ReverseIndex.where(:model_constant => model_constant, :field_name => field_name)
       if index_records.count > 0
         index_records.each do |record|
           if record.id_list.match(/#{object_id},{0,1}/)

data/lib/ar_indexer/reverse_index.rb

@@ -1,10 +1,10 @@
 module ARIndexer
   class ReverseIndex < ::ActiveRecord::Base
     if ::ActiveRecord::VERSION::MAJOR < 4
-      attr_accessible :model_name, :field_name, :word, :id_list
+      attr_accessible :model_constant, :field_name, :word, :id_list
     end
 
-    validates_uniqueness_of :word, :scope => [:model_name, :field_name]
+    validates_uniqueness_of :word, :scope => [:model_constant, :field_name]
 
     def retrieve_id_array
       id_array = self.id_list.split(',')

data/lib/ar_indexer.rb

@@ -16,8 +16,8 @@ module ARIndexer
   # Gem version storage
   module Version
     MAJOR = '0'
-    MINOR = '2'
-    BUILD = '2'
+    MINOR = '3'
+    BUILD = '1'
 
     STRING = "#{MAJOR}.#{MINOR}.#{BUILD}"
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_indexer
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Josh MacLachlan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-08 00:00:00.000000000 Z
+date: 2015-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -87,9 +87,8 @@ homepage: https://github.com/jtmaclachlan/ar_indexer
 licenses:
 - GPL-2
 metadata: {}
-post_install_message: If you're upgrading from v0.1.4 to v0.2.0, read the updated
-  documentation. Your application will throw exceptions when trying to access indexed
-  models.
+post_install_message: If upgrading from v0.1.x to 0.2.x or 0.2.x to 0.3.x, be sure
+  to read the updated documentation. Major changes were made to initialization.
 rdoc_options: []
 require_paths:
 - lib
@@ -105,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Allows for reverse indexing selected ActiveRecord models. Handles searching