mastico 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 205e8a8cf46ddea34bb51b18aac1cb1598b50e72
+  data.tar.gz: 52aaa582fc56299a0b304b2367cc897375e3787a
+SHA512:
+  metadata.gz: 6b4fa50b5278ad53a9d8215efa07d53a6b5658b8ecd70d95a10687679879e33ceb7524976d3d3114a9e87318df09128db079cb59b5a86756135b937dc6023430
+  data.tar.gz: b385bb2c52e244029adbcddfdff64af685bce5beb4eccc8d8d4184e88112a82b589cbae4a2f6c90a57bf6afb7072f09f0324e6adf8fa4c280f1937a3d22607b8

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

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.14.5

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 m.manzo@cantierecreativo.net. 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mastico.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Matteo Manzo
+
+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,83 @@
+# Mastico
+
+Make common queries simple, and make **some** complex queries possible.
+
+
+## Why does this exists?
+
+Creating Elasticsearch queries requires a specialist or hours of comparing Stack Overflow posts.
+
+Chewy makes managing and updating indexes simple, but the query interface remains the same.
+
+## Example 1:
+
+Mastico creates queries based on a list of fields:
+
+```ruby
+query = FooIndex.query
+query = Mastico::Query.new(fields: [:title, description], query: "ciao").perform(query)
+```
+This creates a series of queries: word, prefix, infix and fuzzy match of the word `ciao` against the supplied fields.
+
+## Example 2:
+
+What if I want to block some words ("Stop words") of give ore weight to others?
+
+```ruby
+def weight(word)
+  case word
+  when "I"
+    0
+  else
+    1.0
+  end
+end
+
+query = Mastico::Query.new(fields: [:title, description], word_weight: method(:weight), query: "I like cheese").perform(query)
+```
+
+## Example 3:
+
+What if I don't want all the different types of matching?
+
+```ruby
+query = Mastico::Query.new(fields: {title: {boost: 4.0, types: [:term]} }, query: "Simple").perform(query)
+```
+This will return only the `term` type search for the attribute `title`.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mastico'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mastico
+
+## 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/cantierecreativo/mastico. 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](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 "mastico"
+
+# 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/lib/mastico.rb

@@ -0,0 +1,6 @@
+require "mastico/version"
+require "mastico/version"
+require "mastico/query"
+
+module Mastico
+end

data/lib/mastico/query.rb

@@ -0,0 +1,167 @@
+module Mastico
+  class Query
+    DEFAULT_OPTIONS = {
+      term_boost: 1.0,
+      prefix_boost: 0.7,
+      infix_boost: 0.4,
+      fuzzy_boost: 0.2,
+      minimum_term_length: 2,
+      minimum_prefix_length: 3,
+      minimum_infix_length: 3,
+      minimum_fuzzy_length: 5,
+      fuzziness: 4
+    }.freeze
+
+    QUERY_TYPES = [:term, :prefix, :infix, :fuzzy].freeze
+
+    attr_reader :query
+    attr_reader :fields
+    attr_reader :word_weight
+    attr_reader :options
+
+    def initialize(query:, fields:, word_weight: ->(_w) { 1.0 }, options: DEFAULT_OPTIONS)
+      @query = query
+      @fields = fields
+      @word_weight = word_weight
+      @options = options
+    end
+
+    def perform(scope)
+      parts ? scope.query(parts) : scope
+    end
+
+    private
+
+    def parts
+      clean = query.strip.gsub(/\s+/, ' ').downcase
+      terms = clean.split(" ")
+      term_parts = terms.map do |term|
+        weight = word_weight.call(term)
+        next nil if weight == 0.0
+        chewy_term_query(term: term, weight: weight)
+      end
+      term_parts = term_parts.compact
+      case term_parts.size
+      when 0
+        nil
+      when 1
+        term_parts[0]
+      else
+        # We have multiple words in the query -
+        # all of them **must** match
+        {bool: {must: term_parts}} # AND query
+      end
+    end
+
+    def chewy_term_query(term:, weight:)
+      parts = []
+      if term.length >= options[:minimum_term_length]
+        relevant_fields(:term).each do |field, field_boost|
+          parts << chewy_multi_match_term_query(
+            query: term,
+            fields: [field],
+            boost: options[:term_boost] * weight * field_boost
+          )
+        end
+      end
+      if term.length >= options[:minimum_prefix_length]
+        relevant_fields(:term).each do |field, field_boost|
+          parts << chewy_multi_match_prefix_query(
+            query: term,
+            fields: [field],
+            boost: options[:prefix_boost] * weight * field_boost
+          )
+        end
+      end
+      if term.length >= options[:minimum_infix_length]
+        relevant_fields(:term).each do |field, field_boost|
+          parts << chewy_multi_match_infix_query(
+            query: term,
+            fields: [field],
+            boost: options[:infix_boost] * weight * field_boost
+          )
+        end
+      end
+      if term.length >= options[:minimum_fuzzy_length]
+        relevant_fields(:term).each do |field, field_boost|
+          parts << chewy_multi_match_fuzzy_query(
+            query: term,
+            fields: [field],
+            boost: options[:fuzzy_boost] * weight * field_boost
+          )
+        end
+      end
+      parts.compact!
+
+      if parts.size > 0
+        {bool: {should: parts}} # OR
+      end
+    end
+
+    def relevant_fields(search_type)
+      if fields.is_a? Array
+        fields.map {|field| [field, 1]}.to_h
+      else
+        fields.select do |field, options|
+          if options[:types]
+            options[:types].include?(search_type)
+          else
+            true
+          end
+        end.map do |field, options|
+          [field, options.fetch(:boost, 1)]
+        end.to_h
+      end
+    end
+
+    def chewy_multi_match_term_query(query:, fields:, boost: nil)
+      return nil if fields.empty?
+
+      lower = query.downcase
+      chewy_multi_match_query(
+        type: :term, query: lower, fields: fields, options: {boost: boost}
+      )
+    end
+
+    def chewy_multi_match_prefix_query(query:, fields:, boost: nil)
+      return nil if fields.empty?
+
+      lower = query.downcase
+      chewy_multi_match_query(
+        type: :prefix, query: lower, fields: fields, options: {boost: boost}
+      )
+    end
+
+    def chewy_multi_match_infix_query(query:, fields:, boost: nil)
+      return nil if fields.empty?
+
+      lower = query.downcase
+      wildcard = "*#{lower}*"
+      chewy_multi_match_query(
+        type: :wildcard, query: wildcard, fields: fields, options: {boost: boost}
+      )
+    end
+
+    def chewy_multi_match_fuzzy_query(query:, fields:, boost: nil)
+      return nil if fields.empty?
+
+      lower = query.downcase
+      chewy_multi_match_query(
+        type: :fuzzy, query: lower, fields: fields,
+        options: {boost: boost, fuzziness: options[:fuzziness]}
+      )
+    end
+
+    def chewy_multi_match_query(type:, query:, fields:, options: {})
+      opts = options.dup
+      boost = opts.delete(:boost)
+      should = fields.map do |f|
+        match = {value: query}.merge(opts)
+        match[:boost] = boost if boost
+        field = {type => {f => match}}
+        field
+      end
+      {bool: {should: should, minimum_should_match: 0}} # OR over fields
+    end
+  end
+end

data/lib/mastico/version.rb

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

data/mastico.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mastico/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mastico"
+  spec.version       = Mastico::VERSION
+  spec.authors       = ["Matteo Manzo"]
+  spec.email         = ["m.manzo@cantierecreativo.net"]
+
+  spec.summary       = "A chewy helper"
+  spec.description   = "Helper to simplify search queries with Chewy"
+  spec.homepage      = "https://github.com/cantierecreativo/mastico"
+  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.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: mastico
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matteo Manzo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+description: Helper to simplify search queries with Chewy
+email:
+- m.manzo@cantierecreativo.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mastico.rb
+- lib/mastico/query.rb
+- lib/mastico/version.rb
+- mastico.gemspec
+homepage: https://github.com/cantierecreativo/mastico
+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: A chewy helper
+test_files: []