elasticquery 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c617336d69d42299b02a328f05fa72f498320844
+  data.tar.gz: 83f604e40b5c09af43cce4ce10b67b48d308ea39
+SHA512:
+  metadata.gz: 2ec816c91083db94db3028071bccb70fea89ded4e4fb629866b007e8e72aa8fbaaefdc885d735e18033b32b1a3337236822aabce4ad1172fd9f07f91129d61f7
+  data.tar.gz: a49a99f48a728848c36995306d6739ad30d78614460b5a655ba487646a085a7b704313824299a0fd65f224f09aeab559aefc63aaba2d4f89d3516035e6abee6b

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.2.0
+  - 2.1.0
+  - 2.0.0
+addons:
+  code_climate:
+    repo_token: d69d849c7542eec3fd29893f6935c0bff0947376440fec1a5098dc7afb69cad5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in elasticquery.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sergey Kuchmistov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,165 @@
+# Elasticquery
+
+[![Build Status](https://travis-ci.org/caulfield/elasticquery.svg?branch=master)](https://travis-ci.org/caulfield/elasticquery)
+[![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]
+
+## Instalation
+
+To install using [Bundler][bundler] grab the latest stable version:
+
+```ruby
+gem 'elasticquery'
+```
+To manually install `elasticquery` via [Rubygems][rubygems] simply gem install:
+
+```bash
+gem install elasticquery
+```
+
+## Getting Started
+### First instruction
+
+Elasticsearch was designed to be customized as you need to. Providing simple methods it allows you to build power and flexible form objects. For example:
+
+```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
+  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 
+```
+### 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]  
+
+#### Note! After first releases of elasticuqery it has scarce support of options and methods. Pull requests and issues with your ideas are welcome!
+
+### Extended instruction
+There are multiple ways to organize your query, using chaining calls, or custom filters. Better custom filters support in progress now.
+
+- Chain calls
+```ruby
+PeopleQuery.new.search('hi', operator: :or).term(age: 21).build # => es-ready query
+```
+- Class methods
+```ruby
+class PeopleQuery < Elasticquery::Base
+  filtered do |params|
+     range :age, lte: prepare_age(params[:max_age])
+  end
+
+  protected
+
+  def prepare_age(param)
+    param.to_i
+  end
+end
+PeopleQuery.build(max_age: '42') # => es-ready
+```
+- Multiple `filtered` blocks
+```ruby
+class ChildQuery < Elasticquery::Base
+  filtered do |params|
+    term :'category.id' => params[:category_id]
+  end
+
+  filtered do |params|
+    term :'author.name' => User.find(params[:user_id]).name
+  end
+end
+ChildQuery.build({user_id: 1, category_id: 14}) => # ;)
+
+```
+- Query inheritance
+```ruby
+class ParentQuery < Elasticquery::Base
+  filtered do |params|
+    term :'category.id' => params[:category_id]
+  end
+end
+
+class ChildQuery < ParentQuery
+  filtered do |params|
+    term :'author.name' => User.find(params[:user_id]).name
+  end
+end
+
+ChildQuery.build({user_id: 1, category_id: 14}) => # the same as in previous example
+```
+- Custom filter methods
+```ruby
+in progress...
+```
+
+- Custom filter classes
+```ruby
+in progress...
+```
+
+### 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'
+```
+
+#### 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"
+```
+
+#### 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
+```
+
+## Contributing
+1. I'm happy to see any method you can be part of this.
+
+
+[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_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]: #

data/Rakefile

@@ -0,0 +1,21 @@
+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.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

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'elasticquery/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "elasticquery"
+  spec.version       = Elasticquery::VERSION
+  spec.authors       = ["Sergey Kuchmistov"]
+  spec.email         = ["sergey.kuchmistov@gmail.com"]
+  spec.summary       = %q{Elasticsearch query builder.}
+  spec.description   = %q{Powerful and flexibal query factory for you elasticsearch&ruby application}
+  spec.homepage      = "https://github.com/caulfield/elasticquery"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+
+  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"
+end

data/lib/elasticquery.rb

@@ -0,0 +1,6 @@
+require "elasticquery/version"
+
+# Base gem module
+module Elasticquery
+  autoload :Base, 'elasticquery/base'
+end

data/lib/elasticquery/base.rb

@@ -0,0 +1,80 @@
+require 'active_support/core_ext/class/attribute'
+require 'elasticquery/query'
+require 'elasticquery/queries/all'
+
+# Base class for query builder. Superclass of your all builders
+module Elasticquery
+  class Base
+    include Elasticquery::Queries::All
+
+    class_attribute :filters
+    attr_reader :params, :query
+
+    self.filters = []
+
+    # 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]
+    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?
+    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 }
+      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
+  end
+end

data/lib/elasticquery/filters/base.rb

@@ -0,0 +1,18 @@
+module Elasticquery
+  module Filters
+    class Base
+
+      def valid?
+        true
+      end
+
+      def invalid?
+        !valid?
+      end
+
+      def dup_with(*args)
+        self.class.new *args
+      end
+    end
+  end
+end

data/lib/elasticquery/filters/not.rb

@@ -0,0 +1,30 @@
+require_relative 'base'
+
+module Elasticquery
+  module Filters
+    class Not < Base
+
+      def initialize(condition = {})
+        @condition = condition
+      end
+
+      def dup_with(*args)
+        raise StandardError, 'Cannot use Filters::Not twice'
+      end
+
+      def to_hash
+        condition = @condition
+        -> do
+          filter = filters.last.dup_with condition
+          if filter.valid?
+            subquery = filter.to_hash
+            q = subquery[:query][:filtered][:filter][:and]
+            {query: {filtered: {filter: {and: {not: {filter: q}}}}}}
+          else
+            {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticquery/filters/range.rb

@@ -0,0 +1,29 @@
+require_relative 'base'
+
+module Elasticquery
+  module Filters
+    class Range < Base
+
+      def initialize(field, gte: nil, lte: nil)
+        @field, @gte, @lte = field, gte, lte
+      end
+
+      def valid?
+        @gte || @lte
+      end
+
+      def to_hash
+        valid? ? {query: {filtered: {filter: {and: {range: range}}}}} : {}
+      end
+
+      private
+      
+      def range
+        {@field => {}}.tap do |r|
+          r[@field][:lte] = @lte unless @lte.nil?
+          r[@field][:gte] = @gte unless @gte.nil?
+        end
+      end
+    end
+  end
+end