mongoid-giza 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e001380b635b1d6791949047b359df006939e31
-  data.tar.gz: da994906999be72baff0a36730ef846bbfe3bcfb
+  metadata.gz: 190b245876f472b085d4f2a25712e82e48e4a23e
+  data.tar.gz: 868320c19bf5078dc42faf5a961e03bcd11030b4
 SHA512:
-  metadata.gz: e7d42d8a4c29c6d664e5d450b2322ee3c21de92e01602f2924c9a6a94db2a433092d4224664888d7a4785a732403d636ec4abc37bff04801fa7e45e2dfcb2de2
-  data.tar.gz: c6fc8765245d9261839cdbe189fea7efff0ed22b841e0a6eac357322d51196279074cc4b926580dd7190d03d83c69a5ea288bebd86ded7add89902fcab2f1013
+  metadata.gz: bc2e8850ef004ba24b8d0d5bd9ff3368b4b7ca2cf94c633cbbb47d3e36aa70b0150c1324c9538377b5e65477398ebc2726fd055c176fecdebef493fd2535a26a
+  data.tar.gz: fd62cd8173bcb5ca7323af64175fb2925bc11421372337916adbb131fc109578748337f3871fc0ff93e520034d868f6c004b8b8ca3291cedeae6518817772307

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.5.0
+
+* Clear the generated indexes configuration when regenerating dynamic indexes
+* Removed `Mongoid::Giza::clear_generated_sphinx_indexes_configuration` method
+* Added `Mongoid::Giza::remove_generated_sphinx_indexes` method to remove selected generated indexes
+* Changed the indexes names parameter of `Mongoid::Giza::Search#initialize` from splat to array
+* Renamed `Mongoid::Giza#generate_dynamic_sphinx_indexes` to `Mongoid::Giza#generate_sphinx_indexes`
+* Renamed `Mongoid::Giza::regenerate_dynamic_sphinx_indexes` to `Mongoid::Giza::regenerate_sphinx_indexes`
+* Renamed `Mongoid::Giza::Index#generate_xmlpipe2` to `Mongoid::Giza::Index#xmlpipe2`
+
 ## 0.4.0
 
 * Do not render the configuration file on `Mongoid::Giza::Indexer#index!`

data/README.md

@@ -46,7 +46,7 @@ development:
   index:
     path: "/tmp/sphinx"
   source:
-    xmlpipe_command: "rails r '<%= index.klass %>.sphinx_indexes[:<%= index.name %>].generate_xmlpipe2(STDOUT)'"
+    xmlpipe_command: "rails r '<%= index.klass %>.sphinx_indexes[:<%= index.name %>].xmlpipe2(STDOUT)'"
 ```
 
 ### Setting up indexes on models
@@ -138,6 +138,18 @@ class Person
 end
 ```
 
+##### Manipulating Dynamic Indexes
+
+If your objects changed and this changes must be reflected on your dynamic indexes, call `Mongoid::Giza::regenerate_sphinx_indexes` to clear the existing ones and regenerate all again.
+
+If you need finer control, you may use `Mongoid::Giza#generate_sphinx_indexes` to generate all dynamic indexes for the object (which will replace any existing one with the same name), and `Mongoid::Giza::remove_generated_sphinx_indexes` with the name of the generated indexes which you want to remove.
+
+##### Difference Between Dynamic Index and Generated Index
+
+A dynamic index is just the skeleton that creates indexes from every object of the class.
+
+A generated index is the actual index that was dynamically created based on the object which the dynamic index used for evaluation.
+
 ### Indexing
 
 There are 3 ways to populate the Sphinx index: use the model class' `sphinx_indexer!` method, `Mongoid::Giza::Indexer.instance.index!` or `Mongoid::Giza::Indexer.instance.full_index!`

data/lib/mongoid/giza.rb

@@ -60,7 +60,7 @@ module Mongoid
     end
 
     # Generates all the dynamic indexes defined on the class for the object
-    def generate_dynamic_sphinx_indexes
+    def generate_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})
@@ -128,21 +128,25 @@ 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] }) }
       end
 
       # Regenerates all dynamic indexes of the class
-      def regenerate_dynamic_sphinx_indexes
+      def regenerate_sphinx_indexes
+        giza_configuration.remove_generated_indexes(generated_sphinx_indexes.keys)
         generated_sphinx_indexes.clear
         dynamic_sphinx_indexes.each { |dynamic_index| process_dynamic_sphinx_index(dynamic_index) }
       end
 
-      # 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)
+      # Removes the generated indexes.
+      #
+      # @param names [Array] a list of generated index names that should be removed
+      def remove_generated_sphinx_indexes(*names)
+        names.each { |name| generated_sphinx_indexes.delete(name) }
+        giza_configuration.remove_generated_indexes(names)
       end
 
       # Execute the indexing routines of the indexes defined on the class.

data/lib/mongoid/giza/configuration.rb

@@ -119,10 +119,10 @@ module Mongoid
 
       # Removes Riddle::Index's specifieds as params
       #
-      # @param indexes [Array<Symbol>]  names of indexes that should be removed
-      def remove_generated_indexes(indexes)
-        indexes.each do |index|
-          indices.delete(@generated_indexes.delete(index))
+      # @param names [Array<Symbol>] names of generated indexes that should be removed
+      def remove_generated_indexes(names)
+        names.each do |name|
+          indices.delete(@generated_indexes.delete(name))
         end
       end
 

data/lib/mongoid/giza/index.rb

@@ -99,7 +99,7 @@ module Mongoid
       # Generates a XML document according to the XMLPipe2 specification from Sphinx
       #
       # @param buffer [#<<] any IO object that supports appending content using <<
-      def generate_xmlpipe2(buffer)
+      def xmlpipe2(buffer)
         Mongoid::Giza::XMLPipe2.new(self, buffer).generate!
       end
     end

data/lib/mongoid/giza/indexer.rb

@@ -14,19 +14,19 @@ module Mongoid
       # Index everything, regenerating all dynamic indexes from all classes
       def full_index!
         @configuration.clear_generated_indexes
-        giza_classes.each { |klass| klass.regenerate_dynamic_sphinx_indexes }
+        giza_classes.each { |klass| klass.regenerate_sphinx_indexes }
         @configuration.render
         index!
       end
 
       # Executes the sphinx indexer
       #
-      # @param indexes [Array<Symbol>] name of the indexes that should be indexed.
+      # @param names [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)
-        @controller.index(*indexes)
+      def index!(*names)
+        @controller.index(*names)
       end
 
       # @return [Array<Class>] all Mongoid models that include the {Mongoid::Giza} module

data/lib/mongoid/giza/railtie.rb

@@ -7,7 +7,7 @@ module Mongoid
 
       initializer "mongoid-giza.load-configuration" do
         # Sets the default xmlpipe_command
-        configuration.source.xmlpipe_command = "rails r '<%= index.klass %>.sphinx_indexes[:<%= index.name %>].generate_xmlpipe2(STDOUT)'"
+        configuration.source.xmlpipe_command = "rails r '<%= index.klass %>.sphinx_indexes[:<%= index.name %>].xmlpipe2(STDOUT)'"
         # Loads the configuration file
         file = Rails.root.join("config", "giza.yml")
         configuration.load(file, Rails.env) if file.file?

data/lib/mongoid/giza/search.rb

@@ -10,11 +10,11 @@ module Mongoid
       #
       # @param host [String] the host address of sphinxd
       # @param port [Fixnum] the TCP port of sphinxd
-      # @param indexes [String] an optional string define the indexes that the search will run on.
-      #   Defaults to "*" which means all indexes
-      def initialize(host, port, *indexes)
+      # @param names [Array] an optional array defining the indexes that the search will run on.
+      #   Defaults to "[]" which means all indexes
+      def initialize(host, port, names = [])
         @client = Riddle::Client.new(host, port)
-        @indexes = indexes
+        @indexes = names
       end
 
       # Sets the search criteria on full-text fields

data/lib/mongoid/giza/version.rb

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

data/spec/mongoid/giza/index_spec.rb

@@ -131,20 +131,20 @@ describe Mongoid::Giza::Index do
     end
   end
 
-  describe "generate_xmlpipe2" do
+  describe "xmlpipe2" do
     let(:xmlpipe2) { double("XMLPipe2") }
 
     let(:buffer) { double("buffer") }
 
     it "should create a new XMLPipe2 object" do
       expect(Mongoid::Giza::XMLPipe2).to receive(:new).with(index, buffer) { xmlpipe2.as_null_object }
-      index.generate_xmlpipe2(buffer)
+      index.xmlpipe2(buffer)
     end
 
     it "should generate the xml" do
       allow(Mongoid::Giza::XMLPipe2).to receive(:new) { xmlpipe2 }
       expect(xmlpipe2).to receive(:generate!)
-      index.generate_xmlpipe2(buffer)
+      index.xmlpipe2(buffer)
     end
   end
 

data/spec/mongoid/giza/indexer_spec.rb

@@ -37,21 +37,21 @@ describe Mongoid::Giza::Indexer do
     it "should clear the generated indexes from the configuration" do
       expect(config).to receive(:clear_generated_indexes)
       allow(@indexer).to receive(:giza_classes) { [klass] }
-      allow(klass).to receive(:regenerate_dynamic_sphinx_indexes)
+      allow(klass).to receive(:regenerate_sphinx_indexes)
       @indexer.full_index!
     end
 
     it "should regenerate all dynamic indexes of the giza classes" do
       allow(config).to receive(:clear_generated_indexes)
       allow(@indexer).to receive(:giza_classes) { [klass] }
-      expect(klass).to receive(:regenerate_dynamic_sphinx_indexes)
+      expect(klass).to receive(:regenerate_sphinx_indexes)
       @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)
+      allow(klass).to receive(:regenerate_sphinx_indexes)
       expect(config).to receive(:render)
       @indexer.full_index!
     end
@@ -59,7 +59,7 @@ describe Mongoid::Giza::Indexer do
     it "should execute the indexer" do
       allow(config).to receive(:clear_generated_indexes)
       allow(@indexer).to receive(:giza_classes) { [klass] }
-      allow(klass).to receive(:regenerate_dynamic_sphinx_indexes)
+      allow(klass).to receive(:regenerate_sphinx_indexes)
       expect(@indexer).to receive(:index!).with(no_args)
       @indexer.full_index!
     end

data/spec/mongoid/giza/search_spec.rb

@@ -24,7 +24,7 @@ describe Mongoid::Giza::Search do
     end
 
     it "should accept a index list" do
-      indexes = Mongoid::Giza::Search.new("localhost", 9132, :index1, :index2).indexes
+      indexes = Mongoid::Giza::Search.new("localhost", 9132, [:index1, :index2]).indexes
       expect(indexes).to eql([:index1, :index2])
     end
   end

data/spec/mongoid/giza_spec.rb

@@ -28,7 +28,7 @@ describe Mongoid::Giza do
 
   let(:search) do
     search = double("search")
-    allow(Mongoid::Giza::Search).to receive(:new).with("localhost", 9132) { search }
+    allow(Mongoid::Giza::Search).to receive(:new).with("localhost", 9132, []) { search }
     search
   end
 
@@ -145,7 +145,7 @@ describe Mongoid::Giza do
     end
 
     it "should create a search" do
-      expect(Mongoid::Giza::Search).to receive(:new).with("localhost", 9132, :Person, :Person_2) { double("search").as_null_object }
+      expect(Mongoid::Giza::Search).to receive(:new).with("localhost", 9132, [:Person, :Person_2]) { double("search").as_null_object }
       Person.sphinx_index { }
       Person.sphinx_index { name :Person_2 }
       Person.search {  }
@@ -261,34 +261,39 @@ describe Mongoid::Giza do
     end
   end
 
-  describe "regenerate_dynamic_sphinx_indexes" do
+  describe "regenerate_sphinx_indexes" do
     let(:generated) { double("generated") }
 
     let(:dynamic) { double("dynamic") }
 
-    it "should clear the generated indexes" do
+    let(:keys) { double("keys") }
+
+    before do
       allow(Person).to receive(:generated_sphinx_indexes) { generated }
-      expect(generated).to receive(:clear)
-      Person.regenerate_dynamic_sphinx_indexes
+      allow(generated).to receive(:keys) { keys }
+      allow(generated).to receive(:clear)
+      allow(config).to receive(:remove_generated_indexes)
+    end
+
+    it "should clear the generated indexes configuration" do
+      expect(config).to receive(:remove_generated_indexes).with(keys)
+      Person.regenerate_sphinx_indexes
+    end
+
+    it "should clear the generated indexes" do
+      expect(generated).to receive(:clear).with(no_args)
+      Person.regenerate_sphinx_indexes
     end
 
     it "should process all dynamic indexes" do
       allow(Person).to receive(:dynamic_sphinx_indexes) { dynamic }
       allow(dynamic).to receive(:each).and_yield(:dynamic_index)
       expect(Person).to receive(:process_dynamic_sphinx_index).with(:dynamic_index)
-      Person.regenerate_dynamic_sphinx_indexes
+      Person.regenerate_sphinx_indexes
     end
   end
 
-  describe "clear_generated_sphinx_indexes_configuration" do
-    it "should remove all generated indexes of this class from the configuration" do
-      allow(Person).to receive(:generated_sphinx_indexes) { {index1: :index, index2: :index} }
-      expect(config).to receive(:remove_generated_indexes).with([:index1, :index2])
-      Person.clear_generated_sphinx_indexes_configuration
-    end
-  end
-
-  describe "generate_dynamic_sphinx_indexes" do
+  describe "generate_sphinx_indexes" do
     let(:person) { Person.new }
 
     let(:dynamic_index) { double("dynamic index") }
@@ -307,17 +312,31 @@ describe Mongoid::Giza do
 
     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
+      person.generate_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
+      person.generate_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
+      person.generate_sphinx_indexes
+    end
+  end
+
+  describe "remove_generated_sphinx_indexes" do
+    let(:index_name) { double("index name") }
+
+    it "should remove the indexes from the generated indexes collection" do
+      expect(Person.generated_sphinx_indexes).to receive(:delete).with(index_name).twice
+      Person.remove_generated_sphinx_indexes(index_name, index_name)
+    end
+
+    it "should remove the indexes from the configuration" do
+      expect(config).to receive(:remove_generated_indexes).with([index_name, index_name])
+      Person.remove_generated_sphinx_indexes(index_name, index_name)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-giza
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Maurício Batista
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-13 00:00:00.000000000 Z
+date: 2014-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler