spree_advanced_calculators 0.0.1

data/app/controllers/admin/bucket_rates_controller.rb

@@ -0,0 +1,38 @@
+class Admin::BucketRatesController < Admin::BaseController
+  resource_controller
+  before_filter :load_data
+  layout 'admin'
+
+  update.response do |wants|
+    wants.html { redirect_to collection_url }
+  end
+
+  create.response do |wants|
+    wants.html { 
+      if params["create_another"]
+        rate = params["bucket_rate"].dup
+        rate[:floor] = rate.delete(:ceiling)
+        redirect_to new_object_url+"?"+({"bucket_rate" => rate}.to_param)
+      else
+        redirect_to collection_url 
+      end
+    }
+  end
+    
+  private
+  def collection
+    conditions = params[:calculator_id] ? {:calculator_id => params[:calculator_id]} : {}
+    @collection ||= end_of_association_chain.all(
+      :conditions => conditions,
+      :order => 'calculator_id DESC, floor ASC'
+    )
+  end
+	
+  def load_data
+    @available_calculators = Calculator.find(
+      :all,
+      :conditions => {:advanced => true},
+      :order => 'created_at DESC'
+    )
+  end
+end

data/app/models/bucket_rate.rb

@@ -0,0 +1,28 @@
+class BucketRate < ActiveRecord::Base
+  belongs_to :calculator
+  
+  validates_presence_of :floor, :ceiling, :rate, :calculator_id
+
+  scope :order_by_floor, :order => "floor"
+  scope :for_calculator, lambda{ |calc|
+    if calc.is_a?(Calculator)
+      {:conditions => {:calculator_id => calc.id}}
+    else
+      {:conditions => {:calculator_id => calc.to_i}}
+    end
+  }
+
+  def unit
+    calculator && calculator.unit
+  end
+
+  def validate
+    if !ceiling.blank? && !floor.blank? && ceiling.to_i < floor.to_i
+      errors.add(:ceiling, :higher_or_equal)
+    end
+  end
+  
+  def <=>(other)
+    self.floor <=> other.floor
+  end
+end

data/app/models/calculator/advanced.rb

@@ -0,0 +1,50 @@
+class Calculator::Advanced < Calculator
+  has_many :bucket_rates, :foreign_key => :calculator_id, :dependent => :destroy
+  preference :default_amount, :decimal, :default => 0
+
+  before_save :set_advanced
+
+  def self.register
+    super
+    # Chetan -> to use with promotions remove below comment
+    # Coupon.register_calculator(self)
+    ShippingMethod.register_calculator(self)
+    # Chetan -> I suppose we are not using shipping rates anymore in recent versions of Spree
+    # ShippingRate.register_calculator(self)
+  end
+
+  def set_advanced
+    self.advanced = true
+  end
+
+  def name
+    calculable.respond_to?(:name) ? calculable.name : calculable.to_s
+  end
+
+  def unit
+    self.class.unit
+  end
+
+  def get_rate(value)
+    # First try to find where price falls within price floor and ceiling
+    bucket = BucketRate.find(:first,
+      :conditions => [
+        "calculator_id = ? and floor <= ? and ceiling > ?",
+        self.id, value, value
+      ])
+
+    if bucket
+      return(bucket.rate)
+    else
+      # find largest one
+      bucket = BucketRate.find(:last, :conditions => ['calculator_id = ?', self.id], :order => "ceiling ASC")
+      # check if we've found largest one, and item_total is higher then ceiling
+      if bucket && value > bucket.ceiling
+        return(bucket.rate)
+      else
+        return(false) # if there's no rates, or we've hit a hole, let calculator use default rate.
+      end
+    end
+  end
+  
+end

data/app/models/calculator/quantity_bucket.rb

@@ -0,0 +1,15 @@
+class Calculator::QuantityBucket < Calculator::Advanced
+  def self.description
+    I18n.t("quantity_bucket", :scope => :calculator_names)
+  end
+
+  def self.unit
+    I18n.t(:qty)
+  end
+
+  # as object we always get line items, as calculable we have Coupon, ShippingMethod
+  def compute(object)
+    total_quantity = object.line_items.map(&:quantity).sum
+    get_rate(total_quantity) || self.preferred_default_amount
+  end
+end

data/app/models/calculator/weight_bucket.rb

@@ -0,0 +1,20 @@
+class Calculator::WeightBucket < Calculator::Advanced
+  preference :default_weight, :decimal, :default => 0
+
+  def self.description
+    I18n.t("weight_bucket", :scope => :calculator_names)
+  end
+
+  def self.unit
+    I18n.t('weight_unit')
+  end
+
+  # as object we always get line items, as calculable we have Coupon, ShippingMethod
+  def compute(object)    
+    total_weight = object.line_items.map{|li|
+        (li.variant.weight || self.preferred_default_weight) * li.quantity
+      }.sum
+
+    get_rate(total_weight) || self.preferred_default_amount
+  end
+end

data/app/views/admin/bucket_rates/_form.html.erb

@@ -0,0 +1,37 @@
+<table>
+  <% if @bucket_rate.calculator_id.blank? %>
+    <tr>
+      <td><%=t("calculator")%>:</td>
+      <td>
+        <%= collection_select(
+          :bucket_rate,
+          :calculator_id, @available_calculators,
+          :id, :name, {}, {"style" => "width:200px"}
+        ) %>
+      </td>
+    </tr>
+  <% else %>
+    <%= f.hidden_field :calculator_id %>
+  <% end %>
+  <tr>
+    <td><%= t("floor", :scope => 'activerecord.attributes.bucket_rate') %>:</td>
+    <td>
+      <%= f.text_field :floor, {"style" => "width:60px"} %>
+      <%= @bucket_rate.unit %>
+    </td>
+  </tr>
+  <tr>
+    <td><%= t("ceiling", :scope => 'activerecord.attributes.bucket_rate') %>:</td>
+    <td>
+      <%= f.text_field :ceiling, {"style" => "width:60px"} %>
+      <%= @bucket_rate.unit %>
+    </td>
+  </tr>
+  <tr>
+    <td><%= t("rate", :scope => 'activerecord.attributes.bucket_rate') %>:</td>
+    <td>
+      <%= f.text_field :rate, {"style" => "width:60px"} %>
+      <%= t(:'number.currency.format.unit') %>
+    </td>
+  </tr>
+</table>

data/app/views/admin/bucket_rates/edit.html.erb

@@ -0,0 +1,8 @@
+<h1><%= t("edit_bucket_rate") %></h1>
+<%= error_messages_for :bucket_rate %>
+<% form_for(:bucket_rate, :url => object_url, :html => { :method => :put }) do |f| %>
+  <%= render :partial => "form", :locals => { :f => f } %>
+  <p>
+    <%=submit_tag t("actions.update")%>
+  </p>
+<% end %>

data/app/views/admin/bucket_rates/index.html.erb

@@ -0,0 +1,49 @@
+<div class='toolbar'>
+  <ul class='actions'>
+    <li>
+      <%= button_link_to t("new_bucket_rate"), new_object_url, :icon => 'add'  %>
+    </li>
+  </ul>
+  <br class='clear' />
+</div>
+
+<h1><%= t("bucket_rate") %></h1>
+<p>  
+   In order to use the Bucket Rate calculator, you need to create intervals without gaps between them. 
+   <br />
+   When the order total does not fall within an interval, the default rate will be used.
+   Order amounts larger than the largest ceiling will use the last interval rate.
+   <br />
+   NOTE: The FLOOR value is inclusive and the CEILING value is exclusive.
+</p>
+
+<table class="index">
+  <thead>
+    <tr>
+      <th><%= t("name")%></th>
+      <th><%= t("shipping_calculator")%></th>
+      <th><%= t("floor",   :scope => 'activerecord.attributes.bucket_rate') %></th>
+      <th><%= t("ceiling", :scope => 'activerecord.attributes.bucket_rate')%></th>
+      <th><%= t("rate",    :scope => 'activerecord.attributes.bucket_rate') %></th>
+      <th><%= t("action")%></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @bucket_rates.sort.each do |rate| %>
+      <tr>
+        <td><%=rate.calculator ? rate.calculator.name: "-" %></td>
+        <td><%=rate.calculator ? rate.calculator.class.description: "-" %></td>
+        <td><%=rate.floor %> <%= rate.unit %></td>
+        <td><%=rate.ceiling %> <%= rate.unit %></td>
+        <td><%=number_to_currency(rate.rate) %></td>
+        <td>
+          <%= link_to_edit rate %> &nbsp;
+          <%= link_to_delete rate %>
+        </td>
+      </tr>
+    <% end %>
+    <% if @bucket_rates.empty? %>
+      <tr><td colspan="5"><%= t(:none) %></td></tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/admin/bucket_rates/new.html.erb

@@ -0,0 +1,11 @@
+<h1><%= t("new_bucket_rate") %></h1>
+
+<%= error_messages_for :bucket_rate %>
+
+<% form_for(:bucket_rate, :url => collection_url) do |f| %>
+  <%= render :partial => "form", :locals => { :f => f } %>
+  <p>
+    <%= submit_tag t("actions.create") %>
+    <%= submit_tag t("actions.create_another"), :name => "create_another" %>
+  </p>
+<% end %>

data/app/views/admin/shared/_calculator_fields.html.erb

@@ -0,0 +1,39 @@
+<fieldset id="calculator_fields">
+  <legend><%= t('calculator') %></legend>
+  <div id="preference-settings">
+  
+    <p>
+      <%= f.label(:calc_type, t("calculator")) %>
+      <%= f.collection_select(:calculator_type, @calculators, :to_s, :description, {}, {:id => "calc-type"}) %>
+    </p>
+
+    <% if !@object.new_record? %>
+      <div class="calculator-settings">
+        <%= f.fields_for :calculator do |calculator_form| %>
+          <%= preference_fields(@object.calculator, calculator_form) %>
+        <% end %>
+      </div>
+      <% if @object.calculator.respond_to?(:preferences) %>
+        <div id="calculator-settings-warning"><%= t('calculator_settings_warning')%></div>
+      <% end %>
+      <% if @object.calculator.advanced? && !@object.calculator.name.blank? %>
+        <% if BucketRate.for_calculator(@calculator).count == 0 %>
+          <%= t(:configure_new_bucket_rate) %>
+          <%= link_to t(:click_here), {
+            :controller => 'admin/bucket_rates',
+            :action => 'new',
+            :bucket_rate => {:calculator_id => @object.calculator.id}
+          } %>
+        <% else %>
+          <%= t(:configure_bucket_rates) %>
+          <%= link_to t(:click_here), {
+            :controller => 'admin/bucket_rates',
+            :action => 'index',
+            :calculator_id => @object.calculator.id
+          } %>
+        <% end %>
+      <% end %>
+    <% end %>
+    
+  </div>
+</fieldset>

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  namespace :admin do
+    resources :bucket_rates
+  end
+end

data/lib/spree_advanced_calculators.rb

@@ -0,0 +1,14 @@
+require 'spree_core'
+require 'spree_advanced_calculators_hooks'
+
+module SpreeAdvancedCalculators
+  class Engine < Rails::Engine
+    def self.activate
+      [ 
+        Calculator::WeightBucket, 
+        Calculator::QuantityBucket
+      ].each(&:register)
+    end
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_advanced_calculators_hooks.rb

@@ -0,0 +1,8 @@
+class SpreeAdvancedCalculatorsHooks < Spree::ThemeSupport::HookListener
+    insert_after(:admin_configurations_menu) do
+    '<tr>
+      <td><%= link_to t("bucket_rates"), admin_bucket_rates_url %></td>
+      <td><%= t("bucket_rates") %></td>
+    </tr>'
+  end
+end

data/lib/tasks/install.rake

@@ -0,0 +1,16 @@
+namespace :spree_advanced_calculators do
+  desc "Copies all migrations and assets (NOTE: This will be obsolete with Rails 3.1)"
+  task :install do
+    Rake::Task['spree_advanced_calculators:install:migrations'].invoke
+  end
+
+  namespace :install do
+    desc "Copies all migrations (NOTE: This will be obsolete with Rails 3.1)"
+    task :migrations do
+      source = File.join(File.dirname(__FILE__), '..', '..', 'db')
+      destination = File.join(Rails.root, 'db')
+      Spree::FileUtilz.mirror_files(source, destination)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: spree_advanced_calculators
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chetan Mittal
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-02 00:00:00 +05:30
+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 
+        version: 0.40.0
+  type: :runtime
+  version_requirements: *id001
+description: Allows advanced calculators such as weight etc to be applied on shipping methods
+email: chetan.mittal@niamtech.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/tasks/install.rake
+- lib/spree_advanced_calculators_hooks.rb
+- lib/spree_advanced_calculators.rb
+- app/views/admin/bucket_rates/edit.html.erb
+- app/views/admin/bucket_rates/new.html.erb
+- app/views/admin/bucket_rates/_form.html.erb
+- app/views/admin/bucket_rates/index.html.erb
+- app/views/admin/shared/_calculator_fields.html.erb
+- app/models/bucket_rate.rb
+- app/models/calculator/advanced.rb
+- app/models/calculator/weight_bucket.rb
+- app/models/calculator/quantity_bucket.rb
+- app/controllers/admin/bucket_rates_controller.rb
+- config/routes.rb
+has_rdoc: true
+homepage: http://www.niamtech.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: 
+- none
+rubyforge_project: spree_advanced_calculators
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Allows advanced calculators such as weight etc to be applied on shipping methods
+test_files: []
+