workarea-search_autocomplete 1.0.0

data/test/dummy/config/locales/en.yml

@@ -0,0 +1,33 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# The following keys must be escaped otherwise they will not be retrieved by
+# the default I18n backend:
+#
+# true, false, on, off, yes, no
+#
+# Instead, surround them with single quotes.
+#
+# en:
+#   'true': 'foo'
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
+
+en:
+  hello: "Hello world"

data/test/dummy/config/puma.rb

@@ -0,0 +1,34 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers: a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum; this matches the default thread size of Active Record.
+#
+threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
+threads threads_count, threads_count
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+#
+port        ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked webserver processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory.
+#
+# preload_app!
+
+# Allow puma to be restarted by `rails restart` command.
+plugin :tmp_restart

data/test/dummy/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  mount Workarea::Core::Engine => '/'
+  mount Workarea::Admin::Engine => '/admin', as: 'admin'
+  mount Workarea::Storefront::Engine => '/', as: 'storefront'
+end

data/test/dummy/config/spring.rb

@@ -0,0 +1,6 @@
+%w[
+  .ruby-version
+  .rbenv-vars
+  tmp/restart.txt
+  tmp/caching-dev.txt
+].each { |path| Spring.watch(path) }

data/test/dummy/db/seeds.rb

@@ -0,0 +1,2 @@
+require 'workarea/seeds'
+Workarea::Seeds.run

data/test/integration/workarea/storefront/search_autocomplete_integration_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+module Workarea
+  module Storefront
+    class SearchAutocompleteIntegrationTest < Workarea::IntegrationTest
+      def test_autocomplete
+        test_one = create_product(name: 'Test One')
+        test_two = create_product(name: 'Test Two')
+        create_search_by_week(query_string: 'test one', searches: 5, total_results: 5)
+        create_search_by_week(query_string: 'test two', searches: 10, total_results: 5)
+
+        get storefront.autocomplete_search_path(q: '')
+        assert(response.ok?)
+
+        get storefront.autocomplete_search_path(q: 'tes')
+        assert(response.ok?)
+        assert_match(/test two.*test one/m, response.body)
+        assert_includes(response.body, storefront.product_path(test_two))
+        refute_includes(response.body, storefront.product_path(test_one))
+
+        get storefront.autocomplete_search_path(q: 'TeS')
+        assert(response.ok?)
+        assert_match(/test two.*test one/m, response.body)
+        assert_includes(response.body, storefront.product_path(test_two))
+        refute_includes(response.body, storefront.product_path(test_one))
+      end
+    end
+  end
+end

data/test/models/workarea/metrics/search_by_week_autocomplete_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+module Workarea
+  module Metrics
+    class SearchByWeekAutocompleteTest < TestCase
+      def test_autocomplete
+        create_search_by_week(total_results: 0, query_string: 'test one')
+        create_search_by_week(total_results: 5, query_string: 'test two', reporting_on: 1.week.ago.beginning_of_week)
+        create_search_by_week(total_results: 5, query_string: 'test two', reporting_on: 2.weeks.ago.beginning_of_week)
+        create_search_by_week(searches: 3, total_results: 10, query_string: 'test three')
+        create_search_by_week(total_results: 15, query_string: 'blah blah blah')
+
+        results = SearchByWeek.autocomplete('tes')
+        assert_equal(2, results.size)
+        assert_equal('test three', results.first)
+        assert_equal('test two', results.second)
+      end
+    end
+  end
+end

data/test/system/workarea/storefront/search_autocomplete_system_test.rb

@@ -0,0 +1,171 @@
+require 'test_helper'
+
+module Workarea
+  module Storefront
+    class SearchAutocompleteSystemTest < Workarea::SystemTest
+      setup :generate_trending_products, :generate_trending_searches
+
+      def generate_trending_products
+        create_product(name: 'Foo Product', id: 'foo_product')
+        create_product(name: 'Bar Product', id: 'bar_product')
+        create_product(name: 'Baz Product', id: 'baz_product')
+
+        create_product_by_week(
+          product_id: 'foo_product',
+          revenue_change: 10,
+          orders: 5,
+          reporting_on: Time.zone.local(2018, 12, 3)
+        )
+        create_product_by_week(
+          product_id: 'foo_product',
+          revenue_change: -10,
+          orders: 0,
+          reporting_on: Time.zone.local(2018, 12, 10)
+        )
+        create_product_by_week(
+          product_id: 'foo_product',
+          revenue_change: 20,
+          orders: 10,
+          reporting_on: Time.zone.local(2018, 12, 17)
+        )
+        create_product_by_week(
+          product_id: 'bar_product',
+          revenue_change: 10,
+          orders: 5,
+          reporting_on: Time.zone.local(2018, 12, 3)
+        )
+        create_product_by_week(
+          product_id: 'bar_product',
+          revenue_change: -10,
+          orders: 0,
+          reporting_on: Time.zone.local(2018, 12, 10)
+        )
+        create_product_by_week(
+          product_id: 'bar_product',
+          revenue_change: 0,
+          orders: 0,
+          reporting_on: Time.zone.local(2018, 12, 17)
+        )
+        create_product_by_week(
+          product_id: 'baz_product',
+          revenue_change: 10,
+          orders: 5,
+          reporting_on: Time.zone.local(2018, 12, 3)
+        )
+        create_product_by_week(
+          product_id: 'baz_product',
+          revenue_change: -10,
+          orders: 1,
+          reporting_on: Time.zone.local(2018, 12, 10)
+        )
+        create_product_by_week(
+          product_id: 'baz_product',
+          revenue_change: 0,
+          orders: 0,
+          reporting_on: Time.zone.local(2018, 12, 17)
+        )
+
+        travel_to Time.zone.local(2019, 1, 17)
+        Workarea::Insights::TrendingProducts.generate_monthly!
+      end
+
+      def generate_trending_searches
+        create_search_by_week(
+          query_string: 'foo search',
+          revenue_change: 10,
+          orders: 5,
+          reporting_on: Time.zone.local(2018, 12, 3)
+        )
+        create_search_by_week(
+          query_string: 'foo search',
+          revenue_change: -10,
+          orders: 0,
+          reporting_on: Time.zone.local(2018, 12, 10)
+        )
+        create_search_by_week(
+          query_string: 'foo search',
+          revenue_change: 20,
+          orders: 10,
+          reporting_on: Time.zone.local(2018, 12, 17)
+        )
+        create_search_by_week(
+          query_string: 'bar search',
+          revenue_change: 10,
+          orders: 5,
+          reporting_on: Time.zone.local(2018, 12, 3)
+        )
+        create_search_by_week(
+          query_string: 'bar search',
+          revenue_change: -10,
+          orders: 0,
+          reporting_on: Time.zone.local(2018, 12, 10)
+        )
+        create_search_by_week(
+          query_string: 'bar search',
+          revenue_change: 0,
+          orders: 0,
+          reporting_on: Time.zone.local(2018, 12, 17)
+        )
+        create_search_by_week(
+          query_string: 'baz search',
+          revenue_change: 10,
+          orders: 5,
+          reporting_on: Time.zone.local(2018, 12, 3)
+        )
+        create_search_by_week(
+          query_string: 'baz search',
+          revenue_change: -10,
+          orders: 1,
+          reporting_on: Time.zone.local(2018, 12, 10)
+        )
+        create_search_by_week(
+          query_string: 'baz search',
+          revenue_change: 0,
+          orders: 0,
+          reporting_on: Time.zone.local(2018, 12, 17)
+        )
+
+        travel_to Time.zone.local(2019, 1, 17)
+        Workarea::Insights::TrendingSearches.generate_monthly!
+      end
+
+      def test_autocomplete
+        create_product(name: 'Test One')
+        create_product(name: 'Test Two')
+        create_search_by_week(query_string: 'test one', searches: 5, total_results: 5)
+        create_search_by_week(query_string: 'test two', searches: 10, total_results: 5)
+
+        visit storefront.root_path
+        fill_in 'q', with: ''
+        within '#search_autocomplete' do
+          assert_text(t('workarea.storefront.search_autocomplete.trending_products'))
+          assert_text(t('workarea.storefront.search_autocomplete.trending_searches'))
+          assert_match(/Foo Product.*Baz Product.*Bar Product/m, page.body)
+          assert_match(/foo search.*baz search.*bar search/m, page.body)
+        end
+
+        fill_in 'q', with: 'te'
+        within '#search_autocomplete' do
+          assert_text('Test Two')
+          assert_match(/test two.*test one/m, page.body)
+        end
+
+        fill_in 'q', with: ''
+        within '#search_autocomplete' do
+          assert_text(t('workarea.storefront.search_autocomplete.trending_products'))
+          assert_text(t('workarea.storefront.search_autocomplete.trending_searches'))
+          assert_match(/Foo Product.*Baz Product.*Bar Product/m, page.body)
+          assert_match(/foo search.*baz search.*bar search/m, page.body)
+        end
+
+        fill_in 'q', with: 'corge'
+        within '#search_autocomplete' do
+          assert_text(t('workarea.storefront.search_autocomplete.trending_products'))
+          assert_text(t('workarea.storefront.search_autocomplete.trending_searches'))
+          assert_match(/Foo Product.*Baz Product.*Bar Product/m, page.body)
+          assert_match(/foo search.*baz search.*bar search/m, page.body)
+        end
+      end
+    end
+  end
+end

data/test/teaspoon_env.rb

@@ -0,0 +1,6 @@
+require 'workarea/testing/teaspoon'
+
+Teaspoon.configure do |config|
+  config.root = Workarea::SearchAutocomplete::Engine.root
+  Workarea::Teaspoon.apply(config)
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path("../../test/dummy/config/environment.rb", __FILE__)
+require 'rails/test_help'
+require 'workarea/test_help'
+
+# Filter out Minitest backtrace while allowing backtrace from other libraries
+# to be shown.
+Minitest.backtrace_filter = Minitest::BacktraceFilter.new

data/test/view_models/workarea/storefront/search_autocomplete_view_model_test.rb

@@ -0,0 +1,125 @@
+require 'test_helper'
+
+module Workarea
+  module Storefront
+    class SearchAutocompleteViewModelTest < TestCase
+      include SearchIndexing
+
+      def test_trending_products
+        assert(SearchAutocompleteViewModel.new.trending_products?)
+        assert(SearchAutocompleteViewModel.new('foo').trending_products?)
+
+        IndexProduct.perform(create_product(name: 'foo'))
+        refute(SearchAutocompleteViewModel.new('foo').trending_products?)
+
+        create_search_by_week(query_string: 'foo', searches: 5, total_results: 5)
+        refute(SearchAutocompleteViewModel.new('fo').trending_products?)
+      end
+
+      def test_products
+        foo = create_product(name: 'Foo', id: 'foo')
+        bar = create_product(name: 'Bar', id: 'bar')
+        BulkIndexProducts.perform_by_models([foo, bar])
+
+        create_product_by_week(
+          product_id: 'foo',
+          revenue_change: 10,
+          orders: 5,
+          reporting_on: Time.zone.local(2018, 12, 3)
+        )
+        create_product_by_week(
+          product_id: 'foo',
+          revenue_change: 20,
+          orders: 10,
+          reporting_on: Time.zone.local(2018, 12, 17)
+        )
+        create_product_by_week(
+          product_id: 'bar',
+          revenue_change: 10,
+          orders: 5,
+          reporting_on: Time.zone.local(2018, 12, 3)
+        )
+
+        travel_to Time.zone.local(2019, 1, 17)
+        Insights::TrendingProducts.generate_monthly!
+
+        assert_equal(%w(foo bar), SearchAutocompleteViewModel.new.products.map(&:id))
+        assert_equal(%w(foo bar), SearchAutocompleteViewModel.new('baz').products.map(&:id))
+        assert_equal(%w(foo), SearchAutocompleteViewModel.new('foo').products.map(&:id))
+
+        (Workarea.config.storefront_search_autocomplete_max_products + 1).times do |i|
+          IndexProduct.perform(create_product(name: "Foo #{i}"))
+        end
+
+        assert_equal(
+          Workarea.config.storefront_search_autocomplete_max_products,
+          SearchAutocompleteViewModel.new('foo').products.size
+        )
+      end
+
+      def test_searches
+        create_search_by_week(
+          query_string: 'foo',
+          revenue_change: 10,
+          orders: 5,
+          total_results: 5,
+          reporting_on: Time.zone.local(2018, 12, 3)
+        )
+        create_search_by_week(
+          query_string: 'foo',
+          revenue_change: 20,
+          orders: 10,
+          total_results: 5,
+          reporting_on: Time.zone.local(2018, 12, 17)
+        )
+        create_search_by_week(
+          query_string: 'bar',
+          revenue_change: 10,
+          orders: 5,
+          total_results: 5,
+          reporting_on: Time.zone.local(2018, 12, 3)
+        )
+
+        travel_to Time.zone.local(2019, 1, 17)
+        Workarea::Insights::TrendingSearches.generate_monthly!
+
+        assert_equal(%w(foo bar), SearchAutocompleteViewModel.new.searches)
+        assert_equal(%w(foo bar), SearchAutocompleteViewModel.new('baz').searches)
+
+        foo = create_product(name: 'Foo')
+        bar = create_product(name: 'Bar')
+        BulkIndexProducts.perform_by_models([foo, bar])
+
+        assert_equal(%w(foo), SearchAutocompleteViewModel.new('foo').searches)
+
+        (Workarea.config.storefront_search_autocomplete_max_searches + 1).times do |i|
+          create_search_by_week(
+            query_string: "foo #{i}",
+            revenue_change: 10,
+            orders: 5,
+            total_results: 5,
+            reporting_on: Time.zone.local(2018, 12, 3)
+          )
+        end
+
+        travel_to Time.zone.local(2019, 1, 17)
+        Workarea::Insights::TrendingSearches.generate_monthly!
+
+        assert_equal(
+          Workarea.config.storefront_search_autocomplete_max_searches,
+          SearchAutocompleteViewModel.new('foo').searches.size
+        )
+      end
+
+      def test_query_string
+        assert_nil(SearchAutocompleteViewModel.new.query_string)
+        assert_equal('foo', SearchAutocompleteViewModel.new('foo').query_string)
+
+        create_search_by_week(query_string: 'foo', searches: 10, total_results: 5)
+        create_search_by_week(query_string: 'foo bar', searches: 5, total_results: 5)
+
+        assert_equal('foo', SearchAutocompleteViewModel.new('foo').query_string)
+      end
+    end
+  end
+end