gum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af0f69b2b0a93befee806dd4f19132462587d70c
+  data.tar.gz: 2082ef791cbfc27fb14c7e5d3f0499196b7c444c
+SHA512:
+  metadata.gz: 5083d26be62d07e05692d58ecd7f7a856e3a26aa095278537714df1668c10d39641e2d63130b8c9ee1b5fa067efa062a5753238323e13a048519394f7c2e62a5
+  data.tar.gz: 311fe5200a41c92e50c32420cb102243c85618e0a4a6a82ae9faba979081b859c204f8206b9df22fad883b8b8c5b24ab8253dbedf299298e9c68101d3d013ec8

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Anton Sozontov
+
+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,41 @@
+# Gum
+
+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/gum`. 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 'gum'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gum
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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]/gum.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'gum'
+
+# 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

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/gum.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gum'
+  spec.version       = Gum::VERSION
+  spec.authors       = ['Anton Sozontov']
+  spec.email         = ['a.sozontov@gmail.com']
+
+  spec.summary       = 'Search DSL on top of chewy gem'
+  spec.description   = %q{Gum provides simple DSL for searching in your Elasticsearch}
+  spec.homepage      = 'https://github.com/qwiqer/gum'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  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.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_dependency 'activesupport', '>= 3.2'
+  spec.add_dependency 'chewy', '~> 0.8.4'
+end

data/lib/gum.rb

@@ -0,0 +1,12 @@
+require 'gum/version'
+
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/hash/compact'
+
+require 'gum/coerce'
+require 'gum/filters'
+require 'gum/search'
+
+module Gum
+end

data/lib/gum/coerce.rb

@@ -0,0 +1,51 @@
+module Gum
+  module Coerce
+    FALSE_VALUES = [false, 0, '0', 'f', 'F', 'false', 'FALSE'].to_set
+
+    module_function
+
+    def range(attr, params)
+      key_from = :"#{attr}_from"
+      key_to = :"#{attr}_to"
+
+      return unless params.values_at(key_from, key_to).all?
+
+      yield(gte: params[key_from], lte: params[key_to])
+    end
+
+    def term(attr, params)
+      return if params[attr].blank?
+
+      yield params[attr]
+    end
+
+    def terms(attr, params)
+      return if params[attr].blank?
+
+      if params[attr].is_a?(Array)
+        yield params[attr]
+      elsif params[attr].is_a?(String)
+        yield params[attr].split(',')
+      else
+        raise ArgumentError, 'Terms should be either Array or String'
+      end
+    end
+
+    def exists(attr, params)
+      return if params[attr].eql?('')
+
+      yield !FALSE_VALUES.include?(params[attr])
+    end
+
+    def split(attr, params, separator: '-', default: nil)
+      return if params[attr].blank?
+
+      value, option = params[attr].split(separator, 2)
+      option ||= default.presence
+
+      return if value.blank? || option.blank?
+
+      yield value, option
+    end
+  end
+end

data/lib/gum/filters.rb

@@ -0,0 +1,91 @@
+module Gum
+  module Filters
+    module_function
+
+    def range(attr, flags = {})
+      lambda do |params|
+        attr_from = params["#{attr}_from"]
+        attr_to = params["#{attr}_to"]
+        return if attr_from.blank? && attr_to.blank?
+        Coerce.range(attr, params) do |value|
+          { range: { attr => value.update(flags) } }
+        end
+      end
+    end
+
+    def term(attr, flags = {})
+      lambda do |params|
+        Coerce.term(attr, params) do |value|
+          if flags[:boost]
+            { term: { attr => { value: value, boost: flags[:boost] } } }
+          else
+            { term: { attr => value }.update(flags) }
+          end
+        end
+      end
+    end
+
+    def terms(attr, _flags = {})
+      lambda do |params|
+        Coerce.terms(attr, params) do |value|
+          { terms: { attr => value } }
+        end
+      end
+    end
+
+    def exists(attr, _flags = {})
+      lambda do |params|
+        Coerce.exists(attr, params) do |value|
+          if value
+            { exists: { field: attr } }
+          else
+            { bool: { must_not: { exists: { field: attr } } } }
+          end
+        end
+      end
+    end
+
+    def prefix(attr, flags = {})
+      lambda do |params|
+        Coerce.term(attr, params) do |value|
+          { prefix: { attr => value }.update(flags) }
+        end
+      end
+    end
+
+    def wildcard(attr, flags = {})
+      lambda do |params|
+        Coerce.term(attr, params) do |value|
+          { wildcard: { attr => value }.update(flags) }
+        end
+      end
+    end
+
+    def regexp(attr, flags = {})
+      lambda do |params|
+        Coerce.term(attr, params) do |value|
+          { regexp: flags.update(attr => value) }
+        end
+      end
+    end
+
+    def fuzzy(attr, separator: '_', **flags)
+      lambda do |params|
+        Coerce.split(attr, params, separator: separator, default: flags[:fuzziness]) do |value, fuzziness|
+          { fuzzy: { attr => { value: value, fuzziness: fuzziness }.update(flags) } }
+        end
+      end
+    end
+
+    def default_range_result(attr_from, attr_to)
+      {
+        range: {
+          attr => {
+            gte: attr_from,
+            lte: attr_to
+          }
+        }
+      }
+    end
+  end
+end

data/lib/gum/search.rb

@@ -0,0 +1,93 @@
+module Gum
+  class Search
+    class_attribute :type
+    class_attribute :scope
+    class_attribute :fields
+    class_attribute :filters
+    class_attribute :orders
+    class_attribute :query_param
+
+    self.fields = Set.new
+    self.filters = {}
+    self.orders = {}
+
+    # @param [Chewy::Type] type
+    def self.use(type)
+      self.type = type
+    end
+
+    def self.scope(&block)
+      self.scope = block
+    end
+
+    def self.searchable(*attrs)
+      self.fields += attrs
+    end
+
+    def self.query(attr)
+      self.query_param = attr
+    end
+
+    Filters.singleton_methods.each do |method|
+      define_singleton_method method do |*attrs|
+        options = attrs.extract_options!
+        attrs.each do |attr|
+          filters[attr] = Filters.public_send(method, attr, options)
+        end
+      end
+    end
+
+    def self.order_by(*attrs)
+      attrs.each do |attr|
+        orders[attr] =
+          lambda do |params|
+            Coerce.split(attr, params) do |field, direction|
+              { field => direction }
+            end
+          end
+      end
+    end
+
+    def initialize(params)
+      @params = params
+      @sort_params = @params[:sort].split(',') if @params[:sort]
+      @q = params[query_param]
+    end
+
+    def compile_filters
+      filters.map do |_, proc|
+        proc.call(@params)
+      end.compact
+    end
+
+    def compile_orders
+      if @sort_params
+        self.orders = {}
+        @sort_params.each do |attr|
+          self.class.order_by(attr)
+        end
+      end
+      orders.map do |attr, proc|
+        proc.call(attr)
+      end.compact
+    end
+
+    def search
+      type.query(query).filter(compile_filters).order(compile_orders).load(scope: scope)
+    rescue Elasticsearch::Transport::Transport::Errors::BadRequest => e
+      @error = e.message.match(/QueryParsingException\[([^;]+)\]/).try(:[], 1)
+      type.none
+    end
+
+    def query
+      return {} unless @q.present?
+      {
+        query_string: {
+          fields: fields.to_a,
+          query: @q,
+          default_operator: 'and'
+        }
+      }
+    end
+  end
+end

data/lib/gum/version.rb

@@ -0,0 +1,3 @@
+module Gum
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: gum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anton Sozontov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: chewy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+description: Gum provides simple DSL for searching in your Elasticsearch
+email:
+- a.sozontov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gum.gemspec
+- lib/gum.rb
+- lib/gum/coerce.rb
+- lib/gum/filters.rb
+- lib/gum/search.rb
+- lib/gum/version.rb
+homepage: https://github.com/qwiqer/gum
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Search DSL on top of chewy gem
+test_files: []