amazing-activist 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f315ef7e7d9f2042299846f98243c0ba5b316cf5421d3c8f6d01f3340ed49b91
-  data.tar.gz: ec30a1a3f6f72d3c0daa5160af6e388b3a1f1d4a1110922c3730bf3ddc3da6d1
+  metadata.gz: ccad58a6e900c0d926811f0f5520a807665c3966efff845ac4359c00493cf0cf
+  data.tar.gz: 79b51504d7c1bea9dc76bcefe0d78697d7a3e30f15bd21c3dac8684ebaf81dac
 SHA512:
-  metadata.gz: 6d1a627bdd3555b90c232198db69b73da0cb6e3f51d6c4295e668ddb571fcce94bbe8d1f16d399622a5704cd2cf9c0e7e6e3a83d61bb7c5fa4595b85256f3153
-  data.tar.gz: de4a7d7cb65e4ab08d1c80b23fae22b11a86b225e578e07a03bd7e18bf78202d7a5c5a6bdae0436d5d77f1726464f99a564701d9734fef1dd02842d19ae2c8d2
+  metadata.gz: 36d6f413e5a39dbde9bf7c0aa6ef40bb58f438096ba659963536c7a2c059c135a00f88f765058edfdb53bdc572352f48f5ac6ebd3d7e4444205b9c34c85ccf51
+  data.tar.gz: 56347f7ea9356a1edfdff9f41816b34036f25184ccc7e102ebb11524371b7e3e2e1f134d17bf6644c47ebc7ffd1f36fc369f12f438c62571837f9ae48e8684b2

data/README.adoc

@@ -24,7 +24,7 @@ Or install it yourself as:
 
 [source,ruby]
 ----
-class ApplicationActivity < AmazingActivist::Activity
+class ApplicationActivity < AmazingActivist::Base
 end
 
 class OnboardingActivity < ApplicationActivity

data/lib/amazing_activist/base.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "./irresistible"
 require_relative "./outcome"
 
 module AmazingActivist
@@ -18,16 +19,17 @@ module AmazingActivist
   #     failure(:invalid_params, user: user)
   #   end
   # end
+  #
+  # case OnboardActivity.call(email: "user@example.com")
+  # in success: user
+  #   Current.user = user
+  #   redirect_to dashboard_url
+  # else
+  #   render :new, status: :unprocessable_entity
+  # end
   # ----
   class Base
-    class << self
-      # Convenience method to initialize and immediatelly call the activity.
-      # @see #initialize
-      # @see #call
-      def call(...)
-        new(...).call
-      end
-    end
+    extend Irresistible
 
     # @param params [Hash{Symbol => Object}]
     def initialize(**params)
@@ -53,8 +55,8 @@ module AmazingActivist
     # @param code (see Outcome::Failure#initialize)
     # @param context (see Outcome::Failure#initialize)
     # @return [Outcome::Failure]
-    def failure(code, **context)
-      Outcome::Failure.new(code, activity: self, context: context)
+    def failure(code, message: nil, exception: nil, context: {})
+      Outcome::Failure.new(code, activity: self, message: message, exception: exception, context: context)
     end
   end
 end

data/lib/amazing_activist/broken_contract_error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "./error"
+
+module AmazingActivist
+  class BrokenContractError < Error; end
+end

data/lib/amazing_activist/contractable.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "./broken_contract_error"
+
+module AmazingActivist
+  module Contractable
+    DEFAULT_BROKEN_OUTCOME_HANDLER = lambda do |outcome|
+      raise BrokenContractError, "#{self.class}#call returned #{outcome.class} instead of Outcome"
+    end
+    private_constant :DEFAULT_BROKEN_OUTCOME_HANDLER
+
+    protected
+
+    # @api internal
+    def broken_contract_handler
+      return @broken_contract_handler if defined?(@broken_contract_handler)
+
+      ancestors.each do |klass|
+        next unless klass < Base && klass != self
+
+        return @broken_contract_handler = klass.broken_contract_handler
+      end
+
+      @broken_contract_handler = DEFAULT_BROKEN_OUTCOME_HANDLER
+    end
+
+    private
+
+    def on_broken_outcome(&block)
+      raise ArgumentError, "Handler block required." unless block
+
+      @broken_contract_handler = block
+    end
+  end
+end

data/lib/amazing_activist/irresistible.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "./broken_contract_error"
+require_relative "./contractable"
+require_relative "./rescuable"
+require_relative "./unwrap_error"
+
+module AmazingActivist
+  module Irresistible
+    include Contractable
+    include Rescuable
+
+    # Initialize and call activity.
+    #
+    # @see #initialize
+    # @see #call
+    def call(...)
+      activity = new(...)
+      outcome  = irresistible_call(activity)
+
+      unless outcome.is_a?(Outcome::Failure) || outcome.is_a?(Outcome::Success)
+        return activity.instance_exec(outcome, &broken_contract_handler)
+      end
+
+      outcome
+    end
+
+    private
+
+    # @api internal
+    def irresistible_call(activity)
+      activity.call
+    rescue UnwrapError => e
+      e.failure
+    rescue Exception => e # rubocop:disable Lint/RescueException
+      handler = rescue_handler_for(e)
+      raise unless handler
+
+      activity.instance_exec(e, &handler)
+    end
+  end
+end

data/lib/amazing_activist/outcome/failure.rb

@@ -9,19 +9,26 @@ module AmazingActivist
       # @return [Symbol]
       attr_reader :code
 
-      # @return [AmazingActivist::Activity]
+      # @return [AmazingActivist::Base]
       attr_reader :activity
 
-      # @return [Hash{Symbol => Object}]
+      # @return [Exception, nil]
+      attr_reader :exception
+
+      # @return [Hash]
       attr_reader :context
 
       # @param code [#to_sym]
       # @param activity [AmazingActivist::Activity]
-      # @param context [Hash{Symbol => Object}]
-      def initialize(code, activity:, context:)
-        @code     = code.to_sym
-        @activity = activity
-        @context  = context
+      # @param message [#to_s, nil]
+      # @param exception [Exception, nil]
+      # @param context [Hash]
+      def initialize(code, activity:, message:, exception:, context:)
+        @code      = code.to_sym
+        @activity  = activity
+        @message   = message&.to_s
+        @exception = exception
+        @context   = context
       end
 
       # @return [true]
@@ -35,15 +42,15 @@ module AmazingActivist
       end
 
       # @api internal
-      # @return [Array<(:failure, Symbol, AmazingActivist::Activity, Hash{Symbol => Object})>]
+      # @return [Array]
       def deconstruct
-        [:failure, @code, @activity, @context]
+        [:failure, @code, @activity]
       end
 
       # @api internal
-      # @return [Hash{success: Object, activity: AmazingActivist::Activity}]
+      # @return [Hash]
       def deconstruct_keys(_)
-        { failure: @code, activity: @activity, context: @context }
+        { failure: @code, activity: @activity, message: message, exception: exception, context: context }
       end
 
       # @yieldparam self [self]
@@ -56,8 +63,11 @@ module AmazingActivist
         raise UnwrapError, self
       end
 
+      # Failure message.
+      #
+      # @return [String]
       def message
-        @context.fetch(:message) { Polyglot.new(@activity).message(@code, **context) }
+        @message || Polyglot.new(@activity).message(@code, **context)
       end
     end
   end

data/lib/amazing_activist/outcome/success.rb

@@ -3,11 +3,11 @@
 module AmazingActivist
   module Outcome
     class Success
-      # @return [AmazingActivist::Activity]
+      # @return [AmazingActivist::Base]
       attr_reader :activity
 
       # @param value [Object]
-      # @param activity [AmazingActivist::Activity]
+      # @param activity [AmazingActivist::Base]
       def initialize(value, activity:)
         @value    = value
         @activity = activity
@@ -24,13 +24,13 @@ module AmazingActivist
       end
 
       # @api internal
-      # @return [Array<(:success, Object, AmazingActivist::Activity)>]
+      # @return [Array]
       def deconstruct
         [:success, @value, @activity]
       end
 
       # @api internal
-      # @return [Hash{success: Object, activity: AmazingActivist::Activity}]
+      # @return [Hash]
       def deconstruct_keys(_)
         { success: @value, activity: @activity }
       end

data/lib/amazing_activist/rescuable.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module AmazingActivist
+  module Rescuable
+    protected
+
+    # @api internal
+    def rescue_handlers
+      return @rescue_handlers if defined?(@rescue_handlers)
+
+      ancestors.each do |klass|
+        next unless klass < Base && klass != self
+
+        return @rescue_handlers = klass.rescue_handlers
+      end
+
+      @rescue_handlers = [].freeze
+    end
+
+    # @api internal
+    def rescue_handlers=(new_handlers)
+      @rescue_handlers = new_handlers.freeze
+    end
+
+    private
+
+    def rescue_from(*klasses, &block)
+      raise ArgumentError, "Handler block required." unless block
+
+      klasses.each do |klass|
+        klass_name =
+          case klass
+          when Module then klass.name
+          when String then klass
+          else raise ArgumentError, "#{klass.inspect} must be an Exception class or a String referencing a class."
+          end
+
+        self.rescue_handlers += [[klass_name, block].freeze]
+      end
+    end
+
+    # @api internal
+    def rescue_handler_for(exception)
+      while exception
+        rescue_handlers.reverse_each do |klass, handler|
+          return handler if exception.is_a?(const_get(klass))
+        rescue StandardError
+          # do nothing
+        end
+
+        exception = exception.cause
+      end
+
+      nil
+    end
+  end
+end

data/lib/amazing_activist/unwrap_error.rb

@@ -13,5 +13,10 @@ module AmazingActivist
 
       super(failure.message)
     end
+
+    # @return [Exception, nil]
+    def cause
+      @failure.exception || super
+    end
   end
 end

data/lib/amazing_activist/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AmazingActivist
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amazing-activist
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Alexey Zapparov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-28 00:00:00.000000000 Z
+date: 2024-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -45,19 +45,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
 - LICENSE.txt
 - README.adoc
 - lib/amazing-activist.rb
 - lib/amazing_activist.rb
 - lib/amazing_activist/base.rb
+- lib/amazing_activist/broken_contract_error.rb
+- lib/amazing_activist/contractable.rb
 - lib/amazing_activist/error.rb
+- lib/amazing_activist/irresistible.rb
 - lib/amazing_activist/locale/en.yml
 - lib/amazing_activist/locale/gl.yml
 - lib/amazing_activist/outcome.rb
 - lib/amazing_activist/outcome/failure.rb
 - lib/amazing_activist/outcome/success.rb
 - lib/amazing_activist/polyglot.rb
+- lib/amazing_activist/rescuable.rb
 - lib/amazing_activist/unwrap_error.rb
 - lib/amazing_activist/version.rb
 homepage: https://github.com/ixti/amazing-activist
@@ -65,9 +68,9 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/ixti/amazing-activist
-  source_code_uri: https://github.com/ixti/amazing-activist/tree/v0.2.0
+  source_code_uri: https://github.com/ixti/amazing-activist/tree/v0.4.0
   bug_tracker_uri: https://github.com/ixti/amazing-activist/issues
-  changelog_uri: https://github.com/ixti/amazing-activist/blob/v0.2.0/CHANGES.md
+  changelog_uri: https://github.com/ixti/amazing-activist/blob/v0.4.0/CHANGES.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -84,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: Your friendly neighborhood activist.

data/CHANGELOG.md

@@ -1,25 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-
-## [0.2.0] - 2024-01-28
-
-## Added
-
-- Generate default failure messages with
-  [i18n](https://github.com/ruby-i18n/i18n).
-
-
-## [0.1.0] - 2024-01-27
-
-## Added
-
-- Initial release.
-
-[0.1.0]: https://github.com/ixti/sidekiq-antidote/tree/v0.1.0