spree_store_pickup 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8123b82bfe668da85ebfd3fedf96d394332317975903b566996d2c22916dff10
-  data.tar.gz: 43cbc7a531929c19a19e0ef232aba5b9d637a04ac906aa14af7255e0cdc16d23
+  metadata.gz: d02ed985c2068cff724a0e6f46d67839695b2b61d34200955475959e5a27719f
+  data.tar.gz: 6710d56720b1beab6a6876549ee05f89d24ad9969cfa5c3e7ab1e25cf378d31f
 SHA512:
-  metadata.gz: ec09f349f886fd0c7cf82ecc097608693148b973432a2e161afe6727f767e17208b29c1b4c4efa0f6f802385c731751a2928204b339776af8ad6c11800a85287
-  data.tar.gz: ebac7312474fbec9f4aaf27f0670dd51580e7fe445d8979e6b6ddbf516afa515174bdd9b723885f05852cbfaf940110c49b52a71269f9ebabdae848d9eb960c4
+  metadata.gz: 85d9824885ed2706e53b8dd0916a51070609b808597de131a1d649a2d02ab708ad99cecefd47d9dad8e28d8ce060db0626e808e6da22dfa2ec7c43aa6f32ed41
+  data.tar.gz: 44c0ff744bcdc62683045652a3d020422ec80b2db76bfbb6e6f970d4c06a1ecb14e2bc77d82a772c225c225b1e2ea6bbb46cb729dfa40f220e0ad5fcec4715ef

data/README.md

@@ -1,68 +1,90 @@
-# 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)
 
 ## Installation
 
-1. Add this extension to your Gemfile:
+1. Add this extension to your Gemfile with this line:
 
     ```bash
     bundle add spree_store_pickup
     ```
 
-2. Install the migrations:
+2. Run the install generator
 
     ```bash
-    bundle exec rake railties:install:migrations FROM=spree_store_pickup
+    bundle exec rails g spree_store_pickup:install
     ```
 
-3. Run the migrations:
+3. Restart your server
 
-    ```bash
-    bundle exec rails db:migrate
-    ```
+  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
 
-4. Restart your server
+  PaymentMethod.prepend PaymentMethodDecorator
+end
+````
 
 ## Developing
 
-1. Create a dummy app:
+1. Create a dummy app
 
     ```bash
     bundle update
     bundle exec rake test_app
     ```
 
-2. Add code.
+2. Add your new code
 
-3. Run tests:
+3. Run tests
 
     ```bash
     bundle exec rspec
     ```
 
-When testing your application's integration you may use its factories:
+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_store_pickup/factories'
 ```
 
-## Testing
-
-Generate the test app:
-
-```bash
-bundle exec rake test_app
-```
-
-Then run:
-
-```bash
-bundle exec rspec
-```
-
 ## Releasing a new version
 
 ```bash

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_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,8 +1,7 @@
 Rails.application.config.after_initialize do
-  Rails.application.config.spree.payment_methods << Spree::PaymentMethod::StorePickup
+  Spree.payment_methods << Spree::PaymentMethod::StorePickup
 
-  # Admin partials
-  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/engine.rb

@@ -13,6 +13,19 @@ module SpreeStorePickup
       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.1.3'.freeze
+  VERSION = '1.1.4'.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.3
+  version: 1.1.4
 platform: ruby
 authors:
 - OlympusOne
@@ -15,42 +15,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.8
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.8
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: spree_storefront
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.8
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.8
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: spree_admin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.8
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.8
+        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
@@ -113,10 +118,10 @@ licenses:
 - 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.1.3
+  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.1.3
+  source_code_uri: https://github.com/olympusone/spree_store_pickup/tree/v1.1.4
 rdoc_options: []
 require_paths:
 - lib