spree_store_pickup 1.1.6 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ef59ccecf7d3ea10401f92d1b8c9ed2f8304e85f622fa9aba93a76799aa769d
-  data.tar.gz: aac3af281b52503fa254f50b87ddb17b58daf44af81e850d2814e6f09501869f
+  metadata.gz: b9ea96c2a440506b83d0c18b63756ead9a8c700ce0e28233726b49a9626dd135
+  data.tar.gz: 9d649669ddced34b0566b7454aa6a1b8078d8bfcc145fbcf41902c09cb19711c
 SHA512:
-  metadata.gz: b9f999dffb5ca74a05c69eb2fce54a639d74c5ccd07edc3dc7ade0161ec0761a8fff053dc57f7d8e3848be9dc0fa42a5dd94994007fa380230d92ac1e559e2d0
-  data.tar.gz: 0a479d0818715421e4913c3c02f73051dd1cbc3be9cc4f5f5cd192f1bf4161e34456455f6b755506501b93f59b2737704e09df32596962c09df98d19d0167545
+  metadata.gz: 4e53f483bbc3afce6fbf322caed4650eaa4a548921b19273d094b167b1f5119c1d704120f1b7e846e77b6b404d22af0b472caefe21e5b9e0374be4a771b7189c
+  data.tar.gz: 0ce18ee3d7c5c8b6b9e2dbc1514c3142af6331e2b4b5d33bb8cc6a9526d4ec1dd6069450e7a0092c58446b362eaa4f453f922ef8ad9eb45df27984a821eb6f65

data/README.md

@@ -8,75 +8,73 @@ This is a Store Pickup extension for [Spree Commerce](https://spreecommerce.org)
 
 1. Add this extension to your Gemfile with this line:
 
-    ```bash
-    bundle add spree_store_pickup
-    ```
+   ```bash
+   bundle add spree_store_pickup
+   ```
 
 2. Run the install generator
 
-    ```bash
-    bundle exec rails g spree_store_pickup:install
-    ```
+   ```bash
+   bundle exec rails g spree_store_pickup:install
+   ```
 
 3. Restart your server
 
-  If your server was running, restart it so that it can find the assets properly.
+If your server was running, restart it so that it can find the assets properly.
 
 ## Usage
 
 1. Create (or enable) a Shipping Method that represents in‑store pickup. The generator creates a shipping method with a `store_pickup` type. Ensure the shipping method you want to use returns `true` for `store_pickup?`.
 2. Create a Payment Method for store pickup (e.g. name: "Pay In Store") whose `method_type` is `store_pickup`.
-3. By default this gem only provides helpers:
-   * `payment_method.store_pickup?`
-   * `payment_method.store_pickup_available?(order)` (true when the order's selected shipping method is store pickup)
-4. If you want the Store Pickup payment method to be shown ONLY when the shipping method is store pickup, add a decorator in your host app:
+3. The gem decorates `Spree::PaymentMethod#available_for_order?` with these rules:
+   - The store pickup payment method is shown only when the selected shipping method is store pickup.
+   - When store pickup shipping is selected, all other available payment methods are shown too.
+4. To show ONLY the store pickup payment method when store pickup shipping is selected, enable this in an initializer:
 
-````ruby
+   ```ruby
+   SpreeStorePickup::Config[:exclusive_payment_method] = true
+   ```
+
+5. For custom rules, prepend your own decorator in the host app. Use a different module name than the gem's `Spree::PaymentMethodStorePickupDecorator` so it doesn't replace it. Call `super` to keep the gem's rules, or skip it to replace them:
+
+```ruby
 module Spree
-  module PaymentMethodDecorator
-    # Customize availability combining store pickup (and optionally COD) logic.
+  module PaymentMethodCodDecorator
     def available_for_order?(order)
       return false unless super
 
-      # If shipping method is store pickup, only allow the store pickup payment method.
-      if store_pickup_available?(order)
-        return store_pickup?
-      end
-
-      # Example integration with a COD payment gem (optional):
-      if respond_to?(:cod_payment_available?) && cod_payment_available?(order)
-        return cod_payment?
-      end
-
-      # Hide specialized methods when their conditions are not met.
-      if store_pickup? || (respond_to?(:cod_payment?) && cod_payment?)
-        return false
-      end
+      # Example: hide a COD payment method when store pickup shipping is selected.
+      return false if store_pickup_available?(order) && respond_to?(:cod_payment?) && cod_payment?
 
       true
     end
   end
 
-  PaymentMethod.prepend PaymentMethodDecorator
+  PaymentMethod.prepend PaymentMethodCodDecorator
 end
-````
+```
+
+Helpers available on every payment method:
+
+- `payment_method.store_pickup?`
+- `payment_method.store_pickup_available?(order)` (true when the order's selected shipping method is store pickup)
 
 ## Developing
 
 1. Create a dummy app
 
-    ```bash
-    bundle update
-    bundle exec rake test_app
-    ```
+   ```bash
+   bundle update
+   bundle exec rake test_app
+   ```
 
 2. Add your new code
 
 3. Run tests
 
-    ```bash
-    bundle exec rspec
-    ```
+   ```bash
+   bundle exec rspec
+   ```
 
 When testing your applications integration with this extension you may use it's factories.
 Simply add this require statement to your spec_helper:

data/app/models/spree/payment_method_store_pickup_decorator.rb

@@ -0,0 +1,25 @@
+module Spree
+  module PaymentMethodStorePickupDecorator
+    def store_pickup?
+      method_type == 'store_pickup'
+    end
+
+    def store_pickup_available?(order)
+      order.shipping_method&.store_pickup?
+    end
+
+    def available_for_order?(order)
+      return false unless super
+
+      # Store pickup payment is only available with store pickup shipping.
+      return store_pickup_available?(order) if store_pickup?
+
+      # Optionally restrict store pickup shipping to the store pickup payment method only.
+      return false if SpreeStorePickup::Config[:exclusive_payment_method] && store_pickup_available?(order)
+
+      true
+    end
+  end
+
+  PaymentMethod.prepend PaymentMethodStorePickupDecorator
+end

data/lib/spree_store_pickup/configuration.rb

@@ -1,13 +1,6 @@
 module SpreeStorePickup
   class Configuration < Spree::Preferences::Configuration
-
-   # Some example preferences are shown below, for more information visit:
-   # https://docs.spreecommerce.org/developer/contributing/creating-an-extension
-
-   # 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]
+    # When true, selecting store pickup shipping shows only the store pickup payment method.
+    preference :exclusive_payment_method, :boolean, default: false
   end
 end

data/lib/spree_store_pickup/version.rb

@@ -1,5 +1,5 @@
 module SpreeStorePickup
-  VERSION = '1.1.6'.freeze
+  VERSION = '1.2.0'.freeze
 
   def gem_version
     Gem::Version.new(VERSION)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_store_pickup
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.2.0
 platform: ruby
 authors:
 - OlympusOne
@@ -92,7 +92,7 @@ files:
 - app/javascript/spree_store_pickup/application.js
 - app/javascript/spree_store_pickup/controllers/spree_store_pickup_controller.js
 - app/models/spree/payment_method/store_pickup.rb
-- app/models/spree/payment_method_decorator.rb
+- app/models/spree/payment_method_store_pickup_decorator.rb
 - app/views/spree/admin/payment_methods/_store_pickup.html.erb
 - app/views/spree/admin/payment_methods/descriptions/_store_pickup.html.erb
 - app/views/spree/admin/payments/source_views/_store_pickup.html.erb
@@ -117,10 +117,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/olympusone/spree_store_pickup/issues
-  changelog_uri: https://github.com/olympusone/spree_store_pickup/releases/tag/v1.1.6
+  changelog_uri: https://github.com/olympusone/spree_store_pickup/releases/tag/v1.2.0
   documentation_uri: https://github.com/olympusone/spree_store_pickup
   homepage_uri: https://github.com/olympusone/spree_store_pickup
-  source_code_uri: https://github.com/olympusone/spree_store_pickup/tree/v1.1.6
+  source_code_uri: https://github.com/olympusone/spree_store_pickup/tree/v1.2.0
 rdoc_options: []
 require_paths:
 - lib
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - none
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Spree Commerce Store Pickup Extension
 test_files: []

data/app/models/spree/payment_method_decorator.rb

@@ -1,13 +0,0 @@
-module Spree
-  module PaymentMethodDecorator
-    def store_pickup?
-      method_type == 'store_pickup'
-    end
-
-    def store_pickup_available?(order)
-      order.shipping_method&.store_pickup?
-    end
-  end
-
-  PaymentMethod.prepend PaymentMethodDecorator
-end