workarea-browse_option 2.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 36962f203f973f8b170772166b3d044e8208430a9d1e64bc188251dcd54e6a14
+  data.tar.gz: 71bdd4b75a37c88c7ce5ab2ff212edce7a2890d4b70a22122755153326676146
+SHA512:
+  metadata.gz: 9f2655f7fd7dbde853e5cccecb59f4d1ac724a5cbad3d8162769c7a9aaa240bd1bf1b208cd136690aadadb9e467935194b54226040cfcab119fb6af88a4a1025
+  data.tar.gz: 15c6587978dd8b514ac0dc869892363d64c3fc9a18ba74b74ba870292643949475400e358cc1e76322c05d49d21ffe1d81de397755a92066b261b85dceb4150f

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,14 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+Gemfile.lock
+test/dummy/public/system/
+.DS_STORE
+node_modules
+test/reports
+package.json
+yarn.lock

data/CHANGELOG.md

@@ -0,0 +1,315 @@
+Workarea Browse Option 2.1.6 (2019-08-21)
+--------------------------------------------------------------------------------
+
+*   Open Source!
+
+
+
+Workarea Browse Option 2.1.5 (2019-08-06)
+--------------------------------------------------------------------------------
+
+*   Omit Optionless Images From Primary Image Lookup
+
+    When looking up a primary image based on the browse option, omit any
+    images that have no option set. This prevents an error where
+    `.optionize` gets called on a `nil` object.
+
+    Discovered by **Ryan Tulino** of Syatt. Thanks Ryan!
+
+    WLBBOPTION-33
+    Tom Scott
+
+
+
+Workarea Browse Option 2.1.4 (2019-07-23)
+--------------------------------------------------------------------------------
+
+*   Fix Inconsistency When Products Are Packaged
+
+    Products that browse by option can be packaged into `package` or
+    `family` products, which query for a set of product IDs. These are not
+    necessarily the same IDs that you would get out of MongoDB, in the
+    browse-by-option world, they include the option for which you are
+    indexing in search. Because of this, browse option products which are
+    part of a larger package product are not visible in some areas of the
+    storefront and admin. This has now been fixed by redefining the
+    `#packaged_products` method to query for the base ID of each product in
+    Mongo, and then fill in the correct option based on the product's
+    `browse_option` value. While this won't enforce that option in the
+    package or family product, it will pre-select the option on the
+    storefront so that it will display properly and consistently with what
+    the admin picked out when creating the product.
+
+    WLBBOPTION-30
+    Tom Scott
+
+*   Bulk Delete Product Options Before Reindexing
+
+    Revert to the bulk action instead of using delete_by_query to avert
+    performance problems when used on a large scale.
+
+    WLBBOPTION-32
+    Tom Scott
+
+*   Fix Faceting of Product Options
+
+    When browse-by-option products are indexed, a lot of data was previously
+    lost due to the way each variant details hash was merged with another.
+    The arrays that make up each detail did not concatenate the way one might
+    expect when merging hashes together, so the `#variant_facets` method has
+    been updated to iterate over each variant's details hash and safely
+    combine all fields into an Array of values. This successfully groups
+    together the facets for a particular browse-option, so for example, a
+    product with multiple sizes assigned to the same color will have all of
+    those sizes indexed as facet values in search.
+
+    WLBBOPTION-29
+    Tom Scott
+
+*   Use latest released Workarea version
+
+    Tom Scott
+
+
+
+Workarea Browse Option 2.1.3 (2019-05-28)
+--------------------------------------------------------------------------------
+
+*   Use Browse Option IDs in Categorizations
+
+    When browse option products are manually categorized from the product
+    page, it is assumed that all options of the product should be featured
+    in the category. Workarea now decorates the
+    `Admin::CategorizationsController` to iterate over all browse option IDs
+    and add them to the category's featured products instead of the ID of
+    the main product, which may not actually exist in the index.
+
+    WLBBOPTION-24
+    Tom Scott
+
+*   Fix Removing Featured Browse Option Products
+
+    Featured Browse Option Products appeared to not remove properly because
+    their response was rendering back the first option rather than the one
+    that was selected. As a result, the products stayed in featured product
+    IDs, but we still showed a message indicating they had been removed.
+    The view model used to render the product back once it's been
+    added/removed from featured products has been changed to
+    `Admin::FeaturedBrowseOptionProductViewModel`, and the controller passes
+    in the current product's browse option if it is configured to browse by
+    option.
+
+    WLBBOPTION-24
+    Tom Scott
+
+
+
+Workarea Browse Option 2.1.2 (2019-04-02)
+--------------------------------------------------------------------------------
+
+*   Handle indexing changes to categories with browse option product ids
+
+    WLBBOPTION-28
+    Matt Duffy
+
+*   Update for workarea v3.4 compatibility
+
+    WLBBOPTION-27
+    Matt Duffy
+
+
+
+Workarea Browse Option 2.1.1 (2019-01-22)
+--------------------------------------------------------------------------------
+
+*   Improve readme
+
+    WLBBOPTION-26
+    ECOMMERCE-6523
+    Chris Cressman
+
+
+
+Workarea Browse Option 2.1.0 (2018-10-16)
+--------------------------------------------------------------------------------
+
+*   Allow each occurance of browse option product to be featured separately
+
+    WLBBOPTION-23
+    Matt Duffy
+
+
+
+Workarea Browse Option 2.0.0 (2018-05-24)
+--------------------------------------------------------------------------------
+
+*   Update tests to work with bulk action changes
+
+    WLBBOPTION-21
+    Matt Duffy
+
+*   Leverage Workarea Changelog task
+
+    ECOMMERCE-5355
+    Curt Howard
+
+*   Fix search results upper limit when bulk-indexing
+
+    When bulk-indexing products, set the `:size` option to the total amount
+    of entries in the index, not to the total amount of products. This is
+    because browse_option products typically have an entry per variant, and
+    thus there are more results than allowed back using the Elasticsearch
+    query. We're now finding the total amount of entries in the index for
+    these products and setting the `:size` param to that instead.
+
+    WLBBOPTION-20
+    Tom Scott
+
+*   Account for SKUs with spaces in them
+
+    When SKUs have spaces in them, some of our queries that split lists of
+    product IDs on a space character (for deleting and reindexing each
+    browse-option for a single parent product) don't behave very well.
+    Instead of making a bare query with each ID separated by a space, run a
+    `terms` query for the collection of `catalog_ids` as an Array. This
+    ensures that each `catalog_id` is treated in isolation.
+
+    WLBBOPTION-19
+    Tom Scott
+
+*   Correct recommended product IDs
+
+    Product IDs coming through for recommendations were not correct, because
+    they were using the base product ID without each variant's browse option
+    value, due to the wrong search model being used in the
+    `Search::RelatedProducts` query. Map over all products as well as their
+    options using the `ProductOption` search model if the product is browsed
+    by option.
+
+    WLBBOPTION-18
+    Tom Scott
+
+*   Fixes for headless Chrome
+
+    Ben Crouse
+
+
+
+Workarea Browse by Option 1.2.5 (2018-02-20)
+--------------------------------------------------------------------------------
+
+*   Find image for browse option products in search
+
+    The search model for browse-by-option products didn't include an
+    override for `#primary_image` that finds the correct image by its
+    option. If an image cannot be found, the product's original
+    `primary_image` is used as a default.
+
+    WLBBOPTION-10
+    Tom Scott
+
+
+Workarea Browse by Option 1.2.4 (2018-01-09)
+--------------------------------------------------------------------------------
+
+*   Rework id escaping for product indexing for compatibility with workarea v3.2
+
+    WLBBOPTION-17
+    Matt Duffy
+
+
+Workarea Browse by Option 1.2.3 (2017-11-14)
+--------------------------------------------------------------------------------
+
+*   Add regex to escape irregular product ids during reindexing
+
+    WLBBOPTION-15
+    Matt Duffy
+
+*   Add regex to escape irregular product ids during reindexing
+
+    WLBBOPTION-15
+    Matt Duffy
+
+
+Workarea Browse by Option 1.2.2 (2017-10-31)
+--------------------------------------------------------------------------------
+
+*   Move configuration into initializers
+
+    WLBBOPTION-16
+    Matt Duffy
+
+
+Workarea Browse by Option 1.2.1 (2017-09-26)
+--------------------------------------------------------------------------------
+
+*   Don't show browse by option product if all variants are inactive
+
+    WLBBOPTION-12
+    Brian Berg
+
+
+Workarea Browse by Option 1.2.0 (2017-09-22)
+--------------------------------------------------------------------------------
+
+*   Update for compatibility with workarea v3.1
+
+    WLBBOPTION-11
+    Matt Duffy
+
+    
+Workarea Browse by Option 1.1.2 (2017-09-26)
+--------------------------------------------------------------------------------
+
+*   Don't show browse by option product if all variants are inactive
+
+    WLBBOPTION-12
+    Brian Berg
+
+
+Workarea Browse by Option 1.1.1 (2017-09-22)
+--------------------------------------------------------------------------------
+
+*   Fix workarea dependency to < 3.1.0
+
+    WLBBOPTION-13
+    Curt Howard
+
+
+Workarea Browse by Option 1.1.0 (2017-09-15)
+--------------------------------------------------------------------------------
+
+*   Handle products that do not have browse option set
+
+    WLBBOPTION-9
+    Matt Duffy
+
+*   Add partial to render browse option field for storefront api products
+
+    WLBBOPTION-9
+    Matt Duffy
+
+
+Workarea Browse by Option 1.0.0 (2017-05-17)
+--------------------------------------------------------------------------------
+
+*   Ensure selecting no browse option on product bulk editing clears the field
+
+    WLBBOPTION-7
+    Matt Duffy
+
+*   Fix param value of browse option for bulk action product edit, add test
+
+    WLBBOPTION-7
+    Matt Duffy
+
+*   Fix issues with bulk editing browse options
+
+    WLBBOPTION-7
+    Matt Duffy
+
+*   Update for compatibility with workarea 3
+
+    WLBBOPTION-5
+    Matt Duffy

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,12 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "git@github.com:#{repo}.git" }
+
+# Declare your gem's dependencies in browse_option.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+gem 'bundler-audit'
+gem 'listen'
+
+gem 'workarea-api', '>= 4.x'

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,67 @@
+Workarea Browse Option
+================================================================================
+
+A Workarea Commerce plugin that enables the display of products by their various options (e.g. color) when browsing them in the Storefront.
+
+
+Overview
+--------------------------------------------------------------------------------
+
+* Allows each product to be "broken out" into multiple representations when browsing in the Storefront, based on a particular product option, such as color
+* Allows admins to choose which products "browse by option" and to choose the specific option for each product
+* Allows admins to choose a particular representation of the product (e.g. the blue one) when featuring it within a category or search results
+* Prevents representations of the same product from appearing in collections of related products (e.g. upsells)
+
+Getting Started
+--------------------------------------------------------------------------------
+
+Add the gem to your application's Gemfile:
+
+```ruby
+# ...
+gem 'workarea-browse_option'
+# ...
+```
+
+Update your application's bundle.
+
+```bash
+cd path/to/application
+bundle
+```
+
+Features
+--------------------------------------------------------------------------------
+
+
+### Administration of Browse Options
+
+* When editing a product in the Admin (or bulk editing many), an administrator can choose a "browses by" option for that product
+* The UI for choosing this option is a select menu, which is populated with the keys of the details for all of the product's variants
+* When a value is selected for the browse option, the product is said to "browse by option" and is represented differently in Elasticsearch (see below)
+* Each product's attributes card in the Admin displays its browse option (if any)
+
+
+### Search Indexing & Browsing
+
+* Products that browse by option are stored as multiple documents (one per value of the selected option) within each Storefront search index
+* Each option-specific search document is built from only those variants of the product that match the particular option value (e.g. blue for color)
+* When browsing (e.g. search results and category listings), such products potentially appear in results multiple times (up to once per search document in that index)
+* Each representation of a product uses a relevant product image (if available), such as a blue image for the blue representation of the product
+* Clicking through any of the product's browse results takes the customer to the same product details (from Mongo)
+
+
+### State/Caching in the Storefront
+
+* If a product browses by option, the particular option value is persisted through the `:option` param when clicking through to the product's details
+* When a product browses by option and the `:option` param is set, the specific option value is used in the product's cache key, affecting show, summary, and pricing view caches
+
+Workarea Commerce Documentation
+--------------------------------------------------------------------------------
+
+See [https://developer.workarea.com](https://developer.workarea.com) for Workarea Commerce documentation.
+
+License
+--------------------------------------------------------------------------------
+
+Workarea Browse Option is released under the [Business Software License](LICENSE)

data/Rakefile

@@ -0,0 +1,52 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Tasker'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+load 'workarea/changelog.rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'workarea/browse_option/version'
+
+desc "Release version #{Workarea::BrowseOption::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::BrowseOption::VERSION} -m 'Tagging #{Workarea::BrowseOption::VERSION}'"
+  system 'git push --tags'
+
+  system 'gem build workarea-browse_option.gemspec'
+  system "gem push workarea-browse_option-#{Workarea::BrowseOption::VERSION}.gem"
+  system "gem push workarea-browse_option-#{Workarea::BrowseOption::VERSION}.gem --host #{host}"
+  system "rm workarea-browse_option-#{Workarea::BrowseOption::VERSION}.gem"
+end

data/app/controllers/workarea/admin/categorizations_controller.decorator

@@ -0,0 +1,25 @@
+module Workarea
+  decorate Admin::CategorizationsController, with: :browse_option do
+    def create
+      ids = BrowseOptionIds.all_for(@product.model)
+
+      Catalog::Category.in(id: params[:category_ids]).each do |category|
+        ids.each { |id| category.product_ids.prepend(id) }
+        category.save!
+      end
+
+      flash[:success] = t('workarea.admin.categorizations.flash_messages.added')
+      redirect_to catalog_product_categorizations_path(@product)
+    end
+
+    def destroy
+      category = Catalog::Category.find_by(slug: params[:id])
+      ids = BrowseOptionIds.all_for(@product.model)
+      category.product_ids.reject! { |id| ids.include?(id) }
+      category.save!
+
+      flash[:success] = t('workarea.admin.categorizations.flash_messages.removed')
+      head :ok
+    end
+  end
+end