spree_shipping_matrix 0.1.0

data/lib/spree_shipping_matrix.rb

@@ -0,0 +1,2 @@
+require 'spree_core'
+require 'spree_shipping_matrix/engine'

data/spec/factories/shipping_matrix_factory.rb

@@ -0,0 +1,17 @@
+FactoryGirl.define do
+  factory :shipping_matrix, class: Spree::ShippingMatrix do
+    name 'A shipping matrix'
+
+    factory :shipping_matrix_with_rules do
+      ignore do
+        num_of_rules 1
+      end
+
+      after(:create) do |matrix, evaluator|
+        evaluator.num_of_rules.times do
+          FactoryGirl.create(:shipping_matrix_rule, matrix: matrix)
+        end
+      end
+    end
+  end
+end

data/spec/factories/shipping_matrix_rule_factory.rb

@@ -0,0 +1,8 @@
+FactoryGirl.define do
+  factory :shipping_matrix_rule, class: Spree::ShippingMatrixRule do
+    association :matrix, factory: :shipping_matrix
+    association :role
+    min_line_item_total 25
+    amount 2.99
+  end
+end

data/spec/features/shipping_matrix_calculator_spec.rb

@@ -0,0 +1,34 @@
+feature 'Shipping Matrix Calculator' do
+  before(:each) do
+    given_i_am_logged_into_the_cms
+    and_i_have_shipping_category
+    and_i_have_shipping_matrices_and_rules
+  end
+
+  scenario 'creating a shipping method using matrix calculator', js: true do
+    when_i_create_a_new_shipping_method_using_matrix_calculator
+    then_the_num_of_shipping_methods_should_be(1)
+  end
+end
+
+def and_i_have_shipping_category
+  create(:shipping_category)
+end
+
+def and_i_have_shipping_matrices_and_rules
+  create(:shipping_matrix_with_rules, num_of_rules: 3)
+end
+
+def when_i_create_a_new_shipping_method_using_matrix_calculator
+  visit spree.new_admin_shipping_method_path
+  fill_in :shipping_method_name, with: 'UK Next Day'
+  fill_in :shipping_method_admin_name, with: 'UK Next Day'
+  all('[type=checkbox]').each { |checkbox| checkbox.set(true) }
+  select2 'Shipping Matrix Calculator', from: 'Calculator'
+  click_button 'Create'
+end
+
+def then_the_num_of_shipping_methods_should_be(expected_num)
+  expect(page).to have_content('has been successfully created!')
+  expect(Spree::ShippingMethod.count).to be(expected_num)
+end

data/spec/features/shipping_matrix_checkout_spec.rb

@@ -0,0 +1,92 @@
+feature 'Shipping Matrix in checkout flow' do
+  before(:each) do
+    given_there_are_many_spree_roles
+    and_there_are_payment_methods_and_zones
+    and_there_is_1_shipping_matrix_with_num_of_rules(1)
+    and_there_is_1_shipping_method_with_matrix_calculator
+  end
+
+  [['entry', 26, '2.99'],
+   ['entry', 52, '0.00'],
+   ['vip', 26, '2.99'],
+   ['vip', 52, '0.00'],
+   ['ultra_vip', 26, '0.00'],
+   ['ultra_vip', 52, '0.00'],
+   ['press', 26, '0.00'],
+   ['press', 52, '0.00']].each do |role, order_value, price|
+    scenario "Delivery price as #{role}" do
+      given_i_am_logged_in_as_user_with(role)
+      when_i_have_reached_the_delivery_stage_of_checkout
+      and_my_basket_value_is(order_value)
+      then_i_should_see_the_delivery_price_of(price)
+    end
+
+    scenario "Cheapest shipping method for #{role}" do
+      given_i_am_logged_in_as_user_with(role)
+      when_there_is_more_than_one_shipping_method
+      and_my_basket_value_is(order_value)
+      then_i_should_see_the_cheapest_delivery_price_of(price)
+    end
+  end
+
+  scenario "Free shipping method always wins" do
+    given_i_am_logged_in
+    when_there_is_a_free_delivery_method
+    then_the_delivery_should_be_free
+  end
+end
+
+def given_there_are_many_spree_roles
+  [:entry, :vip, :ultra_vip, :press].each do |role|
+    create(:role, name: role)
+  end
+end
+
+def and_there_are_payment_methods_and_zones
+  FactoryGirl.create(:check_payment_method)
+  country = FactoryGirl.create(:country)
+  Spree::Zone.global.members << Spree::ZoneMember.create(:zoneable => country)
+  country.states << FactoryGirl.create(:state, :country => country)
+end
+
+def and_there_is_1_shipping_matrix_with_num_of_rules(num_of_rules)
+ @matrix = create(:shipping_matrix_with_rules, num_of_rules: num_of_rules)
+end
+
+def and_there_is_1_shipping_method_with_matrix_calculator
+  calc = Spree::ShippingMatrixCalculator.new(preferred_matrix_id: @matrix.id)
+  create(:shipping_method, calculator: calc)
+end
+
+def when_i_have_reached_the_delivery_stage_of_checkout
+  order = OrderWalkthrough.up_to('delivery')
+  order.update(user_id: @user.id)
+  Spree::CheckoutController.any_instance.stub(:current_order => order)
+end
+
+def and_my_basket_value_is(value)
+  Spree::LineItem.first.update(price: value)
+end
+
+def when_there_is_more_than_one_shipping_method
+  create(:shipping_method)
+  when_i_have_reached_the_delivery_stage_of_checkout
+end
+
+def when_there_is_a_free_delivery_method
+  create(:free_shipping_method)
+  when_i_have_reached_the_delivery_stage_of_checkout
+end
+
+def then_i_should_see_the_delivery_price_of(expected_delivery)
+  visit spree.checkout_state_path(:delivery)
+  expect(page).to have_content(expected_delivery)
+end
+
+def then_i_should_see_the_cheapest_delivery_price_of(expected_delivery)
+  then_i_should_see_the_delivery_price_of(expected_delivery)
+end
+
+def then_the_delivery_should_be_free
+  then_i_should_see_the_delivery_price_of('0.00')
+end

data/spec/features/shipping_matrix_spec.rb

@@ -0,0 +1,86 @@
+feature 'Shipping Matrix' do
+  before(:each) do
+    given_i_am_logged_into_the_cms
+  end
+
+  scenario 'creating shipping matrix' do
+    when_i_create_a_new_shipping_matrix
+    then_the_num_of_matrices_should_be(1)
+    and_the_num_of_rules_should_be(1)
+  end
+
+  scenario 'editing shipping matrix' do
+    given_i_have_a_shipping_matrix_with(num_of_rules: 1)
+    when_i_edit_a_shipping_matrix
+    then_i_should_see_changes_to_the_shipping_matrix
+  end
+
+  scenario 'adding rule to shipping matrix', js: true do
+    given_i_have_a_shipping_matrix_with(num_of_rules: 1)
+    when_i_add_2_rules_to_the_shipping_matrix
+    then_the_num_of_rules_should_be(3)
+  end
+
+  scenario 'removing rule from shipping matrix', js: true do
+    given_i_have_a_shipping_matrix_with(num_of_rules: 2)
+    when_i_remove_1_rule
+    then_the_num_of_rules_should_be(1)
+  end
+end
+
+def given_i_have_a_shipping_matrix_with(with)
+ @matrix = create(:shipping_matrix_with_rules, with)
+end
+
+def when_i_create_a_new_shipping_matrix
+  visit spree.new_admin_shipping_matrix_path
+  fill_in :shipping_matrix_name, with: 'UK next day'
+  fill_in :shipping_matrix_rules_attributes_0_min_line_item_total, with: '40'
+  fill_in :shipping_matrix_rules_attributes_0_amount, with: '2'
+  click_button 'Create'
+end
+
+def when_i_edit_a_shipping_matrix
+  visit spree.edit_admin_shipping_matrix_path(@matrix)
+  fill_in :shipping_matrix_name, with: 'UK next day updated'
+  fill_in :shipping_matrix_rules_attributes_0_amount, with: '4'
+  click_button 'Update'
+end
+
+def when_i_add_2_rules_to_the_shipping_matrix
+  visit spree.edit_admin_shipping_matrix_path(@matrix)
+
+  fill_in :shipping_matrix_rules_attributes_1_min_line_item_total, with: '40'
+  fill_in :shipping_matrix_rules_attributes_1_amount, with: '4'
+
+  click_link 'Add rule'
+  fill_in :shipping_matrix_rules_attributes_2_min_line_item_total, with: '20'
+  fill_in :shipping_matrix_rules_attributes_2_amount, with: '8'
+
+  click_button 'Update'
+end
+
+def when_i_remove_1_rule
+  visit spree.edit_admin_shipping_matrix_path(@matrix)
+  click_link 'Remove'
+  click_button 'Update'
+end
+
+def then_the_num_of_matrices_should_be(expected_num)
+  expect(Spree::ShippingMatrix.count).to be(expected_num)
+  expect(page).to have_content('UK next day')
+end
+
+def then_the_num_of_rules_should_be(expected_num)
+  expect(Spree::ShippingMatrixRule.count).to be(expected_num)
+end
+
+def and_the_num_of_rules_should_be(expected_num)
+  then_the_num_of_rules_should_be(expected_num)
+end
+
+def then_i_should_see_changes_to_the_shipping_matrix
+  then_the_num_of_matrices_should_be(1)
+  and_the_num_of_rules_should_be(1)
+  expect(page).to have_content('UK next day updated')
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+
+require 'rspec/rails'
+require 'database_cleaner'
+require 'ffaker'
+require 'capybara/poltergeist'
+require 'factory_girl'
+
+include(FactoryGirl)
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require f }
+
+# Requires factories and other useful helpers defined in spree_core.
+require 'spree/testing_support/authorization_helpers'
+require 'spree/testing_support/capybara_ext'
+require 'spree/testing_support/controller_requests'
+require 'spree/testing_support/factories'
+require 'spree/testing_support/url_helpers'
+require 'spree/testing_support/order_walkthrough'
+
+# Requires factories defined in lib/spree_shipping_matrix/factories.rb
+Dir[File.join(File.dirname(__FILE__), 'factories/**/*_factory.rb')].each { |f| require f }
+
+Capybara.default_selector = :css
+Capybara.javascript_driver = :poltergeist
+Capybara.register_driver :poltergeist do |app|
+  Capybara::Poltergeist::Driver.new(app, timeout: 45,
+                                         js_errors: false,
+                                         phantomjs_options: ['--load-images=no'])
+end
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  # Infer an example group's spec type from the file location.
+  config.infer_spec_type_from_file_location!
+
+  # == URL Helpers
+  #
+  # Allows access to Spree's routes in specs:
+  #
+  # visit spree.admin_path
+  # current_path.should eql(spree.products_path)
+  config.include Spree::TestingSupport::UrlHelpers
+
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+  config.color = true
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # Capybara javascript drivers require transactional fixtures set to false, and we use DatabaseCleaner
+  # to cleanup after each test instead.  Without transactional fixtures set to false the records created
+  # to setup a test will be unavailable to the browser, which runs under a separate server instance.
+  config.use_transactional_fixtures = false
+
+  # Ensure Suite is set to use transactions for speed.
+  config.before :suite do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  # Before each spec check if it is a Javascript test and switch between using database transactions or not where necessary.
+  config.before :each do
+    DatabaseCleaner.strategy = RSpec.current_example.metadata[:js] ? :truncation : :transaction
+    DatabaseCleaner.start
+  end
+
+  # After each spec clean the database.
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+
+  config.fail_fast = ENV['FAIL_FAST'] || false
+  config.order = "random"
+end

data/spec/support/user_steps.rb

@@ -0,0 +1,22 @@
+def given_i_am_logged_into_the_cms
+  @user = FactoryGirl.create(:admin_user)
+  visit spree.admin_path
+  fill_in :spree_user_email, with: @user.email
+  fill_in :spree_user_password, with: @user.password
+  click_button 'Login'
+  @user
+end
+
+def given_i_am_logged_in
+  @user = FactoryGirl.create(:user)
+  visit spree.login_path
+  fill_in :spree_user_email, with: @user.email
+  fill_in :spree_user_password, with: @user.password
+  click_button 'Login'
+  @user
+end
+
+def given_i_am_logged_in_as_user_with(role)
+  given_i_am_logged_in
+  @user.spree_roles << Spree::Role.find_by(name: role)
+end

data/spec/unit/models/shipping_matrix_calculator_spec.rb

@@ -0,0 +1,81 @@
+describe Spree::ShippingMatrixCalculator do
+  let(:variant1) { build(:variant, price: 10) }
+  let(:variant2) { build(:variant, price: 20) }
+
+  let(:role) { create(:role) }
+  let(:user) { create(:user, spree_roles: [role]) }
+
+  let (:package) { build(:stock_package, variants_contents: { variant1 => 4, variant2 => 6 }) }
+
+  before(:each) do
+    package.contents.first.inventory_unit.order.update(user: user)
+  end
+
+  context '#compute' do
+    subject { described_class.new(preferred_matrix_id: matrix.id).compute(package).to_f }
+
+    context 'when matrix has no rules' do
+      let(:matrix) { create(:shipping_matrix) }
+      it { is_expected.to eq(0.0) }
+    end
+
+    context 'when matrix has rules' do
+      let(:matrix) { create(:shipping_matrix_with_rules, num_of_rules: 5) }
+
+      let(:highest_min_line_item_total) do
+        create(:shipping_matrix_rule, min_line_item_total: 100, role: role)
+      end
+
+      let(:rule_with_matching_role) { highest_min_line_item_total }
+
+      before(:each) { matrix.rules << highest_min_line_item_total }
+
+      context 'and a rule with highest matching min line item total has amount of 4.99' do
+        before(:each) { highest_min_line_item_total.update!(amount: 4.99) }
+        it { is_expected.to eq(highest_min_line_item_total.amount.to_f) }
+      end
+
+      context 'and two rules with the same highest min line item total match' do
+        let(:another_rule) { create(:shipping_matrix_rule, min_line_item_total: 100) }
+
+        before(:each) { matrix.rules << another_rule }
+
+        context 'but only one rule#role matches and has amount of 3.99' do
+          before(:each) do
+            rule_with_matching_role.update!(amount: 3.99)
+            another_rule.update!(amount: 4.99)
+          end
+
+          it { is_expected.to eq(rule_with_matching_role.amount.to_f) }
+        end
+
+        context 'and both roles match' do
+          let(:matching_roles) { [rule_with_matching_role, another_rule] }
+
+          before(:each) do
+            rule_with_matching_role.update!(amount: 4.99)
+            another_rule.update!(role: role, amount: 3.99)
+          end
+
+          it 'should equal #amount from first matching role' do
+            is_expected.to eq(matching_roles.first.amount.to_f)
+          end
+        end
+      end
+
+      context 'and the order is a guest checkout' do
+        before(:each) do
+          package.contents.first.inventory_unit.order.update(user: nil, email: 'e@e.com')
+        end
+
+        let(:first_entry_rule) do
+          create(:shipping_matrix_rule, matrix: matrix, role: create(:role, name: 'entry'))
+        end
+
+        it 'should equal first rule matching #min_line_item_total and #role name is "entry"' do
+          is_expected.to eq(first_entry_rule.amount.to_f)
+        end
+      end
+    end
+  end
+end

data/spec/unit/models/shipping_matrix_rule_spec.rb

@@ -0,0 +1,35 @@
+describe Spree::ShippingMatrixRule do
+  context 'when created' do
+    subject { described_class.create(attrs) }
+
+    let(:attrs) { { role: create(:role),
+                    min_line_item_total: 50,
+                    amount: 2.99,
+                    matrix: create(:shipping_matrix) } }
+
+    context 'and all required parameters are provided' do
+      it { is_expected.to be_valid }
+    end
+
+    [:matrix, :role, :min_line_item_total, :amount].each do |field|
+      context "and a ##{field} is not provided" do
+        before(:each) { attrs.delete(field) }
+        it { is_expected.to be_invalid }
+      end
+    end
+
+    [:matrix, :role, :min_line_item_total, :amount].each do |field|
+      context "and a ##{field} is not provided" do
+        before(:each) { attrs.delete(field) }
+        it { is_expected.to be_invalid }
+      end
+    end
+
+    [:min_line_item_total, :amount].each do |field|
+      context "and text value provided for ##{field}" do
+        before(:each) { attrs.merge!(field => 'word') }
+        it { is_expected.to be_invalid }
+      end
+    end
+  end
+end

data/spec/unit/models/shipping_matrix_spec.rb

@@ -0,0 +1,39 @@
+describe Spree::ShippingMatrix do
+  let(:attrs) { { name: 'UK next day' } }
+  subject { described_class.create(attrs) }
+
+  context 'when created' do
+    context 'and all required attributes provided' do
+      it { is_expected.to be_valid }
+    end
+
+    context 'and no name provided' do
+      before(:each) { attrs.delete(:name) }
+      it { is_expected.to be_invalid }
+    end
+  end
+
+  context '#rules scope sorting' do
+    let(:matrix) { described_class.create(attrs) }
+
+    subject { matrix.rules }
+
+    let(:rule_with_lowest_min_line_item_total) do
+      create(:shipping_matrix_rule, matrix: matrix,
+                                    min_line_item_total: 50)
+    end
+
+    let(:rule_with_highest_min_line_item_total) do
+      create(:shipping_matrix_rule, matrix: matrix,
+                                    min_line_item_total: 100)
+    end
+
+    before(:each) do
+      rule_with_lowest_min_line_item_total
+      rule_with_highest_min_line_item_total
+    end
+
+    it { is_expected.to start_with(rule_with_highest_min_line_item_total) }
+    it { is_expected.to end_with(rule_with_lowest_min_line_item_total) }
+  end
+end

data/spree_shipping_matrix.gemspec

@@ -0,0 +1,42 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spree_shipping_matrix/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'spree_shipping_matrix'
+  s.version     = SpreeShippingMatrix::VERSION
+
+  s.summary     = 'Advanced shipping calculator based on rules matrix for Spree'
+  s.description = ''
+
+  s.homepage  = 'https://github.com/madebymade/spree_shipping_matrix'
+
+  s.authors = ['Luke Morton']
+  s.email   = ['luke@madebymade.co.uk']
+
+  s.license = 'MIT'
+
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.platform    = Gem::Platform::RUBY
+
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_dependency 'spree_core', '2.4.0.beta'
+
+  s.add_development_dependency 'capybara', '~> 2.1'
+  s.add_development_dependency 'coffee-rails'
+  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'factory_girl', '~> 4.4'
+  s.add_development_dependency 'ffaker'
+  s.add_development_dependency 'rspec-rails',  '~> 2.13'
+  s.add_development_dependency 'sass-rails', '~> 4.0.2'
+  s.add_development_dependency 'poltergeist'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'tailor'
+  s.add_development_dependency 'codeclimate-test-reporter'
+end