elasticsearch-dsl-builder 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 418d5192343837465ab9d7a60484aacc9eb9f501
-  data.tar.gz: e0627ac86a4f19429291920b72002b9d282ecb8f
+  metadata.gz: 4e9f6de3a22231c91619745c3e9b547bb4719aaa
+  data.tar.gz: b95ba53e9bc8e28c4ad78b1103be51163bc87216
 SHA512:
-  metadata.gz: d44a4bb6bb06cc966024627bf37715a96f01b706732d8ed00a5601f8e1ac13b5a5a91b0a0daf0680dd087e0792febbec00a6a7e0a6d8ce11b6afbd6dbf9a87cb
-  data.tar.gz: b2b3566b4d78722c80029f2da00a28510f1e2eee02c702180eb7cc82a693fa07215aa1102071d5604a89f9dd47ebe6a939f117007822b32202e69a7dc83dd059
+  metadata.gz: 8ca5470e4df4234de616674ed79f28f07334c777663a8e059e77240d8a88169b8c6fbd6af848aadc77b0a4a24fe89e87c6c193d23b3c2dce3da4bc718e8dbda2
+  data.tar.gz: c05e3cc6dd26eb397ea0750c87109b93367901633e2883f473d68134bee7b092c1d20c6d70f03b2d172ee9d97299148512cdd7d690f890a67fe6225a3d5ea2ef

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    elasticsearch-dsl-builder (0.0.16)
+    elasticsearch-dsl-builder (0.0.17)
 
 GEM
   remote: https://rubygems.org/

data/elasticsearch-dsl-builder.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'elasticsearch-dsl-builder'
-  s.version     = '0.0.16'
+  s.version     = '0.0.17'
   s.date        = '2017-10-06'
   s.summary     = 'Library utilizing builder pattern providing Ruby API for the Elasticsearch Query DSL'
   s.description = 'TBD'

data/lib/elasticsearch_dsl_builder/dsl.rb

@@ -2,6 +2,7 @@ require 'elasticsearch_dsl_builder/dsl/version'
 
 require 'elasticsearch_dsl_builder/dsl/search/aggregation'
 require 'elasticsearch_dsl_builder/dsl/search/query'
+require 'elasticsearch_dsl_builder/dsl/search/inner_hits'
 require 'elasticsearch_dsl_builder/dsl/search/script'
 require 'elasticsearch_dsl_builder/dsl/search/sort'
 require 'elasticsearch_dsl_builder/exceptions'

data/lib/elasticsearch_dsl_builder/dsl/search/inner_hits.rb

@@ -0,0 +1,57 @@
+module ElasticsearchDslBuilder
+  module DSL
+    module Search
+      class InnerHits
+        def size(value)
+          raise ArgumentError, 'value must be Numeric' unless value.is_a? Numeric
+          @size = value
+          self
+        end
+
+        def from(value)
+          raise ArgumentError, 'value must be Numeric' unless value.is_a? Numeric
+          @from = value
+          self
+        end
+
+        def sort_by(name, direction = nil)
+          @sort ||= Sort.new
+          @sort.by(name, direction)
+          self
+        end
+
+        def include_fields(*fields)
+          fields = fields.flatten
+          fields_valid = !fields.empty? && fields.all? { |f| f.instance_of?(String) }
+          raise ArgumentError, 'must pass at least 1 String field' unless fields_valid
+          @included_fields ||= []
+          @included_fields.concat fields
+          self
+        end
+
+        def exclude_fields(*fields)
+          fields = fields.flatten
+          fields_valid = !fields.empty? && fields.all? { |f| f.instance_of?(String) }
+          raise ArgumentError, 'must pass at least 1 String field' unless fields_valid
+          @excluded_fields ||= []
+          @excluded_fields.concat fields
+          self
+        end
+
+        def to_hash
+          hash = {}
+          hash.update(sort: @sort.to_hash) if @sort
+          hash.update(size: @size) if @size
+          hash.update(from: @from) if @from
+          unless @included_fields.to_a.empty? && @excluded_fields.to_a.empty?
+            source = {}
+            source.update(includes: @included_fields) unless @included_fields.to_a.empty?
+            source.update(excludes: @excluded_fields) unless @excluded_fields.to_a.empty?
+            hash.update(_source: source)
+          end
+          hash
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch_dsl_builder/dsl/search/queries/has_child.rb

@@ -23,9 +23,16 @@ module ElasticsearchDslBuilder
             self
           end
 
+          def inner_hits(inner_hits)
+            raise ArgumentError, 'inner_hits must be an InnerHits object' unless inner_hits.instance_of?(InnerHits)
+            @inner_hits = inner_hits.to_hash
+            self
+          end
+
           def to_hash
             @query = { type: @child_type }
             @query.update(query: @nested_query) if @nested_query
+            @query.update(inner_hits: @inner_hits) if @inner_hits
             super
           end
         end

data/lib/elasticsearch_dsl_builder/dsl/search/queries/has_parent.rb

@@ -30,11 +30,18 @@ module ElasticsearchDslBuilder
             self
           end
 
+          def inner_hits(inner_hits)
+            raise ArgumentError, 'inner_hits must be an InnerHits object' unless inner_hits.instance_of?(InnerHits)
+            @inner_hits = inner_hits.to_hash
+            self
+          end
+
           def to_hash
             @query = {}
             @query.update(parent_type: @parent_type) if @parent_type
             @query.update(score: @score) if @score
             @query.update(query: @nested_query) if @nested_query
+            @query.update(inner_hits: @inner_hits) if @inner_hits
             super
           end
         end

data/lib/elasticsearch_dsl_builder/dsl/search/queries/nested.rb

@@ -22,9 +22,16 @@ module ElasticsearchDslBuilder
             self
           end
 
+          def inner_hits(inner_hits)
+            raise ArgumentError, 'inner_hits must be an InnerHits object' unless inner_hits.instance_of?(InnerHits)
+            @inner_hits = inner_hits.to_hash
+            self
+          end
+
           def to_hash
             @query = { path: @path }
             @query.update(query: @nested_query) if @nested_query
+            @query.update(inner_hits: @inner_hits) if @inner_hits
             super
           end
         end

data/spec/lib/dsl/search/inner_hits_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe ElasticsearchDslBuilder::DSL::Search::InnerHits do
+  it 'should raise error if sort_by not valid' do
+    expect { InnerHits.new.sort_by(123, 'asc') }.to raise_error(ArgumentError)
+    expect { InnerHits.new.sort_by('valid', 'not_asc_or_desc') }.to raise_error(ArgumentError)
+    expect { InnerHits.new.sort_by('valid', 123) }.to raise_error(ArgumentError)
+  end
+
+  it 'should raise error if size not Numeric' do
+    expect { InnerHits.new.size('invalid') }.to raise_error(ArgumentError)
+  end
+
+  it 'should raise error if from not Numeric' do
+    expect { InnerHits.new.from('invalid') }.to raise_error(ArgumentError)
+  end
+
+  it 'should raise error if include_fields invalid' do
+    expect { InnerHits.new.include_fields }.to raise_error(ArgumentError)
+    expect { InnerHits.new.include_fields(123) }.to raise_error(ArgumentError)
+    expect { InnerHits.new.include_fields('valid', 123) }.to raise_error(ArgumentError)
+  end
+
+  it 'should raise error if exclude_fields invalid' do
+    expect { InnerHits.new.exclude_fields }.to raise_error(ArgumentError)
+    expect { InnerHits.new.exclude_fields(123) }.to raise_error(ArgumentError)
+    expect { InnerHits.new.exclude_fields('valid', 123) }.to raise_error(ArgumentError)
+  end
+
+  it 'should chain build an ES search' do
+    search = InnerHits.new.
+      sort_by('posted_at', 'desc').
+      size(5).from(2).
+      include_fields('id', 'content').
+      exclude_fields('no_show')
+
+    expect(search.to_hash).to eq(
+      sort: [
+        { 'posted_at' => 'desc' }
+      ],
+      size: 5,
+      from: 2,
+      _source: {
+        includes: ['id', 'content'],
+        excludes: ['no_show']
+      }
+    )
+  end
+end

data/spec/lib/dsl/search/queries/has_child_spec.rb

@@ -11,8 +11,31 @@ describe ElasticsearchDslBuilder::DSL::Search::Queries::HasChild do
     expect { Queries::HasChild.new('child').query({}) }.to raise_error(ArgumentError)
   end
 
+  it 'should fail if inner_hits argument not a InnerHits' do
+    expect { Queries::HasChild.new('child').inner_hits('invalid') }.to raise_error(ArgumentError)
+    expect { Queries::HasChild.new('child').inner_hits({}) }.to raise_error(ArgumentError)
+  end
+
   it 'should chain create valid ES query hash' do
-    has_child = Queries::HasChild.new('child').query(Queries::Term.new(:field_a, 'value'))
-    expect(has_child.to_hash).to eq(has_child: { type: 'child', query: { term: { field_a: 'value' } } })
+    has_child = Queries::HasChild.new('child').
+      query(Queries::Term.new(:field_a, 'value')).
+      inner_hits(
+        InnerHits.new.size(1).from(0).sort_by('posted_at', 'asc').
+          include_fields('id', 'content').
+          exclude_fields('no_show')
+      )
+
+    expect(has_child.to_hash).to eq(
+      has_child: {
+        type: 'child', query: { term: { field_a: 'value' } },
+        inner_hits: {
+          sort: [{ 'posted_at' => 'asc' }], size: 1, from: 0,
+          _source: {
+            includes: ['id', 'content'],
+            excludes: ['no_show']
+          }
+        }
+      }
+    )
   end
 end

data/spec/lib/dsl/search/queries/has_parent_spec.rb

@@ -16,8 +16,33 @@ describe ElasticsearchDslBuilder::DSL::Search::Queries::HasParent do
     expect { Queries::HasParent.new('parent').query({}) }.to raise_error(ArgumentError)
   end
 
+  it 'should fail if inner_hits argument not a InnerHits' do
+    expect { Queries::HasParent.new('parent').inner_hits('invalid') }.to raise_error(ArgumentError)
+    expect { Queries::HasParent.new('parent').inner_hits({}) }.to raise_error(ArgumentError)
+  end
+
   it 'should chain create valid ES query hash' do
-    has_parent = Queries::HasParent.new('parent').score(true).query(Queries::Term.new(:field_a, 'value'))
-    expect(has_parent.to_hash).to eq(has_parent: { parent_type: 'parent', score: true, query: { term: { field_a: 'value' } } })
+    has_parent = Queries::HasParent.new('parent').
+      score(true).
+      query(Queries::Term.new(:field_a, 'value')).
+      inner_hits(
+        InnerHits.new.size(1).from(0).sort_by('posted_at', 'asc').
+          include_fields('id', 'content').
+          exclude_fields('no_show')
+      )
+    expect(has_parent.to_hash).to eq(
+      has_parent: {
+        parent_type: 'parent',
+        score: true,
+        query: { term: { field_a: 'value' } },
+        inner_hits: {
+          sort: [{ 'posted_at' => 'asc' }], size: 1, from: 0,
+          _source: {
+            includes: ['id', 'content'],
+            excludes: ['no_show']
+          }
+        }
+      }
+    )
   end
 end

data/spec/lib/dsl/search/queries/nested_spec.rb

@@ -12,8 +12,30 @@ describe ElasticsearchDslBuilder::DSL::Search::Queries::Nested do
     expect { Queries::Nested.new('path').query({}) }.to raise_error(ArgumentError)
   end
 
+  it 'should fail if inner_hits argument not a InnerHits' do
+    expect { Queries::Nested.new('path').inner_hits('invalid') }.to raise_error(ArgumentError)
+    expect { Queries::Nested.new('path').inner_hits({}) }.to raise_error(ArgumentError)
+  end
+
   it 'should chain create valid ES query hash' do
-    match = Queries::Nested.new('path').query(Queries::Exists.new('field_a'))
-    expect(match.to_hash).to eq(nested: { path: 'path', query: { exists: { field: 'field_a' } } })
+    match = Queries::Nested.new('path').
+      query(Queries::Exists.new('field_a')).
+      inner_hits(
+        InnerHits.new.size(1).from(0).sort_by('posted_at', 'asc').
+          include_fields('id', 'content').
+          exclude_fields('no_show')
+      )
+    expect(match.to_hash).to eq(
+      nested: {
+        path: 'path', query: { exists: { field: 'field_a' } },
+        inner_hits: {
+          sort: [{ 'posted_at' => 'asc' }], size: 1, from: 0,
+          _source: {
+            includes: ['id', 'content'],
+            excludes: ['no_show']
+          }
+        }
+      }
+    )
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-dsl-builder
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Marvin Guerra
@@ -98,6 +98,7 @@ files:
 - lib/elasticsearch_dsl_builder/dsl/search/aggregations/sum.rb
 - lib/elasticsearch_dsl_builder/dsl/search/aggregations/sum_bucket.rb
 - lib/elasticsearch_dsl_builder/dsl/search/aggregations/terms.rb
+- lib/elasticsearch_dsl_builder/dsl/search/inner_hits.rb
 - lib/elasticsearch_dsl_builder/dsl/search/queries/bool.rb
 - lib/elasticsearch_dsl_builder/dsl/search/queries/exists.rb
 - lib/elasticsearch_dsl_builder/dsl/search/queries/function_score.rb
@@ -129,6 +130,7 @@ files:
 - spec/lib/dsl/search/aggregations/sum_bucket_spec.rb
 - spec/lib/dsl/search/aggregations/sum_spec.rb
 - spec/lib/dsl/search/aggregations/terms_spec.rb
+- spec/lib/dsl/search/inner_hits_spec.rb
 - spec/lib/dsl/search/queries/bool_spec.rb
 - spec/lib/dsl/search/queries/exists_spec.rb
 - spec/lib/dsl/search/queries/function_score_spec.rb
@@ -187,6 +189,7 @@ test_files:
 - spec/lib/dsl/search/aggregations/sum_bucket_spec.rb
 - spec/lib/dsl/search/aggregations/sum_spec.rb
 - spec/lib/dsl/search/aggregations/terms_spec.rb
+- spec/lib/dsl/search/inner_hits_spec.rb
 - spec/lib/dsl/search/queries/bool_spec.rb
 - spec/lib/dsl/search/queries/exists_spec.rb
 - spec/lib/dsl/search/queries/function_score_spec.rb