zelastic 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f54a69201807f3ba79aa72f7ea5b51c1adfebcdc06d4b51f4662f49c96bc0c7
-  data.tar.gz: '0480ef88c0c3f3f170c18712d2e9208b4fbcd0f7614abbb9cb9b89d2636443be'
+  metadata.gz: 82591810835538bb7b3ede975d3731fc2b3300dfa9934f72f81ed323458c8145
+  data.tar.gz: c7631b4cb764dbfffdf4efd35296b9b9c5d5ce790c03464c7ba584ad060cae47
 SHA512:
-  metadata.gz: 4ba1d3c04f92728c3a414a3b09551117c664eeb3e1ec9e4f395bb393b33cc8de55bb4239da17fd98be0a8171f3ae038a769f3a2b93147abf42fcac8a13ab0254
-  data.tar.gz: 954fe26c4ed02e57e00ae29c82f26b1eba33f6c637e520db7610a220a851b9d158f4052a9323c506804247b8f527115ce808401cb42c1a893ab93d64f9025a34
+  metadata.gz: 43647ec72340be7b8a4121eb7190d74844ad3284f38457dbe6948ddd81d4ed46fe9c2c7b9b8ae057db07b506efb5c2e7393f5eba43e209ecbf49dd58ec22b70c
+  data.tar.gz: 1b834cba1e6bffd46e108528b3d0eac68ca3766b86c5a28741db3c838b71d9c509cd1e42ac6dd82ff5f9ed7fc99a7cf1534507fc48b3fd1b388980ebbf0b33cd

data/.circleci/config.yml

@@ -1,88 +1,47 @@
-references:
-  ruby: &ruby
-    image: carwow/ruby-ci:2.6
-    environment:
-      ELASTICSEARCH_URL: http://localhost:9200
-
-  elasticsearch_container: &elasticsearch_container
-    image: carwow/elasticsearch-ci:5.5.1
+version: 2.1
 
-  elasticsearch_7_container: &elasticsearch_7_container
-    image: carwow/elasticsearch-ci:7.6.1
-
-version: 2
 jobs:
-  bundle:
-    working_directory: ~/zelastic
-    docker:
-      - *ruby
-    steps:
-      - checkout
-      - restore_cache:
-          keys:
-            - bundle-{{ checksum "Gemfile.lock" }}
-            - bundle-
-      - run: |
-          bundle config --local path vendor/bundle &&
-          bundle check || bundle install --jobs=4 --retry=3
-          bundle clean --force
-      - save_cache:
-          key: bundle-{{ checksum "Gemfile.lock" }}
-          paths: [vendor/bundle]
-
-  rubocop:
-    working_directory: ~/zelastic
-    docker:
-      - *ruby
-    steps:
-      - checkout
-      - restore_cache: { keys: ['bundle-{{ checksum "Gemfile.lock" }}'] }
-      - run: bundle exec rubocop
-
-  tests:
-    working_directory: ~/zelastic
-    docker:
-      - *ruby
-      - *elasticsearch_container
-    steps:
-      - checkout
-      - restore_cache: { keys: ['bundle-{{ checksum "Gemfile.lock" }}'] }
-      - run:
-          name: Wait for ES to be ready
-          command: |
-            until curl $ELASTICSEARCH_URL/_cat/health | egrep '(green|yellow)' 2>&1 > /dev/null; do
-              echo -n .
-              sleep 1
-            done
-      - run: |
-          bundle exec rspec --pattern "**/*_spec.rb" --format "progress"
-
-  tests_7:
-    working_directory: ~/zelastic
+  test:
+    parameters:
+      ruby_version:
+        type: string
+      elasticsearch_version:
+        type: string
+      elasticsearch_gem_version:
+        type: string
     docker:
-      - *ruby
-      - *elasticsearch_7_container
+      - image: "cimg/ruby:<< parameters.ruby_version >>"
+      - image: "elasticsearch:<< parameters.elasticsearch_version >>"
+        environment:
+          "discovery.type": single-node
+    environment:
+      ELASTICSEARCH_GEM_VERSION: "<< parameters.elasticsearch_gem_version >>"
     steps:
       - checkout
-      - restore_cache: { keys: ['bundle-{{ checksum "Gemfile.lock" }}'] }
-      - run:
-          name: Wait for ES to be ready
-          command: |
-            until curl $ELASTICSEARCH_URL/_cat/health | egrep '(green|yellow)' 2>&1 > /dev/null; do
-              echo -n .
-              sleep 1
-            done
-      - run: |
-          bundle exec rspec --pattern "**/*_spec.rb" --format "progress"
+      - run: bin/setup
+      - run: bin/rubocop
+      - run: dockerize -wait http://localhost:9200 -timeout 1m
+      - run: bin/rspec
 
 workflows:
   version: 2
-  build:
+  test:
     jobs:
-      - bundle
-      - rubocop:
-          requires: [bundle]
-      - tests:
-          requires: [bundle]
-      - tests_7:
-          requires: [bundle]
+      - test:
+          name: "test with elasticsearch v7
+            and gem << matrix.elasticsearch_gem_version >>
+            and ruby v<< matrix.ruby_version >>"
+          elasticsearch_version: "7.17.5"
+          matrix:
+            parameters:
+              ruby_version: ["3.1", "2.7"]
+              elasticsearch_gem_version: ["~> 7", "~> 5"]
+      - test:
+          name: "test with elasticsearch v5
+            and gem ~> 5
+            and ruby v<< matrix.ruby_version >>"
+          elasticsearch_version: "5.6-alpine"
+          elasticsearch_gem_version: "~> 5"
+          matrix:
+            parameters:
+              ruby_version: ["3.1", "2.7"]

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -1,24 +1,10 @@
-inherit_from: .rubocop_todo.yml
+inherit_gem:
+  carwow_rubocop:
+    - config/default.yml
 
-AllCops:
-  TargetRubyVersion: 2.4
+inherit_mode:
+  merge:
+    - Exclude
 
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/BlockLength:
-  Exclude:
-    - '*.gemspec'
-    - 'spec/**/*'
-
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 18
-
-# Offense count: 2
-Style/Documentation:
-  Exclude:
-    - '**/*'
-
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 100
+Metrics:
+  Enabled: false

data/Gemfile

@@ -3,3 +3,5 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'elasticsearch', ENV['ELASTICSEARCH_GEM_VERSION'] if ENV['ELASTICSEARCH_GEM_VERSION']

data/bin/rspec

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

data/lib/zelastic/config.rb

@@ -42,7 +42,7 @@ module Zelastic
     def logger
       return Rails.logger if defined?(Rails)
 
-      @logger ||= Logger.new(STDOUT)
+      @logger ||= Logger.new($stdout)
     end
 
     def index_definition

data/lib/zelastic/index_manager.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 module Zelastic
-  # rubocop:disable Metrics/AbcSize
-  class IndexManager # rubocop:disable Metrics/ClassLength
+  class IndexManager
     extend Forwardable
 
     def initialize(config, client: nil)
@@ -37,12 +36,14 @@ module Zelastic
       remove_action =
         ({ remove: { index: old_index, alias: config.read_alias } } if old_index)
 
-      client.indices.update_aliases(body: {
-                                      actions: [
-                                        remove_action,
-                                        { add: { index: new_index, alias: config.read_alias } }
-                                      ].compact
-                                    })
+      client.indices.update_aliases(
+        body: {
+          actions: [
+            remove_action,
+            { add: { index: new_index, alias: config.read_alias } }
+          ].compact
+        }
+      )
     end
 
     def stop_dual_writes
@@ -52,14 +53,15 @@ module Zelastic
       logger.info("Currently used index is #{current_index}")
 
       other_write_indices = client.indices.get_alias(name: config.write_alias).keys
-                                  .reject { |name| name == current_index }
+        .reject { |name| name == current_index }
 
       if other_write_indices.none?
         logger.info("No write indexes that aren't the read index. Nothing to do!")
         return
       end
       logger.info("Stopping writes to #{other_write_indices.count} old ES indices: " \
-                        "#{other_write_indices.join(', ')}")
+                  "#{other_write_indices.join(', ')}"
+                 )
 
       actions = other_write_indices.map do |index|
         { remove: { index: index, alias: config.write_alias } }
@@ -74,11 +76,11 @@ module Zelastic
       logger.info("Currently used index is #{current_index}")
 
       indices_to_delete = client
-                          .cat
-                          .indices(format: :json)
-                          .map { |index| index['index'] }
-                          .select { |name| name.start_with?(config.read_alias) }
-                          .reject { |name| name == current_index }
+        .cat
+        .indices(format: :json)
+        .map { |index| index['index'] }
+        .select { |name| name.start_with?(config.read_alias) }
+        .reject { |name| name == current_index }
 
       if indices_to_delete.none?
         logger.info('Nothing to do: no old indices')
@@ -93,6 +95,7 @@ module Zelastic
     private
 
     attr_reader :config, :client
+
     def_delegators :config, :logger
 
     def indexer
@@ -135,5 +138,4 @@ module Zelastic
       client.indices.exists?(index: config.read_alias)
     end
   end
-  # rubocop:enable Metrics/AbcSize
 end

data/lib/zelastic/indexer.rb

@@ -62,12 +62,13 @@ module Zelastic
     private
 
     attr_reader :config
+
     def_delegators :config, :logger
 
     def current_version
       config.data_source.connection
-            .select_one('SELECT txid_snapshot_xmax(txid_current_snapshot()) as xmax')
-            .fetch('xmax')
+        .select_one('SELECT txid_snapshot_xmax(txid_current_snapshot()) as xmax')
+        .fetch('xmax')
     end
 
     def write_indices(client)
@@ -91,13 +92,13 @@ module Zelastic
       }
     end
 
-    def execute_bulk(client: nil, index_name: nil, refresh: false)
+    def execute_bulk(client: nil, index_name: nil, refresh: false, &block)
       clients = Array(client || config.clients)
 
       clients.map do |current_client|
         indices = Array(index_name || write_indices(current_client))
 
-        commands = indices.flat_map { |index| yield(index) }
+        commands = indices.flat_map(&block)
 
         current_client.bulk(body: commands, refresh: refresh).tap do |result|
           check_errors!(result)
@@ -109,11 +110,10 @@ module Zelastic
       return false unless result['errors']
 
       errors = result['items']
-               .map { |item| item['error'] || item.fetch('index', {})['error'] }
-               .compact
+        .filter_map { |item| item['error'] || item.fetch('index', {})['error'] }
 
       ignorable_errors, important_errors = errors
-                                           .partition { |error| ignorable_error?(error) }
+        .partition { |error| ignorable_error?(error) }
 
       logger.warn("Ignoring #{ignorable_errors.count} version conflicts") if ignorable_errors.any?
 

data/lib/zelastic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Zelastic
-  VERSION = '0.6.2'
+  VERSION = '0.7.0'
 end

data/zelastic.gemspec

@@ -25,10 +25,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport'
 
   spec.add_development_dependency 'activerecord'
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'carwow_rubocop'
-  spec.add_development_dependency 'elasticsearch'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'bundler', '~> 2'
+  spec.add_development_dependency 'carwow_rubocop', '~> 4'
+  spec.add_development_dependency 'elasticsearch', '>= 5', '< 8'
+  spec.add_development_dependency 'pry', '~> 0.14'
+  spec.add_development_dependency 'rake', '~> 13'
+  spec.add_development_dependency 'rspec', '~> 3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zelastic
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - carwow Developers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2022-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -42,86 +42,92 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: carwow_rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: elasticsearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 description: An index manager for Elasticsearch and ActiveRecord
 email:
 - developers@carwow.co.uk
@@ -134,14 +140,14 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/rspec
+- bin/rubocop
 - bin/setup
 - lib/zelastic.rb
 - lib/zelastic/config.rb
@@ -168,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: Zero-downtime (re-)indexing of ActiveRecord models into Elasticsearch.

data/.rubocop_todo.yml

@@ -1,32 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2018-05-27 17:11:31 +0100 using RuboCop version 0.52.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-Lint/ShadowingOuterLocalVariable:
-  Exclude:
-    - 'lib/zelastic/indexer.rb'
-
-# Offense count: 1
-Metrics/AbcSize:
-  Max: 17
-
-# Offense count: 1
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/BlockLength:
-  Max: 83
-
-# Offense count: 4
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 146
-
-# Offense count: 1
-Naming/AccessorMethodName:
-  Exclude:
-    - 'spec/zelastic/indexer_spec.rb'

data/Gemfile.lock

@@ -1,107 +0,0 @@
-PATH
-  remote: .
-  specs:
-    zelastic (0.6.2)
-      activesupport
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (6.1.3)
-      activesupport (= 6.1.3)
-    activerecord (6.1.3)
-      activemodel (= 6.1.3)
-      activesupport (= 6.1.3)
-    activesupport (6.1.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    ast (2.4.1)
-    carwow_rubocop (3.3.0)
-      rubocop (>= 0.78)
-      rubocop-performance
-      rubocop-rspec
-    coderay (1.1.3)
-    concurrent-ruby (1.1.8)
-    diff-lcs (1.4.4)
-    elasticsearch (7.11.2)
-      elasticsearch-api (= 7.11.2)
-      elasticsearch-transport (= 7.11.2)
-    elasticsearch-api (7.11.2)
-      multi_json
-    elasticsearch-transport (7.11.2)
-      faraday (~> 1)
-      multi_json
-    faraday (1.3.0)
-      faraday-net_http (~> 1.0)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords
-    faraday-net_http (1.0.1)
-    i18n (1.8.9)
-      concurrent-ruby (~> 1.0)
-    method_source (1.0.0)
-    minitest (5.14.3)
-    multi_json (1.15.0)
-    multipart-post (2.1.1)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
-    pry (0.14.0)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (1.7.1)
-    rexml (3.2.4)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
-    rubocop (0.85.1)
-      parallel (~> 1.10)
-      parser (>= 2.7.0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
-      rexml
-      rubocop-ast (>= 0.0.3)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
-    rubocop-performance (1.6.1)
-      rubocop (>= 0.71.0)
-    rubocop-rspec (1.40.0)
-      rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    ruby2_keywords (0.0.4)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (1.7.0)
-    zeitwerk (2.4.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord
-  bundler
-  carwow_rubocop
-  elasticsearch
-  pry
-  rake
-  rspec
-  zelastic!
-
-BUNDLED WITH
-   2.1.4