daedal-sl 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce4181876f3602d4ab2600db1faeb19888385b3d
-  data.tar.gz: 3273091061f48352851334a89c4a28d2aac69ba0
+  metadata.gz: f26d4a2e191d62a43e1b00016e65d533e7b2dfb0
+  data.tar.gz: 97176f5bfd0afb0b991deaeb5532c4fb34579e5c
 SHA512:
-  metadata.gz: 3e5d2db067987c89929ae15d01e6341367c1a63bdeb563b3b228a888cc401b0e84c151eaad3f158a05dab589df8a7c50ce9db7775209b12cacb744c9e55fb855
-  data.tar.gz: 7074427eda68059d5e6e8d9ecd91bde69542797a7f17d5ebad9b76d38ad652d935fcfcac6a247794580a22d0b6a422400fac0d8444558d209f32d517c869afe2
+  metadata.gz: 17da84c79606730755ae04e7e3098e3089516a3221c07314610a1901afa3b706bb8d78b98f1627125d9a852244d949ab541a3d948324352325e9ab1c1a47a859
+  data.tar.gz: 38369049a33a9d04f7d8777bda25e18d53b4cb87e9f12656cfc997db2e6e0aec7e0309192079ab4843a49c3bdfdf31f3e11f653e3db88b5496c5b74900225e5d

data/.gitignore

@@ -5,4 +5,5 @@
 #   git config --global core.excludesfile '~/.gitignore_global'
 
 # Ignore gem builds
-*.gem
+*.gem
+/tmp

data/.rspec

@@ -1,3 +1 @@
---profile
---color
---format Fuubar
+--color

data/Gemfile

@@ -6,5 +6,5 @@ group :development, :test do
   gem 'rspec'
   gem 'guard'
   gem 'guard-rspec'
-  gem 'fuubar'
+  gem 'hashie'
 end

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    elasticsearch-query-dsl (0.0.0)
-      daedal (~> 0.0.12)
+    daedal-sl (0.0.0)
+      daedal (>= 0.0.12)
 
 GEM
   remote: https://rubygems.org/
@@ -24,9 +24,6 @@ GEM
     equalizer (0.0.9)
     ffi (1.9.3)
     formatador (0.2.5)
-    fuubar (1.3.3)
-      rspec (>= 2.14.0, < 3.1.0)
-      ruby-progressbar (~> 1.4)
     guard (2.6.1)
       formatador (>= 0.2.4)
       listen (~> 2.7)
@@ -36,6 +33,7 @@ GEM
     guard-rspec (4.2.10)
       guard (~> 2.1)
       rspec (>= 2.14, < 4.0)
+    hashie (1.2.0)
     ice_nine (0.11.0)
     listen (2.7.9)
       celluloid (>= 0.15.2)
@@ -62,7 +60,6 @@ GEM
     rspec-mocks (3.0.2)
       rspec-support (~> 3.0.0)
     rspec-support (3.0.1)
-    ruby-progressbar (1.5.1)
     slop (3.5.0)
     thor (0.19.1)
     thread_safe (0.3.4)
@@ -77,8 +74,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  elasticsearch-query-dsl!
-  fuubar
+  daedal-sl!
   guard
   guard-rspec
+  hashie
   rspec

data/Guardfile

@@ -1,4 +1,5 @@
 guard :rspec do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$}) { |m| "spec/unit/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/acceptance/#{m[1]}_spec.rb" }
 end

data/README.md

@@ -1,7 +1,242 @@
 DaedalSL
 =======================
+[![Gem Version](https://badge.fury.io/rb/daedal-sl.svg)](http://badge.fury.io/rb/daedal-sl)
 
-Ruby block DSL for writing ElasticSearch queries built on Daedal
+Ruby block DSL for writing ElasticSearch queries built on [Daedal](https://github.com/cschuch/daedal)
+
+Installation
+------------
+
+From the terminal:
+``` terminal
+$ gem install daedal-sl
+```
+
+or in your `Gemfile`:
+
+``` ruby
+gem 'daedal-sl'
+```
+
+Then, it's as simple as including the line:
+
+``` ruby
+require 'daedal-sl'
+```
+
+Usage
+--------
+Coming soon... but here's an example. Note: Anything you pass into the optional parameter on `DaedalSL`'s `#build` method is accessible within the block via `data`.
+
+``` ruby
+some_data = Hashie::Mash.new({
+  foo: 'foofoo',
+  bar: 'barbar'
+})
+
+query = DaedalSL.build(some_data) do
+  query do
+    bool_query boost: 100 do
+      must do
+        nested_bool_query path: 'path' do
+          must { match field: data.foo, query: data.bar }
+          should { match field: data.foo, query: data.bar }
+        end
+      end
+      must do
+        nested_dis_max_query path: 'path' do
+          query { match field: data.foo, query: data.bar }
+          query { match field: data.foo, query: data.bar }
+        end
+      end
+      should { fuzzy field: data.foo, query: data.bar }
+      should { multi_match fields: ['field1', 'field2'], query: data.bar }
+      must_not { match field: data.foo, query: data.bar }
+    end
+  end
+  filter do
+    bool_filter do
+      must do
+        nested_bool_filter path: 'path' do
+          must { term_filter field: data.foo, term: data.bar }
+          should { term_filter field: data.foo, term: data.bar }
+        end
+      end
+      should do
+        and_filter do
+          filter { term_filter field: data.foo, term: data.bar }
+          filter { terms_filter field: data.foo, terms: ['term1', 'term2'] }
+        end
+      end
+      must_not { range_filter field: data.foo, gt: 1, lt: 2 }
+    end
+  end
+  fields :foo, :bar
+  paginate page: 1, per_page: 10
+end
+```
+
+`query` now yields:
+
+``` ruby
+{
+  query: {
+    bool: {
+      should: [
+        {
+          fuzzy: {
+            foofoo: {
+              value: "barbar"
+            }
+          }
+        },
+        {
+          multi_match: {
+            query: "barbar",
+            fields: [:field1, :field2]
+          }
+        }
+      ],
+      must: [
+        {
+          nested: {
+            path: :path,
+            query: {
+              bool: {
+                should: [
+                  {
+                    match: {
+                      foofoo: {
+                        query: "barbar"
+                      }
+                    }
+                  }
+                ], 
+                must: [
+                  {
+                    match: {
+                      foofoo: {
+                        query: "barbar"
+                      }
+                    }
+                  }
+                ],
+                must_not: []
+              }
+            }
+          }
+        }, 
+        {
+          nested: {
+            path: :path,
+            query: {
+              dis_max: {
+                queries: [
+                  {
+                    match: {
+                      foofoo: {
+                        query: "barbar"
+                      }
+                    }
+                  },
+                  {
+                    match: {
+                      foofoo: {
+                        query: "barbar"
+                      }
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        }
+      ],
+      must_not: [
+        {
+          match: {
+            foofoo: {
+              query: "barbar"
+            }
+          }
+        }
+      ],
+      boost: 100.0
+    }
+  }, 
+  filter: {
+    bool: {
+      should: [
+        {
+          and: [
+            {
+              term: {
+                foofoo: "barbar"
+              }
+            },
+            {
+              terms: {
+                foofoo: ["term1", "term2"]
+              }
+            }
+          ]
+        }
+      ],
+      must: [
+        {
+          nested: {
+            path: :path,
+            filter: {
+              bool: {
+                should: [
+                  {
+                    term: {
+                      foofoo: "barbar"
+                    }
+                  }
+                ],
+                must: [
+                  {
+                    term: {
+                      foofoo: "barbar"
+                    }
+                  }
+                ],
+                must_not: []
+              }
+            }
+          }
+        }
+      ],
+      must_not: [
+        {
+          range: {
+            foofoo: {
+              lt: 2,
+              gt: 1
+            }
+          }
+        }
+      ]
+    }
+  },
+  fields: [:foo, :bar],
+  :from=>0,
+  :size=>10
+}
+```
+
+Contributing
+-------------
+
+Feel free to contribute! We just ask that you:
+
+* Fork the project
+* Make your changes or additions
+* Add tests! Our goal is to keep DaedalSL a thoroughly tested project
+* Send a pull request
+
+Feedback or suggestions are also always welcome!
 
 License
 -------

data/daedal-sl.gemspec

@@ -1,6 +1,8 @@
+require File.expand_path('../lib/daedal-sl/version', __FILE__)
+
 Gem::Specification.new do |s|
   s.name        = 'daedal-sl'
-  s.version     = '0.0.0'
+  s.version     = DaedalSL::VERSION
   s.summary     = "Ruby block DSL for writing ElasticSearch queries"
   s.description = "Ruby block DSL for writing ElasticSearch queries"
   s.authors     = ["Christopher Schuch"]

data/lib/daedal-sl.rb

@@ -0,0 +1,26 @@
+require 'daedal'
+
+require 'daedal-sl/version'
+require 'daedal-sl/block_query'
+require 'daedal-sl/bool_query'
+require 'daedal-sl/dis_max_query'
+require 'daedal-sl/bool_filter'
+require 'daedal-sl/nested_bool_query'
+require 'daedal-sl/nested_bool_filter'
+require 'daedal-sl/nested_dis_max_query'
+require 'daedal-sl/and_filter'
+require 'daedal-sl/or_filter'
+require 'daedal-sl/query_helpers'
+require 'daedal-sl/builder'
+
+module DaedalSL
+  class << self
+    def build(data=nil, &block)
+      result = DaedalSL::Builder.new(data)
+      if block
+        result.instance_eval(&block)
+      end
+      result.to_hash
+    end
+  end
+end

data/lib/daedal-sl/and_filter.rb

@@ -0,0 +1,16 @@
+module DaedalSL
+  class AndFilter < BlockQuery
+
+    def initialize(parent, options)
+      @query_type = Daedal::Filters::AndFilter
+      super
+    end
+
+    def filter
+      if (result = yield)
+        @base.filters << result
+      end
+    end
+
+  end
+end

data/lib/daedal-sl/block_query.rb

@@ -0,0 +1,26 @@
+module DaedalSL
+  class BlockQuery
+    attr_reader :parent
+    attr_reader :base
+
+    def initialize(parent, options)
+      @parent = parent
+      @base = @query_type.new(options)
+    end
+
+    def method_missing(method, *args, &block)
+      @parent.send(method, *args, &block)
+    end
+
+    class << self
+      def build(parent, options, &block)
+        result = new(parent, options)
+        if block
+          result.instance_eval(&block)
+        end
+        result.base
+      end
+    end
+
+  end
+end

data/lib/daedal-sl/bool_filter.rb

@@ -0,0 +1,28 @@
+module DaedalSL
+  class BoolFilter < BlockQuery
+
+    def initialize(parent, options)
+      @query_type = Daedal::Filters::BoolFilter
+      super
+    end
+
+    def must
+      if (result = yield)
+        @base.must << result
+      end
+    end
+
+    def should
+      if (result = yield)
+        @base.should << result
+      end
+    end
+
+    def must_not
+      if (result = yield)
+        @base.must_not << result
+      end
+    end
+
+  end
+end

data/lib/daedal-sl/bool_query.rb

@@ -0,0 +1,28 @@
+module DaedalSL
+  class BoolQuery < BlockQuery
+
+    def initialize(parent, options)
+      @query_type = Daedal::Queries::BoolQuery
+      super
+    end
+
+    def must
+      if (result = yield)
+        @base.must << result
+      end
+    end
+
+    def should
+      if (result = yield)
+        @base.should << result
+      end
+    end
+
+    def must_not
+      if (result = yield)
+        @base.must_not << result
+      end
+    end
+
+  end
+end