solidus_volume_pricing 0.1.0

data/spec/models/spree/order_spec.rb

@@ -0,0 +1,49 @@
+RSpec.describe Spree::Order, type: :model do
+  before do
+    @order = create(:order)
+    @variant = create(:variant, price: 10)
+
+    @variant_with_prices = create(:variant, price: 10)
+    @variant_with_prices.volume_prices << create(:volume_price, range: '1..5', amount: 9, position: 2)
+    @variant_with_prices.volume_prices << create(:volume_price, range: '(5..9)', amount: 8, position: 1)
+  end
+
+  context 'add_variant' do
+    it 'uses the variant price if there are no volume prices' do
+      @order.contents.add(@variant)
+      expect(@order.line_items.first.price).to eq(10)
+    end
+
+    it 'uses the volume price if quantity falls within a quantity range of a volume price' do
+      @variant.volume_prices << create(:volume_price, range: '(5..10)', amount: 9)
+      @order.contents.add(@variant_with_prices, 7)
+      expect(@order.line_items.first.price).to eq(8)
+    end
+
+    it 'uses the variant price if the quantity fails to satisfy any of the volume price ranges' do
+      @order.contents.add(@variant, 10)
+      expect(@order.line_items.first.price).to eq(10)
+    end
+
+    it 'uses the first matching volume price in the event of more then one matching volume prices' do
+      @order.contents.add(@variant_with_prices, 5)
+      expect(@order.line_items.first.price).to eq(8)
+    end
+
+    it 'uses the master variant volume price in case variant has no volume price if config is true' do
+      Spree::Config.use_master_variant_volume_pricing = true
+      @master = @variant.product.master
+      @master.volume_prices << create(:volume_price, range: '(1..5)', amount: 9, position: 2)
+      @order.contents.add(@variant, 5)
+      expect(@order.line_items.first.price).to eq(9)
+    end
+
+    it 'doesnt use the master variant volume price in case variant has no volume price if config is false' do
+      Spree::Config.use_master_variant_volume_pricing = false
+      @master = @variant.product.master
+      @master.volume_prices << create(:volume_price, range: '(1..5)', amount: 9, position: 2)
+      @order.contents.add(@variant, 5)
+      expect(@order.line_items.first.price).to eq(10)
+    end
+  end
+end

data/spec/models/spree/variant_spec.rb

@@ -0,0 +1,306 @@
+RSpec.describe Spree::Variant, type: :model do
+  it { is_expected.to have_many(:volume_prices) }
+
+  describe '#volume_price' do
+
+    context 'discount_type = price' do
+      before :each do
+        @variant = create :variant, price: 10
+        @variant.volume_prices.create! amount: 9, discount_type: 'price', range: '(10+)'
+        @role = create(:role)
+        @user = create(:user)
+      end
+
+      it 'uses the variants price when it does not match a range' do
+        expect(@variant.volume_price(1).to_f).to be(10.00)
+      end
+
+      it 'uses the variants price when it does not match role with null role' do
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price(10).to_f).to be(10.00)
+      end
+
+      it 'uses the variants price when it does not match roles' do
+        other_role = create(:role)
+        @user.spree_roles << other_role
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price(10, @user).to_f).to be(10.00)
+      end
+
+      it 'uses the volume price when it does match a range' do
+        expect(@variant.volume_price(10).to_f).to be(9.00)
+      end
+
+      it 'uses the volume price when it does match a range and role' do
+        @user.spree_roles << @role
+        Spree::Config.volume_pricing_role = @role.name
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price(10, @user).to_f).to be(9.00)
+      end
+
+      it 'uses the volume price when it does match from a volume price model' do
+        @variant.volume_price_models << create(:volume_price_model)
+        @variant.volume_price_models.first.volume_prices.create!(amount: 5, discount_type: 'price', range: '(5+)')
+        expect(@variant.volume_price(6).to_f).to be(5.00)
+      end
+
+      it 'gives percent of earning without role' do
+        expect(@variant.volume_price_earning_percent(10)).to be(10)
+      end
+
+      it 'gives percent of earning if role matches' do
+        @user.spree_roles << @role
+        Spree::Config.volume_pricing_role = @role.name
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price_earning_percent(10, @user)).to be(10)
+      end
+
+      it 'gives zero percent earning if doesnt match' do
+        expect(@variant.volume_price_earning_percent(1)).to be(0)
+      end
+
+      it 'gives zero percent earning if role doesnt match with null' do
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price_earning_percent(10)).to be(0)
+      end
+
+      it 'gives zero percent earning if role doesnt match' do
+        other_role = create(:role)
+        @user.spree_roles << other_role
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price_earning_percent(10, @user)).to be(0)
+      end
+
+      it 'gives amount earning without role' do
+        expect(@variant.volume_price_earning_amount(10)).to eq(1)
+      end
+
+      it 'gives amount earning if role matches' do
+        @user.spree_roles << @role
+        Spree::Config.volume_pricing_role = @role.name
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price_earning_amount(10, @user)).to eq(1)
+      end
+
+      it 'gives zero earning amount if doesnt match' do
+        expect(@variant.volume_price_earning_amount(1)).to eq(0)
+      end
+
+      it 'gives zero earning amount if role doesnt match with null' do
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price_earning_amount(10)).to be(0)
+      end
+
+      it 'gives zero earning amount if role doesnt match' do
+        other_role = create(:role)
+        @user.spree_roles << other_role
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price_earning_amount(10, @user)).to be(0)
+      end
+    end
+
+    context 'discount_type = dollar' do
+      before :each do
+        @variant = create :variant, price: 10
+        @variant.volume_prices.create! amount: 1, discount_type: 'dollar', range: '(10+)'
+        @role = create(:role)
+        @user = create(:user)
+      end
+
+      it 'uses the variants price when it does not match a range' do
+        expect(@variant.volume_price(1).to_f).to be(10.00)
+      end
+
+      it 'uses the variants price when it does not match role with null role' do
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price(10).to_f).to be(10.00)
+      end
+
+      it 'uses the variants price when it does not match roles' do
+        other_role = create(:role)
+        @user.spree_roles << other_role
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price(10, @user).to_f).to be(10.00)
+      end
+
+      it 'uses the volume price when it does match a range' do
+        expect(@variant.volume_price(10).to_f).to be(9.00)
+      end
+
+      it 'uses the volume price when it does match a range and role' do
+        @user.spree_roles << @role
+        Spree::Config.volume_pricing_role = @role.name
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price(10, @user).to_f).to be(9.00)
+      end
+
+      it 'uses the volume price when it does match from a volume price model' do
+        @variant.volume_price_models << create(:volume_price_model)
+        @variant.volume_price_models.first.volume_prices.create!(amount: 5, discount_type: 'dollar', range: '(5+)')
+        expect(@variant.volume_price(6).to_f).to be(5.00)
+      end
+
+      it 'gives percent of earning without role' do
+        expect(@variant.volume_price_earning_percent(10)).to be(10)
+      end
+
+      it 'gives percent of earning if role matches' do
+        @user.spree_roles << @role
+        Spree::Config.volume_pricing_role = @role.name
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price_earning_percent(10, @user)).to be(10)
+      end
+
+      it 'gives zero percent earning if doesnt match' do
+        expect(@variant.volume_price_earning_percent(1)).to be(0)
+      end
+
+      it 'gives zero percent earning if role doesnt match with null' do
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price_earning_percent(10)).to be(0)
+      end
+
+      it 'gives zero percent earning if role doesnt match' do
+        other_role = create(:role)
+        @user.spree_roles << other_role
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price_earning_percent(10, @user)).to be(0)
+      end
+
+      it 'gives amount earning without role' do
+        expect(@variant.volume_price_earning_amount(10)).to eq(1)
+      end
+
+      it 'gives amount earning if role matches' do
+        @user.spree_roles << @role
+        Spree::Config.volume_pricing_role = @role.name
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price_earning_amount(10, @user)).to eq(1)
+      end
+
+      it 'gives zero earning amount if doesnt match' do
+        expect(@variant.volume_price_earning_amount(1)).to eq(0)
+      end
+
+      it 'gives zero earning amount if role doesnt match with null' do
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price_earning_amount(10)).to be(0)
+      end
+
+      it 'gives zero earning amount if role doesnt match' do
+        other_role = create(:role)
+        @user.spree_roles << other_role
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price_earning_amount(10, @user)).to be(0)
+      end
+    end
+
+    context 'discount_type = percent' do
+      before :each do
+        @variant = create :variant, price: 10
+        @variant.volume_prices.create! amount: 0.1, discount_type: 'percent', range: '(10+)'
+        @role = create(:role)
+        @user = create(:user)
+      end
+
+      it 'uses the variants price when it does not match a range' do
+        expect(@variant.volume_price(1).to_f).to be(10.00)
+      end
+
+      it 'uses the variants price when it does not match role with null role' do
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price(10).to_f).to be(10.00)
+      end
+
+      it 'uses the variants price when it does not match roles' do
+        other_role = create(:role)
+        @user.spree_roles << other_role
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price(10, @user).to_f).to be(10.00)
+      end
+
+      it 'uses the volume price when it does match a range' do
+        expect(@variant.volume_price(10).to_f).to be(9.00)
+      end
+
+      it 'uses the volume price when it does match a range and role' do
+        @user.spree_roles << @role
+        Spree::Config.volume_pricing_role = @role.name
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price(10, @user).to_f).to be(9.00)
+      end
+
+      it 'gives percent of earning without roles' do
+        expect(@variant.volume_price_earning_percent(10)).to be(10)
+        @variant_five = create :variant, price: 10
+        @variant_five.volume_prices.create! amount: 0.5, discount_type: 'percent', range: '(1+)'
+        expect(@variant_five.volume_price_earning_percent(1)).to be(50)
+      end
+
+      it 'gives amount earning if role matches' do
+        @user.spree_roles << @role
+        Spree::Config.volume_pricing_role = @role.name
+        expect(@variant.volume_price_earning_percent(10)).to be(10)
+        @variant_five = create :variant, price: 10
+        @variant_five.volume_prices.create! amount: 0.5, discount_type: 'percent', range: '(1+)'
+        @variant_five.volume_prices.first.update(role_id: @role.id)
+        expect(@variant_five.volume_price_earning_percent(1, @user)).to be(50)
+      end
+
+      it 'gives zero percent earning if doesnt match' do
+        expect(@variant.volume_price_earning_percent(1)).to be(0)
+      end
+
+      it 'gives zero percent earning if role doesnt match with null' do
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price_earning_percent(10)).to be(0)
+      end
+
+      it 'gives zero percent earning if role doesnt match' do
+        other_role = create(:role)
+        @user.spree_roles << other_role
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price_earning_percent(10, @user)).to be(0)
+      end
+
+      it 'gives amount earning without roles' do
+        expect(@variant.volume_price_earning_amount(10)).to eq(1)
+        @variant_five = create :variant, price: 10
+        @variant_five.volume_prices.create! amount: 0.5, discount_type: 'percent', range: '(1+)'
+        expect(@variant_five.volume_price_earning_amount(1)).to eq(5)
+      end
+
+      it 'gives amount earning if role matches' do
+        @user.spree_roles << @role
+        Spree::Config.volume_pricing_role = @role.name
+        expect(@variant.volume_price_earning_amount(10)).to eq(1)
+        @variant_five = create :variant, price: 10
+        @variant_five.volume_prices.create! amount: 0.5, discount_type: 'percent', range: '(1+)'
+        @variant_five.volume_prices.first.update(role_id: @role.id)
+        expect(@variant_five.volume_price_earning_amount(1, @user)).to eq(5)
+      end
+
+      it 'uses the volume price when it does match from a volume price model' do
+        @variant.volume_price_models << create(:volume_price_model)
+        @variant.volume_price_models.first.volume_prices.create!(amount: 0.5, discount_type: 'percent', range: '(5+)')
+        expect(@variant.volume_price(6).to_f).to be(5.00)
+      end
+
+      it 'gives zero earning amount if doesnt match' do
+        expect(@variant.volume_price_earning_amount(1)).to eq(0)
+      end
+
+      it 'gives zero earning amount if role doesnt match with null' do
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price_earning_amount(10)).to be(0)
+      end
+
+      it 'gives zero earning amount if role doesnt match' do
+        other_role = create(:role)
+        @user.spree_roles << other_role
+        @variant.volume_prices.first.update(role_id: @role.id)
+        expect(@variant.volume_price_earning_amount(10, @user)).to be(0)
+      end
+    end
+  end
+end

data/spec/models/spree/volume_price_spec.rb

@@ -0,0 +1,121 @@
+RSpec.describe Spree::VolumePrice, type: :model do
+  it { is_expected.to belong_to(:variant).touch(true) }
+  it { is_expected.to belong_to(:volume_price_model).touch(true) }
+  it { is_expected.to belong_to(:spree_role).class_name('Spree::Role').with_foreign_key('role_id') }
+  it { is_expected.to validate_presence_of(:discount_type) }
+  it { is_expected.to validate_inclusion_of(:discount_type).in_array(%w(price dollar percent)) }
+  it { is_expected.to validate_presence_of(:amount) }
+
+  before do
+    @volume_price = Spree::VolumePrice.new(variant: Spree::Variant.new, amount: 10, discount_type: 'price')
+  end
+
+  ['1..2', '(1..2)'].each do |range|
+    it "does not interepret a Ruby range of #{range} as being opend ended" do
+      @volume_price.range = range
+      expect(@volume_price).not_to be_open_ended
+    end
+  end
+
+  ['50+', '(50+)'].each do |range|
+    it "properly interpret an open ended range of #{range}" do
+      @volume_price.range = range
+      expect(@volume_price).to be_open_ended
+    end
+  end
+
+  describe 'valid range format' do
+    it 'requires the presence of a variant' do
+      @volume_price.variant = nil
+      expect(@volume_price).not_to be_valid
+    end
+
+    it 'consider a range of (1..2) to be valid' do
+      @volume_price.range = '(1..2)'
+      expect(@volume_price).to be_valid
+    end
+
+    it 'consider a range of (1...2) to be valid' do
+      @volume_price.range = '(1...2)'
+      expect(@volume_price).to be_valid
+    end
+
+    it 'consider a range of 1..2 to be valid' do
+      @volume_price.range = '1..2'
+      expect(@volume_price).to be_valid
+    end
+
+    it 'consider a range of 1...2 to be valid' do
+      @volume_price.range = '1...2'
+      expect(@volume_price).to be_valid
+    end
+
+    it 'consider a range of (10+) to be valid' do
+      @volume_price.range = '(10+)'
+      expect(@volume_price).to be_valid
+    end
+
+    it 'consider a range of 10+ to be valid' do
+      @volume_price.range = '10+'
+      expect(@volume_price).to be_valid
+    end
+
+    it 'does not consider a range of 1-2 to valid' do
+      @volume_price.range = '1-2'
+      expect(@volume_price).not_to be_valid
+    end
+
+    it 'does not consider a range of 1 to valid' do
+      @volume_price.range = '1'
+      expect(@volume_price).not_to be_valid
+    end
+
+    it 'does not consider a range of foo to valid' do
+      @volume_price.range = 'foo'
+      expect(@volume_price).not_to be_valid
+    end
+  end
+
+  describe 'include?' do
+    ['10..20', '(10..20)'].each do |range|
+      it "does not match a quantity that fails to fall within the specified range of #{range}" do
+        @volume_price.range = range
+        expect(@volume_price).not_to include(21)
+      end
+
+      it "matches a quantity that is within the specified range of #{range}" do
+        @volume_price.range = range
+        expect(@volume_price).to include(12)
+      end
+
+      it 'matches the upper bound of ranges that include the upper bound' do
+        @volume_price.range = range
+        expect(@volume_price).to include(20)
+      end
+    end
+
+    ['10...20', '(10...20)'].each do |range|
+      it 'does not match the upper bound for ranges that exclude the upper bound' do
+        @volume_price.range = range
+        expect(@volume_price).not_to include(20)
+      end
+    end
+
+    ['50+', '(50+)'].each do |range|
+      it "matches a quantity that exceeds the value of an open ended range of #{range}" do
+        @volume_price.range = range
+        expect(@volume_price).to include(51)
+      end
+
+      it "matches a quantity that equals the value of an open ended range of #{range}" do
+        @volume_price.range = range
+        expect(@volume_price).to include(50)
+      end
+
+      it "does not match a quantity that is less then the value of an open ended range of #{range}" do
+        @volume_price.range = range
+        expect(@volume_price).not_to include(40)
+      end
+    end
+  end
+end