spree_shipping_matrix 0.1.0

data/.gitignore

@@ -0,0 +1,14 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.tailor

@@ -0,0 +1,29 @@
+Tailor.config do |config|
+  config.formatters "text"
+  config.file_set '{app,spec/{factories,unit}}/**/*.rb' do |style|
+    style.allow_camel_case_methods false, level: :error
+    style.allow_conditional_parentheses false, level: :warn
+    style.allow_hard_tabs false, level: :error
+    style.allow_screaming_snake_case_classes false, level: :error
+    style.allow_trailing_line_spaces false, level: :error
+    style.allow_unnecessary_interpolation false, level: :warn
+    style.allow_unnecessary_double_quotes false, level: :warn
+    style.allow_invalid_ruby false, level: :warn
+    style.indentation_spaces 2, level: :off
+    style.max_code_lines_in_class 300, level: :error
+    style.max_code_lines_in_method 30, level: :error
+    style.max_line_length 130, level: :error
+    style.spaces_after_comma 1, level: :error
+    style.spaces_after_conditional 1, level: :error
+    style.spaces_after_lbrace 1, level: :error
+    style.spaces_after_lbracket 0, level: :error
+    style.spaces_after_lparen 0, level: :error
+    style.spaces_before_comma 0, level: :error
+    style.spaces_before_lbrace 1, level: :error
+    style.spaces_before_rbrace 1, level: :error
+    style.spaces_before_rbracket 0, level: :error
+    style.spaces_before_rparen 0, level: :error
+    style.spaces_in_empty_braces 0, level: :error
+    style.trailing_newlines 1, level: :error
+  end
+end

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+before_install:
+  - "export DISPLAY=:99.0"
+  - "export CODECLIMATE_REPO_TOKEN=f965fda6d493fe7c6d3e3358a9ea39f2b6bad21bf837fc2c2e41a2aaa3bf4cd2 "
+  - "sh -e /etc/init.d/xvfb start"
+before_script:
+  - "bundle exec rake test_app"
+script:
+  - "bundle exec rake"
+notifications:
+  email:
+    - luke@madetech.co.uk
+    - seb@madetech.co.uk
+branches:
+  only:
+    - master

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'spree', github: 'spree/spree', branch: 'master'
+# Provides basic authentication functionality for testing parts of your engine
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: 'master'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Made Tech Ltd
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# SpreeShippingMatrix
+
+Advanced shipping calculator based on rules matrix for Spree.
+
+[![Code Climate](https://codeclimate.com/github/madebymade/spree_shipping_matrix/badges/gpa.svg)](https://codeclimate.com/github/madebymade/spree_shipping_matrix)
+[![Build Status](https://travis-ci.org/madebymade/spree_shipping_matrix.svg?branch=master)](https://travis-ci.org/madebymade/spree_shipping_matrix)
+[![Brakeman](http://rails-brakeman.com/madebymade/spree_shipping_matrix.png)](http://rails-brakeman.com/madebymade/spree_shipping_matrix)
+[![Test Coverage](https://codeclimate.com/github/madebymade/spree_shipping_matrix/badges/coverage.svg)](https://codeclimate.com/github/madebymade/spree_shipping_matrix)
+
+## Installation
+
+Add spree_shipping_matrix to your Gemfile:
+
+```ruby
+gem 'spree_shipping_matrix'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g spree_shipping_matrix:install
+```
+
+## Testing
+
+First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using `rake test_app`.
+
+```shell
+bundle
+bundle exec rake
+```
+
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'spree_shipping_matrix/factories'
+```
+
+## Credits
+
+[![made](https://s3-eu-west-1.amazonaws.com/made-assets/googleapps/google-apps.png)][made]
+
+Developed and maintained by [Made Tech][made]. Key contributions:
+
+ * [Seb Ashton](https://github.com/SebAshton)
+ * [Luke Morton](https://github.com/DrPheltRight)
+
+## License
+
+Copyright © 2014 Made Tech Ltd. It is free software, and may be
+redistributed under the terms specified in the [MIT-LICENSE][license] file.
+
+[made]: http://www.madetech.co.uk?ref=github&repo=spree_shipping_matrix
+[license]: https://github.com/madebymade/cf-deploy/blob/master/LICENSE

data/Rakefile

@@ -0,0 +1,28 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir["spec/dummy"].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir("../../")
+  end
+  Rake::Task[:tailor].invoke
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_shipping_matrix'
+  Rake::Task['extension:test_app'].invoke
+end
+
+begin
+  require 'tailor/rake_task'
+  Tailor::RakeTask.new
+rescue LoadError
+end

data/Versionfile

@@ -0,0 +1 @@
+'2.4.x'  => { :branch => 'master' }

data/app/assets/javascripts/spree/backend/spree_shipping_matrix.js

@@ -0,0 +1,42 @@
+//= require spree/backend
+
+$(document).on('click', '.js-remove-row', function () {
+  var $removeLink = $(this);
+  var $row = $removeLink.closest('.row');
+  var destroyName = $removeLink.data('row-object-name') + '[_destroy]';
+  $row.replaceWith(
+    '<input type="hidden" name="' + destroyName + '" value="1" />');
+  return false;
+});
+
+$(document).on('click', '.js-duplicate-last-row', function () {
+  var $duplicateLink = $(this);
+  var $row = $duplicateLink.prev();
+  var reRowId = /\[([0-9]+)\]/;
+  var rowId = parseInt(reRowId.exec($row.find('[name]:first').attr('name'))[1], 10);
+  var newRowId = rowId + 1;
+  var $duplicateRow = $row.clone();
+
+  $duplicateRow.find('[for]').each(function () {
+    var labelFor = $(this).attr('for');
+    $(this).attr('for', labelFor.replace('_' + rowId + '_', '_' + newRowId + '_'));
+  });
+
+  $duplicateRow.find('[name]').each(function () {
+    var name = $(this).attr('name');
+    var id = $(this).attr('id');
+    $(this).attr('id', id.replace('_' + rowId + '_', '_' + newRowId + '_'));
+    $(this).attr('name', name.replace(reRowId, '[' + newRowId + ']'));
+  });
+
+  $duplicateRow.find('.select2-container').remove();
+
+  $duplicateLink.before($duplicateRow);
+
+  $('select.select2').select2({
+    allowClear: true,
+    dropdownAutoWidth: true
+  });
+
+  return false;
+});

data/app/assets/javascripts/spree/frontend/spree_shipping_matrix.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/frontend/all.js'

data/app/assets/stylesheets/spree/backend/spree_shipping_matrix.css

@@ -0,0 +1,3 @@
+/**
+ *= require spree/backend
+ */

data/app/assets/stylesheets/spree/frontend/spree_shipping_matrix.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/frontend/all.css'
+*/

data/app/controllers/spree/admin/shipping_matrices_controller.rb

@@ -0,0 +1,13 @@
+module Spree
+  module Admin
+    class ShippingMatricesController < ResourceController
+      def new
+        @shipping_matrix.rules.build
+      end
+
+      def edit
+        @shipping_matrix.rules.build
+      end
+    end
+  end
+end

data/app/helpers/spree/admin/base_helper_decorator.rb

@@ -0,0 +1,9 @@
+Spree::Admin::BaseHelper.module_eval do
+  def preference_field_for(form, field, options)
+    if options[:type] == :matrix_id
+      form.matrix_field(field, preference_field_options(options))
+    else
+      super
+    end
+  end
+end

data/app/helpers/spree/admin/form_builder_decorator.rb

@@ -0,0 +1,9 @@
+ActionView::Helpers::FormBuilder.class_eval do
+  def matrix_field(method, options)
+    collection_select(method,
+                      Spree::ShippingMatrix.all,
+                      :id, :name,
+                      options,
+                      class: 'select2 fullwidth')
+  end
+end

data/app/models/spree/shipping_matrix.rb

@@ -0,0 +1,18 @@
+module Spree
+  class ShippingMatrix < ActiveRecord::Base
+    has_many :rules, ->{ order('min_line_item_total DESC') },
+                     class_name: Spree::ShippingMatrixRule,
+                     inverse_of: :matrix
+
+    accepts_nested_attributes_for :rules, allow_destroy: true,
+                                          reject_if: :rule_blank?
+
+    validates :name, presence: true
+
+    private
+
+    def rule_blank?(attributes)
+      attributes['min_line_item_total'].blank? || attributes['amount'].blank?
+    end
+  end
+end

data/app/models/spree/shipping_matrix_calculator.rb

@@ -0,0 +1,40 @@
+module Spree
+  class ShippingMatrixCalculator < Spree::ShippingCalculator
+    preference :matrix_id, :matrix_id
+
+    def self.description
+      'Shipping Matrix Calculator'
+    end
+
+    def compute_package(package)
+      matched_amount(user: package.contents.first.inventory_unit.order.user,
+                     line_item_total: total(package.contents))
+    end
+
+    private
+
+    def matched_amount(info)
+      matched = matched_rule(info)
+
+      if matched.nil?
+        0
+      else
+        matched.amount
+      end
+    end
+
+    def matched_rule(info)
+      matched = matrix.rules.find { |rule| rule.matches?(info) }
+
+      if matched.nil?
+        matrix.rules.last
+      else
+        matched
+      end
+    end
+
+    def matrix
+      @matrix ||= Spree::ShippingMatrix.find(preferred_matrix_id)
+    end
+  end
+end

data/app/models/spree/shipping_matrix_rule.rb

@@ -0,0 +1,39 @@
+module Spree
+  class ShippingMatrixRule < ActiveRecord::Base
+    belongs_to :matrix, class_name: Spree::ShippingMatrix,
+                        foreign_key: 'shipping_matrix_id'
+
+    belongs_to :role, class_name: Spree::Role
+
+    validates :matrix, presence: true
+    validates :role, presence: true
+
+    validates :min_line_item_total, presence: true,
+                                    numericality: true
+
+    validates :amount, presence: true,
+                       numericality: true
+
+    def matches?(info)
+      matches_role?(info) && matches_line_item_total?(info)
+    end
+
+    private
+
+    def matches_role?(info)
+      if info[:user].nil?
+        role.name == 'entry'
+      else
+        matches_user_role?(info)
+      end
+    end
+
+    def matches_user_role?(info)
+      info[:user].spree_roles.include?(role)
+    end
+
+    def matches_line_item_total?(info)
+      info[:line_item_total] > min_line_item_total
+    end
+  end
+end

data/app/overrides/spree/admin/shared/_configuration_menu/add_shipping_matrix_link.html.erb.deface

@@ -0,0 +1,2 @@
+<!-- insert_bottom '[data-hook="admin_configurations_sidebar_menu"]' -->
+<%= configurations_sidebar_menu_item Spree.t(:title, scope: :shipping_matrix), spree.admin_shipping_matrices_path %>

data/app/views/spree/admin/shipping_matrices/_form.html.erb

@@ -0,0 +1,18 @@
+<%= f.field_container :name, class: ['row'] do %>
+  <%= f.label :name, Spree.t(:name, scope: :shipping_matrix) %>
+  <span class="required">*</span><br />
+  <%= f.text_field :name, class: ['fullwidth'] %>
+  <%= f.error_message_on :name %>
+<% end %>
+
+<div class="js-shipping-matrix-rules">
+  <%= f.fields_for :rules do |f| %>
+    <%= render partial: 'spree/admin/shipping_matrix_rules/form',
+               locals: { f: f } %>
+  <% end %>
+
+  <%= link_to Spree.t(:add_rule, scope: :shipping_matrix),
+              '#new-rule',
+              class: 'js-duplicate-last-row' %>
+</div>
+

data/app/views/spree/admin/shipping_matrices/edit.html.erb

@@ -0,0 +1,25 @@
+<%= render partial: 'spree/admin/shared/configuration_menu' %>
+
+<% content_for :page_title do %>
+  <%= Spree.t(:editting, scope: :shipping_matrix) %>
+  <span class="green">"<%= @shipping_matrix.name %>"</span>
+<% end %>
+
+<% content_for :page_actions do %>
+  <li>
+    <%= button_link_to Spree.t(:back, scope: :shipping_matrix),
+                       spree.admin_shipping_matrices_path,
+                       icon: 'arrow-left' %>
+  </li>
+<% end %>
+
+<%= render partial: 'spree/shared/error_messages',
+           locals: { target: @shipping_matrix } %>
+
+<%= form_for [:admin, @shipping_matrix] do |f| %>
+  <fieldset>
+    <legend align="center"><%= Spree.t(:editting, scope: :shipping_matrix) %></legend>
+    <%= render :partial => 'form', :locals => { :f => f } %>
+    <%= render :partial => 'spree/admin/shared/edit_resource_links' %>
+  </fieldset>
+<% end %>

data/app/views/spree/admin/shipping_matrices/index.html.erb

@@ -0,0 +1,63 @@
+<%= render :partial => 'spree/admin/shared/configuration_menu' %>
+
+<% content_for :page_title do %>
+  <%= Spree.t(:title, scope: :shipping_matrix) %>
+<% end %>
+
+<% content_for :page_actions do %>
+  <li id="new_er_link">
+    <%= button_link_to Spree.t(:new, scope: :shipping_matrix),
+                       new_admin_shipping_matrix_url,
+                       remote: true,
+                       icon: 'plus' %>
+  </li>
+<% end %>
+
+<div class="js-new-shipping-matrix"></div>
+
+<% if @shipping_matrices.any? %>
+<table
+  class="index sortable"
+  id="list_shipping_matrices"
+  data-hook
+  data-sortable-link="<%= update_positions_admin_option_types_url %>"
+  >
+  <colgroup>
+    <col style="width: 35%">
+    <col style="width: 25%">
+    <col style="width: 25%">
+    <col style="width: 15%">
+  </colgroup>
+  <thead>
+    <tr data-hook="option_header">
+      <th><%= Spree.t(:name, scope: :shipping_matrix) %></th>
+      <th class="actions"></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @shipping_matrices.each do |shipping_matrix| %>
+      <tr
+        class="spree_shipping_matrix <%= cycle('odd', 'even')%>"
+        id="<%= spree_dom_id shipping_matrix %>"
+        data-hook="shipping_matrix_row"
+        >
+        <td class="align-center"><%= shipping_matrix.name %></td>
+        <td class="actions">
+          <%= link_to_edit(shipping_matrix,
+                           class: 'admin_edit_shipping_matrix',
+                           no_text: true) %>
+          <%= link_to_delete(shipping_matrix, no_text: true) %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+<% else %>
+  <div class="alpha twelve columns no-objects-found">
+    <%= Spree.t(:no_resource_found, resource: Spree.t(:title, scope: :shipping_matrix)) %>,
+
+    <%= link_to Spree.t(:add_one),
+                spree.new_admin_shipping_matrix_path,
+                remote: true %>!
+  </div>
+<% end %>

data/app/views/spree/admin/shipping_matrices/new.html.erb

@@ -0,0 +1,11 @@
+<%= render partial: 'spree/shared/error_messages',
+           locals: { target: @shipping_matrix } %>
+
+<%= form_for [:admin, @shipping_matrix] do |f| %>
+  <fieldset>
+    <legend align="center"><%= Spree.t(:new, scope: :shipping_matrix) %></legend>
+    <%= render partial: 'form', locals: { f: f } %>
+
+    <%= render partial: 'spree/admin/shared/new_resource_links' %>
+  </fieldset>
+<% end %>

data/app/views/spree/admin/shipping_matrices/new.js.erb

@@ -0,0 +1,6 @@
+$('.js-new-shipping-matrix').html('<%= escape_javascript(render template: "spree/admin/shipping_matrices/new", formats: [:html], handlers: [:erb]) %>');
+$('a[href$="<%= spree.new_admin_shipping_matrix_path %>"]').parent().hide();
+$('select.select2').select2({
+  allowClear: true,
+  dropdownAutoWidth: true
+});

data/app/views/spree/admin/shipping_matrix_rules/_form.html.erb

@@ -0,0 +1,33 @@
+<div class="row">
+  <div class="alpha four columns">
+    <%= f.label(:role) %>
+    <%= f.collection_select(:role_id,
+                            Spree::Role.all,
+                            :id, :name, {},
+                            {class: 'select2 fullwidth'}) %>
+  </div>
+
+  <div class="four columns">
+    <%= f.label(:min_line_item_total) %>
+    <%= f.number_field(:min_line_item_total,
+                       value: number_with_precision(f.object.min_line_item_total,
+                                                    precision: 2)) %>
+  </div>
+
+  <div class="omega four columns">
+    <%= f.label(:amount) %>
+    <%= f.number_field(:amount,
+                       value: number_with_precision(f.object.amount,
+                                                    precision: 2)) %>
+
+    <% if f.object.persisted? %>
+      <a
+        href="#remove-<%= f.object.id %>"
+        class="js-remove-row"
+        data-row-object-name="<%= f.object_name %>"
+        >
+        <%= Spree.t(:remove) %>
+      </a>
+    <% end %>
+  </div>
+</div>

data/bin/rails

@@ -0,0 +1,7 @@
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_shipping_matrix/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/en.yml

@@ -0,0 +1,13 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  spree:
+    shipping_matrix:
+      new: 'New Shipping Matrix'
+      name: 'Name'
+      title: 'Shipping Matrices'
+      editting: 'Edit Shipping Matrix'
+      back: 'Back to Shipping Matrices'
+      add_rule: 'Add rule'
+    matrix_id: 'Shipping Matrix'

data/config/routes.rb

@@ -0,0 +1,5 @@
+Spree::Core::Engine.routes.draw do
+  namespace :admin do
+    resources :shipping_matrices
+  end
+end

data/db/migrate/20140826110342_create_spree_shipping_matrices.rb

@@ -0,0 +1,8 @@
+class CreateSpreeShippingMatrices < ActiveRecord::Migration
+  def change
+    create_table :spree_shipping_matrices do |t|
+      t.string :name
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140826112807_create_spree_shipping_matrix_rules.rb

@@ -0,0 +1,10 @@
+class CreateSpreeShippingMatrixRules < ActiveRecord::Migration
+  def change
+    create_table :spree_shipping_matrix_rules do |t|
+      t.references :shipping_matrix, index: true
+      t.references :role, index: true
+      t.decimal :min_line_item_total, precision: 5, scale: 2, null: false
+      t.decimal :amount, precision: 5, scale: 2, null: false
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module SpreeShippingMatrix
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, :type => :boolean, :default => false
+
+      def add_javascripts
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/spree_shipping_matrix\n"
+      end
+
+      def add_stylesheets
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_shipping_matrix'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask 'Would you like to run the migrations now? [Y/n]')
+        if run_migrations
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_shipping_matrix/engine.rb

@@ -0,0 +1,25 @@
+module SpreeShippingMatrix
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_shipping_matrix'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+
+    config.after_initialize do
+      config.spree.calculators.shipping_methods << Spree::ShippingMatrixCalculator
+    end
+  end
+end

data/lib/spree_shipping_matrix/version.rb

@@ -0,0 +1,3 @@
+module SpreeShippingMatrix
+  VERSION = '0.1.0'
+end