spree_store_pickup 1.0.1 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19b22e5eb5f6769935eaf302b68075f00bfde9c33653c5923d7d82fd7878b0d8
-  data.tar.gz: 8fb8b461b0609a39c0795a8682eda0710d748f8578092699edf8db8a664902dd
+  metadata.gz: d02ed985c2068cff724a0e6f46d67839695b2b61d34200955475959e5a27719f
+  data.tar.gz: 6710d56720b1beab6a6876549ee05f89d24ad9969cfa5c3e7ab1e25cf378d31f
 SHA512:
-  metadata.gz: 97c4980d8e20f69ddaaa79bb023e26dea1ba66baa365473caab2b3e2837c3441c7eb34007425417a9fac9d12b0d1889cd1df9bee4cc78a046257e4bf27835604
-  data.tar.gz: 18661da3303c6ac143bd9007e7b364dc766ee598d814b5f0a9d995f45b0918b764747e947a47d8538cb9bfcf3489bb47325b85a344e008be274e9797d9e0cf0a
+  metadata.gz: 85d9824885ed2706e53b8dd0916a51070609b808597de131a1d649a2d02ab708ad99cecefd47d9dad8e28d8ce060db0626e808e6da22dfa2ec7c43aa6f32ed41
+  data.tar.gz: 44c0ff744bcdc62683045652a3d020422ec80b2db76bfbb6e6f970d4c06a1ecb14e2bc77d82a772c225c225b1e2ea6bbb46cb729dfa40f220e0ad5fcec4715ef

data/LICENSE.md

@@ -1,21 +1,15 @@
-# MIT License
+# LICENSE
 
-Copyright (c) 2025 OlympusOne
+Copyright (c) 2025 OlympusOne. All rights reserved.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+This program is free software: you can redistribute it and/or modify it under the terms of the
+GNU Affero General Public License as published by the Free Software Foundation, either
+version 3 of the License, or any later version.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Affero General Public License for more details.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see [https://www.gnu.org/licenses/](https://www.gnu.org/licenses/).

data/README.md

@@ -1,6 +1,6 @@
-# SpreeStorePickup
+# Spree Store Pickup
 
-This is a Store Pickup extension for [Spree Commerce](https://spreecommerce.org), an open source e-commerce platform built with Ruby on Rails. Adds in-store pickup as selectable shipping and payment option during checkout.
+This is a Store Pickup extension for [Spree Commerce](https://spreecommerce.org), an open source e-commerce platform built with Ruby on Rails. Adds in-store pickup as selectable shipping and payment method during checkout.
 
 [![Gem Version](https://badge.fury.io/rb/spree_store_pickup.svg)](https://badge.fury.io/rb/spree_store_pickup)
 
@@ -8,26 +8,59 @@ This is a Store Pickup extension for [Spree Commerce](https://spreecommerce.org)
 
 1. Add this extension to your Gemfile with this line:
 
-    ```ruby
+    ```bash
     bundle add spree_store_pickup
     ```
 
-2. Install the migrations:
-
-    ```sh
-    bundle exec rake railties:install:migrations FROM=spree_store_pickup
-    ```
-
-3. Run the migrations:
+2. Run the install generator
 
-    ```sh
-    bundle exec rails db:migrate
+    ```bash
+    bundle exec rails g spree_store_pickup:install
     ```
 
-4. Restart your server
+3. Restart your server
 
   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:
+
+````ruby
+module Spree
+  module PaymentMethodDecorator
+    # Customize availability combining store pickup (and optionally COD) logic.
+    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
+
+      true
+    end
+  end
+
+  PaymentMethod.prepend PaymentMethodDecorator
+end
+````
+
 ## Developing
 
 1. Create a dummy app
@@ -38,6 +71,7 @@ This is a Store Pickup extension for [Spree Commerce](https://spreecommerce.org)
     ```
 
 2. Add your new code
+
 3. Run tests
 
     ```bash
@@ -53,7 +87,7 @@ require 'spree_store_pickup/factories'
 
 ## Releasing a new version
 
-```shell
+```bash
 bundle exec gem bump -p -t
 bundle exec gem release
 ```
@@ -66,4 +100,4 @@ If you'd like to contribute, please take a look at the
 [instructions](CONTRIBUTING.md) for installing dependencies and crafting a good
 pull request.
 
-Copyright (c) 2025 OlympusOne, released under the MIT
+Copyright (c) 2025 OlympusOne, released under the AGPL-3.0 or later.

data/app/assets/config/spree_store_pickup_manifest.js

@@ -0,0 +1,5 @@
+//= link_tree ../images
+//= link spree_store_pickup/application.js
+//= link_tree ../../javascript/spree_store_pickup/controllers .js
+//= link_tree ../../../vendor/javascript .js
+//= link_tree ../../../vendor/stylesheets .css

data/app/javascript/spree_store_pickup/application.js

@@ -0,0 +1,16 @@
+import '@hotwired/turbo-rails'
+import { Application } from '@hotwired/stimulus'
+
+let application
+
+if (typeof window.Stimulus === "undefined") {
+  application = Application.start()
+  application.debug = false
+  window.Stimulus = application
+} else {
+  application = window.Stimulus
+}
+
+import SpreeStorePickupController from 'spree_store_pickup/controllers/spree_store_pickup_controller' 
+
+application.register('spree_store_pickup', SpreeStorePickupController)

data/app/javascript/spree_store_pickup/controllers/spree_store_pickup_controller.js

@@ -0,0 +1,7 @@
+import { Controller } from '@hotwired/stimulus'
+
+export default class extends Controller {
+  connect() {
+    // TODO: Add any initialization logic if needed
+  }
+}

data/app/models/spree/payment_method/store_pickup.rb

@@ -8,6 +8,10 @@ module Spree
       Spree.t(:store_pickup_method)
     end
 
+    def payment_icon_name
+      'storecredit'
+    end
+
     def source_required?
       false
     end

data/app/models/spree/payment_method_decorator.rb

@@ -8,6 +8,6 @@ module Spree
       order.shipping_method&.store_pickup?
     end
   end
-end
 
-Spree::PaymentMethod.prepend Spree::PaymentMethodDecorator
+  PaymentMethod.prepend PaymentMethodDecorator
+end

data/app/views/spree/admin/shipping_methods/_store_pickup_form.html.erb

@@ -5,10 +5,6 @@
     </h5>
   </div>
   <div class="card-body">
-    <div class="custom-control custom-checkbox">
-      <%= f.check_box :store_pickup, class: 'custom-control-input' %>
-      <%= f.label :store_pickup, class: 'custom-control-label font-weight-semibold' %>
-      <%= f.error_message_on :store_pickup %>
-    </div>
+    <%= f.spree_check_box :store_pickup %>
   </div>
 </div>

data/app/views/spree_store_pickup/_head.html.erb

@@ -0,0 +1 @@
+<%= javascript_import_module_tag 'application-spree-store-pickup' %>

data/config/importmap.rb

@@ -0,0 +1,6 @@
+pin 'application-spree-store-pickup', to: 'spree_store_pickup/application.js', preload: false
+
+pin_all_from SpreeStorePickup::Engine.root.join('app/javascript/spree_store_pickup/controllers'),
+             under: 'spree_store_pickup/controllers',
+             to:    'spree_store_pickup/controllers',
+             preload: 'application-spree-store-pickup'

data/config/initializers/spree.rb

@@ -1,7 +1,7 @@
 Rails.application.config.after_initialize do
-  Rails.application.config.spree.payment_methods << Spree::PaymentMethod::StorePickup
+  Spree.payment_methods << Spree::PaymentMethod::StorePickup
 
-  Rails.application.config.spree_admin.shipping_method_form_partials << 'spree/admin/shipping_methods/store_pickup_form'
+  Spree.admin.partials.shipping_method_form << 'spree/admin/shipping_methods/store_pickup_form'
 
   Spree::PermittedAttributes.shipping_method_attributes << :store_pickup
 end

data/lib/spree_store_pickup/configuration.rb

@@ -0,0 +1,13 @@
+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]
+  end
+end

data/lib/spree_store_pickup/engine.rb

@@ -9,6 +9,23 @@ module SpreeStorePickup
       g.test_framework :rspec
     end
 
+    initializer 'spree_store_pickup.environment', before: :load_config_initializers do |_app|
+      SpreeStorePickup::Config = SpreeStorePickup::Configuration.new
+    end
+
+    initializer 'spree_store_pickup.assets' do |app|
+      app.config.assets.paths << root.join('app/javascript')
+      app.config.assets.paths << root.join('vendor/javascript')
+      app.config.assets.paths << root.join('vendor/stylesheets')
+      app.config.assets.precompile += %w[spree_store_pickup_manifest]
+    end
+
+    initializer 'spree_store_pickup.importmap', before: 'importmap' do |app|
+      app.config.importmap.paths << root.join('config/importmap.rb')
+      # https://github.com/rails/importmap-rails?tab=readme-ov-file#sweeping-the-cache-in-development-and-test
+      app.config.importmap.cache_sweepers << root.join('app/javascript')
+    end
+
     def self.activate
       Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
         Rails.configuration.cache_classes ? require(c) : load(c)

data/lib/spree_store_pickup/version.rb

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

data/lib/spree_store_pickup.rb

@@ -2,3 +2,4 @@ require 'spree_core'
 require 'spree_extension'
 require 'spree_store_pickup/engine'
 require 'spree_store_pickup/version'
+require 'spree_store_pickup/configuration'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_store_pickup
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.4
 platform: ruby
 authors:
 - OlympusOne
@@ -15,42 +15,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.4
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.4
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: spree_storefront
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.4
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.4
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: spree_admin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.4
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.4
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: spree_extension
   requirement: !ruby/object:Gem::Requirement
@@ -89,6 +89,9 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- app/assets/config/spree_store_pickup_manifest.js
+- 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/views/spree/admin/payment_methods/_store_pickup.html.erb
@@ -97,6 +100,8 @@ files:
 - app/views/spree/admin/shipping_methods/_store_pickup_form.html.erb
 - app/views/spree/admin/spree/checkout/payment/_store_pickup.html.erb
 - app/views/spree/checkout/payment/_store_pickup.html.erb
+- app/views/spree_store_pickup/_head.html.erb
+- config/importmap.rb
 - config/initializers/spree.rb
 - config/locales/el.yml
 - config/locales/en.yml
@@ -104,18 +109,19 @@ files:
 - db/migrate/20250601165042_add_store_pickup_to_shipping_methods.rb
 - lib/generators/spree_store_pickup/install/install_generator.rb
 - lib/spree_store_pickup.rb
+- lib/spree_store_pickup/configuration.rb
 - lib/spree_store_pickup/engine.rb
 - lib/spree_store_pickup/factories.rb
 - lib/spree_store_pickup/version.rb
 homepage: https://github.com/olympusone/spree_store_pickup
 licenses:
-- MIT
+- AGPL-3.0-or-later
 metadata:
   bug_tracker_uri: https://github.com/olympusone/spree_store_pickup/issues
-  changelog_uri: https://github.com/olympusone/spree_store_pickup/releases/tag/v1.0.1
+  changelog_uri: https://github.com/olympusone/spree_store_pickup/releases/tag/v1.1.4
   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.0.1
+  source_code_uri: https://github.com/olympusone/spree_store_pickup/tree/v1.1.4
 rdoc_options: []
 require_paths:
 - lib