autosuggest 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '083927cb6e763a26bad61351189dd1a1c1e66d31da0a4844635ec5440f4620d0'
-  data.tar.gz: 94245fc7eaeb98f54669b561311d9dee4ac43788f88cef3768a33891c8b530ad
+  metadata.gz: 3f04e20f21653bcc9a8941c6da1eddae7726cf775abea699b78022b64fec9e48
+  data.tar.gz: 7a5c362428558d17808310245d7cad1bdf693800419665d650ab9026e5aa8628
 SHA512:
-  metadata.gz: f20b852dfcb4cf4249b4c4b2a72e7f58c2c2b642a11b14b33e632ee934736c721d70bcd87f7b6e20659ba5e82f05ce679b69d0e5e72f3b4c64d8187078d2b8c3
-  data.tar.gz: 6e99a02d77dc1ea2cf06e0903d6adebbbe73579496de092efff471369226dfb917df9bd31cee7697bc2d0fcd9392cbe6393186a6c4a747b49a6b03cee348108a
+  metadata.gz: 62c38fb482638185c18dde9b0b4db1c9aa4deaa6e8f0fb4341220f61c28b218c51f79376b1080fb954982f0aa2b9a979b20b4212bfb704f73fe2e92be8b4373e
+  data.tar.gz: 84383dd6de2c654aefabe546f3c01335f906d5cfb517fd1890b26376ed9f482651b6e7e8d1b5082d120d228603b7b0002227b4293d2668c5de51a464aa831fa5

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.3 (2021-11-23)
+
+- Added model generator
+
 ## 0.1.2 (2021-11-22)
 
 - Added `filter` option to `suggestions` method

data/README.md

@@ -85,17 +85,90 @@ There are two ways to build the corpus, which can be used together.
 autosuggest.block_words ["boom"]
 ```
 
-#### Profit
+#### Generate suggestions
 
-Get suggestions with:
+Generate suggestions with:
 
 ```ruby
-autosuggest.suggestions(filter: true)
+suggestions = autosuggest.suggestions(filter: true)
+```
+
+#### Save suggestions
+
+Save suggestions in your database or another data store.
+
+With Rails, you can generate a simple model with:
+
+```sh
+rails generate autosuggest:suggestions
+rails db:migrate
+```
+
+And update suggestions with:
+
+```ruby
+now = Time.now
+records = suggestions.map { |s| s.slice(:query, :score).merge(updated_at: now) }
+Autosuggest::Suggestion.transaction do
+  Autosuggest::Suggestion.upsert_all(records, unique_by: :query)
+  Autosuggest::Suggestion.where("updated_at < ?", now).delete_all
+end
+```
+
+Leave out `unique_by` for MySQL, and use [activerecord-import](https://github.com/zdennis/activerecord-import) for upserts with Rails < 6.
+
+#### Show suggestions
+
+Use a JavaScript autocomplete library like [typeahead.js](https://github.com/twitter/typeahead.js) to show suggestions in the UI.
+
+If you only have a few thousand suggestions, it’s much faster to load them all at once instead of as a user types (eliminates network requests).
+
+With Rails, you can load all suggestions with:
+
+```ruby
+Autosuggest::Suggestion.order(score: :desc).pluck(:query)
 ```
 
-Filter queries without results and you’re set. We also prefer to have someone manually approve them by hand.
+And suggestions matching user input with:
 
-## Full Example
+```ruby
+input = params[:query]
+Autosuggest::Suggestion
+  .order(score: :desc)
+  .where("query LIKE ?", "%#{Autosuggest::Suggestion.sanitize_sql_like(input.downcase)}%")
+  .pluck(:query)
+```
+
+You can also cache suggestions for performance.
+
+```ruby
+Rails.cache.fetch("suggestions", expires_in: 5.minutes) do
+  Autosuggest::Suggestion.order(score: :desc).pluck(:query)
+end
+```
+
+#### Additional considerations
+
+You may want to have someone manually approve suggestions:
+
+```ruby
+Autosuggest::Suggestion.where(approved: true)
+```
+
+Or filter suggestions without results:
+
+```ruby
+Autosuggest::Suggestion.find_each do |suggestion|
+  suggestion.has_results = Product.search(suggestion.query, load: false, limit: 1).any?
+  suggestion.save! if suggestion.changed?
+end
+
+Autosuggest::Suggestion.where(has_results: true)
+```
+
+You can add additional fields to your model/data store to accomplish this.
+
+## Example
 
 ```ruby
 top_queries = Searchjoy::Search.group(:normalized_query)
@@ -110,9 +183,14 @@ autosuggest.prefer brand_names
 autosuggest.not_duplicates [["straws", "straus"]]
 autosuggest.block_words ["boom"]
 
-puts autosuggest.pretty_suggestions
-# or
 suggestions = autosuggest.suggestions(filter: true)
+
+now = Time.now
+records = suggestions.map { |s| s.slice(:query, :score).merge(updated_at: now) }
+Autosuggest::Suggestion.transaction do
+  Autosuggest::Suggestion.upsert_all(records, unique_by: :query)
+  Autosuggest::Suggestion.where("updated_at < ?", now).delete_all
+end
 ```
 
 ## History

data/lib/autosuggest/version.rb

@@ -1,3 +1,3 @@
 class Autosuggest
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/generators/autosuggest/suggestions_generator.rb

@@ -0,0 +1,33 @@
+require "rails/generators/active_record"
+
+class Autosuggest
+  module Generators
+    class SuggestionsGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+      source_root File.join(__dir__, "templates")
+
+      def copy_templates
+        template "model.rb", "app/models/autosuggest/suggestion.rb"
+        migration_template "migration.rb", "db/migrate/create_autosuggest_suggestions.rb", migration_version: migration_version
+      end
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+
+      def mysql?
+        adapter =~ /mysql/i
+      end
+
+      # use connection_config instead of connection.adapter
+      # so database connection isn't needed
+      def adapter
+        if ActiveRecord::VERSION::STRING.to_f >= 6.1
+          ActiveRecord::Base.connection_db_config.adapter.to_s
+        else
+          ActiveRecord::Base.connection_config[:adapter].to_s
+        end
+      end
+    end
+  end
+end

data/lib/generators/autosuggest/templates/migration.rb.tt

@@ -0,0 +1,11 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :autosuggest_suggestions do |t|
+      t.string :query
+      t.float :score
+      t.datetime :updated_at<%= mysql? ? ", precision: 6" : "" %>
+    end
+
+    add_index :autosuggest_suggestions, :query, unique: true
+  end
+end

data/lib/generators/autosuggest/templates/model.rb.tt

@@ -0,0 +1,3 @@
+class Autosuggest::Suggestion < ApplicationRecord
+  self.table_name = "autosuggest_suggestions"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autosuggest
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-23 00:00:00.000000000 Z
+date: 2021-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-stemmer
@@ -49,6 +49,9 @@ files:
 - README.md
 - lib/autosuggest.rb
 - lib/autosuggest/version.rb
+- lib/generators/autosuggest/suggestions_generator.rb
+- lib/generators/autosuggest/templates/migration.rb.tt
+- lib/generators/autosuggest/templates/model.rb.tt
 homepage: https://github.com/ankane/autosuggest
 licenses:
 - MIT