arelastic 2.9.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1352e598774b8ec63e6e5840c21bdde48f6057d0863130e85589641496175f1d
-  data.tar.gz: 86e8f6398f27fda2b81cc7554fd22027cf7a7c985e116db498cf68dd8dd24553
+  metadata.gz: 41849e76c34d20f19af86422794c1c7c5245d8355cb6a453decc6c87934dbb66
+  data.tar.gz: a32b6ef72a9a28bccba585a0f93e04586a42b18f2ec23bb79134c59a618ea2d0
 SHA512:
-  metadata.gz: c51d28cc2d3fef1c52c6055ae1e897d988a366aaf2ac847bc1c6b07bba07ec168311ce735f527d48b7a4164aa7c85f5a73aa70ac1ec14644e2c6be9ef463fb5a
-  data.tar.gz: aff6d66dc806cab29a7d4e7d3a03a82ee3582acbe510d2cec8fdbb97576ed55e65fa935f783c1e1bb44338f4a19690863e9513bb0f938bdb1f6673c383a9b82a
+  metadata.gz: c109a5bd0a2a6e10aa9e9da405574d86b9d0e74795fd61101b0966aab00c57c41043043b268c94f004127f78b5bc6e6f45116fa1f8ca8f962e41ebeb3ff31d43
+  data.tar.gz: 1f5da97d3217067aac0963b059dff48083da71c02d116b8d3e7a3e4ead1c9786833c5218b84a69fb96b4858447417e5c252aa965ad3bd08925f821493931a8c8

data/README.md

@@ -1 +1,59 @@
 [![Build Status](https://travis-ci.org/matthuhiggins/arelastic.svg?branch=master)](https://travis-ci.org/matthuhiggins/arelastic) [![Code Climate](https://codeclimate.com/github/matthuhiggins/arelastic/badges/gpa.svg)](https://codeclimate.com/github/matthuhiggins/arelastic)
+# Arelastic
+
+Arelastic is a Elasticsearch AST manager for Ruby. It simplifies the generation complex of Elasticsearch queries
+
+It is intended to be a framework framework; that is, you can build your own ORM with it.
+
+One example is [Elastic Record](https://github.com/data-axle/elastic_record)
+
+## Usage
+
+### Search
+```ruby
+search = Arelastic::Builders::Search['name']
+
+# Name equals red
+search.eq('red').as_elastic
+# => {"term"=>{"name"=>"red"}}
+
+# Negation
+search.eq("red").negate.as_elastic
+# => {"bool"=>{"must_not"=>{"term"=>{:name=>"red"}}}}
+```
+
+### Limit & Offset
+```ruby
+# Limit
+Arelastic::Searches::Size.new(20).as_elastic
+# => {"size"=>20}
+
+# Offset
+Arelastic::Searches::From.new(20).as_elastic
+# => {"from"=>20}
+```
+
+### Ordering
+```ruby
+sort_field = Arelastic::Sorts::Field.new('price' => 'asc')
+sort_field.as_elastic
+#  => {'price' => 'asc'}
+
+sort = Arelastic::Searches::Sort.new([sort_field])
+sort.as_elastic
+# => {"sort"=>[{"price"=>"asc"}]}
+```
+
+### Putting It All Together
+```ruby
+search = [
+ Arelastic::Searches::Query.new(Arelastic::Builders::Search['name'].eq('Fun')),
+ Arelastic::Searches::Size.new(20),
+ Arelastic::Searches::From.new(20),
+ Arelastic::Searches::Sort.new([Arelastic::Sorts::Field.new('price' => 'asc')])
+]
+Arelastic::Nodes::HashGroup.new(search).as_elastic
+# => {"query"=>{"term"=>{"name"=>"Fun"}}, "size"=>20, "from"=>20, "sort"=>[{"price"=>"asc"}]}
+```
+
+Some helpful Arel builders can be found [here](/lib/arelastic/builders/filter.rb).

data/lib/arelastic.rb

@@ -13,5 +13,13 @@ module Arelastic
     def queries
       Arelastic::Builders::Queries
     end
+
+    def [](field)
+      Arelastic::Builders::Queries[field]
+    end
+
+    def aggregations
+      Arelastic::Builders::Aggregations
+    end
   end
 end

data/lib/arelastic/builders.rb

@@ -1,6 +1,4 @@
-require 'arelastic/builders/aggregation'
-require 'arelastic/builders/filter'
+require 'arelastic/builders/aggregations'
 require 'arelastic/builders/mapping'
 require 'arelastic/builders/queries'
-require 'arelastic/builders/search'
 require 'arelastic/builders/sort'

data/lib/arelastic/builders/aggregations.rb

@@ -0,0 +1,28 @@
+module Arelastic
+  module Builders
+    class Aggregations
+      class << self
+        MACROS_TO_ARELASTIC = {
+          cardinality:   Arelastic::Aggregations::Cardinality,
+          date_histogram: Arelastic::Aggregations::DateHistogram,
+          filter:         Arelastic::Aggregations::Filter,
+          filters:        Arelastic::Aggregations::Filters,
+          histogram:      Arelastic::Aggregations::Histogram,
+          missing:        Arelastic::Aggregations::Missing,
+          nested:         Arelastic::Aggregations::Nested,
+          range:          Arelastic::Aggregations::Range,
+          reverse_nested: Arelastic::Aggregations::ReverseNested,
+          sampler:        Arelastic::Aggregations::Sampler,
+          terms:          Arelastic::Aggregations::Terms,
+          value_count:    Arelastic::Aggregations::ValueCount
+        }
+
+        MACROS_TO_ARELASTIC.each do |macro, klass|
+          define_method macro do |*args|
+            klass.new(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/arelastic/builders/queries.rb

@@ -52,6 +52,39 @@ module Arelastic
           klass.new(name, *args)
         end
       end
+
+      def in other, options = {}
+        case other
+        when Range
+          if other.exclude_end?
+            range 'gte' => other.begin, 'lt' => other.end
+          else
+            range 'gte' => other.begin, 'lte' => other.end
+          end
+        else
+          terms other, options
+        end
+      end
+
+      def missing(options = {})
+        exists(options).negate
+      end
+
+      def gte other
+        range 'gte' => other
+      end
+
+      def gt other
+        range 'gt' => other
+      end
+
+      def lte other
+        range 'lte' => other
+      end
+
+      def lt other
+        range 'lt' => other
+      end
     end
   end
 end

data/test/arelastic/builders/aggregations_test.rb

@@ -0,0 +1,10 @@
+require 'helper'
+
+class Arelastic::Builders::AggregationsTest < Minitest::Test
+  def test_terms
+    expected = {"name" => {"terms" => {"field" => "color"}}}
+    actual = Arelastic::Builders::Aggregations.terms('name', 'field' => 'color').as_elastic
+
+    assert_equal expected, actual
+  end
+end

data/test/arelastic/builders/queries_test.rb

@@ -50,10 +50,26 @@ class Arelastic::Builders::QueriesTest < Minitest::Test
     assert_equal expected, query.as_elastic
   end
 
-  def test_match
-    query = Arelastic::Builders::Queries['message'].match "hello"
-    expected = {"match" => { "message" => "hello" }}
+  def test_missing
+    expected = {"bool" => {"must_not" => {"exists" => {"field" => "color"}}}}
+    assert_equal expected, Arelastic::Builders::Queries['color'].missing.as_elastic
+  end
 
-    assert_equal expected, query.as_elastic
+  def test_in
+    expected = {"terms" => {"color" => ["blue"]}}
+    assert_equal expected, Arelastic::Builders::Queries['color'].in(['blue']).as_elastic
+  end
+
+  def test_in_with_options
+    expected = {"terms" => {"color" => ["blue"], "execution" => "bool"}}
+    assert_equal expected, Arelastic::Builders::Queries['color'].in(['blue'], "execution" => "bool").as_elastic
+  end
+
+  def test_in_with_range
+    expected = {"range" => {"color" => {"gte" => 1, "lte" => 3}}}
+    assert_equal expected, Arelastic::Builders::Queries['color'].in(1..3).as_elastic
+
+    expected = {"range" => {"color" => {"gte" => 1, "lt" => 3}}}
+    assert_equal expected, Arelastic::Builders::Queries['color'].in(1...3).as_elastic
   end
 end

data/test/arelastic_test.rb

@@ -4,4 +4,9 @@ class ArelasticTest < Minitest::Test
   def test_queries
     assert_equal Arelastic::Builders::Queries, Arelastic.queries
   end
+
+  def test_lookup
+    expected =  { "term" => {"color" => "blue" }}
+    assert_equal expected, Arelastic.queries['color'].term('blue').as_elastic
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arelastic
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Matthew Higgins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-09 00:00:00.000000000 Z
+date: 2019-11-23 00:00:00.000000000 Z
 dependencies: []
 description: Build Elastic Search queries with objects
 email: developer@matthewhiggins.com
@@ -40,11 +40,9 @@ files:
 - lib/arelastic/arities/polyadic.rb
 - lib/arelastic/arities/unary.rb
 - lib/arelastic/builders.rb
-- lib/arelastic/builders/aggregation.rb
-- lib/arelastic/builders/filter.rb
+- lib/arelastic/builders/aggregations.rb
 - lib/arelastic/builders/mapping.rb
 - lib/arelastic/builders/queries.rb
-- lib/arelastic/builders/search.rb
 - lib/arelastic/builders/sort.rb
 - lib/arelastic/mappings.rb
 - lib/arelastic/mappings/type.rb
@@ -117,11 +115,9 @@ files:
 - test/arelastic/arities/binary_test.rb
 - test/arelastic/arities/polyadic_test.rb
 - test/arelastic/arities/unary_test.rb
-- test/arelastic/builders/aggregation_test.rb
-- test/arelastic/builders/filter_test.rb
+- test/arelastic/builders/aggregations_test.rb
 - test/arelastic/builders/mapping_test.rb
 - test/arelastic/builders/queries_test.rb
-- test/arelastic/builders/search_test.rb
 - test/arelastic/builders/sort_test.rb
 - test/arelastic/mappings/types/binary_test.rb
 - test/arelastic/mappings/types/multi_field_test.rb

data/lib/arelastic/builders/aggregation.rb

@@ -1,31 +0,0 @@
-module Arelastic
-  module Builders
-    class Aggregation < Struct.new :name
-      class << self
-        def [](name)
-          new(name)
-        end
-      end
-
-      def date_histogram options
-        Arelastic::Aggregations::DateHistogram.new name, options
-      end
-
-      def filter filter, options
-        Arelastic::Aggregations::Filter.new name, filter, options
-      end
-
-      def histogram options
-        Arelastic::Aggregations::Histogram.new name, options
-      end
-
-      def sample shard_size, aggs
-        Arelastic::Aggregations::Sampler.new(name, sample_size, aggs)
-      end
-
-      def terms options = {}
-        Arelastic::Aggregations::Terms.new(name, options)
-      end
-    end
-  end
-end

data/lib/arelastic/builders/filter.rb

@@ -1,81 +0,0 @@
-module Arelastic
-  module Builders
-    class Filter < Struct.new :field
-      class << self
-        def [](field)
-          new(field)
-        end
-
-        def ids *ids
-          Arelastic::Queries::Ids.new ids.flatten
-        end
-
-        def not expr
-          Arelastic::Queries::Bool.new must_not: expr
-        end
-      end
-
-      def eq other
-        Arelastic::Queries::Term.new field, other
-      end
-
-      def not_eq other
-        self.class.not eq(other)
-      end
-
-      def in other, options = {}
-        case other
-        when Range
-          if other.exclude_end?
-            range 'gte' => other.begin, 'lt' => other.end
-          else
-            range 'gte' => other.begin, 'lte' => other.end
-          end
-        else
-          Arelastic::Queries::Terms.new field, other, options
-        end
-      end
-
-      def not_in other, options = {}
-        self.class.not self.in(other, options)
-      end
-
-      def prefix other
-        Arelastic::Queries::Prefix.new field, other
-      end
-
-      def exists(options = {})
-        Arelastic::Queries::Exists.new field, options
-      end
-
-      def missing(options = {})
-        exists(options).negate
-      end
-
-      def regexp other
-        Arelastic::Queries::Regexp.new field, other
-      end
-
-      def gte other
-        range 'gte' => other
-      end
-
-      def gt other
-        range 'gt' => other
-      end
-
-      def lte other
-        range 'lte' => other
-      end
-
-      def lt other
-        range 'lt' => other
-      end
-
-      private
-        def range options
-          Arelastic::Queries::Range.new field, options
-        end
-    end
-  end
-end

data/lib/arelastic/builders/search.rb

@@ -1,27 +0,0 @@
-module Arelastic
-  module Builders
-    class Search
-      class << self
-        def filter
-          Arelastic::Builders::Filter
-        end
-
-        def [](field)
-          filter[field]
-        end
-
-        def aggregation
-          Arelastic::Builders::Aggregation
-        end
-
-        def queries
-          Arelastic::Builders::Queries
-        end
-
-        def sort
-          Arelastic::Builders::Sort
-        end
-      end
-    end
-  end
-end

data/test/arelastic/builders/aggregation_test.rb

@@ -1,10 +0,0 @@
-require 'helper'
-
-class Arelastic::Builders::AggregationTest < Minitest::Test
-  def test_terms
-    expected = {"name" => {"terms" => {"field" => "color"}}}
-    actual = Arelastic::Builders::Aggregation['name'].terms('field' => 'color').as_elastic
-
-    assert_equal expected, actual
-  end
-end

data/test/arelastic/builders/filter_test.rb

@@ -1,76 +0,0 @@
-require 'helper'
-
-class Arelastic::Builders::FilterTest < Minitest::Test
-  def test_ids
-    expected = {"ids" => {"values"=>["5", "6"]}}
-    assert_equal expected, Arelastic::Builders::Filter.ids('5', '6').as_elastic
-  end
-
-  def test_not
-    expected = {"bool" => {"must_not" => {"terms" => {"color" => "blue"}}}}
-    assert_equal expected, Arelastic::Builders::Filter.not({"terms" => {"color" => "blue"}}).as_elastic    
-  end
-
-  def test_eq
-    expected = {"term"=>{"color"=>"blue"}}
-    assert_equal expected, builder.eq('blue').as_elastic
-  end
-
-  def test_not_eq
-    expected = {"bool" => {"must_not" => {"term" => {"color" => "blue"}}}}
-    assert_equal expected, builder.not_eq('blue').as_elastic
-  end
-
-  def test_in
-    expected = {"terms" => {"color" => ["blue"]}}
-    assert_equal expected, builder.in(['blue']).as_elastic
-  end
-
-  def test_in_with_options
-    expected = {"terms" => {"color" => ["blue"], "execution" => "bool"}}
-    assert_equal expected, builder.in(['blue'], "execution" => "bool").as_elastic
-  end
-
-  def test_in_with_range
-    expected = {"range" => {"color" => {"gte"=>1, "lte"=>3}}}
-    assert_equal expected, builder.in(1..3).as_elastic
-
-    expected = {"range" => {"color" => {"gte"=>1, "lt"=>3}}}
-    assert_equal expected, builder.in(1...3).as_elastic
-  end
-
-  def test_not_in
-    expected = {"bool" => {"must_not" => {"terms" => {"color"=>["blue"]}}}}
-    assert_equal expected, builder.not_in(['blue']).as_elastic
-  end
-
-  def test_prefix
-    expected = {"prefix" => {"color" => "blu"}}
-    assert_equal expected, builder.prefix('blu').as_elastic
-  end
-
-  def test_exists
-    expected = {"exists" => {"field" => "color"}}
-    assert_equal expected, builder.exists.as_elastic
-  end
-
-  def test_missing
-    expected = {"bool" => {"must_not" => {"exists" => {"field" => "color"}}}}
-    assert_equal expected, builder.missing.as_elastic
-  end
-
-  def test_regexp
-    expected = {"regexp" => {"color" => "green(-blue)?"}}
-    assert_equal expected, builder.regexp("green(-blue)?").as_elastic
-  end
-
-  def test_range
-    expected = {"range" => {"color" => {"lt" => 5}}}
-    assert_equal expected, builder.lt(5).as_elastic
-  end
-
-  private
-    def builder
-      @builder ||= Arelastic::Builders::Filter['color']
-    end
-end

data/test/arelastic/builders/search_test.rb

@@ -1,23 +0,0 @@
-require 'helper'
-
-class Arelastic::Builders::SearchTest < Minitest::Test
-  def test_filter
-    assert_equal Arelastic::Builders::Filter, Arelastic::Builders::Search.filter
-  end
-
-  def test_field
-    assert_kind_of Arelastic::Builders::Filter, Arelastic::Builders::Search['poop']
-  end
-
-  def test_aggregation
-    assert_equal Arelastic::Builders::Aggregation, Arelastic::Builders::Search.aggregation
-  end
-
-  def test_query
-    assert_equal Arelastic::Builders::Queries, Arelastic::Builders::Search.queries
-  end
-
-  def test_sort
-    assert_equal Arelastic::Builders::Sort, Arelastic::Builders::Search.sort
-  end
-end