spree_stock_locking 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 38d75dfae6efd34b4f0e73396551513fd1acd3d78fbc339eeb50e9d92bc0fc5d
+  data.tar.gz: 5d0710ceeb52b457763f6ba3f1f0f017e0997ef592df372fc1408acef6ce24f1
+SHA512:
+  metadata.gz: 48e9c07428b3c2854fca7aa4d6d49bdc152570bb60338c411c638acb0127f07d11d42dccd51b07ffb046cf88f89653eef8a26513af1f8128fa8036820545646f
+  data.tar.gz: f4f8af7445d5cdec07d9e0a76a530b2f1b4575b6317a504b86805cc605a0d732e1c0df517801d6721aedab16681c92b37a43c6b56f60303b798d2688586679e6

data/.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: ci
+
+on: push
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    env:
+      DATABASE_HOST: 0.0.0.0
+      DATABASE_PASSWORD: mysql123
+      RAILS_ENV: test
+      REDIS_URL: redis://0.0.0.0:6379
+      TZ: Asia/Tokyo
+
+    services:
+      mysql:
+        image: mysql:8.0.23
+        options: --health-cmd "mysqladmin ping -h localhost" --health-interval 20s --health-timeout 10s --health-retries 10
+        env:
+          MYSQL_ROOT_PASSWORD: ${{ env.DATABASE_PASSWORD }}
+        ports:
+          - 3306:3306
+      redis:
+        image: redis:6.2-alpine
+        options: --health-cmd "redis-cli -h localhost ping" --health-interval 10s --health-timeout 5s --health-retries 15
+        ports:
+          - 6379:6379
+      webdriver_chrome:
+        image: selenium/standalone-chrome:95.0
+        ports:
+          - 4444:4444
+        options: "--shm-size 2g"
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: 3.0.3
+
+      - name: Exec tests 👚
+        env:
+          DB_HOST: 127.0.0.1
+          DB_PASSWORD: ${{ env.DATABASE_PASSWORD }}
+          DB_USERNAME: root
+        run: |
+          bundle exec rake test_app
+          bundle exec rake spec

data/.gitignore

@@ -0,0 +1,23 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.localeapp/locales
+.project
+.vscode
+coverage
+default
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.sw?
+spec/dummy
+.rvmrc
+.sass-cache
+public/spree
+.ruby-version
+.ruby-gemset
+*.gem
+*/*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--color
+-r spec_helper
+-f documentation

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
+  "https://github.com/#{repo_name}.git"
+end
+
+gem 'spree' # , github: 'spree/spree', branch: 'main'
+# gem 'spree_backend', github: 'spree/spree', branch: 'main'
+gem 'rails-controller-testing'
+
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2021 ROUTE06, Inc.
+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,54 @@
+# SpreeStockLocking
+
+A [Spree](https://github.com/spree/spree) extension that implements stock movement locking with Redis::Lock.
+
+## Installation
+
+1. Add this extension to your Gemfile with this line:
+
+    ```ruby
+    gem 'spree_stock_locking'
+    ```
+
+2. Install the gem using Bundler
+
+    ```ruby
+    bundle install
+    ```
+
+3. Copy & run migrations
+
+    ```ruby
+    bundle exec rails g spree_stock_locking:install
+    ```
+
+4. Restart your server
+
+  If your server was running, restart it so that it can find the assets properly.
+
+## 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 update
+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_stock_locking/factories'
+```
+
+## Releasing
+
+```shell
+bundle exec gem bump -p -t
+bundle exec gem release
+```
+
+For more options please see [gem-release REAMDE](https://github.com/svenfuchs/gem-release)
+
+Copyright (c) 2021 ROUTE06, Inc., 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_stock_locking'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/controllers/spree_stock_locking/admin/stock_items_controller_decorator.rb

@@ -0,0 +1,42 @@
+# @see https://github.com/spree/spree/blob/759a342d8c223f38f6544b880eb475db3c6f879c/backend/app/controllers/spree/admin/stock_items_controller.rb
+module SpreeStockLocking::Admin::StockItemsControllerDecorator
+  def self.prepended(base)
+    base.around_action(:lock_with_variant_ids_for_request_params, only: [:create])
+    base.around_action(:lock_with_variant_ids_for_stock_item, only: [:update, :destroy])
+  end
+
+  private
+
+  # @param variant_ids [Array] Get a lock with each variant
+  def lock_with_variant_ids(variant_ids, &block)
+    variant_id = variant_ids.shift
+    if variant_id
+      identifier = "variant_id:#{variant_id}"
+      # Since the lock mechanism of redis-objects uses blocks,
+      # use recursion to handle multiple variant_ids.
+      Redis::Lock.new(identifier, expiration: 15, timeout: 10).lock do
+        lock_with_variant_ids(variant_ids, &block)
+      end
+    else
+      yield
+    end
+  end
+
+  def lock_with_variant_ids_for_stock_item
+    variant_ids = [stock_item.variant_id]
+    lock_with_variant_ids(variant_ids) do
+      yield
+    end
+  rescue Redis::Lock::LockTimeout
+  end
+
+  def lock_with_variant_ids_for_request_params
+    variant_ids = [::Spree::Variant.find(params[:variant_id]).id]
+    lock_with_variant_ids(variant_ids) do
+      yield
+    end
+  rescue Redis::Lock::LockTimeout
+  end
+end
+
+Spree::Admin::StockItemsController.prepend(SpreeStockLocking::Admin::StockItemsControllerDecorator) unless Spree::Admin::StockItemsController.included_modules.include?(SpreeStockLocking::Admin::StockItemsControllerDecorator)

data/app/controllers/spree_stock_locking/api/v2/storefront/checkout_controller_decorator.rb

@@ -0,0 +1,44 @@
+# @see https://github.com/spree/spree/blob/759a342d8c223f38f6544b880eb475db3c6f879c/api/app/controllers/spree/api/v2/storefront/checkout_controller.rb
+module SpreeStockLocking
+  module Api
+    module V2
+      module Storefront
+        module CheckoutControllerDecorator
+          def self.prepended(base)
+            base.around_action(:lock_with_variants_ids_for_complete, only: [:next, :advance, :complete])
+          end
+
+          private
+
+          def lock_with_variants_ids_for_complete
+            if spree_current_order.confirm?
+              variant_ids = spree_current_order.line_items.pluck(:variant_id)
+
+              lock_with_variants_ids(variant_ids) do
+                yield
+              end
+            else
+              yield
+            end
+          rescue Redis::Lock::LockTimeout
+          end
+
+          def lock_with_variants_ids(variant_ids, &block)
+            variant_id = variant_ids.shift
+
+            if variant_id
+              identifier = "variant_id:#{variant_id}"
+              Redis::Lock.new(identifier, expiration: 15, timeout: 10).lock do
+                lock_with_variants_ids(variant_ids, &block)
+              end
+            else
+              yield
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+Spree::Api::V2::Storefront::CheckoutController.prepend(SpreeStockLocking::Api::V2::Storefront::CheckoutControllerDecorator) unless Spree::Api::V2::Storefront::CheckoutController.included_modules.include?(SpreeStockLocking::Api::V2::Storefront::CheckoutControllerDecorator)

data/app/models/spree_stock_locking/configuration.rb

@@ -0,0 +1,13 @@
+module SpreeStockLocking
+  class Configuration < Spree::Preferences::Configuration
+
+   # Some example preferences are shown below, for more information visit:
+   # https://dev-docs.spreecommerce.org/internals/preferences
+
+   preference :enabled, :boolean, default: true
+   # preference :dark_chocolate, :boolean, default: true
+   # preference :color, :string, default: 'Red'
+   # preference :favorite_number, :integer
+   # preference :supported_locales, :array, default: [:en]
+  end
+end

data/bin/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" from the root of your extension
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_stock_locking/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.add_routes do
+  # Add your extension routes here
+end

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

@@ -0,0 +1,20 @@
+module SpreeStockLocking
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :migrate, type: :boolean, default: true
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_stock_locking'
+      end
+
+      def run_migrations
+        run_migrations = options[:migrate] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+        if run_migrations
+          run 'bundle exec rails db:migrate'
+        else
+          puts 'Skipping rails db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_stock_locking/engine.rb

@@ -0,0 +1,24 @@
+module SpreeStockLocking
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_stock_locking'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer 'spree_stock_locking.environment', before: :load_config_initializers do |_app|
+      SpreeStockLocking::Config = SpreeStockLocking::Configuration.new
+    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_stock_locking/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 'spree_stock_locking/factories'
+end

data/lib/spree_stock_locking/version.rb

@@ -0,0 +1,11 @@
+module SpreeStockLocking
+  VERSION = '0.0.1'.freeze
+
+  module_function
+
+  # Returns the version of the currently loaded SpreeStockLocking as a
+  # <tt>Gem::Version</tt>.
+  def version
+    Gem::Version.new VERSION
+  end
+end

data/lib/spree_stock_locking.rb

@@ -0,0 +1,8 @@
+require 'spree_core'
+require 'spree_extension'
+require 'spree_backend'
+require 'spree_auth_devise'
+require 'spree_stock_locking/engine'
+require 'spree_stock_locking/version'
+
+require 'redis-objects'

data/spree_stock_locking.gemspec

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+lib = File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require 'spree_stock_locking/version'
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_stock_locking'
+  s.version     = SpreeStockLocking.version
+  s.summary     = 'A Spree extension that implements stock movement locking with Redis::Lock'
+  s.description = ''
+  s.required_ruby_version = '>= 2.5'
+
+  s.author    = 'ROUTE06'
+  s.email     = 'development+rubygems@route06.co.jp'
+  s.homepage  = 'https://github.com/route06/spree_stock_locking'
+  s.license   = 'BSD-3-Clause'
+
+  s.files       = `git ls-files`.split("\n").reject { |f| f.match(/^spec/) && !f.match(/^spec\/fixtures/) }
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.add_dependency 'spree', '>= 4.3.0'
+  s.add_dependency 'spree_auth_devise'
+  s.add_dependency 'spree_backend'
+  s.add_dependency 'spree_extension'
+
+  s.add_dependency 'redis-objects'
+
+  s.add_development_dependency 'actionmailer' # needed for running rspec
+  s.add_development_dependency 'spree_dev_tools'
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: spree_stock_locking
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ROUTE06
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+- !ruby/object:Gem::Dependency
+  name: spree_auth_devise
+  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: spree_backend
+  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: spree_extension
+  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: redis-objects
+  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: actionmailer
+  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: spree_dev_tools
+  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: ''
+email: development+rubygems@route06.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/.gitkeep
+- app/controllers/.gitkeep
+- app/controllers/spree_stock_locking/admin/stock_items_controller_decorator.rb
+- app/controllers/spree_stock_locking/api/v2/storefront/checkout_controller_decorator.rb
+- app/models/.gitkeep
+- app/models/spree_stock_locking/configuration.rb
+- app/serializers/.gitkeep
+- app/services/.gitkeep
+- bin/rails
+- config/locales/en.yml
+- config/routes.rb
+- lib/generators/spree_stock_locking/install/install_generator.rb
+- lib/spree_stock_locking.rb
+- lib/spree_stock_locking/engine.rb
+- lib/spree_stock_locking/factories.rb
+- lib/spree_stock_locking/version.rb
+- spree_stock_locking.gemspec
+homepage: https://github.com/route06/spree_stock_locking
+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: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: A Spree extension that implements stock movement locking with Redis::Lock
+test_files: []