workarea-content_search 1.0.8

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

@@ -0,0 +1,21 @@
+module Workarea
+  module Storefront
+    module ContentSearchResults
+      def multiple_result_types?
+        product_total > 0 && content_total > 0
+      end
+
+      def product_total
+        model.total
+      end
+
+      def result_type
+        if model.template == 'content'
+          'content'
+        else
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+module Workarea
+  module Storefront
+    class ContentSearchViewModel < ApplicationViewModel
+      include Pagination
+      include SearchCustomizationContent
+      include ContentSearchResults
+
+      ContentResult = Struct.new(:name, :resource_name, :summary, :to_param)
+
+      def search_query
+        content_query
+      end
+
+      def content
+        @content ||=
+          begin
+            results = content_query.results.map do |result|
+              ContentResult.new(
+                result['content']['name'],
+                result['cache']['resource_name'],
+                result['content']['summary'],
+                result['slug']
+              )
+            end
+
+            PagedArray.from(results, page, per_page, total)
+          end
+      end
+
+      def query_suggestions
+        @query_suggestions ||=
+          begin
+            all = Recommendation::Searches.find(options[:q]) +
+                  model.query_suggestions
+
+            all.take(3)
+          end
+      end
+
+      def sort
+        content_query.class.available_sorts.find(options[:sort])
+      end
+
+      def sorts
+        content_query.class.available_sorts.map { |s| [s.name, s.slug] }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+- if @search.multiple_result_types?
+  .grid.grid--auto
+    .grid__cell
+      %span.search-results__type= pluralize(@search.total, t('workarea.storefront.searches.product_result'))
+
+    - if @search.content_total > 0
+      .grid__cell
+        %span.search-results__type= link_to pluralize(@search.content_total, t('workarea.storefront.searches.content_result')), content_search_path(q: @search.query_string, type: 'content')

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

@@ -0,0 +1,71 @@
+- @title = t('workarea.storefront.searches.title')
+
+- content_for :head do
+  %meta{ property: 'recent-view', content: recent_view_content(search: @search.query_string) }
+  = append_partials('storefront.search_head', search: @search)
+
+  - if @search.first_page?
+    %link{ href: search_path(q: @search.query_string), rel: 'canonical' }
+  %meta{ name: 'robots', content: 'noindex, follow' }
+  - unless @search.last_page?
+    %link{ href: url_for(q: @search.query_string, page: @search.next_page), rel: 'next' }
+  - unless @search.first_page?
+    %link{ href: url_for(q: @search.query_string, page: @search.prev_page), rel: 'prev' }
+
+  %meta{ property: 'og:url', content: url_for }
+  %meta{ property: 'og:title', content: page_title }
+  %meta{ property: 'og:type', content: 'website' }
+  %meta{ property: 'og:image', content: root_path + image_path('workarea/storefront/logo.png') }
+
+- content_for :breadcrumbs do
+  %p.breadcrumbs__node-group
+    %span.breadcrumbs__node{ itemprop: 'breadcrumb' }
+      = link_to t('workarea.storefront.layouts.home'), root_path, rel: 'home'
+    %span.breadcrumbs__node{ itemprop: 'breadcrumb' }
+      %span= t('workarea.storefront.searches.title')
+    %span.breadcrumbs__node{ itemprop: 'breadcrumb' }
+      %span= @search.query_string
+
+.view{ data: { analytics: search_results_view_analytics_data(@search).to_json } }
+
+  - if @search.customization_content_blocks_for('above_results').present?
+    .search-query-content= render_content_blocks(@search.customization_content_blocks_for('above_results'))
+
+  - if @search.multiple_result_types?
+    %h1.visually-hidden= pluralize(@search.total, t('workarea.storefront.searches.content_result'))
+
+    %ul.search-result-types
+      - if @search.product_total > 0
+        %li= link_to pluralize(@search.product_total, t('workarea.storefront.searches.product_result')), search_path(q: @search.query_string, type: 'show')
+      %li= pluralize(@search.content_total, t('workarea.storefront.searches.content_result'))
+  - else
+    %h1= pluralize(@search.total, t('workarea.storefront.searches.result'))
+
+  - if @search.query_suggestions.any?
+    .related-searches
+      %p= t('workarea.storefront.searches.suggestions')
+      %ul
+        - @search.query_suggestions.each do |search|
+          %li= link_to search, content_search_path(q: search)
+
+  .grid.grid--auto.grid--middle
+    .grid__cell
+      = form_tag content_search_path, method: 'get' do
+        = hidden_field_tag :q, @search.query_string
+        .property.property--responsive
+          = label_tag 'sort_top', nil, class: 'property__name' do
+            %span.property__text= t('workarea.storefront.searches.sort_by')
+          %span.value= select_tag :sort, options_for_select(@search.sorts, selected: @search.sort), id: 'sort_top', data: { form_submitting_control: '' }
+        .hidden-if-js-enabled= button_tag t('workarea.storefront.searches.sort'), value: 'sort_content_top', class: 'button'
+
+  = append_partials('storefront.search_browse_controls', search: @search)
+
+  .pagination{ data: { pagination: pagination_data(@search.content) } }
+    %ul
+      - @search.content.each do |result|
+        %li{ data: { pagination_item: '' } }
+          = link_to result.name, send("#{result.resource_name}_path", result)
+          %p= truncate(result.summary, length: 100)
+    - if show_pagination?(@search.content)
+      .pagination__button
+        = link_to t('workarea.storefront.pagination.next_page'), pagination_path_for(page: @search.next_page), class: 'button button--large', data: { pagination_button: '' }

data/app/workers/workarea/bulk_index_content.rb

@@ -0,0 +1,29 @@
+module Workarea
+  class BulkIndexContent
+    include Sidekiq::Worker
+
+    sidekiq_options unique: :until_and_while_executing
+
+    class << self
+      def perform(ids = Content.pluck(:id))
+        ids.each_slice(100) do |group|
+          perform_by_models(Content.in(id: group).to_a)
+        end
+      end
+
+      def perform_by_models(content)
+        documents = content.map do |model|
+          search_model = Search::Storefront::Content.new(model)
+          next unless search_model.should_be_indexed?
+          search_model.as_bulk_document
+        end
+
+        Search::Storefront.bulk(documents.compact)
+      end
+    end
+
+    def perform(ids)
+      self.class.perform(ids)
+    end
+  end
+end

data/app/workers/workarea/clean_content.rb

@@ -0,0 +1,35 @@
+module Workarea
+  class CleanContent
+    include Sidekiq::Worker
+    include Sidekiq::CallbacksWorker
+
+    sidekiq_options(
+      enqueue_on: {
+        Contentable => [:save, :destroy],
+        with: -> { [id, self.class.name] }
+      }
+    )
+
+    def perform(id, type)
+      object_id = BSON::ObjectId.from_string(id.to_s) rescue nil
+      content =
+        if object_id.present?
+          Content.where(contentable_type: type)
+                 .any_of({ contentable_id: id }, { contentable_id: object_id })
+        else
+          Content.where(contentable_type: type, contentable_id: id)
+        end
+
+      content.each do |model|
+        search_model = Search::Storefront::Content.new(model)
+        contentable = model.contentable
+
+        if contentable&.active? && search_model.should_be_indexed?
+          search_model.save
+        else
+          search_model.destroy rescue nil
+        end
+      end
+    end
+  end
+end

data/app/workers/workarea/index_content.rb

@@ -0,0 +1,46 @@
+module Workarea
+  class IndexContent
+    include Sidekiq::Worker
+    include Sidekiq::CallbacksWorker
+
+    sidekiq_options(
+      enqueue_on: {
+        Content => [:save, :destroy],
+        Content::Block => [:save, :destroy],
+        with: -> { respond_to?(:content) ? content.id : id }
+      },
+      unique: :until_executing
+    )
+
+    class << self
+      def perform(content)
+        search_model = Search::Storefront::Content.new(content)
+
+        if content.persisted? && search_model.should_be_indexed?
+          search_model.save
+        else
+          begin
+            search_model.try(:destroy)
+          rescue
+            nil # It's OK if it doesn't exist
+          end
+        end
+      end
+
+      # Test whether this content model should be indexed.
+      #
+      # @param [Workarea::Content] content - Model to be tested
+      # @return [Boolean] +true+ if the model should skip the index.
+      # @deprecated Use +Workarea::Search::Storefront::Content#should_be_indexed?+
+      #             instead.
+      def skip_index?(content)
+        !Search::Storefront::Content.new(content).should_be_indexed?
+      end
+    end
+
+    def perform(id)
+      model = Content.find_or_initialize_by(id: id)
+      self.class.perform(model)
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,16 @@
+#!/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('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/content_search/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'action_controller/railtie'
+require 'action_mailer/railtie'
+require 'sprockets/railtie'
+require 'rails/test_unit/railtie'
+require 'rails/engine/commands'

data/config/initializers/appends.rb

@@ -0,0 +1,4 @@
+Workarea.append_partials(
+  'storefront.above_search_results',
+  'workarea/storefront/searches/search_type_toggle'
+)

data/config/initializers/configuration.rb

@@ -0,0 +1,19 @@
+Workarea.configure do |config|
+  config.storefront_search_middleware.swap(
+    'Workarea::Search::StorefrontSearch::Template',
+    'Workarea::Search::StorefrontSearch::TemplateWithContent'
+  )
+
+  config.storefront_search_middleware.swap(
+    'Workarea::Search::StorefrontSearch::SpellingCorrection',
+    'Workarea::Search::StorefrontSearch::SpellingCorrectionWithContent'
+  )
+
+  # Exclude content related to the list of classes from being index for
+  # search. They will not show up in content search results.
+  config.exclude_from_content_search_index = %w(
+    Workarea::Catalog::Category
+    Workarea::Search::Customization
+    Workarea::Navigation::Menu
+  )
+end

data/config/locales/en.yml

@@ -0,0 +1,7 @@
+en:
+  workarea:
+    storefront:
+      searches:
+        product_result: product result
+        content_result: content result
+        content: Content

data/config/routes.rb

@@ -0,0 +1,9 @@
+Workarea::Storefront::Engine.routes.draw do
+  scope '(:locale)', constraints: Workarea::I18n.routes_constraint do
+    resource :search, only: :show do
+      member do
+        get :content
+      end
+    end
+  end
+end

data/lib/tasks/content_search_tasks.rake

@@ -0,0 +1,8 @@
+# desc "Explaining what the task does"
+# task :content_search do
+#   # Task goes here
+# end
+
+Rake::Task['workarea:search_index:storefront'].enhance do
+  Workarea::BulkIndexContent.perform
+end

data/lib/workarea/content_search/engine.rb

@@ -0,0 +1,15 @@
+module Workarea
+  module ContentSearch
+    class Engine < ::Rails::Engine
+      include Workarea::Plugin
+      isolate_namespace Workarea::ContentSearch
+
+      config.to_prepare do
+        Storefront::SearchViewModel.send(
+          :include,
+          Storefront::ContentSearchResults
+        )
+      end
+    end
+  end
+end

data/lib/workarea/content_search/version.rb

@@ -0,0 +1,5 @@
+module Workarea
+  module ContentSearch
+    VERSION = '1.0.8'.freeze
+  end
+end

data/lib/workarea/content_search.rb

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

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,4 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

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

@@ -0,0 +1,13 @@
+// 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_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,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+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,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+
+    <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

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

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/test/dummy/bin/update

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,18 @@
+require_relative 'boot'
+
+require 'action_controller/railtie'
+require 'action_mailer/railtie'
+require 'sprockets/railtie'
+
+require 'workarea'
+require 'workarea/content_search'
+
+Bundler.require(*Rails.groups)
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/test/dummy/config/cable.yml

@@ -0,0 +1,9 @@
+development:
+  adapter: async
+
+test:
+  adapter: async
+
+production:
+  adapter: redis
+  url: redis://localhost:6379/1

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,54 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  if Rails.root.join('tmp/caching-dev.txt').exist?
+    config.action_controller.perform_caching = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      'Cache-Control' => 'public, max-age=172800'
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  config.action_mailer.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  # config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+end