amazing-activist 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5a9d6f3426a86d93d6affd8f54d19f7f071cb5142636c1b3b6fc2a12fbe87b9
-  data.tar.gz: d53b13cc039dee609e0d2870c560932942d3aa38009b4e7a742f7ce7ad44e9df
+  metadata.gz: 290c18d206342a875bfadb61a6d1cda66e7df96a44ecda1379a18e3aefc187fd
+  data.tar.gz: d21e98ee9f606a7264cdf743f935f7c845832c884f86feef55076f8a3eae535f
 SHA512:
-  metadata.gz: '0549ced0fb0312fd5c4cca4cfc8ccaa0e359584c868497a5eea3caa7ad246958de12566d5f33525d555f6bbd9c3a77eb3536514d0e555b83a8a629048c3d58ff'
-  data.tar.gz: de8d63d94501dc73c61cc626e899407846af44dc8e9cb1c603e7154d57a57720adaa0897a319782a458ed9d89eff474a510777f5083206b9da902143f89060bd
+  metadata.gz: 3056d150ef3732e54396acd8915056cd20f5d11c6efc00eb3d131920deeaac92f42cbe5d92955e2667671fe3a14af93fc6cc495108fb797692b3280cb5449f7d
+  data.tar.gz: 68886df50e8d078f52b03804ec09f146d64f6fcc6ad27c1153bc71b078e2b9b49868e5bb496a3caef9708321c18fe088d371c8a9eb4f9b8a1c09d62365d84ced

data/CHANGES.md

@@ -0,0 +1,59 @@
+# 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.5.0] - 2023-03-13
+
+### Changed
+
+- (BREAKING) i18n does not remove `_activity` suffix from keys anymore, e.g.
+  for `Foo::BarActivity` expected i18n key will be `foo/bar_activity`, not
+  `foo/bar` as it was before.
+
+
+## [0.4.0] - 2024-02-19
+
+### Added
+
+- `Base.on_broken_outcome` allows registering custom handler for the broken
+  outcome contract (when `#call` returns neither `Success` nor `Failure`)
+- `Base.rescue_from` allows registering unhandled exception handlers.
+
+
+## [0.3.0] - 2024-02-19
+
+### Added
+
+- `UnwrapError#cause` respects failure's `#exception`.
+
+### Changed
+
+- (BREAKING) `Base#failure` context must be given as keyword argument.
+- (BREAKING) `Failure#message` is no longer part of its `#context`.
+- (BREAKING) `Failure#exception` is no longer part of its `#context`.
+
+
+## [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.5.0]: https://github.com/ixti/amazing-activist/compare/v0.4.0...v0.5.0
+[0.4.0]: https://github.com/ixti/amazing-activist/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/ixti/amazing-activist/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/ixti/amazing-activist/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/ixti/amazing-activist/tree/v0.1.0

data/lib/amazing_activist/base.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "./irresistible"
 require_relative "./outcome"
 
 module AmazingActivist
@@ -28,14 +29,7 @@ module AmazingActivist
   # 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)

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/locale/en.yml

@@ -1,4 +1,4 @@
 en:
   amazing_activist:
     failures:
-      not_implemented: "<%{activity}> activity has no implementation"
+      not_implemented: "<%{activity}> has no implementation"

data/lib/amazing_activist/locale/gl.yml

@@ -1,4 +1,4 @@
 gl:
   amazing_activist:
     failures:
-      not_implemented: "<%{activity}> actividade non ten implementación"
+      not_implemented: "<%{activity}> non ten implementación"

data/lib/amazing_activist/polyglot.rb

@@ -10,9 +10,6 @@ I18n.load_path += Dir[File.expand_path("#{__dir__}/locale/*.yml")]
 module AmazingActivist
   # @api internal
   class Polyglot
-    ANONYMOUS_ACTIVITY_NAME = "anonymous"
-    private_constant :ANONYMOUS_ACTIVITY_NAME
-
     def initialize(activity)
       @activity = activity
     end
@@ -25,26 +22,26 @@ module AmazingActivist
     # Thus, if activity `Pretty::DamnGoodActivity` failed with `:bad_choise`
     # code the lookup will be:
     #
-    # * `amazing_activist.activities.pretty/damn_good.failures.bad_choice
+    # * `amazing_activist.activities.pretty/damn_good_activity.failures.bad_choice
     # * `amazing_activist.failures.bad_choice
     #
     # If there's no translation with any of the above keys, a generic
     # non-translated message will be used:
     #
-    #     <pretty/damn_good> activity failed - bad_choice
+    #     <pretty/damn_good_activity> failed - bad_choice
     #
     # @return [String] Failure message
     def message(code, **context)
       default = [
         :"amazing_activist.failures.#{code}",
-        "<%{activity}> activity failed - %{code}" # rubocop:disable Style/FormatStringToken
+        "<%{activity}> failed - %{code}" # rubocop:disable Style/FormatStringToken
       ]
 
       if @activity.class.name
-        activity = @activity.class.name.underscore.presence.delete_suffix("_activity")
+        activity = @activity.class.name.underscore.presence
         i18n_key = :"amazing_activist.activities.#{activity}.failures.#{code}"
       else
-        activity = "(anonymous)"
+        activity = "(anonymous activity)"
         i18n_key = default.shift
       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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amazing-activist
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Alexey Zapparov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-19 00:00:00.000000000 Z
+date: 2024-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -45,18 +45,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGES.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
@@ -64,9 +69,9 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/ixti/amazing-activist
-  source_code_uri: https://github.com/ixti/amazing-activist/tree/v0.3.0
+  source_code_uri: https://github.com/ixti/amazing-activist/tree/v0.5.0
   bug_tracker_uri: https://github.com/ixti/amazing-activist/issues
-  changelog_uri: https://github.com/ixti/amazing-activist/blob/v0.3.0/CHANGES.md
+  changelog_uri: https://github.com/ixti/amazing-activist/blob/v0.5.0/CHANGES.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []