mongoid-giza 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f6a99c02c683342e9631890d5db0c9f536dc48a
-  data.tar.gz: 130064b3c93bae3095777d233fbd2bd386efc2d8
+  metadata.gz: 879640b0caf8a604f0bd1c30a4f2e28fe8701ebd
+  data.tar.gz: 1574d2f43cc5dd16e9012f6567162c161f59d7af
 SHA512:
-  metadata.gz: 3ea89da7a5ceb6837f4fa27a8e1a00610bd730aad3d4852e72b6c62f0d17bca2e9cecec05b7508e0d6aaaa7835c7421ba0e6b2024b826a269c77802c86168671
-  data.tar.gz: c46b77df7db788fed17b0f6219340a335f3d29a2acdfda8d87f3b3688664a303e9dc14c104964cfe743c68629d2a2759145baa4cb1416190a03c90a0c6c5506d
+  metadata.gz: fde8f8c1aaee58cd6e3bdce7cd91c68681052d52ae392bc8d31f331b0a591e47febe5743654a077ea8280985ff28b89d46ec9ea9df5426761db0ff1fd72fa34f
+  data.tar.gz: c949aee6ad8406d3d2b618cda8497769a3345544c7d5d79523c7d652e5777806cb51d8ab8a4ab9e749b8d74d5e57c597c7460a7a39d547f809cf1f51d8b562e8

data/.travis.yml

@@ -2,5 +2,6 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0
 services:
   - mongodb

data/CHANGELOG.md

@@ -1,11 +1,15 @@
 # Changelog
 
+## 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`
+
 ## 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

data/lib/mongoid/giza/configuration.rb

@@ -117,6 +117,15 @@ module Mongoid
         @generated_indexes =  {}
       end
 
+      # 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))
+        end
+      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

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.to_sym
+          @name = name.to_s.mb_chars.downcase.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.to_sym
+          @name = name.to_s.mb_chars.downcase.to_sym
           @attribute = attribute
           @block = block
         end

data/lib/mongoid/giza/index.rb

@@ -48,8 +48,8 @@ module Mongoid
       # Otherwise the field value will be the value of the corresponding object field
       #
       # @param name [Symbol] the name of the field
-      # @param options [Hash] an optional hash of options.
-      #   Currently only the boolean option :attribute is avaiable (see {Mongoid::Giza::Index::Field#initialize})
+      # @param options [Hash] options for the field.
+      # @option options [TrueClass, FalseClass] :attribute whether the field will also be a attribute or not (see {Mongoid::Giza::Index::Field#initialize})
       # @param block [Proc] an optional block to be evaluated at the scope of the document on index creation
       def field(name, options = {}, &block)
         attribute = options[:attribute].nil? ? false : true
@@ -86,6 +86,11 @@ module Mongoid
         @name = new_name || @name.to_sym
       end
 
+      # Defines the Mongoid::Criteria that will be used to retrive objects when indexing.
+      # Use this to filter what objects from the class will be indexed.
+      # When an index is created the criteria is defined as class.all
+      #
+      #@param new_criteria [Mongoid::Criteria] the criteria to be used
       def criteria(new_criteria = nil)
         @criteria = new_criteria || @criteria
       end

data/lib/mongoid/giza/version.rb

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

data/lib/mongoid/giza.rb

@@ -131,6 +131,11 @@ module Mongoid
         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)
+      end
+
       # Execute the indexing routines of the indexes defined on the class.
       # This means (re)create the sphinx configuration file and then execute the indexer program on it.
       # If no index names are supplied than all indexes defined on the class will be indexed.

data/mongoid-giza.gemspec

@@ -29,4 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "riddle", ">= 1.5"
   spec.add_runtime_dependency "builder", ">= 3.0"
   spec.add_runtime_dependency "docile", ">= 1.1"
+  spec.add_runtime_dependency "activesupport"
 end

data/spec/mongoid/giza/configuration_spec.rb

@@ -326,15 +326,17 @@ describe Mongoid::Giza::Configuration do
   describe "clear_generated_indexes" do
     let(:indices) { double("indices") }
 
-    it "should delete the generated riddle indexes" do
+    before do
       @config.instance_variable_set("@generated_indexes", {name: :index})
+    end
+
+    it "should delete the generated riddle indexes" do
       allow(@config).to receive(:indices) { indices }
       expect(indices).to receive(:delete).with(:index)
       @config.clear_generated_indexes
     end
 
     it "should clear the generated indexes collection" do
-      @config.instance_variable_set("@generated_indexes", {name: :index})
       @config.clear_generated_indexes
       expect(@config.instance_variable_get("@generated_indexes")).to eql({})
     end
@@ -360,4 +362,23 @@ describe Mongoid::Giza::Configuration do
       @config.setter(section, :setting, value)
     end
   end
+
+  describe "remove_generated_indexes" do
+    let(:indices) { double("indices")  }
+
+    before do
+      @config.instance_variable_set("@generated_indexes", {name: :index, two: :index2})
+    end
+
+    it "should remove the indexes from the indices array" do
+      allow(@config).to receive(:indices) { indices }
+      expect(indices).to receive(:delete).with(:index)
+      @config.remove_generated_indexes([:name])
+    end
+
+    it "should remove the index from the generated indexes collection" do
+      @config.remove_generated_indexes([:name])
+      expect(@config.instance_variable_get("@generated_indexes")).not_to include(name: :index)
+    end
+  end
 end

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

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "spec_helper"
 
 describe Mongoid::Giza::Index::Attribute do
@@ -7,10 +9,36 @@ describe Mongoid::Giza::Index::Attribute do
     end
 
     it "should be set on creation" do
+      name = :attribute
+      attribute = Mongoid::Giza::Index::Attribute.new(name, :uint)
+      expect(attribute.name).to eql(name)
+    end
+
+    it "should be converted to symbol" do
       name = "attribute"
       attribute = Mongoid::Giza::Index::Attribute.new(name, :uint)
       expect(attribute.name).to eql(name.to_sym)
     end
+
+    it "should be downcased" do
+      attribute = Mongoid::Giza::Index::Attribute.new("Attribute", :uint)
+      expect(attribute.name).to eql(:attribute)
+    end
+
+    it "should downcase unicode chars" do
+      attribute = Mongoid::Giza::Index::Attribute.new("ESPAÑOL", :uint)
+      expect(attribute.name).to eql(:español)
+    end
+
+    it "should downcase symbols" do
+      attribute = Mongoid::Giza::Index::Attribute.new(:Attribute, :uint)
+      expect(attribute.name).to eql(:attribute)
+    end
+
+    it "should downcase unicode symbols" do
+      attribute = Mongoid::Giza::Index::Attribute.new(:ESPAÑOL, :uint)
+      expect(attribute.name).to eql(:español)
+    end
   end
 
   describe "type" do

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

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "spec_helper"
 
 describe Mongoid::Giza::Index::Field do
@@ -7,10 +9,36 @@ describe Mongoid::Giza::Index::Field do
     end
 
     it "should be set on creation" do
+      name = :field
+      field = Mongoid::Giza::Index::Field.new(name)
+      expect(field.name).to eql(name)
+    end
+
+    it "should be converted to symbol" do
       name = "field"
       field = Mongoid::Giza::Index::Field.new(name)
       expect(field.name).to eql(name.to_sym)
     end
+
+    it "should be downcased" do
+      field = Mongoid::Giza::Index::Field.new("Field")
+      expect(field.name).to eql(:field)
+    end
+
+    it "should downcase unicode chars" do
+      field = Mongoid::Giza::Index::Field.new("ESPAÑOL")
+      expect(field.name).to eql(:español)
+    end
+
+    it "should downcase symbols" do
+      field = Mongoid::Giza::Index::Field.new(:Field)
+      expect(field.name).to eql(:field)
+    end
+
+    it "should downcase unicode symbols" do
+      field = Mongoid::Giza::Index::Field.new(:ESPAÑOL)
+      expect(field.name).to eql(:español)
+    end
   end
 
   it "should accept string attribute" do

data/spec/mongoid/giza_spec.rb

@@ -279,4 +279,12 @@ describe Mongoid::Giza do
       Person.regenerate_dynamic_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
 end

metadata

@@ -1,155 +1,169 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-giza
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Maurício Batista
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-14 00:00:00.000000000 Z
+date: 2014-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: mongoid-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.9'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: riddle
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: docile
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Mongoid layer for the Sphinx fulltext search server that supports block
   fields and dynamic indexes
 email:
@@ -158,8 +172,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -199,17 +213,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Mongoid layer for the Sphinx fulltext search server