elasticsearch-rails 6.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 070bf4a5038e804d6adbd606f8ea323762306bff7f85133032ed92b7b2afbf42
-  data.tar.gz: a2d0e978f0506dabe33c4ee0fad12219967f1dcc368e3eb10ac6e680822ae42e
+  metadata.gz: e9facdda3d11d901cd6b8af2d11b62d0974f97264b10729c0e2405a814d19e17
+  data.tar.gz: ff4a3bb45141d484135e080bd1712ab3c23b757943a46625f06f208b7b9694b4
 SHA512:
-  metadata.gz: b50622e07f26f1d3fea2f16b69fa1f6aaad38a3940004af7f14feaf7d0653356a98ad82b123b26afb543e4fa945a1617c07387359a7b40a42394b138a322e5ab
-  data.tar.gz: 6fed4e96cda1555523a269c3bb1f6585a697dd245a5b18621b30035b49fd2fd51e94e70844ea36ac89463c2a2d611612119433624a4c70a88a8016a24ddede1c
+  metadata.gz: 00cd626f58dcf386def45b82d29cf3eea798e043ae3345ef610a86dfb6e76e7df83025bba18eeba7f2228c947c67cfe8a881474dd8a125db88297f9bca2378df
+  data.tar.gz: 00a182d1f145c48115887e6c394ef567b97319b51b7591a79fc48f0a471600f8d784c20450a3526858d773fe15b70a3a2dd1727b785925a46c71bd7f9b2b2cf4

data/Gemfile

@@ -3,12 +3,12 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in elasticsearch-rails.gemspec
 gemspec
 
-# TODO: Figure out how to specify dependency on local elasticsearch-model without endless "Resolving dependencies"
-# if File.exists? File.expand_path("../../elasticsearch-model", __FILE__)
-#   gem 'elasticsearch-model', :path => File.expand_path("../../elasticsearch-model", __FILE__), :require => true
-# end
-
-
-
 gem 'elasticsearch-model', :path => File.expand_path("../../elasticsearch-model", __FILE__), :require => false
 gem 'elasticsearch-persistence', :path => File.expand_path("../../elasticsearch-persistence", __FILE__), :require => false
+
+
+group :development, :testing do
+  gem 'rspec'
+  gem 'pry-nav'
+  gem 'sqlite3' unless defined?(JRUBY_VERSION)
+end

data/README.md

@@ -16,6 +16,7 @@ is compatible with the Elasticsearch `master` branch, therefore, with the next m
 | 0.1           | → | 1.x           |
 | 2.x           | → | 2.x           |
 | 5.x           | → | 5.x           |
+| 6.x           | → | 6.x           |
 | master        | → | master        |
 
 ## Installation

data/Rakefile

@@ -7,24 +7,27 @@ task :test    => 'test:unit'
 # ----- Test tasks ------------------------------------------------------------
 
 require 'rake/testtask'
+require 'rspec/core/rake_task'
+
 namespace :test do
-  Rake::TestTask.new(:unit) do |test|
-    test.libs << 'lib' << 'test'
-    test.test_files = FileList["test/unit/**/*_test.rb"]
-    test.verbose = false
-    test.warning = false
-  end
 
-  Rake::TestTask.new(:integration) do |test|
-    test.libs << 'lib' << 'test'
-    test.test_files = FileList["test/integration/**/*_test.rb"]
+  RSpec::Core::RakeTask.new(:spec)
+
+  Rake::TestTask.new(:all) do |test|
     test.verbose = false
     test.warning = false
+    test.deps = [ :spec ] unless defined?(JRUBY_VERSION)
   end
+end
 
-  Rake::TestTask.new(:all) do |test|
-    test.libs << 'lib' << 'test'
-    test.test_files = FileList["test/unit/**/*_test.rb", "test/integration/**/*_test.rb"]
+namespace :bundle do
+  desc 'Install gem dependencies'
+  task :install do
+    puts '-'*80
+    Bundler.with_clean_env do
+      sh 'bundle install'
+    end
+    puts '-'*80
   end
 end
 

data/elasticsearch-rails.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = ">= 1.9.3"
 
-  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "bundler"
   s.add_development_dependency "rake", "~> 11.1"
 
   s.add_development_dependency "elasticsearch-extensions"

data/lib/elasticsearch/rails/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module Rails
-    VERSION = '6.0.0'
+    VERSION = '6.1.0'
   end
 end

data/lib/rails/templates/03-expert.rb

@@ -270,9 +270,8 @@ Elasticsearch::Model.client = Elasticsearch::Client.new host: ELASTICSEARCH_URL
 if Rails.env.development?
   tracer = ActiveSupport::Logger.new('log/elasticsearch.log')
   tracer.level =  Logger::DEBUG
+  Elasticsearch::Model.client.transport.tracer = tracer
 end
-
-Elasticsearch::Model.client.transport.tracer = tracer
 CODE
 
 git add:    "config/initializers"

data/lib/rails/templates/seeds.rb

@@ -3,7 +3,8 @@ require 'yaml'
 
 Zlib::GzipReader.open(File.expand_path('../articles.yml.gz', __FILE__)) do |gzip|
   puts "Reading articles from gzipped YAML..."
-  @documents = YAML.load_documents(gzip.read)
+  @documents = YAML.respond_to?(:load_documents) ? YAML.load_documents(gzip.read) : 
+    YAML.load_stream(gzip.read)
 end
 
 # Truncate the default ActiveRecord logger output

data/spec/instrumentation_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe 'ActiveSupport::Instrumentation integration' do
+
+  before(:all) do
+    class DummyInstrumentationModel
+      extend Elasticsearch::Model::Searching::ClassMethods
+
+      def self.index_name;    'foo'; end
+      def self.document_type; 'bar'; end
+    end
+  end
+
+  after(:all) do
+    remove_classes(DummyInstrumentationModel)
+  end
+
+  let(:response_document) do
+    { 'took' => '5ms',
+      'hits' => { 'total' => 123,
+                  'max_score' => 456,
+                  'hits' => [] } }
+  end
+
+  let(:search) do
+    Elasticsearch::Model::Searching::SearchRequest.new(DummyInstrumentationModel, 'foo')
+  end
+
+  let(:client) do
+    double('client', search: response_document)
+  end
+
+  before do
+    allow(DummyInstrumentationModel).to receive(:client).and_return(client)
+    Elasticsearch::Rails::Instrumentation::Railtie.run_initializers
+  end
+
+  context 'SearchRequest#execute!' do
+
+    it 'wraps the method with instrumentation' do
+      expect(search).to respond_to(:execute_without_instrumentation!)
+      expect(search).to respond_to(:execute_with_instrumentation!)
+    end
+  end
+
+  context 'Model#search' do
+
+    before do
+      expect(ActiveSupport::Notifications).to receive(:instrument).with('search.elasticsearch',
+                                                                        { klass: 'DummyInstrumentationModel',
+                                                                          name: 'Search',
+                                                                          search: { body: query,
+                                                                          index: 'foo',
+                                                                          type: 'bar' } }).and_return({})
+    end
+
+    let(:query) do
+      { query: { match: { foo: 'bar' } } }
+    end
+
+    let(:logged_message) do
+      @logger.logged(:debug).first
+    end
+
+    it 'publishes a notification' do
+      expect(DummyInstrumentationModel.search(query).response).to eq({})
+    end
+
+    context 'when a message is logged', unless: defined?(RUBY_VERSION) && RUBY_VERSION > '2.2' do
+
+      let(:query) do
+        { query: { match: { moo: 'bam' } } }
+      end
+
+      it 'prints the debug information to the log' do
+        expect(logged_message).to match(/DummyInstrumentationModel Search \(\d+\.\d+ms\)/)
+        expect(logged_message).to match(/body\: \{query\: \{match\: \{moo\: "bam"\}\}\}\}/)
+      end
+    end
+  end
+end

data/spec/lograge_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'action_pack'
+require 'lograge'
+require 'elasticsearch/rails/lograge'
+
+describe 'ActiveSupport::Instrumentation integration' do
+
+  before do
+    Elasticsearch::Rails::Lograge::Railtie.run_initializers
+  end
+
+  it 'customizes the Lograge configuration' do
+    expect(Elasticsearch::Rails::Lograge::Railtie.initializers
+               .select { |i| i.name == 'elasticsearch.lograge' }
+               .first).not_to be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+require 'pry-nav'
+require 'active_record'
+require 'elasticsearch/model'
+require 'elasticsearch/rails'
+require 'rails/railtie'
+require 'elasticsearch/rails/instrumentation'
+
+
+unless defined?(ELASTICSEARCH_URL)
+  ELASTICSEARCH_URL = ENV['ELASTICSEARCH_URL'] || "localhost:#{(ENV['TEST_CLUSTER_PORT'] || 9200)}"
+end
+
+RSpec.configure do |config|
+  config.formatter = 'documentation'
+  config.color = true
+
+  config.before(:suite) do
+    require 'ansi'
+    tracer = ::Logger.new(STDERR)
+    tracer.formatter = lambda { |s, d, p, m| "#{m.gsub(/^.*$/) { |n| '   ' + n }.ansi(:faint)}\n" }
+    Elasticsearch::Model.client = Elasticsearch::Client.new host: ELASTICSEARCH_URL,
+                                                            tracer: (ENV['QUIET'] ? nil : tracer)
+
+    unless ActiveRecord::Base.connected?
+      ActiveRecord::Base.establish_connection( :adapter => 'sqlite3', :database => ":memory:" )
+    end
+
+    if ::ActiveRecord::Base.respond_to?(:raise_in_transactional_callbacks) && ::ActiveRecord::VERSION::MAJOR.to_s < '5'
+      ::ActiveRecord::Base.raise_in_transactional_callbacks = true
+    end
+  end
+end
+
+# Remove all classes.
+#
+# @param [ Array<Class> ] classes The list of classes to remove.
+#
+# @return [ true ]
+#
+# @since 6.0.1
+def remove_classes(*classes)
+  classes.each do |_class|
+    Object.send(:remove_const, _class.name.to_sym) if defined?(_class)
+  end and true
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-rails
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.1.0
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-06 00:00:00.000000000 Z
+date: 2019-08-12 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'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -289,9 +289,9 @@ files:
 - lib/rails/templates/searchable.dsl.rb
 - lib/rails/templates/searchable.rb
 - lib/rails/templates/seeds.rb
-- test/test_helper.rb
-- test/unit/instrumentation/instrumentation_test.rb
-- test/unit/instrumentation/lograge_test.rb
+- spec/instrumentation_spec.rb
+- spec/lograge_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/elasticsearch/elasticsearch-rails/
 licenses:
 - Apache 2
@@ -312,12 +312,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Ruby on Rails integrations for Elasticsearch.
 test_files:
-- test/test_helper.rb
-- test/unit/instrumentation/instrumentation_test.rb
-- test/unit/instrumentation/lograge_test.rb
+- spec/instrumentation_spec.rb
+- spec/lograge_spec.rb
+- spec/spec_helper.rb

data/test/test_helper.rb

@@ -1,64 +0,0 @@
-RUBY_1_8 = defined?(RUBY_VERSION) && RUBY_VERSION < '1.9'
-
-exit(0) if RUBY_1_8
-
-require 'simplecov' and SimpleCov.start { add_filter "/test|test_/" } if ENV["COVERAGE"]
-
-# Register `at_exit` handler for integration tests shutdown.
-# MUST be called before requiring `test/unit`.
-at_exit { Elasticsearch::Test::IntegrationTestCase.__run_at_exit_hooks }
-
-puts '-'*80
-
-if defined?(RUBY_VERSION) && RUBY_VERSION > '2.2'
-  require 'test-unit'
-  require 'mocha/test_unit'
-else
-  require 'minitest/autorun'
-  require 'mocha/mini_test'
-end
-
-require 'shoulda-context'
-
-require 'turn' unless ENV["TM_FILEPATH"] || ENV["NOTURN"] || defined?(RUBY_VERSION) && RUBY_VERSION > '2.2'
-
-require 'ansi'
-require 'oj' unless defined?(JRUBY_VERSION)
-
-require 'rails/version'
-require 'active_record'
-require 'active_model'
-
-require 'elasticsearch/model'
-require 'elasticsearch/rails'
-
-require 'elasticsearch/extensions/test/cluster'
-require 'elasticsearch/extensions/test/startup_shutdown'
-
-module Elasticsearch
-  module Test
-    class IntegrationTestCase < ::Test::Unit::TestCase
-      extend Elasticsearch::Extensions::Test::StartupShutdown
-
-      startup  { Elasticsearch::Extensions::Test::Cluster.start(nodes: 1) if ENV['SERVER'] and not Elasticsearch::Extensions::Test::Cluster.running? }
-      shutdown { Elasticsearch::Extensions::Test::Cluster.stop if ENV['SERVER'] && started? }
-      context "IntegrationTest" do; should "noop on Ruby 1.8" do; end; end if RUBY_1_8
-
-      def setup
-        ActiveRecord::Base.establish_connection( :adapter => 'sqlite3', :database => ":memory:" )
-        logger = ::Logger.new(STDERR)
-        logger.formatter = lambda { |s, d, p, m| "#{m.ansi(:faint, :cyan)}\n" }
-        ActiveRecord::Base.logger = logger unless ENV['QUIET']
-
-        ActiveRecord::LogSubscriber.colorize_logging = false
-        ActiveRecord::Migration.verbose = false
-
-        tracer = ::Logger.new(STDERR)
-        tracer.formatter = lambda { |s, d, p, m| "#{m.gsub(/^.*$/) { |n| '   ' + n }.ansi(:faint)}\n" }
-
-        Elasticsearch::Model.client = Elasticsearch::Client.new host: "localhost:#{(ENV['TEST_CLUSTER_PORT'] || 9250)}",
-                                                                tracer: (ENV['QUIET'] ? nil : tracer)
-      end
-    end
-  end
-end

data/test/unit/instrumentation/instrumentation_test.rb

@@ -1,61 +0,0 @@
-require 'test_helper'
-
-require 'rails/railtie'
-require 'active_support/log_subscriber/test_helper'
-
-require 'elasticsearch/rails/instrumentation'
-
-class Elasticsearch::Rails::InstrumentationTest < Test::Unit::TestCase
-  include ActiveSupport::LogSubscriber::TestHelper
-
-  context "ActiveSupport::Instrumentation integration" do
-    class ::DummyInstrumentationModel
-      extend Elasticsearch::Model::Searching::ClassMethods
-
-      def self.index_name;    'foo'; end
-      def self.document_type; 'bar'; end
-    end
-
-    RESPONSE = { 'took' => '5ms', 'hits' => { 'total' => 123, 'max_score' => 456, 'hits' => [] } }
-
-    setup do
-      @search = Elasticsearch::Model::Searching::SearchRequest.new ::DummyInstrumentationModel, '*'
-
-      @client = stub('client', search: RESPONSE)
-      DummyInstrumentationModel.stubs(:client).returns(@client)
-
-      Elasticsearch::Rails::Instrumentation::Railtie.run_initializers
-    end
-
-    should "wrap SearchRequest#execute! with instrumentation" do
-      s = Elasticsearch::Model::Searching::SearchRequest.new ::DummyInstrumentationModel, 'foo'
-      assert_respond_to s, :execute_without_instrumentation!
-      assert_respond_to s, :execute_with_instrumentation!
-    end
-
-    should "publish the notification" do
-      @query = { query: { match: { foo: 'bar' } } }
-
-      ActiveSupport::Notifications.expects(:instrument).with do |name, payload|
-        assert_equal "search.elasticsearch", name
-        assert_equal 'DummyInstrumentationModel', payload[:klass]
-        assert_equal @query, payload[:search][:body]
-        true
-      end
-
-      s = ::DummyInstrumentationModel.search @query
-      s.response
-    end
-
-    should "print the debug information to the Rails log" do
-      s = ::DummyInstrumentationModel.search query: { match: { moo: 'bam' } }
-      s.response
-
-      logged = @logger.logged(:debug).first
-
-      assert_not_nil logged
-      assert_match /DummyInstrumentationModel Search \(\d+\.\d+ms\)/,  logged
-      assert_match /body\: \{query\: \{match\: \{moo\: "bam"\}\}\}\}/, logged
-    end unless defined?(RUBY_VERSION) && RUBY_VERSION > '2.2'
-  end
-end

data/test/unit/instrumentation/lograge_test.rb

@@ -1,21 +0,0 @@
-require 'test_helper'
-
-require 'rails/railtie'
-require 'action_pack'
-require 'lograge'
-
-require 'elasticsearch/rails/lograge'
-
-class Elasticsearch::Rails::LogrageTest < Test::Unit::TestCase
-  context "Lograge integration" do
-    setup do
-      Elasticsearch::Rails::Lograge::Railtie.run_initializers
-    end
-
-    should "customize the Lograge configuration" do
-      assert_not_nil Elasticsearch::Rails::Lograge::Railtie.initializers
-                       .select { |i| i.name == 'elasticsearch.lograge' }
-                       .first
-    end
-  end
-end