workarea-content_search 1.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 12449ee4b459998e0083ff6daedaa711d577c7ac21c062c3b498a5c946ce8ca1
+  data.tar.gz: d90f4ccf145aad771d2681ecbd0e64563bbde18537e6b22fb4d64b5f8eaff0d4
+SHA512:
+  metadata.gz: bebeb905089554408bf71691ef17f9cc5c12195281297014129e11155f93d0de9f43ab7c3ba507f95fefba8b86e143ac0442e43dd7a4186f27422c603c01e969
+  data.tar.gz: 0a59facf22c4e352d205fe60a7c5523d58952f7c29daea918165d4ce0ffc6eb965cab5e5cffabf887baf2facf4bbe9ea67fda4b92f52cec7ff623dbb1d3c475f

data/.editorconfig

@@ -0,0 +1,20 @@
+# editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{*.rb,*.haml,*.decorator,*.yml,*.yaml,*.jbuilder}]
+indent_size = 2
+indent_style = space
+
+[{*.js,*.jst,*.ejs,*.scss}]
+indent_size = 4
+
+[*.md]
+indent_size = 4
+trim_trailing_whitespace = false

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve Workarea
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+⚠️**Before you create**⚠️
+Please verify the issue you're experiencing is not part of your Workarea project customizations. The best way to do this is with a [vanilla Workarea installation](https://developer.workarea.com/articles/create-a-new-host-application.html). This will help us spend time on fixes/improvements for the whole community. Thank you!
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Workarea Setup (please complete the following information):**
+ - Workarea Version: [e.g. v3.4.6]
+ - Plugins [e.g. workarea-blog, workarea-sitemaps]
+
+**Attachments**
+If applicable, add any attachments to help explain your problem, things like:
+- screenshots
+- Gemfile.lock
+- test cases
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/documentation-request.md

@@ -0,0 +1,17 @@
+---
+name: Documentation request
+about: Suggest documentation
+title: ''
+labels: documentation
+assignees: ''
+
+---
+
+**Is your documentation related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm confused by [...]
+
+**Describe the article you'd like**
+A clear and concise description of what would be in the documentation article.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for Workarea
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.gitignore

@@ -0,0 +1,13 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/public/system/
+Gemfile.lock
+node_modules
+test/reports
+package.json
+yarn.lock

data/CHANGELOG.md

@@ -0,0 +1,131 @@
+Workarea Content Search 1.0.8 (2019-07-09)
+--------------------------------------------------------------------------------
+
+*   Open Source!
+
+
+Workarea Content Search 1.0.7 (2019-07-09)
+--------------------------------------------------------------------------------
+
+*   Choose Default Search Response Template When Sorting Without Type
+
+    When no `:type` is given, and search results are being sorted, assume
+    that this sort was triggered from the "default" product search and not
+    content search, and render the default search results template rather
+    than the one for content search. This prevents a bug whereby a customer
+    was not able to sort product results if more content results were found
+    than products, because the search page would always render the content
+    template rather than the products search template.
+
+    CONTSEARCH-12
+    Tom Scott
+
+
+
+Workarea Content Search 1.0.6 (2019-05-28)
+--------------------------------------------------------------------------------
+
+*   Ensure BulkIndexContent documents array does not contain nil objects
+
+    CONTSEARCH-15
+    Matt Duffy
+
+
+
+Workarea Content Search 1.0.5 (2019-05-14)
+--------------------------------------------------------------------------------
+
+*   Fix Models Excluded From Index Appearing in Content Search
+
+    Refactor the `IndexContent.skip_index?` method as
+    `Search::Storefront::Content#should_be_indexed?`, a core feature that
+    allows Elasticsearch documents to control whether they can be indexed or
+    not. In the `Search::Storefront` base document class, this method returns
+    `true`, but here in `Workarea::ContentSearch` it should be dependent on
+    the configuration. Update the `CleanContent` and `IndexContent` jobs to
+    call this method before attempting to save a piece of content into the
+    index.
+
+    CONTSEARCH-13
+    Tom Scott
+
+*   Allows sort submission to return to the current search type
+
+    CONTSEARCH-12
+    Lucas Boyd
+
+
+
+Workarea Content Search 1.0.4 (2019-02-05)
+--------------------------------------------------------------------------------
+
+*   Update indexing behavior for storefront content
+
+    Trigger indexing of content when blocks are changed and
+    allow contentable changes to trigger a reindex of the content
+
+    CONTSEARCH-8
+    Matt Duffy
+
+*   Update for workarea v3.4 compatibility
+
+    CONTSEARCH-11
+    Matt Duffy
+
+*   Remove content from search index when Contentable is deleted
+
+    CleanContent can sometimes be passed an BSON::ObjectId as a string,
+    causing the lookup of the content to fail. Querying for the id as
+    either an BSON::ObjectId or String.
+
+    CONTSEARCH-7
+    Matt Duffy
+
+*   Remove Content From Search Index When Contentable is Removed
+
+    When a `Contentable` object is removed from the search index for
+    whatever reason, ensure that its content is also removed from the index.
+    Prevents 404s on the storefront when clicking links to contentables that
+    either no longer exist, or are no longer active.
+
+    CONTSEARCH-7
+    Tom Scott
+
+
+
+Workarea Content Search 1.0.3 (2018-07-10)
+--------------------------------------------------------------------------------
+
+*   Fix Gemfile
+
+    Curt Howard
+
+*   Remove use of .percolate method for es index
+
+    CONTSEARCH-6
+    Matt Duffy
+
+*   Leverage Workarea Changelog task
+
+    ECOMMERCE-5355
+    Curt Howard
+
+
+
+Workarea Content Search 1.0.1 (2017-05-30)
+--------------------------------------------------------------------------------
+
+*   Initialization clean up, exclude content from search suggestions
+
+    CONTSEARCH-4
+    Matt Duffy
+
+*   Decorate core test to update assertions affected by content search
+
+    CONTSEARCH-4
+    Matt Duffy
+
+
+Workarea Content Search 1.0.0 (2017-05-04)
+--------------------------------------------------------------------------------
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+View this plugin's code of conduct here:
+
+<https://github.com/workarea-commerce/workarea/blob/master/CODE_OF_CONDUCT.md>

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+View this plugin's contribution guidelines here:
+
+<https://github.com/workarea-commerce/workarea/blob/master/CONTRIBUTING.md>

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "git@github.com:#{repo}.git" }
+
+gemspec
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]
+
+gem 'workarea', github: 'workarea-commerce/workarea'

data/LICENSE

@@ -0,0 +1,52 @@
+WebLinc
+Business Source License
+
+Licensor: WebLinc Corporation, 22 S. 3rd Street, 2nd Floor, Philadelphia PA 19106
+
+Licensed Work: Workarea Commerce Platform
+               The Licensed Work is (c) 2019 WebLinc Corporation
+
+Additional Use Grant:
+                      You may make production use of the Licensed Work without an additional license agreement with WebLinc so long as you do not use the Licensed Work for a Commerce Service.
+
+                      A "Commerce Service" is a commercial offering that allows third parties (other than your employees and contractors) to access the functionality of the Licensed Work by creating or managing commerce functionality, the products, taxonomy, assets and/or content of which are controlled by such third parties. 
+
+                      For information about obtaining an additional license agreement with WebLinc, contact licensing@workarea.com.
+
+Change Date: 2019-08-20
+
+Change License: Version 2.0 or later of the GNU General Public License as published by the Free Software Foundation
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative works, redistribute, and make non-production use of the Licensed Work. The Licensor may make an Additional Use Grant, above, permitting limited production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly available distribution of a specific version of the Licensed Work under this License, whichever comes first, the Licensor hereby grants you rights under the terms of the Change License, and the rights granted in the paragraph above terminate.
+
+If your use of the Licensed Work does not comply with the requirements currently in effect as described in this License, you must purchase a commercial license from the Licensor, its affiliated entities, or authorized resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works of the Licensed Work, are subject to this License. This License applies separately for each version of the Licensed Work and the Change Date may vary for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy of the Licensed Work. If you receive the Licensed Work in original or modified form from a third party, the terms and conditions set forth in this License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically terminate your rights under this License for the current and all other versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of Licensor or its affiliates (provided that you may use a trademark or logo of Licensor as expressly required by this License). TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE. MariaDB hereby grants you permission to use this License’s text to license your works and to refer to it using the trademark "Business Source License" as long as you comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+In consideration of the right to use this License’s text and the "Business Source License" name and trademark, Licensor covenants to MariaDB, and to all other recipients of the licensed work to be provided by Licensor:
+
+To specify as the Change License the GPL Version 2.0 or any later version, or a license that is compatible with GPL Version 2.0 or a later version, where "compatible" means that software provided under the Change License can be included in a program with software provided under GPL Version 2.0 or a later version. Licensor may specify additional Change Licenses without limitation.
+
+To either: (a) specify an additional grant of rights to use that does not impose any additional restriction on the right granted in this License, as the Additional Use Grant; or (b) insert the text "None."
+
+To specify a Change Date.
+
+Not to modify this License in any other way.
+
+Notice
+The Business Source License (this document, or the "License") is not an Open Source license. However, the Licensed Work will eventually be made available under an Open Source License, as stated in this License.
+
+For more information on the use of the Business Source License generally, please visit the Adopting and Developing Business Source License FAQ.
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved. "Business Source License" is a trademark of MariaDB Corporation Ab.

data/README.md

@@ -0,0 +1,45 @@
+Workarea Content Search
+================================================================================
+
+A Workarea Commerce plugin that enables visitors of your site to use the site-wide search to find content pages.
+
+Overview
+--------------------------------------------------------------------------------
+
+* Indexes content pages in Elasticsearch
+* Enables returning both product and content search results on the storefront
+* Adds the ability for visitors to toggle between content and product results
+
+Getting Started
+--------------------------------------------------------------------------------
+
+Add the gem to your application's Gemfile:
+
+```ruby
+# ...
+gem 'workarea-content_search'
+# ...
+```
+
+Update your application's bundle.
+
+```bash
+cd path/to/application
+bundle
+```
+
+If you are adding this to an existing site, reindex the storefront.
+
+```bash
+bin/rails workarea:search_index:storefront
+```
+
+Workarea Commerce Documentation
+--------------------------------------------------------------------------------
+
+See [https://developer.workarea.com](https://developer.workarea.com) for Workarea Commerce documentation.
+
+License
+--------------------------------------------------------------------------------
+
+Workarea Content Search is released under the [Business Software License](LICENSE)

data/Rakefile

@@ -0,0 +1,31 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+load 'workarea/changelog.rake'
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'workarea/content_search/version'
+
+desc "Release version #{Workarea::ContentSearch::VERSION} of the gem"
+task :release do
+  host = "https://#{ENV['BUNDLE_GEMS__WEBLINC__COM']}@gems.weblinc.com"
+
+  #Rake::Task['workarea:changelog'].execute
+  #system 'git add CHANGELOG.md'
+  #system 'git commit -m "Update CHANGELOG"'
+  #system 'git push origin HEAD'
+
+  system "git tag -a v#{Workarea::ContentSearch::VERSION} -m 'Tagging #{Workarea::ContentSearch::VERSION}'"
+  system 'git push --tags'
+
+  system 'gem build workarea-content_search.gemspec'
+  system "gem push workarea-content_search-#{Workarea::ContentSearch::VERSION}.gem"
+  system "gem push workarea-content_search-#{Workarea::ContentSearch::VERSION}.gem --host #{host}"
+  system "rm workarea-content_search-#{Workarea::ContentSearch::VERSION}.gem"
+end

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

@@ -0,0 +1,17 @@
+module Workarea
+  decorate Storefront::SearchesController, with: :content_search do
+    def content
+      response = Search::StorefrontSearch.new(params.to_unsafe_h).response
+      response.template = 'content'
+      handle_search_response(response)
+    end
+
+    def set_search(response)
+      if response.template == 'content'
+        @search = Storefront::ContentSearchViewModel.new(response, view_model_options)
+      else
+        super
+      end
+    end
+  end
+end

data/app/models/workarea/search/storefront/content.rb

@@ -0,0 +1,55 @@
+module Workarea
+  module Search
+    class Storefront
+      class Content < Workarea::Search::Storefront
+        # TODO: rename method ensure_dynamic_mappings
+        def self.percolate_null_content
+          content = new(Workarea::Content.new)
+          content.save
+
+          Storefront.delete(content.id)
+        end
+
+        def content
+          { name: name, text: text, summary: text }
+        end
+
+        def sorts
+          { has_text: text.present? ? 1 : 0 }
+        end
+
+        def cache
+          { resource_name: resource_name }
+        end
+
+        def name
+          model.contentable.try(:name)
+        end
+
+        def text
+          @text ||= ExtractContentBlockText.new(model.blocks).text
+        end
+
+        def suggestion_content
+          "#{name} #{text}"
+        end
+
+        def slug
+          model.contentable.try(:slug)
+        end
+
+        def resource_name
+          return nil unless model.contentable_type.present?
+          model.contentable_type.underscore.split('/').last
+        end
+
+        def should_be_indexed?
+          !model.system? &&
+            !model.contentable.class.name.in?(
+              Workarea.config.exclude_from_content_search_index
+            )
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/search/storefront.decorator

@@ -0,0 +1,10 @@
+module Workarea
+  decorate Search::Storefront, with: :content_search do
+    class_methods do
+      def ensure_dynamic_mappings
+        super
+        Search::Storefront::Content.percolate_null_content
+      end
+    end
+  end
+end

data/app/queries/workarea/search/content_search.rb

@@ -0,0 +1,96 @@
+module Workarea
+  module Search
+    class ContentSearch
+      include Query
+      include QuerySuggestions
+      include Pagination
+
+      document Search::Storefront
+
+      def self.available_sorts
+        Sort::Collection.new(Sort.relevance, Sort.newest)
+      end
+
+      def customization
+        @customization ||= Customization.find_by_query(params[:q])
+      end
+
+      def rewritten_query
+        if customization.rewrite?
+          customization.rewrite
+        else
+          query_string.sanitized
+        end
+      end
+
+      def query
+        if params[:q].present? && !query_string.all?
+          {
+            multi_match: {
+              query: rewritten_query,
+              type: 'cross_fields',
+              fields: %w(content.name^2 content.text^0.75),
+              tie_breaker: Workarea.config.search_dismax_tie_breaker
+            }
+          }
+        else
+          super
+        end
+      end
+
+      def post_filter
+        filters = super
+        filters[:bool] ||= {}
+        filters[:bool][:must] ||= []
+        filters[:bool][:must] << { term: { type: 'content' } }
+        filters
+      end
+
+      def sort
+        result = []
+        selected_sort = self.class.available_sorts.find(params[:sort])
+
+        if selected_sort.field.present?
+          result << { selected_sort.field => selected_sort.direction }
+        else
+          result << {
+            'sorts.has_text' => {
+              order: 'desc',
+              missing: '_last',
+              unmapped_type: 'float'
+            }
+          }
+          result << { _score: :desc }
+        end
+
+        result
+      end
+
+      def results
+        @results ||=
+          begin
+            tmp = response['hits']['hits'].map do |result|
+              result['_source']
+            end
+
+            PagedArray.from(
+              tmp,
+              page,
+              per_page,
+              total
+            )
+          end
+      end
+
+      # (sadpanda) QuerySuggestions looks to product display rules for
+      # conditions to use when generating suggestions. We need content search
+      # to respond to the method to prevent any issues with suggestions for
+      # content.
+      #
+      # TODO: for v4, rework QuerySuggestions to not depend on another module
+      def product_display_query_clauses
+        []
+      end
+    end
+  end
+end

data/app/queries/workarea/search/search_suggestions.decorator

@@ -0,0 +1,9 @@
+module Workarea
+  decorate Search::SearchSuggestions, with: :content_search do
+    def query
+      super.tap do |query|
+        query[:bool][:must_not] = { term: { type: 'content' } }
+      end
+    end
+  end
+end

data/app/queries/workarea/search/storefront_search/response.decorator

@@ -0,0 +1,24 @@
+module Workarea
+  decorate Search::StorefrontSearch::Response, with: :content_search do
+
+    decorated do
+      attr_accessor :content_query
+    end
+
+    def reset!(params, by: nil)
+      # maintain compatiblity with workarea < 3.4 and 3.4+
+      # TODO: Remove if/when support for < 3.4 is not necessary
+      by.present? ? super : super(params)
+
+      @content_query = Search::ContentSearch.new(params)
+    end
+
+    def content_total
+      content_query.total
+    end
+
+    def query_suggestions
+      super + content_query.query_suggestions
+    end
+  end
+end

data/app/queries/workarea/search/storefront_search/spelling_correction_with_content.rb

@@ -0,0 +1,20 @@
+module Workarea
+  module Search
+    class StorefrontSearch
+      class SpellingCorrectionWithContent < StorefrontSearch::SpellingCorrection
+        def find_spell_correction(response)
+          return nil if response.has_filters? || any_results?(response)
+
+          product_correction = response.query.query_suggestions.first
+          content_correction = response.content_query.query_suggestions.first
+
+          product_correction.presence || content_correction
+        end
+
+        def any_results?(response)
+          response.total > 0 || response.content_query.total > 0
+        end
+      end
+    end
+  end
+end

data/app/queries/workarea/search/storefront_search/template_with_content.rb

@@ -0,0 +1,28 @@
+module Workarea
+  module Search
+    class StorefrontSearch
+      class TemplateWithContent
+        include Middleware
+
+        def call(response)
+          if response.has_filters?
+            yield
+            return
+          end
+
+          if response.total.zero? && response.content_total.zero?
+            response.template = 'no_results'
+          elsif response.params[:type].present?
+            response.template = response.params[:type]
+          elsif response.params[:sort].present?
+            response.template = 'show'
+          elsif response.content_total > response.total
+            response.template = 'content'
+          else
+            yield
+          end
+        end
+      end
+    end
+  end
+end