solidus_support 0.13.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b29adfe3ba04b222f4644fb12d8e26d4b77f1f438d75ed4fe72873b2c29b1301
-  data.tar.gz: b5e87fb3449a317d500bc0a87d8e45f0efafbac61c825363dc2bf0dcf8374ed9
+  metadata.gz: f806b6a51765583aba92e5da3dc943006b383572af0aaf02d1aba0ecce33ed5a
+  data.tar.gz: 46bb34278a3de81f7af8e2d90c4a3852430f204248904e37df898fbff4bac874
 SHA512:
-  metadata.gz: b0303b76dab3ad82ff50fe85cc4508c5750241a06a2d179a2feacf005c402017c1f15488e3eb1082147449d96ea040e5a3fd2df09bd74c675d9ceef7c87906f6
-  data.tar.gz: '068a4e6077b32e4e3a78577912fbcfbad23fede909822cb9c6a26d5d1f5346bc753d07ed38dd17cadf1e4787431b1032fc2551ea023c44a0974d75f7d7890680'
+  metadata.gz: a2ffa3274fb6a3bb433a50de1051083567c11b79d770281cd7001b2aca0b184c8ffb6c3f08c2f67c82c34fee941260e3f270e0b7ef7a689e7bb7d090fb40edbb
+  data.tar.gz: a8d1e98aa2fbc7657c0d2c78a84597c6950ca7618b26dd5b1c57a3dd24ea34fdbf80020bc6bbb7e0b5a70d7eb88a42782ebcc38e60dd3ee68d78102f968f8e98

data/README.md

@@ -1,3 +1,5 @@
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/solidusio/solidus_support/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/solidusio/solidus_support/tree/main)
+
 # SolidusSupport
 
 This gem contains common runtime functionality for Solidus extensions.

data/lib/solidus_support/engine_extensions.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_support/deprecation"
+require "flickwerk"
 
 module SolidusSupport
   module EngineExtensions
@@ -9,6 +10,7 @@ module SolidusSupport
 
     def self.included(engine)
       engine.extend ClassMethods
+      engine.include Flickwerk
 
       engine.class_eval do
         solidus_decorators_root.glob('*') do |decorators_folder|
@@ -35,16 +37,16 @@ module SolidusSupport
       # This allows to add event subscribers to extensions without explicitly subscribing them,
       # similarly to what happens in Solidus core.
       def load_solidus_subscribers_from(path)
-        if SolidusSupport::LegacyEventCompat.using_legacy?
-          path.glob("**/*_subscriber.rb") do |subscriber_path|
-            require_dependency(subscriber_path)
-          end
+        return unless SolidusSupport::LegacyEventCompat.using_legacy?
 
-          if Spree::Event.respond_to?(:activate_all_subscribers)
-            Spree::Event.activate_all_subscribers
-          else
-            Spree::Event.subscribers.each(&:subscribe!)
-          end
+        path.glob("**/*_subscriber.rb") do |subscriber_path|
+          require_dependency(subscriber_path)
+        end
+
+        if Spree::Event.respond_to?(:activate_all_subscribers)
+          Spree::Event.activate_all_subscribers
+        else
+          Spree::Event.subscribers.each(&:subscribe!)
         end
       end
 
@@ -102,7 +104,7 @@ module SolidusSupport
         # by those gems, we work around those gems by adding our paths before
         # `initialize_cache`, which is the Rails initializer called before
         # `set_load_path`.
-        initializer "#{name}_#{engine}_paths", before: :initialize_cache do
+        initializer "#{engine_name}_#{engine}_paths", before: :initialize_cache do
           if SolidusSupport.send(:"#{engine}_available?")
             paths['app/controllers'] << "lib/controllers/#{engine}"
             paths['app/views'] << "lib/views/#{engine}"
@@ -111,9 +113,11 @@ module SolidusSupport
 
         if SolidusSupport.send(:"#{engine}_available?")
           decorators_path = root.join("lib/decorators/#{engine}")
+          patches_path = root.join("lib/patches/#{engine}")
           controllers_path = root.join("lib/controllers/#{engine}")
           components_path = root.join("lib/components/#{engine}")
           config.autoload_paths += decorators_path.glob('*')
+          config.autoload_paths += patches_path.glob("*")
           config.autoload_paths << controllers_path if controllers_path.exist?
           config.autoload_paths << components_path if components_path.exist?
 
@@ -124,6 +128,36 @@ module SolidusSupport
             end
           end
         end
+
+        initializer "#{engine_name}_#{engine}_patch_paths" do
+          if SolidusSupport.send(:"#{engine}_available?")
+            patch_paths = root.join("lib/patches/#{engine}").glob("*")
+            Flickwerk.patch_paths += patch_paths
+          end
+        end
+
+        initializer "#{engine_name}_#{engine}_user_patches" do |app|
+          app.reloader.to_prepare do
+            Flickwerk.aliases["Spree.user_class"] = if Spree.respond_to?(:user_class_name)
+                                                      Spree.user_class_name
+                                                    else
+                                                      Spree.user_class.name
+                                                    end
+          end
+        end
+
+        initializer "eager_load_#{engine_name}_#{engine}_patches" do |app|
+          # Solidus versions < 4.5 `require` some of their application code.
+          # This leads to hard-to-debug problems with Flickwerk patches.
+          # What this does is eager-load all the patches in a `to_prepare`
+          # hook by constantizing them.
+          # You can override this behavior by setting the environment variable `SOLIDUS_LAZY_LOAD_PATCHES`.
+          if Spree.solidus_gem_version < Gem::Version.new("4.5.0.a") && !ENV["SOLIDUS_LAZY_LOAD_PATCHES"]
+            app.reloader.to_prepare do
+              Flickwerk.patches.each_value { _1.each(&:constantize) }
+            end
+          end
+        end
       end
     end
   end

data/lib/solidus_support/legacy_event_compat/bus.rb

@@ -23,6 +23,10 @@ module SolidusSupport
       # @param event_name [Symbol]
       # @param payload [Hash<Symbol, Any>]
       def self.publish(event_name, **payload)
+        SolidusSupport.deprecator.warn(
+          "SolidusSupport::LegacyEventCompat::Bus is deprecated and will be removed in solidus_support 1.0." \
+          " Please use Spree::Bus.publish instead."
+        )
         if SolidusSupport::LegacyEventCompat.using_legacy?
           Spree::Event.fire(event_name, payload)
         else

data/lib/solidus_support/legacy_event_compat/subscriber.rb

@@ -41,6 +41,10 @@ module SolidusSupport
       end
 
       def self.included(legacy_subscriber)
+        SolidusSupport.deprecator.warn(
+          "SolidusSupport::LegacyEventCompat::Subscriber is deprecated and will be removed in solidus_support 1.0." \
+          " Please `include Omnes::Subscriber` in `#{legacy_subscriber.name}` instead."
+        )
         legacy_subscriber.define_singleton_method(:omnes_subscriber) do
           @omnes_subscriber ||= Class.new.include(::Omnes::Subscriber).tap do |subscriber|
             legacy_subscriber.event_actions.each do |(legacy_subscriber_method, event_name)|

data/lib/solidus_support/migration.rb

@@ -3,15 +3,10 @@
 module SolidusSupport
   module Migration
     def self.[](version)
-      if Rails.gem_version >= Gem::Version.new('5.x')
-        ActiveRecord::Migration[version]
-      else
-        # Rails < 5 doesn't support specifying rails version of migrations, but
-        # it _is_ rails 4.2, so we can use that when requested.
-        return ActiveRecord::Migration if version.to_s == '4.2'
-
-        raise ArgumentError, "Unknown migration version '#{version}'; expected one of '4.2'"
-      end
+      SolidusSupport.deprecator.warn(
+        "SolidusSupport::Migration[#{version}] is deprecated. Please use ActiveRecord::Migration[#{version}] instead."
+      )
+      ActiveRecord::Migration[version]
     end
   end
 end

data/lib/solidus_support/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidusSupport
-  VERSION = '0.13.0'
+  VERSION = '0.14.1'
 end

data/solidus_support.gemspec

@@ -28,6 +28,9 @@ Gem::Specification.new do |spec|
   spec.executables = files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'flickwerk', '~> 0.3.4'
+  spec.add_dependency 'solidus_core', '~> 4.1'
+
   spec.add_development_dependency 'rails'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

data/spec/support/dummy_app.rb

@@ -14,9 +14,6 @@ module DummyApp
   class Application < ::Rails::Application
     config.eager_load               = false
     config.paths['config/database'] = File.expand_path('dummy_app/database.yml', __dir__)
-    if ActiveRecord::VERSION::MAJOR >= 7 && ActiveRecord::VERSION::MINOR < 1
-      config.active_record.legacy_connection_handling = false
-    end
   end
 end
 

metadata

@@ -1,16 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: solidus_support
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.1
 platform: ruby
 authors:
 - John Hawthorn
 - Solidus Team
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-13 00:00:00.000000000 Z
+date: 2025-02-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: flickwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+- !ruby/object:Gem::Dependency
+  name: solidus_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +150,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.2
-description:
 email: contact@solidus.io
 executables: []
 extensions: []
@@ -165,7 +191,6 @@ metadata:
   homepage_uri: https://github.com/solidusio/solidus_support
   source_code_uri: https://github.com/solidusio/solidus_support
   changelog_uri: https://github.com/solidusio/solidus_support/releases
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -180,8 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Common runtime helpers for Solidus extensions.
 test_files: