solidus_volume_pricing 0.2.1 → 1.0.0

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
 

data/app/assets/javascripts/spree/backend/solidus_volume_pricing.js

@@ -1,16 +1,2 @@
-//= require spree/backend
+// Just here for backwards compatibility
 
-// spree's version only handles 'input', not 'select', and this breaks solidus_volume_pricing
-
-$(function () {
-  $('#add_volume_price').click( function() {
-    var target = $(this).data("target"),
-      new_table_row = $(target + ' tr:visible:first');
-    new_table_row.find('div.select2').remove();
-    $('select.select2').select2({
-      allowClear: true,
-      dropdownAutoWidth: true
-    });
-  });
-
-});

data/app/controllers/spree/admin/volume_price_models_controller.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module Spree
   module Admin
     class VolumePriceModelsController < ResourceController
-
       before_action :load_volume_prices, only: [:new, :edit]
 
       private

data/app/controllers/spree/admin/volume_prices_controller.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Spree
   module Admin
     class VolumePricesController < Spree::Admin::BaseController
       def destroy
         @volume_price = Spree::VolumePrice.find(params[:id])
         @volume_price.destroy
-        render nothing: true
+        head :ok
       end
     end
   end

data/app/decorators/controllers/solidus_volume_pricing/spree/admin/variants_controller_decorator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module SolidusVolumePricing
+  module Spree
+    module Admin
+      module VariantsControllerDecorator
+        def edit
+          @variant.volume_prices.build if @variant.volume_prices.empty?
+          super
+        end
+
+        def volume_prices
+          @product = @variant.product
+          @variant.volume_prices.build if @variant.volume_prices.empty?
+        end
+
+        private
+
+        # this loads the variant for the master variant volume price editing
+        def load_resource_instance
+          parent
+
+          if new_actions.include?(params[:action].to_sym)
+            build_resource
+          elsif params[:id]
+            ::Spree::Variant.find(params[:id])
+          end
+        end
+
+        def location_after_save
+          if @product.master.id == @variant.id && params[:variant].key?(:volume_prices_attributes)
+            return volume_prices_admin_product_variant_url(@product, @variant)
+          end
+
+          super
+        end
+
+        ::Spree::Admin::VariantsController.prepend self
+      end
+    end
+  end
+end

data/app/decorators/helpers/solidus_volume_pricing/spree/base_helper_decorator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module SolidusVolumePricing
+  module Spree
+    module BaseHelperDecorator
+      def self.prepended(base)
+        base.module_eval do
+          def display_volume_price(variant, quantity = 1, user = nil)
+            price_display(variant, quantity: quantity, user: user).price_string
+          end
+
+          def display_volume_price_earning_percent(variant, quantity = 1, user = nil)
+            price_display(variant, quantity: quantity, user: user).earning_percent_string
+          end
+
+          def display_volume_price_earning_amount(variant, quantity = 1, user = nil)
+            price_display(variant, quantity: quantity, user: user).earning_amount_string
+          end
+
+          private
+
+          def price_display(variant, quantity:, user:)
+            SolidusVolumePricing::PriceDisplay.new(variant, quantity: quantity, user: user)
+          end
+        end
+      end
+
+      ::Spree::BaseHelper.prepend self
+    end
+  end
+end

data/app/decorators/models/solidus_volume_pricing/spree/line_item_decorator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SolidusVolumePricing
+  module Spree
+    module LineItemDecorator
+      def set_pricing_attributes
+        if quantity_changed?
+          options = SolidusVolumePricing::PricingOptions.from_line_item(self)
+          self.money_price = SolidusVolumePricing::Pricer.new(variant).price_for(options)
+        end
+
+        super
+      end
+
+      ::Spree::LineItem.prepend self
+    end
+  end
+end

data/app/decorators/models/solidus_volume_pricing/spree/user_decorator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SolidusVolumePricing
+  module Spree
+    module UserDecorator
+      def resolve_role
+        if has_spree_role? ::Spree::Config.volume_pricing_role.to_sym
+          ::Spree::Role.find_by name: ::Spree::Config.volume_pricing_role
+        else
+          ::Spree::Role.find_by name: 'user'
+        end
+      end
+
+      ::Spree.user_class.prepend self
+    end
+  end
+end

data/app/decorators/models/solidus_volume_pricing/spree/variant_decorator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SolidusVolumePricing
+  module Spree
+    module VariantDecorator
+      def self.prepended(base)
+        base.class_eval do
+          has_and_belongs_to_many :volume_price_models
+          has_many :volume_prices, -> { order(position: :asc) }, dependent: :destroy
+          has_many :model_volume_prices, -> { order(position: :asc) }, class_name: '::Spree::VolumePrice', through: :volume_price_models, source: :volume_prices
+          accepts_nested_attributes_for :volume_prices, allow_destroy: true,
+                                                        reject_if: proc { |volume_price|
+                                                                     volume_price[:amount].blank? && volume_price[:range].blank?
+                                                                   }
+        end
+      end
+
+      ::Spree::Variant.prepend self
+    end
+  end
+end

data/app/models/solidus_volume_pricing/price_display.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module SolidusVolumePricing
+  class PriceDisplay
+    attr_reader :variant, :quantity, :user
+
+    def initialize(variant, quantity: 1, user: nil)
+      @variant = variant
+      @quantity = quantity
+      @user = user
+    end
+
+    def price_string
+      price.to_s
+    end
+
+    def earning_amount_string
+      earning_amount.to_s
+    end
+
+    def earning_percent_string
+      earning_percent.to_s
+    end
+
+    private
+
+    def price
+      pricer.price_for(options)
+    end
+
+    def earning_amount
+      pricer.earning_amount(options)
+    end
+
+    def earning_percent
+      pricer.earning_percent(options)
+    end
+
+    def options
+      SolidusVolumePricing::PricingOptions.new(quantity: quantity, user: user)
+    end
+
+    def pricer
+      SolidusVolumePricing::Pricer.new(variant)
+    end
+  end
+end

data/app/models/solidus_volume_pricing/pricer.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module SolidusVolumePricing
+  class Pricer < ::Spree::Variant::PriceSelector
+    attr_reader :quantity, :user
+
+    def self.pricing_options_class
+      SolidusVolumePricing::PricingOptions
+    end
+
+    def price_for(pricing_options)
+      extract_options(pricing_options)
+      ::Spree::Money.new(computed_price)
+    end
+
+    def earning_amount(pricing_options)
+      extract_options(pricing_options)
+      ::Spree::Money.new(computed_earning)
+    end
+
+    def earning_percent(pricing_options)
+      extract_options(pricing_options)
+      computed_earning_percent.round
+    end
+
+    private
+
+    def extract_options(pricing_options)
+      @quantity = pricing_options.quantity
+      @user = pricing_options.user
+    end
+
+    def use_master_variant_volume_pricing?
+      ::Spree::Config.use_master_variant_volume_pricing && @variant.volume_prices.empty?
+    end
+
+    def variant
+      if use_master_variant_volume_pricing?
+        super.product.master
+      else
+        super
+      end
+    end
+
+    def volume_prices
+      ::Spree::VolumePrice.for_variant(variant, user: user)
+    end
+
+    def volume_price
+      volume_prices.detect do |volume_price|
+        volume_price.include?(quantity)
+      end
+    end
+
+    def computed_price
+      case volume_price&.discount_type
+      when 'price'
+        volume_price.amount
+      when 'dollar'
+        variant.price - volume_price.amount
+      when 'percent'
+        variant.price * (1 - volume_price.amount)
+      else
+        variant.price
+      end
+    end
+
+    def computed_earning
+      case volume_price&.discount_type
+      when 'price'
+        variant.price - volume_price.amount
+      when 'dollar'
+        volume_price.amount
+      when 'percent'
+        variant.price - (variant.price * (1 - volume_price.amount))
+      else
+        0
+      end
+    end
+
+    def computed_earning_percent
+      case volume_price&.discount_type
+      when 'price'
+        diff = variant.price - volume_price.amount
+        diff * 100 / variant.price
+      when 'dollar'
+        volume_price.amount * 100 / variant.price
+      when 'percent'
+        volume_price.amount * 100
+      else
+        0
+      end
+    end
+  end
+end

data/app/models/solidus_volume_pricing/pricing_options.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module SolidusVolumePricing
+  class PricingOptions < ::Spree::Variant::PricingOptions
+    attr_accessor :quantity, :user
+
+    def initialize(options = {})
+      super options.except(:quantity, :user)
+      @quantity = options.delete(:quantity)
+      @user = options.delete(:user)
+    end
+
+    def self.from_line_item(line_item)
+      pricing_options = super(line_item)
+      pricing_options.quantity = line_item.quantity
+      pricing_options.user = line_item.order.user
+      pricing_options
+    end
+  end
+end

data/app/models/spree/volume_price.rb

@@ -1,35 +1,52 @@
-class Spree::VolumePrice < ActiveRecord::Base
-  belongs_to :variant, touch: true
-  belongs_to :volume_price_model, touch: true
-  belongs_to :spree_role, class_name: 'Spree::Role', foreign_key: 'role_id'
+# frozen_string_literal: true
+
+class Spree::VolumePrice < ApplicationRecord
+  belongs_to :variant, touch: true, optional: true
+  belongs_to :volume_price_model, touch: true, optional: true
+  belongs_to :spree_role, class_name: 'Spree::Role', foreign_key: 'role_id', optional: true
   acts_as_list scope: [:variant_id, :volume_price_model_id]
 
   validates :amount, presence: true
   validates :discount_type,
-            presence: true,
-            inclusion: {
-              in: %w(price dollar percent),
-              message: I18n.t(:'activerecord.errors.messages.is_not_a_valid_volume_price_type', value: self)
-            }
-  validates :range,
-            format: {
-              with: /\(?[0-9]+(?:\.{2,3}[0-9]+|\+\)?)/,
-              message: I18n.t(:'activerecord.errors.messages.must_be_in_format')
-            }
-
-  OPEN_ENDED = /\(?[0-9]+\+\)?/
-
-  def include?(quantity)
-    if open_ended?
-      bound = /\d+/.match(range)[0].to_i
-      return quantity >= bound
-    else
-      range.to_range === quantity
+    presence: true,
+    inclusion: {
+      in: %w(price dollar percent)
+    }
+
+  validate :range_format
+
+  def self.for_variant(variant, user: nil)
+    roles = [nil]
+    if user
+      roles << user.resolve_role&.id
+    end
+
+    where(
+      arel_table[:variant_id].eq(variant.id).
+      or(
+        arel_table[:volume_price_model_id].in(variant.volume_price_model_ids)
+      )
+    ).
+      where(role_id: roles).
+      order(position: :asc, amount: :asc)
+  end
+
+  delegate :include?, to: :range_from_string
+
+  def display_range
+    range.gsub(/\.+/, "-").gsub(/\(|\)/, '')
+  end
+
+  private
+
+  def range_format
+    if !(SolidusVolumePricing::RangeFromString::RANGE_FORMAT =~ range ||
+         SolidusVolumePricing::RangeFromString::OPEN_ENDED =~ range)
+      errors.add(:range, :must_be_in_format)
     end
   end
 
-  # indicates whether or not the range is a true Ruby range or an open ended range with no upper bound
-  def open_ended?
-    OPEN_ENDED =~ range
+  def range_from_string
+    SolidusVolumePricing::RangeFromString.new(range).to_range
   end
 end

data/app/models/spree/volume_price_model.rb

@@ -1,8 +1,10 @@
-class Spree::VolumePriceModel < ActiveRecord::Base
+# frozen_string_literal: true
+
+class Spree::VolumePriceModel < ApplicationRecord
   has_many :variants
   has_many :volume_prices, -> { order(position: :asc) }, dependent: :destroy
   accepts_nested_attributes_for :volume_prices, allow_destroy: true,
-    reject_if: proc { |volume_price|
-      volume_price[:amount].blank? && volume_price[:range].blank?
-    }
+                                                reject_if: proc { |volume_price|
+                                                             volume_price[:amount].blank? && volume_price[:range].blank?
+                                                           }
 end