amazing-activist 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c059cc4ff198a6fb4d721683061c51063050fa209f4bdb3d0e27b0232abd2e7f
-  data.tar.gz: 1cfd1f85b06587f6c3ab903e36ae15fdd25c5f7c9f366690e041a89a71fcb952
+  metadata.gz: 37bc656c60ec0c017a2a9c50c7d197b2c69b9917aa653f6b310b4e3a3d962ad5
+  data.tar.gz: 28a3c3b2dbdb56d59b0b3c9e0e6038c5a9b4976da58605a9d70a83ef932efc1c
 SHA512:
-  metadata.gz: 1f21b35f615f84a428d6b53c859b4bcf0c1a60bbb5f41c3bea265135c1acd32e7cf99d734b05bdae3913199095517d632ee042da175581c9ac7fc335b30a97ae
-  data.tar.gz: f8123ee0debd3ae42218f1651b8b9df163aef428f778b26f1e12296861b354c7710eb8f5e97ab042746a6e881cb467e36b2dc676b230731e9fdf4621affe73a2
+  metadata.gz: 639ead2f02b487f53adc2ebb329e630a5d610e609a600a9f0382e7b2296d03d2e89cd41a61c53327fef5bb71dcf0992e1d3a6019f842f00b8d7d19f2d198f05f
+  data.tar.gz: 3b4d9c97d7359c587f9f03e0636b8283c6ea71be15363eae8ef71a9ff0b124205c10f767c85f9301fa5250725a747838662ff0ec40c7132b76756f38507520dc

data/CHANGES.md

@@ -8,6 +8,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 
+## [0.10.0] - 2025-10-01
+
+### Added
+
+- Add `success_or` alias for `value_or`
+
+### Removed
+
+- (BREAKING) Remove `Failure#failure` and `Sucess#success`
+
+
+## [0.9.0] - 2025-05-28
+
+### Changed
+
+- (BREAKING) Switch to Zeitwerk autoloader.
+- (BREAKING) Deprecate `AmazingActivist::Outcome::{Success,Failure}`
+  in favour of `AmazingActivist::Success` and `AmazingActivist::Failure`
+  respectively.
+- (BREAKING) Harden outcomes initializer API
+
+
 ## [0.8.0] - 2025-05-01
 
 ### Changed
@@ -109,7 +131,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.8.0...main
+[Unreleased]: https://github.com/ixti/amazing-activist/compare/v0.10.0...main
+[0.10.0]: https://github.com/ixti/amazing-activist/compare/v0.9.0...v0.10.0
+[0.9.0]: https://github.com/ixti/amazing-activist/compare/v0.8.0...v0.9.0
 [0.8.0]: https://github.com/ixti/amazing-activist/compare/v0.7.0...v0.8.0
 [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

data/README.adoc

@@ -9,6 +9,10 @@ ifdef::env-github[]
 {codecov-url}[image:{codecov-img}[codecov]]
 endif::[]
 
+== Is it any good?
+
+https://news.ycombinator.com/item?id=3067434[Yes!]
+
 == Installation
 
 Add this line to your application's Gemfile:
@@ -28,8 +32,11 @@ class ApplicationActivity < AmazingActivist::Base
 end
 
 class OnboardingActivity < ApplicationActivity
+  prop :email,    String
+  prop :password, String
+
   def call
-    user = User.new(params)
+    user = User.new(email:, password:)
 
     return failure(:invalid_params, user: user) unless user.save
 
@@ -39,10 +46,10 @@ end
 
 class UsersController < ApplicationController
   def create
-    case OnboardingActivity.call(**params.require(:user).permit(:password))
+    case OnboardingActivity.call(**params.require(:user).permit(:email, :password))
     in success: user
       redirect_to user_bashboard_url(user)
-    in failure: :invalid_params, context: { user: user }
+    in failure: :invalid_params, context: { user: }
       @user = user
       render :new
     else

data/lib/amazing-activist.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require_relative "./amazing_activist"
+require "amazing_activist"

data/lib/amazing_activist/base.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "./irresistible"
-require_relative "./outcome"
-
 module AmazingActivist
   # Abstract activity class.
   #
@@ -38,24 +35,24 @@ module AmazingActivist
       private :new
     end
 
-    # @return [Outcome::Success, Outcome::Failure]
+    # @return [Success, Failure]
     def call
       failure(:not_implemented)
     end
 
     private
 
-    # @param value (see Outcome::Success#initialize)
-    # @return [Outcome::Success]
+    # @param value (see Success#initialize)
+    # @return [Success]
     def success(value = nil)
-      Outcome::Success.new(value, activity: self)
+      Success.new(value, activity: self)
     end
 
-    # @param code (see Outcome::Failure#initialize)
-    # @param context (see Outcome::Failure#initialize)
-    # @return [Outcome::Failure]
+    # @param code (see Failure#initialize)
+    # @param context (see Failure#initialize)
+    # @return [Failure]
     def failure(code, message: nil, exception: nil, context: {})
-      Outcome::Failure.new(code, activity: self, message: message, exception: exception, context: context)
+      Failure.new(code, activity: self, message: message, exception: exception, context: context)
     end
   end
 end

data/lib/amazing_activist/contractable.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require "literal"
-
-require_relative "./broken_contract_error"
-
 module AmazingActivist
   module Contractable
     include Literal::Properties

data/lib/amazing_activist/{broken_contract_error.rb → errors/broken_contract_error.rb}

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "./error"
-
 module AmazingActivist
   class BrokenContractError < Error; end
 end

data/lib/amazing_activist/{unwrap_error.rb → errors/unwrap_error.rb}

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
-require_relative "./error"
-
 module AmazingActivist
   class UnwrapError < Error
-    # @return [Outcome::Failure]
+    # @return [Failure]
     attr_reader :failure
 
-    # @param failure [Outcome::Failure]
+    # @param failure [Failure]
     def initialize(failure)
       @failure = failure
 

data/lib/amazing_activist/failure.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module AmazingActivist
+  class Failure < Literal::Data
+    include Outcome
+
+    # @!attribute [r] failure
+    #   @return failure [Symbol]
+    prop :code, _Interface(:to_sym), :positional, &:to_sym
+
+    # @!attribute [r] activity
+    #   @return [AmazingActivist::Base]
+    prop :activity, AmazingActivist::Base
+
+    # @!attribute [r] exception
+    #   @return [Exception, nil]
+    prop :exception, _Nilable(Exception)
+
+    # @!attribute [r] context
+    #   @return [Hash]
+    prop :context, _Hash(_Void, _Void), &:to_h
+
+    prop :message, _String?, reader: false
+
+    def failure? = true
+    def success? = false
+
+    # @api internal
+    # @return [Array]
+    def deconstruct
+      [:failure, code, activity]
+    end
+
+    # @api internal
+    # @return [Hash]
+    def deconstruct_keys(keys)
+      if keys.nil? || keys.include?(:message)
+        { failure: code, activity:, exception:, context:, message: }
+      else
+        { failure: code, activity:, exception:, context: }
+      end
+    end
+
+    # Failure message.
+    #
+    # @return [String]
+    def message
+      @message || Polyglot.new(activity).message(code, **context)
+    end
+  end
+end

data/lib/amazing_activist/irresistible.rb

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "./broken_contract_error"
-require_relative "./contractable"
-require_relative "./rescuable"
-require_relative "./unwrap_error"
-
 module AmazingActivist
   module Irresistible
     include Contractable
@@ -17,9 +12,7 @@ module AmazingActivist
       activity = new(...)
       outcome  = irresistible_call(activity)
 
-      unless outcome.is_a?(Outcome::Failure) || outcome.is_a?(Outcome::Success)
-        return activity.instance_exec(outcome, &broken_contract_handler)
-      end
+      return activity.instance_exec(outcome, &broken_contract_handler) unless outcome.is_a?(Outcome)
 
       outcome
     end

data/lib/amazing_activist/outcome/failure.rb

@@ -1,98 +1,9 @@
 # frozen_string_literal: true
 
-require_relative "../polyglot"
-require_relative "../unwrap_error"
-require_relative "../undefined"
-
 module AmazingActivist
   module Outcome
-    class Failure
-      # @return [Symbol]
-      attr_reader :code
-
-      # @return [AmazingActivist::Base]
-      attr_reader :activity
-
-      # @return [Exception, nil]
-      attr_reader :exception
-
-      # @return [Hash]
-      attr_reader :context
-
-      # @param code [#to_sym]
-      # @param activity [AmazingActivist::Activity]
-      # @param message [#to_s, nil]
-      # @param exception [Exception, nil]
-      # @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.to_h
-      end
-
-      def inspect
-        "#<#{self.class} (#{@activity.class}) #{@code.inspect}>"
-      end
-
-      alias to_s inspect
-
-      # @return [true]
-      def success?
-        false
-      end
-
-      # @return [false]
-      def failure?
-        true
-      end
-
-      # @api internal
-      # @return [Array]
-      def deconstruct
-        [:failure, @code, @activity]
-      end
-
-      # @api internal
-      # @return [Hash]
-      def deconstruct_keys(keys)
-        deconstructed = { failure: @code, activity: @activity, exception: exception, context: context }
-        deconstructed[:message] = message if keys.nil? || keys.include?(:message)
-
-        deconstructed
-      end
-
-      # @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
-
-      # @raise [UnwrapError]
-      def unwrap!
-        raise UnwrapError, self
-      end
-
-      # Failure message.
-      #
-      # @return [String]
-      def message
-        @message || Polyglot.new(@activity).message(@code, **context)
-      end
-    end
+    # @deprecated Use AmazingActivist::Failure
+    Failure = AmazingActivist::Failure
+    deprecate_constant :Failure
   end
 end

data/lib/amazing_activist/outcome/success.rb

@@ -1,70 +1,9 @@
 # frozen_string_literal: true
 
-require_relative "../undefined"
-
 module AmazingActivist
   module Outcome
-    class Success
-      # @return [AmazingActivist::Base]
-      attr_reader :activity
-
-      # @param value [Object]
-      # @param activity [AmazingActivist::Base]
-      def initialize(value, activity:)
-        @value    = value
-        @activity = activity
-      end
-
-      def inspect
-        "#<#{self.class} (#{@activity.class}) #{@value.inspect}>"
-      end
-
-      alias to_s inspect
-
-      # @return [true]
-      def success?
-        true
-      end
-
-      # @return [false]
-      def failure?
-        false
-      end
-
-      # @api internal
-      # @return [Array]
-      def deconstruct
-        [:success, @value, @activity]
-      end
-
-      # @api internal
-      # @return [Hash]
-      def deconstruct_keys(_)
-        { success: @value, activity: @activity }
-      end
-
-      # @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
-
-      # @return [Object]
-      def unwrap!
-        @value
-      end
-    end
+    # @deprecated Use AmazingActivist::Success
+    Success = AmazingActivist::Success
+    deprecate_constant :Success
   end
 end

data/lib/amazing_activist/outcome.rb

@@ -1,4 +1,52 @@
 # frozen_string_literal: true
 
-require_relative "./outcome/success"
-require_relative "./outcome/failure"
+module AmazingActivist
+  module Outcome
+    UNDEFINED = Object.new.freeze
+    private_constant :UNDEFINED
+
+    # @return [String]
+    def inspect = "#<#{self.class} (#{activity.class})>"
+
+    alias to_s inspect
+
+    # @overload value_or(default)
+    #   @param default [Object]
+    #   @return [Object] `default` if outcome is {Failure}
+    #   @return [Object] {#success} otherwise
+    #
+    # @overload value_or(&block)
+    #   Yelds outcome, when outcome is {Failure}, or returns {#success} without
+    #   yielding the control when {Success}.
+    #   @yield [self]
+    #   @yieldparam self [Failure]
+    #   @yieldreturn [Object] result of the block
+    #
+    # @raise [ArgumentError] if neither default value, nor block given
+    def value_or(default = UNDEFINED)
+      if block_given?
+        warn "block supersedes default value argument" unless default == UNDEFINED
+
+        return value if success?
+
+        yield self
+      elsif default != UNDEFINED
+        return value if success?
+
+        default
+      else
+        raise ArgumentError, "either default value, or block must be given"
+      end
+    end
+
+    alias success_or value_or
+
+    # @return [Object] {#success} if outcome is {Success}
+    # @raise [UnwrapError] otherwise
+    def unwrap!
+      return value if success?
+
+      raise UnwrapError, self
+    end
+  end
+end

data/lib/amazing_activist/polyglot.rb

@@ -3,10 +3,6 @@
 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

data/lib/amazing_activist/success.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module AmazingActivist
+  class Success < Literal::Data
+    include Outcome
+
+    # @!attribute [r] success
+    #   @return [AmazingActivist::Base]
+    prop :value, _Any?, :positional
+
+    # @!attribute [r] activity
+    #   @return [AmazingActivist::Base]
+    prop :activity, AmazingActivist::Base
+
+    def failure? = false
+    def success? = true
+
+    # @api internal
+    # @return [Array]
+    def deconstruct
+      [:success, value, activity]
+    end
+
+    # @api internal
+    # @return [Hash]
+    def deconstruct_keys(_)
+      { success: value, activity: }
+    end
+  end
+end

data/lib/amazing_activist/version.rb

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

data/lib/amazing_activist.rb

@@ -1,6 +1,19 @@
 # frozen_string_literal: true
 
-require_relative "./amazing_activist/base"
-require_relative "./amazing_activist/error"
-require_relative "./amazing_activist/outcome"
+require "i18n"
+require "literal"
+require "zeitwerk"
+
 require_relative "./amazing_activist/version"
+
+I18n.load_path += Dir[File.expand_path("#{__dir__}/amazing_activist/locale/*.yml")]
+
+module AmazingActivist
+  Loader = Zeitwerk::Loader.for_gem
+
+  Loader.ignore("#{__dir__}/amazing-activist.rb")
+
+  Loader.collapse("#{__dir__}/amazing_activist/errors")
+
+  Loader.setup
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: amazing-activist
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Alexey Zapparov
 bindir: exe
 cert_chain: []
-date: 2025-05-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -43,14 +43,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.3
 description: Another take on Command Pattern.
 email:
 - alexey@zapparov.com
@@ -64,9 +78,11 @@ files:
 - lib/amazing-activist.rb
 - lib/amazing_activist.rb
 - lib/amazing_activist/base.rb
-- lib/amazing_activist/broken_contract_error.rb
 - lib/amazing_activist/contractable.rb
-- lib/amazing_activist/error.rb
+- lib/amazing_activist/errors/broken_contract_error.rb
+- lib/amazing_activist/errors/error.rb
+- lib/amazing_activist/errors/unwrap_error.rb
+- lib/amazing_activist/failure.rb
 - lib/amazing_activist/irresistible.rb
 - lib/amazing_activist/locale/en.yml
 - lib/amazing_activist/locale/gl.yml
@@ -75,17 +91,16 @@ 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/success.rb
 - lib/amazing_activist/version.rb
 homepage: https://github.com/ixti/amazing-activist
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/ixti/amazing-activist
-  source_code_uri: https://github.com/ixti/amazing-activist/tree/v0.8.0
+  source_code_uri: https://github.com/ixti/amazing-activist/tree/v0.10.0
   bug_tracker_uri: https://github.com/ixti/amazing-activist/issues
-  changelog_uri: https://github.com/ixti/amazing-activist/blob/v0.8.0/CHANGES.md
+  changelog_uri: https://github.com/ixti/amazing-activist/blob/v0.10.0/CHANGES.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -101,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.5
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Your friendly neighborhood activist.
 test_files: []

data/lib/amazing_activist/undefined.rb

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