solid-process 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1190b2778ef23e74384d8526ff747c3a741c62a23de0308dc0bcce85c427fef6
-  data.tar.gz: b3dd1f4009959aed58c08943e3ae642f5322c7d989036161bdaa71559c36fa5d
+  metadata.gz: e3b27456b398dffc893e5034953dcb74baa2406beeafd8d88f1be31c26611d90
+  data.tar.gz: ac372ee023cc5730e80d00951dda408634efdcc0d25322406d4fe37c85313edf
 SHA512:
-  metadata.gz: 3e81a5319038e788e726573abf7f53c2fccdd4ad5cd24d8b57db426cc4d63bd3e2c10bcc041d24c32c268b8ad7abfa61e97fbf3394e096974a2ee6c90262ca3a
-  data.tar.gz: 3bbdadd724e66a871f3ec83701e9feff39f26fbf59886c83954575e16dc80849ae3d5787acffeec01b43acdafdd4b1d2e19a1b12f55503602a4e71e73317866f
+  metadata.gz: '09a4852a76e0e47ef0b3dd02554805647d33b500efb939cc1221f1ff48d538220db9ffa426df2774855d5a014a7de49d28e9e3e7660aca8bab4e12aa85286214'
+  data.tar.gz: 2074bc2fef703376047a43e273e138ec038dba78b228a5ec14655351954ecf5b5ad71e50a306480b0dda37d85c6b60920bff0a210581507469709ba52817c0f8

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.3.0] - 2024-04-14
+
+## [0.2.0] - 2024-03-18
+
 ## [0.1.0] - 2024-03-16
 
 - Initial release

data/README.md

@@ -1,9 +1,9 @@
 <p align="center">
   <h1 align="center" id="-solidprocess">🚄 Solid::Process</h1>
-  <p align="center"><i>Ruby on Rails + Business Processes</i></p>
+  <p align="center"><i>Write self-documenting and self-observable business processes in Ruby/Rails.</i></p>
   <p align="center">
-    <a href="https://codeclimate.com/github/serradura/solid-process/maintainability"><img src="https://api.codeclimate.com/v1/badges/643a53e99bb591321c9f/maintainability" /></a>
-    <a href="https://codeclimate.com/github/serradura/solid-process/test_coverage"><img src="https://api.codeclimate.com/v1/badges/643a53e99bb591321c9f/test_coverage" /></a>
+    <a href="https://codeclimate.com/github/solid-process/solid-process/maintainability"><img src="https://api.codeclimate.com/v1/badges/643a53e99bb591321c9f/maintainability" /></a>
+    <a href="https://codeclimate.com/github/solid-process/solid-process/test_coverage"><img src="https://api.codeclimate.com/v1/badges/643a53e99bb591321c9f/test_coverage" /></a>
     <img src="https://img.shields.io/badge/Ruby%20%3E%3D%202.7%2C%20%3C%3D%20Head-ruby.svg?colorA=444&colorB=333" alt="Ruby">
     <img src="https://img.shields.io/badge/Rails%20%3E%3D%206.0%2C%20%3C%3D%20Edge-rails.svg?colorA=444&colorB=333" alt="Rails">
   </p>
@@ -54,7 +54,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/serradura/solid-process. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/serradura/solid-process/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/solid-process/solid-process. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/solid-process/solid-process/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -62,4 +62,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Solid::Process project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/serradura/solid-process/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Solid::Process project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/solid-process/solid-process/blob/main/CODE_OF_CONDUCT.md).

data/lib/solid/input.rb

@@ -1,13 +1,7 @@
 # frozen_string_literal: true
 
-class Solid::Input
-  require_relative "model"
-
-  def self.inherited(subclass)
-    subclass.include(::Solid::Model)
-  end
+require_relative "model"
 
-  def self.[](...)
-    new(...)
-  end
+class Solid::Input
+  include ::Solid::Model
 end

data/lib/solid/model.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-module Solid::Model
-  require_relative "model/access"
+require_relative "model/access"
 
+module Solid::Model
   extend ::ActiveSupport::Concern
 
   included do
@@ -14,6 +14,16 @@ module Solid::Model
     include ::ActiveModel::Validations::Callbacks
   end
 
+  module ClassMethods
+    def [](...)
+      new(...)
+    end
+
+    def inherited(subclass)
+      subclass.include(::Solid::Model)
+    end
+  end
+
   def inspect
     "#<#{self.class.name} #{attributes.map { |k, v| "#{k}=#{v.inspect}" }.join(" ")}>"
   end

data/lib/solid/process/callbacks.rb

@@ -5,37 +5,31 @@ class Solid::Process
     def self.included(subclass)
       subclass.include ActiveSupport::Callbacks
 
-      subclass.define_callbacks(:success, :failure, :output)
+      subclass.define_callbacks(:call, :success, :failure)
 
       subclass.extend ClassMethods
     end
 
     module ClassMethods
-      def after_success(*args, &block)
-        options = args.extract_options!
-        options = options.dup
-        options[:prepend] = true
-
-        set_callback(:success, :after, *args, options, &block)
+      def before_call(*filters, &block)
+        set_callback(:call, :before, *filters, &block)
       end
 
-      def after_failure(*args, &block)
-        options = args.extract_options!
-        options = options.dup
-        options[:prepend] = true
-
-        set_callback(:failure, :after, *args, options, &block)
+      def around_call(*filters, &block)
+        set_callback(:call, :around, *filters, &block)
       end
 
-      def after_output(*args, &block)
-        options = args.extract_options!
-        options = options.dup
-        options[:prepend] = true
+      def after_call(*filters, &block)
+        set_callback(:call, :after, *filters, &block)
+      end
 
-        set_callback(:output, :after, *args, options, &block)
+      def after_success(*filters, &block)
+        set_callback(:success, :after, *filters, &block)
       end
 
-      alias_method :after_result, :after_output
+      def after_failure(*filters, &block)
+        set_callback(:failure, :after, *filters, &block)
+      end
     end
   end
 end

data/lib/solid/process/caller.rb

@@ -1,31 +1,35 @@
 # frozen_string_literal: true
 
+# rubocop:disable Lint/RescueException
 class Solid::Process
   module Caller
     def call(arg = nil)
-      if output?
-        raise Error, "#{self.class}#call already called. " \
-                     "Use #{self.class}#output to access the result or create a new instance to call again."
-      end
+      output_already_set! if output?
+
+      self.input = arg
 
-      self.input = self.class.input.then { arg.instance_of?(_1) ? arg : _1.new(arg) }
+      run_callbacks(:call) do
+        ::Solid::Result.event_logs(name: self.class.name) do
+          self.output =
+            if dependencies&.invalid?
+              Failure(:invalid_dependencies, dependencies: dependencies)
+            elsif input.invalid?
+              Failure(:invalid_input, input: input)
+            else
+              super(input.attributes.deep_symbolize_keys)
+            end
+        rescue ::Exception => exception
+          rescue_with_handler(exception) || raise
 
-      ::BCDD::Result.event_logs(name: self.class.name) do
-        self.output =
-          if dependencies&.invalid?
-            Failure(:invalid_dependencies, dependencies: dependencies)
-          elsif input.invalid?
-            Failure(:invalid_input, input: input)
-          else
-            super(input.attributes.deep_symbolize_keys)
-          end
+          output
+        end
       end
 
       run_callbacks(:success) if output.success?
       run_callbacks(:failure) if output.failure?
-      run_callbacks(:output)
 
       output
     end
   end
 end
+# rubocop:enable Lint/RescueException

data/lib/solid/process/class_methods.rb

@@ -5,11 +5,7 @@ class Solid::Process
     def input=(klass)
       const_defined?(:Input, false) and raise Error, "#{const_get(:Input, false)} class already defined"
 
-      unless klass.is_a?(::Class) && klass < ::Solid::Model
-        raise ArgumentError, "#{klass.inspect} must be a class that includes #{::Solid::Model}"
-      end
-
-      const_set(:Input, klass)
+      const_set(:Input, Config::SolidModel[klass])
     end
 
     def input(&block)
@@ -17,7 +13,7 @@ class Solid::Process
 
       block.nil? and raise Error, "#{self}::Input is undefined. Use #{self}.input { ... } to define it."
 
-      klass = ::Class.new(::Solid::Input)
+      klass = ::Class.new(Config.instance.input_class)
       klass.class_eval(&block)
 
       self.input = klass
@@ -26,11 +22,7 @@ class Solid::Process
     def dependencies=(klass)
       const_defined?(:Dependencies, false) and raise Error, "#{const_get(:Dependencies, false)} class already defined"
 
-      unless klass.is_a?(::Class) && klass < ::Solid::Model
-        raise ArgumentError, "#{klass.inspect} must be a class that includes #{::Solid::Model}"
-      end
-
-      const_set(:Dependencies, klass)
+      const_set(:Dependencies, Config::SolidModel[klass])
     end
 
     def dependencies(&block)
@@ -38,7 +30,7 @@ class Solid::Process
 
       return if block.nil?
 
-      klass = ::Class.new(::Solid::Input)
+      klass = ::Class.new(Config.instance.dependencies_class)
       klass.class_eval(&block)
 
       self.dependencies = klass

data/lib/solid/process/config.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+class Solid::Process
+  class Config
+    SolidModel = ->(klass) do
+      return klass if klass.is_a?(::Class) && klass < ::Solid::Model
+
+      raise ArgumentError, "#{klass.inspect} must be a class that includes #{::Solid::Model}"
+    end
+
+    attr_reader :input_class, :dependencies_class
+
+    def initialize
+      self.input_class = ::Solid::Input
+      self.dependencies_class = ::Solid::Input
+    end
+
+    def input_class=(klass)
+      @input_class = SolidModel[klass]
+    end
+
+    def dependencies_class=(klass)
+      @dependencies_class = SolidModel[klass]
+    end
+
+    alias_method :deps_class, :dependencies_class
+    alias_method :deps_class=, :dependencies_class=
+
+    class << self
+      attr_reader :instance
+    end
+
+    @instance = new
+  end
+end

data/lib/solid/process/version.rb

@@ -2,6 +2,6 @@
 
 module Solid
   class Process
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/solid/process.rb

@@ -2,15 +2,23 @@
 
 require "active_support/all"
 require "active_model"
-require "bcdd/result"
+require "solid/result"
 
 module Solid
   require "solid/input"
-  require "solid/result"
+
+  def self.Success(...)
+    ::Solid::Output::Success(...)
+  end
+
+  def self.Failure(...)
+    ::Solid::Output::Failure(...)
+  end
 
   class Process
     require "solid/process/version"
     require "solid/process/error"
+    require "solid/process/config"
     require "solid/process/caller"
     require "solid/process/callbacks"
     require "solid/process/class_methods"
@@ -18,23 +26,46 @@ module Solid
 
     extend ClassMethods
 
-    include ::BCDD::Context.mixin(config: {addon: {continue: true}})
+    include Callbacks
+    include ::ActiveSupport::Rescuable
+    include ::Solid::Output.mixin(config: {addon: {continue: true}})
 
     def self.inherited(subclass)
+      super
+
       subclass.prepend(Caller)
-      subclass.include(Callbacks)
     end
 
     def self.call(arg = nil)
       new.call(arg)
     end
 
-    attr_accessor :input, :output, :dependencies
+    def self.configuration(&block)
+      yield config
 
-    private :input=, :output=, :dependencies=
+      config.freeze
+    end
+
+    def self.config
+      Config.instance
+    end
+
+    attr_reader :output, :input, :dependencies
 
     def initialize(arg = nil)
-      self.dependencies = self.class.dependencies&.then { arg.instance_of?(_1) ? arg : _1.new(arg) }
+      self.dependencies = arg
+    end
+
+    def call(_arg = nil)
+      raise Error, "#{self.class}#call must be implemented."
+    end
+
+    def with(dependencies)
+      self.class.new(dependencies.with_indifferent_access.with_defaults(deps&.attributes))
+    end
+
+    def new(dependencies = {})
+      with(dependencies)
     end
 
     def input?
@@ -49,8 +80,12 @@ module Solid
       !dependencies.nil?
     end
 
-    def call(_arg = nil)
-      raise Error, "#{self.class}#call must be implemented."
+    def success?(type = nil)
+      !!output&.success?(type)
+    end
+
+    def failure?(type = nil)
+      !!output&.failure?(type)
     end
 
     def inspect
@@ -69,5 +104,44 @@ module Solid
     alias_method :deps?, :dependencies?
     alias_method :result, :output
     alias_method :result?, :output?
+
+    private
+
+    def dependencies=(arg)
+      raise Error, "The `#{self.class}#dependencies` is already set." unless dependencies.nil?
+
+      @dependencies = self.class.dependencies&.then { arg.instance_of?(_1) ? arg : _1.new(arg) }
+    end
+
+    def input=(arg)
+      raise Error, "The `#{self.class}#input` is already set." unless input.nil?
+
+      @input = self.class.input.then { arg.instance_of?(_1) ? arg : _1.new(arg) }
+    end
+
+    def output_already_set!
+      raise Error, "The `#{self.class}#output` is already set. " \
+                   "Use `.output` to access the result or create a new instance to call again."
+    end
+
+    def output=(result)
+      output_already_set! unless output.nil?
+
+      raise Error, "The result #{result.inspect} must be a Solid::Output." unless result.is_a?(::Solid::Output)
+
+      @output = result
+    end
+
+    def Success!(...)
+      return self.output = Success(...) if output.nil?
+
+      raise Error, "`Success!()` cannot be called because the `#{self.class}#output` is already set."
+    end
+
+    def Failure!(...)
+      return self.output = Failure(...) if output.nil?
+
+      raise Error, "`Failure!()` cannot be called because the `#{self.class}#output` is already set."
+    end
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: solid-process
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-16 00:00:00.000000000 Z
+date: 2024-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bcdd-result
+  name: solid-result
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
-description: Ruby on Rails + Business Processes
+description: Write self-documenting and self-observable business processes in Ruby/Rails.
 email:
 - rodrigo.serradura@gmail.com
 executables: []
@@ -92,9 +92,9 @@ files:
 - lib/solid/process/callbacks.rb
 - lib/solid/process/caller.rb
 - lib/solid/process/class_methods.rb
+- lib/solid/process/config.rb
 - lib/solid/process/error.rb
 - lib/solid/process/version.rb
-- lib/solid/result.rb
 - lib/solid/validators/all.rb
 - lib/solid/validators/bool_validator.rb
 - lib/solid/validators/email_validator.rb
@@ -131,5 +131,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: Ruby on Rails + Business Processes
+summary: Write self-documenting and self-observable business processes in Ruby/Rails.
 test_files: []

data/lib/solid/result.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Solid
-  Output = ::BCDD::Context
-
-  Result = ::BCDD::Context
-  Success = Result::Success
-  Failure = Result::Failure
-
-  def self.Success(...)
-    Result::Success(...)
-  end
-
-  def self.Failure(...)
-    Result::Failure(...)
-  end
-end