elasticsearch_query 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e046e13523ec5f641a624c51a7676c0407e53985
+  data.tar.gz: 5049e0aea93d2b18077b63c6c7af875eadd7568d
+SHA512:
+  metadata.gz: 1c597f1a86af453cd714ccb25c0e67da3db35875162caca2b6a66f0d186815192175c2429f0cf4d6f8528b588b4580ebf0f42183479a4b65847147d3b041d35a
+  data.tar.gz: 380550d41d26078648f5ad92133d5a662f2ee5158dfc73464846c7f6167a1718be51584c9356b18cf3a138ec14b577323688bd459d557c90bcceb6e36360ed04

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.3
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at gaorlov@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in elasticsearch_query.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    elasticsearch_query (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    docile (1.3.1)
+    json (2.1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  elasticsearch_query!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  simplecov
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Greg Orlov
+
+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,43 @@
+# ElasticsearchQuery
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/elasticsearch_query`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'elasticsearch_query'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install elasticsearch_query
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/elasticsearch_query. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ElasticsearchQuery project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/elasticsearch_query/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "elasticsearch_query"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/elasticsearch_query.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "elasticsearch_query/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "elasticsearch_query"
+  spec.version       = ElasticsearchQuery::VERSION
+  spec.authors       = ["Greg Orlov"]
+  spec.email         = ["gaorlov@gmail.com"]
+
+  spec.summary       = "Elasticsearch Query from Rails params"
+  spec.description   = "Rails params parser that converts the prams hash into an Elasticsearch query"
+  spec.homepage      = "https://github.com/gaorlov/elasticsearch_query"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "simplecov"
+end

data/lib/elasticsearch_query.rb

@@ -0,0 +1,13 @@
+require "elasticsearch_query/version"
+
+module ElasticsearchQuery
+  autoload :Filter,           'elasticsearch_query/filter'
+  autoload :Filters,          'elasticsearch_query/filters'
+  autoload :FilterFormatter,  'elasticsearch_query/filter_formatter'
+  autoload :Query,            'elasticsearch_query/query'
+  autoload :Sort,             'elasticsearch_query/sort'
+
+  def self.from_params( params = {} )
+    Query.new( params )
+  end
+end

data/lib/elasticsearch_query/filter.rb

@@ -0,0 +1,18 @@
+module ElasticsearchQuery
+  class Filter
+    def initialize( name, value )
+      @name  = name
+      @value = value
+    end
+
+    def to_hash
+      formatter_class.new( @name, @value ).to_hash
+    end
+
+    private
+
+    def formatter_class
+      @formatter_class ||= FilterFormatter.formatter_for( @value )
+    end
+  end
+end

data/lib/elasticsearch_query/filter_formatter.rb

@@ -0,0 +1,13 @@
+module ElasticsearchQuery
+  module FilterFormatter
+    autoload :Base,  'elasticsearch_query/filter_formatter/base'
+    autoload :Match, 'elasticsearch_query/filter_formatter/match'
+    autoload :Range, 'elasticsearch_query/filter_formatter/range'
+
+    class << self
+      def formatter_for( value )
+        !!value.match( /\.\./ ) ? FilterFormatter::Range : FilterFormatter::Match
+      end
+    end
+  end
+end

data/lib/elasticsearch_query/filter_formatter/base.rb

@@ -0,0 +1,14 @@
+module ElasticsearchQuery
+  module FilterFormatter
+    class Base
+      def initialize( name, value )
+        @name  = name
+        @value = value
+      end
+
+      def to_hash
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/elasticsearch_query/filter_formatter/match.rb

@@ -0,0 +1,9 @@
+module ElasticsearchQuery
+  module FilterFormatter
+    class Match < Base
+      def to_hash
+        { match: { @name => @value } }
+      end
+    end
+  end
+end

data/lib/elasticsearch_query/filter_formatter/range.rb

@@ -0,0 +1,49 @@
+module ElasticsearchQuery
+  module FilterFormatter
+    class Range < Base
+      INFINITY = 'inf'.freeze
+      NEGATIVE_INFINITY = 'neginf'.freeze
+
+      def to_hash
+        return nil if all_the_values?
+
+        range = {}.tap do |range|
+          range[ :gte ] = beginning unless negative_infinity?( beginning )
+          range[ :lt ]  = ending    unless infinity?( ending )
+        end
+
+        { range: { @name => range } }
+      end
+
+      private
+
+      def range
+        @range ||= self.class.parser.new( @value ).parse
+      end
+
+      def beginning
+        @beginning ||= range.first
+      end
+
+      def ending
+        @ending ||= range.last
+      end
+
+      def all_the_values?
+        infinity?( ending ) && negative_infinity?( beginning )
+      end
+
+      def infinity?( value )
+        value == INFINITY
+      end
+
+      def negative_infinity?( value )
+        value == NEGATIVE_INFINITY
+      end
+
+      class << self
+        attr_accessor :parser
+      end
+    end
+  end
+end

data/lib/elasticsearch_query/filters.rb

@@ -0,0 +1,25 @@
+module ElasticsearchQuery
+  class Filters
+    def initialize( params )
+      @params = params
+    end
+
+    def to_hash
+      if matches.length == 1
+        matches.first
+      else
+        { bool: { must: matches } }
+      end
+    end
+
+    private
+
+    def matches
+      @filters ||= begin
+        @params.fetch( :filter, {} ).each_with_object( [] ) do | ( field, value ), arr |
+          arr << Filter.new( field, value ).to_hash
+        end.compact
+      end
+    end
+  end
+end

data/lib/elasticsearch_query/query.rb

@@ -0,0 +1,45 @@
+module ElasticsearchQuery
+  class Query
+    def initialize( params )
+      if params.respond_to? :with_indifferent_acess
+        @params = params.with_indifferent_acess
+      else
+        @params = params
+      end
+    end
+
+    def sort
+      @_sort ||= Sort.new @params
+    end
+
+    def filters
+      @_filters ||= Filters.new @params
+    end
+
+    def paginator
+      @_paginator ||= self.class.paginator_class.new @params
+    end
+
+    def to_hash
+      @hash ||= begin
+        base_query
+          .merge sort.to_hash
+          .merge paginator.to_hash
+      end
+    end
+
+    def to_count_hash
+      base_query
+    end
+
+    private
+
+    def base_query
+      @base_query ||= { query: filters.to_hash }
+    end
+
+    class << self
+      attr_accessor :paginator_class
+    end
+  end
+end

data/lib/elasticsearch_query/sort.rb

@@ -0,0 +1,30 @@
+module ElasticsearchQuery
+  class Sort
+    def initialize( params = {}, default = "" )
+      @params  = params
+      @default = default
+    end
+
+    def to_hash
+      return {} if sorts&.empty?
+      if sorts.length == 1
+        { sort: sorts.first }
+      else
+        { sort: sorts }
+      end
+    end
+
+    private
+
+    def sorts
+      @sorts ||= begin
+        sorts = @params.fetch( :sort, @default ).split(',')
+
+        sorts.each_with_object([]) do |field, arr|
+          desc, field   = field.match(/^([-_])?(\w+)$/i)[1..2]
+          arr << { field => desc&.empty? ? :asc : :desc }
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch_query/version.rb

@@ -0,0 +1,3 @@
+module ElasticsearchQuery
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: elasticsearch_query
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Greg Orlov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails params parser that converts the prams hash into an Elasticsearch
+  query
+email:
+- gaorlov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- elasticsearch_query.gemspec
+- lib/elasticsearch_query.rb
+- lib/elasticsearch_query/filter.rb
+- lib/elasticsearch_query/filter_formatter.rb
+- lib/elasticsearch_query/filter_formatter/base.rb
+- lib/elasticsearch_query/filter_formatter/match.rb
+- lib/elasticsearch_query/filter_formatter/range.rb
+- lib/elasticsearch_query/filters.rb
+- lib/elasticsearch_query/query.rb
+- lib/elasticsearch_query/sort.rb
+- lib/elasticsearch_query/version.rb
+homepage: https://github.com/gaorlov/elasticsearch_query
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Elasticsearch Query from Rails params
+test_files: []