mongoid-giza 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 150e88a193d198b7ee59e633753808457f01f9d0
-  data.tar.gz: dd2c1cc23492df7aa5e1c3e9c3fd6b13a578486a
+  metadata.gz: 8f6a99c02c683342e9631890d5db0c9f536dc48a
+  data.tar.gz: 130064b3c93bae3095777d233fbd2bd386efc2d8
 SHA512:
-  metadata.gz: 632f8929ab2a00803101594e1dc0e0bdd98164ef984797bb889eaaa4d90ebfef1250e7c94ad3f00f2eadab1313b4b36b49dd9d2969010b585df34a6b10f2bff1
-  data.tar.gz: 5eadf9661bc8697db39111932e5677ed1df5199269cef298fc2cf0788a95de779d1c8a63e3f783bb9877556ce9e3f9d553ecfd07f24ef6f8ef3602fcb5dc6d7e
+  metadata.gz: 3ea89da7a5ceb6837f4fa27a8e1a00610bd730aad3d4852e72b6c62f0d17bca2e9cecec05b7508e0d6aaaa7835c7421ba0e6b2024b826a269c77802c86168671
+  data.tar.gz: c46b77df7db788fed17b0f6219340a335f3d29a2acdfda8d87f3b3688664a303e9dc14c104964cfe743c68629d2a2759145baa4cb1416190a03c90a0c6c5506d

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## 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!`
+
+* Always convert `Mongoid::Giza::Index::Field` and `Mongoid::Giza::Index::Attribute` names to symbol
+
+## 0.1.0
+
+**Initial release**

data/README.md

@@ -1,4 +1,4 @@
-# Mongoid::Giza [![Build Status](https://travis-ci.org/yadevteam/mongoid-giza.png)](https://travis-ci.org/yadevteam/mongoid-giza) [![Code Climate](https://codeclimate.com/github/yadevteam/mongoid-giza.png)](https://codeclimate.com/github/yadevteam/mongoid-giza) [![Coverage Status](https://coveralls.io/repos/yadevteam/mongoid-giza/badge.png)](https://coveralls.io/r/yadevteam/mongoid-giza)
+# Mongoid::Giza [![Build Status](https://travis-ci.org/yadevteam/mongoid-giza.png)](https://travis-ci.org/yadevteam/mongoid-giza) [![Code Climate](https://codeclimate.com/github/yadevteam/mongoid-giza.png)](https://codeclimate.com/github/yadevteam/mongoid-giza) [![Coverage Status](https://coveralls.io/repos/yadevteam/mongoid-giza/badge.png)](https://coveralls.io/r/yadevteam/mongoid-giza) [![Gem Version](https://badge.fury.io/rb/mongoid-giza.png)](http://badge.fury.io/rb/mongoid-giza)
 
 Mongoid layer for the Sphinx fulltext search server that supports block fields and dynamic indexes
 
@@ -20,12 +20,41 @@ Or install it yourself as:
 
 :warning: **Before proceeding is extremely recommended to read the [Sphinx documentation](http://sphinxsearch.com/docs/current.html) if you are not yet familiar with it. Reading up to chapter 5 is enought to get you going.**
 
+### Configuration file
+
+A YAML configuration file is needed to configure the gem, the Sphinx searchd daemon, optionally the Sphinx indexer and set the default options for the sources and indexes.
+
+The minimum configuration file must have the sphinx.conf output path, the address and port of the searchd daemon, paths to its pid and log files.
+It's also a good idea to define a default path for very index.
+
+The `xmlpipe_command` is set to a default when using rails, otherwise you need to set it for each index or a default on the YAML file.
+String settings accept ERB, and you have access to the `Mongoid::Giza::Index` from index and source section settings.
+
+The configuration file is automatically loaded when using Rails from `config/giza.yml`, otherwise you will need to call `Mongoid::Giza::Configuration.instance.load` to load it.
+
+**Example:** *(the `xmlpipe_command` used here is already the one used in rails automatically so it's not needed, just for illustration)*
+
+```yaml
+development:
+  file:
+    output_path: "/tmp/sphinx/sphinx.conf"
+  searchd:
+    address: "localhost"
+    port: 9312
+    pid_file: "/tmp/sphinx/searchd.pid"
+    log: "/tmp/sphinx/searchd.log"
+  index:
+    path: "/tmp/sphinx"
+  source:
+    xmlpipe_command: "rails r '<%= index.klass %>.sphinx_indexes[:<%= index.name %>].generate_xmlpipe2(STDOUT)'"
+```
+
 ### Setting up indexes on models
 
 Use a `sphinx_index` block to create a new index.
 
 The `sphinx_index` method may receive optional settings that will be set in this index's section or in its source section on the generated sphinx configuration file.
-These settings take precedence to the defaults defined in `giza.yml`.
+These settings take precedence to the defaults defined in the configuration file.
 
 A model may have more than one index, but they need to have different names.
 If two or more indexes have the same name the last one to be defined is the one which will exist.
@@ -44,7 +73,7 @@ It's `Class.all` by default.
 
 **Example:** Creating a index on the person model
 
-```
+```ruby
 class Person
   include Mongoid::Document
   include Mongoid::Giza
@@ -80,7 +109,7 @@ This dynamic index will generate one index for each job that is associated to a
 On each index only the people that have that job will be indexed.
 Finally each dynamic attribute of the job will be a field on its index.
 
-```
+```ruby
 class Job
   include Mongoid::Document
 
@@ -109,6 +138,18 @@ class Person
 end
 ```
 
+### 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!`
+
+* **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.
+Does not regenerate dynamic indexes.
+* **full_index!:** Will regenerate dynamic indexes 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.
+
 ### Searching
 
 Use the `search` block on the class that have the indexes where the search should run.
@@ -125,7 +166,7 @@ Every other [Riddle::Client](http://rdoc.info/github/pat/riddle/Riddle/Client) s
 
 **Example:** Searching on the person class
 
-```
+```ruby
 results = Person.search do
   fulltext "john"
   with :age 18..40

data/lib/mongoid/giza.rb

@@ -144,7 +144,7 @@ module Mongoid
 
       # Retrieves all the sphinx indexes defined on this class, static and dynamic
       #
-      # @return [Array] an Array of indexes from the current class {Mongoid::Giza::Index}
+      # @return [Hash] a Hash with indexes names as keys and the actual indexes as the values
       def sphinx_indexes
         static_sphinx_indexes.merge(generated_sphinx_indexes)
       end

data/lib/mongoid/giza/configuration.rb

@@ -31,8 +31,8 @@ module Mongoid
           section = instance_variable_get("@#{section_name}")
           if !section.nil?
             settings.each do |setting, value|
-              method = "#{setting}="
-              section.send(method, value) if section.respond_to?(method)
+              value = interpolate_string(value, nil) if section != @index and section != @source
+              setter(section, setting, value)
             end
           end
         end
@@ -89,9 +89,8 @@ module Mongoid
       # @param section [Riddle::Configuration::Index, Riddle::Configuration::XMLSource] the object that settings are being set
       def apply_default_settings(default, section, index)
         default.class.settings.each do |setting|
-          method = "#{setting}="
           value = interpolate_string(default.send("#{setting}"), index)
-          section.send(method, value) if !value.nil? and section.respond_to?(method)
+          setter(section, setting, value) if !value.nil?
         end
       end
 
@@ -102,11 +101,22 @@ module Mongoid
       # @param section [Riddle::Configuration::Index, Riddle::Configuration::XMLSource] where the settings will be applied
       def apply_user_settings(index, section)
         index.settings.each do |setting, value|
-          method = "#{setting}="
-          section.send(method, interpolate_string(value, index)) if section.respond_to?(method)
+          value = interpolate_string(value, index)
+          setter(section, setting, value)
         end
       end
 
+      # Renders the configuration to the output_path
+      def render
+        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}
+      def clear_generated_indexes
+        @generated_indexes.each { |name, index| indices.delete(index) }
+        @generated_indexes =  {}
+      end
+
       # Interpolates a value if it's a String using ERB.
       # Useful for defining dynamic settings.
       # The ERB template may reference to the current {Mongoid::Giza::Index} and it's methods
@@ -117,19 +127,19 @@ module Mongoid
       # @return [Object] if value was a String and contains ERB syntax than it will beinterpolated and returned.
       #   Otherwise it will return the original value
       def interpolate_string(value, index)
-        namespace = OpenStruct.new(index: index)
+        namespace = index.nil? ? Object.new : OpenStruct.new(index: index)
         value.is_a?(String) ? ERB.new(value).result(namespace.instance_eval { binding }) : value
       end
 
-      # Renders the configuration to the output_path
-      def render
-        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}
-      def clear_generated_indexes
-        @generated_indexes.each { |name, index| indices.delete(index) }
-        @generated_indexes =  {}
+      # Helper method to set a value to a setting from a section (i.e. indexer, source) if the section has this setting.
+      # If the setting is not avaiable on the section, nothing is done
+      #
+      # @param section [Riddle::Configuration::Section] a configuration section to define the setting
+      # @param setting [Symbol] the setting that will be defined on the section
+      # @param value [Object] the value of the setting
+      def setter(section, setting, value)
+        method = "#{setting}="
+        section.send(method, value) if section.respond_to?(method)
       end
     end
   end

data/lib/mongoid/giza/index/attribute.rb

@@ -29,7 +29,7 @@ module Mongoid
             "attribute type not supported. " \
             "It must be one of the following: " \
             "#{Mongoid::Giza::Index::Attribute::TYPES.join(", ")}" unless Mongoid::Giza::Index::Attribute::TYPES.include? type
-          @name = name
+          @name = name.to_sym
           @type = type
           @block = block
         end

data/lib/mongoid/giza/index/field.rb

@@ -17,7 +17,7 @@ module Mongoid
         #   (see {http://sphinxsearch.com/docs/current.html#conf-xmlpipe-field-string})
         # @param block [Proc] an optional block to be evaluated at the scope of the document on index creation
         def initialize(name, attribute = false, &block)
-          @name = name
+          @name = name.to_sym
           @attribute = attribute
           @block = block
         end

data/lib/mongoid/giza/indexer.rb

@@ -12,7 +12,7 @@ module Mongoid
       end
 
       # Index everything, regenerating all dynamic indexes from all classes
-      def full_index
+      def full_index!
         @configuration.clear_generated_indexes
         giza_classes.each { |klass| klass.regenerate_dynamic_sphinx_indexes }
         index!

data/lib/mongoid/giza/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Giza
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/spec/mongoid/giza/configuration_spec.rb

@@ -59,6 +59,27 @@ describe Mongoid::Giza::Configuration do
       file_open
       @config.load("giza.yml", "test")
     end
+
+    it "should interpolate the string with ERB" do
+      allow(file).to receive(:read) { "test:\n  searchd:\n    address: localhost" }
+      expect(@config).to receive(:interpolate_string).with("localhost", nil)
+      file_open
+      @config.load("giza.yml", "test")
+    end
+
+    it "should not interpolate index settings" do
+      allow(file).to receive(:read) { "test:\n  index:\n    path: home" }
+      expect(@config).not_to receive(:interpolate_string)
+      file_open
+      @config.load("giza.yml", "test")
+    end
+
+    it "should not interpolate source settings" do
+      allow(file).to receive(:read) { "test:\n  source:\n    xmlpipe_command: cmd" }
+      expect(@config).not_to receive(:interpolate_string)
+      file_open
+      @config.load("giza.yml", "test")
+    end
   end
 
   describe "add_index" do
@@ -216,29 +237,18 @@ describe Mongoid::Giza::Configuration do
 
     it "should apply the settings from default to section" do
       allow(@default).to receive(:html_strip) { 1 }
-      allow(@section).to receive(:respond_to?).with("html_strip=") { true }
-      expect(@section).to receive(:html_strip=).with(1)
+      expect(@config).to receive(:setter).with(@section, :html_strip, 1)
       @config.apply_default_settings(@default, @section, @index)
     end
 
     it "should not set nil values" do
       allow(@default).to receive(:html_strip) { nil }
-      allow(@section).to receive(:respond_to?).with("html_strip=") { true }
-      expect(@section).not_to receive(:html_strip=)
-      @config.apply_default_settings(@default, @section, @index)
-    end
-
-    it "should not try to apply settings without a setter" do
-      allow(@default).to receive(:html_strip) { 1 }
-      allow(@section).to receive(:respond_to?).with("html_strip=") { false }
-      expect(@section).not_to receive(:html_strip=)
+      expect(@config).not_to receive(:setter)
       @config.apply_default_settings(@default, @section, @index)
     end
 
     it "should interpolate string values" do
       allow(@default).to receive(:html_strip) { 1 }
-      allow(@section).to receive(:respond_to?).with("html_strip=") { true }
-      allow(@section).to receive(:html_strip=)
       expect(@config).to receive(:interpolate_string).with(1, @index)
       @config.apply_default_settings(@default, @section, @index)
     end
@@ -253,19 +263,11 @@ describe Mongoid::Giza::Configuration do
     end
 
     it "should apply the the settings" do
-      allow(@section).to receive(:respond_to?).with("html_strip=") { true }
-      expect(@section).to receive(:html_strip=).with(1)
-      @config.apply_user_settings(@index, @section)
-    end
-
-    it "should not try to apply settings without a setter" do
-      allow(@section).to receive(:respond_to?).with("html_strip=") { false }
-      expect(@section).not_to receive(:html_strip=)
+      expect(@config).to receive(:setter).with(@section, :html_strip, 1)
       @config.apply_user_settings(@index, @section)
     end
 
     it "should interpolate the value" do
-      allow(@section).to receive(:respond_to?).with("html_strip=") { true }
       expect(@config).to receive(:interpolate_string).with(1, @index)
       @config.apply_user_settings(@index, @section)
     end
@@ -337,4 +339,25 @@ describe Mongoid::Giza::Configuration do
       expect(@config.instance_variable_get("@generated_indexes")).to eql({})
     end
   end
+
+  describe "setter" do
+    let(:section) { double("section")  }
+
+    let(:value) { double("value") }
+
+    before do
+      allow(section).to receive(:respond_to?) { true }
+    end
+
+    it "should use the attribute setter on the section" do
+      expect(section).to receive("setting=").with(value)
+      @config.setter(section, :setting, value)
+    end
+
+    it "should no set the value if the section does not respond to the attribute setter" do
+      allow(section).to receive(:respond_to?).with("setting=") { false }
+      expect(section).not_to receive("setting=")
+      @config.setter(section, :setting, value)
+    end
+  end
 end

data/spec/mongoid/giza/index/attribute_spec.rb

@@ -9,7 +9,7 @@ describe Mongoid::Giza::Index::Attribute do
     it "should be set on creation" do
       name = "attribute"
       attribute = Mongoid::Giza::Index::Attribute.new(name, :uint)
-      expect(attribute.name).to eql(name)
+      expect(attribute.name).to eql(name.to_sym)
     end
   end
 

data/spec/mongoid/giza/index/field_spec.rb

@@ -9,7 +9,7 @@ describe Mongoid::Giza::Index::Field do
     it "should be set on creation" do
       name = "field"
       field = Mongoid::Giza::Index::Field.new(name)
-      expect(field.name).to eql(name)
+      expect(field.name).to eql(name.to_sym)
     end
   end
 

data/spec/mongoid/giza/indexer_spec.rb

@@ -29,7 +29,7 @@ describe Mongoid::Giza::Indexer do
     end
   end
 
-  describe "full_index" do
+  describe "full_index!" do
     let(:klass) { double("class") }
 
     before do
@@ -40,14 +40,14 @@ describe Mongoid::Giza::Indexer do
       expect(config).to receive(:clear_generated_indexes)
       allow(@indexer).to receive(:giza_classes) { [klass] }
       allow(klass).to receive(:regenerate_dynamic_sphinx_indexes)
-      @indexer.full_index
+      @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)
-      @indexer.full_index
+      @indexer.full_index!
     end
 
     it "should execute the indexer" do
@@ -55,7 +55,7 @@ describe Mongoid::Giza::Indexer do
       allow(@indexer).to receive(:giza_classes) { [klass] }
       allow(klass).to receive(:regenerate_dynamic_sphinx_indexes)
       expect(@indexer).to receive(:index!).with(no_args)
-      @indexer.full_index
+      @indexer.full_index!
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-giza
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Maurício Batista
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-20 00:00:00.000000000 Z
+date: 2014-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -160,6 +160,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md