spree_payment_calculator 0.70.1 → 1.0.0

data/README.md

@@ -9,7 +9,7 @@ Basic Installation
 
 1. Add the following to your Gemfile
 <pre>
-  gem 'spree_payment_calculator', '~> 0.70.1'
+  gem 'spree_payment_calculator', '~> 1.0.0'
 </pre>
 2. Run `bundle install`
 3. Go to Payment Method in the Admin panel and add a calculator for each type of payment you prefer

data/app/model/spree/payment_calculator/default_tax.rb

@@ -0,0 +1,51 @@
+require_dependency 'spree/calculator'
+
+module Spree
+  class PaymentCalculator::DefaultTax < Calculator
+    def self.description
+      I18n.t(:default_tax)
+    end
+
+    def compute(computable)
+      case computable
+        when Spree::Order
+          compute_order(computable)
+        when Spree::LineItem
+          compute_line_item(computable)
+      end
+    end
+
+
+    private
+
+      def rate
+        rate = self.calculable
+      end
+
+      def compute_order(order)
+        matched_line_items = order.line_items.select do |line_item|
+          line_item.product.tax_category == rate.tax_category
+        end
+
+        line_items_total = matched_line_items.sum(&:total)
+        round_to_two_places(line_items_total * rate.amount)
+      end
+
+      def compute_line_item(line_item)
+        if line_item.product.tax_category == rate.tax_category
+          deduced_total_by_rate(line_item.total, rate)
+        else
+          0
+        end
+      end
+
+      def round_to_two_places(amount)
+        BigDecimal.new(amount.to_s).round(2, BigDecimal::ROUND_HALF_UP)
+      end
+      
+      def deduced_total_by_rate(total, rate)
+        round_to_two_places(total - ( total / (1 + rate.amount) ) )
+      end
+
+  end
+end

data/app/model/spree/payment_calculator/flat_percent_item_total.rb

@@ -0,0 +1,20 @@
+require_dependency 'spree/calculator'
+
+module Spree
+  class PaymentCalculator::FlatPercentItemTotal < Calculator
+    preference :flat_percent, :decimal, :default => 0
+
+    attr_accessible :preferred_flat_percent
+
+    def self.description
+      I18n.t(:flat_percent)
+    end
+
+    def compute(object)
+      return unless object.present? and object.line_items.present?
+      item_total = object.line_items.map(&:amount).sum
+      value = item_total * BigDecimal(self.preferred_flat_percent.to_s) / 100.0
+      (value * 100).round.to_f / 100
+    end
+  end
+end

data/app/model/spree/payment_calculator/flat_rate.rb

@@ -0,0 +1,17 @@
+require_dependency 'spree/calculator'
+
+module Spree
+  class PaymentCalculator::FlatRate < Calculator
+    preference :amount, :decimal, :default => 0
+
+    attr_accessible :preferred_amount
+
+    def self.description
+      I18n.t(:flat_rate_per_order)
+    end
+
+    def compute(object=nil)
+      self.preferred_amount
+    end
+  end
+end

data/app/model/spree/payment_calculator/flexi_rate.rb

@@ -0,0 +1,35 @@
+require_dependency 'spree/calculator'
+
+module Spree
+  class PaymentCalculator::FlexiRate < Calculator
+    preference :first_item,      :decimal, :default => 0.0
+    preference :additional_item, :decimal, :default => 0.0
+    preference :max_items,       :integer, :default => 0
+
+    attr_accessible :preferred_first_item, :preferred_additional_item, :preferred_max_items
+
+    def self.description
+      I18n.t(:flexible_rate)
+    end
+
+    def self.available?(object)
+      true
+    end
+
+    def compute(object)
+      sum = 0
+      max = self.preferred_max_items.to_i
+      items_count = object.line_items.map(&:quantity).sum
+      items_count.times do |i|
+        # check max value to avoid divide by 0 errors
+        if (max == 0 && i == 0) || (max > 0) && (i % max == 0)
+          sum += self.preferred_first_item.to_f
+        else
+          sum += self.preferred_additional_item.to_f
+        end
+      end
+
+      sum
+    end
+  end
+end

data/app/model/spree/payment_calculator/per_item.rb

@@ -0,0 +1,20 @@
+require_dependency 'spree/calculator'
+
+module Spree
+  class PaymentCalculator::PerItem < Calculator
+    preference :amount, :decimal, :default => 0
+
+    attr_accessible :preferred_amount
+
+    def self.description
+      I18n.t(:flat_rate_per_item)
+    end
+
+    def compute(object=nil)
+      return 0 if object.nil?
+      self.preferred_amount * object.line_items.reduce(0) do |sum, value|
+        sum + value.quantity
+      end
+    end
+  end
+end

data/app/model/spree/payment_calculator/price_sack.rb

@@ -0,0 +1,32 @@
+require_dependency 'spree/calculator'
+
+module Spree
+  class PaymentCalculator::PriceSack < Calculator
+    preference :minimal_amount, :decimal, :default => 0
+    preference :normal_amount, :decimal, :default => 0
+    preference :discount_amount, :decimal, :default => 0
+
+    attr_accessible :preferred_minimal_amount,
+                    :preferred_normal_amount,
+                    :preferred_discount_amount
+
+    def self.description
+      I18n.t(:price_sack)
+    end
+
+    # as object we always get line items, as calculable we have Coupon, ShippingMethod
+    def compute(object)
+      if object.is_a?(Array)
+        base = object.map { |o| o.respond_to?(:amount) ? o.amount : o.to_d }.sum
+      else
+        base = object.respond_to?(:amount) ? object.amount : object.to_d
+      end
+
+      if base >= self.preferred_minimal_amount
+        self.preferred_normal_amount
+      else
+        self.preferred_discount_amount
+      end
+    end
+  end
+end

data/app/model/{payment_decorator.rb → spree/payment_decorator.rb}

@@ -1,4 +1,4 @@
-Payment.class_eval do
+Spree::Payment.class_eval do
   has_one :adjustment, :as => :source
   before_save :remove_old_adjustment
   after_save :ensure_correct_adjustment, :update_order, :if => Proc.new {|p| !p.payment_method.calculator.blank?}

data/app/model/spree/payment_method_decorator.rb

@@ -0,0 +1,3 @@
+Spree::PaymentMethod.class_eval do
+  calculated_adjustments
+end

data/app/overrides/add_calculators_to_payment_methods.rb

@@ -1,5 +1,5 @@
-Deface::Override.new(:virtual_path => 'admin/payment_methods/_form',
+Deface::Override.new(:virtual_path => 'spree/admin/payment_methods/_form',
                      :name => 'add_calculators_to_payment_methods',
                      :insert_before => %q{[id='preference-settings']}, 
-                     :text => %q{<% @calculators = PaymentMethod.send_calculator(params[:id]) %><%= render :partial => 'admin/shared/calculator_fields', :locals => {:f => f}},
+                     :text => %q{<% @calculators = Spree::PaymentMethod.calculators.sort_by(&:name) rescue nil %><%= render :partial => 'spree/admin/shared/calculator_fields', :locals => {:f => f}},
                      :disabled => false)

data/config/locales/en.yml

@@ -1,3 +1,4 @@
 ---
 en:
-  payment_cost: "Fixed Costs by Type of Payment"
+  payment_cost: "Fixed Costs by Type of Payment"
+  payment_adjustment: "Fees"

data/config/locales/it.yml

@@ -1,3 +1,4 @@
 ---
 en:
-  payment_cost: "Costi Fissi per Tipologia di Pagamento"
+  payment_cost: "Costi Fissi per Tipologia di Pagamento"
+  payment_adjustment: "Costo Aggiuntivo"

data/config/routes.rb

@@ -1,3 +1,3 @@
-Rails.application.routes.draw do
+Spree::Core::Engine.routes.prepend do
   # Add your extension routes here
 end

data/lib/generators/spree_payment_calculator/install/install_generator.rb

@@ -11,6 +11,7 @@ module SpreePaymentCalculator
         #inject_into_file "app/assets/stylesheets/store/all.css", " *= require store/spree_payment_calculator\n", :before => /\*\//, :verbose => true
         #inject_into_file "app/assets/stylesheets/admin/all.css", " *= require admin/spree_payment_calculator\n", :before => /\*\//, :verbose => true
       end
+      
     end
   end
 end

data/lib/spree/core/environment/calculators.rb

@@ -0,0 +1,11 @@
+module Spree
+  module Core
+    class Environment
+      class Calculators
+        include EnvironmentExtension
+
+        attr_accessor :shipping_methods, :tax_rates, :payment_methods
+      end
+    end
+  end
+end

data/lib/spree_payment_calculator/engine.rb

@@ -17,35 +17,14 @@ module SpreePaymentCalculator
       Dir.glob(File.join(File.dirname(__FILE__), "../../app/overrides/*.rb")) do |c|
         Rails.application.config.cache_classes ? require(c) : load(c)
       end
+      
+      Dir.glob(File.join(File.dirname(__FILE__), "../../lib/spree/environment/calculator.rb")) do |c|
+        Rails.application.config.cache_classes ? require(c) : load(c)
+      end
     end
-    
     initializer 'spree.register.calculators' do |app|
-      if Gem::Specification::find_by_name('spree_paypal_express')
-        BillingIntegration.class_eval do
-          calculated_adjustments
-        end
-        app.config.spree.calculators.add_class('billing_integrations')
-        app.config.spree.calculators.billing_integrations = [
-          PaymentCalculator::PriceSack,
-          PaymentCalculator::FlatPercentItemTotal,
-          PaymentCalculator::FlatRate,
-          PaymentCalculator::FlexiRate,
-          PaymentCalculator::PerItem
-        ]
-      end
-      
-      app.config.spree.calculators.add_class('payment_methods')
-      app.config.spree.calculators.add_class('gateways')
-      
       app.config.spree.calculators.payment_methods = [
-        PaymentCalculator::PriceSack,
-        PaymentCalculator::FlatPercentItemTotal,
-        PaymentCalculator::FlatRate,
-        PaymentCalculator::FlexiRate,
-        PaymentCalculator::PerItem
-      ]
-      
-      app.config.spree.calculators.gateways = [
+        PaymentCalculator::DefaultTax,
         PaymentCalculator::PriceSack,
         PaymentCalculator::FlatPercentItemTotal,
         PaymentCalculator::FlatRate,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_payment_calculator
 version: !ruby/object:Gem::Version
-  version: 0.70.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-13 00:00:00.000000000 Z
+date: 2012-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree_core
@@ -52,20 +52,21 @@ files:
 - README.md
 - LICENSE
 - lib/generators/spree_payment_calculator/install/install_generator.rb
+- lib/spree/core/environment/calculators.rb
 - lib/spree_payment_calculator/engine.rb
 - lib/spree_payment_calculator.rb
 - app/assets/javascripts/admin/spree_payment_calculator.js
 - app/assets/javascripts/store/spree_payment_calculator.js
 - app/assets/stylesheets/admin/spree_payment_calculator.css
 - app/assets/stylesheets/store/spree_payment_calculator.css
-- app/model/gateway_decorator.rb
-- app/model/payment_calculator/flat_percent_item_total.rb
-- app/model/payment_calculator/flat_rate.rb
-- app/model/payment_calculator/flexi_rate.rb
-- app/model/payment_calculator/per_item.rb
-- app/model/payment_calculator/price_sack.rb
-- app/model/payment_decorator.rb
-- app/model/payment_method_decorator.rb
+- app/model/spree/payment_calculator/default_tax.rb
+- app/model/spree/payment_calculator/flat_percent_item_total.rb
+- app/model/spree/payment_calculator/flat_rate.rb
+- app/model/spree/payment_calculator/flexi_rate.rb
+- app/model/spree/payment_calculator/per_item.rb
+- app/model/spree/payment_calculator/price_sack.rb
+- app/model/spree/payment_decorator.rb
+- app/model/spree/payment_method_decorator.rb
 - app/overrides/add_calculators_to_payment_methods.rb
 - config/locales/en.yml
 - config/locales/it.yml

data/app/model/gateway_decorator.rb

@@ -1,3 +0,0 @@
-Gateway.class_eval do
-  calculated_adjustments
-end

data/app/model/payment_calculator/flat_percent_item_total.rb

@@ -1,14 +0,0 @@
-class PaymentCalculator::FlatPercentItemTotal < Calculator
-  preference :flat_percent, :decimal, :default => 0
-
-  def self.description
-    I18n.t("flat_percent")
-  end
-
-  def compute(object)
-    return unless object.present? and object.line_items.present?
-    item_total = object.line_items.map(&:amount).sum
-    value = item_total * self.preferred_flat_percent / 100.0
-    (value * 100).round.to_f / 100
-  end
-end

data/app/model/payment_calculator/flat_rate.rb

@@ -1,11 +0,0 @@
-class PaymentCalculator::FlatRate < Calculator
-  preference :amount, :decimal, :default => 0
-
-  def self.description
-    I18n.t("flat_rate_per_order")
-  end
-
-  def compute(object=nil)
-    self.preferred_amount
-  end
-end

data/app/model/payment_calculator/flexi_rate.rb

@@ -1,27 +0,0 @@
-class PaymentCalculator::FlexiRate < Calculator
-  preference :first_item,      :decimal, :default => 0
-  preference :additional_item, :decimal, :default => 0
-  preference :max_items,       :decimal, :default => 0
-
-  def self.description
-    I18n.t("flexible_rate")
-  end
-
-  def self.available?(object)
-    true
-  end
-
-  def compute(object)
-    sum = 0
-    max = self.preferred_max_items
-    items_count = object.line_items.map(&:quantity).sum
-    items_count.times do |i|
-      if (i % max == 0) && (max > 0)
-        sum += self.preferred_first_item
-      else
-        sum += self.preferred_additional_item
-      end
-    end
-    return(sum)
-  end
-end

data/app/model/payment_calculator/per_item.rb

@@ -1,11 +0,0 @@
-class PaymentCalculator::PerItem < Calculator
-  preference :amount, :decimal, :default => 0
-
-  def self.description
-    I18n.t("flat_rate_per_item")
-  end
-
-  def compute(object=nil)
-    self.preferred_amount * object.line_items.length
-  end
-end

data/app/model/payment_calculator/price_sack.rb

@@ -1,24 +0,0 @@
-class PaymentCalculator::PriceSack < Calculator
-  preference :minimal_amount, :decimal, :default => 0
-  preference :normal_amount, :decimal, :default => 0
-  preference :discount_amount, :decimal, :default => 0
-
-  def self.description
-    I18n.t("price_sack")
-  end
-
-  # as object we always get line items, as calculable we have Coupon, ShippingMethod
-  def compute(object)
-    if object.is_a?(Array)
-      base = object.map{ |o| o.respond_to?(:amount) ? o.amount : o.to_d }.sum
-    else
-      base = object.respond_to?(:amount) ? object.amount : object.to_d
-    end
-
-    if base >= self.preferred_minimal_amount
-      self.preferred_normal_amount
-    else
-      self.preferred_discount_amount
-    end
-  end
-end

data/app/model/payment_method_decorator.rb

@@ -1,17 +0,0 @@
-PaymentMethod.class_eval do
-  calculated_adjustments
-  
-  def self.send_calculator(id = nil)
-    if id
-      if PaymentMethod.find(id).class.to_s.match(/Gateway/)
-        return Gateway.calculators.sort_by(&:name)
-      elsif PaymentMethod.find(id).class.to_s.match(/BillingIntegration/)
-        return BillingIntegration.calculators.sort_by(&:name)
-      else
-        return PaymentMethod.calculators.sort_by(&:name)
-      end
-    else
-      return PaymentMethod.calculators.sort_by(&:name)
-    end
-  end
-end