rom-elasticsearch 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 952c1f408e7aacb129e6cd717870d5cc868d4e9a
-  data.tar.gz: 5455ddde25816f89151a439864c660c88672da5c
+SHA256:
+  metadata.gz: 4e74b8fa3035dc7923a8d9b9ae9366c59ccf412934bc7a4ff11b4fbc76ec7ac3
+  data.tar.gz: 3850528b01efb065373bcd31c6d089c11e85872f30dc6c3c02d439dbf81a529f
 SHA512:
-  metadata.gz: a6fb4a3af4baf016bec6fa0cbf7d817408f3dbe27a510dc1ec5c3a97e3a207398383d873b9af0a3798acfdd81595ae80035e22a68034088e9ee80f9cd272fbfb
-  data.tar.gz: 2e830ef47d27a707e85d8340d7f5933b1d18e3ea8911742b9eedd554721b799a63ec4137937d36eec2cdd687e2e6c66beb84e66c5e3f9fa4d3179a00b962dc71
+  metadata.gz: fde4c8952f143d7778b377d3b1ac9168ff700b4e0fb184e6a6ee4c391c6918ce6c75efcd3162990ba580bb1ba4bdc86b964b1d4b1f45e5f2d283b8fc6ba73f9a
+  data.tar.gz: 23e0871170e5c98b38a4f926c5889094ce89d888e1b87663a122e451870cebd2958d694868ffe79a10fd6eef334fbf5b9915b0f17cf90d11e0a2944da4e88007

data/.codeclimate.yml

@@ -0,0 +1,6 @@
+engines:
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+    - lib/**

data/.travis.yml

@@ -1,19 +1,22 @@
 language: ruby
 sudo: false
 cache: bundler
+before_install: gem update --system
 services:
   - elasticsearch
 bundler_args: --without yard guard benchmarks tools
 before_script:
   - curl -XPUT http://localhost:9200/rom-test
+after_success:
+  - '[ -d coverage ] && bundle exec codeclimate-test-reporter'
 script: "bundle exec rake ci"
 rvm:
-  - 2.3.4
-  - 2.4.1
+  - 2.5.0
+  - 2.4.3
+  - 2.3.6
   - jruby-9.1.12.0
 env:
   global:
-    - JRUBY_OPTS='--dev -J-Xmx1024M'
     - COVERAGE='true'
 notifications:
   webhooks:

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## v0.2.0 2018-01-23
+
+## 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)
+
+[Compare v0.1.1...v0.2.0](https://github.com/rom-rb/rom/compare/v0.1.1...v0.2.0)
+
 ## v0.1.1 2017-11-18
 
 ## Changed

data/Gemfile

@@ -11,8 +11,7 @@ end
 gem 'codeclimate-test-reporter', require: false
 gem 'simplecov', require: false
 
-gem 'pry-byebug', platform: :mri
-gem 'pry', platform: :jruby
+gem 'byebug', platform: :mri
 gem 'elasticsearch-dsl'
 
 group :tools do

data/README.md

@@ -9,8 +9,8 @@
 [![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]
-[![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]
+[![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)
 [![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).

data/lib/rom/elasticsearch/attribute.rb

@@ -7,6 +7,7 @@ module ROM
     # @api public
     class Attribute < ROM::Attribute
       INTERNAL_META_KEYS = %i[name source primary_key].freeze
+      DEFAULT_SORT_DIRECTION = 'asc'.freeze
 
       # Return ES mapping properties
       #
@@ -25,6 +26,34 @@ module ROM
       def properties?
         properties.size > 0
       end
+
+      # Return attribute with direction set to ascending
+      #
+      # @return [Attribute]
+      #
+      # @api public
+      def asc
+        meta(direction: 'asc')
+      end
+
+      # Return attribute with direction set to descending
+      #
+      # @return [Attribute]
+      #
+      # @api public
+      def desc
+        meta(direction: 'desc')
+      end
+
+      # @api private
+      memoize def to_sort_expr
+        "#{name}:#{direction}"
+      end
+
+      # @api private
+      memoize def direction
+        meta[:direction] || DEFAULT_SORT_DIRECTION
+      end
     end
   end
 end

data/lib/rom/elasticsearch/dataset.rb

@@ -20,6 +20,9 @@ module ROM
 
       include QueryMethods
 
+      # Sort values separator
+      SORT_VALUES_SEPARATOR = ','.freeze
+
       # Default query options
       ALL = { query: { match_all: EMPTY_HASH } }.freeze
 
@@ -38,6 +41,10 @@ module ROM
       #   @return [Hash] default body
       option :body, default: -> { EMPTY_HASH }
 
+      # @!attribute [r] response
+      #   @return [Hash] memoized response from the client
+      option :response, optional: true, reader: false
+
       # Put new data under configured index
       #
       # @param [Hash] data
@@ -178,6 +185,37 @@ module ROM
         self
       end
 
+      # Return dataset with :sort set
+      #
+      # @return [Dataset]
+      #
+      # @api public
+      def sort(*fields)
+        params(sort: fields.join(SORT_VALUES_SEPARATOR))
+      end
+
+      # Return dataset with :from set
+      #
+      # @param [Integer] num
+      #
+      # @return [Dataset]
+      #
+      # @api public
+      def from(num)
+        params(from: num)
+      end
+
+      # Return dataset with :size set
+      #
+      # @param [Integer] num
+      #
+      # @return [Dataset]
+      #
+      # @api public
+      def size(num)
+        params(size: num)
+      end
+
       # Create an index
       #
       # @param [Hash] opts ES options
@@ -200,6 +238,15 @@ module ROM
         client.indices.delete(params.merge(opts))
       end
 
+      # Return a dataset with pre-set client response
+      #
+      # @return [Dataset]
+      #
+      # @api public
+      def call
+        with(response: response)
+      end
+
       private
 
       # Return results of a query based on configured params and body
@@ -211,9 +258,14 @@ module ROM
         if params[:id]
           [client.get(params)]
         else
-          client.search(**params, body: body).fetch('hits').fetch('hits')
+          response.fetch('hits').fetch('hits')
         end
       end
+
+      # @api private
+      def response
+        options[:response] || client.search(**params, body: body)
+      end
     end
   end
 end

data/lib/rom/elasticsearch/relation.rb

@@ -1,4 +1,5 @@
 require 'rom/relation'
+require 'rom/elasticsearch/relation/loaded'
 require 'rom/elasticsearch/types'
 require 'rom/elasticsearch/schema'
 require 'rom/elasticsearch/attribute'
@@ -96,6 +97,14 @@ module ROM
       # whereas in core, it is only used when there's at least one read-type
       option :output_schema, default: -> { schema.to_output_hash }
 
+      # @attribute [r] current_page
+      #   @return [Integer] Currently set page
+      option :current_page, default: -> { 1 }
+
+      # @attribute [r] per_page
+      #   @return [Integer] Number of results per page
+      option :per_page, reader: false, optional: true, default: -> { 10 }
+
       # Default index settings that can be overridden
       index_settings(
         { number_of_shards: 1,
@@ -111,6 +120,52 @@ module ROM
           } }.freeze
       )
 
+      # Load a relation
+      #
+      # @return [Loaded]
+      #
+      # @api public
+      def call
+        Loaded.new(new(dataset.call))
+      end
+
+      # Return a relation with changed sorting logic
+      #
+      # @param [Array<Symbol,Attribute>] attrs
+      #
+      # @return [Relation]
+      #
+      # @api public
+      def order(*attrs)
+        new(dataset.sort(*schema.project(*attrs).map(&:to_sort_expr)))
+      end
+
+      # Return a relation with page number set
+      #
+      # @param [Integer] num
+      #
+      # @return [Relation]
+      #
+      # @api public
+      def page(num)
+        new(dataset.from((num - 1) * per_page), current_page: num)
+      end
+
+      # Return a relation with per-page number set
+      #
+      # @param [Integer] num
+      #
+      # @return [Relation]
+      #
+      # @api public
+      def per_page(num = Undefined)
+        if num.equal?(Undefined)
+          options[:per_page]
+        else
+          new(dataset.size(num), per_page: num)
+        end
+      end
+
       # Map indexed data
       #
       # @yieldparam [Hash,ROM::Struct]

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

@@ -0,0 +1,28 @@
+module ROM
+  module Elasticsearch
+    class Relation < ROM::Relation
+      # Materialized index data
+      #
+      # @api public
+      class Loaded < ROM::Relation::Loaded
+        # Return total number of hits
+        #
+        # @return [Integer]
+        #
+        # @api public
+        def total_hits
+          response['hits']['total']
+        end
+
+        # Return raw response from the ES client
+        #
+        # @return [Hash]
+        #
+        # @api public
+        def response
+          source.dataset.options[:response]
+        end
+      end
+    end
+  end
+end

data/lib/rom/elasticsearch/version.rb

@@ -1,5 +1,5 @@
 module ROM
   module Elasticsearch
-    VERSION = '0.1.1'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

data/spec/spec_helper.rb

@@ -15,9 +15,8 @@ if RUBY_ENGINE == 'ruby' && ENV['COVERAGE'] == 'true'
 end
 
 begin
-  require 'pry-byebug'
+  require 'byebug'
 rescue LoadError
-  require 'pry'
 end
 
 require 'rom-elasticsearch'

data/spec/unit/rom/elasticsearch/relation/call_spec.rb

@@ -0,0 +1,22 @@
+require 'rom/elasticsearch/relation'
+
+RSpec.describe ROM::Elasticsearch::Relation, '#call' do
+  subject(:relation) { relations[:users] }
+
+  include_context 'users'
+
+  before do
+    relation.command(:create).(id: 1, name: 'Jane')
+    relation.command(:create).(id: 2, name: 'John')
+
+    relation.refresh
+  end
+
+  it 'returns loaded relation' do
+    result = relation.call
+
+    expect(result).to match_array([{ id: 1, name: 'Jane' }, { id: 2, name: 'John' }])
+
+    expect(result.total_hits).to be(2)
+  end
+end

data/spec/unit/rom/elasticsearch/relation/order_spec.rb

@@ -0,0 +1,40 @@
+require 'rom/elasticsearch/relation'
+
+RSpec.describe ROM::Elasticsearch::Relation, '#order' do
+  subject(:relation) { relations[:users] }
+
+  include_context 'users'
+
+  before do
+    relation.command(:create).(id: 1, name: 'John')
+    relation.command(:create).(id: 2, name: 'Jane')
+    relation.command(:create).(id: 3, name: 'Jade')
+    relation.command(:create).(id: 4, name: 'Joe')
+
+    relation.refresh
+  end
+
+  it 'with ascending direction' do
+    result = relation.order(:id).to_a
+
+    expect(result).
+      to eql([
+               { id: 1, name: 'John' },
+               { id: 2, name: 'Jane' },
+               { id: 3, name: 'Jade' },
+               { id: 4, name: 'Joe' }
+             ])
+  end
+
+  it 'with descending direction' do
+    result = relation.order(relation[:id].desc).to_a
+
+    expect(result).
+      to eql([
+               { id: 4, name: 'Joe' },
+               { id: 3, name: 'Jade' },
+               { id: 2, name: 'Jane' },
+               { id: 1, name: 'John' }
+             ])
+  end
+end

data/spec/unit/rom/elasticsearch/relation/page_spec.rb

@@ -0,0 +1,20 @@
+require 'rom/elasticsearch/relation'
+
+RSpec.describe ROM::Elasticsearch::Relation, '#page' do
+  subject(:relation) { relations[:users].order(:id) }
+
+  include_context 'users'
+
+  before do
+    relation.command(:create).(id: 1, name: 'Jane')
+    relation.command(:create).(id: 2, name: 'John')
+
+    relation.refresh
+  end
+
+  it 'returns relation with page set' do
+    result = relation.per_page(1).page(2).to_a
+
+    expect(result).to match_array([{ id: 2, name: 'John' }])
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rom-elasticsearch
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Hannes Nevalainen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-18 00:00:00.000000000 Z
+date: 2018-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rom-core
@@ -89,6 +89,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -109,6 +110,7 @@ files:
 - lib/rom/elasticsearch/plugins/relation/query_dsl.rb
 - lib/rom/elasticsearch/query_methods.rb
 - lib/rom/elasticsearch/relation.rb
+- lib/rom/elasticsearch/relation/loaded.rb
 - lib/rom/elasticsearch/schema.rb
 - lib/rom/elasticsearch/types.rb
 - lib/rom/elasticsearch/version.rb
@@ -126,11 +128,14 @@ files:
 - 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
@@ -156,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: ROM adapter for Elasticsearch
@@ -174,11 +179,14 @@ test_files:
 - 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