amazing-activist 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1b67a3e5f375db018b80c5576790c70199cab89e8e352bf2700f06e2efa8678
-  data.tar.gz: 313e959d99e39ec6c6c759748bdd08889c73945388ed5240e5919043968558f5
+  metadata.gz: bc682de44572c16ca1a0d4b1ad94e771c94a18f29ff7aafc53c2c6a44f5f9bdf
+  data.tar.gz: 9e5419f79392609bebf059df7380139262927b94e32b49df4c0770cadf437358
 SHA512:
-  metadata.gz: 2f97922ccb1e84836578e2103f17b34e6a0081d29f6370aac8438b9cfdbf53974c3d14ab66f92f56569ca2481c0000e069db0967be80614578d7edf8881f7bfa
-  data.tar.gz: a53cc57eb23851df4af94092f83506fc23d79769158d8ac7105badd94742d68e08959add4746eb41f767bb1fd2b0fec082ee161caf73722a200420a96cd68a72
+  metadata.gz: 93ace31de12aecf905e25390b51e4672c46a3cd5dfb8bf5bf38f70c04bfd0dd16e03bdb0fb192fc52f889b679810e9b2312a5b8a859148b809d54aca9954c218
+  data.tar.gz: 4681c868840de2df1030f11da788247763f5fd92ea69da706d62b3bcb7b2e1f0e6d455eaf288d3b16a26c9b9d6941b9a0cc538cc2c8e814a8ca805d48582d956

data/CHANGES.md

@@ -8,7 +8,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 
-## [0.5.1] - 2023-04-26
+## [0.6.0] - 2024-12-15
+
+### Added
+
+- Support Ruby-3.4.X.
+- Add `Success#inspect` and `Failure#inspect` methods.
+- Support default value literal in `Failure#value_or`.
+
+### Changed
+
+- (BREAKING) `Success#value_or` requries default value or block to keep it
+  consistent with `Failure#value_or`.
+
+
+## [0.5.2] - 2024-08-30
+
+### Changed
+
+- i18n now looks for keys without `amazing_activist` prefix as well; Lookup
+  order now goes like: `amazing_activist.activities.[activity].failures`,
+  `activities.[activity].failures`, `amazing_activist.failures`,
+  `activities.failures`, with fallback to hardcoded `"<[activity]> failed - [code]"`.
+
+
+## [0.5.1] - 2024-04-26
 
 ### Changed
 
@@ -16,7 +40,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   keys are present and do not include it.
 
 
-## [0.5.0] - 2023-03-13
+## [0.5.0] - 2024-03-13
 
 ### Changed
 
@@ -61,6 +85,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release.
 
+[Unreleased]: https://github.com/ixti/amazing-activist/compare/v0.6.0...main
+[0.6.0]: https://github.com/ixti/amazing-activist/compare/v0.5.2...v0.6.0
+[0.5.2]: https://github.com/ixti/amazing-activist/compare/v0.5.1...v0.5.2
 [0.5.1]: https://github.com/ixti/amazing-activist/compare/v0.5.0...v0.5.1
 [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

data/README.adoc

@@ -62,6 +62,7 @@ This library aims to support and is tested against:
 ** MRI 3.1.x
 ** MRI 3.2.x
 ** MRI 3.3.x
+** MRI 3.4.x
 
 If something doesn't work on one of these versions, it's a bug.
 

data/lib/amazing_activist/outcome/failure.rb

@@ -2,6 +2,7 @@
 
 require_relative "../polyglot"
 require_relative "../unwrap_error"
+require_relative "../undefined"
 
 module AmazingActivist
   module Outcome
@@ -22,15 +23,21 @@ module AmazingActivist
       # @param activity [AmazingActivist::Activity]
       # @param message [#to_s, nil]
       # @param exception [Exception, nil]
-      # @param context [Hash]
+      # @param context [#to_h]
       def initialize(code, activity:, message:, exception:, context:)
         @code      = code.to_sym
         @activity  = activity
         @message   = message&.to_s
         @exception = exception
-        @context   = context
+        @context   = context.to_h
       end
 
+      def inspect
+        "#<#{self.class} (#{@activity.class}) #{@code.inspect}>"
+      end
+
+      alias to_s inspect
+
       # @return [true]
       def success?
         false
@@ -56,8 +63,22 @@ module AmazingActivist
         deconstructed
       end
 
-      # @yieldparam self [self]
-      def value_or
+      # @overload value_or(default)
+      #   @param default [Object]
+      #   @return [Object] default value
+      # @overload value_or(&block)
+      #   @yieldparam self [self]
+      #   @yieldreturn [Object] result of the block
+      # @raise [ArgumentError] if neither default value, nor block given
+      def value_or(default = UNDEFINED)
+        raise ArgumentError, "either default value, or block must be given" if default == UNDEFINED && !block_given?
+
+        unless default == UNDEFINED
+          return default unless block_given?
+
+          warn "block supersedes default value argument"
+        end
+
         yield self
       end
 

data/lib/amazing_activist/outcome/success.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "../undefined"
+
 module AmazingActivist
   module Outcome
     class Success
@@ -13,6 +15,12 @@ module AmazingActivist
         @activity = activity
       end
 
+      def inspect
+        "#<#{self.class} (#{@activity.class}) #{@value.inspect}>"
+      end
+
+      alias to_s inspect
+
       # @return [true]
       def success?
         true
@@ -35,8 +43,21 @@ module AmazingActivist
         { success: @value, activity: @activity }
       end
 
-      # @return [Object]
-      def value_or
+      # @note Method requires default value or block (even though neither will
+      #   be used) to keep it consistent with {Failure#value_or}, and avoid
+      #   unpleasant surprises when code is not testing all possible outcomes.
+      #
+      # @raise [ArgumentError] if neither default value, nor block given
+      # @return [Object] unwrapped value
+      def value_or(default = UNDEFINED)
+        raise ArgumentError, "either default value, or block must be given" if default == UNDEFINED && !block_given?
+
+        unless default == UNDEFINED
+          return @value unless block_given?
+
+          warn "block supersedes default value argument"
+        end
+
         @value
       end
 

data/lib/amazing_activist/polyglot.rb

@@ -17,13 +17,17 @@ module AmazingActivist
     # The i18n key for the message will be looked in namespaces:
     #
     # * `amazing_activist.activities.[activity].failures`
+    # * `activities.[activity].failures`
     # * `amazing_activist.failures`
+    # * `activities.failures`
     #
     # Thus, if activity `Pretty::DamnGoodActivity` failed with `:bad_choise`
     # code the lookup will be:
     #
     # * `amazing_activist.activities.pretty/damn_good_activity.failures.bad_choice
+    # * `activities.pretty/damn_good_activity.failures.bad_choice
     # * `amazing_activist.failures.bad_choice
+    # * `activities.failures.bad_choice
     #
     # If there's no translation with any of the above keys, a generic
     # non-translated message will be used:
@@ -32,14 +36,16 @@ module AmazingActivist
     #
     # @return [String] Failure message
     def message(code, **context)
-      default = [
+      activity = @activity.class.name&.underscore
+      default  = [
         :"amazing_activist.failures.#{code}",
+        :"activities.failures.#{code}",
         "<%{activity}> failed - %{code}" # rubocop:disable Style/FormatStringToken
       ]
 
-      if @activity.class.name
-        activity = @activity.class.name.underscore.presence
+      if activity
         i18n_key = :"amazing_activist.activities.#{activity}.failures.#{code}"
+        default.unshift(:"activities.#{activity}.failures.#{code}")
       else
         activity = "(anonymous activity)"
         i18n_key = default.shift

data/lib/amazing_activist/undefined.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AmazingActivist
+  UNDEFINED = Object.new.freeze
+end

data/lib/amazing_activist/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amazing-activist
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
+original_platform: ''
 authors:
 - Alexey Zapparov
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-26 00:00:00.000000000 Z
+date: 2024-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -62,6 +62,7 @@ files:
 - lib/amazing_activist/outcome/success.rb
 - lib/amazing_activist/polyglot.rb
 - lib/amazing_activist/rescuable.rb
+- lib/amazing_activist/undefined.rb
 - lib/amazing_activist/unwrap_error.rb
 - lib/amazing_activist/version.rb
 homepage: https://github.com/ixti/amazing-activist
@@ -69,11 +70,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/ixti/amazing-activist
-  source_code_uri: https://github.com/ixti/amazing-activist/tree/v0.5.1
+  source_code_uri: https://github.com/ixti/amazing-activist/tree/v0.6.0
   bug_tracker_uri: https://github.com/ixti/amazing-activist/issues
-  changelog_uri: https://github.com/ixti/amazing-activist/blob/v0.5.1/CHANGES.md
+  changelog_uri: https://github.com/ixti/amazing-activist/blob/v0.6.0/CHANGES.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -88,8 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
-signing_key:
+rubygems_version: 3.6.0.dev
 specification_version: 4
 summary: Your friendly neighborhood activist.
 test_files: []