autosuggest 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 305c68241ebeabdd7eca78f2bb1b4d3e7e1e430d
-  data.tar.gz: 797e7579646943ec7aa324f2f1c748d550914af0
+SHA256:
+  metadata.gz: bda23aeaee3abc15c45b52ddc2d64943de44a164f11d3a33de234171126b209c
+  data.tar.gz: de6f64ac9ceb628e55e275080a45ac8cf0f5605a5e80767350c264adc92266a6
 SHA512:
-  metadata.gz: d137ecf95fcdb4ab5271ad6be3f1cc4776411721a094093e84798a85938b91f92429cbb1090fdcb3bfc9e6e717b39a1197809d16dd79b81a56a53df88bb00bad
-  data.tar.gz: 52a264b4ebb28ef1786a3b9adfa6dff750f063d1eb92307113465a353becd64fd90e0a2b93f63cd81258a84dd998e8cf18e5204c0655c231c3bcf5ea92e1f342
+  metadata.gz: 9a7a317190aba2237a7b98b6b2cce8ed656eeb44f7c57edd6e19644700fd2c8268c5086201d44d0186f1cabd513e365d471ff2abc4e14d0963989cac55b676f1
+  data.tar.gz: d5dfe7b13390ef216d1f3ab614c4b6c83177d68ff4fef2545e0f34d92936f27cbd077fa44175393a487b6a398c216a51677add321521c97c4db9753e35c6bfbd

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.1.1 (2021-03-15)
+
+- Deprecated `blacklist_words` in favor of `block_words`
+
+## 0.1.0 (2015-06-20)
+
+- First release

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015-2021 Andrew Kane
+
+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

@@ -4,6 +4,16 @@ Generate autocomplete suggestions based on what your users search
 
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
 
+[![Build Status](https://github.com/ankane/autosuggest/workflows/build/badge.svg?branch=master)](https://github.com/ankane/autosuggest/actions)
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'autosuggest'
+```
+
 ## How It Works
 
 #### Start with the most popular queries
@@ -53,14 +63,12 @@ There are two ways to build the corpus, which can be used together.
   autosuggest.add_concept "brand", Brand.pluck(:name)
   ```
 
-#### Blacklist words
+#### Filter words
 
-[Profanity](https://github.com/tjackiw/obscenity/blob/master/config/blacklist.yml) is blacklisted by default.
-
-Add custom words with:
+[Profanity](https://github.com/tjackiw/obscenity/blob/master/config/blacklist.yml) is blocked by default. Add custom words with:
 
 ```ruby
-autosuggest.blacklist_words ["boom"]
+autosuggest.block_words ["boom"]
 ```
 
 #### Profit
@@ -71,9 +79,7 @@ Get suggestions with:
 autosuggest.suggestions
 ```
 
-Filter queries without results and you’re set.
-
-We also prefer to have someone manually approve them by hand.
+Filter queries without results and you’re set. We also prefer to have someone manually approve them by hand.
 
 ## Full Example
 
@@ -81,40 +87,24 @@ We also prefer to have someone manually approve them by hand.
 top_queries = Search.group("LOWER(query)")
                     .having("COUNT(DISTINCT user_id) >= 5")
                     .count("DISTINCT user_id")
+product_names = Product.pluck(:name)
+brand_names = Brand.pluck(:name)
 
 autosuggest = Autosuggest.new(top_queries)
-
-# create corpus with product names and brand names
-autosuggest.parse_words Product.pluck(:name)
-brand_names = Brand.pluck(:name)
+autosuggest.parse_words product_names
 autosuggest.add_concept "brand", brand_names
-
-# prefer brand names
 autosuggest.prefer brand_names
-
-# prevent false positives for duplicates
 autosuggest.not_duplicates [["straws", "straus"]]
+autosuggest.block_words ["boom"]
 
-# blacklist words
-autosuggest.blacklist_words ["boom"]
-
-# print suggestions
 puts autosuggest.pretty_suggestions
 # or
-p autosuggest.suggestions
-```
-
-## Installation
-
-Add this line to your application’s Gemfile:
-
-```ruby
-gem 'autosuggest'
+suggestions = autosuggest.suggestions
 ```
 
-## TODO
+## History
 
-- try Jaro-Winkler for duplicates
+View the [changelog](https://github.com/ankane/autosuggest/blob/master/CHANGELOG.md)
 
 ## Contributing
 
@@ -124,3 +114,12 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/autosuggest/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/autosuggest.git
+cd autosuggest
+bundle install
+bundle exec rake test
+```

data/lib/autosuggest.rb

@@ -1,14 +1,21 @@
-require "autosuggest/version"
-require "lingua/stemmer"
+# stdlib
+require "set"
 require "yaml" # for obscenity
+
+# dependencies
+require "lingua/stemmer"
 require "obscenity"
 
+# modules
+require "autosuggest/version"
+
 class Autosuggest
   def initialize(top_queries)
     @top_queries = top_queries
     @concepts = {}
     @words = Set.new
     @non_duplicates = Set.new
+    @blocked_words = Set.new
     @blacklisted_words = Set.new
     @preferred_queries = {}
     @profane_words = Set.new(Obscenity::Base.blacklist)
@@ -42,7 +49,14 @@ class Autosuggest
     end
   end
 
+  def block_words(words)
+    words.each do |word|
+      @blocked_words << word.downcase
+    end
+  end
+
   def blacklist_words(words)
+    warn "[autosuggest] blacklist_words is deprecated. Use block_words instead."
     words.each do |word|
       @blacklisted_words << word.downcase
     end
@@ -99,19 +113,20 @@ class Autosuggest
       # exclude misspellings that are not brands
       misspelling = @words.any? && misspellings?(query)
 
-      profane = blacklisted?(query, @profane_words)
-
-      blacklisted = blacklisted?(query, @blacklisted_words)
+      profane = blocked?(query, @profane_words)
+      blocked = blocked?(query, @blocked_words)
+      blacklisted = blocked?(query, @blacklisted_words)
 
       notes = []
       notes << "duplicate of #{duplicate}" if duplicate
       notes.concat(concepts)
       notes << "misspelling" if misspelling
       notes << "profane" if profane
+      notes << "blocked" if blocked
       notes << "blacklisted" if blacklisted
       notes << "originally #{original_query}" if original_query
 
-      {
+      result = {
         query: query,
         original_query: original_query,
         score: count,
@@ -119,9 +134,11 @@ class Autosuggest
         concepts: concepts,
         misspelling: misspelling,
         profane: profane,
-        blacklisted: blacklisted,
-        notes: notes
+        blocked: blocked
       }
+      result[:blacklisted] = blacklisted if @blacklisted_words.any?
+      result[:notes] = notes
+      result
     end
   end
 
@@ -144,9 +161,9 @@ class Autosuggest
     true
   end
 
-  def blacklisted?(query, blacklisted_words)
+  def blocked?(query, blocked_words)
     recurse(tokenize(query)).each do |terms|
-      return true if terms.any? { |t| blacklisted_words.include?(t) }
+      return true if terms.any? { |t| blocked_words.include?(t) }
     end
     false
   end
@@ -173,7 +190,7 @@ class Autosuggest
     str.to_s.downcase.split(" ")
   end
 
-  # from http://blog.lojic.com/2008/09/04/how-to-write-a-spelling-corrector-in-ruby/
+  # from https://blog.lojic.com/2008/09/04/how-to-write-a-spelling-corrector-in-ruby/
   LETTERS = ("a".."z").to_a.join + "'"
   def edits(word)
     n = word.length
@@ -189,14 +206,4 @@ class Autosuggest
   def normalize_query(query)
     tokenize(query.to_s.gsub("&", "and")).map { |q| Lingua.stemmer(q) }.sort.join
   end
-
-  # TODO remove ActiveSupport dependency
-
-  def singularize(str)
-    str.singularize
-  end
-
-  def pluralize(str)
-    str.pluralize
-  end
 end

data/lib/autosuggest/version.rb

@@ -1,3 +1,3 @@
 class Autosuggest
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autosuggest
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2015-06-20 00:00:00.000000000 Z
+date: 2021-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-stemmer
@@ -38,66 +38,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !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: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: 
-email:
-- andrew@chartkick.com
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Gemfile
+- CHANGELOG.md
+- LICENSE.txt
 - README.md
-- Rakefile
-- autosuggest.gemspec
 - lib/autosuggest.rb
 - lib/autosuggest/version.rb
 homepage: https://github.com/ankane/autosuggest
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,17 +61,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Generate autocomplete suggestions based on what your users search
 test_files: []
-has_rdoc: 

data/.gitignore

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

data/Gemfile

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

data/Rakefile

@@ -1,8 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-task default: :test
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.pattern = "test/**/*_test.rb"
-end

data/autosuggest.gemspec

@@ -1,26 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "autosuggest/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "autosuggest"
-  spec.version       = Autosuggest::VERSION
-  spec.authors       = ["Andrew Kane"]
-  spec.email         = ["andrew@chartkick.com"]
-
-  spec.summary       = "Generate autocomplete suggestions based on what your users search"
-  spec.homepage      = "https://github.com/ankane/autosuggest"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "ruby-stemmer"
-  spec.add_dependency "obscenity"
-
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest"
-end