elastic-rails 0.8.5 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4479b2e301ba75acb8449d5afb042efaf249511c
-  data.tar.gz: 6f456debe94dcaa755a3a5e8e45e1de0ed53264a
+  metadata.gz: c0035b5db3d49f0a734e2f8a2d77162ac50867cc
+  data.tar.gz: 0223a10c669b8f637b14c50afe88b73ef4714a17
 SHA512:
-  metadata.gz: c4015950ebd08be302993e16ca68ddc8641e9038fb9198a661d670569642ceae4324a978c9deb8c5cd410443d5fa0b3c6d69dacac3b9c1670fb66f5a4ed68e98
-  data.tar.gz: b929a60ed947548975264fd69c68935e7cb3dca1a0dea9372aa8986d1f372979a58f27ba28318841308c7d4444a6ea399793f490d6c0829bb3954ed90329be80
+  metadata.gz: f95a7f7abbaae72da092ec05cbfc2fc5cdec442438d48acbcfab152a716a84c0deb1f3e2e1ae60196a756608d73753203861f8337ccabd9a1353110f720fb19d
+  data.tar.gz: 4f3fe1093d986f8fcda505c37623a5da5398a93bb0a407408c32863ffe33e14d161244617fa0b6247e4dfc1b946695d23931136ab9b9512d437e8db82aa28dfd

data/.travis.yml

@@ -1,5 +1,8 @@
-sudo: false
 language: ruby
 rvm:
-  - 2.3.1
-before_install: gem install bundler -v 1.12.4
+  - 2.4.0
+  - 2.3.3
+  - 2.2.6
+services:
+  - elasticsearch
+before_install: gem install bundler -v 1.12.5

data/README.md

@@ -1,5 +1,7 @@
 # Elastic Rails
 
+[![Build Status](https://travis-ci.org/platanus/elastic-rails.svg?branch=master)](https://travis-ci.org/platanus/elastic-rails)
+
 Elasticsearch + Ruby on Rails made easy.
 
 ## Features
@@ -119,6 +121,14 @@ BikeIndex
   .average(:price)
   .each { |keys, price| puts "#{keys[:year]}/#{keys[:category]} => #{price}" }
 
+# Get average and maximum bike price for bikes newer than 2014
+BikeIndex
+  .must(year: { gte: 2014 })
+  .compose do |c|
+    c.average(:price)
+    c.maximum(:price)
+  end
+
 # Search bikes ids that have shimano parts:
 BikeIndex.must(parts: { brand: 'shimano' }).ids
 ```

data/lib/elastic.rb

@@ -45,6 +45,7 @@ require "elastic/nodes/agg/average"
 require "elastic/nodes/agg/minimum"
 require "elastic/nodes/agg/maximum"
 require "elastic/nodes/agg/sum"
+require "elastic/nodes/agg/top"
 require "elastic/nodes/agg/terms"
 require "elastic/nodes/agg/date_histogram"
 require "elastic/nodes/agg/top_hits"
@@ -52,7 +53,8 @@ require "elastic/nodes/agg/top_hits"
 require "elastic/shims/base"
 require "elastic/shims/populating"
 require "elastic/shims/grouping"
-require "elastic/shims/reducing"
+require "elastic/shims/single_aggregation"
+require "elastic/shims/multiple_aggregation"
 require "elastic/shims/total_picking"
 require "elastic/shims/id_picking"
 require "elastic/shims/field_picking"
@@ -79,6 +81,7 @@ require "elastic/core/query_assembler"
 require "elastic/dsl/bool_query_builder"
 require "elastic/dsl/bool_query_context"
 require "elastic/dsl/metric_builder"
+require "elastic/dsl/result_composer"
 
 require "elastic/types/base_type"
 require "elastic/types/faceted_type"

data/lib/elastic/core/query_assembler.rb

@@ -30,11 +30,16 @@ module Elastic::Core
     end
 
     def assemble_metric(_node)
-      query = assemble_metrics([_node])
-      reduced_query query
+      query = assemble_aggregated([_node])
+      single_aggregation_query query
     end
 
-    def assemble_metrics(_aggs)
+    def assemble_metrics(_nodes)
+      query = assemble_aggregated(_nodes)
+      multiple_aggregation_query query
+    end
+
+    def assemble_aggregated(_aggs)
       query = build_base_query
       query.size = 0
 
@@ -64,7 +69,7 @@ module Elastic::Core
         last.aggregate sort_node Elastic::Nodes::TopHits.build('default')
 
         query = grouped_query query
-        query = reduced_query query
+        query = single_aggregation_query query
       end
 
       query
@@ -93,8 +98,12 @@ module Elastic::Core
       Elastic::Shims::Grouping.new(_query)
     end
 
-    def reduced_query(_query)
-      Elastic::Shims::Reducing.new(_query)
+    def single_aggregation_query(_query)
+      Elastic::Shims::SingleAggregation.new(_query)
+    end
+
+    def multiple_aggregation_query(_query)
+      Elastic::Shims::MultipleAggregation.new(_query)
     end
 
     def populated_query(_query)

data/lib/elastic/dsl/metric_builder.rb

@@ -20,15 +20,32 @@ module Elastic::Dsl
       aggregate_metric(Elastic::Nodes::Agg::Stats, _field, _options, '%s_stats')
     end
 
-    private
+    def opening(_field, _options = {})
+      by = _options.delete :by
+      raise ArgumentError, 'must provide a sorting column' if by.nil?
+
+      aggregate_metric(Elastic::Nodes::Agg::Top, _field, _options, 'open_%s') do |node|
+        node.add_sort(by, order: :asc)
+      end
+    end
+
+    def closing(_field, _options = {})
+      by = _options.delete :by
+      raise ArgumentError, 'must provide a sorting column' if by.nil?
 
-    def aggregate_metric(_klass, _field, _options, _default_name)
-      with_aggregable_for_metric do |agg|
-        # TODO: detect nested name and wrap node
-        name = _options[:as] || sprintf(_default_name, _field)
-        node = _klass.build(name, _field, missing: _options[:missing])
-        agg.aggregate node
+      aggregate_metric(Elastic::Nodes::Agg::Top, _field, _options, 'close_%s') do |node|
+        node.add_sort(by, order: :desc)
       end
     end
+
+    private
+
+    def aggregate_metric(_klass, _field, _options, _default_name, &_block)
+      # TODO: detect nested name and wrap node
+      name = _options.delete(:as) || sprintf(_default_name, _field)
+      node = _klass.build(name, _field, _options)
+      _block.call node unless _block.nil?
+      aggregate node
+    end
   end
 end

data/lib/elastic/dsl/result_composer.rb

@@ -0,0 +1,15 @@
+module Elastic::Dsl
+  class ResultComposer
+    include MetricBuilder
+
+    def initialize(_aggs)
+      @aggs = _aggs
+    end
+
+    def aggregate(_node)
+      raise ArgumentError, 'node must provide a name' unless _node.name
+      @aggs << _node
+      nil
+    end
+  end
+end

data/lib/elastic/nodes/agg/top.rb

@@ -0,0 +1,42 @@
+module Elastic::Nodes::Agg
+  class Top < Elastic::Nodes::BaseAgg
+    include Elastic::Nodes::Concerns::Sortable
+
+    def self.build(_name, _field, _options = {})
+      super(_name).tap do |node|
+        node.field = _field
+      end
+    end
+
+    attr_accessor :field
+
+    def clone
+      prepare_clone super
+    end
+
+    def simplify
+      prepare_clone super
+    end
+
+    def render(_options = {})
+      top_hit_config = { '_source' => { 'include' => [@field.to_s] }, 'size' => 1 }
+      top_hit_config['sort'] = render_sorts if registered_sorts.count > 0
+
+      { 'top_hits' => top_hit_config }
+    end
+
+    def handle_result(_raw, _formatter)
+      raw_value = _raw['hits'] ? _raw['hits']['hits'].first['_source'][@field.to_s] : nil
+
+      # TODO: apply formatter to value
+      Elastic::Results::Metric.new raw_value
+    end
+
+    private
+
+    def prepare_clone(_clone)
+      _clone.field = @field
+      _clone
+    end
+  end
+end

data/lib/elastic/nodes/base.rb

@@ -33,4 +33,4 @@ require "elastic/nodes/concerns/aggregable"
 require "elastic/nodes/concerns/bucketed"
 require "elastic/nodes/concerns/boostable"
 require "elastic/nodes/concerns/field_query"
-
+require "elastic/nodes/concerns/sortable"

data/lib/elastic/nodes/concerns/sortable.rb

@@ -0,0 +1,54 @@
+module Elastic::Nodes::Concerns
+  module Sortable
+    ORDER = [:asc, :desc]
+    MODES = [:min, :max, :sum, :avg, :median]
+
+    def clone
+      copy_sorts super
+    end
+
+    def simplify
+      copy_sorts super
+    end
+
+    def sorts
+      registered_sorts.dup
+    end
+
+    def add_sort(_field, order: :asc, mode: nil, missing: nil)
+      raise ArgumentError, "invalid sort order #{order}" unless ORDER.include?(order.to_sym)
+      raise ArgumentError, "invalid sort mode #{mode}" if mode && !MODES.include?(mode.to_sym)
+
+      options = { 'order' => order.to_s }
+      options['mode'] = mode.to_s if mode.present?
+      options['missing'] = missing if missing.present?
+
+      registered_sorts << { _field.to_s => options.freeze }.freeze
+      self
+    end
+
+    def reset_sorts
+      @registered_sorts = nil
+      self
+    end
+
+    protected
+
+    attr_writer :registered_sorts
+
+    private
+
+    def copy_sorts(_clone)
+      _clone.registered_sorts = sorts
+      _clone
+    end
+
+    def render_sorts
+      sorts
+    end
+
+    def registered_sorts
+      @registered_sorts ||= []
+    end
+  end
+end

data/lib/elastic/nodes/sort.rb

@@ -1,47 +1,19 @@
 module Elastic::Nodes
   class Sort < Base
-    ORDER = [:asc, :desc]
-    MODES = [:min, :max, :sum, :avg, :median]
+    include Concerns::Sortable
 
     attr_accessor :child
 
-    def initialize
-      @sorts = []
-    end
-
-    def sorts
-      @sorts.dup
-    end
-
-    def add_sort(_field, order: :asc, mode: nil, missing: nil)
-      raise ArgumentError, "invalid sort order #{order}" unless ORDER.include?(order.to_sym)
-      raise ArgumentError, "invalid sort mode #{mode}" if mode && !MODES.include?(mode.to_sym)
-
-      options = { 'order' => order.to_s }
-      options['mode'] = mode.to_s if mode.present?
-      options['missing'] = missing if missing.present?
-
-      @sorts << { _field => options.freeze }.freeze
-      self
-    end
-
     def add_score_sort(order: :desc)
-      raise ArgumentError, "invalid sort order #{order}" unless ORDER.include?(order.to_sym)
-
       add_sort('_score', order: order)
     end
 
-    def reset_sorts
-      @sorts = []
-      self
-    end
-
     def clone
       prepare_clone(super, child.try(:clone))
     end
 
     def simplify
-      if @sorts.empty?
+      if registered_sorts.empty?
         child.try(:simplify)
       else
         prepare_clone(super, child.try(:simplify))
@@ -63,20 +35,11 @@ module Elastic::Nodes
       @child.traverse(&_block)
     end
 
-    protected
-
-    attr_writer :sorts
-
     private
 
     def prepare_clone(_clone, _child)
       _clone.child = _child
-      _clone.sorts = @sorts.dup
       _clone
     end
-
-    def render_sorts
-      @sorts.dup
-    end
   end
 end

data/lib/elastic/query.rb

@@ -43,10 +43,6 @@ module Elastic
       execute assembler.assemble_pick(_field)
     end
 
-    def aggregate(_name = nil, _node = nil, &_block)
-      # TODO
-    end
-
     def total
       execute assembler.assemble_total
     end
@@ -64,6 +60,16 @@ module Elastic
       assembler.assemble.render
     end
 
+    def compose(&_block)
+      agg_nodes = []
+      Dsl::ResultComposer.new(agg_nodes).tap(&_block)
+      execute assembler.assemble_metrics agg_nodes
+    end
+
+    def aggregate(_node)
+      execute assembler.assemble_metric _node
+    end
+
     private
 
     def with_clone(&_block)
@@ -76,11 +82,6 @@ module Elastic
       with_clone { |config| _block.call(config.query) }
     end
 
-    def with_aggregable_for_metric(&_block)
-      adaptor = AggregableAdaptor.new.tap(&_block)
-      execute assembler.assemble_metric(adaptor.agg)
-    end
-
     def build_base_config
       Core::QueryConfig.initial_config
     end
@@ -101,13 +102,5 @@ module Elastic
     def formatter
       Core::SourceFormatter.new(@index.definition)
     end
-
-    class AggregableAdaptor
-      attr_accessor :agg
-
-      def aggregate(_node)
-        self.agg = _node
-      end
-    end
   end
 end

data/lib/elastic/shims/multiple_aggregation.rb

@@ -0,0 +1,16 @@
+module Elastic::Shims
+  class MultipleAggregation < Base
+    def handle_result(_raw, _formatter)
+      result = super
+
+      case result
+      when Elastic::Results::Root
+        result.aggregations
+      when Elastic::Results::GroupedResult
+        result
+      else
+        raise "unable to reduce result of type #{result.class}"
+      end
+    end
+  end
+end

data/lib/elastic/shims/{reducing.rb → single_aggregation.rb}

@@ -1,5 +1,5 @@
 module Elastic::Shims
-  class Reducing < Base
+  class SingleAggregation < Base
     def handle_result(_raw, _formatter)
       result = super
 

data/lib/elastic/version.rb

@@ -1,3 +1,3 @@
 module Elastic
-  VERSION = "0.8.5"
+  VERSION = "0.8.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-rails
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.6
 platform: ruby
 authors:
 - Ignacio Baixas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-17 00:00:00.000000000 Z
+date: 2017-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch
@@ -248,6 +248,7 @@ files:
 - lib/elastic/dsl/bool_query_builder.rb
 - lib/elastic/dsl/bool_query_context.rb
 - lib/elastic/dsl/metric_builder.rb
+- lib/elastic/dsl/result_composer.rb
 - lib/elastic/errors.rb
 - lib/elastic/fields/nested.rb
 - lib/elastic/fields/value.rb
@@ -261,6 +262,7 @@ files:
 - lib/elastic/nodes/agg/stats.rb
 - lib/elastic/nodes/agg/sum.rb
 - lib/elastic/nodes/agg/terms.rb
+- lib/elastic/nodes/agg/top.rb
 - lib/elastic/nodes/agg/top_hits.rb
 - lib/elastic/nodes/and.rb
 - lib/elastic/nodes/base.rb
@@ -271,6 +273,7 @@ files:
 - lib/elastic/nodes/concerns/bucketed.rb
 - lib/elastic/nodes/concerns/field_query.rb
 - lib/elastic/nodes/concerns/hit_provider.rb
+- lib/elastic/nodes/concerns/sortable.rb
 - lib/elastic/nodes/function_score.rb
 - lib/elastic/nodes/match.rb
 - lib/elastic/nodes/nested.rb
@@ -309,8 +312,9 @@ files:
 - lib/elastic/shims/field_picking.rb
 - lib/elastic/shims/grouping.rb
 - lib/elastic/shims/id_picking.rb
+- lib/elastic/shims/multiple_aggregation.rb
 - lib/elastic/shims/populating.rb
-- lib/elastic/shims/reducing.rb
+- lib/elastic/shims/single_aggregation.rb
 - lib/elastic/shims/total_picking.rb
 - lib/elastic/support/command.rb
 - lib/elastic/support/transform.rb