spree_location_prioritizer 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7323d24b35a4ac60a2759a40baa442f1db8bbda4
+  data.tar.gz: f97e587c5207bcfb7e5fade53e8f0c0a0867e8a9
+SHA512:
+  metadata.gz: 9cfd9a2da9c3ad9620b5ae7154a80ec8d5c3d9bfbd5ce558343e161e5c2cbd64bcddbd3859f058ffb01698cc4f8d1661aca163cf64095e0d3cee3f4e7c781b7b
+  data.tar.gz: 183e9a943a5640404f839d05b83fad9c671bfd0960fb818fdaed797683b5ec268e6ce4a6dbcdee55ac825c27e54559a43d10cb0fd024c7bc9c2d6a0252dcf2d4

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 @@
+--color

data/Gemfile

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

data/HEAD

@@ -0,0 +1 @@
+ref: refs/heads/master

data/README.md

@@ -0,0 +1,45 @@
+SpreeLocationPrioritizer
+=============
+
+Spree 3.0 has the priotitizer to sort the package capability but not implemented.
+This gem/extenstion assume every stock location has its own serving countries and priorities.
+Example, stock location with priorities as {"ca" => 1, "all" => 0, "us" => 10000} , and location with prioties as {"ca" => 10000}
+The second location should serve Canadian customers when possible.
+
+The coordinator will put all items into one package and ship from one warehouse. It will will not check the on_hand_count. If you want remove one item away from one stock location,
+delete it from the item location lists, not just set the on_hand_count to 0.
+
+Installation
+------------
+
+Add spree_location_prioritizer to your Gemfile:
+
+```ruby
+gem 'spree_location_prioritizer'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g spree_location_prioritizer: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_location_prioritizer/factories'
+```
+
+Copyright (c) 2014 [name of extension creator], released under the New BSD License

data/Rakefile

@@ -0,0 +1,21 @@
+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[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_location_prioritizer'
+  Rake::Task['extension:test_app'].invoke
+end

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

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

data/app/assets/javascripts/spree/frontend/spree_location_prioritizer.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_location_prioritizer.css

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

data/app/assets/stylesheets/spree/frontend/spree_location_prioritizer.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/models/spree/stock/coordinator_decorator.rb

@@ -0,0 +1,28 @@
+module Spree
+  module Stock
+    Coordinator.class_eval do
+      # Build packages as per stock location
+      #
+      # It needs to check whether each stock location holds at least one stock
+      # item for the order. In case none is found it wouldn't make any sense
+      # to build a package because it would be empty. Plus we avoid errors down
+      # the stack because it would assume the stock location has stock items
+      # for the given order
+      #
+      # Returns an array of Package instances
+      # we drop the package who does not cover all inventories
+      def build_packages(packages = Array.new)
+        StockLocation.active.each do |stock_location|
+          next unless stock_location.stock_items.where(:variant_id => inventory_units.map(&:variant_id).uniq).exists?
+          # skip the warehouse we can not fulfill the order as one package.
+          # this need we have one primary warehouse can ship them all.
+
+          next unless stock_location.stock_items.where(:variant_id => inventory_units.map(&:variant_id).uniq).length == inventory_units.map(&:variant_id).uniq.length
+          packer = build_packer(stock_location, inventory_units)
+          packages += packer.packages
+        end
+        packages
+      end
+    end
+  end
+end

data/app/models/spree/stock/prioritizer_decorator.rb

@@ -0,0 +1,20 @@
+module Spree
+  module Stock
+    Prioritizer.class_eval do
+      private
+      def sort_packages
+        Rails.logger.info("sort_packages track: #{caller_locations(0..2)}")
+        # order packages by preferred stock_locations
+        # de={"ca" => 1, "all" => 0, "us" => 10000}  in string   "{\"gb\":1, \"all\":0, \"us\":10000}"
+        # nwb={"ca" => 10000}             in string "{\"gb\":10000}"
+        # p=[de,nwb]
+        # p.sort!{|t,y| y[o["country"]]<=>t[o["country"]]}  # t y sequence reversed here  p
+
+        packages.sort!{|f,s| (JSON.parse(s.stock_location.priorities)[inventory_units.first.order.ship_address.country.iso.downcase] || JSON.parse(s.stock_location.priorities)["all"] || 0) <=> (JSON.parse(f.stock_location.priorities)[inventory_units.first.order.ship_address.country.iso.downcase]  || JSON.parse(f.stock_location.priorities)["all"] || 0)}
+
+        Rails.logger.info("packages after sort: #{packages.length} at locations of #{packages.map(&:stock_location).inspect}")
+        packages
+      end
+    end
+  end
+end

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_location_prioritizer/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# 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:
+  hello: "Hello world"

data/config/routes.rb

@@ -0,0 +1,3 @@
+Spree::Core::Engine.routes.draw do
+  # Add your extension routes here
+end

data/db/migrate/20150126092933_add_priorities_to_locations.rb

@@ -0,0 +1,11 @@
+class AddPrioritiesToLocations < ActiveRecord::Migration
+  def change
+    add_column :spree_stock_locations, :priorities, :string
+  end
+
+  def down
+    change_table :spree_stock_locations do |t|
+      t.remove :priorities
+    end
+  end
+end

data/description

@@ -0,0 +1 @@
+Unnamed repository; edit this file 'description' to name the repository.

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

@@ -0,0 +1,31 @@
+module SpreeLocationPrioritizer
+  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/frontend/all.js', "//= require spree/frontend/spree_location_prioritizer\n"
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/spree_location_prioritizer\n"
+      end
+
+      def add_stylesheets
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/spree_location_prioritizer\n", :before => /\*\//, :verbose => true
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/spree_location_prioritizer\n", :before => /\*\//, :verbose => true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_location_prioritizer'
+      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_location_prioritizer.rb

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

data/lib/spree_location_prioritizer/engine.rb

@@ -0,0 +1,20 @@
+module SpreeLocationPrioritizer
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_location_prioritizer'
+
+    # 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
+  end
+end

data/lib/spree_location_prioritizer/factories.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'spree_location_prioritizer/factories'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,87 @@
+# Run Coverage report
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'spec/dummy'
+  add_group 'Controllers', 'app/controllers'
+  add_group 'Helpers', 'app/helpers'
+  add_group 'Mailers', 'app/mailers'
+  add_group 'Models', 'app/models'
+  add_group 'Views', 'app/views'
+  add_group 'Libraries', 'lib'
+end
+
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+
+require 'rspec/rails'
+require 'database_cleaner'
+require 'ffaker'
+
+# 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'
+
+# Requires factories defined in lib/spree_location_prioritizer/factories.rb
+require 'spree_location_prioritizer/factories'
+
+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/spree_location_prioritizer.gemspec

@@ -0,0 +1,32 @@
+# encoding: UTF-8
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_location_prioritizer'
+  s.version     = '3.0.0'
+  s.summary     = 'sort the packages with stock location priority settings'
+  s.description = 'for multi-warehouse stores, we need set the closest/cheapest stock location for the shipment. this extension will do it with stock location settings.'
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.author    = 'Albert Liu'
+  s.email     = 'albertliu@naturalwellbeing.com'
+  s.homepage  = 'http://www.naturalwellbeing.com'
+
+  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'
+
+  version = '~> 3-0-stable'
+  s.add_dependency 'spree_core'
+
+  s.add_development_dependency 'capybara', '~> 2.4'
+  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',  '~> 3.1'
+  s.add_development_dependency 'sass-rails', '~> 4.0.2'
+  s.add_development_dependency 'selenium-webdriver'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,222 @@
+--- !ruby/object:Gem::Specification
+name: spree_location_prioritizer
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- Albert Liu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: for multi-warehouse stores, we need set the closest/cheapest stock location
+  for the shipment. this extension will do it with stock location settings.
+email: albertliu@naturalwellbeing.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- HEAD
+- README.md
+- Rakefile
+- app/assets/javascripts/spree/backend/spree_location_prioritizer.js
+- app/assets/javascripts/spree/frontend/spree_location_prioritizer.js
+- app/assets/stylesheets/spree/backend/spree_location_prioritizer.css
+- app/assets/stylesheets/spree/frontend/spree_location_prioritizer.css
+- app/models/spree/stock/coordinator_decorator.rb
+- app/models/spree/stock/prioritizer_decorator.rb
+- bin/rails
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20150126092933_add_priorities_to_locations.rb
+- description
+- lib/generators/spree_location_prioritizer/install/install_generator.rb
+- lib/spree_location_prioritizer.rb
+- lib/spree_location_prioritizer/engine.rb
+- lib/spree_location_prioritizer/factories.rb
+- spec/spec_helper.rb
+- spree_location_prioritizer.gemspec
+homepage: http://www.naturalwellbeing.com
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: sort the packages with stock location priority settings
+test_files:
+- spec/spec_helper.rb