amazing-activist 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fab0193cbbc4c13ab7e7f2162143de36d01369aa84090020c4903164c9be3eb
-  data.tar.gz: ce39998e2d99ab98dcd504b52f634ce0ad829fa0063ddb646a64627a21348f92
+  metadata.gz: bc682de44572c16ca1a0d4b1ad94e771c94a18f29ff7aafc53c2c6a44f5f9bdf
+  data.tar.gz: 9e5419f79392609bebf059df7380139262927b94e32b49df4c0770cadf437358
 SHA512:
-  metadata.gz: d0c769b8a3b3ddfc1c1595c05c3b1093db5679c5a8f2ca2ef6076402113cb390b62ac4617b29e447426be8602f6df6825427b0e70d05e2c980747ddc98977b0a
-  data.tar.gz: bc41b347b777da6516b4b1fbc08006816f953d79219f47df93a4e8530e3de60383f7441045c42ab7b300f17d3d8d9bc20902f59ca4222c11499573551933f199
+  metadata.gz: 93ace31de12aecf905e25390b51e4672c46a3cd5dfb8bf5bf38f70c04bfd0dd16e03bdb0fb192fc52f889b679810e9b2312a5b8a859148b809d54aca9954c218
+  data.tar.gz: 4681c868840de2df1030f11da788247763f5fd92ea69da706d62b3bcb7b2e1f0e6d455eaf288d3b16a26c9b9d6941b9a0cc538cc2c8e814a8ca805d48582d956

data/CHANGES.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+
+## [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
@@ -70,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/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.2"
+  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.2
+  version: 0.6.0
 platform: ruby
+original_platform: ''
 authors:
 - Alexey Zapparov
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-29 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.2
+  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.2/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.11
-signing_key:
+rubygems_version: 3.6.0.dev
 specification_version: 4
 summary: Your friendly neighborhood activist.
 test_files: []