solidus_legacy_stock_system 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 606ec48b0fa6131ea4c5d0f5623695c716a15197
+  data.tar.gz: caf64dc6cfe49b5b6ba8583368f39af45521b5b0
+SHA512:
+  metadata.gz: 2751accd31a54debb60a96d3e17d1f2e0e04a7073ba35dcc1f32ab745eaa9b67459a0b1452b9a367d10dd665fdddff86d5baa29ae4aba4b741afbbec273ad65e
+  data.tar.gz: 2841223ae36abfa3424233b9e2b021b1a7ff62f01eaae5d0da7825181c33301170c0143633823816f18fb15e62844c8fa650f1757d67bfa88a7fb892074ca68c

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2017 Stembolt
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,50 @@
+SolidusLegacyStockSystem
+========================
+
+This is the old stock system. This was removed from Solidus in [this pull
+request](https://github.com/solidusio/solidus/pull/2199).
+
+What is in the box?
+------------------
+
+This extension provides the `Adjuster`, `Coordinator`, `Packer`, and
+`Prioritizer` classes that were removed in version 2.4 of Solidus. Relevant
+specs are also included for development and testing continued compatibility with
+core.
+
+Installation
+------------
+
+There are no migrations to go along with this extension. Following the steps
+below is all that is required to use the legacy system.
+
+Add solidus_legacy_stock_system to your Gemfile:
+
+```ruby
+gem 'solidus_legacy_stock_system'
+```
+
+Bundle your dependencies:
+
+```shell
+bundle
+```
+
+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, and [Rubocop](https://github.com/bbatsov/rubocop) static code analysis. 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 'solidus_legacy_stock_system/factories'
+```
+
+Copyright (c) 2017 Stembolt, released under the New BSD License

data/Rakefile

@@ -0,0 +1,30 @@
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+begin
+  require 'spree/testing_support/extension_rake'
+  require 'rubocop/rake_task'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  RuboCop::RakeTask.new
+
+  task default: %i(first_run spec)
+rescue LoadError
+  # no rspec available
+end
+
+task :first_run do
+  if Dir['spec/dummy'].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir('../../')
+  end
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'solidus_legacy_stock_system'
+  Rake::Task['extension:test_app'].invoke
+end

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

@@ -0,0 +1,28 @@
+module Spree
+  module Stock
+    # Used by Prioritizer to adjust item quantities.
+    #
+    # See spec/models/spree/stock/prioritizer_spec.rb for use cases.
+    class Adjuster
+      attr_accessor :inventory_unit, :status, :fulfilled
+
+      def initialize(inventory_unit, status)
+        @inventory_unit = inventory_unit
+        @status = status
+        @fulfilled = false
+      end
+
+      def adjust(package)
+        if fulfilled?
+          package.remove(inventory_unit)
+        else
+          self.fulfilled = true
+        end
+      end
+
+      def fulfilled?
+        fulfilled
+      end
+    end
+  end
+end

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

@@ -0,0 +1,150 @@
+module Spree
+  module Stock
+    class Coordinator
+      attr_reader :order, :inventory_units
+
+      def initialize(order, inventory_units = nil)
+        @order = order
+        @inventory_units = inventory_units || InventoryUnitBuilder.new(order).units
+        @preallocated_inventory_units = []
+      end
+
+      def shipments
+        packages.map(&:shipment)
+      end
+
+      private
+
+      def packages
+        packages = build_location_configured_packages
+        packages = build_packages(packages)
+        packages = prioritize_packages(packages)
+        packages.each do |package|
+          package.shipment = package.to_shipment
+        end
+        packages = estimate_packages(packages)
+        validate_packages(packages)
+        packages
+      end
+
+      # Build packages for the inventory units that have preferred stock locations first
+      #
+      # Certain variants have been selected to be fulfilled from a particular stock
+      # location during the process of the order being created. The rest of the
+      # service objects the coordinator uses do a lot of automated logic to
+      # determine which stock location is best for the inventory unit to be
+      # fulfilled from, but for these special snowflakes we KNOW which stock
+      # location they should be fulfilled from. So rather than sending these units
+      # through the rest of the packing / prioritization, lets just put them
+      # in packages we know they should be in and deal with other automatically-
+      # handled inventory units otherwise.
+      def build_location_configured_packages(packages = [])
+        order.order_stock_locations.where(shipment_fulfilled: false).group_by(&:stock_location).each do |stock_location, stock_location_configurations|
+          units = stock_location_configurations.flat_map do |stock_location_configuration|
+            unallocated_inventory_units.select { |iu| iu.variant == stock_location_configuration.variant }.take(stock_location_configuration.quantity)
+          end
+          packer = build_packer(stock_location, units)
+          packages += packer.packages
+          @preallocated_inventory_units += units
+        end
+        packages
+      end
+
+      # 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
+      def build_packages(packages = [])
+        stock_location_variant_ids.each do |stock_location, variant_ids|
+          units_for_location = unallocated_inventory_units.select { |unit| variant_ids.include?(unit.variant_id) }
+          packer = build_packer(stock_location, units_for_location)
+          packages += packer.packages
+        end
+        packages
+      end
+
+      # This finds the variants we're looking for in each active stock location.
+      # It returns a hash like:
+      #   {
+      #     <stock location> => <set of variant ids>,
+      #     <stock location> => <set of variant ids>,
+      #     ...,
+      #   }
+      # This is done in an awkward way for performance reasons.  It uses two
+      # queries that are kept as performant as possible, and only loads the
+      # minimum required ActiveRecord objects.
+      def stock_location_variant_ids
+        # associate the variant ids we're interested in with stock location ids
+        location_variant_ids = Spree::StockItem.
+          where(variant_id: unallocated_variant_ids).
+          joins(:stock_location).
+          merge(Spree::StockLocation.active).
+          pluck(:stock_location_id, :variant_id)
+
+        # load activerecord objects for the stock location ids and turn them
+        # into a lookup hash like:
+        #   {
+        #     <stock location id> => <stock location>,
+        #     ...,
+        #   }
+        location_lookup = Spree::StockLocation.
+          where(id: location_variant_ids.map(&:first).uniq).
+          map { |l| [l.id, l] }.
+          to_h
+
+        # build the final lookup hash of
+        #   {<stock location> => <set of variant ids>, ...}
+        # using the previous results
+        location_variant_ids.each_with_object({}) do |(location_id, variant_id), hash|
+          location = location_lookup[location_id]
+          hash[location] ||= Set.new
+          hash[location] << variant_id
+        end
+      end
+
+      def unallocated_inventory_units
+        inventory_units - @preallocated_inventory_units
+      end
+
+      def unallocated_variant_ids
+        unallocated_inventory_units.map(&:variant_id).uniq
+      end
+
+      def prioritize_packages(packages)
+        prioritizer = Prioritizer.new(inventory_units, packages)
+        prioritizer.prioritized_packages
+      end
+
+      def estimate_packages(packages)
+        estimator = Spree::Config.stock.estimator_class.new
+        packages.each do |package|
+          package.shipment.shipping_rates = estimator.shipping_rates(package)
+        end
+        packages
+      end
+
+      def validate_packages(packages)
+        desired_quantity = inventory_units.size
+        packaged_quantity = packages.sum(&:quantity)
+        if packaged_quantity != desired_quantity
+          raise Spree::Order::InsufficientStock,
+            "Was only able to package #{packaged_quantity} inventory units of #{desired_quantity} requested"
+        end
+      end
+
+      def build_packer(stock_location, inventory_units)
+        Packer.new(stock_location, inventory_units, splitters(stock_location))
+      end
+
+      def splitters(_stock_location)
+        # extension point to return custom splitters for a location
+        Rails.application.config.spree.stock_splitters
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+module Spree
+  module Stock
+    class Packer
+      attr_reader :stock_location, :inventory_units, :splitters
+
+      def initialize(stock_location, inventory_units, splitters = [Splitter::Base])
+        @stock_location = stock_location
+        @inventory_units = inventory_units
+        @splitters = splitters
+      end
+
+      def packages
+        Spree::Stock::SplitterChain.new(stock_location, splitters).split([default_package])
+      end
+
+      def default_package
+        package = Package.new(stock_location)
+        inventory_units.group_by(&:variant).each do |variant, variant_inventory_units|
+          units = variant_inventory_units.clone
+          if variant.should_track_inventory?
+            stock_item = stock_item_for(variant.id)
+            next unless stock_item
+
+            on_hand, backordered = stock_item.fill_status(units.count)
+            package.add_multiple units.slice!(0, on_hand), :on_hand if on_hand > 0
+            package.add_multiple units.slice!(0, backordered), :backordered if backordered > 0
+          else
+            package.add_multiple units
+          end
+        end
+        package
+      end
+
+      private
+
+      def stock_item_for(variant_id)
+        stock_item_lookup[variant_id]
+      end
+
+      # Returns a lookup table in the form of:
+      #   {<variant_id> => <stock_item>, ...}
+      def stock_item_lookup
+        @stock_item_lookup ||= Spree::StockItem.
+          where(variant_id: inventory_units.map(&:variant_id).uniq).
+          where(stock_location_id: stock_location.id).
+          map { |stock_item| [stock_item.variant_id, stock_item] }.
+          to_h # there is only one stock item per variant in a stock location
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module Spree
+  module Stock
+    class Prioritizer
+      attr_reader :packages, :inventory_units
+
+      def initialize(inventory_units, packages, adjuster_class = Adjuster)
+        @inventory_units = inventory_units
+        @packages = packages
+        @adjuster_class = adjuster_class
+      end
+
+      def prioritized_packages
+        sort_packages
+        adjust_packages
+        prune_packages
+        packages
+      end
+
+      private
+
+      def adjust_packages
+        inventory_units.each do |inventory_unit|
+          adjuster = @adjuster_class.new(inventory_unit, :on_hand)
+
+          visit_packages(adjuster)
+
+          adjuster.status = :backordered
+          visit_packages(adjuster)
+        end
+      end
+
+      def visit_packages(adjuster)
+        packages.each do |package|
+          item = package.find_item adjuster.inventory_unit, adjuster.status
+          adjuster.adjust(package) if item
+        end
+      end
+
+      def sort_packages
+        # order packages by preferred stock_locations
+      end
+
+      def prune_packages
+        packages.reject!(&:empty?)
+      end
+    end
+  end
+end

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/lib/generators/solidus_legacy_stock_system/install/install_generator.rb

@@ -0,0 +1,20 @@
+module SolidusLegacyStockSystem
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=solidus_legacy_stock_system'
+      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/solidus_legacy_stock_system.rb

@@ -0,0 +1,2 @@
+require 'solidus_core'
+require 'solidus_legacy_stock_system/engine'

data/lib/solidus_legacy_stock_system/engine.rb

@@ -0,0 +1,16 @@
+module SolidusLegacyStockSystem
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'solidus_legacy_stock_system'
+
+    initializer 'spree.stock.coordinator_class' do |app|
+      app.config.spree.preferences.stock.coordinator_class = 'Spree::Stock::Coordinator'
+    end
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/solidus_legacy_stock_system/factories.rb

@@ -0,0 +1,6 @@
+FactoryBot.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 'solidus_legacy_stock_system/factories'
+end

data/lib/solidus_legacy_stock_system/version.rb

@@ -0,0 +1,3 @@
+module SolidusLegacyStockSystem
+  VERSION = '1.0.0'
+end

data/lib/spree/testing_support/factories/stock_packer_factory.rb

@@ -0,0 +1,13 @@
+require 'spree/testing_support/factories/stock_location_factory'
+
+FactoryBot.define do
+  # must use build()
+  factory :stock_packer, class: Spree::Stock::Packer do
+    transient do
+      stock_location { build(:stock_location) }
+      contents []
+    end
+
+    initialize_with { new(stock_location, contents) }
+  end
+end

metadata

@@ -0,0 +1,246 @@
+--- !ruby/object:Gem::Specification
+name: solidus_legacy_stock_system
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Stembolt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: solidus_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.x
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.x
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.x
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.x
+- !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_bot
+  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: 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: pry
+  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-activemodel-mocks
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.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'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: mysql2
+  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: Legacy stock system for Solidus
+email: contact@solidus.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/models/spree/stock/adjuster.rb
+- app/models/spree/stock/coordinator.rb
+- app/models/spree/stock/packer.rb
+- app/models/spree/stock/prioritizer.rb
+- config/locales/en.yml
+- config/routes.rb
+- lib/generators/solidus_legacy_stock_system/install/install_generator.rb
+- lib/solidus_legacy_stock_system.rb
+- lib/solidus_legacy_stock_system/engine.rb
+- lib/solidus_legacy_stock_system/factories.rb
+- lib/solidus_legacy_stock_system/version.rb
+- lib/spree/testing_support/factories/stock_packer_factory.rb
+homepage: https://solidus.io
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Legacy stock system for Solidus
+test_files: []