workarea-storefront 3.4.12

data/app/view_models/workarea/storefront/order_pricing.rb

@@ -0,0 +1,37 @@
+module Workarea
+  module Storefront
+    module OrderPricing
+      delegate :store_credit_balance, to: :payment
+
+      def total_adjustments
+        @total_adjustments ||= price_adjustments.reduce_by_description('order')
+      end
+
+      def store_credit?
+        store_credit_amount > 0
+      end
+
+      def store_credit_amount
+        if store_credit_balance > order.total_price
+          order.total_price
+        else
+          store_credit_balance
+        end
+      end
+
+      def order_balance
+        order.total_price - advance_payment_amount
+      end
+
+      # The total amount of payment the customer would perceive as prepaid -
+      # i.e. would be deducted from the total order balance. Examples of these
+      # types of payments would be store credit and gift cards.
+      #
+      # @return [Money]
+      #
+      def advance_payment_amount
+        store_credit_amount
+      end
+    end
+  end
+end

data/app/view_models/workarea/storefront/order_view_model.rb

@@ -0,0 +1,144 @@
+module Workarea
+  module Storefront
+    class OrderViewModel < ApplicationViewModel
+      include OrderPricing
+
+      class PendingItem < Struct.new(:product_attributes, :sku, :quantity); end
+      class CancelledItem < Struct.new(:product_attributes, :sku, :quantity); end
+
+      alias_method :order, :model
+
+      delegate :tenders, :credit_card, :credit_card?,
+        :store_credit?, :store_credit,
+        to: :payment
+
+      delegate :issuer, :display_number, :month, :year, :amount,
+        to: :credit_card, prefix: true, allow_nil: true
+
+      delegate :saved_card_id, to: :credit_card, allow_nil: true
+
+      def render_signup_form?
+        User.find_by_email(model.email).blank?
+      end
+
+      def user
+        @user ||= User.find(model.user_id) if model.user_id.present?
+      end
+
+      def billing_address
+        payment.address
+      end
+
+      def shipping_address
+        shipping.try(:address)
+      end
+
+      def shipping_service
+        shipping.try(:shipping_service).try(:name)
+      end
+
+      def full_name
+        if billing_address.present?
+          "#{billing_address.last_name}, #{billing_address.first_name}"
+        elsif shipping_address.present?
+          "#{shipping_address.last_name}, #{shipping_address.first_name}"
+        end
+      end
+
+      def items
+        @items ||= model.items.by_newest.map do |item|
+          Storefront::OrderItemViewModel.new(item)
+        end
+      end
+
+      def shippings
+        @shippings ||= Storefront::ShippingViewModel.wrap(
+          Shipping.by_order(model.id).to_a,
+          options.merge(order: model)
+        )
+      end
+
+      def store_credit_amount
+        if store_credit.present?
+          store_credit.amount
+        else
+          0.to_m
+        end
+      end
+
+      def paid_amount
+        total_price - store_credit_amount
+      end
+
+      def refunds
+        @refunds ||= RefundViewModel.wrap(payment.refunds, options)
+      end
+
+      def status
+        if fulfillment_status_slug.in?(%w(open not_available))
+          model.status.to_s.titleize
+        else
+          fulfillment_status
+        end
+      end
+
+      def fulfillment_status
+        return if fulfillment_status_slug == 'not_available'
+        fulfillment_status_slug.titleize
+      end
+
+      def packages
+        @packages ||= fulfillment.packages.map do |package|
+          Storefront::PackageViewModel.wrap(package, order: self)
+        end
+      end
+
+      def pending_items
+        @pending_items ||= fulfillment.pending_items.map do |fulfillment_item|
+          next unless order_item = items
+            .detect { |i| i.id.to_s == fulfillment_item.order_item_id }
+
+          FulfillmentItemViewModel.new(order_item, quantity: fulfillment_item.quantity_pending)
+        end.compact
+      end
+
+      def canceled_items
+        @canceled_items ||= fulfillment.canceled_items.map do |fulfillment_item|
+          next unless order_item = items
+            .detect { |i| i.id.to_s == fulfillment_item.order_item_id }
+
+          FulfillmentItemViewModel.new(order_item, quantity: fulfillment_item.quantity_canceled)
+        end.compact
+      end
+
+      # Returns recommendations for the order. The view model it returns behave
+      # like {Enumerable}.
+      #
+      # @return [Workarea::Storefront::CartRecommendationsViewModel]
+      #
+      def recommendations
+        @recommendations ||= CartRecommendationsViewModel.new(model)
+      end
+
+      private
+
+      def payment
+        @payment ||= Payment.find_or_initialize_by(id: model.id)
+      end
+
+      def shipping
+        @shipping ||= Shipping.find_by_order(model.id)
+      end
+
+      def fulfillment
+        @fulfillment ||= Fulfillment.find_or_initialize_by(id: model.id)
+      end
+
+      def fulfillment_status_slug
+        @fulfillment_status ||= (
+          options[:fulfillment_status].presence || fulfillment.status
+        ).to_s
+      end
+    end
+  end
+end

data/app/view_models/workarea/storefront/package_view_model.rb

@@ -0,0 +1,20 @@
+module Workarea
+  module Storefront
+    class PackageViewModel < ApplicationViewModel
+      include ShippingCarrierViewModel
+
+      def items
+        @items ||= model.events_by_item.map do |order_item_id, events|
+          order_item = order.items.detect { |i| i.id.to_s == order_item_id }
+          next if order_item.blank?
+
+          FulfillmentItemViewModel.new(order_item, events: events)
+        end.compact
+      end
+
+      def order
+        options[:order] || OrderViewModel.wrap(Order.find(model.order_id))
+      end
+    end
+  end
+end

data/app/view_models/workarea/storefront/page_view_model.rb

@@ -0,0 +1,11 @@
+module Workarea
+  module Storefront
+    class PageViewModel < ApplicationViewModel
+      include DisplayContent
+
+      def breadcrumbs
+        @breadcrumbs ||= Navigation::Breadcrumbs.new(model)
+      end
+    end
+  end
+end

data/app/view_models/workarea/storefront/pagination.rb

@@ -0,0 +1,42 @@
+module Workarea
+  module Storefront
+    module Pagination
+      extend ActiveSupport::Concern
+
+      included do
+        delegate :page, :per_page, :total, to: :search_query
+      end
+
+      def search_query
+        raise(
+          NotImplementedError,
+          "#{self.class} must implement #search_query for Pagination"
+        )
+      end
+
+      def total_pages
+        (total.to_f / per_page.to_f).ceil
+      end
+
+      def first_page?
+        page == 1
+      end
+
+      def second_page?
+        page == 2
+      end
+
+      def last_page?
+        page == total_pages
+      end
+
+      def next_page
+        page + 1 unless last_page?
+      end
+
+      def prev_page
+        page - 1 unless first_page?
+      end
+    end
+  end
+end

data/app/view_models/workarea/storefront/personalized_recommendations_view_model.rb

@@ -0,0 +1,13 @@
+module Workarea
+  module Storefront
+    class PersonalizedRecommendationsViewModel < RecommendationsViewModel
+      def product_ids
+        Recommendation::UserActivityBased.new(model).results
+      end
+
+      def result_count
+        Workarea.config.personalized_recommendations_count
+      end
+    end
+  end
+end

data/app/view_models/workarea/storefront/product_browsing.rb

@@ -0,0 +1,33 @@
+module Workarea
+  module Storefront
+    module ProductBrowsing
+      extend ActiveSupport::Concern
+      include Pagination
+
+      def product_browse_cache_key
+        @product_browse_cache_key ||= options
+          .except(:user)
+          .to_a
+          .sort
+          .flatten
+          .reject(&:blank?)
+          .join('/')
+      end
+
+      def has_filters?
+        facets.any?(&:selected?)
+      end
+
+      def filters
+        search_query.facets.reduce({}) do |memo, facet|
+          memo[facet.system_name] = facet.selections if facet.selected?
+          memo
+        end
+      end
+
+      def facets
+        search_query.facets.reject(&:useless?)
+      end
+    end
+  end
+end

data/app/view_models/workarea/storefront/product_templates/option_selects_view_model.rb

@@ -0,0 +1,7 @@
+module Workarea
+  module Storefront
+    class ProductTemplates::OptionSelectsViewModel < ProductViewModel
+      include OptionSetViewModel
+    end
+  end
+end

data/app/view_models/workarea/storefront/product_templates/option_thumbnails_view_model.rb

@@ -0,0 +1,15 @@
+module Workarea
+  module Storefront
+    class ProductTemplates::OptionThumbnailsViewModel < ProductViewModel
+      include OptionSetViewModel
+
+      def images_by_option
+        @images_by_option ||= model
+          .images
+          .group_by { |i| i.option.to_s.optionize }
+          .with_indifferent_access
+          .transform_keys(&:optionize)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,183 @@
+module Workarea
+  module Storefront
+    class ProductViewModel < ApplicationViewModel
+
+      def self.wrap(model, options = {})
+        if model.is_a?(Enumerable)
+          model.map { |m| wrap(m, options) }
+        elsif Workarea.config.product_templates.include?(model.template.to_sym)
+          view_model_class = "Workarea::Storefront::ProductTemplates::#{model.template.camelize}ViewModel"
+          view_model_class.constantize.new(model, options)
+        else
+          new(model, options)
+        end
+      end
+
+      def breadcrumbs
+        @breadcrumbs ||=
+          if options[:via].present?
+            Navigation::Breadcrumbs.from_global_id(
+              options[:via],
+              last: model.name
+            )
+          else
+            Navigation::Breadcrumbs.new(
+              default_category,
+              last: model.name
+            )
+          end
+      end
+
+      def primary_image
+        images.primary
+      end
+
+      def images
+        @images_collection ||=
+          Storefront::ProductViewModel::ImageCollection.new(model, options)
+      end
+
+      def cache_key
+        @cache_key ||= CacheKey.new(
+          model,
+          options.merge(current_sku: current_sku)
+        ).to_s
+      end
+
+      #
+      # Browsing
+      #
+      #
+
+      def catalog_id
+        options[:catalog_id]
+      end
+
+      def browse_link_options
+        @browse_link_options ||= options.slice(:via).with_indifferent_access
+      end
+
+      # Returns the set of recommendations for the product.
+      # The view model it returns behave like {Enumerable}.
+      #
+      # @return [Workarea::Storefront::DetailPageRecommendationsViewModel]
+      #
+      def recommendations
+        @recommendations ||= DetailPageRecommendationsViewModel.new(model, options)
+      end
+
+      #
+      # Pricing
+      #
+      #
+
+      delegate :sell_min_price, :sell_max_price, :on_sale?, :has_prices?, to: :pricing
+
+      def pricing
+        @pricing ||= options[:pricing] || Pricing::Collection.new(
+          options[:sku].presence || variants.map(&:sku)
+        )
+      end
+
+      def purchasable?
+        has_prices? && model.purchasable? && inventory_purchasable?
+      end
+
+      def one_price?
+        return false if sell_min_price.nil?
+        sell_min_price >= original_min_price
+      end
+
+      def show_sell_range?
+        return false if sell_min_price.nil? || sell_max_price.nil?
+        sell_min_price < sell_max_price
+      end
+
+      def show_original_range?
+        return false if original_min_price.nil? || original_max_price.nil?
+        original_min_price < original_max_price
+      end
+
+      def original_min_price
+        return nil unless has_prices?
+
+        if pricing.msrp_min_price.present? && pricing.msrp_min_price > sell_min_price
+          pricing.msrp_min_price
+        else
+          pricing.regular_min_price
+        end
+      end
+
+      def original_max_price
+        return nil unless has_prices?
+
+        if pricing.msrp_max_price.present? && pricing.msrp_max_price > sell_max_price
+          pricing.msrp_max_price
+        else
+          pricing.regular_max_price
+        end
+      end
+
+      #
+      # Variants
+      #
+      #
+
+      def variants
+        @variants ||= model.variants.active.select do |variant|
+          !!inventory.for_sku(variant.sku).try(:displayable?)
+        end
+      end
+
+      def current_sku
+        options[:sku]
+      end
+
+      def current_variant
+        variants.detect { |variant| variant.sku == current_sku }
+      end
+
+      def sku_options
+        @sku_options ||= SkuOptions.new(variants).to_a
+      end
+
+      def inventory
+        @inventory ||= options[:inventory] ||
+          Inventory::Collection.new(model.variants.map(&:sku))
+      end
+
+      def inventory_status
+        InventoryStatusViewModel.new(inventory.for_sku(current_sku)).message
+      end
+
+      def inventory_purchasable?
+        current_sku.blank? || inventory.for_sku(current_sku).purchasable?
+      end
+
+      def default_category
+        @default_category ||= Categorization.new(model).default_model
+      end
+
+      #
+      # Detail
+      #
+      #
+
+      def browser_title
+        if model.browser_title.present?
+          model.browser_title
+        else
+          model.name
+        end
+      end
+
+      def meta_description
+        if model.meta_description.present?
+          model.meta_description
+        else
+          model.description
+        end
+      end
+    end
+  end
+end