solidus_support 0.10.3 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3b8268a446799d2154688de5602aef63f7b5c2317c8584f4cf8f38cf30d3ce8
-  data.tar.gz: da32754eaa89c23b6938d6d1885f17b7d9718f58b32ffdcb10037a6aeb1dd3c5
+  metadata.gz: 791e44bf714cfc82303b07994a80c9fa72c94e2ad92bf0e50cbf6d7fd67a6124
+  data.tar.gz: a0b7e7d7d9e551d99bbc93f12e1e16bfce0ffb4b63ec5c908a52bbde8fe78565
 SHA512:
-  metadata.gz: 58003ca1bf85e2a62b50bafcb6352b726aaa2ec1bbba022b309796311440ee73d286d1e03ba6016a4d320f825aac8d38788fe07e7bbf51fe0f11d027c6f71251
-  data.tar.gz: 64e5be70aeb42c9173c6447cb5cd10d8c0aa155fb015c0b75c6c6236b790746046b66d91e898c2e8956c9b86ed395a18e5ebeca54fab56d4f21f19aaf3551375
+  metadata.gz: 53f1fef22c5003effc4611881f89a74da814fa354b68a23b70f96e00888dd0625f925cd41b60ec841cfb41ee2e91717bfd9e61e721c17e82aa30f2fe78a5bef5
+  data.tar.gz: 1f034253895ade97162295ef67797f0145b6c6ba153b3351f9a9fc83996dee4e926cd1f9ed9474478642d51760269aa2cf19185a43a10151d6d3a0cba89d7f85

data/lib/solidus_support/engine_extensions.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "active_support/deprecation"
+require "flickwerk"
+
 module SolidusSupport
   module EngineExtensions
     include ActiveSupport::Deprecation::DeprecatedConstantAccessor
@@ -7,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|
@@ -25,25 +29,6 @@ module SolidusSupport
     module ClassMethods
       def activate
         load_solidus_decorators_from(solidus_decorators_root)
-        load_solidus_subscribers_from(solidus_subscribers_root)
-      end
-
-      # Loads Solidus event subscriber files.
-      #
-      # 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
-
-          if Spree::Event.respond_to?(:activate_all_subscribers)
-            Spree::Event.activate_all_subscribers
-          else
-            Spree::Event.subscribers.each(&:subscribe!)
-          end
-        end
       end
 
       # Loads decorator files.
@@ -122,6 +107,17 @@ module SolidusSupport
             end
           end
         end
+
+        initializer "#{name}_#{engine}_patch_paths", before: "flickwerk.add_paths" do
+          patch_paths = root.join("lib/patches/#{engine}").glob("*")
+          Flickwerk.patch_paths += patch_paths
+        end
+
+        initializer "#{name}_#{engine}_user_patches", before: "flickwerk.add_patches" do
+          Flickwerk.patches.transform_keys! do |key|
+            key.gsub("Spree.user_class", Spree.user_class_name)
+          end
+        end
       end
     end
   end

data/lib/solidus_support/version.rb

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

data/lib/solidus_support.rb

@@ -3,7 +3,6 @@
 require 'solidus_support/version'
 require 'solidus_support/deprecator'
 require 'solidus_support/migration'
-require 'solidus_support/legacy_event_compat'
 require 'solidus_support/engine_extensions'
 require 'solidus_core'
 

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.2.0'
+  spec.add_dependency 'solidus_core', '~> 4.1'
+
   spec.add_development_dependency 'rails'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solidus_support
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 0.11.1
 platform: ruby
 authors:
 - John Hawthorn
@@ -9,8 +9,36 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-20 00:00:00.000000000 Z
+date: 2024-12-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: flickwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !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
@@ -146,14 +174,9 @@ files:
 - lib/solidus_support.rb
 - lib/solidus_support/deprecator.rb
 - lib/solidus_support/engine_extensions.rb
-- lib/solidus_support/legacy_event_compat.rb
-- lib/solidus_support/legacy_event_compat/bus.rb
-- lib/solidus_support/legacy_event_compat/subscriber.rb
 - lib/solidus_support/migration.rb
 - lib/solidus_support/version.rb
 - solidus_support.gemspec
-- spec/solidus_support/legacy_event_compat/bus_spec.rb
-- spec/solidus_support/legacy_event_compat/legacy_event_compat_spec.rb
 - spec/solidus_support_spec.rb
 - spec/spec_helper.rb
 - spec/support/dummy_app.rb
@@ -185,8 +208,6 @@ signing_key:
 specification_version: 4
 summary: Common runtime helpers for Solidus extensions.
 test_files:
-- spec/solidus_support/legacy_event_compat/bus_spec.rb
-- spec/solidus_support/legacy_event_compat/legacy_event_compat_spec.rb
 - spec/solidus_support_spec.rb
 - spec/spec_helper.rb
 - spec/support/dummy_app.rb

data/lib/solidus_support/legacy_event_compat/bus.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module SolidusSupport
-  module LegacyEventCompat
-    # Compatibility for some event-driven operations
-    module Bus
-      # Publication of an event
-      #
-      # If extensions want to support the legacy sytem, they need to use a
-      # compatible API. That means it's not possible to publish an instance as
-      # event, which is something supported by Omnes but not the legacy adapter.
-      # Instead, a payload can be given. E.g.:
-      #
-      # ```
-      # SolidusSupport::LegacyEventCompat::Bus.publish(:foo, bar: :baz)
-      # ```
-      #
-      # Legacy subscribers will receive an
-      # `ActiveSupport::Notifications::Fanout`, while omnes subscribers will get
-      # an `Omnes::UnstructuredEvent`. Both instances are compatible as they
-      # implement a `#payload` method.
-      #
-      # @param event_name [Symbol]
-      # @param payload [Hash<Symbol, Any>]
-      def self.publish(event_name, **payload)
-        if SolidusSupport::LegacyEventCompat.using_legacy?
-          Spree::Event.fire(event_name, payload)
-        else
-          Spree::Bus.publish(event_name, **payload, caller_location: caller_locations(1)[0])
-        end
-      end
-    end
-  end
-end

data/lib/solidus_support/legacy_event_compat/subscriber.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-begin
-  require "omnes"
-rescue LoadError
-end
-
-module SolidusSupport
-  module LegacyEventCompat
-    # Compatibility for subscriber modules
-    #
-    # Thanks to this module, extensions can create legacy subscriber modules
-    # (see {Spree::Event::Subscriber}) and translate them automatically to an
-    # {Omnes::Subscriber}). E.g.:
-    #
-    # ```
-    # module MyExtension
-    #   module MySubscriber
-    #     include Spree::Event::Subscriber
-    #     include SolidusSupport::LegacyEventCompat::Subscriber
-    #
-    #     event_action :order_finalized
-    #
-    #     def order_finalized(event)
-    #       event.payload[:order].do_something
-    #     end
-    #   end
-    # end
-    #
-    # MyExtension::MySubscriber.omnes_subscriber.subscribe_to(Spree::Bus)
-    # ```
-    #
-    # The generated omnes subscriptions will call the corresponding legacy
-    # subscriber method with the omnes event. It'll compatible as long as the
-    # omnes event responds to the `#payload` method (see
-    # {Omnes::UnstructuredEvent}).
-    module Subscriber
-      # @api private
-      ADAPTER = lambda do |legacy_subscriber, legacy_subscriber_method, _omnes_subscriber, omnes_event|
-        legacy_subscriber.send(legacy_subscriber_method, omnes_event)
-      end
-
-      def self.included(legacy_subscriber)
-        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)|
-              subscriber.handle(event_name.to_sym, with: ADAPTER.curry[legacy_subscriber, legacy_subscriber_method])
-            end
-          end.new
-        end
-      end
-    end
-  end
-end

data/lib/solidus_support/legacy_event_compat.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require 'solidus_support/legacy_event_compat/bus'
-require 'solidus_support/legacy_event_compat/subscriber'
-
-module SolidusSupport
-  # Compatibility middleman for {Spree::Event} and {Spree::Bus}
-  #
-  # Solidus v3.2 changed to use [Omnes](https://github.com/nebulab/omnes) as the
-  # backbone for event-driven behavior (see {Spree::Bus}) by default. Before
-  # that, a custom adapter based on {ActiveSupport::Notifications} was used (see
-  # {Spree::Event}. Both systems are still supported on v3.2.
-  #
-  # This module provides compatibility support so that extensions can easily
-  # target both systems regardless of the underlying circumstances:
-  #
-  # - Solidus v3.2 with the new system.
-  # - Solidus v3.2 with the legacy system.
-  # - Solidus v2.9 to v3.1, when only {Spree::Event} existed.
-  # - Possible future versions of Solidus, whether the legacy system is
-  # eventually removed or not.
-  module LegacyEventCompat
-    # Returns whether the application is using the legacy event system
-    #
-    # @return [Boolean]
-    def self.using_legacy?
-      legacy_present? &&
-        (legacy_alone? ||
-         legacy_chosen?)
-    end
-
-    def self.legacy_present?
-      defined?(Spree::Event)
-    end
-    private_class_method :legacy_present?
-
-    def self.legacy_alone?
-      !Spree::Config.respond_to?(:use_legacy_events)
-    end
-    private_class_method :legacy_alone?
-
-    def self.legacy_chosen?
-      Spree::Config.use_legacy_events
-    end
-    private_class_method :legacy_chosen?
-  end
-end

data/spec/solidus_support/legacy_event_compat/bus_spec.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe SolidusSupport::LegacyEventCompat::Bus do
-  describe '#publish' do
-    if SolidusSupport::LegacyEventCompat.using_legacy?
-      it 'forwards to Spree::Event' do
-        box = nil
-        subscription = Spree::Event.subscribe(:foo) { |event| box = event.payload[:bar] }
-
-        described_class.publish(:foo, bar: :baz)
-
-        expect(box).to be(:baz)
-      ensure
-        Spree::Event.unsubscribe(subscription)
-      end
-    else
-      it 'forwards to Spree::Bus' do
-        box = nil
-        Spree::Bus.register(:foo)
-        subscription = Spree::Bus.subscribe(:foo) { |event| box = event.payload[:bar] }
-
-        described_class.publish(:foo, bar: :baz)
-
-        expect(box).to be(:baz)
-      ensure
-        Spree::Bus.unsubscribe(subscription)
-        Spree::Bus.registry.unregister(:foo)
-      end
-    end
-  end
-end

data/spec/solidus_support/legacy_event_compat/legacy_event_compat_spec.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-require 'omnes'
-
-RSpec.describe SolidusSupport::LegacyEventCompat::Subscriber, if: Spree.solidus_version < Gem::Version.new("4.0.0.dev") do
-  subject { Module.new.include(Spree::Event::Subscriber).include(described_class) }
-
-  describe '#omnes_subscriber' do
-    it 'returns an Omnes::Subscriber' do
-      subject.module_eval do
-        event_action :foo
-
-        def foo(_event); end
-      end
-
-      expect(subject.omnes_subscriber.is_a?(Omnes::Subscriber)).to be(true)
-    end
-
-    it 'adds single-event definitions matching legacy event actions' do
-      subject.module_eval do
-        event_action :foo
-
-        def foo(_event); end
-      end
-      bus = Omnes::Bus.new
-      bus.register(:foo)
-
-      subscriptions = subject.omnes_subscriber.subscribe_to(bus)
-
-      event = Struct.new(:omnes_event_name).new(:foo)
-      expect(subscriptions.first.matches?(event)).to be(true)
-    end
-
-    it 'coerces event names given as Strings' do
-      subject.module_eval do
-        event_action 'foo'
-
-        def foo(_event); end
-      end
-      bus = Omnes::Bus.new
-      bus.register(:foo)
-
-      subscriptions = subject.omnes_subscriber.subscribe_to(bus)
-
-      event = Struct.new(:omnes_event_name).new(:foo)
-      expect(subscriptions.first.matches?(event)).to be(true)
-    end
-
-    it 'executes legacy event action methods as handlers with the omnes event' do
-      subject.module_eval do
-        event_action :foo
-
-        def foo(event)
-          event[:bar]
-        end
-      end
-      bus = Omnes::Bus.new
-      bus.register(:foo)
-
-      subscriptions = subject.omnes_subscriber.subscribe_to(bus)
-
-      expect(
-        bus.publish(:foo, bar: :baz).executions.first.result
-      ).to be(:baz)
-    end
-
-    it 'distingish when event name is given explicitly' do
-      subject.module_eval do
-        event_action :foo, event_name: :bar
-
-        def foo(_event)
-          :bar
-        end
-      end
-      bus = Omnes::Bus.new
-      bus.register(:bar)
-
-      subscriptions = subject.omnes_subscriber.subscribe_to(bus)
-
-      expect(
-        bus.publish(:bar).executions.first.result
-      ).to be(:bar)
-    end
-
-    it "returns the same omnes subscriber instance if called again" do
-      expect(subject.omnes_subscriber).to be(subject.omnes_subscriber)
-    end
-
-    it "doesn't fail when no event action has been defined" do
-      expect { subject.omnes_subscriber }.not_to raise_error
-    end
-  end
-end