spree_limit_order_quantity 1.0.0

data/README.md

@@ -0,0 +1,54 @@
+# Spree Limit order quantity
+
+This is a Spree extension that allows store administrators to set **minimum** and **maximum** quantity limits per product or variant for each order. This helps control how many units of a product or variant a customer can add to their cart or order.
+
+## Features
+
+- Set **minimum** and **maximum** quantity per order for each product.
+- Override those limits at the **variant** level.
+- Enforce quantity limits in the cart and checkout process.
+- Edit these limits directly from the admin panel (Product or Variant edit pages).
+
+## Installation
+
+1. Add this extension to your Gemfile with this line:
+
+    ```ruby
+    gem 'spree_limit_order_quantity', github: 'be-agile/spree_limit_order_quantity'
+    ```
+
+2. Then bundle install:
+
+    ```bash
+    bundle install
+    ```
+
+3. Run the install generator
+
+    ```ruby
+    bundle exec rails g spree_limit_order_quantity:install
+    ```
+
+4. Run migrations:
+
+    ```bash
+    rails db:migrate
+    ```
+
+## Validation Behavior
+
+During add-to-cart and checkout:
+
+- If the quantity is less than the minimum or greater than the maximum, the system will show an error and prevent the action.
+
+- Limits are applied per line item per order.
+
+## License
+
+This extension is available as open source under the terms of either:
+* [GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later)](https://www.gnu.org/licenses/agpl-3.0.en.html)
+* [BSD 3-Clause License](https://opensource.org/licenses/BSD-3-Clause)
+
+## Credits
+
+[be agile Co., Ltd.](https://be-agile.jp/)

data/app/controllers/spree_limit_order_quantity/checkout_controller_decorator.rb

@@ -0,0 +1,33 @@
+module SpreeLimitOrderQuantity
+  module CheckoutControllerDecorator
+    def self.prepended(base)
+      base.before_action :validate_master_variant_limits, only: [ :edit, :update ]
+    end
+
+    private
+
+    def validate_master_variant_limits
+      @order.line_items.group_by { |li| li.variant.product }.each do |product, line_items|
+        next unless should_check_master_limits?(product)
+
+        total_quantity = line_items.sum(&:quantity)
+        checker = MasterVariantQuantityChecker.new(product, total_quantity)
+
+        unless checker.valid?
+          flash[:error] = checker.error_message
+          redirect_to spree.product_path(product, order_token: @order.token)
+          return
+        end
+      end
+    end
+
+    def should_check_master_limits?(product)
+      master_variant = product.master
+      master_variant.min_order_quantity.present? || master_variant.max_order_quantity.present?
+    end
+  end
+end
+
+if Spree::CheckoutController.included_modules.exclude?(SpreeLimitOrderQuantity::CheckoutControllerDecorator)
+  Spree::CheckoutController.prepend(SpreeLimitOrderQuantity::CheckoutControllerDecorator)
+end

data/app/controllers/spree_limit_order_quantity/line_items_controller_decorator.rb

@@ -0,0 +1,54 @@
+module SpreeLimitOrderQuantity
+  module LineItemsControllerDecorator
+    def self.prepended(base)
+      base.before_action :validate_order_item_quantity, only: [ :update, :create ]
+    end
+
+    private
+
+    def validate_order_item_quantity
+      initialize_quantity_validation
+      return if @quantity_checker.valid?
+
+      handle_quantity_error
+    end
+
+    def initialize_quantity_validation
+      variant = @variant || @line_item&.variant
+      order = @order || current_order(create_order_if_necessary: true)
+      @quantity_checker = OrderQuantityChecker.new(order, variant, quantity: determine_order_item_quantity)
+      @quantity_checker.quantity += @quantity_checker.calculate_quantity if action_name == 'create'
+    end
+
+    def handle_quantity_error
+      flash_message = @quantity_checker.validation_error_messages.to_sentence
+      return product_quantity_error_response_stream(flash_message) if request.format.turbo_stream?
+
+      flash[:error] = flash_message
+      redirect_to spree.cart_path(order_token: order_token)
+    end
+
+    def product_quantity_error_response_stream(flash_message)
+      @order ||= @quantity_checker.order
+      load_line_items
+      template = "spree/line_items/#{action_name}"
+
+      # Render the Turbo Stream without flash message for updating line items
+      line_item_update_stream = render_to_string(template: template, formats: [ :turbo_stream ])
+
+      # Render the Turbo Stream for displaying the flash message
+      flash.now[:error] = flash_message
+      flash_message_stream = render_to_string(template: template, formats: [ :turbo_stream ])
+
+      render turbo_stream: [ flash_message_stream, line_item_update_stream ]
+    end
+
+    def determine_order_item_quantity
+      (params[:quantity].presence || line_item_params[:quantity].presence || 1).to_i
+    end
+  end
+end
+
+if Spree::LineItemsController.included_modules.exclude?(SpreeLimitOrderQuantity::LineItemsControllerDecorator)
+  Spree::LineItemsController.prepend(SpreeLimitOrderQuantity::LineItemsControllerDecorator)
+end

data/app/decorators/spree/core/controller_helpers/strong_parameters_loq_decorator.rb

@@ -0,0 +1,21 @@
+module Spree
+  module Core
+    module ControllerHelpers
+      module StrongParametersLoqDecorator
+        def permitted_variant_attributes
+          super + [ :min_order_quantity, :max_order_quantity ]
+        end
+
+        # @gem-override spree_core-5.3.6/lib/spree/core/controller_helpers/strong_parameters.rb#permitted_product_attributes
+        # @see https://github.com/be-agile/giga-repeat/commit/051fe2e2c01d36f5c85cee7f2033e8f90a7b3e7c
+        # 注文数量制限の min/max を許可属性に追加する。
+        def permitted_product_attributes
+          super + [ :min_order_quantity, :max_order_quantity ]
+        end
+      end
+    end
+  end
+end
+::Spree::Core::ControllerHelpers::StrongParameters.prepend(
+  Spree::Core::ControllerHelpers::StrongParametersLoqDecorator
+)

data/app/models/spree_limit_order_quantity/product_decorator.rb

@@ -0,0 +1,13 @@
+module SpreeLimitOrderQuantity
+  module ProductDecorator
+    def self.prepended(base)
+      [ :min_order_quantity, :max_order_quantity ].each do |method_name|
+        base.delegate method_name, :"#{method_name}=", to: :default_variant
+      end
+    end
+  end
+end
+
+if Spree::Product.included_modules.exclude?(SpreeLimitOrderQuantity::ProductDecorator)
+  Spree::Product.prepend(SpreeLimitOrderQuantity::ProductDecorator)
+end

data/app/models/spree_limit_order_quantity/variant_decorator.rb

@@ -0,0 +1,24 @@
+module SpreeLimitOrderQuantity
+  module VariantDecorator
+    def self.prepended(base)
+      base.validates :min_order_quantity, numericality: { only_integer: true, greater_than_or_equal_to: 1 }, if: -> { !min_order_quantity.nil? }
+      base.validates :max_order_quantity, numericality: { only_integer: true, greater_than_or_equal_to: 1 }, if: -> { !max_order_quantity.nil? }
+      base.validate :validate_min_max_order_quantity
+    end
+
+    private
+
+    def validate_min_max_order_quantity
+      if !min_order_quantity.nil? && !max_order_quantity.nil? && min_order_quantity > max_order_quantity
+        errors.add(
+          :base,
+          I18n.t('activerecord.errors.models.spree/variant.attributes.max_order_quantity.greater_than_min_order_quantity')
+        )
+      end
+    end
+  end
+end
+
+if Spree::Variant.included_modules.exclude?(SpreeLimitOrderQuantity::VariantDecorator)
+  Spree::Variant.prepend(SpreeLimitOrderQuantity::VariantDecorator)
+end

data/app/overrides/spree/admin/variants/edit/add_order_quantity_limits_form.html.erb.deface

@@ -0,0 +1,2 @@
+<!-- insert_after "erb[loud]:contains('spree/admin/variants/form/inventory')" -->
+<%= render 'spree_limit_order_quantity/admin/shared/limit_quantity_settings', f: f %>  

data/app/views/spree/admin/products/form/_limit_product_quantity_settings.html.erb

@@ -0,0 +1,3 @@
+<%= f.fields_for :master, @product.master do |vf| %>
+  <%= render 'spree_limit_order_quantity/admin/shared/limit_quantity_settings', f: vf %>  
+<% end %>

data/app/views/spree_limit_order_quantity/admin/shared/_limit_quantity_settings.html.erb

@@ -0,0 +1,19 @@
+<div class="card mb-4" id="limit-quantity-settings-card">
+  <div class="card-header">
+    <h5 class="card-title">
+      <%= Spree.t('admin.limit_product_quantity_settings') %>
+    </h5>
+  </div>
+  <div class="card-body">
+
+    <% [ :min_order_quantity, :max_order_quantity ].each do |field| %>
+      <div class="form-group d-flex align-items-center">
+        <%= f.label(field, class: 'col-form-label text-nowrap mr-3') %>
+        <div class="flex-grow-1">
+          <%= f.number_field(field, class: 'form-control', min: 1) %>
+        </div>
+      </div>
+    <% end %>
+
+  </div>
+</div>

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

data/config/locales/activerecord.en.yml

@@ -0,0 +1,13 @@
+en:
+  activerecord:
+    attributes:
+      spree/variant:
+        min_order_quantity: Minimum Order Quantity
+        max_order_quantity: Maximum Order Quantity
+
+    errors:
+      models:
+        spree/variant:
+          attributes:
+            max_order_quantity:
+              greater_than_min_order_quantity: "The order quantity must be greater than or equal to the minimum quantity"

data/config/locales/activerecord.ja.yml

@@ -0,0 +1,13 @@
+ja:
+  activerecord:
+    attributes:
+      spree/variant:
+        min_order_quantity: 注文時の最低数量
+        max_order_quantity: 注文時の最大数量
+
+    errors:
+      models:
+        spree/variant:
+          attributes:
+            max_order_quantity:
+              greater_than_min_order_quantity: "注文数量は最小数量以上でなければなりません"

data/config/locales/en.yml

@@ -0,0 +1,10 @@
+en:
+  spree:
+    storefront:
+      line_item:
+        max_order_quantity_error: "You can only purchase up to %{max_quantity} of %{product_name}."
+        min_order_quantity_error: "Please order at least %{min_quantity} of %{product_name}."
+        master_max_order_quantity_error: "You can purchase up to a maximum of %{max_quantity} units in total for all variations of %{product_name}."
+        master_min_order_quantity_error: "Please order at least %{min_quantity} units in total for all variations of %{product_name}."
+    admin:
+      limit_product_quantity_settings: "Limit Product Quantity Settings"

data/config/locales/ja.yml

@@ -0,0 +1,10 @@
+ja:
+  spree:
+    storefront:
+      line_item:
+        max_order_quantity_error: "%{product_name}は最大%{max_quantity}個まで購入できます。"
+        min_order_quantity_error: "%{product_name}は最低%{min_quantity}個以上注文してください。"
+        master_max_order_quantity_error: "%{product_name}の全バリエーション合計は最大%{max_quantity}個まで購入できます。"
+        master_min_order_quantity_error: "%{product_name}の全バリエーション合計は最低%{min_quantity}個以上注文してください。"
+    admin:
+      limit_product_quantity_settings: "注文数量の制限"

data/db/migrate/20250505025922_add_order_quantity_limits_to_spree_variants.rb

@@ -0,0 +1,6 @@
+class AddOrderQuantityLimitsToSpreeVariants < ActiveRecord::Migration[8.0]
+  def change
+    add_column :spree_variants, :min_order_quantity, :integer, null: true
+    add_column :spree_variants, :max_order_quantity, :integer, null: true
+  end
+end

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

@@ -0,0 +1,20 @@
+module SpreeLimitOrderQuantity
+  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_limit_order_quantity'
+      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 'bin/rails db:migrate'
+        else
+          puts 'Skipping rails db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_limit_order_quantity/engine.rb

@@ -0,0 +1,25 @@
+module SpreeLimitOrderQuantity
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_limit_order_quantity'
+
+    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.after_initialize do
+      Rails.application.config.spree_admin.product_form_partials << 'spree/admin/products/form/limit_product_quantity_settings'
+    end
+
+    initializer 'spree_limit_order_quantity.autoloader' do |app|
+      if Rails.autoloaders.zeitwerk_enabled?
+        Rails.autoloaders.main.ignore("#{root}/app/overrides")
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/spree_limit_order_quantity/master_variant_quantity_checker.rb

@@ -0,0 +1,56 @@
+module SpreeLimitOrderQuantity
+  class MasterVariantQuantityChecker
+    attr_accessor :product, :total_quantity
+
+    def initialize(product, total_quantity)
+      @product = product
+      @total_quantity = total_quantity
+    end
+
+    def valid?
+      max_quantity_valid? && min_quantity_valid?
+    end
+
+    def max_quantity_valid?
+      return true if master_variant.max_order_quantity.nil?
+
+      @total_quantity <= master_variant.max_order_quantity
+    end
+
+    def min_quantity_valid?
+      return true if master_variant.min_order_quantity.nil?
+
+      @total_quantity >= master_variant.min_order_quantity
+    end
+
+    def should_check_limits?
+      master_variant.min_order_quantity.present? || master_variant.max_order_quantity.present?
+    end
+
+    def error_message
+      return nil if valid?
+
+      product_name = @product.name
+
+      if !max_quantity_valid?
+        Spree.t(
+          "storefront.line_item.master_max_order_quantity_error",
+          product_name: product_name,
+          max_quantity: master_variant.max_order_quantity
+        )
+      elsif !min_quantity_valid?
+        Spree.t(
+          "storefront.line_item.master_min_order_quantity_error",
+          product_name: product_name,
+          min_quantity: master_variant.min_order_quantity
+        )
+      end
+    end
+
+    private
+
+    def master_variant
+      @master_variant ||= @product.master
+    end
+  end
+end

data/lib/spree_limit_order_quantity/order_quantity_checker.rb

@@ -0,0 +1,54 @@
+module SpreeLimitOrderQuantity
+  class OrderQuantityChecker
+    attr_accessor :order, :variant, :quantity
+
+    def initialize(order, variant, quantity: nil)
+      @order = order
+      @variant = variant
+      @quantity = quantity.nil? ? calculate_quantity : quantity
+    end
+
+    def valid?
+      max_quantity_valid? && min_quantity_valid?
+    end
+
+    def max_quantity_valid?
+      return true if @variant.max_order_quantity.nil?
+
+      @quantity <= @variant.max_order_quantity
+    end
+
+    def min_quantity_valid?
+      return true if @variant.min_order_quantity.nil?
+
+      @quantity >= @variant.min_order_quantity
+    end
+
+    def calculate_quantity
+      @order.line_items.where(variant: @variant).sum(:quantity).to_i
+    end
+
+    def validation_error_messages
+      messages = []
+      product_name = @variant.name
+
+      unless max_quantity_valid?
+        messages << Spree.t(
+          "storefront.line_item.max_order_quantity_error",
+          product_name: product_name,
+          max_quantity: @variant.max_order_quantity
+        )
+      end
+
+      unless min_quantity_valid?
+        messages << Spree.t(
+          "storefront.line_item.min_order_quantity_error",
+          product_name: product_name,
+          min_quantity: @variant.min_order_quantity
+        )
+      end
+
+      messages
+    end
+  end
+end

data/lib/spree_limit_order_quantity/version.rb

@@ -0,0 +1,7 @@
+module SpreeLimitOrderQuantity
+  VERSION = '1.0.0'.freeze
+
+  def gem_version
+    Gem::Version.new(VERSION)
+  end
+end

data/lib/spree_limit_order_quantity.rb

@@ -0,0 +1,7 @@
+require 'spree_core'
+require 'spree_extension'
+require 'spree_limit_order_quantity/engine'
+require 'spree_limit_order_quantity/version'
+require 'spree_limit_order_quantity/order_quantity_checker'
+require 'spree_limit_order_quantity/master_variant_quantity_checker'
+require 'deface'

data/spec/spec_helper.rb

@@ -0,0 +1,93 @@
+# Run Coverage report
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'spec/dummy'
+  add_filter 'vendor/'
+  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('../../../config/environment.rb',  __FILE__)
+
+require 'rspec/rails'
+require 'database_cleaner'
+require 'ffaker'
+require 'shoulda/matchers'
+require 'rspec/active_model/mocks'
+
+# 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 defined in spree_core
+require 'spree/testing_support/factories'
+require 'spree/testing_support/controller_requests'
+require 'spree/testing_support/authorization_helpers'
+require 'spree/testing_support/url_helpers'
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  # == 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 seperate server instance.
+  config.use_transactional_fixtures = false
+  config.include Spree::Core::Engine.routes.url_helpers
+
+  # 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 |example|
+    DatabaseCleaner.strategy = 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.include Spree::TestingSupport::UrlHelpers, type: :controller
+  config.include Spree::TestingSupport::ControllerRequests, type: :controller
+  config.infer_spec_type_from_file_location!
+end
+
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end

data/spree_limit_order_quantity.gemspec

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+
+lib = File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require 'spree_limit_order_quantity/version'
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_limit_order_quantity'
+  s.version     = SpreeLimitOrderQuantity::VERSION
+  s.summary     = "Limit the minimum and maximum quantity per product or variant per order in Spree"
+  s.required_ruby_version = '>= 3.0'
+
+  s.author      = 'be agile Co., Ltd.'
+  s.email       = 'develop@be-agile.jp'
+  s.homepage    = 'https://github.com/be-agile/spree_limit_order_quantity'
+  s.licenses    = ['AGPL-3.0-or-later']
+
+  s.files        = `git ls-files`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.add_dependency 'spree', '= 5.3.6'
+  s.add_dependency 'spree_storefront', '= 5.3.6'
+  s.add_dependency 'spree_admin', '= 5.3.6'
+  s.add_dependency 'spree_extension', '= 0.1.0'
+  s.add_dependency 'deface'
+
+  s.add_development_dependency 'spree_dev_tools'
+
+  # @gem-override マーカーの差分確認に使う開発ツール
+  s.add_development_dependency 'gem_override_marker'
+end