solidus_volume_pricing 0.2.1 → 1.1.0

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/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
+      user.spree_roles.each {|r| roles << r.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

data/app/overrides/spree/admin/shared/_settings_sub_menu/add_volume_price_model_admin_menu_links.html.erb.deface

@@ -0,0 +1,5 @@
+<!-- insert_bottom "[data-hook='admin_settings_sub_tabs']" -->
+
+<% if can?(:admin, Spree::VolumePriceModel) %>
+  <%= tab :volume_price_models, url: spree.admin_volume_price_models_path %>
+<% end %>

data/app/overrides/views_decorator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Deface::Override.new(
   virtual_path: 'spree/admin/shared/_product_tabs',
   name: 'add_volume_pricing_admin_tab',

data/app/views/spree/admin/shared/_vp_product_tab.html.erb

@@ -1,3 +1,3 @@
-<%= content_tag :li, class: ('active' if current == Spree.t(:volume_pricing)) do %>
-  <%= link_to_with_icon 'tasks', Spree.t(:volume_pricing), volume_prices_admin_product_variant_url(@product, @product.master) %>
+<%= content_tag :li, class: ('active' if current == t('spree.volume_pricing')) do %>
+  <%= link_to t('spree.volume_pricing'), volume_prices_admin_product_variant_url(@product, @product.master) %>
 <% end %>

data/app/views/spree/admin/variants/_edit_fields.html.erb

@@ -1,33 +1,6 @@
-<% content_for :page_actions do %>
-  <span id="new_add_volume_price" data-hook>
-    <%= button_link_to Spree.t(:add_volume_price), 'javascript:;', {
-      icon: 'add', :'data-target' => 'tbody#volume_prices', class: 'btn-success spree_add_fields', id: 'add_volume_price' } %>
-  </span>
-<% end %>
+<fieldset>
+  <legend><%= t('spree.volume_prices') %></legend>
 
-<h3><%= Spree.t(:volume_prices) %></h3>
-<table class="table">
-  <thead>
-    <tr>
-      <th><%= Spree.t(:name) %></th>
-      <th><%= Spree.t(:discount_type) %></th>
-      <th><%= Spree.t(:range) %></th>
-      <th><%= Spree.t(:amount) %></th>
-      <th><%= Spree.t(:position) %></th>
-      <th><%= Spree.t(:role) %></th>
-      <th><%= Spree.t(:action) %></th>
-    </tr>
-  </thead>
-  <tbody id="volume_prices">
-    <%= f.fields_for :volume_prices do |vp_form| %>
-      <%= render partial: 'spree/admin/volume_prices/volume_price_fields', locals: { f: vp_form } %>
-    <% end %>
-  </tbody>
-  <tbody id="volume_price_models">
-    <%= f.field_container :volume_price_model, class: ['form-group'] do %>
-      <%= f.label :volume_price_model_id, Spree.t(:volume_price_model) %>
-      <%= f.collection_select(:volume_price_model_ids, Spree::VolumePriceModel.all, :id, :name, { include_blank: Spree.t('match_choices.none') }, { class: 'select2', disabled: (cannot? :edit, Spree::VolumePriceModel) }) %>
-    <%= f.error_message_on :volume_price_model %>
-    <% end %>
-  </tbody>
-</table>
+  <%= render 'spree/admin/volume_price_models/select', f: f %>
+  <%= render 'spree/admin/volume_prices/table', f: f %>
+</fieldset>

data/app/views/spree/admin/variants/volume_prices.html.erb

@@ -1,39 +1,12 @@
-<%= render 'spree/admin/shared/product_tabs', current: Spree.t(:volume_pricing) %>
+<%= render 'spree/admin/shared/product_tabs', current: t('spree.volume_pricing') %>
 <%= render 'spree/shared/error_messages', target: @variant %>
 
-<% content_for :page_actions do %>
-  <span id="new_add_volume_price" data-hook>
-    <%= button_link_to Spree.t(:add_volume_price), 'javascript:;', {
-      icon: 'add', :'data-target' => 'tbody#volume_prices', class: 'btn-success spree_add_fields', id: 'add_volume_price'} %>
-  </span>
-<% end %>
+<fieldset>
+  <legend><%= t('spree.volume_prices') %></legend>
 
-<%= form_for(@variant, url: admin_product_variant_path(@product, @variant), html: { method: :put }) do |f| %>
-  <h3><%= Spree.t(:volume_prices) %></h3>
-  <table class="table">
-    <thead>
-      <tr>
-        <th><%= Spree.t(:name) %></th>
-        <th><%= Spree.t(:discount_type) %></th>
-        <th><%= Spree.t(:range) %></th>
-        <th><%= Spree.t(:amount) %></th>
-        <th><%= Spree.t(:position) %></th>
-        <th><%= Spree.t(:role) %></th>
-        <th class="actions"></th>
-      </tr>
-    </thead>
-    <tbody id="volume_prices">
-      <%= f.fields_for :volume_prices do |vp_form| %>
-        <%= render partial: 'spree/admin/volume_prices/volume_price_fields', locals: { f: vp_form } %>
-      <% end %>
-    </tbody>
-    <tbody id="volume_price_models">
-      <%= f.field_container :volume_price_model, class: ['form-group'] do %>
-        <%= f.label :volume_price_model_id, Spree.t(:volume_price_model) %>
-        <%= f.collection_select(:volume_price_model_ids, Spree::VolumePriceModel.all, :id, :name, { include_blank: Spree.t('match_choices.none') }, { class: 'select2', disabled: (cannot? :edit, Spree::VolumePriceModel) }) %>
-      <%= f.error_message_on :volume_price_model %>
-      <% end %>
-    </tbody>
-  </table>
-  <%= render 'spree/admin/shared/edit_resource_links' %>
-<% end %>
+  <%= form_for(@variant, url: admin_product_variant_path(@product, @variant), html: { method: :put }) do |f| %>
+    <%= render 'spree/admin/volume_price_models/select', f: f %>
+    <%= render 'spree/admin/volume_prices/table', f: f %>
+    <%= render 'spree/admin/shared/edit_resource_links' %>
+  <% end %>
+</fieldset>

data/app/views/spree/admin/volume_price_models/_form.html.erb

@@ -1,9 +1,13 @@
 <div data-hook="admin_inside_volume_price_model_form" class="form-group">
   <%= f.field_container :name, class: ['form-group'] do %>
-    <%= f.label :name, Spree.t(:name) %> <span class="required">*</span>
+    <%= f.label :name, t('spree.name') %> <span class="required">*</span>
     <%= error_message_on :volume_price_model, :name, :class => 'error-message' %>
     <%= text_field :volume_price_model, :name, :class => 'form-control' %>
   <% end %>
 
-  <%= render 'spree/admin/volume_prices/edit_fields', f: f %>
+  <fieldset>
+    <legend><%= t('spree.volume_prices') %></legend>
+
+    <%= render 'spree/admin/volume_prices/table', f: f %>
+  </fieldset>
 </div>

data/app/views/spree/admin/volume_price_models/_list.html.erb

@@ -1,8 +1,8 @@
-<table class="table sortable" id='listing_volume_price_models' data-hook data-sortable-link="<%#= update_positions_admin_volume_price_models_url %>">
+<table class="table sortable" id='listing_volume_price_models' data-hook>
   <thead>
     <tr data-hook="volume_price_models_header">
       <th class="no-border"></th>
-      <th><%= Spree.t(:name) %></th>
+      <th><%= t('spree.name') %></th>
       <th class="actions"></th>
     </tr>
   </thead>
@@ -14,8 +14,12 @@
         </td>
         <td><%= price_model.name %></td>
         <td class="actions actions-2 text-right">
-          <%= link_to_edit price_model.id, no_text: true %>
-          <%= link_to_delete price_model, no_text: true %>
+          <% if can?(:update, price_model) %>
+            <%= link_to_edit price_model, no_text: true %>
+          <% end %>
+          <% if can?(:destroy, price_model) %>
+            <%= link_to_delete price_model, no_text: true %>
+          <% end %>
         </td>
       </tr>
     <% end %>

data/app/views/spree/admin/volume_price_models/_select.html.erb

@@ -0,0 +1,17 @@
+<div class="row">
+  <div class="col-4">
+    <%= f.field_container :volume_price_model, class: ['form-group'] do %>
+      <%= f.label :volume_price_model_id, t('spree.volume_price_model') %>
+      <%= f.collection_select :volume_price_model_ids,
+        Spree::VolumePriceModel.all, :id, :name,
+        {
+          include_blank: t('spree.match_choices.none')
+        },
+        {
+          class: 'custom-select fullwidth',
+          disabled: cannot?(:edit, Spree::VolumePriceModel)
+        } %>
+      <%= f.error_message_on :volume_price_model %>
+    <% end %>
+  </div>
+</div>

data/app/views/spree/admin/volume_price_models/edit.html.erb

@@ -1,12 +1,13 @@
 <% content_for :page_title do %>
-  <%= Spree.t(:volume_price_model_edit) %>
+  <%= t('spree.volume_price_model_edit') %>
 <% end %>
 
-<%= form_for [:admin, @volume_price_model] do |f| %>
-  <fieldset>
-    <%= render partial: 'form', locals: { f: f } %>
-  </fieldset>
+<% admin_breadcrumb(link_to plural_resource_name(Spree::VolumePriceModel), admin_volume_price_models_path) %>
 
-  <%= render 'spree/admin/shared/edit_resource_links' %>
+<%= form_for [:admin, @volume_price_model] do |f| %>
+  <%= render partial: 'form', locals: { f: f } %>
 
+  <% if can?(:update, @volume_price_model) %>
+    <%= render 'spree/admin/shared/edit_resource_links' %>
+  <% end %>
 <% end %>

data/app/views/spree/admin/volume_price_models/index.html.erb

@@ -1,9 +1,9 @@
 <% content_for :page_title do %>
-  <%= "Volume Price Models" %>
+  <%= plural_resource_name(Spree::VolumePriceModel) %>
 <% end %>
 
 <% content_for :page_actions do %>
-  <%= button_link_to Spree.t(:new_volume_price_model), new_object_url, class: "btn-success", icon: 'add', id: 'admin_new_volume_price_model_link' %>
+  <%= link_to t('spree.new_volume_price_model'), new_object_url, class: "btn btn-primary", id: 'admin_new_volume_price_model_link' %>
 <% end %>
 
 <% if @volume_price_models.any? %>
@@ -11,8 +11,10 @@
     <%= render 'list' %>
   </div>
 <% else %>
-  <div class="alert alert-info no-objects-found">
-    <%= Spree.t(:no_resource_found, resource: "Volume Price Models") %>,
-    <%= link_to Spree.t(:add_one), new_object_url %>!
+  <div class="no-objects-found">
+    <%= t('spree.no_resource_found', resource: plural_resource_name(Spree::VolumePriceModel)) %>,
+    <% if can? :create, Spree::VolumePriceModel %>
+      <%= link_to t('spree.create_one'), new_object_url %>
+    <% end %>
   </div>
 <% end %>

data/app/views/spree/admin/volume_price_models/new.html.erb

@@ -1,12 +1,12 @@
 <% content_for :page_title do %>
-  <%= Spree.t(:new_volume_price_model) %>
+  <%= t('spree.new_volume_price_model') %>
 <% end %>
 
+<% admin_breadcrumb(link_to plural_resource_name(Spree::VolumePriceModel), admin_volume_price_models_path) %>
+
 <%= form_for [:admin, @volume_price_model] do |f| %>
-  <fieldset>
+  <fieldset class="no-border-top">
     <%= render partial: 'form', locals: { f: f } %>
-    <div class="form-actions" data-hook="buttons">
-      <%= button Spree.t(:create), 'save' %>
-    </div>
+    <%= render partial: 'spree/admin/shared/new_resource_links' %>
   </fieldset>
 <% end %>

data/app/views/spree/admin/volume_prices/_table.html.erb

@@ -0,0 +1,26 @@
+<table class="table">
+  <thead>
+    <tr>
+      <th><%= t('spree.name') %></th>
+      <th><%= t('spree.discount_type') %></th>
+      <th><%= t('spree.range') %></th>
+      <th><%= t('spree.amount') %></th>
+      <th><%= t('spree.position') %></th>
+      <th><%= t('spree.role') %></th>
+      <th class="actions"></th>
+    </tr>
+  </thead>
+  <tbody id="volume_prices">
+    <%= f.fields_for :volume_prices do |vp_form| %>
+      <%= render partial: 'spree/admin/volume_prices/volume_price_fields', locals: { f: vp_form } %>
+    <% end %>
+  </tbody>
+</table>
+
+<span id="new_add_volume_price" data-hook>
+  <%= link_to t(:add_volume_price, scope: :spree), 'javascript:;', {
+    data: { target: 'tbody#volume_prices' },
+    class: 'btn btn-primary spree_add_fields',
+    id: 'add_volume_price'
+  } %>
+</span>