elasticsearch-model 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62d28c182c4b21b048ad496387e6cc139a79ee1b
-  data.tar.gz: f4bdb161bc448d38ba4fd2da0e7eb8c74fdebd15
+  metadata.gz: a357cdf1cb6d365afa38ed6631734804545d9cac
+  data.tar.gz: d11d799cc4c42be14d094e4561ca826f235d8399
 SHA512:
-  metadata.gz: ce7abb8673ae21d515c48f64e07a057ea82302132cedce60eeade565a44f9743fc0e811903df29aa93fa7cb55b96011d52ec25287064df5c846d5474da5125a4
-  data.tar.gz: 0eb48de6a8a1f7b264582b764de7013727d8909fa024a1777a9bad4304fa57649957dbc54b92fff24aa140364ee38f1ad35ddfc35da552cbab1ee4b0064e07f2
+  metadata.gz: c6608ecda81dc60edd8a18e814ad2baa758d879ed861b9e413b9123c91c648037d719635c7875a4e95e0199dfdad660a34297a4fa759e00eec23c0bf2eefcde3
+  data.tar.gz: 34e2112aa52d77b7b8d3fd688f11618cf2aa34634004217c613b31e65cc3b7cbd884b2614cdfb3b63d60e68ec9b2e4b0a3ff664b142287d170d9097cb9318530

data/CHANGELOG.md

@@ -1,9 +1,34 @@
+## 0.1.8
+
+* Added "default per page" methods for pagination with multi model searches
+* Added a convenience accessor for the `aggregations` part of response
+* Added a full example with mapping for the completion suggester
+* Added an integration test for paginating multiple models
+* Added proper support for the new "multi_fields" in the mapping DSL
+* Added the `no_timeout` option for `__find_in_batches` in the Mongoid adapter
+* Added, that index settings can be loaded from any object that responds to `:read`
+* Added, that index settings/mappings can be loaded from a YAML or JSON file
+* Added, that String pagination parameters are converted to numbers
+* Added, that empty block is not required for setting mapping options
+* Added, that on MyModel#import, an exception is raised if the index does not exists
+* Changed the Elasticsearch port in the Mongoid example to 9200
+* Cleaned up the tests for multiple fields/properties in mapping DSL
+* Fixed a bug where continuous `#save` calls emptied the `@__changed_attributes` variable
+* Fixed a buggy test introduced in #335
+* Fixed incorrect deserialization of records in the Multiple adapter
+* Fixed incorrect examples and documentation
+* Fixed unreliable order of returned results/records in the integration test for the multiple adapter
+* Fixed, that `param_name` is used when paginating with WillPaginate
+* Fixed the problem where `document_type` configuration was not propagated to mapping [6 months ago by Miguel Ferna
+* Refactored the code in `__find_in_batches` to use Enumerable#each_slice
+* Refactored the string queries in multiple_models_test.rb to avoid quote escaping
+
 ## 0.1.7
 
 * Improved examples and instructions in README and code annotations
 * Prevented index methods to swallow all exceptions
 * Added the `:validate` option to the `save` method for models
-* Added support for searching across multiple models (elastic/elasticsearch-rails#345),
+* Added support for searching across multiple models (elastic/elasticsearch-rails#345),
   including documentation, examples and tests
 
 ## 0.1.6

data/README.md

@@ -129,7 +129,7 @@ Or configure the client for all models:
 Elasticsearch::Model.client = Elasticsearch::Client.new log: true
 ```
 
-You might want to do this during you application bootstrap process, e.g. in a Rails initializer.
+You might want to do this during your application bootstrap process, e.g. in a Rails initializer.
 
 Please refer to the
 [`elasticsearch-transport`](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-transport)

data/examples/activerecord_mapping_completion.rb

@@ -0,0 +1,69 @@
+require 'ansi'
+require 'active_record'
+require 'elasticsearch/model'
+
+ActiveRecord::Base.logger = ActiveSupport::Logger.new(STDOUT)
+ActiveRecord::Base.establish_connection( adapter: 'sqlite3', database: ":memory:" )
+
+ActiveRecord::Schema.define(version: 1) do
+  create_table :articles do |t|
+    t.string :title
+    t.date   :published_at
+    t.timestamps
+  end
+end
+
+class Article < ActiveRecord::Base
+  include Elasticsearch::Model
+  include Elasticsearch::Model::Callbacks
+
+  mapping do
+    indexes :title
+    indexes :title_suggest, type: 'completion', payloads: true
+  end
+
+  def as_indexed_json(options={})
+    as_json.merge \
+    title_suggest: {
+      input:  title,
+      output: title,
+      payload: { url: "/articles/#{id}" }
+    }
+  end
+end
+
+Article.__elasticsearch__.client = Elasticsearch::Client.new log: true
+
+# Create index
+
+Article.__elasticsearch__.create_index! force: true
+
+# Store data
+
+Article.delete_all
+Article.create title: 'Foo'
+Article.create title: 'Bar'
+Article.create title: 'Foo Foo'
+Article.__elasticsearch__.refresh_index!
+
+# Search and suggest
+
+response_1 = Article.search 'foo';
+
+puts "Article search:".ansi(:bold),
+     response_1.to_a.map { |d| "Title: #{d.title}" }.inspect.ansi(:bold, :yellow)
+
+response_2 = Article.__elasticsearch__.client.suggest \
+  index: Article.index_name,
+  body: {
+    articles: {
+      text: 'foo',
+      completion: { field: 'title_suggest', size: 25 }
+    }
+  };
+
+puts "Article suggest:".ansi(:bold),
+     response_2['articles'].first['options'].map { |d| "#{d['text']} -> #{d['payload']['url']}" }.
+     inspect.ansi(:bold, :green)
+
+require 'pry'; binding.pry;

data/examples/mongoid_article.rb

@@ -21,7 +21,7 @@ Moped.logger.level = Logger::DEBUG
 
 Mongoid.connect_to 'articles'
 
-Elasticsearch::Model.client = Elasticsearch::Client.new host: 'localhost:9250', log: true
+Elasticsearch::Model.client = Elasticsearch::Client.new host: 'localhost:9200', log: true
 
 class Article
   include Mongoid::Document
@@ -49,7 +49,7 @@ Article.create id: '3', title: 'Foo Foo'
 
 # Index data
 #
-client = Elasticsearch::Client.new host:'localhost:9250', log:true
+client = Elasticsearch::Client.new host:'localhost:9200', log:true
 
 client.indices.delete index: 'articles' rescue nil
 client.bulk index: 'articles',

data/lib/elasticsearch/model.rb

@@ -145,7 +145,7 @@ module Elasticsearch
       #
       # @example Configure (set) the client for all models
       #
-      #     Elasticsearch::Model.client Elasticsearch::Client.new host: 'http://localhost:9200', tracer: true
+      #     Elasticsearch::Model.client = Elasticsearch::Client.new host: 'http://localhost:9200', tracer: true
       #     => #<Elasticsearch::Transport::Client:0x007f96a6dd0d80 @transport=... >
       #
       # @note You have to set the client before you call Elasticsearch methods on the model,

data/lib/elasticsearch/model/adapters/mongoid.rb

@@ -64,18 +64,8 @@ module Elasticsearch
           #
           def __find_in_batches(options={}, &block)
             options[:batch_size] ||= 1_000
-            items = []
-
-            all.each do |item|
-              items << item
-
-              if items.length % options[:batch_size] == 0
-                yield items
-                items = []
-              end
-            end
-
-            unless items.empty?
+  
+            all.no_timeout.each_slice(options[:batch_size]) do |items|
               yield items
             end
           end

data/lib/elasticsearch/model/adapters/multiple.rb

@@ -18,9 +18,11 @@ module Elasticsearch
           def records
             records_by_type = __records_by_type
 
-            response.response["hits"]["hits"].map do |hit|
+            records = response.response["hits"]["hits"].map do |hit|
               records_by_type[ __type_for_hit(hit) ][ hit[:_id] ]
             end
+
+            records.compact
           end
 
           # Returns the collection of records grouped by class based on `_type`
@@ -49,12 +51,12 @@ module Elasticsearch
           # @api private
           #
           def __records_for_klass(klass, ids)
-            adapter = __adapter_name_for_klass(klass)
+            adapter = __adapter_for_klass(klass)
 
-            case adapter
-              when Elasticsearch::Model::Adapter::ActiveRecord
+            case
+              when Elasticsearch::Model::Adapter::ActiveRecord.equal?(adapter)
                 klass.where(klass.primary_key => ids)
-              when Elasticsearch::Model::Adapter::Mongoid
+              when Elasticsearch::Model::Adapter::Mongoid.equal?(adapter)
                 klass.where(:id.in => ids)
               else
                 klass.find(ids)
@@ -100,7 +102,7 @@ module Elasticsearch
           #
           # @api private
           #
-          def __adapter_name_for_klass(klass)
+          def __adapter_for_klass(klass)
             Adapter.adapters.select { |name, checker| checker.call(klass) }.keys.first
           end
         end

data/lib/elasticsearch/model/importing.rb

@@ -114,6 +114,9 @@ module Elasticsearch
 
           if options.delete(:force)
             self.create_index! force: true, index: target_index
+          elsif !self.index_exists? index: target_index
+            raise ArgumentError,
+                  "#{target_index} does not exist to be imported into. Use create_index! or the :force option to create it."
           end
 
           __find_in_batches(options) do |batch|

data/lib/elasticsearch/model/indexing.rb

@@ -34,7 +34,10 @@ module Elasticsearch
       # Wraps the [index mappings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/mapping.html)
       #
       class Mappings
-        attr_accessor :options
+        attr_accessor :options, :type
+
+        # @private
+        TYPES_WITH_EMBEDDED_PROPERTIES = %w(object nested)
 
         def initialize(type, options={})
           raise ArgumentError, "`type` is missing" if type.nil?
@@ -44,12 +47,12 @@ module Elasticsearch
           @mapping = {}
         end
 
-        def indexes(name, options = {}, &block)
+        def indexes(name, options={}, &block)
           @mapping[name] = options
 
           if block_given?
             @mapping[name][:type] ||= 'object'
-            properties = @mapping[name][:type] == 'multi_field' ? :fields : :properties
+            properties = TYPES_WITH_EMBEDDED_PROPERTIES.include?(@mapping[name][:type]) ? :properties : :fields
 
             @mapping[name][properties] ||= {}
 
@@ -63,7 +66,6 @@ module Elasticsearch
           end
 
           # Set the type to `string` by default
-          #
           @mapping[name][:type] ||= 'string'
 
           self
@@ -128,14 +130,14 @@ module Elasticsearch
         #     # => {:article=>{:dynamic=>"strict", :properties=>{:foo=>{:type=>"long"}}}}
         #
         # The `mappings` and `settings` methods are accessible directly on the model class,
-        # when it doesn't already defines them. Use the `__elasticsearch__` proxy otherwise.
+        # when it doesn't already define them. Use the `__elasticsearch__` proxy otherwise.
         #
         def mapping(options={}, &block)
           @mapping ||= Mappings.new(document_type, options)
 
-          if block_given?
-            @mapping.options.update(options)
+          @mapping.options.update(options) unless options.empty?
 
+          if block_given?
             @mapping.instance_eval(&block)
             return self
           else
@@ -153,7 +155,39 @@ module Elasticsearch
         #
         #     # => {:index=>{:number_of_shards=>1}}
         #
+        # You can read settings from any object that responds to :read
+        # as long as its return value can be parsed as either YAML or JSON.
+        #
+        # @example Define index settings from YAML file
+        #
+        #     # config/elasticsearch/articles.yml:
+        #     #
+        #     # index:
+        #     #   number_of_shards: 1
+        #     #
+        #
+        #     Article.settings File.open("config/elasticsearch/articles.yml")
+        #
+        #     Article.settings.to_hash
+        #
+        #     # => { "index" => { "number_of_shards" => 1 } }
+        #
+        #
+        # @example Define index settings from JSON file
+        #
+        #     # config/elasticsearch/articles.json:
+        #     #
+        #     # { "index": { "number_of_shards": 1 } }
+        #     #
+        #
+        #     Article.settings File.open("config/elasticsearch/articles.json")
+        #
+        #     Article.settings.to_hash
+        #
+        #     # => { "index" => { "number_of_shards" => 1 } }
+        #
         def settings(settings={}, &block)
+          settings = YAML.load(settings.read) if settings.respond_to?(:read)
           @settings ||= Settings.new(settings)
 
           @settings.settings.update(settings) unless settings.empty?
@@ -166,6 +200,10 @@ module Elasticsearch
           end
         end
 
+        def load_settings_from_io(settings)
+          YAML.load(settings.read)
+        end
+
         # Creates an index with correct name, automatically passing
         # `settings` and `mappings` defined in the model
         #
@@ -186,7 +224,7 @@ module Elasticsearch
 
           delete_index!(options.merge index: target_index) if options[:force]
 
-          unless ( self.client.indices.exists(index: target_index) rescue false )
+          unless index_exists?(index: target_index)
             self.client.indices.create index: target_index,
                                        body: {
                                          settings: self.settings.to_hash,
@@ -194,6 +232,22 @@ module Elasticsearch
           end
         end
 
+        # Returns true if the index exists
+        #
+        # @example Check whether the model's index exists
+        #
+        #     Article.__elasticsearch__.index_exists?
+        #
+        # @example Check whether a specific index exists
+        #
+        #     Article.__elasticsearch__.index_exists? index: 'my-index'
+        #
+        def index_exists?(options={})
+          target_index = options[:index] || self.index_name
+
+          self.client.indices.exists(index: target_index) rescue false
+        end
+
         # Deletes the index with corresponding name
         #
         # @example Delete the index for the `Article` model

data/lib/elasticsearch/model/proxy.rb

@@ -59,8 +59,9 @@ module Elasticsearch
           # @see http://api.rubyonrails.org/classes/ActiveModel/Dirty.html
           #
           before_save do |i|
+            changed_attr = i.__elasticsearch__.instance_variable_get(:@__changed_attributes) || {}
             i.__elasticsearch__.instance_variable_set(:@__changed_attributes,
-                                                      Hash[ i.changes.map { |key, value| [key, value.last] } ])
+                                                      changed_attr.merge(Hash[ i.changes.map { |key, value| [key, value.last] } ]))
           end if respond_to?(:before_save) && instance_methods.include?(:changed_attributes)
         end
       end

data/lib/elasticsearch/model/response.rb

@@ -65,6 +65,12 @@ module Elasticsearch
         def shards
           Hashie::Mash.new(response['_shards'])
         end
+
+        # Returns a Hashie::Mash of the aggregations
+        #
+        def aggregations
+          response['aggregations'] ? Hashie::Mash.new(response['aggregations']) : nil
+        end
       end
     end
   end

data/lib/elasticsearch/model/response/pagination.rb

@@ -31,7 +31,7 @@ module Elasticsearch
                 @records  = nil
                 @response = nil
                 @page     = [num.to_i, 1].max
-                @per_page ||= klass.default_per_page
+                @per_page ||= __default_per_page
 
                 self.search.definition.update size: @per_page,
                                               from: @per_page * (@page - 1)
@@ -48,7 +48,7 @@ module Elasticsearch
               when search.definition[:size]
                 search.definition[:size]
               else
-                search.klass.default_per_page
+                __default_per_page
             end
           end
 
@@ -66,10 +66,11 @@ module Elasticsearch
           # Set the "limit" (`size`) value
           #
           def limit(value)
+            return self if value.to_i <= 0
             @results  = nil
             @records  = nil
             @response = nil
-            @per_page = value
+            @per_page = value.to_i
 
             search.definition.update :size => @per_page
             search.definition.update :from => @per_page * (@page - 1) if @page
@@ -79,11 +80,12 @@ module Elasticsearch
           # Set the "offset" (`from`) value
           #
           def offset(value)
+            return self if value.to_i < 0
             @results  = nil
             @records  = nil
             @response = nil
             @page     = nil
-            search.definition.update :from => value
+            search.definition.update :from => value.to_i
             self
           end
 
@@ -92,6 +94,14 @@ module Elasticsearch
           def total_count
             results.total
           end
+
+          # Returns the models's `per_page` value or the default
+          #
+          # @api private
+          #
+          def __default_per_page
+            klass.respond_to?(:default_per_page) && klass.default_per_page || ::Kaminari.config.default_per_page
+          end
         end
 
         # Allow models to be paginated with the "will_paginate" gem [https://github.com/mislav/will_paginate]
@@ -122,8 +132,9 @@ module Elasticsearch
           #     Article.search('foo').paginate(page: 1, per_page: 30)
           #
           def paginate(options)
-            page = [options[:page].to_i, 1].max
-            per_page = (options[:per_page] || klass.per_page).to_i
+            param_name = options[:param_name] || :page
+            page       = [options[param_name].to_i, 1].max
+            per_page   = (options[:per_page] || __default_per_page).to_i
 
             search.definition.update size: per_page,
                                      from: (page - 1) * per_page
@@ -165,6 +176,14 @@ module Elasticsearch
           def total_entries
             results.total
           end
+
+          # Returns the models's `per_page` value or the default
+          #
+          # @api private
+          #
+          def __default_per_page
+            klass.respond_to?(:per_page) && klass.per_page || ::WillPaginate.per_page
+          end
         end
       end