workarea-browse_option 2.1.6

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

@@ -0,0 +1,63 @@
+module Workarea
+  decorate Admin::FeaturedProductsController, with: :browse_option do
+    def select
+      search = Search::AdminProducts.new(view_model_options)
+      @search = Admin::FeaturedProductsSearchViewModel.new(
+        search,
+        view_model_options
+      )
+    end
+
+    def add
+      product_id, option = BrowseOptionIds.split(params[:product_id])
+      product = Catalog::Product.find(product_id)
+
+      @featurable.add_product(params[:product_id])
+
+      flash[:success] = t(
+        'workarea.admin.featured_products.flash_messages.added',
+        name: product.name
+      )
+
+      render(
+        partial: 'workarea/admin/featured_products/selected',
+        locals: {
+          featurable: @featurable,
+          product: wrap_in_browse_option_view_model(product, option)
+        }
+      )
+    end
+
+    def remove
+      product_id, option = BrowseOptionIds.split(params[:product_id])
+      product = Catalog::Product.find(product_id)
+
+      @featurable.remove_product(params[:product_id])
+
+      flash[:success] = t(
+        'workarea.admin.featured_products.flash_messages.removed',
+        name: product.name
+      )
+
+      render(
+        partial: 'workarea/admin/featured_products/unselected',
+        locals: {
+          featurable: @featurable,
+          product: wrap_in_browse_option_view_model(product, option)
+        }
+      )
+    end
+
+    private
+
+    def wrap_in_browse_option_view_model(product, option)
+      return Admin::ProductViewModel.wrap(product) \
+        unless product.browse_option.present?
+
+      Admin::FeaturedBrowseOptionProductViewModel.wrap(
+        product,
+        product.browse_option => option
+      )
+    end
+  end
+end

data/app/models/workarea/catalog/product.decorator

@@ -0,0 +1,20 @@
+module Workarea
+  decorate Catalog::Product, with: :browse_option do
+    decorated do
+      field :browse_option, type: String
+    end
+
+    def browses_by_option?
+      browse_option.present?
+    end
+
+    def browse_options
+      variants
+        .select(&:active?)
+        .map { |v| v.fetch_detail(browse_option) }
+        .flatten
+        .reject(&:blank?)
+        .uniq
+    end
+  end
+end

data/app/models/workarea/featured_browse_option_products.rb

@@ -0,0 +1,13 @@
+module Workarea
+  module FeaturedBrowseOptionProducts
+    def featured_product?(id)
+      product_ids.any? do |product_id|
+        product_id == id || BrowseOptionIds.extract(product_id) == id
+      end
+    end
+
+    def unique_product_ids
+      product_ids.map { |id| BrowseOptionIds.extract(id) }.uniq
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+module Workarea
+  module Search
+    class Storefront
+      class ProductOption < Product
+        def id
+          "#{super}-#{value.optionize}"
+        end
+
+        # URL to the primary image for display in autocomplete results.
+        #
+        # @return [String]
+        #
+        def primary_image
+          ProductOptionImageUrl.new(model, option: value).url
+        end
+
+        def option
+          options[:option]
+        end
+
+        def category_positions
+          Catalog::ProductPositions.find(
+            BrowseOptionIds.for(model, value),
+            categories: categorization.to_models
+          )
+        end
+
+        def value
+          options[:value].to_s
+        end
+
+        def variants
+          @variants ||= model.variants.select do |variant|
+            variant.matches_detail?(option, value)
+          end
+        end
+
+        def skus
+          variants.map(&:sku)
+        end
+
+        def as_document
+          result = super
+          result[:keywords][:option] = value
+          result[:facets][option] = [value]
+          result
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Workarea
+  module Search
+    class Storefront
+      class ProductOptionImageUrl < Workarea::ProductPrimaryImageUrl
+        def initialize(product, image_size: :small_thumb, option:)
+          super(product, image_size)
+          @option = option
+        end
+
+        def image
+          @product.images.find_by(option: @option)
+        rescue Mongoid::Errors::DocumentNotFound
+          super
+        end
+      end
+    end
+  end
+end

data/app/queries/workarea/categorization.decorator

@@ -0,0 +1,12 @@
+module Workarea
+  decorate Categorization, with: :browse_option do
+    private
+
+    def manual_models
+      return [] if @product.blank?
+      @manual_models ||= Catalog::Category.by_product(
+        [@product.id, *BrowseOptionIds.all_for(@product)]
+      ).to_a
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Workarea
+  decorate Search::ProductEntries, with: :browse_option do
+    def index_entries_for(product)
+      if product.browses_by_option?
+        product.browse_options.map do |value|
+          Search::Storefront::ProductOption.new(
+            product,
+            option: product.browse_option,
+            value: value
+          )
+        end
+      else
+        super
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module Workarea
+  decorate Search::RelatedProducts, with: :browse_option do
+    def search_product_ids
+      @search_product_ids ||= products.flat_map { |p| search_model_for(p) }.map(&:id)
+    end
+
+    def exclude_search_product_ids
+      @exclude_search_product_ids ||=
+        begin
+          catalog_ids = Array(params[:exclude_product_ids])
+          products = Catalog::Product.any_in(id: catalog_ids).to_a
+          products.flat_map { |p| search_model_for(p) }.map(&:id)
+        end
+    end
+
+    def search_model_for(product)
+      if product.browses_by_option?
+        product.browse_options.map do |value|
+          Search::Storefront::ProductOption.new(
+            product,
+            option: product.browse_option,
+            value: value
+          )
+        end
+      else
+        Search::Storefront::Product.new(product)
+      end
+    end
+  end
+end

data/app/services/workarea/browse_option_ids.rb

@@ -0,0 +1,39 @@
+module Workarea
+  class BrowseOptionIds
+    class << self
+      def all_for(product, options = [])
+        return [product.id] unless product.browses_by_option?
+
+        (Array.wrap(options).presence || product.browse_options).map do |option|
+          build(product.id, option.optionize)
+        end
+      end
+
+      def for(product, option = nil)
+        return product.id unless product.browses_by_option?
+
+        if option.present?
+          build(product.id, option.optionize)
+        else
+          all_for(product).first
+        end
+      end
+
+      def build(product_id, option)
+        [product_id, conjunction, option.optionize].join
+      end
+
+      def split(browse_option_id)
+        browse_option_id.to_s.split(conjunction)
+      end
+
+      def extract(browse_option_id)
+        split(browse_option_id).first
+      end
+
+      def conjunction
+        Workarea.config.browse_option_product_id_conjunction
+      end
+    end
+  end
+end

data/app/view_models/workarea/admin/bulk_action_product_edit_view_model.decorator

@@ -0,0 +1,10 @@
+module Workarea
+  decorate Admin::BulkActionProductEditViewModel, with: :browse_option do
+    def browse_options
+      [['None', nil]] +
+        Search::Settings.current.terms_facets.map do |facet|
+          [facet.titleize, facet]
+        end
+    end
+  end
+end

data/app/view_models/workarea/admin/featured_browse_option_product_view_model.rb

@@ -0,0 +1,18 @@
+module Workarea
+  module Admin
+    # Used for displaying each product option in feature product UI
+    class FeaturedBrowseOptionProductViewModel < ProductViewModel
+      def id
+        BrowseOptionIds.for(model, browse_option_value)
+      end
+
+      def name
+        [model.name, browse_option_value&.titleize].compact.join(' - ')
+      end
+
+      def browse_option_value
+        @options[model.browse_option]
+      end
+    end
+  end
+end

data/app/view_models/workarea/admin/featured_browse_option_products_view_model.rb

@@ -0,0 +1,23 @@
+module Workarea
+  module Admin
+    module FeaturedBrowseOptionProductsViewModel
+      def featured_products
+        @featured_products ||=
+          begin
+            models = Catalog::Product.any_in(id: model.unique_product_ids).to_a
+
+            results = model.product_ids.map do |id|
+              id, option = BrowseOptionIds.split(id)
+              tmp = models.detect { |m| m.id == id }
+              next unless tmp.present?
+
+              Admin::FeaturedBrowseOptionProductViewModel.new(
+                tmp,
+                tmp.browse_option => option&.optionize
+              )
+            end
+          end
+      end
+    end
+  end
+end

data/app/view_models/workarea/admin/featured_products_search_view_model.rb

@@ -0,0 +1,45 @@
+module Workarea
+  module Admin
+    class FeaturedProductsSearchViewModel < SearchViewModel
+      def results
+        @results ||= PagedArray.from(
+          browse_option_results,
+          model.results.page,
+          model.results.per_page,
+          total
+        )
+      end
+
+      # Yes, I know this is dumb. But there seems to be a bug with flat_map and
+      # flatten that is driving me fucking crazy and i need to avoid it.
+      #
+      def browse_option_results
+        results = []
+
+        persisted_results.each do |model|
+          if model.browses_by_option?
+            model.browse_options.each do |option|
+              results.push(
+                FeaturedBrowseOptionProductViewModel.wrap(
+                  model,
+                  view_model_options_for(model).merge(
+                    model.browse_option => option.optionize
+                  )
+                )
+              )
+            end
+          else
+            results.push(
+              FeaturedBrowseOptionProductViewModel.wrap(
+                model,
+                view_model_options_for(model)
+              )
+            )
+          end
+        end
+
+        results
+      end
+    end
+  end
+end

data/app/view_models/workarea/admin/product_view_model.decorator

@@ -0,0 +1,9 @@
+module Workarea
+  decorate Admin::ProductViewModel, with: :browse_option do
+    def browse_options
+      [['None', nil]] + variants.map do |variant|
+        variant.details.keys.map { |k| [k, k] }
+      end.flatten.map { |v| [v, v] }.uniq
+    end
+  end
+end

data/app/view_models/workarea/storefront/product_view_model/cache_key.decorator

@@ -0,0 +1,12 @@
+module Workarea
+  decorate Storefront::ProductViewModel::CacheKey, with: :browse_option do
+    private
+
+    def option_parts
+      option = @product.browse_option
+      return super unless option.present? && @options[option].present?
+
+      super.unshift(@options[option])
+    end
+  end
+end

data/app/view_models/workarea/storefront/product_view_model/image_collection.decorator

@@ -0,0 +1,26 @@
+module Workarea
+  decorate Storefront::ProductViewModel::ImageCollection, with: :browse_option do
+
+    def primary
+      @browse_option_primary ||= browse_option_image || super
+    end
+
+    private
+
+    def browse_option_image
+      unless @product.browses_by_option? && current_browse_option.present?
+        return
+      end
+
+      @all.detect do |image|
+        image.option&.optionize.in?(
+          Array(current_browse_option).map(&:optionize)
+        )
+      end
+    end
+
+    def current_browse_option
+      @options[:option] || @options[@product.browse_option.optionize]
+    end
+  end
+end

data/app/view_models/workarea/storefront/product_view_model.decorator

@@ -0,0 +1,15 @@
+module Workarea
+  decorate Storefront::ProductViewModel, with: :browse_option do
+    def browse_link_options
+      @browse_link_options_with_browse_option ||= super.tap do |link_options|
+        link_options[browse_option.optionize] =
+          options[:option] if options[:option].present?
+      end
+    end
+
+    def current_browse_option
+      return nil unless browse_option.present?
+      options[:option] || options[browse_option.optionize]
+    end
+  end
+end

data/app/views/workarea/admin/bulk_action_product_edits/_browse_option_field.html.haml

@@ -0,0 +1,10 @@
+.bulk-actions__sub-section
+  .grid
+    .grid__cell
+      .property-toggle
+        .property-toggle__checkbox
+          = check_box_tag 'toggle_browses_by', nil, nil, class: 'toggle-property__check-box'
+        .property-toggle__property
+          .property
+            = label_tag 'bulk_action[settings][browse_option]', t('workarea.admin.catalog_products.browse_by_option'), class: 'property__name'
+            = select_tag 'bulk_action[settings][browse_option]', options_for_select(bulk_action.browse_options), disabled: true, class: 'toggle-property__input text-box', data: { property_toggle_allow_blank: '' }

data/app/views/workarea/admin/catalog_products/_browse_option_attribute_card.html.haml

@@ -0,0 +1,3 @@
+%li
+  %strong= t("workarea.admin.catalog_products.card.browse_option")
+  = product.browse_option.presence || '(none)'

data/app/views/workarea/admin/catalog_products/_browse_option_field.html.haml

@@ -0,0 +1,3 @@
+.property
+  = label_tag 'product_browse_option', t('workarea.admin.catalog_products.browse_by_option'), class: 'property__name'
+  = select_tag 'product[browse_option]', options_for_select(product.browse_options, product.browse_option)

data/app/views/workarea/api/storefront/products/_browse_option_field.json.jbuilder

@@ -0,0 +1,2 @@
+json.browse_option product.browse_option
+json.current_browse_option product.current_browse_option

data/app/workers/workarea/bulk_index_products.decorator

@@ -0,0 +1,34 @@
+module Workarea
+  decorate BulkIndexProducts, with: :browse_option do
+    class_methods do
+      def perform(ids = Catalog::Product.pluck(:id))
+        ids = ids.map { |id| BrowseOptionIds.extract(id) }.uniq
+        super(ids)
+      end
+
+      def perform_by_models(products)
+        return if products.blank?
+        delete_existing_documents(products)
+        super
+      end
+
+      private
+
+      def delete_existing_documents(products)
+        I18n.for_each_locale do
+          ids = products.map do |product|
+            id = Search::Storefront::Product.new(product).keywords[:catalog_id]
+            id.gsub(Workarea.config.search_index_id_escape_regex) { |match| "\\#{match}" }
+          end
+          query = { query: { terms: { 'keywords.catalog_id': ids } } }
+          hits = Search::Storefront.search(query)['hits']['hits']
+          documents = hits.map do |hit|
+            { id: hit['_source']['id'], bulk_action: :delete }
+          end
+
+          Search::Storefront.bulk(documents)
+        end
+      end
+    end
+  end
+end

data/app/workers/workarea/index_category_changes.decorator

@@ -0,0 +1,7 @@
+module Workarea
+  decorate IndexCategoryChanges, with: :browse_option do
+    def require_index_ids(previous_ids, new_ids)
+      super.map { |id| BrowseOptionIds.extract(id) }
+    end
+  end
+end

data/app/workers/workarea/index_product.decorator

@@ -0,0 +1,18 @@
+module Workarea
+  decorate IndexProduct, with: :browse_option do
+    class_methods do
+      def perform(product)
+        clear(product)
+        super
+      end
+
+      def clear(product)
+        id = Search::Storefront::Product.new(product).keywords[:catalog_id]
+        id.gsub!(Workarea.config.search_index_id_escape_regex) { |match| "\\#{match}" }
+        hits = Search::Storefront.search("keywords.catalog_id:#{id}")['hits']['hits']
+
+        hits.each { |hit| Search::Storefront.delete(hit['_id']) }
+      end
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,17 @@
+#!/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/browse_option/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,21 @@
+Workarea.append_partials(
+  'admin.product_fields',
+  'workarea/admin/catalog_products/browse_option_field'
+)
+
+Workarea.append_partials(
+  'admin.product_attributes_card',
+  'workarea/admin/catalog_products/browse_option_attribute_card'
+)
+
+Workarea.append_partials(
+  'admin.product_bulk_update_settings',
+  'workarea/admin/bulk_action_product_edits/browse_option_field'
+)
+
+if Workarea::Plugin.installed?('Workarea::Api::Storefront')
+  Workarea.append_partials(
+    'api.storefront.product_details',
+    'workarea/api/storefront/products/browse_option_field'
+  )
+end

data/config/initializers/configuration.rb

@@ -0,0 +1,17 @@
+Workarea.configure do |config|
+  # Used to find irregular characters in product ids that can cause issues
+  # with finding a document in elasticsearch when reindexing.
+  config.search_index_id_escape_regex = %r{
+    ( [-!\(\)\{\}\[\]^"~*?:\\\/]    # A special character
+      | &&                          # Boolean &&
+      | \|\|                        # Boolean ||
+    )
+  }x
+
+  # Used to combine product_id and browse option value when storing
+  # each option in featured products in the format of [ID][CONJUNCTION][OPTION]
+  # i.e. 1018-5915--blue. Changing this after a category has featured a browse
+  # option will not update the category automatically and will require a
+  # reindex of products.
+  config.browse_option_product_id_conjunction = '--'
+end

data/config/locales/en.yml

@@ -0,0 +1,8 @@
+---
+en:
+  workarea:
+    admin:
+      catalog_products:
+        browse_by_option: Browse by Option
+        card:
+          browse_option: 'Browse Option:'

data/lib/tasks/browse_option_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :browse_option do
+#   # Task goes here
+# end

data/lib/workarea/browse_option/engine.rb

@@ -0,0 +1,20 @@
+module Workarea
+  module BrowseOption
+    class Engine < ::Rails::Engine
+      include Workarea::Plugin
+      isolate_namespace Workarea::BrowseOption
+
+      config.to_prepare do
+        Catalog::Category.include(FeaturedBrowseOptionProducts)
+        Search::Customization.include(FeaturedBrowseOptionProducts)
+
+        Admin::CategoryViewModel.include(
+          Admin::FeaturedBrowseOptionProductsViewModel
+        )
+        Admin::SearchCustomizationViewModel.include(
+          Admin::FeaturedBrowseOptionProductsViewModel
+        )
+      end
+    end
+  end
+end

data/lib/workarea/browse_option/version.rb

@@ -0,0 +1,5 @@
+module Workarea
+  module BrowseOption
+    VERSION = '2.1.6'.freeze
+  end
+end

data/lib/workarea/browse_option.rb

@@ -0,0 +1,11 @@
+require 'workarea'
+require 'workarea/storefront'
+require 'workarea/admin'
+
+require 'workarea/browse_option/engine'
+require 'workarea/browse_option/version'
+
+module Workarea
+  module BrowseOption
+  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