solidus_volume_pricing 0.1.0

data/app/helpers/spree/base_helper_decorator.rb

@@ -0,0 +1,19 @@
+Spree::BaseHelper.class_eval do
+  def display_volume_price(variant, quantity = 1, user = nil)
+    Spree::Money.new(
+      variant.volume_price(quantity, user),
+      currency: Spree::Config[:currency]
+    ).to_html
+  end
+
+  def display_volume_price_earning_percent(variant, quantity = 1, user = nil)
+    variant.volume_price_earning_percent(quantity, user).round.to_s
+  end
+
+  def display_volume_price_earning_amount(variant, quantity = 1, user = nil)
+    Spree::Money.new(
+      variant.volume_price_earning_amount(quantity, user),
+      currency: Spree::Config[:currency]
+    ).to_html
+  end
+end

data/app/models/spree/line_item_decorator.rb

@@ -0,0 +1,27 @@
+Spree::LineItem.class_eval do
+  # pattern grabbed from: http://stackoverflow.com/questions/4470108/
+
+  # the idea here is compatibility with spree_sale_products
+  # trying to create a 'calculation stack' wherein the best valid price is
+  # chosen for the product. This is mainly for compatibility with spree_sale_products
+  #
+  # Assumption here is that the volume price currency is the same as the product currency
+  old_copy_price = instance_method(:copy_price)
+  define_method(:copy_price) do
+    old_copy_price.bind(self).call
+    return unless variant
+
+    if variant
+      if changed? && changes.keys.include?('quantity')
+        vprice = variant.volume_price(quantity, order.user)
+        if price.present? && vprice <= variant.price
+          self.price = vprice and return
+        end
+      end
+
+      self.price = variant.price if price.nil?
+    end
+
+    self.price = variant.price if price.nil?
+  end
+end

data/app/models/spree/user_decorator.rb

@@ -0,0 +1,10 @@
+Spree.user_class.class_eval do
+
+  def resolve_role
+    if self.has_spree_role? Spree::Config.volume_pricing_role.to_sym
+      return Spree::Role.find_by name: Spree::Config.volume_pricing_role
+    else
+      return Spree::Role.find_by name: 'user'
+    end
+  end
+end

data/app/models/spree/variant_decorator.rb

@@ -0,0 +1,104 @@
+Spree::Variant.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?
+    }
+
+  def join_volume_prices(user = nil)
+    table = Spree::VolumePrice.arel_table
+
+    if user
+      Spree::VolumePrice.where(
+        (table[:variant_id].eq(id)
+          .or(table[:volume_price_model_id].in(volume_price_models.ids)))
+          .and(table[:role_id].eq(user.resolve_role))
+        )
+        .order(position: :asc)
+    else
+      Spree::VolumePrice.where(
+        (table[:variant_id]
+          .eq(id)
+          .or(table[:volume_price_model_id].in(volume_price_models.ids)))
+          .and(table[:role_id].eq(nil))
+        ).order(position: :asc)
+    end
+  end
+
+  # calculates the price based on quantity
+  def volume_price(quantity, user = nil)
+    compute_volume_price_quantities :volume_price, price, quantity, user
+  end
+
+  # return percent of earning
+  def volume_price_earning_percent(quantity, user = nil)
+    compute_volume_price_quantities :volume_price_earning_percent, 0, quantity, user
+  end
+
+  # return amount of earning
+  def volume_price_earning_amount(quantity, user = nil)
+    compute_volume_price_quantities :volume_price_earning_amount, 0, quantity, user
+  end
+
+  protected
+
+  def use_master_variant_volume_pricing?
+    Spree::Config.use_master_variant_volume_pricing && !(product.master.join_volume_prices.count == 0)
+  end
+
+  def compute_volume_price_quantities(type, default_price, quantity, user)
+    volume_prices = join_volume_prices user
+    if volume_prices.count == 0
+      if use_master_variant_volume_pricing?
+        product.master.send(type, quantity, user)
+      else
+        return default_price
+      end
+    else
+      volume_prices.each do |volume_price|
+        if volume_price.include?(quantity)
+          return send "compute_#{type}".to_sym, volume_price
+        end
+      end
+
+      # No price ranges matched.
+      default_price
+    end
+  end
+
+  def compute_volume_price(volume_price)
+    case volume_price.discount_type
+    when 'price'
+      return volume_price.amount
+    when 'dollar'
+      return price - volume_price.amount
+    when 'percent'
+      return price * (1 - volume_price.amount)
+    end
+  end
+
+  def compute_volume_price_earning_percent(volume_price)
+    case volume_price.discount_type
+    when 'price'
+      diff = price - volume_price.amount
+      return (diff * 100 / price).round
+    when 'dollar'
+      return (volume_price.amount * 100 / price).round
+    when 'percent'
+      return (volume_price.amount * 100).round
+    end
+  end
+
+  def compute_volume_price_earning_amount(volume_price)
+    case volume_price.discount_type
+    when 'price'
+      return price - volume_price.amount
+    when 'dollar'
+      return volume_price.amount
+    when 'percent'
+      return price - (price * (1 - volume_price.amount))
+    end
+  end
+end

data/app/models/spree/volume_price.rb

@@ -0,0 +1,35 @@
+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'
+  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
+    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
+  end
+end

data/app/models/spree/volume_price_model.rb

@@ -0,0 +1,8 @@
+class Spree::VolumePriceModel < ActiveRecord::Base
+  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?
+    }
+end

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

@@ -0,0 +1,3 @@
+<!-- insert_bottom "[data-hook='admin_configurations_sidebar_menu'], #admin_configurations_sidebar_menu[data-hook]" -->
+
+<%= configurations_sidebar_menu_item Spree.t('volume_price_models'), admin_volume_price_models_path if can? :admin, Spree::VolumePriceModel %>

data/app/overrides/views_decorator.rb

@@ -0,0 +1,13 @@
+Deface::Override.new(
+  virtual_path: 'spree/admin/shared/_product_tabs',
+  name: 'add_volume_pricing_admin_tab',
+  insert_bottom: '[data-hook="admin_product_tabs"]',
+  partial: 'spree/admin/shared/vp_product_tab'
+)
+
+Deface::Override.new(
+  virtual_path: 'spree/admin/variants/edit',
+  name: 'add_volume_pricing_field_to_variant',
+  insert_after: '[data-hook="admin_variant_edit_form"]',
+  partial: 'spree/admin/variants/edit_fields'
+)

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

@@ -0,0 +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) %>
+<% end %>

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

@@ -0,0 +1,33 @@
+<% 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 %>
+
+<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>

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

@@ -0,0 +1,39 @@
+<%= render 'spree/admin/shared/product_tabs', current: Spree.t(: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 %>
+
+<%= 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 %>

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

@@ -0,0 +1,9 @@
+<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>
+    <%= 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 %>
+</div>

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

@@ -0,0 +1,23 @@
+<table class="table sortable" id='listing_volume_price_models' data-hook data-sortable-link="<%#= update_positions_admin_volume_price_models_url %>">
+  <thead>
+    <tr data-hook="volume_price_models_header">
+      <th class="no-border"></th>
+      <th><%= Spree.t(:name) %></th>
+      <th class="actions"></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @volume_price_models.each do |price_model| %>
+      <tr id="<%= spree_dom_id price_model %>" data-hook="volume_price_models_row">
+        <td class="move-handle">
+          <span class="icon icon-sort handle"></span>
+        </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 %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

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

@@ -0,0 +1,12 @@
+<% content_for :page_title do %>
+  <%= Spree.t(:volume_price_model_edit) %>
+<% end %>
+
+<%= form_for [:admin, @volume_price_model] do |f| %>
+  <fieldset>
+    <%= render partial: 'form', locals: { f: f } %>
+  </fieldset>
+
+  <%= render 'spree/admin/shared/edit_resource_links' %>
+
+<% end %>

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

@@ -0,0 +1,18 @@
+<% content_for :page_title do %>
+  <%= "Volume Price Models" %>
+<% 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' %>
+<% end %>
+
+<% if @volume_price_models.any? %>
+  <div id="list-volume-price-models" data-hook>
+    <%= 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>
+<% end %>

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

@@ -0,0 +1,12 @@
+<% content_for :page_title do %>
+  <%= Spree.t(:new_volume_price_model) %>
+<% end %>
+
+<%= form_for [:admin, @volume_price_model] do |f| %>
+  <fieldset>
+    <%= render partial: 'form', locals: { f: f } %>
+    <div class="form-actions" data-hook="buttons">
+      <%= button Spree.t(:create), 'save' %>
+    </div>
+  </fieldset>
+<% end %>

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

@@ -0,0 +1,31 @@
+<% 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 %>
+
+<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>
+</table>
+<br/><br/>

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

@@ -0,0 +1,33 @@
+<tr class="volume_price fields">
+  <td>
+    <%= error_message_on(f.object, :name) %>
+    <%= f.text_field :name, size: 10, class: 'form-control' %>
+  </td>
+  <td>
+    <%= error_message_on(f.object, :discount_type) %>
+    <%= f.select :discount_type, [
+        ["#{Spree.t(:total_price)}", 'price'],
+        ["#{Spree.t(:percent_discount)}", 'percent'],
+        ["#{Spree.t(:price_discount)}", 'dollar']
+      ], { inlcude_blank: true }, class: 'select2' %>
+  </td>
+  <td>
+    <%= error_message_on(f.object, :range) %>
+    <%= f.text_field :range, size: 10, class: 'form-control' %>
+  </td>
+  <td>
+    <%= error_message_on(f.object, :amount) %>
+    <%= f.text_field :amount, size: 10, class: 'form-control' %>
+  </td>
+  <td>
+    <%= error_message_on(f.object, :position) %>
+    <%= f.text_field :position, size: 3, class: 'form-control' %>
+  </td>
+  <td>
+    <%= error_message_on(f.object, :role_id) %>
+    <%= f.collection_select(:role_id, Spree::Role.all, :id, :name, { include_blank: Spree.t('match_choices.none') }, { class: 'select2' }) %>
+  </td>
+  <td class="actions">
+    <%= link_to_icon_remove_fields f %>
+  </td>
+</tr>