mongoid-giza 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9edb036ce36b11799e47d366dd694c9b85ea5cba
-  data.tar.gz: 1d91150beaa2ed2afd8b8328805df93394b59496
+  metadata.gz: 8593011380c8765b61fdf11371d82e7427889d30
+  data.tar.gz: 5d74f081406d8d50a3c76f588d17283ca2734606
 SHA512:
-  metadata.gz: bf0041aab836a2511ca73c02b7540e6562747d39e0cee50ac15df020aaa23183d2fa8905e9ada8a7b45020371464290b08b537f638eba0c88aa75e1d4e384104
-  data.tar.gz: 5d37e08e2e3332cbfdabb2ef80ae38bf75460aa103022e55e1b400e9e7fd557bc2ba782d4704f52d383195a3cfa7f7281b56c990e0d4d00817826ee12216f3af
+  metadata.gz: b3fc45f6e90137143f01bce79c31a525a1fada5174077c89ee7ac0dfe8aa267f8f219fdcf8a244b7bdbebe74f0082fa9e988e31b1c05294259b26d1ea1c0c920
+  data.tar.gz: edadbb151bff73bb6834a05db6775b2565e1c4a4006d3169abbacb6abbcc310ba4c42c45ea8f5c31729d02fcfab77585fe7a6f8e5c4cf0e50a4c5673a08fae99

data/.rubocop.yml

@@ -1,10 +1,20 @@
-Style/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space
+AllCops:
+  TargetRubyVersion: 2.0
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/*_spec.rb"
+    - "mongoid-giza.gemspec"
 
 Style/Encoding:
   Enabled: true
   EnforcedStyle: when_needed
 
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
 Style/StringLiterals:
   EnforcedStyle: double_quotes
-

data/.travis.yml

@@ -1,8 +1,9 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
-  - 2.1.6
-  - 2.2.2
+  - 2.1.10
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
 services:
   - mongodb

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.7.0
+
+#### Mongoid::Giza now requires Ruby >= 2.0
+
+### Breaking changes
+
+* `Mongoid::Giza::Search#order_by` now accepts multiple ordering as a `Hash` (i.e.: `order_by age: :asc, :@id => :desc`)
+
+### Fixes
+
+* Defined **Mongoid < 5.0** and **ActiveSupport < 5.0** as greater versions are not yet supported
+* Use `YAML#safe_load` when available **(Ruby >= 2.1)**
+
 ## 0.6.2
 
 * Allow underscore on fields' and attributes' names

data/README.md

@@ -180,8 +180,9 @@ Every other [Riddle::Client](http://rdoc.info/github/pat/riddle/Riddle/Client) s
 ```ruby
 result = Person.search do
   fulltext "john"
-  with :age 18..40
-  order_by :age :asc
+  with :age, 18..40
+  sort_mode :extended
+  order_by age: :asc, :@id => :desc
 end
 
 result[:Person].each do |person|
@@ -189,6 +190,15 @@ result[:Person].each do |person|
 end
 ```
 
+#### Sorting MongoDB results
+
+MongoDB doesn't return the documents on the "arbitrary" order defined by Sphinx. To maintain the Sphinx ordering you can do:
+
+```ruby
+giza_ids = result[:matches].map { |match| match[:doc] }
+people = result[:Person].sort_by { |person| giza_ids.index(person._giza_id) }
+```
+
 ## TODO
 
 * Support delta indexing

data/lib/mongoid/giza.rb

@@ -59,7 +59,7 @@ module Mongoid
     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)
+        self.class.generated_sphinx_indexes[index.name] = index
         self.class.giza_configuration.add_index(index, true)
       end
     end
@@ -174,13 +174,13 @@ module Mongoid
       # @param names [Array] a list of index names of this class that will be
       #   indexed
       def sphinx_indexer!(*names)
-        if names.length > 0
+        if !names.empty?
           indexes_names =
             sphinx_indexes_names.select { |name| names.include?(name) }
         else
           indexes_names = sphinx_indexes_names
         end
-        Indexer.instance.index!(*indexes_names) if indexes_names.length > 0
+        Indexer.instance.index!(*indexes_names) unless indexes_names.empty?
       end
 
       # Retrieves all the sphinx indexes defined on this class, static and

data/lib/mongoid/giza/configuration.rb

@@ -27,8 +27,8 @@ module Mongoid
       #   defined
       # @param env [String] environment whoose settings will be loaded
       def load(path, env)
-        YAML.load(File.open(path).read)[env].each do |section_name, settings|
-          section = instance_variable_get("@#{section_name}")
+        yaml_safe_load(File.open(path).read)[env].each do |section, settings|
+          section = instance_variable_get("@#{section}")
           next unless section
           settings.each do |setting, value|
             unless section == @index || section == @source
@@ -98,7 +98,7 @@ module Mongoid
       #   set
       def apply_default_settings(default, section, index)
         default.class.settings.each do |setting|
-          value = interpolate_string(default.send("#{setting}"), index)
+          value = interpolate_string(default.send(setting.to_s), index)
           setter(section, setting, value) unless value.nil?
         end
       end
@@ -128,7 +128,7 @@ module Mongoid
       #   a generated {Mongoid::Giza::Index}
       def clear_generated_indexes
         @generated_indexes.each { |_, index| indices.delete(index) }
-        @generated_indexes =  {}
+        @generated_indexes = {}
       end
 
       # Removes Riddle::Index's specifieds as params
@@ -157,9 +157,8 @@ module Mongoid
         namespace = index.nil? ? Object.new : OpenStruct.new(index: index)
         if value.is_a?(String)
           return ERB.new(value).result(namespace.instance_eval { binding })
-        else
-          return value
         end
+        value
       end
 
       # Helper method to set a value to a setting from a section (i.e. indexer,
@@ -174,6 +173,16 @@ module Mongoid
         method = "#{setting}="
         section.send(method, value) if section.respond_to?(method)
       end
+
+      private
+
+      def yaml_safe_load(yaml_code)
+        if YAML.respond_to?(:safe_load)
+          YAML.safe_load(yaml_code)
+        else
+          YAML.load(yaml_code) # rubocop:disable Security/YAMLLoad
+        end
+      end
     end
   end
 end

data/lib/mongoid/giza/index.rb

@@ -20,7 +20,7 @@ module Mongoid
         Hash => :json,
         BSON::ObjectId => :string,
         ActiveSupport::TimeWithZone => :timestamp
-      }
+      }.freeze
 
       attr_accessor :klass, :settings, :fields, :attributes
 
@@ -79,11 +79,11 @@ module Mongoid
       def attribute(name, type = nil, options = {}, &block)
         unless type
           field = @klass.fields[name.to_s]
-          if field
-            type = TYPES_MAP[field.type] || :string
-          else
-            type = :string
-          end
+          type = if field
+                   TYPES_MAP[field.type] || :string
+                 else
+                   :string
+                 end
         end
         @attributes << Attribute.new(name, type, options, &block)
       end

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

@@ -9,7 +9,7 @@ module Mongoid
         TYPES = [
           :uint, :bool, :bigint, :timestamp, :float,
           :multi, :multi_64, :string, :json
-        ]
+        ].freeze
 
         attr_accessor :default, :bits, :block
         attr_reader :name, :type
@@ -31,10 +31,11 @@ module Mongoid
         # @raise [TypeError] if the type is not valid. (see
         #   {Mongoid::Giza::Index::Attribute::TYPES})
         def initialize(name, type, options = {}, &block)
-          fail TypeError,
-               "Attribute type not supported. " \
-               "It must be one of the following: " \
-               "#{TYPES.join(', ')}" unless TYPES.include? type
+          unless TYPES.include? type
+            raise TypeError,
+                  "Attribute type not supported. It must be one of the " \
+                  "following: #{TYPES.join(', ')}"
+          end
           @name = normalize(name)
           @type = type
           @block = block

data/lib/mongoid/giza/search.rb

@@ -5,7 +5,7 @@ module Mongoid
       attr_accessor :indexes, :query_string
       attr_reader :client
 
-      alias_method :fulltext, :query_string=
+      alias fulltext query_string=
 
       # Creates a new search
       #
@@ -43,18 +43,19 @@ module Mongoid
 
       # Sets the order in which the results will be returned
       #
-      # @param attribute [Symbol] the attribute used for sorting
-      # @param order [Symbol] the order of the sorting. Valid values are :asc
-      #   and :desc
-      def order_by(attribute, order)
-        @client.sort_by = "#{attribute} #{order.to_s.upcase}"
+      # @param ordering [Hash] a hash with attribute names as keys and order
+      #   as values (i.e.: attr1: :desc, attr2: :asc)
+      def order_by(ordering)
+        @client.sort_by = ordering.map do |attribute, order|
+          "#{attribute} #{order.to_s.upcase}"
+        end.join(", ")
       end
 
       # Executes the configured query
       #
       # @return [Array] an Array of Hashes as specified by Riddle::Response
       def run
-        index = indexes.length > 0 ? indexes.join(" ") : "*"
+        index = !indexes.empty? ? indexes.join(" ") : "*"
         @client.query(query_string, index)
       end
 
@@ -92,6 +93,12 @@ module Mongoid
           @client.send method, *args
         end
       end
+
+      def respond_to_missing?(method, include_private = false)
+        @client.respond_to?(method) ||
+          @client.respond_to?("#{method}=") ||
+          super
+      end
     end
   end
 end

data/lib/mongoid/giza/version.rb

@@ -1,6 +1,6 @@
 module Mongoid
   # :nodoc:
   module Giza
-    VERSION = "0.6.2"
+    VERSION = "0.7.0".freeze
   end
 end

data/lib/mongoid/giza/xml_pipe2.rb

@@ -104,9 +104,8 @@ module Mongoid
       def process_value(content, object)
         if content.is_a?(Index::Attribute) && content.type == :timestamp
           return object[content.name].to_time.to_i
-        else
-          return object[content.name]
         end
+        object[content.name]
       end
     end
   end

data/mongoid-giza.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.0"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", ">= 2.14"
@@ -27,9 +29,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "database_cleaner", ">= 1.2.0"
   spec.add_development_dependency "rubocop", ">= 0.29.0"
 
-  spec.add_runtime_dependency "mongoid", ">= 4.0"
+  spec.add_runtime_dependency "mongoid", ">= 4.0", "< 5.0"
   spec.add_runtime_dependency "riddle", ">= 1.5.11"
   spec.add_runtime_dependency "builder", ">= 3.0"
   spec.add_runtime_dependency "docile", ">= 1.1"
-  spec.add_runtime_dependency "activesupport", ">= 4.0"
+  spec.add_runtime_dependency "activesupport", ">= 4.0", "< 5.0"
 end

data/spec/mongoid/giza/configuration_spec.rb

@@ -359,7 +359,7 @@ describe Mongoid::Giza::Configuration do
   end
 
   describe "setter" do
-    let(:section) { double("section")  }
+    let(:section) { double("section") }
 
     let(:value) { double("value") }
 
@@ -381,7 +381,7 @@ describe Mongoid::Giza::Configuration do
   end
 
   describe "remove_generated_indexes" do
-    let(:indices) { double("indices")  }
+    let(:indices) { double("indices") }
 
     before do
       @config.instance_variable_set("@generated_indexes", name: :index,

data/spec/mongoid/giza/search_spec.rb

@@ -22,7 +22,7 @@ describe Mongoid::Giza::Search do
 
     it "should accept a index list" do
       indexes = Mongoid::Giza::Search.new("localhost", 9132, [:index1, :index2])
-                .indexes
+                                     .indexes
       expect(indexes).to eql([:index1, :index2])
     end
   end
@@ -59,7 +59,12 @@ describe Mongoid::Giza::Search do
   describe "order_by" do
     it "should set the search order" do
       expect(client).to receive(:sort_by=).with("attr ASC")
-      search.order_by(:attr, :asc)
+      search.order_by(attr: :asc)
+    end
+
+    it "should accept a multiple ordering" do
+      expect(client).to receive(:sort_by=).with("attr1 ASC, attr2 DESC")
+      search.order_by(attr1: :asc, attr2: :desc)
     end
   end
 

data/spec/mongoid/giza_spec.rb

@@ -287,14 +287,13 @@ 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 }
+                                                       .twice { index }
       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_sphinx_indexes
+      expect(Person.generated_sphinx_indexes[:name]).to be(index)
     end
 
     it "should add the indexes to the configuration" do

data/spec/spec_helper.rb

@@ -18,7 +18,7 @@ MONGOID_CONFIG = {
       hosts: ["localhost:27017"]
     }
   }
-}
+}.freeze
 
 Mongoid.configure do |config|
   config.load_configuration(MONGOID_CONFIG)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-giza
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Maurício Batista
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-14 00:00:00.000000000 Z
+date: 2017-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,6 +115,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -122,6 +125,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: riddle
   requirement: !ruby/object:Gem::Requirement
@@ -171,6 +177,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -178,6 +187,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: Mongoid layer for the Sphinx fulltext search server that supports block
   fields and dynamic indexes
 email:
@@ -232,7 +244,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -240,7 +252,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Mongoid layer for the Sphinx fulltext search server
@@ -257,4 +269,3 @@ test_files:
 - spec/mongoid/giza/xml_pipe2_spec.rb
 - spec/mongoid/giza_spec.rb
 - spec/spec_helper.rb
-has_rdoc: