clean-architecture 2.0.0 → 3.0.0

data/lib/clean_architecture/use_cases/contract.rb

@@ -0,0 +1,9 @@
+# typed: strong
+# frozen_string_literal: true
+
+module CleanArchitecture
+  module UseCases
+    class Contract < Dry::Validation::Contract
+    end
+  end
+end

data/lib/clean_architecture/use_cases/errors.rb

@@ -0,0 +1,57 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'active_model'
+require 'active_support/core_ext/string/inflections'
+
+module CleanArchitecture
+  module UseCases
+    # Acts as a facade in front of ActiveModel::Errors implementing the bare minimum of the API
+    # It also implements the same interface as a FailureDetails so as to be interchangeable if
+    # passed back to code expecting a FailureDetails
+    class Errors
+      extend Forwardable
+      include ActiveModel::Translation
+
+      DEFAULT_FAILURE_DETAILS_TYPE = 'error'
+
+      def initialize(base, type = DEFAULT_FAILURE_DETAILS_TYPE)
+        @active_model_errors = ActiveModel::Errors.new(base)
+        @type = type
+      end
+
+      attr_reader :type
+
+      def message
+        full_messages.join(', ')
+      end
+
+      def other_properties
+        {}
+      end
+
+      def_delegators :@active_model_errors,
+                     :count,
+                     :each,
+                     :size,
+                     :clear,
+                     :blank?,
+                     :empty?,
+                     :add
+
+      ATTRIBUTE_NAME_HUMANIZE_OPTIONS = { capitalize: true, keep_id_suffix: false }
+      BASE_NAME = :base
+
+      def full_messages
+        @active_model_errors.messages.map do |attribute, messages|
+          attribute_name = if attribute == BASE_NAME
+            nil
+          else
+            ActiveSupport::Inflector.humanize(attribute, ATTRIBUTE_NAME_HUMANIZE_OPTIONS)
+          end
+          messages.map { |message| [attribute_name, message].compact.join(' ') }
+        end.flatten
+      end
+    end
+  end
+end

data/lib/clean_architecture/use_cases/form.rb

@@ -0,0 +1,116 @@
+# typed: false
+# frozen_string_literal: true
+
+require 'active_model'
+require 'clean_architecture/use_cases/errors'
+require 'clean_architecture/entities/failure_details'
+require 'dry/struct'
+require 'dry/monads/try'
+require 'dry/matcher/result_matcher'
+
+module CleanArchitecture
+  module UseCases
+    class Form
+      include ActiveModel::Conversion
+      include Dry::Monads::Try::Mixin
+      extend ActiveModel::Naming
+
+      attr_reader :errors, :context
+
+      def initialize(params: {}, context: {}, errors: UseCases::Errors.new(nil))
+        @params = params.to_h.symbolize_keys
+        @context = context
+        @errors = errors
+      end
+
+      def persisted?
+        false
+      end
+
+      # Attempts to create the parameter object returning a Dry::Monads::Result with either
+      # the parameter object or an exception
+      def to_parameter_object
+        @to_parameter_object ||= begin
+          use_case_class.parameters(parameter_object_hash.merge(context: context))
+        end
+      end
+
+      def with_errors(new_errors, override_params: nil)
+        self.class.new(
+          params: override_params || @params,
+          context: @context,
+          errors: ErrorsFactory.new(new_errors).manufacture
+        )
+      end
+
+      def with_error_message(message, override_params: nil)
+        new_errors = UseCases::Errors.new(nil)
+        new_errors.add(:base, message)
+        with_errors(new_errors, override_params: override_params)
+      end
+
+      def self.acts_as_form_for(use_case_class)
+        attribute_names = use_case_class.contract.__schema__.rules.keys
+
+        attribute_names.each do |attribute_name|
+          define_method attribute_name do
+            to_parameter_object[attribute_name]
+          end
+        end
+
+        define_method :use_case_class do
+          use_case_class
+        end
+      end
+
+      def self.prepopulate_with(_object, _context)
+        raise NotImplementedError, 'This form does not support prepopulation'
+      end
+
+      private
+
+      def attempt_parameter_object_hash_creation
+        errors.clear
+        parameter_object_hash
+      end
+
+      # This can be overridden for forms where the params don't map perfectly
+      # to the parameter object
+      def parameter_object_hash
+        @params
+      end
+
+      class ErrorsFactory
+        def initialize(errors)
+          @errors = errors
+        end
+
+        def manufacture
+          if @errors.is_a?(UseCases::Errors)
+            return @errors
+          elsif @errors.is_a?(Entities::FailureDetails)
+            return errors_from_failure_details
+          elsif @errors.is_a?(String)
+            return errors_from_string
+          end
+
+          raise ArgumentError, "Unable to handle errors of type: #{@errors.class}"
+        end
+
+        private
+
+        def errors_from_failure_details
+          errors = UseCases::Errors.new(nil)
+          errors.add(:base, @errors.message)
+          errors
+        end
+
+        def errors_from_string
+          errors = UseCases::Errors.new(nil)
+          errors.add(:base, @errors)
+          errors
+        end
+      end
+    end
+  end
+end

data/lib/clean_architecture/use_cases/parameters.rb

@@ -0,0 +1,42 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'dry/monads/result'
+require 'clean_architecture/use_cases/errors'
+
+module CleanArchitecture
+  module UseCases
+    class Parameters
+      include Dry::Monads::Result::Mixin
+      extend Forwardable
+
+      def initialize(context, dry_validation_result)
+        @context = context
+        @dry_validation_result = dry_validation_result
+      end
+
+      def context(key)
+        @context.fetch(key)
+      end
+
+      def_delegators :@dry_validation_result,
+                     :[]
+
+      def to_monad
+        @dry_validation_result.success? ? Success(@dry_validation_result.to_h) : Failure(errors)
+      end
+
+      INVALID_PARAMS_FAILURE_TYPE = 'expectation_failed'
+
+      def errors
+        new_errors = Errors.new(nil, INVALID_PARAMS_FAILURE_TYPE)
+        @dry_validation_result.errors.to_h.each_pair do |invalid_attribute_key, error_messages|
+          error_messages.each do |error_message|
+            new_errors.add(invalid_attribute_key, error_message)
+          end
+        end
+        new_errors
+      end
+    end
+  end
+end

data/lib/clean_architecture/version.rb

@@ -1,5 +1,6 @@
+# typed: strong
 # frozen_string_literal: true
 
 module CleanArchitecture
-  VERSION = '2.0.0'
+  VERSION = '3.0.0'
 end

data/sorbet/config

@@ -0,0 +1,2 @@
+--dir
+.

data/sorbet/rbi/gems/activemodel.rbi

@@ -0,0 +1,74 @@
+# This file is autogenerated. Do not edit it by hand. Regenerate it with:
+#   srb rbi gems
+
+# typed: strong
+#
+# If you would like to make changes to this file, great! Please create the gem's shim here:
+#
+#   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/activemodel/all/activemodel.rbi
+#
+# activemodel-6.0.0
+module ActiveModel
+  def self.eager_load!; end
+  def self.gem_version; end
+  def self.version; end
+  extend ActiveSupport::Autoload
+end
+module ActiveModel::VERSION
+end
+module ActiveModel::Serializers
+  extend ActiveSupport::Autoload
+end
+class ActiveModel::Name
+  def !~(*args, &block); end
+  def <=>(*args, &block); end
+  def ==(arg); end
+  def ===(arg); end
+  def =~(*args, &block); end
+  def _singularize(string); end
+  def as_json(*args, &block); end
+  def cache_key; end
+  def collection; end
+  def element; end
+  def eql?(*args, &block); end
+  def human(options = nil); end
+  def i18n_key; end
+  def initialize(klass, namespace = nil, name = nil); end
+  def match?(*args, &block); end
+  def name; end
+  def param_key; end
+  def plural; end
+  def route_key; end
+  def singular; end
+  def singular_route_key; end
+  def to_s(*args, &block); end
+  def to_str(*args, &block); end
+  include Comparable
+end
+module ActiveModel::Naming
+  def model_name; end
+  def self.extended(base); end
+  def self.model_name_from_record_or_class(record_or_class); end
+  def self.param_key(record_or_class); end
+  def self.plural(record_or_class); end
+  def self.route_key(record_or_class); end
+  def self.singular(record_or_class); end
+  def self.singular_route_key(record_or_class); end
+  def self.uncountable?(record_or_class); end
+end
+module ActiveModel::Translation
+  def human_attribute_name(attribute, options = nil); end
+  def i18n_scope; end
+  def lookup_ancestors; end
+  include ActiveModel::Naming
+end
+module ActiveModel::Conversion
+  def to_key; end
+  def to_model; end
+  def to_param; end
+  def to_partial_path; end
+  extend ActiveSupport::Concern
+end
+module ActiveModel::Conversion::ClassMethods
+  def _to_partial_path; end
+end

data/sorbet/rbi/gems/activesupport.rbi

@@ -0,0 +1,440 @@
+# This file is autogenerated. Do not edit it by hand. Regenerate it with:
+#   srb rbi gems
+
+# typed: true
+#
+# If you would like to make changes to this file, great! Please create the gem's shim here:
+#
+#   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/activesupport/all/activesupport.rbi
+#
+# activesupport-6.0.0
+class Hash
+  def blank?; end
+  def deep_merge!(other_hash, &block); end
+  def deep_merge(other_hash, &block); end
+  def except!(*keys); end
+  def except(*keys); end
+  def extract!(*keys); end
+  def extractable_options?; end
+  def slice!(*keys); end
+end
+module ActiveSupport
+  def self.eager_load!; end
+  def self.gem_version; end
+  def self.test_order; end
+  def self.test_order=(obj); end
+  def self.to_time_preserves_timezone; end
+  def self.to_time_preserves_timezone=(value); end
+  def self.version; end
+  def test_order; end
+  def test_order=(obj); end
+  extend ActiveSupport::Autoload
+  extend ActiveSupport::LazyLoadHooks
+end
+module ActiveSupport::LazyLoadHooks
+  def execute_hook(name, base, options, block); end
+  def on_load(name, options = nil, &block); end
+  def run_load_hooks(name, base = nil); end
+  def self.extended(base); end
+  def with_execution_control(name, block, once); end
+end
+module Kernel
+  def class_eval(*args, &block); end
+end
+class Module
+  def cattr_accessor(*syms, instance_reader: nil, instance_writer: nil, instance_accessor: nil, default: nil, &blk); end
+  def cattr_reader(*syms, instance_reader: nil, instance_accessor: nil, default: nil); end
+  def cattr_writer(*syms, instance_writer: nil, instance_accessor: nil, default: nil); end
+  def delegate(*methods, to: nil, prefix: nil, allow_nil: nil, private: nil); end
+  def delegate_missing_to(target); end
+  def deprecate(*method_names); end
+  def mattr_accessor(*syms, instance_reader: nil, instance_writer: nil, instance_accessor: nil, default: nil, &blk); end
+  def mattr_reader(*syms, instance_reader: nil, instance_accessor: nil, default: nil); end
+  def mattr_writer(*syms, instance_writer: nil, instance_accessor: nil, default: nil); end
+  def method_visibility(method); end
+  def module_parent; end
+  def module_parent_name; end
+  def module_parents; end
+  def parent; end
+  def parent_name; end
+  def parents; end
+  def redefine_method(method, &block); end
+  def redefine_singleton_method(method, &block); end
+  def silence_redefinition_of_method(method); end
+end
+class Module::DelegationError < NoMethodError
+end
+class ActiveSupport::Deprecation
+  def self.allocate; end
+  def self.behavior(*args, &block); end
+  def self.behavior=(arg); end
+  def self.debug(*args, &block); end
+  def self.debug=(arg); end
+  def self.deprecate_methods(*args, &block); end
+  def self.deprecation_horizon(*args, &block); end
+  def self.deprecation_horizon=(arg); end
+  def self.deprecation_warning(deprecated_method_name, message = nil, caller_backtrace = nil); end
+  def self.gem_name(*args, &block); end
+  def self.gem_name=(arg); end
+  def self.initialize(*args, &block); end
+  def self.instance; end
+  def self.new(*arg0); end
+  def self.silence(*args, &block); end
+  def self.silenced(*args, &block); end
+  def self.silenced=(arg); end
+  def self.warn(message = nil, callstack = nil); end
+  extend ActiveSupport::Deprecation::InstanceDelegator::ClassMethods
+  extend Singleton::SingletonClassMethods
+  include ActiveSupport::Deprecation::Behavior
+  include ActiveSupport::Deprecation::InstanceDelegator
+  include ActiveSupport::Deprecation::MethodWrapper
+  include ActiveSupport::Deprecation::Reporting
+  include Singleton
+end
+module ActiveSupport::Deprecation::InstanceDelegator
+  def self.included(base); end
+end
+module ActiveSupport::Deprecation::InstanceDelegator::ClassMethods
+  def include(included_module); end
+  def method_added(method_name); end
+end
+module ActiveSupport::Deprecation::InstanceDelegator::OverrideDelegators
+  def deprecation_warning(deprecated_method_name, message = nil, caller_backtrace = nil); end
+  def warn(message = nil, callstack = nil); end
+end
+module ActiveSupport::Notifications
+  def self.instrument(name, payload = nil); end
+  def self.instrumenter; end
+  def self.notifier; end
+  def self.notifier=(arg0); end
+  def self.publish(name, *args); end
+  def self.subscribe(*args, &block); end
+  def self.subscribed(callback, *args, &block); end
+  def self.unsubscribe(subscriber_or_name); end
+end
+class ActiveSupport::Notifications::Instrumenter
+  def finish(name, payload); end
+  def finish_with_state(listeners_state, name, payload); end
+  def id; end
+  def initialize(notifier); end
+  def instrument(name, payload = nil); end
+  def start(name, payload); end
+  def unique_id; end
+end
+class ActiveSupport::Notifications::Event
+  def <<(event); end
+  def allocations; end
+  def children; end
+  def cpu_time; end
+  def duration; end
+  def end; end
+  def end=(ending); end
+  def finish!; end
+  def idle_time; end
+  def initialize(name, start, ending, transaction_id, payload); end
+  def name; end
+  def now; end
+  def now_allocations; end
+  def now_cpu; end
+  def parent_of?(event); end
+  def payload; end
+  def self.clock_gettime_supported?; end
+  def start!; end
+  def time; end
+  def transaction_id; end
+end
+class ActiveSupport::Notifications::Fanout
+  def finish(name, id, payload, listeners = nil); end
+  def initialize; end
+  def listeners_for(name); end
+  def listening?(name); end
+  def lock; end
+  def locked?; end
+  def publish(name, *args); end
+  def start(name, id, payload); end
+  def subscribe(pattern = nil, callable = nil, &block); end
+  def synchronize(&block); end
+  def try_lock; end
+  def unlock; end
+  def unsubscribe(subscriber_or_name); end
+  def wait; end
+  include Mutex_m
+end
+module ActiveSupport::Notifications::Fanout::Subscribers
+  def self.event_object_subscriber(pattern, block); end
+  def self.new(pattern, listener); end
+  def self.wrap_all(pattern, subscriber); end
+end
+class ActiveSupport::Notifications::Fanout::Subscribers::Matcher
+  def ===(name); end
+  def exclusions; end
+  def initialize(pattern); end
+  def pattern; end
+  def self.wrap(pattern); end
+  def unsubscribe!(name); end
+end
+class ActiveSupport::Notifications::Fanout::Subscribers::Evented
+  def finish(name, id, payload); end
+  def initialize(pattern, delegate); end
+  def matches?(name); end
+  def pattern; end
+  def publish(name, *args); end
+  def start(name, id, payload); end
+  def subscribed_to?(name); end
+  def unsubscribe!(name); end
+end
+class ActiveSupport::Notifications::Fanout::Subscribers::Timed < ActiveSupport::Notifications::Fanout::Subscribers::Evented
+  def finish(name, id, payload); end
+  def publish(name, *args); end
+  def start(name, id, payload); end
+end
+class ActiveSupport::Notifications::Fanout::Subscribers::EventObject < ActiveSupport::Notifications::Fanout::Subscribers::Evented
+  def build_event(name, id, payload); end
+  def finish(name, id, payload); end
+  def start(name, id, payload); end
+end
+class ActiveSupport::Notifications::Fanout::Subscribers::AllMessages
+  def finish(name, id, payload); end
+  def initialize(delegate); end
+  def matches?(arg0); end
+  def publish(name, *args); end
+  def start(name, id, payload); end
+  def subscribed_to?(name); end
+  def unsubscribe!(*arg0); end
+end
+module ActiveSupport::PerThreadRegistry
+  def instance; end
+  def method_missing(name, *args, &block); end
+  def self.extended(object); end
+end
+class ActiveSupport::Notifications::InstrumentationRegistry
+  def initialize; end
+  def instrumenter_for(notifier); end
+  extend ActiveSupport::PerThreadRegistry
+end
+class ActiveSupport::DeprecationException < StandardError
+end
+module ActiveSupport::Deprecation::Behavior
+  def arity_coerce(behavior); end
+  def behavior; end
+  def behavior=(behavior); end
+  def debug; end
+  def debug=(arg0); end
+end
+module ActiveSupport::Deprecation::Reporting
+  def _extract_callstack(callstack); end
+  def deprecated_method_warning(method_name, message = nil); end
+  def deprecation_caller_message(callstack); end
+  def deprecation_message(callstack, message = nil); end
+  def deprecation_warning(deprecated_method_name, message = nil, caller_backtrace = nil); end
+  def extract_callstack(callstack); end
+  def gem_name; end
+  def gem_name=(arg0); end
+  def ignored_callstack(path); end
+  def silence; end
+  def silenced; end
+  def silenced=(arg0); end
+  def warn(message = nil, callstack = nil); end
+end
+module ActiveSupport::Deprecation::DeprecatedConstantAccessor
+  def self.included(base); end
+end
+class Array
+  def blank?; end
+  def extract_options!; end
+end
+module ActiveSupport::Deprecation::MethodWrapper
+  def deprecate_methods(target_module, *method_names); end
+end
+class ActiveSupport::Deprecation::DeprecationProxy
+  def inspect; end
+  def method_missing(called, *args, &block); end
+  def self.new(*args, &block); end
+end
+class ActiveSupport::Deprecation::DeprecatedObjectProxy < ActiveSupport::Deprecation::DeprecationProxy
+  def initialize(object, message, deprecator = nil); end
+  def target; end
+  def warn(callstack, called, args); end
+end
+class ActiveSupport::Deprecation::DeprecatedInstanceVariableProxy < ActiveSupport::Deprecation::DeprecationProxy
+  def initialize(instance, method, var = nil, deprecator = nil); end
+  def target; end
+  def warn(callstack, called, args); end
+end
+class ActiveSupport::Deprecation::DeprecatedConstantProxy < Module
+  def class; end
+  def const_missing(name); end
+  def initialize(old_const, new_const, deprecator = nil, message: nil); end
+  def inspect; end
+  def method_missing(called, *args, &block); end
+  def self.new(*args, &block); end
+  def target; end
+end
+module ActiveSupport::Inflector
+  def apply_inflections(word, rules, locale = nil); end
+  def camelize(term, uppercase_first_letter = nil); end
+  def classify(table_name); end
+  def const_regexp(camel_cased_word); end
+  def constantize(camel_cased_word); end
+  def dasherize(underscored_word); end
+  def deconstantize(path); end
+  def demodulize(path); end
+  def foreign_key(class_name, separate_class_name_and_id_with_underscore = nil); end
+  def humanize(lower_case_and_underscored_word, capitalize: nil, keep_id_suffix: nil); end
+  def inflections(locale = nil); end
+  def ordinal(number); end
+  def ordinalize(number); end
+  def parameterize(string, separator: nil, preserve_case: nil, locale: nil); end
+  def pluralize(word, locale = nil); end
+  def safe_constantize(camel_cased_word); end
+  def singularize(word, locale = nil); end
+  def tableize(class_name); end
+  def titleize(word, keep_id_suffix: nil); end
+  def transliterate(string, replacement = nil, locale: nil); end
+  def underscore(camel_cased_word); end
+  def upcase_first(string); end
+  extend ActiveSupport::Inflector
+  extend ActiveSupport::Inflector
+end
+class ActiveSupport::Inflector::Inflections
+  def acronym(word); end
+  def acronyms; end
+  def acronyms_camelize_regex; end
+  def acronyms_underscore_regex; end
+  def clear(scope = nil); end
+  def define_acronym_regex_patterns; end
+  def human(rule, replacement); end
+  def humans; end
+  def initialize; end
+  def initialize_dup(orig); end
+  def irregular(singular, plural); end
+  def plural(rule, replacement); end
+  def plurals; end
+  def self.instance(locale = nil); end
+  def singular(rule, replacement); end
+  def singulars; end
+  def uncountable(*words); end
+  def uncountables; end
+end
+class ActiveSupport::Inflector::Inflections::Uncountables < Array
+  def <<(*word); end
+  def add(words); end
+  def delete(entry); end
+  def initialize; end
+  def to_regex(string); end
+  def uncountable?(str); end
+end
+module ActiveSupport::Autoload
+  def autoload(const_name, path = nil); end
+  def autoload_at(path); end
+  def autoload_under(path); end
+  def autoloads; end
+  def eager_autoload; end
+  def eager_load!; end
+  def self.extended(base); end
+end
+module ActiveSupport::VERSION
+end
+module ActiveSupport::Concern
+  def append_features(base); end
+  def class_methods(&class_methods_module_definition); end
+  def included(base = nil, &block); end
+  def self.extended(base); end
+end
+class ActiveSupport::Concern::MultipleIncludedBlocks < StandardError
+  def initialize; end
+end
+module ActiveSupport::LoggerThreadSafeLevel
+  def add(severity, message = nil, progname = nil, &block); end
+  def after_initialize; end
+  def debug?; end
+  def error?; end
+  def fatal?; end
+  def info?; end
+  def level; end
+  def local_level; end
+  def local_level=(level); end
+  def local_log_id; end
+  def unknown?; end
+  def warn?; end
+  extend ActiveSupport::Concern
+end
+module LoggerSilence
+  extend ActiveSupport::Concern
+end
+module ActiveSupport::LoggerSilence
+  def silence(temporary_level = nil); end
+  extend ActiveSupport::Concern
+end
+class ActiveSupport::Logger < Logger
+  def initialize(*args); end
+  def self.broadcast(logger); end
+  def self.local_levels; end
+  def self.local_levels=(obj); end
+  def self.logger_outputs_to?(logger, *sources); end
+  def self.silencer; end
+  def self.silencer=(obj); end
+  def silencer; end
+  def silencer=(obj); end
+  include ActiveSupport::LoggerSilence
+  include ActiveSupport::LoggerThreadSafeLevel
+end
+class ActiveSupport::Logger::SimpleFormatter < Logger::Formatter
+  def call(severity, timestamp, progname, msg); end
+end
+module DateAndTime
+end
+module DateAndTime::Compatibility
+  def preserve_timezone; end
+  def self.preserve_timezone; end
+  def self.preserve_timezone=(obj); end
+end
+class Object < BasicObject
+  def blank?; end
+  def presence; end
+  def present?; end
+end
+class NilClass
+  def blank?; end
+end
+class FalseClass
+  def blank?; end
+end
+class TrueClass
+  def blank?; end
+end
+class String
+  def camelcase(first_letter = nil); end
+  def camelize(first_letter = nil); end
+  def classify; end
+  def constantize; end
+  def dasherize; end
+  def deconstantize; end
+  def demodulize; end
+  def foreign_key(separate_class_name_and_id_with_underscore = nil); end
+  def humanize(capitalize: nil, keep_id_suffix: nil); end
+  def is_utf8?; end
+  def mb_chars; end
+  def parameterize(separator: nil, preserve_case: nil, locale: nil); end
+  def pluralize(count = nil, locale = nil); end
+  def safe_constantize; end
+  def singularize(locale = nil); end
+  def tableize; end
+  def titlecase(keep_id_suffix: nil); end
+  def titleize(keep_id_suffix: nil); end
+  def underscore; end
+  def upcase_first; end
+end
+class Numeric
+  def blank?; end
+end
+class Time
+  def blank?; end
+end
+class Class < Module
+  def class_attribute(*attrs, instance_accessor: nil, instance_reader: nil, instance_writer: nil, instance_predicate: nil, default: nil); end
+end
+module ActiveSupport::Multibyte
+  def self.proxy_class; end
+  def self.proxy_class=(klass); end
+end