amazing-activist 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8cba9d28e25f87ba33a43233f981a13826c716db8342fa1df5a39ed14ca59c1
-  data.tar.gz: bcda1343f32f2df0aec0e3aaa806f602b98410e9a54d4a79214859f21830d275
+  metadata.gz: f315ef7e7d9f2042299846f98243c0ba5b316cf5421d3c8f6d01f3340ed49b91
+  data.tar.gz: ec30a1a3f6f72d3c0daa5160af6e388b3a1f1d4a1110922c3730bf3ddc3da6d1
 SHA512:
-  metadata.gz: c57c413901c0323f40a153d42a4b22be48281a1f6e76ceb2065cc94aed379a3d69238dfddde3537fa3ded78e573c3c9a168fcd76eb1c2547ed228b3b622f47cd
-  data.tar.gz: 9d37d65dc06c8a8784b4bc9ea4d6c1c2d72798cfea742e292e8a4d0847451dc851024a0fef330889d27d56313d944107354dc0a7dd300aed01859bc1d67383b9
+  metadata.gz: 6d1a627bdd3555b90c232198db69b73da0cb6e3f51d6c4295e668ddb571fcce94bbe8d1f16d399622a5704cd2cf9c0e7e6e3a83d61bb7c5fa4595b85256f3153
+  data.tar.gz: de4a7d7cb65e4ab08d1c80b23fae22b11a86b225e578e07a03bd7e18bf78202d7a5c5a6bdae0436d5d77f1726464f99a564701d9734fef1dd02842d19ae2c8d2

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# 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

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
 

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)
   #
@@ -19,7 +19,7 @@ module AmazingActivist
   #   end
   # end
   # ----
-  class Activity
+  class Base
     class << self
       # Convenience method to initialize and immediatelly call the activity.
       # @see #initialize

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
@@ -56,7 +57,7 @@ module AmazingActivist
       end
 
       def message
-        "#{@activity.class} failed with #{@code}"
+        @context.fetch(:message) { Polyglot.new(@activity).message(@code, **context) }
       end
     end
   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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AmazingActivist
-  VERSION = "0.1.0"
+  VERSION = "0.2.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.2.0
 platform: ruby
 authors:
 - Alexey Zapparov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-27 00:00:00.000000000 Z
-dependencies: []
+date: 2024-01-28 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
@@ -17,15 +45,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - 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 +65,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.2.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.2.0/CHANGES.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -52,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Your friendly neighborhood activist.