Merge pull request #1546 from gevann/use-actionmodel-naming-for-calcu…

…lators

Use actionmodel naming for calculators

core/app/models/spree/calculator/flat_percent_item_total.rb

@@ -4,10 +4,6 @@ module Spree
   class Calculator::FlatPercentItemTotal < Calculator
     preference :flat_percent, :decimal, default: 0
 
-    def self.description
-      Spree.t(:flat_percent)
-    end
-
     def compute(object)
       computed_amount = (object.amount * preferred_flat_percent / 100).round(2)
 

core/app/models/spree/calculator/flat_rate.rb

@@ -5,10 +5,6 @@ class Calculator::FlatRate < Calculator
     preference :amount, :decimal, default: 0
     preference :currency, :string, default: ->{ Spree::Config[:currency] }
 
-    def self.description
-      Spree.t(:flat_rate_per_order)
-    end
-
     def compute(object = nil)
       if object && preferred_currency.casecmp(object.currency).zero?
         preferred_amount

core/app/models/spree/calculator/flexi_rate.rb

@@ -7,10 +7,6 @@ class Calculator::FlexiRate < Calculator
     preference :max_items,       :integer, default: 0
     preference :currency,        :string,  default: ->{ Spree::Config[:currency] }
 
-    def self.description
-      Spree.t(:flexible_rate)
-    end
-
     def self.available?(_object)
       true
     end

core/app/models/spree/calculator/free_shipping.rb

@@ -3,9 +3,6 @@ module Spree
   #   The only case where it was used was for Free Shipping Promotions.  There is
   #   now a Promotion Action which deals with these types of promotions instead.
   class Calculator::FreeShipping < Calculator
-    def self.description
-      Spree.t(:free_shipping)
-    end
 
     def compute(object)
       if object.is_a?(Array)

core/app/models/spree/calculator/percent_on_line_item.rb

@@ -3,10 +3,6 @@ class Calculator
     class PercentOnLineItem < Calculator
       preference :percent, :decimal, default: 0
 
-      def self.description
-        Spree.t(:percent_per_item)
-      end
-
       def compute(object)
         (object.amount * preferred_percent) / 100
       end

core/app/models/spree/calculator/percent_per_item.rb

@@ -10,10 +10,6 @@ module Spree
   class Calculator::PercentPerItem < Calculator
     preference :percent, :decimal, default: 0
 
-    def self.description
-      Spree.t(:percent_per_item)
-    end
-
     def compute(object = nil)
       return 0 if object.nil?
       object.line_items.map { |line_item|

core/app/models/spree/calculator/price_sack.rb

@@ -7,10 +7,6 @@ class Calculator::PriceSack < Calculator
     preference :discount_amount, :decimal, default: 0
     preference :currency, :string, default: ->{ Spree::Config[:currency] }
 
-    def self.description
-      Spree.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)

core/app/models/spree/calculator/returns/default_refund_amount.rb

@@ -3,9 +3,6 @@
 module Spree
   module Calculator::Returns
     class DefaultRefundAmount < ReturnsCalculator
-      def self.description
-        Spree.t(:default_refund_amount)
-      end
 
       def compute(return_item)
         return 0.0.to_d if return_item.part_of_exchange?

core/app/models/spree/calculator/shipping/flat_percent_item_total.rb

@@ -5,10 +5,6 @@ module Calculator::Shipping
     class FlatPercentItemTotal < ShippingCalculator
       preference :flat_percent, :decimal, default: 0
 
-      def self.description
-        Spree.t(:flat_percent)
-      end
-
       def compute_package(package)
         compute_from_price(total(package.contents))
       end

core/app/models/spree/calculator/shipping/flat_rate.rb

@@ -6,10 +6,6 @@ class FlatRate < ShippingCalculator
       preference :amount, :decimal, default: 0
       preference :currency, :string, default: ->{ Spree::Config[:currency] }
 
-      def self.description
-        Spree.t(:shipping_flat_rate_per_order)
-      end
-
       def compute_package(_package)
         preferred_amount
       end

core/app/models/spree/calculator/shipping/flexi_rate.rb

@@ -8,10 +8,6 @@ class FlexiRate < ShippingCalculator
       preference :max_items,       :integer, default: 0
       preference :currency,        :string,  default: ->{ Spree::Config[:currency] }
 
-      def self.description
-        Spree.t(:shipping_flexible_rate)
-      end
-
       def compute_package(package)
         compute_from_quantity(package.contents.sum(&:quantity))
       end

core/app/models/spree/calculator/shipping/per_item.rb

@@ -6,10 +6,6 @@ class PerItem < ShippingCalculator
       preference :amount, :decimal, default: 0
       preference :currency, :string, default: ->{ Spree::Config[:currency] }
 
-      def self.description
-        Spree.t(:shipping_flat_rate_per_item)
-      end
-
       def compute_package(package)
         compute_from_quantity(package.contents.sum(&:quantity))
       end

core/app/models/spree/calculator/shipping/price_sack.rb

@@ -8,10 +8,6 @@ class PriceSack < ShippingCalculator
       preference :discount_amount, :decimal, default: 0
       preference :currency, :string, default: ->{ Spree::Config[:currency] }
 
-      def self.description
-        Spree.t(:shipping_price_sack)
-      end
-
       def compute_package(package)
         compute_from_price(total(package.contents))
       end

core/app/models/spree/calculator/tiered_flat_rate.rb

@@ -14,10 +14,6 @@ class Calculator::TieredFlatRate < Calculator
 
     validate :preferred_tiers_content
 
-    def self.description
-      Spree.t(:tiered_flat_rate)
-    end
-
     def compute(object)
       _base, amount = preferred_tiers.sort.reverse.detect{ |b, _| object.amount >= b }
       amount || preferred_base_amount

core/app/models/spree/calculator/tiered_percent.rb

@@ -18,10 +18,6 @@ class Calculator::TieredPercent < Calculator
     }
     validate :preferred_tiers_content
 
-    def self.description
-      Spree.t(:tiered_percent)
-    end
-
     def compute(object)
       order = object.is_a?(Order) ? object : object.order
       _base, percent = preferred_tiers.sort.reverse.detect{ |b, _| order.item_total >= b }

core/config/locales/en.yml

@@ -363,6 +363,51 @@ en:
       spree/calculator/default_tax:
         one: Default Tax
         other: Default Tax
+      spree/calculator/flat_percent_item_total:
+        one: Flat Percent
+        other: Flat Percent
+      spree/calculator/flat_rate:
+        one: Flat Rate
+        other: Flat Rate
+      spree/calculator/flexi_rate:
+        one: Flexible Rate
+        other: Flexible Rate
+      spree/calculator/free_shipping:
+        one: Free Shipping
+        other: Free Shipping
+      spree/calculator/percent_on_line_item:
+        one: Percent Per Item
+        other: Percent Per Item
+      spree/calculator/percent_per_item:
+        one: Percent Per Item
+        other: Percent Per Item
+      spree/calculator/price_sack:
+        one: Price Sack
+        other: Price Sack
+      spree/calculator/tiered_percent:
+        one: Tiered Percent
+        other: Tiered Percent
+      spree/calculator/tiered_flat_rate:
+        one: Tiered Flat Rate
+        other: Tiered Flat Rate
+      spree/calculator/returns/default_refund_amount:
+        one: Default Refund Amount
+        other: Default Refund Amount
+      spree/calculator/shipping/flat_percent_item_total:
+        one: Flat Percent
+        other: Flat Percent
+      spree/calculator/shipping/flat_rate:
+        one: Flat rate
+        other: Flat rate
+      spree/calculator/shipping/flexi_rate:
+        one: Flexible Rate per package item
+        other: Flexible Rate per package item
+      spree/calculator/shipping/per_item:
+        one: Flat rate per package item
+        other: Flat rate per package item
+      spree/calculator/shipping/price_sack:
+        one: Price sack
+        other: Price sack
       spree/country:
         one: Country
         other: Countries

core/spec/models/spree/calculator/default_tax_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'shared_examples/calculator_shared_examples'
 
 describe Spree::Calculator::DefaultTax, type: :model do
   let(:address) { create(:address) }
@@ -9,10 +10,7 @@
   let(:included_in_price) { false }
   subject(:calculator) { Spree::Calculator::DefaultTax.new(calculable: rate ) }
 
-  describe ".description" do
-    subject { described_class.description }
-    it { is_expected.to eq("Default Tax") }
-  end
+  it_behaves_like 'a calculator with a description'
 
   context "#compute" do
     context "when given an order" do

core/spec/models/spree/calculator/flat_percent_item_total_spec.rb

@@ -1,9 +1,12 @@
 require 'spec_helper'
+require 'shared_examples/calculator_shared_examples'
 
 describe Spree::Calculator::FlatPercentItemTotal, type: :model do
   let(:calculator) { Spree::Calculator::FlatPercentItemTotal.new }
   let(:line_item) { mock_model Spree::LineItem }
 
+  it_behaves_like 'a calculator with a description'
+
   before { allow(calculator).to receive_messages preferred_flat_percent: 10 }
 
   context "compute" do

core/spec/models/spree/calculator/flat_rate_spec.rb

@@ -1,8 +1,11 @@
 require 'spec_helper'
+require 'shared_examples/calculator_shared_examples'
 
 describe Spree::Calculator::FlatRate, type: :model do
   let(:calculator) { Spree::Calculator::FlatRate.new }
 
+  it_behaves_like 'a calculator with a description'
+
   let(:order) do
     mock_model(
       Spree::Order, quantity: 10, currency: "USD"

core/spec/models/spree/calculator/flexi_rate_spec.rb

@@ -1,8 +1,11 @@
 require 'spec_helper'
+require 'shared_examples/calculator_shared_examples'
 
 describe Spree::Calculator::FlexiRate, type: :model do
   let(:calculator) { Spree::Calculator::FlexiRate.new }
 
+  it_behaves_like 'a calculator with a description'
+
   let(:order) do
     mock_model(
       Spree::Order, quantity: 10

core/spec/models/spree/calculator/free_shipping_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+require 'shared_examples/calculator_shared_examples'
+
+describe Spree::Calculator::FreeShipping, type: :model do
+  it_behaves_like 'a calculator with a description'
+end

core/spec/models/spree/calculator/percent_on_line_item_spec.rb

@@ -1,15 +1,20 @@
 require 'spec_helper'
+require 'shared_examples/calculator_shared_examples'
 
 module Spree
   class Calculator
     describe PercentOnLineItem, type: :model do
-      let(:line_item) { double("LineItem", amount: 100) }
+      context "compute" do
+        let(:line_item) { double("LineItem", amount: 100) }
 
-      before { subject.preferred_percent = 15 }
+        before { subject.preferred_percent = 15 }
 
-      it "computes based on item price and quantity" do
-        expect(subject.compute(line_item)).to eq 15
+        it "computes based on item price and quantity" do
+          expect(subject.compute(line_item)).to eq 15
+        end
       end
+
+      it_behaves_like 'a calculator with a description'
     end
   end
 end

core/spec/models/spree/calculator/percent_per_item_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'shared_examples/calculator_shared_examples'
+
+module Spree
+  class Calculator
+    describe PercentPerItem, type: :model do
+      it_behaves_like 'a calculator with a description'
+    end
+  end
+end

core/spec/models/spree/calculator/price_sack_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'shared_examples/calculator_shared_examples'
 
 describe Spree::Calculator::PriceSack, type: :model do
   let(:calculator) do
@@ -9,6 +10,8 @@
     calculator
   end
 
+  it_behaves_like 'a calculator with a description'
+
   let(:order) { stub_model(Spree::Order) }
   let(:shipment) { stub_model(Spree::Shipment, amount: 10) }
 

core/spec/models/spree/calculator/refunds/default_refund_amount_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'shared_examples/calculator_shared_examples'
 
 describe Spree::Calculator::Returns::DefaultRefundAmount, type: :model do
   let(:line_item_quantity) { 2 }
@@ -9,6 +10,8 @@
   let(:calculator) { Spree::Calculator::Returns::DefaultRefundAmount.new }
   let(:order) { line_item.order }
 
+  it_behaves_like 'a calculator with a description'
+
   subject { calculator.compute(return_item) }
 
   context "not an exchange" do

core/spec/models/spree/calculator/shipping/flat_percent_item_total_spec.rb

@@ -1,11 +1,14 @@
 require 'spec_helper'
+require 'shared_examples/calculator_shared_examples'
 
 module Spree
   module Calculator::Shipping
     describe FlatPercentItemTotal, type: :model do
       let(:variant1) { build(:variant, price: 10.11) }
       let(:variant2) { build(:variant, price: 20.2222) }
 
+      it_behaves_like 'a calculator with a description'
+
       let(:line_item1) { build(:line_item, variant: variant1) }
       let(:line_item2) { build(:line_item, variant: variant2) }
 

core/spec/models/spree/calculator/shipping/flat_rate_spec.rb

@@ -1,10 +1,13 @@
 require 'spec_helper'
+require 'shared_examples/calculator_shared_examples'
 
 module Spree
   module Calculator::Shipping
     describe FlatRate, type: :model do
       subject { Calculator::Shipping::FlatRate.new(preferred_amount: 4.00) }
 
+      it_behaves_like 'a calculator with a description'
+
       it 'always returns the same rate' do
         expect(subject.compute(build(:stock_package_fulfilled))).to eql 4.00
       end

core/spec/models/spree/calculator/shipping/flexi_rate_spec.rb

@@ -1,11 +1,14 @@
 require 'spec_helper'
+require 'shared_examples/calculator_shared_examples'
 
 module Spree
   module Calculator::Shipping
     describe FlexiRate, type: :model do
       let(:variant1) { build(:variant, price: 10) }
       let(:variant2) { build(:variant, price: 20) }
 
+      it_behaves_like 'a calculator with a description'
+
       let(:package) do
         build(:stock_package, variants_contents: { variant1 => 4, variant2 => 6 })
       end