rom-elasticsearch 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d16fc720d3b0bbdbb8c31b3e44a301b663eb0cac2ba00b7949414b38576c26a
-  data.tar.gz: b86bb549184a72684d21578805ea393a87e6f0d1e665f0a82b8ccd6831065a2a
+  metadata.gz: c2706a7a8a9fcde89b7ad2a6965594a1891c39fb27a9faade8273793499a920c
+  data.tar.gz: 6710ed9229b728d2db9b391b759f7236bad238ede805469098bf46d72c9f1e88
 SHA512:
-  metadata.gz: 4da96f9e4092383134b09d7b81e5c972f99463e13f4a1fd9430a74c64e9a1b2b292b8e9e7060ce0ca46e963be59942d992bac2a0815651316bcd93c81ee75e02
-  data.tar.gz: e1e82ac281fcecbce51a7c00fc08ba39c0a52cdd33a1d4f4e829e988621b17471bd63cc565e04f9f823f1cf8a024c0d93997fd3847ca336b72836ff7f32cadd2
+  metadata.gz: fd2e9eb744108d4a89ca01631b8a228e46bdde76d40b4ca507eb225085e93aa78414e2e350fff512929df569a5da0b56584c28f70980cbf9180ed3db36bae114
+  data.tar.gz: 8f6ae092b5ec62eb5550d78e9b0b844f20c135c8adc95ff9528189e63a16741c4953974a21dcf9418f75cb863c4a784de3fee78984d2cff6fcad21e2ce0b8b4a

data/CHANGELOG.md

@@ -1,4 +1,16 @@
-# v0.4.0 2019-04-28
+<!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
+
+## 0.5.0 2021-06-05
+
+
+### Changed
+
+- Upgrade to elasticsearch ~> 7.13 (via #25) (@demsullivan + @solnic)
+
+[Compare v0.4.0...v0.5.0](https://github.com/rom-rb/rom-elasticsearch/compare/v0.4.0...v0.5.0)
+
+## 0.4.0 2019-04-28
+
 
 ### Added
 
@@ -11,24 +23,29 @@
 
 [Compare v0.3.0...v0.4.0](https://github.com/rom-rb/rom-elasticsearch/compare/v0.3.0...v0.4.0)
 
-# v0.3.0 2018-03-12
+## 0.3.0 2018-03-12
+
 
 ### Added
 
 - Support for multi-index relations via `schema(multi: true)` (solnic)
 - Datasets can be configured to include `_metadata` in resulting tuples (solnic)
 
+
 [Compare v0.2.1...v0.3.0](https://github.com/rom-rb/rom-elasticsearch/compare/v0.2.1...v0.3.0)
 
-# v0.2.1 2018-02-06
+## 0.2.1 2018-02-06
+
 
 ### Fixed
 
 - Using `read` types in schemas no longer breaks indexing (solnic)
 
+
 [Compare v0.2.0...v0.2.1](https://github.com/rom-rb/rom-elasticsearch/compare/v0.2.0...v0.2.1)
 
-# v0.2.0 2018-01-23
+## 0.2.0 2018-01-23
+
 
 ### Added
 
@@ -37,14 +54,18 @@
 - `Relation#per_page` which sets `:size` (solnic)
 - `Relation#call` returns custom `ROM::Elasticsearch::Relation::Loaded` object, which provides access to `#total_hits` and raw client response (solnic)
 
+
 [Compare v0.1.1...v0.2.0](https://github.com/rom-rb/rom-elasticsearch/compare/v0.1.1...v0.2.0)
 
-# v0.1.1 2017-11-18
+## 0.1.1 2017-11-18
+
 
 ### Changed
 
 - Connection URI is passed directly to the ES client now (solnic)
 
-# v0.1.0 2017-11-17
+[Compare v0.1.0...v0.1.1](https://github.com/rom-rb/rom-elasticsearch/compare/v0.1.0...v0.1.1)
+
+## 0.1.0 2017-11-17
 
 First public release

data/README.md

@@ -1,39 +1,28 @@
 [gem]: https://rubygems.org/gems/rom-elasticsearch
-[travis]: https://travis-ci.org/rom-rb/rom-elasticsearch
-[codeclimate]: https://codeclimate.com/github/rom-rb/rom-elasticsearch
-[inchpages]: http://inch-ci.org/github/rom-rb/rom-elasticsearch
+[actions]: https://github.com/rom-rb/rom-elasticsearch/actions
+[codacy]: https://www.codacy.com/gh/rom-rb/rom-elasticsearch
 [chat]: https://rom-rb.zulipchat.com
+[inchpages]: http://inch-ci.org/github/rom-rb/rom-elasticsearch
 
-# rom-elasticsearch [![Join the chat at https://rom-rb.zulipchat.com](https://img.shields.io/badge/rom--rb-join%20chat-942283.svg)][chat]
+# rom-elasticsearch [![Join the chat at https://rom-rb.zulipchat.com](https://img.shields.io/badge/rom--rb-join%20chat-%23346b7a.svg)][chat]
 
 [![Gem Version](https://badge.fury.io/rb/rom-elasticsearch.svg)][gem]
-[![Build Status](https://travis-ci.org/rom-rb/rom-elasticsearch.svg?branch=master)][travis]
-[![Code Climate](https://codeclimate.com/github/rom-rb/rom-elasticsearch/badges/gpa.svg)][codeclimate]
-[![Test Coverage](https://codeclimate.com/github/rom-rb/rom-elasticsearch/badges/coverage.svg)][codeclimate]
+[![CI Status](https://github.com/rom-rb/rom-elasticsearch/workflows/ci/badge.svg)][actions]
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/9882fd022f904b48b5359b799b59ae88)][codacy]
+[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/9882fd022f904b48b5359b799b59ae88)][codacy]
 [![Inline docs](http://inch-ci.org/github/rom-rb/rom-elasticsearch.svg?branch=master)][inchpages]
 
-Elasticsearch support for [rom-rb](https://github.com/rom-rb/rom).
-
-Resources:
-
-- [User Documentation](http://rom-rb.org/learn/elasticsearch/)
-- [API Documentation](http://rubydoc.info/gems/rom-elasticsearch)
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'rom-elasticsearch'
-```
+## Links
 
-And then execute:
+* [User documentation](http://rom-rb.org/learn/elasticsearch)
+* [API documentation](http://rubydoc.info/gems/rom-elasticsearch)
 
-    $ bundle
+## Supported Ruby versions
 
-Or install it yourself as:
+This library officially supports the following Ruby versions:
 
-    $ gem install rom-elasticsearch
+* MRI >= `2.5`
+* jruby >= `9.2`
 
 ## License
 

data/lib/rom-elasticsearch.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require 'rom/elasticsearch'
+require "rom/elasticsearch"

data/lib/rom/elasticsearch.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'rom/core'
+require "rom/core"
 
-require 'rom/elasticsearch/version'
-require 'rom/elasticsearch/gateway'
-require 'rom/elasticsearch/relation'
-require 'rom/elasticsearch/commands'
+require "rom/elasticsearch/version"
+require "rom/elasticsearch/gateway"
+require "rom/elasticsearch/relation"
+require "rom/elasticsearch/commands"
 
 ROM.register_adapter(:elasticsearch, ROM::Elasticsearch)

data/lib/rom/elasticsearch/attribute.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rom/attribute'
+require "rom/attribute"
 
 module ROM
   module Elasticsearch
@@ -9,7 +9,7 @@ module ROM
     # @api public
     class Attribute < ROM::Attribute
       INTERNAL_META_KEYS = %i[name source primary_key read].freeze
-      DEFAULT_SORT_DIRECTION = 'asc'.freeze
+      DEFAULT_SORT_DIRECTION = "asc"
 
       # Return ES mapping properties
       #
@@ -26,7 +26,7 @@ module ROM
       #
       # @api public
       def properties?
-        properties.size > 0
+        properties.size.positive?
       end
 
       # Return attribute with direction set to ascending
@@ -35,7 +35,7 @@ module ROM
       #
       # @api public
       def asc
-        meta(direction: 'asc')
+        meta(direction: "asc")
       end
 
       # Return attribute with direction set to descending
@@ -44,7 +44,7 @@ module ROM
       #
       # @api public
       def desc
-        meta(direction: 'desc')
+        meta(direction: "desc")
       end
 
       # @api private

data/lib/rom/elasticsearch/commands.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rom/commands'
+require "rom/commands"
 
 module ROM
   module Elasticsearch
@@ -22,7 +22,7 @@ module ROM
             else
               dataset.put(tuple)
             end
-          [relation.get(result['_id']).one]
+          [relation.get(result["_id"]).one]
         end
 
         private

data/lib/rom/elasticsearch/dataset.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'rom/initializer'
+require "rom/initializer"
 
-require 'rom/elasticsearch/query_methods'
-require 'rom/elasticsearch/scroll_methods'
-require 'rom/elasticsearch/errors'
+require "rom/elasticsearch/query_methods"
+require "rom/elasticsearch/scroll_methods"
+require "rom/elasticsearch/errors"
 
 module ROM
   module Elasticsearch
@@ -25,13 +25,13 @@ module ROM
       include ScrollMethods
 
       # Sort values separator
-      SORT_VALUES_SEPARATOR = ','.freeze
+      SORT_VALUES_SEPARATOR = ","
 
       # Default query options
-      ALL = { query: { match_all: EMPTY_HASH } }.freeze
+      ALL = {query: {match_all: EMPTY_HASH}}.freeze
 
       # The source key in raw results
-      SOURCE_KEY = '_source'.freeze
+      SOURCE_KEY = "_source"
 
       # @!attribute [r] client
       #   @return [::Elasticsearch::Client] configured client from the gateway
@@ -65,7 +65,7 @@ module ROM
       TUPLE_PROC_WITH_METADATA = -> t { TUPLE_PROC[t].merge(_metadata: t) }
 
       # @api private
-      def initialize(*args)
+      def initialize(*args, **kwargs)
         super
         @tuple_proc = options[:include_metadata] ? TUPLE_PROC_WITH_METADATA : TUPLE_PROC
       end
@@ -87,7 +87,7 @@ module ROM
       #
       # @api public
       def settings
-        client.indices.get_settings[index.to_s]['settings']['index']
+        client.indices.get_settings[index.to_s]["settings"]["index"]
       end
 
       # Return index mappings
@@ -96,7 +96,7 @@ module ROM
       #
       # @api public
       def mappings
-        client.indices.get_mapping[index.to_s]['mappings'][type.to_s]
+        client.indices.get_mapping[index.to_s]["mappings"]
       end
 
       # Delete everything matching configured params and/or body
@@ -134,6 +134,7 @@ module ROM
       # @api public
       def each
         return to_enum unless block_given?
+
         view.each { |result| yield(tuple_proc[result]) }
       rescue ::Elasticsearch::Transport::Transport::Error => e
         raise SearchError.new(e, options)
@@ -283,7 +284,7 @@ module ROM
         elsif params[:scroll]
           scroll_enumerator(client, response)
         else
-          response.fetch('hits').fetch('hits')
+          response.fetch("hits").fetch("hits")
         end
       end
 

data/lib/rom/elasticsearch/gateway.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'elasticsearch'
-require 'uri'
+require "elasticsearch"
+require "uri"
 
-require 'rom/gateway'
-require 'rom/support/inflector'
-require 'rom/elasticsearch/dataset'
-require 'rom/elasticsearch/index_name'
+require "rom/gateway"
+require "rom/support/inflector"
+require "rom/elasticsearch/dataset"
+require "rom/elasticsearch/index_name"
 
 module ROM
   module Elasticsearch
@@ -38,8 +38,14 @@ module ROM
     #
     #   posts.like('Hello').first
     #
+    # @example using an existing client
+    #   client = Elasticsearch::Client.new('http://localhost:9200')
+    #   conf = ROM::Configuration.new(:elasticsearch, client: client)
+    #
     # @api public
     class Gateway < ROM::Gateway
+      extend ROM::Initializer
+
       adapter :elasticsearch
 
       # @!attribute [r] url
@@ -50,11 +56,9 @@ module ROM
       #   @return [::Elasticsearch::Client] configured ES client
       attr_reader :client
 
-      # @api private
-      def initialize(uri, log: false)
-        @url = URI.parse(uri)
-        @client = ::Elasticsearch::Client.new(url: url, log: log)
-      end
+      param :uri, default: proc {}
+      option :client, default: -> { ::Elasticsearch::Client.new(url: uri, log: log) }
+      option :log, default: -> { false }
 
       # Return true if a dataset with the given :index exists
       #
@@ -77,7 +81,7 @@ module ROM
       # @api public
       def dataset(index)
         idx_name = IndexName[index]
-        Dataset.new(client, params: { index: idx_name.to_sym, type: idx_name.type })
+        Dataset.new(client, params: {index: idx_name.to_sym})
       end
       alias_method :[], :dataset
     end

data/lib/rom/elasticsearch/index_name.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rom/support/inflector'
+require "rom/support/inflector"
 
 module ROM
   module Elasticsearch
@@ -9,34 +9,24 @@ module ROM
       # @api private
       attr_reader :name
 
-      # @api private
-      attr_reader :types
-
-      def self.[](name, types = nil)
+      def self.[](name)
         if name.is_a?(self)
           name
         else
-          new(name, types)
+          new(name)
         end
       end
 
       # @api private
-      def initialize(name, types = nil)
+      def initialize(name)
         @name = name
-        @types = types
         freeze
       end
 
-      # @api private
-      def type
-        types ? Array(types).join(',') : Inflector.singularize(name).to_sym
-      end
-
       # @api private
       def to_sym
         name
       end
     end
-
   end
 end

data/lib/rom/elasticsearch/plugins/relation/query_dsl.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rom/global'
-require 'elasticsearch/dsl'
+require "rom/global"
+require "elasticsearch/dsl"
 
 module ROM
   module Elasticsearch

data/lib/rom/elasticsearch/query_methods.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rom/elasticsearch/errors'
+require "rom/elasticsearch/errors"
 
 module ROM
   module Elasticsearch
@@ -46,7 +46,7 @@ module ROM
       #
       # @api public
       def query_string(expression)
-        query(query_string: { query: expression })
+        query(query_string: {query: expression})
       end
 
       # Return a new dataset configured to search via :query body option

data/lib/rom/elasticsearch/relation.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'rom/relation'
+require "rom/relation"
 
-require 'rom/elasticsearch/index_name'
-require 'rom/elasticsearch/relation/loaded'
-require 'rom/elasticsearch/types'
-require 'rom/elasticsearch/schema'
-require 'rom/elasticsearch/attribute'
+require "rom/elasticsearch/index_name"
+require "rom/elasticsearch/relation/loaded"
+require "rom/elasticsearch/types"
+require "rom/elasticsearch/schema"
+require "rom/elasticsearch/attribute"
 
 module ROM
   module Elasticsearch
@@ -130,17 +130,17 @@ module ROM
 
       # Default index settings that can be overridden
       index_settings(
-        { number_of_shards: 1,
-          index: {
-            analysis: {
-              analyzer: {
-                standard_stopwords: {
-                  type: "standard",
-                  stopwords: "_english_"
-                }
-              }
-            }
-          } }.freeze
+        {number_of_shards: 1,
+         index: {
+           analysis: {
+             analyzer: {
+               standard_stopwords: {
+                 type: "standard",
+                 stopwords: "_english_"
+               }
+             }
+           }
+         }}.freeze
       )
 
       # Define a schema for the relation
@@ -148,7 +148,7 @@ module ROM
       # @return [self]
       def self.schema(dataset = nil, multi: false, **opts, &block)
         if multi
-          super(IndexName[:_all, multi_index_types], **opts, &block)
+          super(IndexName[:_all], **opts, &block)
         else
           super(dataset, **opts, &block)
         end
@@ -339,9 +339,8 @@ module ROM
       def count
         dataset.client.count(
           index: dataset.index,
-          type: dataset.type,
           body: dataset.body
-        )['count']
+        )["count"]
       end
 
       # Restrict relation data by offset
@@ -378,10 +377,11 @@ module ROM
       #
       # @api private
       def index_params
-        { index: name.dataset.to_sym,
-          body: {
-            settings: self.class.index_settings,
-            mappings: { dataset.type => { properties: schema.to_properties } } } }
+        {index: name.dataset.to_sym,
+         body: {
+           settings: self.class.index_settings,
+           mappings: {properties: schema.to_properties}
+         }}
       end
     end
   end

data/lib/rom/elasticsearch/relation/loaded.rb

@@ -13,7 +13,7 @@ module ROM
         #
         # @api public
         def total_hits
-          response['hits']['total']
+          response["hits"]["total"]["value"]
         end
 
         # Return raw response from the ES client

data/lib/rom/elasticsearch/schema.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rom/types'
-require 'rom/schema'
+require "rom/types"
+require "rom/schema"
 
 module ROM
   module Elasticsearch

data/lib/rom/elasticsearch/scroll_methods.rb

@@ -23,13 +23,13 @@ module ROM
       def scroll_enumerator(client, response)
         Enumerator.new do |yielder|
           loop do
-            hits = response.fetch('hits').fetch('hits')
+            hits = response.fetch("hits").fetch("hits")
             break if hits.empty?
 
             hits.each { |result| yielder.yield(result) }
 
             response = client.scroll(
-              scroll_id: response.fetch('_scroll_id'),
+              scroll_id: response.fetch("_scroll_id"),
               scroll: params[:scroll]
             )
           end

data/lib/rom/elasticsearch/types.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rom/types'
+require "rom/types"
 
 module ROM
   module Elasticsearch
@@ -19,7 +19,7 @@ module ROM
       #
       # @api public
       def self.Keyword(meta = {})
-        String.meta(type: 'keyword', **meta)
+        String.meta(type: "keyword", **meta)
       end
 
       # Define a keyword attribute type
@@ -28,7 +28,7 @@ module ROM
       #
       # @api public
       def self.Text(meta = {})
-        String.meta(type: 'text', **meta)
+        String.meta(type: "text", **meta)
       end
     end
   end

data/lib/rom/elasticsearch/version.rb

@@ -2,6 +2,6 @@
 
 module ROM
   module Elasticsearch
-    VERSION = '0.4.0'
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rom-elasticsearch
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Hannes Nevalainen
 - Piotr Solnica
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-28 00:00:00.000000000 Z
+date: 2021-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rom-core
@@ -17,34 +17,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.1
+        version: 5.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.1
+        version: 5.2.5
 - !ruby/object:Gem::Dependency
   name: elasticsearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -96,7 +96,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- LICENSE.txt
 - README.md
 - lib/rom-elasticsearch.rb
 - lib/rom/elasticsearch.rb
@@ -118,7 +117,7 @@ homepage: https://rom-rb.org
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,8 +132,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: ROM adapter for Elasticsearch
 test_files: []

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) rom-rb team
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.