es-elasticity 0.12.0 → 0.13.3.pre1

data/README.md

@@ -31,7 +31,7 @@ Or install it yourself as:
 ### Version Support
 This gem has [elasticsearch-ruby](https://github.com/elastic/elasticsearch-ruby) as a dependency.  In order to use different versions of elasticsearch you will need to match your version of elasticsearch-ruby to the version of elasticsearch you want to use ([see here](https://github.com/elastic/elasticsearch-ruby#compatibility).  Elasticity should work across all versions of elastisearch-ruby, although they have not all been tested so there are likely edge cases.
 
-Currently tests are run on travis ci against elasticsearch 5.1.1 with elasticsearch-ruby 5.0.3.
+Currently tests are run on CirlceCI against elasticsearch 6.8.2 with elasticsearch-ruby 7.2.0.
 
 ### Configuration
 
@@ -194,7 +194,7 @@ adults = adults.active_records(User)
 #### Search Args
 
 ##### explain: true
-For `search` definitions we support passing  `{ explain: true }` to the search as a second argument in order to surface the reason a search result was returned. 
+For `search` definitions we support passing  `{ explain: true }` to the search as a second argument in order to surface the reason a search result was returned.
 
 ```ruby
 # example in single search
@@ -359,7 +359,7 @@ For example:
       Search::User.from_active_record(self).update
     end
 
-    def remove_index_document
+    def delete_index_document
       Search::User.delete(self.id)
     end
   end
@@ -443,6 +443,20 @@ The default persistence strategy changed from SingleIndex to AliasIndex in versi
 5. Create a new Pull Request
 6. Sign the CLA if you haven't yet. See CONTRIBUTING.md
 
+## Gem documentation
+
+You can find the documentation by going to CircleCI, looking for the `build` job, going to Artifacts and clicking on `index.html`. A visual guide on this can be found in our wiki at [Gems Development: Where to find documentation for our gems](https://wiki.doximity.com/articles/gems-development-where-to-find-documentation-for-our-gems).
+
+## Gem development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+You can also run `bundle console` for an interactive prompt that will allow you to experiment.
+
+This repository uses a gem publishing mechanism on the CI configuration, meaning most work related with cutting a new
+version is done automatically.
+
+To release a new version, follow the [wiki instructions](https://wiki.doximity.com/articles/gems-development-releasing-new-versions).
+
 ## License
 
 MPN is licensed under an Apache 2 license. Contributors are required to sign an contributor license agreement. See LICENSE.txt and CONTRIBUTING.md for more information.

data/Rakefile

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new
+FileList["tasks/*.rake"].each { |task| load task }
+
+RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec

data/{elasticity.gemspec → es-elasticity.gemspec}

@@ -14,6 +14,9 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
+    spec.files = `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(bin|test|spec|vendor|tmp|coverage)/})
+    end
   # spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.executables   = []
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
@@ -28,8 +31,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "redis"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "rspec_junit_formatter"
 
   spec.add_dependency "activesupport", ">= 4.0.0", "< 6"
   spec.add_dependency "activemodel",   ">= 4.0.0", "< 6"
+  spec.add_dependency "activerecord",   ">= 4.0.0", "< 6"
   spec.add_dependency "elasticsearch", ">= 1.0"
 end

data/lib/elasticity.rb

@@ -17,6 +17,7 @@ require "bundler/setup"
 Bundler.setup
 
 require "active_support"
+require "arel"
 require "active_support/core_ext"
 require "active_model"
 require "elasticsearch"

data/lib/elasticity/index_config.rb

@@ -10,7 +10,7 @@ module Elasticity
     VERSION_FOR_SUBCLASS_ERROR = "7.0.0".freeze
     ATTRS = [
       :index_base_name, :document_type, :mapping, :strategy, :subclasses,
-      :settings
+      :settings, :use_new_timestamp_format, :include_type_name_on_create
     ].freeze
     VALIDATABLE_ATTRS = [:index_base_name, :document_type, :strategy].freeze
 
@@ -39,7 +39,8 @@ module Elasticity
     def definition
       return @definition if defined?(@definition)
       @definition = {
-        settings: merge_settings, mappings: { @document_type => @mapping.nil? ? {} : @mapping.deep_stringify_keys }
+        settings: merge_settings,
+        mappings: { @document_type => @mapping.nil? ? {} : @mapping.deep_stringify_keys }
       }
       subclasses.each do |doc_type, subclass|
         @definition[:mappings][doc_type] = subclass.constantize.mapping

data/lib/elasticity/index_mapper.rb

@@ -11,6 +11,7 @@ module Elasticity
         :index_exists?,
         :remap!,
         :flush_index,
+        :refresh_index,
         :index_document,
         :search,
         :get,
@@ -27,7 +28,7 @@ module Elasticity
     def initialize(document_klass, index_config)
       @document_klass = document_klass
       @index_config   = index_config
-      @strategy       = @index_config.strategy.new(@index_config.client, @index_config.fq_index_base_name, @index_config.document_type)
+      @strategy       = @index_config.strategy.new(@index_config.client, @index_config.fq_index_base_name, @index_config.document_type, @index_config.use_new_timestamp_format, @index_config.include_type_name_on_create)
     end
 
     delegate(
@@ -71,10 +72,16 @@ module Elasticity
     end
 
     # Flushes the index, forcing any writes
+    # note that v7 no longer forces any writes on flush
     def flush_index
       @strategy.flush
     end
 
+    # Resfreshes the index, forcing any writes
+    def refresh_index
+      @strategy.refresh
+    end
+
     # Index the given document
     def index_document(id, document_hash)
       @strategy.index_document(document_type, id, document_hash)

data/lib/elasticity/instrumented_client.rb

@@ -1,6 +1,6 @@
 module Elasticity
   class InstrumentedClient
-    INDICES_METHODS = %w(exists create delete get_settings get_mapping flush get_alias get_aliases put_alias delete_alias exists_alias update_aliases)
+    INDICES_METHODS = %w(exists create delete get_settings get_mapping flush refresh get_alias get_aliases put_alias delete_alias exists_alias update_aliases)
     INDEX_METHODS   = %w(index delete get mget search count msearch scroll delete_by_query bulk)
 
     def initialize(client)

data/lib/elasticity/search.rb

@@ -147,7 +147,12 @@ module Elasticity
       end
 
       def total
-        search["hits"]["total"]
+        res = search["hits"]["total"]
+        if res.is_a?(::Hash)
+          res["value"]
+        else
+          res
+        end
       end
 
       def each_batch
@@ -193,7 +198,7 @@ module Elasticity
         if ids.any?
           id_col  = "#{relation.connection.quote_column_name(relation.table_name)}.#{relation.connection.quote_column_name(relation.klass.primary_key)}"
           id_vals = ids.map { |id| relation.connection.quote(id) }
-          Relation.new(relation.where("#{id_col} IN (?)", ids).order("FIELD(#{id_col}, #{id_vals.join(',')})"), body, response)
+          Relation.new(relation.where("#{id_col} IN (?)", ids).order(Arel.sql("FIELD(#{id_col}, #{id_vals.join(',')})")), body, response)
         else
           Relation.new(relation.none, body, response)
         end
@@ -237,7 +242,12 @@ module Elasticity
       end
 
       def total
-        metadata[:total]
+        res = metadata[:total]
+        if res.is_a?(::Hash)
+          res["value"]
+        else
+          res
+        end
       end
 
       def suggestions
@@ -311,7 +321,12 @@ module Elasticity
       end
 
       def total
-        @response["hits"]["total"]
+        res = @response["hits"]["total"]
+        if res.is_a?(::Hash)
+          res["value"]
+        else
+          res
+        end
       end
       alias_method :total_entries, :total
 

data/lib/elasticity/strategies/alias_index.rb

@@ -11,11 +11,15 @@ module Elasticity
 
       STATUSES = [:missing, :ok]
 
-      def initialize(client, index_base_name, document_type)
+      def initialize(client, index_base_name, document_type, use_new_timestamp_format = false, include_type_name_on_create = true)
         @client       = client
         @main_alias   = index_base_name
         @update_alias = "#{index_base_name}_update"
         @document_type = document_type
+
+        # included for compatibility with v7
+        @use_new_timestamp_format = use_new_timestamp_format
+        @include_type_name_on_create = include_type_name_on_create
       end
 
       def ref_index_name
@@ -186,11 +190,12 @@ module Elasticity
 
       def create(index_def)
         if missing?
-          index_name = create_index(index_def)
+          name = create_index(index_def)
+          @created_index_name = name
           @client.index_update_aliases(body: {
             actions: [
-              { add: { index: index_name, alias: @main_alias } },
-              { add: { index: index_name, alias: @update_alias } },
+              { add: { index: name, alias: @main_alias } },
+              { add: { index: name, alias: @update_alias } },
             ]
           })
         else
@@ -257,6 +262,10 @@ module Elasticity
         @client.index_flush(index: @update_alias)
       end
 
+      def refresh
+        @client.index_refresh(index: @update_alias)
+      end
+
       def settings
         @client.index_get_settings(index: @main_alias, type: @document_type).values.first
       rescue Elasticsearch::Transport::Transport::Errors::NotFound
@@ -279,11 +288,20 @@ module Elasticity
 
       private
 
+      def build_index_name
+        ts = String.new
+        if @use_new_timestamp_format == true
+          ts = Time.now.utc.strftime("%Y%m%d%H%M%S%6N")
+        else
+          ts = Time.now.utc.strftime("%Y-%m-%d_%H:%M:%S.%6N")
+        end
+        "#{@main_alias}-#{ts}"
+      end
+
       def create_index(index_def)
-        ts = Time.now.utc.strftime("%Y-%m-%d_%H:%M:%S.%6N")
-        index_name = "#{@main_alias}-#{ts}"
-        @client.index_create(index: index_name, body: index_def)
-        index_name
+        name = build_index_name
+        @client.index_create(index: name, body: index_def, include_type_name: @include_type_name_on_create)
+        name
       end
 
       def retryable_error?(e)

data/lib/elasticity/strategies/single_index.rb

@@ -3,10 +3,16 @@ module Elasticity
     class SingleIndex
       STATUSES = [:missing, :ok]
 
-      def initialize(client, index_name, document_type)
+      def initialize(client, index_name, document_type, use_new_timestamp_format = false, include_type_name_on_create = true)
         @client        = client
         @index_name    = index_name
         @document_type = document_type
+
+        # included for compatibility with v7
+        @include_type_name_on_create = include_type_name_on_create
+
+        # not currently used. included for argument compatiblity with AliasStrategy
+        @use_new_timestamp_format = use_new_timestamp_format
       end
 
       def ref_index_name
@@ -23,7 +29,7 @@ module Elasticity
 
       def create(index_def)
         if missing?
-          @client.index_create(index: @index_name, body: index_def)
+          @client.index_create(index: @index_name, body: index_def, include_type_name: @include_type_name_on_create)
         else
           raise IndexError.new(@index_name, "index already exist")
         end
@@ -101,6 +107,10 @@ module Elasticity
       def flush
         @client.index_flush(index: @index_name)
       end
+
+      def refresh
+        @client.index_refresh(index: @index_name)
+      end
     end
   end
 end

data/lib/elasticity/version.rb

@@ -1,3 +1,3 @@
 module Elasticity
-  VERSION = "0.12.0"
+  VERSION = "0.13.3.pre1"
 end

data/tasks/ci.rake

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+namespace :ci do
+  desc "Run specs"
+  task :specs do
+    reports = "tmp/test-results/rspec"
+    sh "mkdir -p #{reports}"
+    sh "bundle exec rspec ./spec " \
+      "--format progress "\
+      "-o #{reports}/results.xml"
+  end
+end

data/tasks/rdoc.rake

@@ -0,0 +1,14 @@
+# frozeon_string_literal: true
+
+require "rdoc/task"
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.md"
+  rdoc.markup = "tomdoc"
+  rdoc.options << "--github --encoding=UTF-8"
+  rdoc.rdoc_dir = "doc"
+  rdoc.rdoc_files.exclude("vendor", "tmp")
+  rdoc.rdoc_files.include("README.md", "lib", "*.rb")
+  rdoc.template = "rails"
+  rdoc.title = "Documentation"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: es-elasticity
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.3.pre1
 platform: ruby
 authors:
 - Rodrigo Kochenburger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-31 00:00:00.000000000 Z
+date: 2020-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,6 +136,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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_junit_formatter
+  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: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -176,6 +204,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: elasticsearch
   requirement: !ruby/object:Gem::Requirement
@@ -198,20 +246,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".simplecov"
-- ".travis.yml"
-- CHANGELOG
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/rake
-- bin/rspec
-- elasticity.gemspec
-- es-elasticity-0.12.0.pre.rc1.gem
+- es-elasticity.gemspec
 - lib/elasticity.rb
 - lib/elasticity/base_document.rb
 - lib/elasticity/bulk.rb
@@ -231,17 +278,8 @@ files:
 - lib/elasticity/strategies/alias_index.rb
 - lib/elasticity/strategies/single_index.rb
 - lib/elasticity/version.rb
-- spec/functional/persistence_spec.rb
-- spec/functional/search_spec.rb
-- spec/functional/segmented_spec.rb
-- spec/rspec_config.rb
-- spec/units/document_spec.rb
-- spec/units/index_config_spec.rb
-- spec/units/index_mapper_spec.rb
-- spec/units/multi_search_response_parser_spec.rb
-- spec/units/multi_search_spec.rb
-- spec/units/search_spec.rb
-- spec/units/strategies/single_index_spec.rb
+- tasks/ci.rake
+- tasks/rdoc.rake
 homepage: ''
 licenses:
 - MIT
@@ -257,24 +295,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: ActiveModel-based library for working with Elasticsearch
-test_files:
-- spec/functional/persistence_spec.rb
-- spec/functional/search_spec.rb
-- spec/functional/segmented_spec.rb
-- spec/rspec_config.rb
-- spec/units/document_spec.rb
-- spec/units/index_config_spec.rb
-- spec/units/index_mapper_spec.rb
-- spec/units/multi_search_response_parser_spec.rb
-- spec/units/multi_search_spec.rb
-- spec/units/search_spec.rb
-- spec/units/strategies/single_index_spec.rb
+test_files: []