rom-elasticsearch 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa9cb00a1c12ce6fe7272e59acb19a5a1cb473b4a31c5fd9355bebd4e3993234
-  data.tar.gz: 2c1338c63fe76a413386fb48c5b7afba3602f8b51b7c8473422c2f9e996966f7
+  metadata.gz: 4d16fc720d3b0bbdbb8c31b3e44a301b663eb0cac2ba00b7949414b38576c26a
+  data.tar.gz: b86bb549184a72684d21578805ea393a87e6f0d1e665f0a82b8ccd6831065a2a
 SHA512:
-  metadata.gz: 7984f2495ca0645cbbe39a7a34f2b6015f16c1c54c7736f96abda000a0669175b28e6a1ee6eefe89e452c33656f40d785562ccf536bd2938c180a84867bc8f04
-  data.tar.gz: 5f8a73f4038e26f8173739bafa40af575b8599e2318e947943b31d91c21d5b0ea36847f69eb25d094b5202128a81dc8ebb3dac33be64a33ce9ec9c02da435d99
+  metadata.gz: 4da96f9e4092383134b09d7b81e5c972f99463e13f4a1fd9430a74c64e9a1b2b292b8e9e7060ce0ca46e963be59942d992bac2a0815651316bcd93c81ee75e02
+  data.tar.gz: e1e82ac281fcecbce51a7c00fc08ba39c0a52cdd33a1d4f4e829e988621b17471bd63cc565e04f9f823f1cf8a024c0d93997fd3847ca336b72836ff7f32cadd2

data/CHANGELOG.md

@@ -1,9 +1,22 @@
+# v0.4.0 2019-04-28
+
+### Added
+
+- New relation methods: `#count`, `#from` and `#size` (v-kolesnikov)
+- Scroll API (hpetru)
+
+### Changed
+
+- Updated to work with `rom ~> 5.0` (v-kolesnikov)
+
+[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
 
 ### Added
 
-* Support for multi-index relations via `schema(multi: true)` (solnic)
-* Datasets can be configured to include `_metadata` in resulting tuples (solnic)
+- 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)
 
@@ -11,7 +24,7 @@
 
 ### Fixed
 
-* Using `read` types in schemas no longer breaks indexing (solnic)
+- 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)
 
@@ -19,10 +32,10 @@
 
 ### Added
 
-* `Relation#order` which sets `:sort` (solnic)
-* `Relation#page` which sets `:from` offset (solnic)
-* `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)
+- `Relation#order` which sets `:sort` (solnic)
+- `Relation#page` which sets `:from` offset (solnic)
+- `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)
 
@@ -30,7 +43,7 @@
 
 ### Changed
 
-* Connection URI is passed directly to the ES client now (solnic)
+- Connection URI is passed directly to the ES client now (solnic)
 
 # v0.1.0 2017-11-17
 

data/README.md

@@ -1,23 +1,23 @@
 [gem]: https://rubygems.org/gems/rom-elasticsearch
 [travis]: https://travis-ci.org/rom-rb/rom-elasticsearch
-[gemnasium]: https://gemnasium.com/rom-rb/rom-elasticsearch
 [codeclimate]: https://codeclimate.com/github/rom-rb/rom-elasticsearch
 [inchpages]: http://inch-ci.org/github/rom-rb/rom-elasticsearch
+[chat]: https://rom-rb.zulipchat.com
 
-# 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]
 
 [![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]
-[![Dependency Status](https://gemnasium.com/rom-rb/rom-elasticsearch.svg)][gemnasium]
-[![Maintainability](https://api.codeclimate.com/v1/badges/dc6780aac2d99766b141/maintainability)](https://codeclimate.com/github/rom-rb/rom-elasticsearch/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/dc6780aac2d99766b141/test_coverage)](https://codeclimate.com/github/rom-rb/rom-elasticsearch/test_coverage)
+[![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]
 [![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).
+Elasticsearch support for [rom-rb](https://github.com/rom-rb/rom).
 
 Resources:
 
-- [API Documentation](http://api.rom-rb.org/rom-elasticsearch)
+- [User Documentation](http://rom-rb.org/learn/elasticsearch/)
+- [API Documentation](http://rubydoc.info/gems/rom-elasticsearch)
 
 ## Installation
 

data/lib/rom-elasticsearch.rb

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

data/lib/rom/elasticsearch.rb

@@ -1,4 +1,6 @@
-require 'rom'
+# frozen_string_literal: true
+
+require 'rom/core'
 
 require 'rom/elasticsearch/version'
 require 'rom/elasticsearch/gateway'

data/lib/rom/elasticsearch/attribute.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/attribute'
 
 module ROM

data/lib/rom/elasticsearch/commands.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/commands'
 
 module ROM

data/lib/rom/elasticsearch/dataset.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require 'rom/initializer'
 
 require 'rom/elasticsearch/query_methods'
+require 'rom/elasticsearch/scroll_methods'
 require 'rom/elasticsearch/errors'
 
 module ROM
@@ -19,6 +22,7 @@ module ROM
       extend Initializer
 
       include QueryMethods
+      include ScrollMethods
 
       # Sort values separator
       SORT_VALUES_SEPARATOR = ','.freeze
@@ -276,6 +280,8 @@ module ROM
       def view
         if params[:id]
           [client.get(params)]
+        elsif params[:scroll]
+          scroll_enumerator(client, response)
         else
           response.fetch('hits').fetch('hits')
         end

data/lib/rom/elasticsearch/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ROM
   module Elasticsearch
     # @api private

data/lib/rom/elasticsearch/gateway.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'elasticsearch'
 require 'uri'
 

data/lib/rom/elasticsearch/index_name.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/support/inflector'
 
 module ROM

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/global'
 require 'elasticsearch/dsl'
 

data/lib/rom/elasticsearch/query_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/elasticsearch/errors'
 
 module ROM

data/lib/rom/elasticsearch/relation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/relation'
 
 require 'rom/elasticsearch/index_name'
@@ -198,6 +200,17 @@ module ROM
         end
       end
 
+      # Return a relation with scroll set
+      #
+      # @param [String] ttl
+      #
+      # @return [Relation]
+      #
+      # @api public
+      def scroll(ttl)
+        new(dataset.scroll(ttl))
+      end
+
       # Map indexed data
       #
       # @yieldparam [Hash,ROM::Struct]
@@ -310,6 +323,53 @@ module ROM
         new(dataset.refresh)
       end
 
+      # Return count of documents in the index
+      #
+      # @example
+      #   users.count
+      #   GET /_count
+      #
+      # @example
+      #   users.search(<query>).count
+      #   GET /_count?q=<query>
+      #
+      # @return [Integer]
+      #
+      # @api public
+      def count
+        dataset.client.count(
+          index: dataset.index,
+          type: dataset.type,
+          body: dataset.body
+        )['count']
+      end
+
+      # Restrict relation data by offset
+      #
+      # @example
+      #   users.search.from(100)
+      #   GET /_search?from=100
+      #
+      # @return [Integer]
+      #
+      # @api public
+      def from(value)
+        new(dataset.from(value))
+      end
+
+      # Restrict relation data by limit the count of documents
+      #
+      # @example
+      #   users.search.size(100)
+      #   GET /_search?size=100
+      #
+      # @return [Integer]
+      #
+      # @api public
+      def size(value)
+        new(dataset.size(value))
+      end
+
       private
 
       # Dataset index params based on relation configuration

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ROM
   module Elasticsearch
     class Relation < ROM::Relation

data/lib/rom/elasticsearch/schema.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/types'
 require 'rom/schema'
 
@@ -19,7 +21,9 @@ module ROM
       #
       # @api private
       def to_output_hash
-        Types::Hash.symbolized(map { |attr| [attr.key, attr.to_read_type] }.to_h)
+        Types::Hash
+          .schema(map { |attr| [attr.key, attr.to_read_type] }.to_h)
+          .with_key_transform(&:to_sym)
       end
     end
   end

data/lib/rom/elasticsearch/scroll_methods.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ROM
+  module Elasticsearch
+    # Dataset's scoll methods
+    #
+    # @see Dataset
+    #
+    # @api public
+    module ScrollMethods
+      # Return dataset with :scroll set
+      #
+      # @param [String] ttl
+      #
+      # @return [Dataset]
+      #
+      # @api public
+      def scroll(ttl)
+        params(scroll: ttl)
+      end
+
+      # @api private
+      def scroll_enumerator(client, response)
+        Enumerator.new do |yielder|
+          loop do
+            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: params[:scroll]
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rom/elasticsearch/types.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/types'
 
 module ROM
@@ -9,24 +11,24 @@ module ROM
       include ROM::Types
 
       # Default integer primary key
-      ID = Int.meta(primary_key: true)
+      ID = Integer.meta(primary_key: true)
 
-      # Define a keywoard attribute type
+      # Define a keyword attribute type
       #
       # @return [Dry::Types::Type]
       #
       # @api public
       def self.Keyword(meta = {})
-        String.meta(type: "keyword").meta(meta)
+        String.meta(type: 'keyword', **meta)
       end
 
-      # Define a keywoard attribute type
+      # Define a keyword attribute type
       #
       # @return [Dry::Types::Type]
       #
       # @api public
       def self.Text(meta = {})
-        String.meta(type: "text").meta(meta)
+        String.meta(type: 'text', **meta)
       end
     end
   end

data/lib/rom/elasticsearch/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module ROM
   module Elasticsearch
-    VERSION = '0.3.0'.freeze
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rom-elasticsearch
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Hannes Nevalainen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-12 00:00:00.000000000 Z
+date: 2019-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rom-core
@@ -17,14 +17,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.1
 - !ruby/object:Gem::Dependency
   name: elasticsearch
   requirement: !ruby/object:Gem::Requirement
@@ -43,16 +49,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -89,18 +95,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- ".yardopts"
 - CHANGELOG.md
-- CONTRIBUTING.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- docker-compose.yml
 - lib/rom-elasticsearch.rb
 - lib/rom/elasticsearch.rb
 - lib/rom/elasticsearch/attribute.rb
@@ -114,38 +111,10 @@ files:
 - lib/rom/elasticsearch/relation.rb
 - lib/rom/elasticsearch/relation/loaded.rb
 - lib/rom/elasticsearch/schema.rb
+- lib/rom/elasticsearch/scroll_methods.rb
 - lib/rom/elasticsearch/types.rb
 - lib/rom/elasticsearch/version.rb
-- rom-elasticsearch.gemspec
-- spec/integration/rom/elasticsearch/relation/command_spec.rb
-- spec/integration/rom/elasticsearch/relation/multi_index_spec.rb
-- spec/integration/rom/elasticsearch/relation/schema_spec.rb
-- spec/shared/setup.rb
-- spec/shared/unit/user_fixtures.rb
-- spec/shared/unit/users.rb
-- spec/spec_helper.rb
-- spec/unit/rom/elasticsearch/dataset/body_spec.rb
-- spec/unit/rom/elasticsearch/dataset/delete_spec.rb
-- spec/unit/rom/elasticsearch/dataset/params_spec.rb
-- spec/unit/rom/elasticsearch/dataset/put_spec.rb
-- spec/unit/rom/elasticsearch/dataset/query_string_spec.rb
-- spec/unit/rom/elasticsearch/dataset/search_spec.rb
-- spec/unit/rom/elasticsearch/gateway_spec.rb
-- spec/unit/rom/elasticsearch/plugins/relation/query_dsl_spec.rb
-- spec/unit/rom/elasticsearch/relation/call_spec.rb
-- spec/unit/rom/elasticsearch/relation/create_index_spec.rb
-- spec/unit/rom/elasticsearch/relation/dataset_spec.rb
-- spec/unit/rom/elasticsearch/relation/delete_spec.rb
-- spec/unit/rom/elasticsearch/relation/get_spec.rb
-- spec/unit/rom/elasticsearch/relation/map_spec.rb
-- spec/unit/rom/elasticsearch/relation/order_spec.rb
-- spec/unit/rom/elasticsearch/relation/page_spec.rb
-- spec/unit/rom/elasticsearch/relation/pluck_spec.rb
-- spec/unit/rom/elasticsearch/relation/query_spec.rb
-- spec/unit/rom/elasticsearch/relation/query_string_spec.rb
-- spec/unit/rom/elasticsearch/relation/search_spec.rb
-- spec/unit/rom/elasticsearch/relation/to_a_spec.rb
-homepage: http://rom-rb.org
+homepage: https://rom-rb.org
 licenses:
 - MIT
 metadata: {}
@@ -164,37 +133,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: ROM adapter for Elasticsearch
-test_files:
-- spec/integration/rom/elasticsearch/relation/command_spec.rb
-- spec/integration/rom/elasticsearch/relation/multi_index_spec.rb
-- spec/integration/rom/elasticsearch/relation/schema_spec.rb
-- spec/shared/setup.rb
-- spec/shared/unit/user_fixtures.rb
-- spec/shared/unit/users.rb
-- spec/spec_helper.rb
-- spec/unit/rom/elasticsearch/dataset/body_spec.rb
-- spec/unit/rom/elasticsearch/dataset/delete_spec.rb
-- spec/unit/rom/elasticsearch/dataset/params_spec.rb
-- spec/unit/rom/elasticsearch/dataset/put_spec.rb
-- spec/unit/rom/elasticsearch/dataset/query_string_spec.rb
-- spec/unit/rom/elasticsearch/dataset/search_spec.rb
-- spec/unit/rom/elasticsearch/gateway_spec.rb
-- spec/unit/rom/elasticsearch/plugins/relation/query_dsl_spec.rb
-- spec/unit/rom/elasticsearch/relation/call_spec.rb
-- spec/unit/rom/elasticsearch/relation/create_index_spec.rb
-- spec/unit/rom/elasticsearch/relation/dataset_spec.rb
-- spec/unit/rom/elasticsearch/relation/delete_spec.rb
-- spec/unit/rom/elasticsearch/relation/get_spec.rb
-- spec/unit/rom/elasticsearch/relation/map_spec.rb
-- spec/unit/rom/elasticsearch/relation/order_spec.rb
-- spec/unit/rom/elasticsearch/relation/page_spec.rb
-- spec/unit/rom/elasticsearch/relation/pluck_spec.rb
-- spec/unit/rom/elasticsearch/relation/query_spec.rb
-- spec/unit/rom/elasticsearch/relation/query_string_spec.rb
-- spec/unit/rom/elasticsearch/relation/search_spec.rb
-- spec/unit/rom/elasticsearch/relation/to_a_spec.rb
+test_files: []