use_cases 1.1.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34892c434db7409635d2628aee340dc76f71f2386c3b28c591b958d3fd7b9581
-  data.tar.gz: 922c959f22bbf32c82de1913a6384d46058eec701274dcaaee8dd5cb63fc09df
+  metadata.gz: c3434ac25b743c9794d09774344e6e2af73e4b2077a2d7d0aef31628ffc4a75d
+  data.tar.gz: de20ba12bb9a7ac43cf6bdb8ac35c96973de8b63f8cd90fee4b016e2e3459827
 SHA512:
-  metadata.gz: 8d2da877b7f1e0ad6e9cc01a560126110b8e53e9e1364b1cea07943318380c766499890b0bec5b67d8c3687742489f902cade0f76761cf6da693942cf01cc9c7
-  data.tar.gz: db808f18bb859f6f9faa2ac6aac8c6f5dcee9e820235e35b74bf5074fe262f7b477e2aa344c9d14d815b6739c2b47f7b530f3fdb8c84bf61c8f6407e41c6e237
+  metadata.gz: 8755ef9b16ab142c6fa1a2156f0c539d366195af5f065aa4b182dfa539fd973cb5d1f800d26c43c886f36bd8fa6c91e71955b612df229d4577b117b1455515a1
+  data.tar.gz: 8c89294d590c86a6f6126e309ca4011839fb5c236269623493f319bd55424d1aef026010f3ae7723ff62d229deb9ecec83a0d94c7efdbfdce327b285486d698b

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [2.0.0] - 2022-06-12
+
+- Removes `publishing` module from the DSL.
+
 ## [1.0.1] - 2021-12-19
 
 - Async published events are now suffixed by `".async"`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    use_cases (1.1.3)
+    use_cases (2.0.0)
       activesupport
       dry-events
       dry-matcher

data/README.md

@@ -22,7 +22,7 @@ In order to add optional modules (optins), use the following notation:
 
 ```ruby
 class Users::Create
-  include UseCase[:validated, :transactional, :publishing]
+  include UseCase[:validated, :transactional]
 end
 ```
 
@@ -68,7 +68,6 @@ end
 |---|---|
 | `:authorized` | Adds an extra `authorize` step macro, used to check user permissions. |
 | `:prepared` | Adds an extra `prepare` step macro, used to run some code before the use case runs. |
-| `:publishing` | Adds extra extra `publish`, `event_data` and `event_metadata` options to all steps, which allows a step to broadcast an event after executing | 
 | `:transactional` | Calls `#transaction` on a given `transaction_handler` object around the use case execution |
 | `:validated` | Adds all methods of `dry-transaction` to the use case DSL, which run validations on the received `params` object. | 
 
@@ -105,7 +104,7 @@ Defining a step can be done in the body of the use case.
 
 ```ruby
 class Users::DeleteAccount
-  include UseCases[:validated, :transactional, :publishing, :validated]
+  include UseCases[:validated, :transactional, :validated]
 
   step :do_something, {}
 ```
@@ -114,7 +113,7 @@ In real life, a simple use case would look something like:
 
 ```ruby
 class Users::DeleteAccount
-  include UseCases[:validated, :transactional, :publishing, :validated]
+  include UseCases[:validated, :transactional, :validated]
 
   params do
     required(:id).filled(:str?)
@@ -122,7 +121,7 @@ class Users::DeleteAccount
 
   authorize :user_owns_account?, failure_message: 'Cannot delete account'
   try :load_account, catch: ActiveRecord::RecordNotFound, failure: :account_not_found, failure_message: 'Account not found'
-  map :delete_account, publish: :account_deleted, event_data: proc { |account| { account_id: account.id } }, event_metadata: proc { { published_by: 'users.delete_account' } }
+  map :delete_account
   enqueue :send_farewell_email
 
   private 

data/lib/use_cases/module_optins.rb

@@ -3,7 +3,6 @@
 require "use_cases/module_optins/prepared"
 require "use_cases/module_optins/transactional"
 require "use_cases/module_optins/validated"
-require "use_cases/module_optins/publishing"
 require "use_cases/module_optins/authorized"
 
 module UseCases
@@ -15,7 +14,6 @@ module UseCases
       transactional: Transactional,
       validated: Validated,
       prepared: Prepared,
-      publishing: Publishing
     }.freeze
 
     def [](*options)

data/lib/use_cases/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module UseCases
-  VERSION = "1.1.4"
+  VERSION = "2.0.0"
 end

data/lib/use_cases.rb

@@ -16,7 +16,6 @@ module UseCases
   extend Dry::Configurable
 
   setting :container, reader: true
-  setting :publisher, default: ::UseCases::Events::Publisher.new, reader: true
   setting :subscribers, default: [], reader: true
   setting :dry_validation, default: ->(config) {}
   setting :transform_validation_errors, default: ->(errors) { errors.to_h }, reader: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: use_cases
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Ring Twice
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-06 00:00:00.000000000 Z
+date: 2022-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -161,14 +161,9 @@ files:
 - lib/use_case.rb
 - lib/use_cases.rb
 - lib/use_cases/dsl.rb
-- lib/use_cases/events/event_registry.rb
-- lib/use_cases/events/publish_job.rb
-- lib/use_cases/events/publisher.rb
-- lib/use_cases/events/subscriber.rb
 - lib/use_cases/module_optins.rb
 - lib/use_cases/module_optins/authorized.rb
 - lib/use_cases/module_optins/prepared.rb
-- lib/use_cases/module_optins/publishing.rb
 - lib/use_cases/module_optins/transactional.rb
 - lib/use_cases/module_optins/validated.rb
 - lib/use_cases/params.rb

data/lib/use_cases/events/event_registry.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module UseCases
-  module Events
-    class EventRegistry
-      def self.register(event_id)
-        event_ids << event_id
-        listener_name = ["on", event_id].join("_").gsub(".", "_")
-        UseCases.publisher.register_event(event_id)
-
-        UseCases.subscribers.each do |subscriber|
-          next if !subscriber.respond_to?(listener_name) || UseCases.publisher.subscribed?(subscriber.method(listener_name))
-
-          UseCases.publisher.subscribe(subscriber)
-        end
-      end
-
-      def self.event_ids
-        @event_ids ||= []
-      end
-    end
-  end
-end

data/lib/use_cases/events/publish_job.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-return unless defined? ActiveJob
-
-module UseCases
-  module Events
-    class PublishJob < ActiveJob::Base
-      def perform(event_id, payload)
-        event_id += ".async"
-        Events::EventRegistry.register(event_id)
-        UseCases.publisher.publish(event_id, payload)
-      end
-    end
-  end
-end

data/lib/use_cases/events/publisher.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require "dry/events/publisher"
-
-module UseCases
-  module Events
-    class Publisher
-      include Dry::Events::Publisher[:use_cases]
-
-      # This is a hack waiting for this https://github.com/dry-rb/dry-events/pull/15 to be merged
-      def subscribed?(listener)
-        __bus__.listeners.values.any? do |value|
-          value.any? do |block, _|
-            block.owner == listener.owner && block.name == listener.name
-          end
-        end
-      end
-
-      def publish(event_name, payload)
-        super
-        PublishJob.perform_later(event_name, payload) if defined?(PublishJob) && !event_name.to_s.end_with?(".async")
-      end
-    end
-  end
-end

data/lib/use_cases/events/subscriber.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module UseCases
-  module Events
-    module Subscriber
-      def self.included(base)
-        UseCases.subscribers << base.new
-      end
-
-      def should_subscribe_to?(event_name)
-        event_handler_name = "on_#{event_name.gsub(".", "_")}"
-
-        respond_to?(event_handler_name.to_sym)
-      end
-    end
-  end
-end

data/lib/use_cases/module_optins/publishing.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-require "use_cases/events/publisher"
-require "use_cases/events/subscriber"
-require "use_cases/events/publish_job"
-require "use_cases/events/event_registry"
-
-module UseCases
-  module ModuleOptins
-    module Publishing
-      def self.included(base)
-        super
-        StepAdapters::Abstract.prepend StepPatch
-      end
-
-      module StepPatch
-        def initialize(*)
-          super
-          return unless options[:publish]
-
-          %w[success failure].map do |event_type|
-            event_id = [options[:publish], event_type].join(".")
-            Events::EventRegistry.register(event_id)
-          end
-        end
-
-        def call(*args)
-          super(*args).tap do |result|
-            publish_step_result(result, args)
-          end
-        end
-
-        def publish_step_result(step_result, args)
-          return unless options[:publish]
-
-          key = extract_event_key(step_result)
-          payload = extract_payload(step_result, args)
-
-          UseCases.publisher.publish(key, payload)
-        end
-
-        private
-
-        def extract_payload(step_result, args)
-          value = step_result.value!
-          {
-            data: options[:event_data]&.call(value, args) || {},
-            metadata: options[:event_metadata]&.call(value, args) || {}
-          }
-        end
-
-        def extract_event_key(step_result)
-          options[:publish].to_s + (step_result.success? ? ".success" : ".failure")
-        end
-      end
-    end
-  end
-end