mastico 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 10574d0b9586998f4d7fd7543d5c7ef614e28a29
-  data.tar.gz: bd2cad87ba6821b050e3483d857acdf2c4f1cd8a
+SHA256:
+  metadata.gz: a71e46abdec31f568afd7a0e617dbba73df92acd7b02a99125a247ba6e9bb6ca
+  data.tar.gz: 8b583babd44479e1adf3a5e7a65fbacdd67cc6ece8df3d990505da44ef05d7e3
 SHA512:
-  metadata.gz: 3899db6f982100299f90d94db7fb8e81c6b97513906ef3aaa2247bb1859cfaee7341341b293892e7c41613e69701ad458cf43315afd26867c72cdd2bf2fe44a1
-  data.tar.gz: 6133e753e4409c3fe2e9482d02b198a99f4eae19acdfb82bce766ddc685293ba25b4de95d678624c8420238142116762a646b79ef3957ee93d708a5033c35e6a
+  metadata.gz: a3493cf5c54e66b30340e01d63328940e7890083fd955d7a6f832236821a4967ead5a0cb75735206ce4f8ee7052719e3e5711fcec8c4fdff416a4313b542b2be
+  data.tar.gz: '04298599aa136610a449f47e43f3dd97430caa75fc7a438afcd3406f4b0e50c2965bd3a1df1e287a431f0314a9c0c3806a3903adcced83e4788fa53330be9615'

data/README.md

@@ -1,13 +1,16 @@
+![Mastico Logo](https://raw.github.com/cantierecreativo/mastico/master/mastico.gif)
+
 # Mastico
 
 Make common queries simple, and make **some** complex queries possible.
 
+## Why does this exist?
 
-## Why does this exists?
-
-Creating Elasticsearch queries requires a specialist or hours of comparing Stack Overflow posts.
+Using a basic client, creating Elasticsearch queries requires specialist
+knowledge or hours of comparing Stack Overflow posts.
 
-Chewy makes managing and updating indexes simple, but the query interface remains the same.
+Chewy makes managing and updating indexes simple, but the query interface
+remains the same.
 
 ## Example 1:
 
@@ -15,25 +18,33 @@ Mastico creates queries based on a list of fields:
 
 ```ruby
 query = FooIndex.query
-query = Mastico::Query.new(fields: [:title, description], query: "ciao").apply(query)
+query = Mastico::Query.new(
+  fields: [:title, :description], query: "ciao"
+).apply(query)
 ```
-This creates a series of queries: word, prefix, infix and fuzzy match of the word `ciao` against the supplied fields.
+
+This creates a series of queries: `word`, `prefix`, `infix` and `fuzzy` matches
+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?
+What if I want to block some words ("Stop words") of give more weight to others?
 
 ```ruby
 def weight(word)
   case word
-  when "I"
+  when "information"
     0
   else
     1.0
   end
 end
 
-query = Mastico::Query.new(fields: [:title, description], word_weight: method(:weight), query: "I like cheese").apply(query)
+query = Mastico::Query.new(
+  fields: [:title, description],
+  word_weight: method(:weight),
+  query: "Information is power"
+).apply(query)
 ```
 
 ## Example 3:
@@ -41,10 +52,21 @@ query = Mastico::Query.new(fields: [:title, description], word_weight: method(:w
 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").apply(query)
+query = Mastico::Query.new(
+  fields: {title: {boost: 4.0, types: [:word]} },
+  query: "Simple"
+).apply(query)
 ```
-This will return only the `term` type search for the attribute `title`.
 
+This will return only the `word` type search (i.e. whole words) for the
+attribute `title`.
+
+The types of matching that are available are:
+
+* `:word` - whole words,
+* `:prefix` - the beginning of words,
+* `:infix` - some part of a word,
+* `:fuzzy` - similar words.
 
 ## Installation
 
@@ -64,16 +86,22 @@ Or install it yourself as:
 
 ## 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.
+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).
+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.
-
+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/lib/mastico.rb

@@ -1,5 +1,4 @@
 require "mastico/version"
-require "mastico/version"
 require "mastico/query"
 
 module Mastico

data/lib/mastico/query.rb

@@ -1,18 +1,18 @@
 module Mastico
   class Query
     DEFAULT_OPTIONS = {
-      term_boost: 1.0,
+      word_boost: 1.0,
       prefix_boost: 0.7,
       infix_boost: 0.4,
       fuzzy_boost: 0.2,
-      minimum_term_length: 2,
+      minimum_word_length: 2,
       minimum_prefix_length: 3,
       minimum_infix_length: 3,
       minimum_fuzzy_length: 5,
       fuzziness: 4
     }.freeze
 
-    QUERY_TYPES = [:term, :prefix, :infix, :fuzzy].freeze
+    QUERY_TYPES = [:word, :prefix, :infix, :fuzzy].freeze
 
     attr_reader :query
     attr_reader :fields
@@ -37,63 +37,63 @@ module Mastico
       @parts ||=
         begin
           clean = query.strip.gsub(/\s+/, ' ').downcase
-          terms = clean.split(" ")
-          term_parts = terms.map do |term|
-            weight = word_weight.call(term)
+          words = clean.split(" ")
+          word_subqueries = words.map do |word|
+            weight = word_weight.call(word)
             next nil if weight == 0.0
-            chewy_term_query(term: term, weight: weight)
+            chewy_term_query(word: word, weight: weight)
           end
-          term_parts = term_parts.compact
-          case term_parts.size
+          word_subqueries = word_subqueries.compact
+          case word_subqueries.size
           when 0
             nil
           when 1
-            term_parts[0]
+            word_subqueries[0]
           else
             # We have multiple words in the query -
             # all of them **must** match
-            {bool: {must: term_parts}} # AND query
+            {bool: {must: word_subqueries}} # AND query
           end
         end
     end
 
-    def chewy_term_query(term:, weight:)
+    def chewy_term_query(word:, 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,
+      if word.length >= options[:minimum_word_length]
+        relevant_fields(:word).each do |field, field_boost|
+          parts << chewy_multi_match_word_query(
+            query: word,
             fields: [field],
-            boost: options[:term_boost] * weight * field_boost
+            boost: options[:word_boost] * weight * field_boost
           )
         end
       end
 
-      if term.length >= options[:minimum_prefix_length]
+      if word.length >= options[:minimum_prefix_length]
         relevant_fields(:prefix).each do |field, field_boost|
           parts << chewy_multi_match_prefix_query(
-            query: term,
+            query: word,
             fields: [field],
             boost: options[:prefix_boost] * weight * field_boost
           )
         end
       end
 
-      if term.length >= options[:minimum_infix_length]
+      if word.length >= options[:minimum_infix_length]
         relevant_fields(:infix).each do |field, field_boost|
           parts << chewy_multi_match_infix_query(
-            query: term,
+            query: word,
             fields: [field],
             boost: options[:infix_boost] * weight * field_boost
           )
         end
       end
 
-      if term.length >= options[:minimum_fuzzy_length]
+      if word.length >= options[:minimum_fuzzy_length]
         relevant_fields(:fuzzy).each do |field, field_boost|
           parts << chewy_multi_match_fuzzy_query(
-            query: term,
+            query: word,
             fields: [field],
             boost: options[:fuzzy_boost] * weight * field_boost
           )
@@ -109,7 +109,7 @@ module Mastico
 
     def relevant_fields(search_type)
       if fields.is_a? Array
-        fields.map {|field| [field, 1]}.to_h
+        fields.map { |field| [field, 1] }.to_h
       else
         fields.select do |field, options|
           if options[:types]
@@ -123,7 +123,7 @@ module Mastico
       end
     end
 
-    def chewy_multi_match_term_query(query:, fields:, boost: nil)
+    def chewy_multi_match_word_query(query:, fields:, boost: nil)
       return nil if fields.empty?
 
       lower = query.downcase

data/lib/mastico/version.rb

@@ -1,3 +1,3 @@
 module Mastico
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mastico
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Matteo Manzo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-23 00:00:00.000000000 Z
+date: 2018-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,6 +87,7 @@ files:
 - lib/mastico/query.rb
 - lib/mastico/version.rb
 - mastico.gemspec
+- mastico.gif
 homepage: https://github.com/cantierecreativo/mastico
 licenses:
 - MIT
@@ -108,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A chewy helper