amazing-activist 0.5.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fab0193cbbc4c13ab7e7f2162143de36d01369aa84090020c4903164c9be3eb
-  data.tar.gz: ce39998e2d99ab98dcd504b52f634ce0ad829fa0063ddb646a64627a21348f92
+  metadata.gz: 541998aec21a78778cf6cbe4ed8abfe84f86873c43e42edc965b4a78c97288e0
+  data.tar.gz: 9aa931fd204447211f02848d4e288a9edab389f3c65e3c3a4725fa7ada14b0a0
 SHA512:
-  metadata.gz: d0c769b8a3b3ddfc1c1595c05c3b1093db5679c5a8f2ca2ef6076402113cb390b62ac4617b29e447426be8602f6df6825427b0e70d05e2c980747ddc98977b0a
-  data.tar.gz: bc41b347b777da6516b4b1fbc08006816f953d79219f47df93a4e8530e3de60383f7441045c42ab7b300f17d3d8d9bc20902f59ca4222c11499573551933f199
+  metadata.gz: e4d7b6fff7d8191b23b4cd4dc924939af064a3bd92cda61fbdc4f7e3fed5a06a1d13f05834352e469b0dddf603819d0cdbf74b10deba539df71f8226dd5d7437
+  data.tar.gz: c342b3f260a7e66a395a13f5c01b60fcdde87c94fb00745ccaf426271e6ff4afdf0bf243133229bb21ab2862a178801f670da4ff768ae0b8f267e88f6e509375

data/CHANGES.md

@@ -7,6 +7,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+
+## [0.7.0] - 2025-04-14
+
+### Added
+
+- Use [literal](https://github.com/joeldrapper/literal) gem to aid inputs
+  boilerplate.
+
+### Changed
+
+- (BREAKING) Drop support of Ruby-3.0.X, and Ruby-3.1.X
+
+
+## [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 +97,10 @@ 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.7.0...main
+[0.7.0]: https://github.com/ixti/amazing-activist/compare/v0.6.0...v0.7.0
+[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

@@ -58,10 +58,9 @@ end
 This library aims to support and is tested against:
 
 * https://www.ruby-lang.org[Ruby]
-** MRI 3.0.x
-** 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/base.rb

@@ -31,10 +31,7 @@ module AmazingActivist
   class Base
     extend Irresistible
 
-    # @param params [Hash{Symbol => Object}]
-    def initialize(**params)
-      @params = params
-    end
+    prop :params, _Hash(Symbol, _Any?), :**
 
     # @return [Outcome::Success, Outcome::Failure]
     def call
@@ -43,9 +40,6 @@ module AmazingActivist
 
     private
 
-    # @return [Hash{Symbol => Object}]
-    attr_reader :params
-
     # @param value (see Outcome::Success#initialize)
     # @return [Outcome::Success]
     def success(value = nil)

data/lib/amazing_activist/contractable.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
+require "literal"
+
 require_relative "./broken_contract_error"
 
 module AmazingActivist
   module Contractable
+    include Literal::Properties
+
     DEFAULT_BROKEN_OUTCOME_HANDLER = lambda do |outcome|
       raise BrokenContractError, "#{self.class}#call returned #{outcome.class} instead of Outcome"
     end
@@ -26,6 +30,10 @@ module AmazingActivist
 
     private
 
+    def prop(name, type, kind = :keyword, reader: :private, default: nil, &)
+      super(name, type, kind, reader:, writer: false, predicate: false, default:, &)
+    end
+
     def on_broken_outcome(&block)
       raise ArgumentError, "Handler block required." unless block
 

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.7.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: amazing-activist
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Alexey Zapparov
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-29 00:00:00.000000000 Z
+date: 2025-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +37,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: literal
+  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
@@ -62,6 +75,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 +83,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.7.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.7.0/CHANGES.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -81,15 +94,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Your friendly neighborhood activist.
 test_files: []