elasticquery 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62b85e40bdf7bc8321ee105e4c67ee408b732117
-  data.tar.gz: 4c329fec2adc7718269d89313623183e92fd6f1c
+  metadata.gz: f2b9c2cc27bc50734cdc0d3b33140ddf3d4d9ef9
+  data.tar.gz: e59c4f8544a438c6d7ea3761223498a46e6aa3f3
 SHA512:
-  metadata.gz: 849847e5c48fb2bfb4c60f096fc7654ae25b8bff9619e006f61014065cfe9d204d6b439db2e9e94ac95bfe0d1b6d3ed683d84969ca0c7ce88d016f6cd387aba4
-  data.tar.gz: 6f5312d494e156c13d9dc662d771322860a34d3ee2f567d484126eede664cd4b97c632c5253073ff99397e708e78fe2d6e49373f9c2b902c58bf2bd8b2aa96f2
+  metadata.gz: 7f1ca3adbaa442c18253c14c75ba9c07a1f5f697261008fc506292149a587c12679b465f239c399ffe165dcc96aad914d904042af73df753899c9b8afaeb5253
+  data.tar.gz: 2852864ee870296ccbba95835083f1b11c28a42a09f4e20f39fe0109bb89cfed1d4de8e87486902b27d78a932334b2e3a5a6c01f2a90234d462b6ea8eee77a09

data/History.md

@@ -1,5 +1,17 @@
 ## Elasticquery (master)
 
+* Separate all filters to filters and queries. Rename search to multi_match. Change dsl for using explisit rule type.
+
+* Add `terms` filter
+
+* Add `exists` filter. `exists.not` works as `missing`.
+
+* Add `where` alias to `terms`
+
+* Add `without`/`missing` filter
+
+* Add `es` shortcut from `Elasticquery::Es` to model chain calls
+
 ## Elasticquery 0.1.2 (16 June 2015)
 
 * Fix `range.not`. Exception was raised

data/README.md

@@ -5,7 +5,7 @@
 [![Code Climate](https://codeclimate.com/github/caulfield/elasticquery/badges/gpa.svg)](https://codeclimate.com/github/caulfield/elasticquery)
 [![Test Coverage](https://codeclimate.com/github/caulfield/elasticquery/badges/coverage.svg)](https://codeclimate.com/github/caulfield/elasticquery)
 
-A module for elasticquery ruby [libraries][elasticsearch_rails] for using user-friendly query generator. [Click here to view demo with code examples.][demo]
+A module for elasticsearch-rails [libraries][elasticsearch_rails] like as user-friendly query generator.
 
 ## Instalation
 
@@ -23,43 +23,148 @@ gem install elasticquery
 ## Getting Started
 ### First instruction
 
-Elasticquery was designed to be customized as you need to. Providing simple methods it allows you to build power and flexible form objects. Simplicity - is the main goal. For example:
+Elasticquery was designed to be customized as you need to. Providing simple methods it allows you to build flexible queries using [Elastic Query DSL][elastic_query_dsl]
 
 ```ruby
 class MyQuery < Elasticquery::Base
   filtered do |params|
-     search params[:query]
-     term user_id: params[:user_id] if params[:user_id].present?
-     range.not :age, gte: 18
+    filters do
+      term "user.id" => params[:user_id]
+      range.not :age, gte: 18
+    end
+    queries do
+      multi_match params[:query]
+    end
   end
 end
 ```
 
-Then use it
-
 ```ruby
 query = MyQuery.new query: 'i typed', user_id: 5
-query.build # => query for elasticsearch
-Article.search query.build # => be happy 
+query.build # => query for elastic
+Article.search query.build # => returns result 
 ```
-### Currently you have
 
-1. [Term][es_term] filter. [Usage][term_examples]
-2. [MultiMatch][es_search] filter. [Usage][search_examples]
-3. [Range][es_range] filter. [Usage][range_examples]  
+## Currently you have
+### Filters
+  [Term][es_term]
+
+
+  ```ruby
+  # Simple one term filter
+  term category: 'Rock'
+
+  # _cache option support
+  term category: 'Soul', _cache: false
+
+  # Blank values are skipped. This query returns all records
+  term name: " "
+  ```
+  [Terms][es_terms]
+
+
+  ```ruby
+  # Standard terms options
+  terms a: 1, b: 2
+
+  # Skip empty values
+  terms a: 1, b: "" # => {a: 1} wil be passed
+
+  # Blank terms are skipped
+  terms a: "", b: nil # => match_all will be executed
+
+  # _cache and execution support
+  terms a: 1, b: 2, _cache: false, execution: "or"
+
+  # where alias. Usable in chain calls
+  where a: 1, b: 2, c: 3
+  ```
+  [Range][es_range]
+
+
+  ```ruby
+  # One side range
+  range :age, gte: 18
+
+  # Double sides range
+  range :volume, gte: 1, lte: 100
+
+  # _cache and execution options support
+  range :volume, gte: 1, lte: 100, _cache: true, execution: "fielddata"
+  ```
+  [Exists][es_exists]
+  [Missing][es_missing]
+
+
+  ```ruby
+  # Field existence check
+  exists "last_name"
+  missing "last_name"
+
+  # Blank value skipped
+  exists ""
+  missing ""
+
+  # Has with alias
+  with 'first_name'
+  without 'first_name'
+  ```
+  [Not][es_not]
+
+
+  ```ruby
+  # Blank values are skipped. This query returns all records
+  range.not :age, lte: ' ', gte: nil
+
+  # Term exclusion
+  term.not category: 'Rap'
+
+  # Terms exclusion
+  terms.not category: 'Rap', name: "Guf"
+
+  # 'Exists not' uses missing
+  with.not #=> returns missing filter
+  ```
+
+All filters are joined by **AND** filter.
+## Queries
+  [MultiMatch][es_search]
+
+
+  ```ruby
+  # Simple all fields search in your index
+  multi_match 'developers'
+
+  # The same as above
+  multi_match 'developers', fields: "_all", operator: "and", type: "best_fields"
+
+  # Configure fields
+  multi_match 'Jordan', fields: ['first_name', 'last_name'], operator: "or"
+
+  # Blank values are skipped. This query returns all records
+  multi_match ''
+
+  # Alias as search
+  search 'Hello!'
+  ```
 
 ### Extended instruction
-There are multiple ways to organize your query, using chaining calls, or custom filters. Better custom filters support in progress now.
+There are multiple ways to organize your query, using chaining calls, or custom filters.
 
 - Chain calls
 ```ruby
-PeopleQuery.new.search('hi', operator: :or).term(age: 21).build # => es-ready query
+PeopleQuery.new.queries.multi_match('hi', operator: :or).filters.term(age: 21).build # => returns hash
+Query.new.queries./queries-chain/.filters./filters-chain/
 ```
+
 - Class methods
+
 ```ruby
 class PeopleQuery < Elasticquery::Base
   filtered do |params|
-     range :age, lte: prepare_age(params[:max_age])
+    filters do
+      range :age, lte: prepare_age(params[:max_age])
+    end
   end
 
   protected
@@ -68,95 +173,71 @@ class PeopleQuery < Elasticquery::Base
     param.to_i
   end
 end
-PeopleQuery.build(max_age: '42') # => es-ready
+PeopleQuery.build(max_age: '42') # => result
 ```
+
 - Multiple `filtered` blocks
+
 ```ruby
 class ChildQuery < Elasticquery::Base
   filtered do |params|
-    term :'category.id' => params[:category_id]
+    filters do
+      term :'category.id' => params[:category_id]
+    end
   end
 
   filtered do |params|
-    term :'author.name' => User.find(params[:user_id]).name
+    filters do
+      term :'author.id' => User.find(params[:user_id]).name
+    end
   end
 end
-ChildQuery.build({user_id: 1, category_id: 14}) => # ;)
-
+ChildQuery.build({user_id: 1, category_id: 14}) => returns both user and category filters
 ```
+
 - Query inheritance
+
 ```ruby
 class ParentQuery < Elasticquery::Base
   filtered do |params|
-    term :'category.id' => params[:category_id]
+    filters do
+      term :'category.id' => params[:category_id]
+    end
   end
 end
 
 class ChildQuery < ParentQuery
   filtered do |params|
-    term :'author.name' => User.find(params[:user_id]).name
+    filters do
+      term :'author.id' => User.find(params[:user_id]).name
+    end
   end
 end
 
 ChildQuery.build({user_id: 1, category_id: 14}) => # the same as in previous example
 ```
 
-### Usage
-#### term
-
-```ruby
-# Simple one term filter
-term category: 'Rock'
-
-# Multiple filters joined by AND condition
-term category: 'Soul', user: 'Aaron'
-
-# Term exclusion
-term.not category: 'Rap'
-
-# Blank values are skipped. This query returns all records
-term name: " "
-```
+- Elasticsearch::Model support with `es` shortcut
 
-#### search (multimatch)
 ```ruby
-# Simple all fields search in your index
-search 'developers'
-
-# The same as above
-search 'developers', fields: "_all", operator: "and", type: "best_fields"
-
-# Configure fields
-search 'Jordan', fields: ['first_name', 'last_name'], operator: "or"
+class Article
+  include Elasticsearch::Model
+  extend Elasticquery::Es
+end
 
-# Blank values are skipped. This query returns all records
-search ''
+Article.es.filters.term(user_id: 12).with("published_at").queries.search("Verge").results # => collection of "hits"
+Article.es.filters.term(user_id: 12).with("published_at").queries.search("Verge").records # => collection of records from db
 ```
 
-#### range
-```ruby
-# One side range
-range :age, gte: 18
-
-# Double sides range
-range :volume, gte: 1, lte: 100
-
-# Range exclusion
-range.not :size, gte: 32, lte: 128
-
-# Blank values are skipped. This query returns all records
-range.not :age, lte: ' ', gte: nil
-
-# _cache and execution options support
-range :volume, gte: 1, lte: 100, _cache: true, execution: "fielddata"
-```
 [elasticsearch_rails]: https://github.com/elasticsearch/elasticsearch-rails
 [demo]: http://elasticquery-demo.herokuapp.com
 [bundler]: http://bundler.io/
 [rubygems]: https://rubygems.org/
 [es_term]: http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-term-filter.html
+[es_terms]: http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-terms-filter.html
+[es_not]: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-not-filter.html
+[es_exists]: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-filter.html
+[es_missing]: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-missing-filter.html
 [es_search]: http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html
 [es_range]: http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-range-query.html
-[term_examples]: #
-[search_examples]: #
-[range_examples]: #
+[elastic_query_dsl]: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html

data/Rakefile

@@ -1,21 +1,13 @@
 require "bundler/gem_tasks"
 require 'rake/testtask'
-require 'yard'
 
 desc "Run unit tests"
 Rake::TestTask.new do |t|
   t.libs << 'lib'
   t.libs << 'test'
-  t.pattern = "test/**/*_test.rb"
+  t.pattern = "test/**/**_test.rb"
   # t.verbose = true
   # t.warning = false
 end
 
-desc "Generate docs"
-YARD::Rake::YardocTask.new do |t|
-  t.files   = ['lib/**/*.rb']
-  t.options = ['--any', '--extra', '--opts']
-  t.stats_options = ['--list-undoc']
-end
-
 task default: :test

data/elasticquery.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Powerful and flexible elasticsearch query factory for you ruby application}
   spec.homepage      = "https://github.com/caulfield/elasticquery"
   spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.0.0"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -19,12 +20,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport"
-  spec.add_dependency "deep_merge"
 
   spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "yard"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-reporters"
   spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "elasticsearch-model"
 end

data/lib/elasticquery.rb

@@ -3,4 +3,5 @@ require "elasticquery/version"
 # Base gem module
 module Elasticquery
   autoload :Base, "elasticquery/base"
+  autoload :Es, "elasticquery/es"
 end

data/lib/elasticquery/base.rb

@@ -7,72 +7,30 @@ module Elasticquery
   class Base
     include Elasticquery::Builder
 
-    class_attribute :filters
+    class_attribute :rules
     attr_reader :params, :query
 
-    self.filters = []
+    self.rules = []
 
-    # Define params processor for es query.
-    #
-    # @note Multiple filtered blocks can be defined.
-    #
-    # @yield [params] Block with defined filters for passed yield param processing
-    #
-    # @yieldparam [Hash] passed params to processing
-    #
-    # @example query builder for id
-    #   class PostQuery < Elasticquery::Base
-    #     filtered do |params|
-    #       term "id" => params[:id]
-    #     end
-    #   end
     def self.filtered(&block)
-      self.filters += [block]
+      self.rules += [block]
     end
 
-    # Is your object can process params to elasticqueriable.
-    #
-    # @return [Boolean]
-    #
-    # @example 
-    #   class EmptyQuery < Elasticquery::Base
-    #   end
-    #   EmptyQuery.new.filterable? #=> false
-    #
-    # @example
-    #   class PostQuery < Elasticquery::Base
-    #     filtered { |params| true }
-    #   end
-    #   PostQuery.new.filterable? #=> true
     def filterable?
-      filters.any?
+      rules.any?
     end
 
-    # Create new query objects with built empty query.
     def initialize(params = {})
       @params = params
       @query = Query.new
     end
 
-    # Build elasticquery query using defined filters.
-    #
-    # @example
-    #   query.build # => { query: { match_all: {} }
-    #
-    # @return [Hash] elasticqueriable hash
     def build
-      filters.each { |filter| instance_exec @params, &filter }
+      @namespace = nil
+      rules.each { |rule| instance_exec @params, &rule }
       query.to_hash
     end
 
-    # Build elasticquery query using defined filters.
-    #
-    # @example
-    #   query.build # => { query: { match_all: {} }
-    #
-    # @see Elasticquery::Base#build
-    #
-    # @return [Hash] elasticqueriable hash
     def self.build(params = {})
       new(params).build
     end