mongoid-giza 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 879640b0caf8a604f0bd1c30a4f2e28fe8701ebd
-  data.tar.gz: 1574d2f43cc5dd16e9012f6567162c161f59d7af
+  metadata.gz: 3e001380b635b1d6791949047b359df006939e31
+  data.tar.gz: da994906999be72baff0a36730ef846bbfe3bcfb
 SHA512:
-  metadata.gz: fde8f8c1aaee58cd6e3bdce7cd91c68681052d52ae392bc8d31f331b0a591e47febe5743654a077ea8280985ff28b89d46ec9ea9df5426761db0ff1fd72fa34f
-  data.tar.gz: c949aee6ad8406d3d2b618cda8497769a3345544c7d5d79523c7d652e5777806cb51d8ab8a4ab9e749b8d74d5e57c597c7460a7a39d547f809cf1f51d8b562e8
+  metadata.gz: e7d42d8a4c29c6d664e5d450b2322ee3c21de92e01602f2924c9a6a94db2a433092d4224664888d7a4785a732403d636ec4abc37bff04801fa7e45e2dfcb2de2
+  data.tar.gz: c6fc8765245d9261839cdbe189fea7efff0ed22b841e0a6eac357322d51196279074cc4b926580dd7190d03d83c69a5ea288bebd86ded7add89902fcab2f1013

data/.travis.yml

@@ -3,5 +3,6 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
+  - 2.1.1
 services:
   - mongodb

data/CHANGELOG.md

@@ -1,15 +1,24 @@
 # Changelog
 
+## 0.4.0
+
+* Do not render the configuration file on `Mongoid::Giza::Indexer#index!`
+* Do not force the verbose indexing
+* Added `Mongoid::Giza::giza_configuration` accessor
+* Fix converting the index name to symbol
+* Added `Mongoid::Giza::DynamicIndex#generate_index` method to generate the dynamic index for a single object
+* Added `Mongoid::Giza#generate_dynamic_sphinx_indexes` method to generate all dynamic indexes for the object
+
 ## 0.3.0
 
 * Downcase all fields' and attributes' names
 * Made possible to selective remove generated indexes from the configuration -- `Mongoid::Giza::Configuration#remove_generated_indexes`
-* Made possible to remove from the configuratio only the generated indexes of a model -- `Mongoid::Giza::clear_generated_sphinx_indexes_configuration`
+* Made possible to remove from the configuration only the generated indexes of a model -- `Mongoid::Giza::clear_generated_sphinx_indexes_configuration`
 
 ## 0.2.0
 
 * Use ERB to parse string settings of every section of the configuration
-* Renamed `Mongoid::Giza::Indexer::full_index` to `Mongoid::Giza::Indexer::full_index!`
+* Renamed `Mongoid::Giza::Indexer#full_index` to `Mongoid::Giza::Indexer#full_index!`
 * Always convert `Mongoid::Giza::Index::Field` and `Mongoid::Giza::Index::Attribute` names to symbol
 
 ## 0.1.0

data/README.md

@@ -144,9 +144,9 @@ There are 3 ways to populate the Sphinx index: use the model class' `sphinx_inde
 
 * **sphinx_indexer!:** Will execute the indexer program only on the indexes of the class.
 Does not regenerate dynamic indexes.
-* **index!:** Will execute the indexer program on all indexes.
+* **index!:** Will execute the indexer.
 Does not regenerate dynamic indexes.
-* **full_index!:** Will regenerate dynamic indexes and execute the indexer program on all indexes.
+* **full_index!:** Will regenerate dynamic indexes, render the configuration file and execute the indexer program on all indexes.
 
 This gem does not execute none of those automatically to let the you define what is the best reindexing strategy for your software.
 

data/lib/mongoid/giza.rb

@@ -59,8 +59,17 @@ module Mongoid
       self[:giza_id]
     end
 
+    # Generates all the dynamic indexes defined on the class for the object
+    def generate_dynamic_sphinx_indexes
+      self.class.dynamic_sphinx_indexes.each do |dynamic_index|
+        index = dynamic_index.generate_index(self)
+        self.class.generated_sphinx_indexes.merge!({index.name => index})
+        self.class.giza_configuration.add_index(index, true)
+      end
+    end
+
     module ClassMethods
-      attr_reader :static_sphinx_indexes, :generated_sphinx_indexes, :dynamic_sphinx_indexes
+      attr_reader :giza_configuration, :static_sphinx_indexes, :generated_sphinx_indexes, :dynamic_sphinx_indexes
 
       # Class method that defines a index relative to the current class' objects.
       # If an argument is given in the block then a dynamic index will be created.
@@ -98,7 +107,7 @@ module Mongoid
         index = Index.new(self, settings)
         Docile.dsl_eval(index, &block)
         static_sphinx_indexes[index.name] = index
-        @giza_configuration.add_index(index)
+        giza_configuration.add_index(index)
       end
 
       # Generates the indexes from the dynamic index and
@@ -108,7 +117,7 @@ module Mongoid
       def process_dynamic_sphinx_index(dynamic_index)
         generated = dynamic_index.generate!
         generated_sphinx_indexes.merge!(generated)
-        generated.each { |name, index| @giza_configuration.add_index(index, true) }
+        generated.each { |name, index| giza_configuration.add_index(index, true) }
       end
 
       # Class method that implements a search DSL using a {Mongoid::Giza::Search} object.
@@ -119,7 +128,7 @@ module Mongoid
       # @return [Array] an Array with Riddle result hashes containing an additional key with the name of the class.
       #   The value of this aditional key is a Mongoid::Criteria that return the actual objects of the match
       def search(&block)
-        search = Mongoid::Giza::Search.new(@giza_configuration.searchd.address, @giza_configuration.searchd.port, *sphinx_indexes_names)
+        search = Mongoid::Giza::Search.new(giza_configuration.searchd.address, giza_configuration.searchd.port, *sphinx_indexes_names)
         Docile.dsl_eval(search, &block)
         results = search.run
         results.each { |result| result[name.to_sym] = self.in(giza_id: result[:matches].map { |match| match[:doc] }) }
@@ -133,7 +142,7 @@ module Mongoid
 
       # Removes all generated indexes of the class from the configuration
       def clear_generated_sphinx_indexes_configuration
-        @giza_configuration.remove_generated_indexes(generated_sphinx_indexes.keys)
+        giza_configuration.remove_generated_indexes(generated_sphinx_indexes.keys)
       end
 
       # Execute the indexing routines of the indexes defined on the class.

data/lib/mongoid/giza/configuration.rb

@@ -111,7 +111,7 @@ module Mongoid
         File.open(@file.output_path, "w") { |file| file.write(super) }
       end
 
-      # Removes all Riddle::Index from the indices Array that where created from a generated {Mongoid::Giza::Index}
+      # Removes all Riddle::Index from the indices Array that were created from a generated {Mongoid::Giza::Index}
       def clear_generated_indexes
         @generated_indexes.each { |name, index| indices.delete(index) }
         @generated_indexes =  {}

data/lib/mongoid/giza/dynamic_index.rb

@@ -21,16 +21,29 @@ module Mongoid
       # The name of the index is unique so in case of a name collision,
       # the last index to be generated is the one that will persist
       #
-      # @return [Hash<Symbol, Mongoid::Giza::Index] an hash with every key being the index name
+      # @return [Hash<Symbol, Mongoid::Giza::Index>] an hash with every key being the index name
       #   and the value the index itself
       def generate!
         indexes = {}
         klass.all.each do |object|
+          index = generate_index(object)
+          indexes[index.name] = index if !index.nil?
+        end
+        indexes
+      end
+
+      # Generates the index for the object passed as parameter.
+      # It is only generated if the object's class is the class or a subclass of the index's class
+      #
+      # @param object [Mongoid::Document] the object which the index block wil be evaluated for
+      #
+      # @return [Mongoid::Giza::Index, NilClass] the resulting index from the evaluation
+      #   or nil if the object's class is not the index's class or a subclass of it
+      def generate_index(object)
+        if object.is_a?(klass)
           index = Mongoid::Giza::Index.new(klass, settings)
           Docile.dsl_eval(index, object, &block)
-          indexes[index.name] = index
         end
-        indexes
       end
     end
   end

data/lib/mongoid/giza/index.rb

@@ -83,7 +83,8 @@ module Mongoid
       #
       # @return [Symbol] The name of the index
       def name(new_name = nil)
-        @name = new_name || @name.to_sym
+        @name = new_name.to_sym if !new_name.nil?
+        @name
       end
 
       # Defines the Mongoid::Criteria that will be used to retrive objects when indexing.

data/lib/mongoid/giza/indexer.rb

@@ -15,13 +15,18 @@ module Mongoid
       def full_index!
         @configuration.clear_generated_indexes
         giza_classes.each { |klass| klass.regenerate_dynamic_sphinx_indexes }
+        @configuration.render
         index!
       end
 
-      # Creates the sphinx configuration file then executes the indexer on it
+      # Executes the sphinx indexer
+      #
+      # @param indexes [Array<Symbol>] name of the indexes that should be indexed.
+      #   If not provided all indexes from the configuration file are indexed
+      # @param options [Hash] additional options to pass to Riddle::Controller#index
+      # @option options [TrueClass, FalseClass] :verbose shows the indexer output
       def index!(*indexes)
-        @configuration.render
-        @controller.index(*indexes, verbose: true)
+        @controller.index(*indexes)
       end
 
       # @return [Array<Class>] all Mongoid models that include the {Mongoid::Giza} module

data/lib/mongoid/giza/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Giza
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/spec/mongoid/giza/dynamic_index_spec.rb

@@ -11,14 +11,22 @@ describe Mongoid::Giza::DynamicIndex do
   end
 
   describe "generate!" do
-    let(:dynamic_index) { Mongoid::Giza::DynamicIndex.new(Object, {}, Proc.new { |object| name(object[:name]) }) }
+    let(:dynamic_index) { Mongoid::Giza::DynamicIndex.new(Object, {}, Proc.new { }) }
+
+    let(:index) { double("index") }
 
     before do
       klass = double("class")
-      index = double("index")
-      allow(klass).to receive(:all) { [{name: "object"}, {name: "other"}, {name: "other"}] }
+      allow(index).to receive(:name) { :name }
+      allow(klass).to receive(:all) { Array.new(3) }
       allow(klass).to receive(:name) { :class }
       allow(dynamic_index).to receive(:klass) { klass }
+      allow(dynamic_index).to receive(:generate_index) { index }
+    end
+
+    it "should generate index for each object of the class" do
+      expect(dynamic_index).to receive(:generate_index).exactly(3).times
+      dynamic_index.generate!
     end
 
     it "should return a collection of indexes" do
@@ -26,7 +34,36 @@ describe Mongoid::Giza::DynamicIndex do
     end
 
     it "should only return indexes with unique names" do
-      expect(dynamic_index.generate!.length).to eql(2)
+      expect(dynamic_index.generate!.length).to eql(1)
+    end
+
+    it "should not an Index if it's nil" do
+      allow(dynamic_index).to receive(:generate_index) { nil }
+      expect(dynamic_index.generate!.length).to eql(0)
+    end
+  end
+
+  describe "generate_index" do
+    let(:index) { double("index") }
+
+    before do
+      allow(Mongoid::Giza::Index).to receive(:new) { index }
+    end
+
+    it "should check if the object is from the index's class" do
+      expect(Mongoid::Giza::DynamicIndex.new(String, {}, Proc.new { }).generate_index(Array.new)).to eql(nil)
+    end
+
+    it "should execute the index dsl on the parameter" do
+      object = Object.new
+      block = Proc.new { }
+      expect(Docile).to receive(:dsl_eval).with(index, object, &block)
+      Mongoid::Giza::DynamicIndex.new(Object, {}, block).generate_index(object)
+    end
+
+    it "should return an Index" do
+      allow(Docile).to receive(:dsl_eval) { index }
+      expect(Mongoid::Giza::DynamicIndex.new(String, {}, Proc.new { }).generate_index("")).to be(index)
     end
   end
 end

data/spec/mongoid/giza/index_spec.rb

@@ -124,6 +124,11 @@ describe Mongoid::Giza::Index do
       index.name(:Index)
       expect(index.name).to eql(:Index)
     end
+
+    it "should be converted to symbol" do
+      index.name("Index")
+      expect(index.name).to eql(:Index)
+    end
   end
 
   describe "generate_xmlpipe2" do

data/spec/mongoid/giza/indexer_spec.rb

@@ -10,23 +10,20 @@ describe Mongoid::Giza::Indexer do
   let(:config) { Mongoid::Giza::Configuration.instance }
 
   describe "index!" do
-    it "should create the sphinx configuration file" do
-      allow(@controller).to receive(:index)
-      expect(config).to receive(:render)
-      @indexer.index!
-    end
-
     it "should execute the sphinx indexer" do
-      allow(config).to receive(:render)
-      expect(@controller).to receive(:index).with(verbose: true)
+      expect(@controller).to receive(:index).with(no_args())
       @indexer.index!
     end
 
     it "should accept an index list" do
-      allow(config).to receive(:render)
-      expect(@controller).to receive(:index).with(:Person, :Person_2, verbose: true)
+      expect(@controller).to receive(:index).with(:Person, :Person_2)
       @indexer.index!(:Person, :Person_2)
     end
+
+    it "should accept verbose option" do
+      expect(@controller).to receive(:index).with(verbose: true)
+      @indexer.index!(verbose: true)
+    end
   end
 
   describe "full_index!" do
@@ -34,6 +31,7 @@ describe Mongoid::Giza::Indexer do
 
     before do
       allow(@indexer).to receive(:index!)
+      allow(config).to receive(:render)
     end
 
     it "should clear the generated indexes from the configuration" do
@@ -50,6 +48,14 @@ describe Mongoid::Giza::Indexer do
       @indexer.full_index!
     end
 
+    it "should create the sphinx configuration file" do
+      allow(config).to receive(:clear_generated_indexes)
+      allow(@indexer).to receive(:giza_classes) { [klass] }
+      allow(klass).to receive(:regenerate_dynamic_sphinx_indexes)
+      expect(config).to receive(:render)
+      @indexer.full_index!
+    end
+
     it "should execute the indexer" do
       allow(config).to receive(:clear_generated_indexes)
       allow(@indexer).to receive(:giza_classes) { [klass] }

data/spec/mongoid/giza_spec.rb

@@ -287,4 +287,37 @@ describe Mongoid::Giza do
       Person.clear_generated_sphinx_indexes_configuration
     end
   end
+
+  describe "generate_dynamic_sphinx_indexes" do
+    let(:person) { Person.new }
+
+    let(:dynamic_index) { double("dynamic index") }
+
+    let(:dynamic_index2) { double("dynamic index 2") }
+
+    let(:index) { double("index") }
+
+    let(:index2) { double("index 2") }
+
+    before do
+      allow(Person).to receive(:dynamic_sphinx_indexes) { [dynamic_index, dynamic_index] }
+      allow(dynamic_index).to receive(:generate_index) { index }
+      allow(index).to receive(:name) { :name }
+    end
+
+    it "should generate all the dynamic indexes of the class for the object" do
+      expect(dynamic_index).to receive(:generate_index).with(person).twice { index }
+      person.generate_dynamic_sphinx_indexes
+    end
+
+    it "should merge the resulting indexes to the class' generated indexes" do
+      expect(Person.generated_sphinx_indexes).to receive(:merge!).with({name: index}).twice
+      person.generate_dynamic_sphinx_indexes
+    end
+
+    it "should add the indexes to the configuration" do
+      expect(config).to receive(:add_index).with(index, true).twice
+      person.generate_dynamic_sphinx_indexes
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-giza
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Maurício Batista
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-23 00:00:00.000000000 Z
+date: 2014-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -223,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Mongoid layer for the Sphinx fulltext search server