amazing-activist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8cba9d28e25f87ba33a43233f981a13826c716db8342fa1df5a39ed14ca59c1
+  data.tar.gz: bcda1343f32f2df0aec0e3aaa806f602b98410e9a54d4a79214859f21830d275
+SHA512:
+  metadata.gz: c57c413901c0323f40a153d42a4b22be48281a1f6e76ceb2065cc94aed379a3d69238dfddde3537fa3ded78e573c3c9a168fcd76eb1c2547ed228b3b622f47cd
+  data.tar.gz: 9d37d65dc06c8a8784b4bc9ea4d6c1c2d72798cfea742e292e8a4d0847451dc851024a0fef330889d27d56313d944107354dc0a7dd300aed01859bc1d67383b9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Alexey Zapparov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.adoc

@@ -0,0 +1,76 @@
+= AmazingActivist
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+    $ bundle add amazing-activist
+
+Or install it yourself as:
+
+    $ gem install amazing-activist
+
+
+== Usage
+
+[source,ruby]
+----
+class ApplicationActivity < AmazingActivist::Activity
+end
+
+class OnboardingActivity < ApplicationActivity
+  def call
+    user = User.new(params)
+
+    return failure(:invalid_params, user: user) unless user.save
+
+    success(user)
+  end
+end
+
+class UsersController < ApplicationController
+  def create
+    case OnboardingActivity.call(**params.require(:user).permit(:password))
+    in success: user
+      redirect_to user_bashboard_url(user)
+    in failure: :invalid_params, context: { user: user }
+      @user = user
+      render :new
+    else
+      head :bad_request
+    end
+  end
+end
+----
+
+
+== Compatibility
+
+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
+
+If something doesn't work on one of these versions, it's a bug.
+
+This library may inadvertently work (or seem to work) on other Ruby versions,
+however support will only be provided for the versions listed above.
+
+
+== Development
+
+  bundle install
+  bundle exec rake
+
+
+== Contributing
+
+* Fork amazing-activist
+* Make your changes
+* Ensure all tests pass (`bundle exec rake`)
+* Send a merge request
+* If we like them we'll merge them
+* If we've accepted a patch, feel free to ask for commit access!

data/lib/amazing-activist.rb

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

data/lib/amazing_activist/activity.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative "./outcome"
+
+module AmazingActivist
+  # Abstract activity class.
+  #
+  # == Example
+  #
+  # [source,ruby]
+  # ----
+  # class OnboardActivity < AmazingActivist::Activity
+  #   def call
+  #     user = User.new(params)
+  #
+  #     return success(user) if user.save
+  #
+  #     failure(:invalid_params, user: user)
+  #   end
+  # end
+  # ----
+  class Activity
+    class << self
+      # Convenience method to initialize and immediatelly call the activity.
+      # @see #initialize
+      # @see #call
+      def call(...)
+        new(...).call
+      end
+    end
+
+    # @param params [Hash{Symbol => Object}]
+    def initialize(**params)
+      @params = params
+    end
+
+    # @return [Outcome::Success, Outcome::Failure]
+    def call
+      failure(:not_implemented)
+    end
+
+    private
+
+    # @return [Hash{Symbol => Object}]
+    attr_reader :params
+
+    # @param value (see Outcome::Success#initialize)
+    # @return [Outcome::Success]
+    def success(value = nil)
+      Outcome::Success.new(value, activity: self)
+    end
+
+    # @param code (see Outcome::Failure#initialize)
+    # @param context (see Outcome::Failure#initialize)
+    # @return [Outcome::Failure]
+    def failure(code, **context)
+      Outcome::Failure.new(code, activity: self, context: context)
+    end
+  end
+end

data/lib/amazing_activist/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AmazingActivist
+  class Error < StandardError; end
+end

data/lib/amazing_activist/outcome/failure.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative "../unwrap_error"
+
+module AmazingActivist
+  module Outcome
+    class Failure
+      # @return [Symbol]
+      attr_reader :code
+
+      # @return [AmazingActivist::Activity]
+      attr_reader :activity
+
+      # @return [Hash{Symbol => Object}]
+      attr_reader :context
+
+      # @param code [#to_sym]
+      # @param activity [AmazingActivist::Activity]
+      # @param context [Hash{Symbol => Object}]
+      def initialize(code, activity:, context:)
+        @code     = code.to_sym
+        @activity = activity
+        @context  = context
+      end
+
+      # @return [true]
+      def success?
+        false
+      end
+
+      # @return [false]
+      def failure?
+        true
+      end
+
+      # @api internal
+      # @return [Array<(:failure, Symbol, AmazingActivist::Activity, Hash{Symbol => Object})>]
+      def deconstruct
+        [:failure, @code, @activity, @context]
+      end
+
+      # @api internal
+      # @return [Hash{success: Object, activity: AmazingActivist::Activity}]
+      def deconstruct_keys(_)
+        { failure: @code, activity: @activity, context: @context }
+      end
+
+      # @yieldparam self [self]
+      def value_or
+        yield self
+      end
+
+      # @raise [UnwrapError]
+      def unwrap!
+        raise UnwrapError, self
+      end
+
+      def message
+        "#{@activity.class} failed with #{@code}"
+      end
+    end
+  end
+end

data/lib/amazing_activist/outcome/success.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module AmazingActivist
+  module Outcome
+    class Success
+      # @return [AmazingActivist::Activity]
+      attr_reader :activity
+
+      # @param value [Object]
+      # @param activity [AmazingActivist::Activity]
+      def initialize(value, activity:)
+        @value    = value
+        @activity = activity
+      end
+
+      # @return [true]
+      def success?
+        true
+      end
+
+      # @return [false]
+      def failure?
+        false
+      end
+
+      # @api internal
+      # @return [Array<(:success, Object, AmazingActivist::Activity)>]
+      def deconstruct
+        [:success, @value, @activity]
+      end
+
+      # @api internal
+      # @return [Hash{success: Object, activity: AmazingActivist::Activity}]
+      def deconstruct_keys(_)
+        { success: @value, activity: @activity }
+      end
+
+      # @return [Object]
+      def value_or
+        @value
+      end
+
+      # @return [Object]
+      def unwrap!
+        @value
+      end
+    end
+  end
+end

data/lib/amazing_activist/outcome.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "./outcome/success"
+require_relative "./outcome/failure"

data/lib/amazing_activist/unwrap_error.rb

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

data/lib/amazing_activist/version.rb

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

data/lib/amazing_activist.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "./amazing_activist/activity"
+require_relative "./amazing_activist/error"
+require_relative "./amazing_activist/outcome"
+require_relative "./amazing_activist/version"

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: amazing-activist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexey Zapparov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-01-27 00:00:00.000000000 Z
+dependencies: []
+description: Another take on Command Pattern.
+email:
+- alexey@zapparov.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.adoc
+- lib/amazing-activist.rb
+- lib/amazing_activist.rb
+- lib/amazing_activist/activity.rb
+- lib/amazing_activist/error.rb
+- lib/amazing_activist/outcome.rb
+- lib/amazing_activist/outcome/failure.rb
+- lib/amazing_activist/outcome/success.rb
+- lib/amazing_activist/unwrap_error.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.1.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
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.4
+signing_key:
+specification_version: 4
+summary: Your friendly neighborhood activist.
+test_files: []