workarea-core 3.4.45 → 3.5.0.beta.1

data/app/middleware/workarea/query_cache_middleware.rb

@@ -0,0 +1,55 @@
+module Workarea
+  # Execute sidekiq jobs with query caches enabled. Each job can specify one or
+  # both query_caches to use via `query_cache`, `mongoid_query_cache`, or
+  # `elasticsearch_query_cache` options.
+  #
+  # @return [ Object ] The result of the call.
+  #
+  class QueryCacheMiddleware
+    def initialize(options = {})
+      @options = options
+    end
+
+    def call(worker, msg, queue)
+      cache_options = CacheOptions.new(worker.class.sidekiq_options)
+      return yield if cache_options.none?
+
+      if cache_options.all?
+        Mongoid::QueryCache.cache do
+          Elasticsearch::QueryCache.cache do
+            yield
+          end
+        end
+      elsif cache_options.mongoid?
+        Mongoid::QueryCache.cache { yield }
+      elsif cache_options.elasticsearch?
+        Elasticsearch::QueryCache.cache { yield }
+      end
+    ensure
+      Mongoid::QueryCache.clear_cache
+      Elasticsearch::QueryCache.clear_cache
+    end
+
+    class CacheOptions
+      def initialize(options)
+        @options = options
+      end
+
+      def none?
+        !mongoid? && !elasticsearch?
+      end
+
+      def all?
+        mongoid? && elasticsearch?
+      end
+
+      def mongoid?
+        !!(@options['mongoid_query_cache'] || @options['query_cache'])
+      end
+
+      def elasticsearch?
+        !!(@options['elasticsearch_query_cache'] || @options['query_cache'])
+      end
+    end
+  end
+end

data/app/middleware/workarea/release_server_middleware.rb

@@ -5,7 +5,7 @@ module Workarea
     end
 
     def call(worker, msg, queue)
-      Release.with_current(nil) { yield }
+      Release.without_current { yield }
     end
   end
 end

data/app/models/workarea/application_document.rb

@@ -14,7 +14,7 @@ module Workarea
     end
 
     def releasable?
-      false
+      is_a?(Releasable)
     end
 
     private

data/app/models/workarea/bulk_action/product_edit.rb

@@ -36,15 +36,15 @@ module Workarea
       end
 
       def apply_details!(product)
-        product.details = HashUpdate
-          .new(original: product.details, adds: add_details, removes: remove_details)
-          .result
+        HashUpdate
+          .new(adds: add_details, removes: remove_details)
+          .apply(product.details)
       end
 
       def apply_filters!(product)
-        product.filters = HashUpdate
-          .new(original: product.filters, adds: add_filters, removes: remove_filters)
-          .result
+        HashUpdate
+          .new(adds: add_filters, removes: remove_filters)
+          .apply(product.filters)
       end
 
       def apply_pricing!(product)

data/app/models/workarea/calculate_percent_change.rb

@@ -1,7 +1,7 @@
 module Workarea
   module CalculatePercentChange
     def calculate_percent_change(first, second)
-      return nil if first.zero?
+      return nil if first.blank? || first.zero?
       ((second.to_f - first) / first.to_f) * 100
     end
   end

data/app/models/workarea/catalog/category.rb

@@ -23,8 +23,6 @@ module Workarea
       validates :client_id, uniqueness: true, allow_blank: true
 
       scope :recent, ->(l = 5) { order_by([:created_at, :desc]).limit(l) }
-      scope :by_product, ->(id) { self.in(product_ids: id) }
-
       index({ client_id: 1 })
     end
   end

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

@@ -12,7 +12,6 @@ module Workarea
       field :name, type: String, localize: true
       field :filters, type: Hash, default: {}, localize: true
       field :template, type: String, default: 'generic'
-      field :digital, type: Boolean, default: false
       field :customizations, type: String
       field :browser_title, type: String, localize: true
       field :meta_description, type: String, localize: true
@@ -21,6 +20,14 @@ module Workarea
       field :purchasable, type: Boolean, default: true
       field :default_category_id, type: String
 
+      # DEPRECATED. This field will be remove in v3.6 in favor of using
+      # Fulfillment::SKU to determine behavior in checkout for items not
+      # requiring phsyical fulfillment.
+      #
+      # TODO: remove in v3.6
+      #
+      field :digital, type: Boolean, default: false
+
       index({ 'variants.sku': 1 })
       index({ last_indexed_at: 1 })
       index({ 'images.option': 1 })
@@ -119,7 +126,17 @@ module Workarea
       end
 
       def active?
-        super && variants.active.any?
+        super && active_by_relations?
+      end
+
+      # This hook allows plugins extending this model a place to hook into
+      # #active? without overriding all the logic in that method's `super`. For
+      # example, package products.
+      #
+      # @return [Boolean]
+      #
+      def active_by_relations?
+        variants.active.any?
       end
 
       # Whether to allow purchasing on this product. This is always false if

data/app/models/workarea/checkout/collect_payment.rb

@@ -33,7 +33,16 @@ module Workarea
       end
 
       def action
-        Workarea.config.auto_capture ? 'purchase!' : 'authorize!'
+        # TODO deprecated, remove in v3.6
+        return 'purchase!' if Workarea.config.auto_capture
+
+        if @order.items.all?(&:requires_shipping?)
+          Workarea.config.checkout_payment_action[:shipped]
+        elsif @order.items.any?(&:requires_shipping?)
+          Workarea.config.checkout_payment_action[:mixed]
+        else
+          Workarea.config.checkout_payment_action[:not_shipped]
+        end
       end
     end
   end

data/app/models/workarea/checkout/fraud/analyzer.rb

@@ -0,0 +1,44 @@
+module Workarea
+  class Checkout
+    module Fraud
+      class Analyzer
+        attr_reader :checkout
+
+        delegate :order, :user, :payment, :payment_profile, :shipping, :shippings,
+            to: :checkout, allow_nil: true
+        delegate :fraud_suspected?, to: :order
+
+        def initialize(checkout)
+          @checkout = checkout
+        end
+
+        def decide!
+          begin
+            decision = make_decision.tap { |r| r.analyzer = self.class.name }
+          rescue => e
+            decision = error_decision(e.message)
+          ensure
+            order.set_fraud_decision!(decision)
+          end
+        end
+
+        # Gets a decision about the fraudlence of a given checkout
+        #
+        # @param [Workarea::Checkout] checkout
+        #
+        # @return [Workarea::Order::FraudDecision]
+        #
+        def make_decision(checkout = nil)
+          raise(NotImplementedError, "#{self.class} must implement the #make_decision method")
+        end
+
+        def error_decision(message)
+          Workarea::Order::FraudDecision.new(
+            decision: :no_decision,
+            message: "An error occured during the fraud check: #{message}"
+          )
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/checkout/fraud/no_decision_analyzer.rb

@@ -0,0 +1,14 @@
+module Workarea
+  class Checkout
+    module Fraud
+      class NoDecisionAnalyzer < Analyzer
+        def make_decision
+          Workarea::Order::FraudDecision.new(
+            decision: :no_decision,
+            message: I18n.t('workarea.storefront.fraud.default_message')
+          )
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/checkout/fraud/test_analyzer.rb

@@ -0,0 +1,26 @@
+module Workarea
+  class Checkout
+    module Fraud
+      class TestAnalyzer < Analyzer
+        def make_decision
+          if order.email == "decline@workarea.com"
+            Workarea::Order::FraudDecision.new(
+              decision: :declined,
+              message: "Forced test fraud decline."
+            )
+          elsif order.email == "approved@workarea.com"
+            Workarea::Order::FraudDecision.new(
+              decision: :approved,
+              message: "Forced test fraud approval."
+            )
+          else
+            Workarea::Order::FraudDecision.new(
+              decision: :no_decision,
+              message: "Workarea default fraud check. Automatic no decision."
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/checkout.rb

@@ -158,14 +158,10 @@ module Workarea
     # Used in auto completing an order for a logged in user.
     #
     # @param [Hash] parameters for updating
-    # @return [Boolean] whether the update was successful.
+    # @return [self]
     #
     def update(params = {})
-      return true if params.blank?
-
-      steps.reduce(true) do |result, step|
-        result &= step.new(self).update(params)
-      end
+      steps.each { |s| s.new(self).update(params) }
     end
 
     # Whether this checkout needs any further information
@@ -191,6 +187,9 @@ module Workarea
       return false unless shippable?
       return false unless payable?
 
+      fraud_analyzer.decide!
+      return false if fraud_analyzer.fraud_suspected?
+
       inventory.purchase
       return false unless inventory.captured?
 
@@ -221,6 +220,15 @@ module Workarea
       payment.valid? && payment_collection.valid?
     end
 
+    # Recalculate the amounts on tenders if payment is persisted.
+    #
+    # @return [Boolean, nil]
+    #
+    def adjust_tender_amounts!
+      return unless payment.persisted?
+      payment.adjust_tender_amounts(order.total_price)
+    end
+
     private
 
     def auto_complete
@@ -234,5 +242,9 @@ module Workarea
     def place_order_side_effects
       CreateFulfillment.new(order).perform
     end
+
+    def fraud_analyzer
+      @fraud_analyzer ||= Workarea.config.fraud_analyzer.constantize.new(self)
+    end
   end
 end

data/app/models/workarea/configuration/admin.rb

@@ -0,0 +1,25 @@
+module Workarea
+  module Configuration
+    class Admin
+      include ApplicationDocument
+      include ::Mongoid::Encrypted
+
+      delegate :definition, to: :class
+
+      def self.instance
+        first || create
+      end
+
+      def self.definition
+        Workarea.config.admin_definition
+      end
+
+      definition.fields.each do |f|
+        field f.key,
+          type: f.type_class,
+          default: f.default,
+          encrypted: f.encrypted?
+      end
+    end
+  end
+end

data/app/models/workarea/configuration/params.rb

@@ -0,0 +1,45 @@
+module Workarea
+  module Configuration
+    class Params
+      def initialize(params)
+        @params = params
+      end
+
+      def to_h
+        Admin.definition.fields.each_with_object({}) do |field, memo|
+          next unless @params.key?(field.key)
+          value = @params[field.key]
+
+          formatted_value =
+            if value.present? && respond_to?(field.type)
+              send(field.type, field, value)
+            else
+              value
+            end
+
+          memo[field.key] =
+            if formatted_value.blank? && !field.allow_blank?
+              field.default
+            else
+              formatted_value
+            end
+        end
+      end
+
+      def array(field, value)
+        Array.wrap(CSV.parse(value).first).map(&:strip)
+      end
+
+      def hash(field, value)
+        value.each_slice(2)
+             .to_h
+             .reject { |k, v| k.blank? || v.blank? }
+             .transform_values { |v| field.values_type_class.mongoize(v) }
+      end
+
+      def duration(field, value)
+        value.first.to_i.send(value.last.to_sym)
+      end
+    end
+  end
+end

data/app/models/workarea/content/asset.rb

@@ -7,6 +7,7 @@ module Workarea
 
     field :name, type: String
     field :type, type: String
+    field :alt_text, type: String
 
     #
     # The values for the following fields are automatically populated via
@@ -45,15 +46,6 @@ module Workarea
     after_validation :set_name
     after_validation :set_type
 
-    # TODO v3.5 remove
-    def self.placeholder
-      warn <<~eos
-        [DEPRECATION] `Asset.placeholder` is deprecated and will be removed in
-        version 3.5.0. Please use `Asset.image_placeholder` instead.
-      eos
-      self.image_placeholder
-    end
-
     def self.image_placeholder
       find_by(file_name: Workarea.config.image_placeholder_image_name)
 
@@ -91,17 +83,12 @@ module Workarea
       tagged_with(['favicon', type].compact.join('-'))
     end
 
-    def favicon?
-      tags.any? { |t| t.starts_with?('favicon') }
+    def self.open_graph_default
+      tagged_with('og-default').first
     end
 
-    # TODO v3.5 remove
-    def placeholder?
-      warn <<~eos
-        [DEPRECATION] `Asset#placeholder?` is deprecated and will be removed in
-        version 3.5.0. Please use `Asset#image_placeholder?` instead.
-      eos
-      image_placeholder?
+    def favicon?
+      tags.any? { |t| t.starts_with?('favicon') }
     end
 
     def image_placeholder?

data/app/models/workarea/content/block.rb

@@ -8,7 +8,7 @@ module Workarea
     # The data field is passed to the partial as local assigns.
     #
     # This flexibility makes it very easy to add a new type to the system:
-    # 1) Define the block type using the DSL ({Workarea::Content.define_block_types})
+    # 1) Define the block type using the DSL ({Workarea.define_content_block_types})
     # 2) Add the storefront partial, e.g. workarea/storefront/content_blocks/types/_foo.html.haml
     #
     class Block
@@ -91,7 +91,7 @@ module Workarea
       end
 
       # The {Workarea::Content::BlockType} that this block is. See documentation
-      # for {Content.define_block_types} for info how to define block types.
+      # for {Workarea.define_content_block_types} for info how to define block types.
       #
       # @return [Workarea::Content::BlockType]
       #
@@ -127,6 +127,12 @@ module Workarea
         self == siblings.select(&:active?).last
       end
 
+      def to_draft
+        result = Content::BlockDraft.instantiate(as_document.merge('content_id' => _parent.id))
+        result.new_record = true
+        result
+      end
+
       private
 
       def set_defaults

data/app/models/workarea/content/block_draft.rb

@@ -2,9 +2,12 @@ module Workarea
   class Content
     class BlockDraft
       include ApplicationDocument
-      include Mongoid::Attributes::Dynamic
+      include Releasable
 
       field :content_id, type: String
+      Block.fields.except('_id').each do |name, field_instance|
+        field name, field_instance.options.except(:klass)
+      end
 
       index(
         { created_at: 1 },
@@ -29,7 +32,9 @@ module Workarea
       end
 
       def to_block
-        content.blocks.build(attributes.except('content_id'))
+        result = Content::Block.instantiate(as_document.except('content_id'))
+        result.new_record = true
+        result
       end
     end
   end

data/app/models/workarea/content/block_type.rb

@@ -83,7 +83,7 @@ module Workarea
 
       # Define a fieldset on the block type. The block will be evaluated in the
       # {Workarea::Content::Fieldset} to provide the DSL. See more info on the
-      # block type DSL at {Workarea::Content.define_block_types}
+      # block type DSL at {Workarea.define_content_block_types}.
       #
       # @param name [String]
       # @yield evaluated in the {Workarea::Content::Fieldset} for DSL
@@ -130,7 +130,7 @@ module Workarea
       # Define a {Workarea::Content::Field} on this block type. Given that this
       # is being declared without a {Workarea::Content::Fieldset}, this will be
       # added to a default {Workarea::Content::Fieldset} called 'Settings'. See
-      # more info on the block type DSL at {Workarea::Content.define_block_types}
+      # more info on the block type DSL at {Workarea.define_content_block_types}
       #
       # @param name [String]
       # @param type [Symbol] a slug version of a {Workarea::Content::Field} subclass

data/app/models/workarea/content/block_type_definition.rb

@@ -1,6 +1,10 @@
 module Workarea
   class Content
     class BlockTypeDefinition
+      def self.define(&block)
+        new.instance_eval(&block)
+      end
+
       def block_type(name, &block)
         block_type = BlockType.new(name)
 

data/app/models/workarea/content/preset.rb

@@ -54,7 +54,7 @@ module Workarea
       end
 
       # The {Workarea::Content::BlockType} that this block is. See documentation
-      # for {Content.define_block_types} for info how to define block types.
+      # for {Workarea.define_content_block_types} for info how to define block types.
       #
       # @return [Workarea::Content::BlockType]
       #

data/app/models/workarea/content.rb

@@ -8,6 +8,7 @@ module Workarea
     field :browser_title, type: String, localize: true
     field :meta_description, type: String, localize: true
     field :javascript, type: String
+    field :head_content, type: String
     field :css, type: String
     field :automate_metadata, type: Boolean, default: true
     field :open_graph_asset_id, type: String
@@ -57,88 +58,17 @@ module Workarea
       find_by('blocks._id' => block_id) rescue nil
     end
 
-    # Define block types for use by administrators. A block type represents a
-    # row of content on the storefront, self-contained with its own styles and
-    # responsive logic.
-    #
-    # == Defining new block types
-    #
-    #    Workarea::Content.define_block_types do
-    #      # Create a new block type called 2 Column Text
-    #      # The ID or slug for this type will be :2_column_text
-    #      block_type '2 Column Text' do
-    #        # Set a description, which will be shown to admin users when
-    #        # selecting a block type
-    #        description 'Provides 2 columns of text'
-    #
-    #        # Allows custom specification of which icon to use to display this
-    #        # block type in the admin when selecting a new block. The default
-    #        # is workarea/admin/content_block_types/#{block_type_id}
-    #        icon 'workarea/admin/content_block_types/columns'
-    #
-    #        # Tags are used for filtering content block types in the admin when
-    #        # creating a new block and selecting its type
-    #        tags %w(columns text)
-    #
-    #        # You can also specify a custom view model to be used in the store
-    #        # front when rendering. You could even share view models for
-    #        # different blocks
-    #        view_model 'Workarea::Storefront::ContentBlocks::ColumnsViewModel'
-    #
-    #        # If your block type requires developer-facing configuration, you
-    #        # you can specify any arbitrary attributes and they will be added
-    #        # to the #config hash on the block type. For example, configuration
-    #        # values tied to site design.
-    #        height 960
-    #        width 470
-    #
-    #        # Use fieldset to group fields together for admin display. The
-    #        # fieldset has no other use.
-    #        fieldset 'Left Column' do
-    #          # A field corresponds to one input in the admin and one key in
-    #          # the Workarea::Content::Block#data hash. It will be referenced
-    #          # by a systemized version of the name.
-    #
-    #          # The second argument must be a type. Out-of-the-box valid types
-    #          # include :asset, :category, :options, :products, :rich_text,
-    #          # :string, and :url.
-    #
-    #          # Options can be specific to the field type. All field types
-    #          # support :default and :required.
-    #          field 'Left Column Text', :text, required: true, default: 'Left Column'
-    #        end
-    #
-    #        fieldset 'Right Column' do
-    #          field 'Right Column Text', :text, required: true, default: 'Right Column'
-    #        end
-    #      end
-    #    end
-    #
-    # == Overriding values for existing block types
-    #
-    # To allow full customization, all details about a block type and its fields
-    # can be overridden. Here's an example of overriding details on the Product
-    # List block type which ships out of the box.
-    #
-    #    Workarea::Content.define_block_types do
-    #      # Open the Product List block up again
-    #      block_type 'Product List' do
-    #        # Override the default on Title
-    #        field 'Title', :string, default: 'Staff Picks'
-    #        # Add a new field called description
-    #        field 'Description', :text, default: 'Top picks by our staff
-    #
-    #        # No need to touch other fields, they remain the same
-    #      end
-    #    end
-    #
-    # == Admin UI
-    # The admin UI for the block will be automatically generated based on the
-    # fields provided.
-    #
-    def self.define_block_types(&block)
-      definition = BlockTypeDefinition.new
-      definition.instance_eval(&block)
+    # @deprecated Use `Workarea.define_content_block_types` instead.
+    class << self
+      def define_block_types(&block)
+        require_dependency 'workarea/content/block_type_definition'
+        definition = BlockTypeDefinition.new
+        definition.instance_eval(&block)
+      end
+      Workarea.deprecation.deprecate_methods(
+        self,
+        define_block_types: 'Use `Workarea.define_content_block_types` instead.'
+      )
     end
 
     # The name for this content, returns the name of the contentable

data/app/models/workarea/data_file/csv.rb

@@ -48,8 +48,6 @@ module Workarea
 
       def assign_attributes(model, attrs)
         model.fields.each do |name, metadata|
-          next if name == 'updated_at'
-
           value = CsvFields.deserialize_from(attrs, field: metadata, model: model)
           model.send("#{name}=", value) if value.present?
         end
@@ -88,17 +86,17 @@ module Workarea
           ]
 
           if unnamespaced_attrs.values.any?(&:present?)
-            klass = attrs["#{name}_type"].constantize if attrs["#{name}_type"].present?
-            klass ||= root.relations[name].class_name.constantize
-
             if metadata.many?
               id = attrs["#{name}_id"]
-              instance = root.send(name).find_by(id: id) rescue nil
-              instance ||= root.send(name).build({}, klass)
+              instance = if id.present?
+                root.send(name).find_or_initialize_by(id: id)
+              else
+                root.send(name).build
+              end
 
               assign_attributes(instance, unnamespaced_attrs)
             else
-              instance = root.send(name) || root.send("build_#{name}", {}, klass)
+              instance = root.send(name) || root.send("build_#{name}")
               assign_attributes(instance, unnamespaced_attrs)
             end
           end