amazing-activist 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8cba9d28e25f87ba33a43233f981a13826c716db8342fa1df5a39ed14ca59c1
-  data.tar.gz: bcda1343f32f2df0aec0e3aaa806f602b98410e9a54d4a79214859f21830d275
+  metadata.gz: b5a9d6f3426a86d93d6affd8f54d19f7f071cb5142636c1b3b6fc2a12fbe87b9
+  data.tar.gz: d53b13cc039dee609e0d2870c560932942d3aa38009b4e7a742f7ce7ad44e9df
 SHA512:
-  metadata.gz: c57c413901c0323f40a153d42a4b22be48281a1f6e76ceb2065cc94aed379a3d69238dfddde3537fa3ded78e573c3c9a168fcd76eb1c2547ed228b3b622f47cd
-  data.tar.gz: 9d37d65dc06c8a8784b4bc9ea4d6c1c2d72798cfea742e292e8a4d0847451dc851024a0fef330889d27d56313d944107354dc0a7dd300aed01859bc1d67383b9
+  metadata.gz: '0549ced0fb0312fd5c4cca4cfc8ccaa0e359584c868497a5eea3caa7ad246958de12566d5f33525d555f6bbd9c3a77eb3536514d0e555b83a8a629048c3d58ff'
+  data.tar.gz: de8d63d94501dc73c61cc626e899407846af44dc8e9cb1c603e7154d57a57720adaa0897a319782a458ed9d89eff474a510777f5083206b9da902143f89060bd

data/README.adoc

@@ -1,4 +1,13 @@
 = AmazingActivist
+:ci-url: https://github.com/ixti/amazing-activist/actions/workflows/ci.yml?query=branch%3Amain
+:ci-img: https://github.com/ixti/amazing-activist/actions/workflows/ci.yml/badge.svg?branch=main
+:codecov-url: https://codecov.io/gh/ixti/amazing-activist/tree/main
+:codecov-img: https://codecov.io/gh/ixti/amazing-activist/graph/badge.svg?token=LXaGWwv5xl
+
+ifdef::env-github[]
+{ci-url}[image:{ci-img}[CI]]
+{codecov-url}[image:{codecov-img}[codecov]]
+endif::[]
 
 == Installation
 
@@ -15,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/{activity.rb → base.rb}

@@ -9,7 +9,7 @@ module AmazingActivist
   #
   # [source,ruby]
   # ----
-  # class OnboardActivity < AmazingActivist::Activity
+  # class OnboardActivity < AmazingActivist::Base
   #   def call
   #     user = User.new(params)
   #
@@ -18,8 +18,16 @@ 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 Activity
+  class Base
     class << self
       # Convenience method to initialize and immediatelly call the activity.
       # @see #initialize
@@ -53,8 +61,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/locale/en.yml

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

data/lib/amazing_activist/locale/gl.yml

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

data/lib/amazing_activist/outcome/failure.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "../polyglot"
 require_relative "../unwrap_error"
 
 module AmazingActivist
@@ -8,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]
@@ -34,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]
@@ -55,8 +63,11 @@ module AmazingActivist
         raise UnwrapError, self
       end
 
+      # Failure message.
+      #
+      # @return [String]
       def message
-        "#{@activity.class} failed with #{@code}"
+        @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/polyglot.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/string/inflections"
+
+require "i18n"
+
+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
+
+    # The i18n key for the message will be looked in namespaces:
+    #
+    # * `amazing_activist.activities.[activity].failures`
+    # * `amazing_activist.failures`
+    #
+    # 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.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
+    #
+    # @return [String] Failure message
+    def message(code, **context)
+      default = [
+        :"amazing_activist.failures.#{code}",
+        "<%{activity}> activity failed - %{code}" # rubocop:disable Style/FormatStringToken
+      ]
+
+      if @activity.class.name
+        activity = @activity.class.name.underscore.presence.delete_suffix("_activity")
+        i18n_key = :"amazing_activist.activities.#{activity}.failures.#{code}"
+      else
+        activity = "(anonymous)"
+        i18n_key = default.shift
+      end
+
+      I18n.t(i18n_key, **context, default: default, activity: activity, code: code)
+    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.1.0"
+  VERSION = "0.3.0"
 end

data/lib/amazing_activist.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "./amazing_activist/activity"
+require_relative "./amazing_activist/base"
 require_relative "./amazing_activist/error"
 require_relative "./amazing_activist/outcome"
 require_relative "./amazing_activist/version"

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: amazing-activist
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Alexey Zapparov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-27 00:00:00.000000000 Z
-dependencies: []
+date: 2024-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Another take on Command Pattern.
 email:
 - alexey@zapparov.com
@@ -21,11 +49,14 @@ files:
 - README.adoc
 - lib/amazing-activist.rb
 - lib/amazing_activist.rb
-- lib/amazing_activist/activity.rb
+- lib/amazing_activist/base.rb
 - lib/amazing_activist/error.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/unwrap_error.rb
 - lib/amazing_activist/version.rb
 homepage: https://github.com/ixti/amazing-activist
@@ -33,9 +64,9 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/ixti/amazing-activist
-  source_code_uri: https://github.com/ixti/amazing-activist/tree/v0.1.0
+  source_code_uri: https://github.com/ixti/amazing-activist/tree/v0.3.0
   bug_tracker_uri: https://github.com/ixti/amazing-activist/issues
-  changelog_uri: https://github.com/ixti/amazing-activist/blob/v0.1.0/CHANGES.md
+  changelog_uri: https://github.com/ixti/amazing-activist/blob/v0.3.0/CHANGES.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []