workarea-search_autocomplete 1.0.0

data/app/controllers/workarea/storefront/searches_controller.decorator

@@ -0,0 +1,10 @@
+module Workarea
+  decorate Storefront::SearchesController, with: 'search_autocomplete' do
+    def autocomplete
+      @autocomplete = Storefront::SearchAutocompleteViewModel.wrap(
+        QueryString.new(params[:q]).pretty,
+        view_model_options
+      )
+    end
+  end
+end

data/app/models/workarea/metrics/search_by_week.decorator

@@ -0,0 +1,37 @@
+module Workarea
+  decorate Metrics::SearchByWeek, with: 'search_autocomplete' do
+    decorated do
+      index(
+        { query_string: 1, total_results: 1, searches: 1 },
+        { partial_filter_expression: { total_results: { '$gt' => 0 } } }
+      )
+
+      scope :by_query_string, ->(string) { where(query_string: /^#{string}/) }
+    end
+
+    class_methods do
+      def autocomplete(query_string, max: 3)
+        pipeline = [
+          {
+            '$match' => {
+              total_results: { '$gt' => 0 },
+              query_string: { '$regex' => /^#{query_string}/ }
+            }
+          },
+          { '$project' => { 'query_id' => 1, 'searches' => 1, 'query_string' => 1 } },
+          {
+            '$group' => {
+              '_id' => '$query_id',
+              'searches' => { '$sum' => '$searches' },
+              'query_string' => { '$first' => '$query_string' }
+            }
+          },
+          { '$sort' => { 'searches' => -1 } },
+          { '$limit' => max }
+        ]
+
+        collection.aggregate(pipeline).map { |r| r['query_string'] }
+      end
+    end
+  end
+end

data/app/view_models/workarea/storefront/search_autocomplete_products_view_model.rb

@@ -0,0 +1,13 @@
+module Workarea
+  module Storefront
+    class SearchAutocompleteProductsViewModel < RecommendationsViewModel
+      def product_ids
+        model.results.map { |v| v['product_id'] }
+      end
+
+      def result_count
+        Workarea.config.storefront_search_autocomplete_max_products
+      end
+    end
+  end
+end

data/app/view_models/workarea/storefront/search_autocomplete_view_model.rb

@@ -0,0 +1,66 @@
+module Workarea
+  module Storefront
+    class SearchAutocompleteViewModel < ApplicationViewModel
+      def trending_products?
+        query_string.blank? || full_results.products.blank?
+      end
+      alias_method :trending_searches?, :trending_products?
+
+      def products
+        @products ||= begin
+          results = trending_products? ? trending_products : full_results.products
+          results.take(Workarea.config.storefront_search_autocomplete_max_products)
+        end
+      end
+
+      def searches
+        @searches ||= begin
+          results = trending_searches? ? trending_searches : autocomplete_searches
+          results.take(Workarea.config.storefront_search_autocomplete_max_searches)
+        end
+      end
+
+      def query_string
+        autocomplete_searches.first.presence || model
+      end
+
+      def content
+        Storefront::SearchViewModel.new(response, options)
+      end
+
+      private
+
+      def autocomplete_searches
+        return [] if model.blank?
+
+        @autocomplete_searches ||= Metrics::SearchByWeek.autocomplete(
+          model,
+          max: Workarea.config.storefront_search_autocomplete_max_searches
+        )
+      end
+
+      def trending_searches
+        @trending_searches ||= begin
+          Workarea::Insights::TrendingSearches.current.results.map do |v|
+            v['query_string']
+          end
+        end
+      end
+
+      def trending_products
+        @trending_products ||= SearchAutocompleteProductsViewModel.wrap(
+          Workarea::Insights::TrendingProducts.current,
+          options
+        )
+      end
+
+      def full_results
+        @full_results ||= SearchViewModel.wrap(response, options)
+      end
+
+      def response
+        @response ||= Search::StorefrontSearch.new(q: query_string).response
+      end
+    end
+  end
+end

data/app/views/workarea/storefront/searches/_autocomplete_placeholder.html.haml

@@ -0,0 +1,2 @@
+#search_autocomplete.search-autocomplete.visually-hidden{ aria: { live: 'polite' } }
+

data/app/views/workarea/storefront/searches/autocomplete.html.haml

@@ -0,0 +1,34 @@
+.grid.grid--rev
+  .grid__cell.grid__cell--25
+    - if @autocomplete.searches.any?
+      %span.search-autocomplete__heading
+        - if @autocomplete.trending_searches?
+          = t('workarea.storefront.search_autocomplete.trending_searches')
+        - else
+          = t('workarea.storefront.search_autocomplete.popular_searches')
+
+      %ul.search-autocomplete__searches
+        - @autocomplete.searches.each do |search|
+          %li.search-autocomplete__searches-item
+            = link_to search, search_path(q: search), class: 'search-autocomplete__searches-link'
+
+    = append_partials('storefront.search_autocomplete_under_searches')
+
+  .grid__cell.grid__cell--75
+    - if @autocomplete.products.any?
+      .search-autocomplete__products
+        %span.search-autocomplete__heading
+          - if @autocomplete.trending_products?
+            = t('workarea.storefront.search_autocomplete.trending_products')
+          - else
+            = t('workarea.storefront.search_autocomplete.products_heading', term: @autocomplete.query_string)
+
+        .grid
+          - @autocomplete.products.each do |product|
+            .grid__cell.grid__cell--25
+              .product-summary
+                = render 'workarea/storefront/products/summary', product: product
+
+    - if @autocomplete.content.customization_content_blocks_for('autocomplete').present?
+      .autocomplete.content-autocomplete__content
+        = render_content_blocks(@autocomplete.content.customization_content_blocks_for('autocomplete'))

data/bin/rails

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/workarea/search_autocomplete/engine', __dir__)
+APP_PATH = File.expand_path('../test/dummy/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+# require "active_job/railtie"
+# require "active_record/railtie"
+# require "active_storage/engine"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+# require "action_cable/engine"
+require "sprockets/railtie"
+require "rails/test_unit/railtie"
+require 'rails/engine/commands'

data/config/initializers/appends.rb

@@ -0,0 +1,20 @@
+Workarea.append_partials(
+  'storefront.page_header_search_value',
+  'workarea/storefront/searches/autocomplete_placeholder'
+)
+
+Workarea.append_javascripts(
+  'storefront.config',
+  'workarea/storefront/search_autocomplete/config'
+)
+
+Workarea.append_javascripts(
+  'storefront.modules',
+  'workarea/storefront/search_autocomplete/modules/search_autocomplete'
+)
+
+Workarea.append_stylesheets(
+  'storefront.components',
+  'workarea/storefront/search_autocomplete/components/page_header',
+  'workarea/storefront/search_autocomplete/components/search_autocomplete'
+)

data/config/initializers/content.rb

@@ -0,0 +1,3 @@
+Workarea.configure do |config|
+  config.content_areas['customization'].append('autocomplete')
+end

data/config/initializers/fields.rb

@@ -0,0 +1,13 @@
+Workarea::Configuration.define_fields do
+  fieldset 'Search', namespaced: false do
+    field 'Storefront Search Autocomplete Max Searches',
+      type: :integer,
+      default: 5,
+      description: 'The max number of search autocomplete suggestions to show in the storefront.'
+
+    field 'Storefront Search Autocomplete Max Products',
+      type: :integer,
+      default: 4,
+      description: 'The max number of search autocomplete products to show in the storefront.'
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,8 @@
+en:
+  workarea:
+    storefront:
+      search_autocomplete:
+        products_heading: "Product Results: %{term}"
+        trending_products: Trending Products
+        trending_searches: Trending Searches
+        popular_searches: Popular Searches

data/config/routes.rb

@@ -0,0 +1,7 @@
+Workarea::Storefront::Engine.routes.draw do
+  scope '(:locale)', constraints: Workarea::I18n.routes_constraint do
+    resource :search, only: [] do
+      get 'autocomplete'
+    end
+  end
+end

data/lib/workarea/search_autocomplete.rb

@@ -0,0 +1,11 @@
+require 'workarea'
+require 'workarea/storefront'
+require 'workarea/admin'
+
+require 'workarea/search_autocomplete/engine'
+require 'workarea/search_autocomplete/version'
+
+module Workarea
+  module SearchAutocomplete
+  end
+end

data/lib/workarea/search_autocomplete/engine.rb

@@ -0,0 +1,8 @@
+module Workarea
+  module SearchAutocomplete
+    class Engine < ::Rails::Engine
+      include Workarea::Plugin
+      isolate_namespace Workarea::SearchAutocomplete
+    end
+  end
+end

data/lib/workarea/search_autocomplete/version.rb

@@ -0,0 +1,5 @@
+module Workarea
+  module SearchAutocomplete
+    VERSION = '1.0.0'
+  end
+end

data/package.json

@@ -0,0 +1,9 @@
+{
+  "devDependencies": {
+    "eslint": "~5.16.0",
+    "eslint-config-recommended": "~4.0.0",
+    "stylelint": "~10.1.0",
+    "stylelint-config-recommended-scss": "~3.3.0",
+    "stylelint-scss": "~3.9.2"
+  }
+}

data/script/admin_ci

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+gem install bundler
+bundle update
+
+CI_GEM_PATH="$(bundle show workarea-ci)"
+. ${CI_GEM_PATH}/exe/workarea-set-ci-env
+
+bin/rails app:workarea:test:admin

data/script/ci

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+gem install bundler
+bundle update
+
+CI_GEM_PATH="$(bundle show workarea-ci)"
+. ${CI_GEM_PATH}/exe/workarea-set-ci-env
+
+bundle exec workarea-lint
+bundle exec workarea-audit
+bin/rails test test/**/*_test.rb

data/script/core_ci

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+gem install bundler
+bundle update
+
+CI_GEM_PATH="$(bundle show workarea-ci)"
+. ${CI_GEM_PATH}/exe/workarea-set-ci-env
+
+bin/rails app:workarea:test:core

data/script/plugins_ci

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+gem install bundler
+bundle update
+
+CI_GEM_PATH="$(bundle show workarea-ci)"
+. ${CI_GEM_PATH}/exe/workarea-set-ci-env
+
+bin/rails app:workarea:test:plugins

data/script/storefront_ci

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+gem install bundler
+bundle update
+
+CI_GEM_PATH="$(bundle show workarea-ci)"
+. ${CI_GEM_PATH}/exe/workarea-set-ci-env
+
+bin/rails app:workarea:test:storefront

data/test/dummy/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/test/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>