elasticsearch-model 0.1.9 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6ee0c4e1aa23d578d305367880c00683f8722eb
-  data.tar.gz: e55f679c7973d5381225ca46514dd3d901a65aa4
+  metadata.gz: 3f2934457bc9ab48762cfab715d994d56b9421f0
+  data.tar.gz: 4c7ed85875ee9ab58ff390ad1e6e7a13d576807b
 SHA512:
-  metadata.gz: e1bb3398d41326acb683669d4becd275f2f6bb9c4ef4ac8148d810c056d8e59df3ee0647f0dabaeb681d29cd94eff8fee7498fbc09cd3ec91a9abd2986bce953
-  data.tar.gz: 7c7f7e24165e04f86494f5458944155cfa4c36f1e15acd58ede28d27372172885f74c74d1af16d6786960c0402eb0f58a24f223b58a3f865a61cb4a9f5851878
+  metadata.gz: df184cea73c42757b1c52afe22c009000310eaf5383d01b82055e51cb953f86701584b5afc56dadb9ef811e4ca87c92e8e67c9a7e84ef3a3bab680330c27f445
+  data.tar.gz: 34e576da4c6d6e0ea80ed5f175c226f1583332c29d3eb0fc8b488d4f7dbc0222ea3eba5e87001e7c3a7e79493a230cba402acfc7adcfa5b150d7e86e0a7086f0

data/.gitignore

@@ -18,3 +18,4 @@ tmp
 
 gemfiles/3.0.gemfile.lock
 gemfiles/4.0.gemfile.lock
+gemfiles/5.0.gemfile.lock

data/README.md

@@ -1,13 +1,25 @@
 # Elasticsearch::Model
 
 The `elasticsearch-model` library builds on top of the
-the [`elasticsearch`](https://github.com/elasticsearch/elasticsearch-ruby) library.
+the [`elasticsearch`](https://github.com/elastic/elasticsearch-ruby) library.
 
 It aims to simplify integration of Ruby classes ("models"), commonly found
 e.g. in [Ruby on Rails](http://rubyonrails.org) applications, with the
 [Elasticsearch](http://www.elasticsearch.org) search and analytics engine.
 
-The library is compatible with Ruby 1.9.3 and higher.
+## Compatibility
+
+This library is compatible with Ruby 1.9.3 and higher.
+
+The library version numbers follow the Elasticsearch major versions, and the `master` branch
+is compatible with the Elasticsearch `master` branch, therefore, with the next major version.
+
+| Rubygem       |   | Elasticsearch |
+|:-------------:|:-:| :-----------: |
+| 0.1           | → | 1.x           |
+| 2.x           | → | 2.x           |
+| 5.x           | → | 5.x           |
+| master        | → | master        |
 
 ## Installation
 
@@ -17,11 +29,11 @@ Install the package from [Rubygems](https://rubygems.org):
 
 To use an unreleased version, either add it to your `Gemfile` for [Bundler](http://bundler.io):
 
-    gem 'elasticsearch-model', git: 'git://github.com/elasticsearch/elasticsearch-rails.git'
+    gem 'elasticsearch-model', git: 'git://github.com/elastic/elasticsearch-rails.git', branch: '5.x'
 
 or install it from a source code checkout:
 
-    git clone https://github.com/elasticsearch/elasticsearch-rails.git
+    git clone https://github.com/elastic/elasticsearch-rails.git
     cd elasticsearch-rails/elasticsearch-model
     bundle install
     rake install
@@ -109,7 +121,7 @@ See the `Elasticsearch::Model` module documentation for technical information.
 
 ### The Elasticsearch client
 
-The module will set up a [client](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch),
+The module will set up a [client](https://github.com/elastic/elasticsearch-ruby/tree/master/elasticsearch),
 connected to `localhost:9200`, by default. You can access and use it as any other `Elasticsearch::Client`:
 
 ```ruby
@@ -132,7 +144,7 @@ Elasticsearch::Model.client = Elasticsearch::Client.new log: true
 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)
+[`elasticsearch-transport`](https://github.com/elastic/elasticsearch-ruby/tree/master/elasticsearch-transport)
 library documentation for all the configuration options, and to the
 [`elasticsearch-api`](http://rubydoc.info/gems/elasticsearch-api) library documentation
 for information about the Ruby client API.
@@ -241,7 +253,7 @@ response.records.order(:title).to_a
 The `records` method returns the real instances of your model, which is useful when you want to access your
 model methods -- at the expense of slowing down your application, of course.
 In most cases, working with `results` coming from Elasticsearch is sufficient, and much faster. See the
-[`elasticsearch-rails`](https://github.com/elasticsearch/elasticsearch-rails/tree/master/elasticsearch-rails)
+[`elasticsearch-rails`](https://github.com/elastic/elasticsearch-rails/tree/master/elasticsearch-rails)
 library for more information about compatibility with the Ruby on Rails framework.
 
 When you want to access both the database `records` and search `results`, use the `each_with_hit`
@@ -303,7 +315,7 @@ In a Rails controller, use the the `params[:page]` parameter to paginate through
 To initialize and include the Kaminari pagination support manually:
 
 ```ruby
-Kaminari::Hooks.init
+Kaminari::Hooks.init if defined?(Kaminari::Hooks)
 Elasticsearch::Model::Response::Response.__send__ :include, Elasticsearch::Model::Response::Pagination::Kaminari
 ```
 
@@ -320,8 +332,8 @@ response.results.first.highlight.title
 # ["Quick brown <em>fox</em>"]
 ```
 
-You can pass any object which implements a `to_hash` method, or you can use your favourite JSON builder
-to build the search definition as a JSON string:
+You can pass any object which implements a `to_hash` method, which is called automatically,
+so you can use a custom class or your favourite JSON builder to build the search definition:
 
 ```ruby
 require 'jbuilder'
@@ -341,6 +353,25 @@ response.results.first.title
 # => "Quick brown fox"
 ```
 
+Also, you can use the [**`elasticsearch-dsl`**](https://github.com/elastic/elasticsearch-ruby/tree/master/elasticsearch-dsl) library, which provides a specialized Ruby API for
+the Elasticsearch Query DSL:
+
+```ruby
+require 'elasticsearch/dsl'
+
+query = Elasticsearch::DSL::Search.search do
+  query do
+    match :title do
+      query 'fox dogs'
+    end
+  end
+end
+
+response = Article.search query
+response.results.first.title
+# => "Quick brown fox"
+```
+
 ### Index Configuration
 
 For proper search engine function, it's often necessary to configure the index properly.
@@ -685,6 +716,18 @@ response.records.records.class
 More examples can be found in the `examples` folder. Please see the `Elasticsearch::Model::Adapter`
 module and its submodules for technical information.
 
+### Settings
+
+The module provides a common `settings` method to customize various features.
+
+At the moment, the only supported setting is `:inheritance_enabled`, which makes the class receiving the module
+respect index names and document types of a super-class, eg. in case you're using "single table inheritance" (STI)
+in Rails:
+
+```ruby
+Elasticsearch::Model.settings[:inheritance_enabled] = true
+```
+
 ## Development and Community
 
 For local development, clone the repository and run `bundle install`. See `rake -T` for a list of

data/Rakefile

@@ -4,40 +4,49 @@ desc "Run unit tests"
 task :default => 'test:unit'
 task :test    => 'test:unit'
 
+namespace :bundler do
+  desc "Install dependencies for all the Gemfiles"
+  task :install do
+    sh "BUNDLE_GEMFILE='#{File.expand_path('../gemfiles/3.0.gemfile', __FILE__)}' bundle install"
+    sh "BUNDLE_GEMFILE='#{File.expand_path('../gemfiles/4.0.gemfile', __FILE__)}' bundle install"
+    sh "BUNDLE_GEMFILE='#{File.expand_path('../gemfiles/5.0.gemfile', __FILE__)}' bundle install"
+  end
+end
+
 # ----- Test tasks ------------------------------------------------------------
 
 require 'rake/testtask'
 namespace :test do
-  task :ci_reporter do
-    ENV['CI_REPORTS'] ||= 'tmp/reports'
-    require 'ci/reporter/rake/minitest'
-    Rake::Task['ci:setup:minitest'].invoke
-  end
-
-  Rake::TestTask.new(:unit) do |test|
-    Rake::Task['test:ci_reporter'].invoke if ENV['CI']
+  Rake::TestTask.new(:run_unit) do |test|
     test.libs << 'lib' << 'test'
     test.test_files = FileList["test/unit/**/*_test.rb"]
-    # test.verbose = true
-    # test.warning = true
+    test.verbose = false
+    test.warning = false
   end
 
   Rake::TestTask.new(:run_integration) do |test|
-    Rake::Task['test:ci_reporter'].invoke if ENV['CI']
     test.libs << 'lib' << 'test'
     test.test_files = FileList["test/integration/**/*_test.rb"]
+    test.verbose = false
+    test.warning = false
+  end
+
+  desc "Run unit tests against ActiveModel 3, 4 and 5"
+  task :unit do
+    sh "BUNDLE_GEMFILE='#{File.expand_path('../gemfiles/3.0.gemfile', __FILE__)}' bundle exec rake test:run_unit"
+    sh "BUNDLE_GEMFILE='#{File.expand_path('../gemfiles/4.0.gemfile', __FILE__)}' bundle exec rake test:run_unit"
+    sh "BUNDLE_GEMFILE='#{File.expand_path('../gemfiles/5.0.gemfile', __FILE__)}' bundle exec rake test:run_unit"
   end
 
-  desc "Run integration tests against ActiveModel 3 and 4"
+  desc "Run integration tests against ActiveModel 3, 4 and 5"
   task :integration do
-    sh "BUNDLE_GEMFILE='#{File.expand_path('../gemfiles/3.0.gemfile', __FILE__)}' bundle exec rake test:run_integration" unless defined?(RUBY_VERSION) && RUBY_VERSION > '2.2'
+    sh "BUNDLE_GEMFILE='#{File.expand_path('../gemfiles/3.0.gemfile', __FILE__)}' bundle exec rake test:run_integration"
     sh "BUNDLE_GEMFILE='#{File.expand_path('../gemfiles/4.0.gemfile', __FILE__)}' bundle exec rake test:run_integration"
+    sh "BUNDLE_GEMFILE='#{File.expand_path('../gemfiles/5.0.gemfile', __FILE__)}' bundle exec rake test:run_integration"
   end
 
   desc "Run unit and integration tests"
   task :all do
-    Rake::Task['test:ci_reporter'].invoke if ENV['CI']
-
     Rake::Task['test:unit'].invoke
     Rake::Task['test:integration'].invoke
   end

data/elasticsearch-model.gemspec

@@ -23,35 +23,32 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = ">= 1.9.3"
 
-  s.add_dependency "elasticsearch",       '> 0.4'
+  s.add_dependency "elasticsearch",       '~> 1.1'
   s.add_dependency "activesupport",       '> 3'
   s.add_dependency "hashie"
 
   s.add_development_dependency "bundler", "~> 1.3"
-  s.add_development_dependency "rake", "< 11.0"
+  s.add_development_dependency "rake", "~> 11.1"
 
   s.add_development_dependency "elasticsearch-extensions"
 
   s.add_development_dependency "sqlite3"
-  s.add_development_dependency "activemodel",   "> 3.0"
+  s.add_development_dependency "activemodel",   "> 3"
 
   s.add_development_dependency "oj"
   s.add_development_dependency "kaminari"
   s.add_development_dependency "will_paginate"
 
-  s.add_development_dependency "minitest", "~> 4.2"
-  s.add_development_dependency "test-unit" if defined?(RUBY_VERSION) && RUBY_VERSION > '2.2'
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "test-unit"
   s.add_development_dependency "shoulda-context"
   s.add_development_dependency "mocha"
   s.add_development_dependency "turn"
   s.add_development_dependency "yard"
   s.add_development_dependency "ruby-prof"
   s.add_development_dependency "pry"
-  s.add_development_dependency "ci_reporter", "~> 1.9"
 
-  if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
-    s.add_development_dependency "simplecov"
-    s.add_development_dependency "cane"
-    s.add_development_dependency "require-prof"
-  end
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "cane"
+  s.add_development_dependency "require-prof"
 end

data/examples/activerecord_article.rb

@@ -26,7 +26,7 @@ ActiveRecord::Schema.define(version: 1) do
   end
 end
 
-Kaminari::Hooks.init
+Kaminari::Hooks.init if defined?(Kaminari::Hooks) if defined?(Kaminari::Hooks)
 
 class Article < ActiveRecord::Base
 end

data/examples/activerecord_associations.rb

@@ -28,23 +28,23 @@ ActiveRecord::Base.establish_connection( adapter: 'sqlite3', database: ":memory:
 ActiveRecord::Schema.define(version: 1) do
   create_table :categories do |t|
     t.string     :title
-    t.timestamps
+    t.timestamps null: false
   end
 
   create_table :authors do |t|
     t.string     :first_name, :last_name
-    t.timestamps
+    t.timestamps null: false
   end
 
   create_table :authorships do |t|
     t.references :article
     t.references :author
-    t.timestamps
+    t.timestamps null: false
   end
 
   create_table :articles do |t|
     t.string   :title
-    t.timestamps
+    t.timestamps null: false
   end
 
   create_table :articles_categories, id: false do |t|
@@ -54,9 +54,10 @@ ActiveRecord::Schema.define(version: 1) do
   create_table :comments do |t|
     t.string     :text
     t.references :article
-    t.timestamps
+    t.timestamps null: false
   end
-  add_index(:comments, :article_id)
+
+  add_index(:comments, :article_id) unless index_exists?(:comments, :article_id)
 end
 
 # ----- Elasticsearch client setup ----------------------------------------------------------------

data/gemfiles/5.0.gemfile

@@ -0,0 +1,12 @@
+# Usage:
+#
+# $ BUNDLE_GEMFILE=./gemfiles/5.0.gemfile bundle install
+# $ BUNDLE_GEMFILE=./gemfiles/5.0.gemfile bundle exec rake test:integration
+
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activemodel',  '~> 5'
+gem 'activerecord', '~> 5'
+gem 'sqlite3'

data/lib/elasticsearch/model.rb

@@ -31,6 +31,7 @@ require 'elasticsearch/model/response/result'
 require 'elasticsearch/model/response/results'
 require 'elasticsearch/model/response/records'
 require 'elasticsearch/model/response/pagination'
+require 'elasticsearch/model/response/aggregations'
 require 'elasticsearch/model/response/suggestions'
 
 require 'elasticsearch/model/ext/active_record'
@@ -129,8 +130,13 @@ module Elasticsearch
       end
     end
 
-    module ClassMethods
+    # Access the module settings
+    #
+    def self.settings
+      @settings ||= {}
+    end
 
+    module ClassMethods
       # Get the client common for all models
       #
       # @example Get the client
@@ -180,6 +186,24 @@ module Elasticsearch
         request = Searching::SearchRequest.new(models, query_or_payload, options)
         Response::Response.new(models, request)
       end
+
+      # Check if inheritance is enabled
+      #
+      # @note Inheritance is disabled by default.
+      #
+      def inheritance_enabled
+        @inheritance_enabled ||= false
+      end
+
+      # Enable inheritance of index_name and document_type
+      #
+      # @example Enable inheritance
+      #
+      #     Elasticsearch::Model.inheritance_enabled = true
+      #
+      def inheritance_enabled=(inheritance_enabled)
+        @inheritance_enabled = inheritance_enabled
+      end
     end
     extend ClassMethods
 

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

@@ -26,14 +26,17 @@ module Elasticsearch
             # by redefining `to_a`, unless the user has called `order()`
             #
             sql_records.instance_exec(response.response['hits']['hits']) do |hits|
-              define_singleton_method :to_a do
+              ar_records_method_name = :to_a
+              ar_records_method_name = :records if defined?(::ActiveRecord) && ::ActiveRecord::VERSION::MAJOR >= 5
+
+              define_singleton_method(ar_records_method_name) do
                 if defined?(::ActiveRecord) && ::ActiveRecord::VERSION::MAJOR >= 4
                   self.load
                 else
                   self.__send__(:exec_queries)
                 end
                 @records.sort_by { |record| hits.index { |hit| hit['_id'].to_s == record.id.to_s } }
-              end
+              end if self
             end
 
             sql_records
@@ -42,7 +45,7 @@ module Elasticsearch
           # Prevent clash with `ActiveSupport::Dependencies::Loadable`
           #
           def load
-            records.load
+            records.__send__(:load)
           end
 
           # Intercept call to the `order` method, so we can ignore the order from Elasticsearch

data/lib/elasticsearch/model/naming.rb

@@ -34,7 +34,7 @@ module Elasticsearch
           if @index_name.respond_to?(:call)
             @index_name.call
           else
-            @index_name || self.model_name.collection.gsub(/\//, '-')
+            @index_name || implicit(:index_name)
           end
         end
 
@@ -58,7 +58,7 @@ module Elasticsearch
         #     Article.document_type "my-article"
         #
         def document_type name=nil
-          @document_type = name || @document_type || self.model_name.element
+          @document_type = name || @document_type || implicit(:document_type)
         end
 
 
@@ -69,6 +69,30 @@ module Elasticsearch
         def document_type=(name)
           @document_type = name
         end
+
+        private
+
+          def implicit(prop)
+            value = nil
+
+            if Elasticsearch::Model.settings[:inheritance_enabled]
+              self.ancestors.each do |klass|
+                next if klass == self
+                break if value = klass.respond_to?(prop) && klass.send(prop)
+              end
+            end
+
+            value || self.send("default_#{prop}")
+          end
+
+          def default_index_name
+            self.model_name.collection.gsub(/\//, '-')
+          end
+
+          def default_document_type
+            self.model_name.element
+          end
+
       end
 
       module InstanceMethods