app/models/charge.rb app/models/shipping_charge.rb app/models/tax_charge.rb db/migrate/20090618203233_create_charges.rb db/sample/charges.yml test/fixtures/charges.yml @@ -30,9 +30,9 @@ class CheckoutsController < Spree::BaseController end success.wants.js do - render :json => { :order_total => number_to_currency(@order.total), - :ship_amount => number_to_currency(@order.ship_amount), - :tax_amount => number_to_currency(@order.tax_amount), + @order.reload + render :json => { :order_total => number_to_currency(@order.total), + :charges => charge_hash, :available_methods => rate_hash}.to_json, :layout => false end @@ -74,5 +74,9 @@ class CheckoutsController < Spree::BaseController :name => ship_method.name, :rate => number_to_currency(ship_method.calculate_shipping(fake_shipment)) } end + end + + def charge_hash + Hash[*@order.charges.collect { |c| [c.description, number_to_currency(c.amount)] }.flatten] end end \ No newline at end of file app/controllers/checkouts_controller.rb @@ -31,10 +31,10 @@ module Spree::BaseHelper options.reverse_merge! :format_as_currency => true, :show_vat_text => true # overwrite show_vat_text if show_price_inc_vat is false - options[:show_vat_text] = Spree::Tax::Config[:show_price_inc_vat] + options[:show_vat_text] = Spree::Config[:show_price_inc_vat] amount = order.item_total - amount += Spree::VatCalculator.calculate_tax(order) if Spree::Tax::Config[:show_price_inc_vat] + amount += Spree::VatCalculator.calculate_tax(order) if Spree::Config[:show_price_inc_vat] options.delete(:format_as_currency) ? number_to_currency(amount) : amount end app/helpers/spree/base_helper.rb @@ -1,6 +1,6 @@ -class Checkout < ActiveRecord::Base - after_update :update_order_totals +class Checkout < ActiveRecord::Base before_save :authorize_creditcard + after_save :update_charges belongs_to :order belongs_to :shipping_method belongs_to :bill_address, :foreign_key => "bill_address_id", :class_name => "Address" @@ -17,7 +17,26 @@ class Checkout < ActiveRecord::Base return unless cc.valid? and cc.authorize(order.total) order.complete end - def update_order_totals + def update_charges + # update shipping (if applicable) + if shipping_method + ship_charge = order.shipping_charges.first + ship_charge ||= order.shipping_charges.build + ship_charge.amount = shipping_method.calculate_shipping(Shipment.new(:order => order, :address => ship_address)) + ship_charge.description = "#{I18n.t(:shipping)} (#{shipping_method.name})" + ship_charge.save + end + # update tax (if applicable) + tax_amount = order.calculate_tax + if tax_amount > 0 + tax_charge = order.tax_charges.first + tax_charge ||= order.tax_charges.build(:description => I18n.t(:tax)) + tax_charge.amount = tax_amount + tax_charge.save + end + + order.reload order.update_totals + order.save end end app/models/checkout.rb @@ -1,7 +1,7 @@ class Order < ActiveRecord::Base - before_save :update_line_items before_create :generate_token - before_create :create_checkout + before_save :update_line_items, :update_totals + after_create :create_checkout has_many :line_items, :dependent => :destroy, :attributes => true has_many :inventory_units @@ -13,14 +13,15 @@ class Order < ActiveRecord::Base has_one :checkout has_one :bill_address, :through => :checkout has_one :ship_address, :through => :checkout - + has_many :charges, :order => :position + has_many :shipping_charges + has_many :tax_charges + delegate :email, :to => :checkout delegate :ip_address, :to => :checkout delegate :special_instructions, :to => :checkout validates_associated :line_items, :message => "are not valid" - validates_numericality_of :tax_amount - validates_numericality_of :ship_amount validates_numericality_of :item_total validates_numericality_of :total @@ -32,7 +33,7 @@ class Order < ActiveRecord::Base make_permalink :field => :number # attr_accessible is a nightmare with attachment_fu, so use attr_protected instead. - attr_protected :ship_amount, :tax_amount, :item_total, :total, :user, :number, :ip_address, :checkout_complete, :state, :token + attr_protected :charge_total, :item_total, :total, :user, :number, :state, :token def to_param self.number if self.number @@ -138,10 +139,14 @@ class Order < ActiveRecord::Base self.item_total = tot end - def total - self.total = self.item_total + self.ship_amount + self.tax_amount - end - + def ship_total + shipping_charges.inject(0) { |sum, charge| charge.amount + 0 } + end + + def tax_total + tax_charges.inject(0) { |sum, charge| charge.amount + 0 } + end + # convenience method since many stores will not allow user to create multiple shipments def shipment shipments.last @@ -172,16 +177,9 @@ class Order < ActiveRecord::Base ShippingMethod.all.select { |method| method.zone.include?(ship_address) && method.available?(self) } end - def update_totals - # finalize order totals - tmp_shipment = shipment || Shipment.new(:order => self, :address => checkout.ship_address) - if checkout.shipping_method - self.ship_amount = checkout.shipping_method.calculate_shipping(tmp_shipment) if checkout.ship_address - else - self.ship_amount = 0 - end - self.tax_amount = calculate_tax - save! + def update_totals + self.charge_total = self.charges.inject(0) { |sum, charge| charge.amount + sum } + self.total = self.item_total + self.charge_total end def calculate_tax @@ -204,14 +202,13 @@ class Order < ActiveRecord::Base shipments.build(:address => ship_address, :shipping_method => checkout.shipping_method) checkout.update_attribute(:completed_at, Time.now) InventoryUnit.sell_units(self) - #update_totals save_result = save! if email OrderMailer.deliver_confirm(self) end save_result - end - + end + def cancel_order restock_inventory OrderMailer.deliver_cancel(self) @@ -234,6 +231,6 @@ class Order < ActiveRecord::Base end def create_checkout - self.checkout = Checkout.create unless self.checkout - end + self.checkout = Checkout.create(:order => self) unless self.checkout + end end app/models/order.rb @@ -4,7 +4,7 @@ class Shipment < ActiveRecord::Base belongs_to :address before_create :generate_shipment_number - after_save :recalculate_tax +# after_save :recalculate_tax after_save :transition_order attr_accessor :special_instructions @@ -41,8 +41,8 @@ class Shipment < ActiveRecord::Base order.state_events.create(:name => I18n.t('ship'), :user => current_user, :previous_state => order.state_was) end - def recalculate_tax - return unless order && order.respond_to?(:calculate_tax) - order.update_attribute("tax_amount", order.calculate_tax) - end +# def recalculate_tax +# return unless order && order.respond_to?(:calculate_tax) +# order.update_attribute("tax_amount", order.calculate_tax) +# end end app/models/shipment.rb @@ -5,7 +5,7 @@ <%= render :partial => 'admin/shared/order_tabs', :locals => {:current => "Order Details"} %> -<%= render :partial => 'admin/shared/order_details', :locals => {:order => @order} -%> +<%= render :partial => 'shared/order_details', :locals => {:order => @order} -%> <% if @order.bill_address %> <div class='adr'> app/views/admin/orders/show.html.erb @@ -6,7 +6,7 @@ </ul> <br class='clear' /> </div> -<h1><%=t("ext_tax_calculator_tax_rates") %></h1> +<h1><%=t("tax_rates") %></h1> <table class="index"> <thead> <th><%=t("zone")%></th> app/views/admin/tax_rates/index.html.erb @@ -10,6 +10,7 @@ Order Summary [CANCELED] <% end -%> ============================================================ Subtotal: <%= number_to_currency @order.item_total %> -Tax: <%= number_to_currency @order.tax_amount %> -Shipping: <%= number_to_currency @order.ship_amount %> +<% @order.charges.each do |charge| %> + <%= "#{charge.description}: #{number_to_currency charge.amount}"%> +<% end %> Order Total: <%= number_to_currency @order.total %> app/views/order_mailer/cancel.html.erb @@ -10,8 +10,9 @@ Order Summary <% end -%> ============================================================ Subtotal: <%= number_to_currency @order.item_total %> -Tax: <%= number_to_currency @order.tax_amount %> -Shipping: <%= number_to_currency @order.ship_amount %> +<% @order.charges.each do |charge| %> + <%= "#{charge.description}: #{number_to_currency charge.amount}"%> +<% end %> Order Total: <%= number_to_currency @order.total %> app/views/order_mailer/confirm.html.erb @@ -10,8 +10,8 @@ "<%= order.number %>", //Order Number "", //Affiliation "<%= order.total %>", //Order total - "<%= order.tax_amount %>", //Tax Amount - "<%= order.ship_amount %>", //Ship Amount + "<%= order.tax_charges.sum(:amount).to_s %>", //Tax Amount + "<%= order.shipping_charges.sum(:amount).to_s %>", //Ship Amount "", //City "", //State "" //Country app/views/orders/_google_order.html.erb @@ -1,36 +1,38 @@ -<table class="order-summary"> - <tr> - <th><%= t('item_description') %></th> - <th class="price"><%= t('price') %></th> - <th class="qty"><%= t('qty') %></th> - <th class="total_display"><span><%= t('total') %></span></th> - </tr> - <% @order.line_items.each do |item| %> - <tr > - <td width="300"><%=item.variant.product.name-%> <%= "(" + variant_options(item.variant) + ")" unless item.variant .option_values.empty? %></td> - <td valign="top"><%= number_to_currency item.price -%></td> - <td valign="top"><%=item.quantity-%></td> - <td valign="top" class="total_display"><span><%= number_to_currency (item.price * item.quantity)-%></span></td> - </tr> - <% end %> - <tr id="subtotal-row"> - <td colspan="3"><b><%= t('subtotal') %>:</b></td> - <td class="total_display"><span><%= number_to_currency @order.item_total -%></span></td> - </tr> - <tr> - <td colspan="3"><b><%= t('tax') %>:</b></td> - <td class="total_display"><span id="tax_amount"><%= number_to_currency @order.tax_amount -%></span></td> - </tr> - <tr> - <td colspan="3"><b><%= t('shipping') %>:</b> - <% if @order.shipment && @order.shipment.shipping_method %> - <span id="ship_method">(<%= @order.shipment.shipping_method.name %>)</span> - <% end %> - </td> - <td class="total_display"><span id="ship_amount"><%= number_to_currency @order.ship_amount -%></span></td> - </tr> - <tr> - <td colspan="3"><b><%= t('order_total') %>:</b></td> - <td class="total_display"><span id="order_total"><%= number_to_currency @order.total -%></span></td> - </tr> -</table> +<table class="index"> + <tbody id='line-items'> + <tr> + <th><%= t('item_description') %></th> + <th class="price"><%= t('price') %></th> + <th class="qty"><%= t('qty') %></th> + <th class="total_display"><span><%= t('total') %></span></th> + </tr> + <% @order.line_items.each do |item| %> + <tr > + <td width="300"><%=item.variant.product.name-%> <%= "(" + variant_options(item.variant) + ")" unless item.variant .option_values.empty? %></td> + <td valign="top"><%= number_to_currency item.price -%></td> + <td valign="top"><%=item.quantity-%></td> + <td valign="top" class="total_display"><span><%= number_to_currency (item.price * item.quantity)-%></span></td> + </tr> + <% end %> + </tbody> + <tbody id='subtotal'> + <tr class="total" id="subtotal-row"> + <td colspan="3"><b><%= t('subtotal') %>:</b></td> + <td class="total_display"><span><%= number_to_currency @order.item_total -%></span></td> + </tr> + </tbody> + <tbody id="order-charges"> + <% order.charges.each do |charge| %> + <tr class="total"> + <td colspan="3"><strong><%= charge.description %></strong></td> + <td class="total_display"><span><%= number_to_currency charge.amount -%></span></td> + </tr> + <% end %> + </tbody> + <tbody id='order-total'> + <tr class="total"> + <td colspan="3"><b><%= t('order_total') %>:</b></td> + <td class="total_display"><span id="order_total"><%= number_to_currency @order.total -%></span></td> + </tr> + </tbody> +</table> \ No newline at end of file app/views/shared/_order_details.html.erb @@ -46,10 +46,8 @@ en-US: ip_address: "IP Address" item_total: "Item Total" number: Number - ship_amount: "Ship Amount" special_instructions: "Special Instructions" state: State - tax_amount: "Tax Amount" total: Total product: available_on: "Available On" config/locales/en-US.yml @@ -1,6 +1,12 @@ class Order < ActiveRecord::Base belongs_to :bill_address, :foreign_key => "bill_address_id", :class_name => "Address" - belongs_to :ship_address, :foreign_key => "ship_address_id", :class_name => "Address" + belongs_to :ship_address, :foreign_key => "ship_address_id", :class_name => "Address" + has_many :shipments +end +Checkout.class_eval do + # temporarily disable the charge stuff since its interfering with this migration + def update_charges + end end class CreateCheckouts < ActiveRecord::Migration @@ -19,13 +25,13 @@ class CreateCheckouts < ActiveRecord::Migration change_table :creditcards do |t| t.references :checkout end - + Checkout.reset_column_information Creditcard.reset_column_information # move address, etc. from order to checkout Order.all.each do |order| - shipping_method = order.shipment.shipping_method if order.shipment + shipping_method = order.shipments.last.shipping_method if order.shipments.present? completed_at = order.attributes["created_at"] if order.attributes["checkout_complete"] creditcard = Creditcard.find_by_order_id(order.id) checkout = Checkout.create(:order => order, db/migrate/20090603153927_create_checkouts.rb @@ -3,7 +3,7 @@ checkout_<%= i %>: ship_address: frank_ship_address_<%= i %> bill_address: frank_bill_address_<%= i %> email: frank.foo@example.com - order: order_<%= i %> - ip_address: 127.0.0.1 - completed_at: <%= Time.now %> + order: order_<%= i %> + completed_at: <%=Time.now%> + ip_address: 127.0.0.1 <% end %> \ No newline at end of file db/sample/checkouts.yml @@ -3,8 +3,6 @@ order_<%= i %>: user: frank number: <%= "R#{Array.new(9){rand(9)}.join}" %> state: new - ship_amount: 5.00 - tax_amount: 2.78 item_total: 37.97 total: 45.75 <% end %> \ No newline at end of file db/sample/orders.yml @@ -301,10 +301,12 @@ var update_shipping_methods = function(methods) { }; var update_confirmation = function(order) { + var textToInsert = ''; + for (var key in order.charges) { + textToInsert += '<tr><td colspan="3"><strong>' + key + '</strong></td><td class="total_display"><span>' + order.charges[key] + '</span></td>'; + } + $('tbody#order-charges').html(textToInsert); $('span#order_total').html(order.order_total); - $('span#ship_amount').html(order.ship_amount); - $('span#tax_amount').html(order.tax_amount); - $('span#ship_method').html(order.ship_method); }; var submit_registration = function() { public/javascripts/checkout.js @@ -147,3 +147,6 @@ div#order :display block :text-align right :padding-right 150px + +tbody#subtotal + border-bottom:1px solid #DDDDDD; \ No newline at end of file public/stylesheets/sass/_checkout.sass @@ -1,5 +1,4 @@ Factory.define :order do |f| - f.line_items { [Factory(:line_item)] } f.charges { [Factory(:ship_charge), Factory(:tax_charge)] } end @@ -116,4 +115,14 @@ end Factory.define :creditcard_txn do |f| f.amount 45.75 f.response_code 12345 +end + +Factory.define :ship_charge, :class => ShippingCharge do |f| + f.amount 8.99 + f.description "Shipping" +end + +Factory.define :tax_charge, :class => TaxCharge do |f| + f.amount 3.17 + f.description "Sales Tax" end \ No newline at end of file test/factories.rb @@ -5,16 +5,17 @@ class ChargeTest < ActiveSupport::TestCase should_validate_presence_of :description context "order instance with charges" do setup do - @charge = Factory(:tax_charge, :amount => 3.00) + @charge = Factory(:tax_charge, :amount => 3.17) @order = Factory(:order, :charges => [@charge]) end context "when adding another charge" do setup do @order.charges << Factory(:ship_charge, :amount => 8.99) @order.save - end - should_change "@order.total", :by => 8.99 - should_change "@order.charge_total", :by => 8.99 + end + + should_change "@order.total.to_f", :by => 8.99 + should_change "@order.charge_total.to_f", :by => 8.99 should_not_change "@order.item_total" end context "when destroying a charge" do @@ -22,8 +23,8 @@ class ChargeTest < ActiveSupport::TestCase @order.charges.clear @order.save end - should_change "@order.total.to_f", :by => -3.00 - should_change "@order.charge_total", :by => -3.00 + should_change "@order.total.to_f", :by => -3.17 + should_change "@order.charge_total.to_f", :by => -3.17 should_not_change "@order.item_total" end end test/unit/charge_test.rb @@ -34,6 +34,62 @@ class CheckoutTest < ActiveSupport::TestCase should_not_change "Creditcard.count" should_not_change "CreditcardPayment.count" should_not_change "CreditcardTxn.count" + end + end + + context "belonging to an order" do + setup do + @checkout = Checkout.new(:order => Order.create, :ship_address => Factory(:address), :bill_address => Factory(:address)) + end + context "with no shipping method" do + setup { @checkout.save } + should_not_change "@checkout.order.shipping_charges" end + context "with shipping method" do + setup do + @shipping_method = ShippingMethod.new + @checkout.shipping_method = @shipping_method + @shipping_method.stub!(:available?, :return => true) + @shipping_method.stub!(:calculate_shipping, :return => 10) + @checkout.save + end + should "increase shipping_charges by 1" do + assert_equal 1, @checkout.order.shipping_charges.size + end + should "have the correct value for the new shipping charge" do + assert_equal 10, @checkout.order.shipping_charges.first.amount + end + should_change "@checkout.order.total", :by => 10 + context "and shipping amount changes" do + setup do + @shipping_method.stub!(:calculate_shipping, :return => 20) + @checkout.save + end + should_not_change "@checkout.order.shipping_charges.count" + should_change "@checkout.order.shipping_charges.first.amount", :from => 10, :to => 20 + end + end + context "with taxable items" do + setup do + @checkout.order.stub!(:calculate_tax, :return => 15) + @checkout.save + end + should "increase tax_charges by 1" do + assert_equal 1, @checkout.order.tax_charges.size + end + should "have the correct value for the newly created tax charge" do + assert_equal 15, @checkout.order.tax_charges.first.amount + end + should_change "@checkout.order.total", :by => 15 + context "and tax amount changes" do + setup do + @checkout.order.stub!(:calculate_tax, :return => 8) + @checkout.save + end + should_not_change "@checkout.order.tax_charges.count" + should_change "@checkout.order.tax_charges.first.amount", :from => 15, :to => 8 + end + end end + end test/unit/checkout_test.rb @@ -85,8 +85,8 @@ module Spree :customer => checkout.email, :ip => checkout.ip_address, :order_id => checkout.order.number, - :shipping => checkout.order.ship_amount * 100, - :tax => checkout.order.tax_amount * 100, + :shipping => checkout.order.ship_total * 100, + :tax => checkout.order.tax_total * 100, :subtotal => checkout.order.item_total * 100} end vendor/extensions/payment_gateway/lib/spree/payment_gateway.rb app/views/admin/shared/_order_details.html.erb 0112563ec294c320e2c33ffac144d558b6b743e8 Sean Schofield schof schof@apache.org http://github.com/railsdog/spree/commit/0f12041d6412364767d9daec5d5a165f8633053e 0f12041d6412364767d9daec5d5a165f8633053e 2009-06-24T19:22:12-07:00 2009-06-18T13:44:50-07:00 Replaced ship_amount and tax_amount with a flexible system of charges. [#499 state:resolved milestone:0.8.99] 5be2245dc58e9504d351f5f574d827ce3c1479d3 Sean Schofield schof schof@apache.org