workarea-core 3.4.44 → 3.5.0.beta.1

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/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/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

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

@@ -9,6 +9,7 @@ module Workarea
       field :error_message, type: String
       field :total, type: Integer, default: 0
       field :succeeded, type: Integer, default: 0
+      field :release_id, type: String
 
       # These scopes used for mailer previews only
       scope :successful, -> { where(file_errors: {}, error_type: nil, :succeeded.gt => 0) }
@@ -40,8 +41,10 @@ module Workarea
       def process!
         set(started_at: Time.current)
         assert_valid_file_type
-        run_callbacks(:process) { format.import! }
 
+        Workarea::Release.with_current(release_id) do
+          run_callbacks(:process) { format.import! }
+        end
       rescue Exception => e
         self.error_type = e.class
         self.error_message = e.message
@@ -63,6 +66,11 @@ module Workarea
         end
       end
 
+      def releasable?
+        return false unless model_type.present?
+        model_class.new.releasable?
+      end
+
       private
 
       def set_file_type

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

@@ -45,31 +45,12 @@ module Workarea
 
         if id.present?
           result = model_class.find_or_initialize_by(id: id)
-          result.attributes = attributes_without_updated_at(attributes)
+          result.attributes = attributes
           result
         else
           model_class.new(attributes)
         end
       end
-
-      def attributes_without_updated_at(attrs)
-        return attrs unless attrs.respond_to?(:each_with_object)
-
-        attrs.each_with_object({}) do |(key, value), attributes|
-          next if key.to_s == 'updated_at'
-
-          attributes[key] = case value
-                            when Hash
-                              attributes_without_updated_at(value)
-                            when Array
-                              value.map do |item|
-                                attributes_without_updated_at(item)
-                              end
-                            else
-                              value
-                            end
-        end
-      end
     end
   end
 end

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

@@ -37,10 +37,6 @@ module Workarea
           Workarea.config.data_file_formats.first
       end
 
-      def mime_type
-        "#{MIME::Types.type_for(file_type).first.to_s}; charset=utf-8"
-      end
-
       def process!
         raise NotImplementedError
       end

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

@@ -31,6 +31,9 @@ module Workarea
             country: row[:country] || 'US',
             postal_code: row[:zip_code],
             percentage: row[:estimated_combined_rate],
+            country_percentage: row[:federal_rate],
+            region_percentage: row[:state_rate],
+            postal_code_percentage: row[:county_rate],
             charge_on_shipping: row[:charge_on_shipping] !~ /false/i
           )
       end

data/app/models/workarea/featured_products.rb

@@ -6,9 +6,17 @@ module Workarea
       field :product_ids, type: Array, default: []
       before_validation :clean_product_ids
 
+      scope :by_product, ->(id) { self.in(product_ids: id) }
       index({ product_ids: 1 })
     end
 
+    def self.changesets(*product_ids)
+      Release::Changeset.any_of(
+        { 'changeset.product_ids' => { '$in' => product_ids } },
+        { 'original.product_ids' => { '$in' => product_ids } }
+      )
+    end
+
     def featured_products?
       product_ids.present?
     end

data/app/models/workarea/fulfillment/policies/base.rb

@@ -0,0 +1,21 @@
+module Workarea
+  class Fulfillment
+    module Policies
+      class Base
+        attr_reader :sku
+
+        def initialize(sku)
+          @sku = sku
+        end
+
+        def requires_shipping?
+          false
+        end
+
+        def process(order_item:, fulfillment: nil)
+          raise(NotImplementedError)
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/fulfillment/policies/download.rb

@@ -0,0 +1,21 @@
+module Workarea
+  class Fulfillment
+    module Policies
+      class Download < Base
+        def process(order_item:, fulfillment: nil)
+          Fulfillment::Token.create!(
+            order_id: order_item.order.id,
+            order_item_id: order_item.id,
+            sku: sku.id
+          )
+
+          return unless fulfillment.present?
+          fulfillment.mark_item_shipped(
+            id: order_item.id.to_s,
+            quantity: order_item.quantity
+          )
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/fulfillment/policies/ignore.rb

@@ -0,0 +1,11 @@
+module Workarea
+  class Fulfillment
+    module Policies
+      class Ignore < Base
+        def process(*args)
+          # no op
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/fulfillment/policies/ship.rb

@@ -0,0 +1,15 @@
+module Workarea
+  class Fulfillment
+    module Policies
+      class Ship < Base
+        def requires_shipping?
+          true
+        end
+
+        def process(*args)
+          # no op
+        end
+      end
+    end
+  end
+end