spree_volume_pricing 3.0.1

data/README.markdown

@@ -0,0 +1,80 @@
+Volume Pricing
+==============
+
+Volume Pricing is an extension to Spree (a complete open source commerce solution for Ruby on Rails) that uses predefined ranges of quantities to determine the price for a particular product variant.  For instance, this allows you to set a price for quantities between 1-10, another price for quantities between (10-100) and another for quantities of 100 or more.  If no volume price is defined for a variant, then the standard price is used.
+
+Each VolumePrice contains the following values:
+
+1. **Variant:** Each VolumePrice is associated with a _Variant_, which is used to link products to particular prices.
+2. **Display:** The human readable reprentation of the quantity range (Ex. 10-100).  (Optional)
+3. **Range:** The quantity range for which the price is valid (See Below for Examples of Valid Ranges.)
+4. **Amount:** The price of the product if the line item quantity falls within the specified range.
+5. **Position:** Integer value for `acts_as_list` (Helps keep the volume prices in a defined order.)
+
+Ranges
+======
+
+Ranges are expressed as Strings and are similar to the format of a Range object in Ruby.  The lower numeber of the range is always inclusive.  If the range is defined with '..' then it also includes the upper end of the range.  If the range is defined with '...' then the upper end of the range is not inclusive.
+
+Ranges can also be defined as "open ended."  Open ended ranges are defined with an integer followed by a '+' character.  These ranges are inclusive of the integer and any value higher then the integer.
+
+All ranges need to be expressed as Strings and must include parentheses.  "(1..10)" is considered to be a valid range. "1..10" is not considered to be a valid range (missing the parentheses.)
+
+Examples
+========
+Consider the following examples of volume prices:
+
+       Variant                Display            Range        Amount         Position
+       -------------------------------------------------------------------------------
+       Rails T-Shirt          1-5                (1..5)       19.99          1
+       Rails T-Shirt          6-9                (6...10)     18.99          2
+       Rails T-Shirt          10 or more         (10+)        17.99          3
+
+## Example 1
+
+Cart Contents:
+
+       Product                Quantity       Price       Total
+       ----------------------------------------------------------------
+       Rails T-Shirt          1              19.99       19.99
+
+## Example 2
+
+Cart Contents:
+
+       Product                Quantity       Price       Total
+       ----------------------------------------------------------------
+       Rails T-Shirt          5              19.99       99.95
+
+## Example 3
+
+Cart Contents:
+
+      Product                Quantity       Price       Total
+      ----------------------------------------------------------------
+      Rails T-Shirt          6              18.99       113.94
+
+## Example 4
+
+Cart Contents:
+
+      Product                Quantity       Price       Total
+      ----------------------------------------------------------------
+      Rails T-Shirt          10             17.99       179.90
+
+## Example 5
+
+Cart Contents:
+
+      Product                Quantity       Price       Total
+      ----------------------------------------------------------------
+      Rails T-Shirt          20             17.99       359.80
+
+
+Additional Notes
+================
+
+* The volume price is applied based on the total quantity ordered for a particular variant.  It does not apply different prices for the portion of the quantity that falls within a particular range.  Only the one price is used (although this would be an interesting configurable option if someone wanted to write a patch.)
+
+
+

data/app/models/volume_price.rb

@@ -0,0 +1,27 @@
+class VolumePrice < ActiveRecord::Base
+  belongs_to :variant
+  acts_as_list :scope => :variant
+  validates_presence_of :variant
+  validates_presence_of :amount
+  
+  OPEN_ENDED = /\([0-9]+\+\)/
+  
+  def validate
+    return if open_ended?
+    errors.add(:range, "must be in one of the following formats: (a..b), (a...b), (a+)") unless /\([0-9]+\.{2,3}[0-9]+\)/ =~ range
+  end
+  
+  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/views/admin/shared/_vp_product_tab.html.erb

@@ -0,0 +1,5 @@
+<% if url_options_authenticate?(:controller => 'admin/taxons') %>
+ <li <%= ' class="active"' if current == "Volume Pricing" %>>
+   <%= link_to("Volume Pricing", volume_prices_admin_product_variant_url(@product, @product.master))  %>
+ </li>
+<% end %>

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

@@ -0,0 +1,17 @@
+<h3><%= t("volume_prices") %></h3>
+<table class="index">
+  <thead>
+    <tr>
+      <th><%= t("display") %></th>
+      <th><%= t("range") %></th>
+      <th><%= t("amount") %></th>
+      <th><%= t("position") %></th>
+      <th><%= t("action") %></th>
+    </tr>
+  </thead>
+  <tbody id="volume_prices">
+    <%= f.render_associated_form(@variant.volume_prices) %>
+  </tbody>
+</table>
+<%= f.add_associated_link(icon('add') + ' ' + t("add_volume_price"), @variant.volume_prices.build) %>
+<br/><br/>

data/app/views/admin/variants/_volume_price.html.erb

@@ -0,0 +1,19 @@
+<tr class="volume_price">
+  <td valign="top">
+    <%= error_message_on(f.object, :display) %>
+    <%= f.text_field(:display, :size => 10) %>
+  </td>
+  <td valign="top">
+    <%= error_message_on(f.object, :range) %>
+    <%= f.text_field(:range, :size => 10) %>
+  </td>
+  <td valign="top">
+    <%= error_message_on(f.object, :amount) %>
+    <%= f.text_field(:amount, :size => 10) %>
+  </td>
+  <td valign="top">
+    <%= error_message_on(f.object, :position) %>
+    <%= f.text_field(:position, :size => 3) %>
+  </td>
+  <td valign="top"><%= f.remove_link icon('delete') + ' ' + t("remove") %></td>
+</tr>

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

@@ -0,0 +1,28 @@
+<%= render :partial => 'admin/shared/product_sub_menu' %>
+
+<%= render :partial => 'admin/shared/product_tabs', :locals => {:current => "Volume Pricing"} %>
+
+<%= error_messages_for :variant %>
+
+<% form_for(:variant, :url => admin_product_variant_url(@product, @variant), :html => { :method => :put }) do |f| %>
+
+  <h3><%= t("volume_prices") %></h3>
+  <table class="index">
+    <thead>
+      <tr>
+        <th><%= t("display") %></th>
+        <th><%= t("range") %></th>
+        <th><%= t("amount") %></th>
+        <th><%= t("position") %></th>
+        <th><%= t("action") %></th>
+      </tr>
+    </thead>
+    <tbody id="volume_prices">
+      <%= f.render_associated_form(@variant.volume_prices) %>
+    </tbody>
+  </table>
+  <%= f.add_associated_link(icon('add') + ' ' + t("add_volume_price"), @variant.volume_prices.build) %>
+  <br/><br/>
+
+  <%= render :partial => 'admin/shared/edit_resource_links' %>
+<% end %>

data/lib/spree_volume_pricing.rb

@@ -0,0 +1,5 @@
+require 'spree_core'
+require 'spree_volume_pricing'
+require 'spree_volume_pricing/engine'
+
+

data/lib/spree_volume_pricing/engine.rb

@@ -0,0 +1,109 @@
+require "spree_volume_pricing"
+
+module SpreeVolumePricing
+
+  class Engine < Rails::Engine
+
+    def self.activate
+
+      Variant.class_eval do 
+        has_many :volume_prices, :order => :position, :dependent => :destroy
+        accepts_nested_attributes_for :volume_prices
+        
+        # calculates the price based on quantity
+        def volume_price(quantity)
+          volume_prices.each do |price|
+            return price.amount if price.include?(quantity)
+          end
+          self.price
+        end
+        
+      end
+      
+      Order.class_eval do
+        # override the add_variant functionality so that we can adjust the price based on possible volume adjustment
+        def add_variant(variant, quantity=1)
+          current_item = contains?(variant)
+          price = variant.volume_price(quantity) # Added
+          if current_item
+            current_item.increment_quantity unless quantity > 1
+            current_item.quantity = (current_item.quantity + quantity) if quantity > 1
+            current_item.price = price # Added
+            current_item.save
+          else
+            current_item = line_items.create(:quantity => quantity)
+            current_item.variant = variant
+            current_item.price = price
+            current_item.save
+          end
+
+          # populate line_items attributes for additional_fields entries
+          # that have populate => [:line_item]
+          Variant.additional_fields.select{|f| !f[:populate].nil? && f[:populate].include?(:line_item) }.each do |field| 
+            value = ""
+
+            if field[:only].nil? || field[:only].include?(:variant)
+              value = variant.send(field[:name].gsub(" ", "_").downcase)
+            elsif field[:only].include?(:product)
+              value = variant.product.send(field[:name].gsub(" ", "_").downcase)
+            end
+            current_item.update_attribute(field[:name].gsub(" ", "_").downcase, value)
+          end
+        end
+      end
+
+      LineItem.class_eval do
+        before_update :check_volume_pricing
+        
+        private
+        def check_volume_pricing
+          if changed? && changes.keys.include?("quantity")
+            self.price = variant.volume_price(quantity)
+          end
+        end
+      end
+      
+      String.class_eval do 
+       def to_range
+         case self.count('.')
+           when 2
+             elements = self.split('..')
+             return Range.new(elements[0].from(1).to_i, elements[1].to_i)
+           when 3
+             elements = self.split('...')
+             return Range.new(elements[0].from(1).to_i, elements[1].to_i-1)
+           else
+             raise ArgumentError.new("Couldn't convert to Range: #{self}")
+         end
+       end
+      end
+      
+      Admin::VariantsController.class_eval do
+        update.before do
+          params[:variant][:volume_price_attributes] ||= {}
+        end      
+        
+        update.response do |wants| 
+          wants.html do 
+            redirect_to object.is_master ? volume_prices_admin_product_variant_url(object.product, object) : collection_url
+          end
+        end
+
+        def object 
+          @object ||=  Variant.find(params[:id]) 
+        end
+        
+        def volume_prices
+          @variant = object
+          @product = @variant.product
+        end
+      end
+    
+    end
+
+    config.autoload_paths += %W(#{config.root}/lib)
+    config.to_prepare &method(:activate).to_proc
+
+  end
+end
+

data/lib/spree_volume_pricing_hooks.rb

@@ -0,0 +1,7 @@
+class VolumePricingHooks < Spree::ThemeSupport::HookListener
+
+  insert_after :admin_product_tabs, :partial => "admin/shared/vp_product_tab"
+
+  insert_after :admin_variant_edit_form, :partial => "admin/variants/edit_fields"
+
+end

data/lib/tasks/volume_pricing_extension_tasks.rake

@@ -0,0 +1,29 @@
+namespace :db do
+  desc "Bootstrap your database for Spree."
+  task :bootstrap  => :environment do
+    # load initial database fixtures (in db/sample/*.yml) into the current environment's database
+    ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+    Dir.glob(File.join(VolumePricingExtension.root, "db", 'sample', '*.{yml,csv}')).each do |fixture_file|
+      Fixtures.create_fixtures("#{VolumePricingExtension.root}/db/sample", File.basename(fixture_file, '.*'))
+    end
+
+  end
+end
+
+namespace :spree do
+  namespace :extensions do
+    namespace :volume_pricing do
+      desc "Copies public assets of the Volume Pricing to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        Dir[VolumePricingExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(VolumePricingExtension.root, '')
+          directory = File.dirname(path)
+          puts "Copying #{path}..."
+          mkdir_p RAILS_ROOT + directory
+          cp file, RAILS_ROOT + path
+        end
+      end  
+    end
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: spree_volume_pricing
+version: !ruby/object:Gem::Version 
+  hash: 5
+  prerelease: false
+  segments: 
+  - 3
+  - 0
+  - 1
+  version: 3.0.1
+platform: ruby
+authors: []
+
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-03 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: spree_core
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: -1848229955
+        segments: 
+        - 0
+        - 30
+        - 0
+        - beta1
+        version: 0.30.0.beta1
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- lib/spree_volume_pricing/engine.rb
+- lib/spree_volume_pricing.rb
+- lib/spree_volume_pricing_hooks.rb
+- lib/tasks/volume_pricing_extension_tasks.rake
+- app/models/volume_price.rb
+- app/views/admin/shared/_vp_product_tab.html.erb
+- app/views/admin/variants/_edit_fields.html.erb
+- app/views/admin/variants/_volume_price.html.erb
+- app/views/admin/variants/volume_prices.html.erb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: 
+- none
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Allow prices to be configured in quantity ranges for each variant
+test_files: []
+