clean-architecture 2.0.0 → 3.0.0

data/clean-architecture.gemspec

@@ -19,13 +19,17 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'dry-matcher', '~> 0.0'
-  spec.add_dependency 'dry-monads', '~> 1.0'
-  spec.add_dependency 'dry-struct', '~> 0.0'
-  spec.add_dependency 'dry-types', '~> 0.0'
+  spec.add_dependency 'activemodel', '>= 5'
+  spec.add_dependency 'activesupport', '>= 5'
+  spec.add_dependency 'dry-matcher'
+  spec.add_dependency 'dry-monads'
+  spec.add_dependency 'dry-struct'
+  spec.add_dependency 'dry-types'
+  spec.add_dependency 'dry-validation', '>= 1.0.0'
   spec.add_dependency 'duckface-interfaces', '~> 0.0'
+  spec.add_dependency 'sorbet-runtime'
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/generate_require_files.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 def directories_in(root)

data/lib/clean-architecture.rb

@@ -1,3 +1,4 @@
+# typed: strong
 # frozen_string_literal: true
 
 require 'clean_architecture/all'

data/lib/clean_architecture/adapters/all.rb

@@ -1,3 +1,4 @@
+# typed: strong
 # frozen_string_literal: true
 
 # THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED

data/lib/clean_architecture/adapters/attribute_hash_base.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'time'

data/lib/clean_architecture/all.rb

@@ -1,14 +1,17 @@
+# typed: strong
 # frozen_string_literal: true
 
 # THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED
 
 require 'clean_architecture/adapters/all'
+require 'clean_architecture/builders/all'
 require 'clean_architecture/checks/all'
 require 'clean_architecture/entities/all'
 require 'clean_architecture/interfaces/all'
 require 'clean_architecture/matchers/all'
 require 'clean_architecture/queries/all'
 require 'clean_architecture/serializers/all'
+require 'clean_architecture/use_cases/all'
 
 require 'clean_architecture/types'
 require 'clean_architecture/version'

data/lib/clean_architecture/builders/abstract_active_record_entity_builder.rb

@@ -0,0 +1,124 @@
+# typed: false
+# frozen_string_literal: true
+
+module CleanArchitecture
+  module Builders
+    # Helps to take an instance of an AR model and wrap it up in the given Entity
+    # Any columns from the AR model that do not directly map to an attribute on the Entity
+    # can be specified by overriding #attributes_for_entity.
+    class AbstractActiveRecordEntityBuilder
+      # @param [Class] A Dry::Struct based entity that this builder will construct instances of
+      def self.acts_as_builder_for_entity(entity_class)
+        @has_many_builders = []
+        @belongs_to_builders = []
+
+        define_singleton_method :has_many_builders do
+          @has_many_builders
+        end
+
+        define_singleton_method :belongs_to_builders do
+          @belongs_to_builders
+        end
+
+        define_method :entity_class do
+          entity_class
+        end
+
+        private :entity_class
+      end
+
+      def self.has_many(relation_name, use:)
+        @has_many_builders << [relation_name, use]
+      end
+
+      def self.belongs_to(relation_name, use:)
+        @belongs_to_builders << [relation_name, use]
+      end
+
+      # @param [ActiveRecord::Base] An ActiveRecord model to map to the entity
+      def initialize(ar_model_instance)
+        @ar_model_instance = ar_model_instance
+      end
+
+      def build
+        entity_class.new(all_attributes_for_entity)
+      end
+
+      private
+
+      attr_reader :ar_model_instance
+
+      def entity_attribute_names
+        @entity_attributes ||= begin
+          if entity_class.respond_to?(:schema) # Dry::Struct
+            schema_keys = entity_class.schema.keys
+          elsif entity_class.respond_to?(:decorator) # T::Struct
+            schema_keys = entity_class.decorator.props.keys
+          else
+            raise 'Cannot determine schema format'
+          end
+          first_key = schema_keys.first
+          if first_key.is_a?(Symbol)
+            schema_keys
+          elsif first_key.respond_to?(:name)
+            schema_keys.map(&:name)
+          else
+            raise 'Cannot determine schema format'
+          end
+        end
+      end
+
+      def ar_model_instance_attributes
+        @ar_model_instance_attributes ||= @ar_model_instance.attributes
+      end
+
+      def symbolized_ar_model_instance_attributes
+        @symbolized_ar_model_instance_attributes ||= Hash[
+          ar_model_instance_attributes.map{|(key, value)| [key.to_sym, value]}
+        ]
+      end
+
+      def ar_attributes_for_entity
+        symbolized_ar_model_instance_attributes.slice(*entity_attribute_names)
+      end
+
+      def attributes_for_belongs_to_relations
+        self.class.belongs_to_builders.map do |belongs_to_builder_config|
+          relation_name, builder_class = belongs_to_builder_config
+          relation = @ar_model_instance.public_send(relation_name)
+
+          [
+            relation_name,
+            relation ? builder_class.new(relation).build : nil
+          ]
+        end.to_h
+      end
+
+      def attributes_for_has_many_relations
+        self.class.has_many_builders.map do |has_many_builder_config|
+          relation_name, builder_class = has_many_builder_config
+          relations = @ar_model_instance.public_send(relation_name)
+          built_relations = relations.map do |relation|
+            builder_class.new(relation).build
+          end
+
+          [
+            relation_name,
+            built_relations
+          ]
+        end.to_h
+      end
+
+      def attributes_for_entity
+        {}
+      end
+
+      def all_attributes_for_entity
+        ar_attributes_for_entity
+          .merge(attributes_for_belongs_to_relations)
+          .merge(attributes_for_has_many_relations)
+          .merge(attributes_for_entity)
+      end
+    end
+  end
+end

data/lib/clean_architecture/builders/all.rb

@@ -0,0 +1,6 @@
+# typed: strong
+# frozen_string_literal: true
+
+# THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED
+
+require 'clean_architecture/builders/abstract_active_record_entity_builder'

data/lib/clean_architecture/checks/all.rb

@@ -1,3 +1,4 @@
+# typed: strong
 # frozen_string_literal: true
 
 # THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED

data/lib/clean_architecture/checks/authorization.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'dry/monads/all'

data/lib/clean_architecture/entities/all.rb

@@ -1,3 +1,4 @@
+# typed: strong
 # frozen_string_literal: true
 
 # THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED

data/lib/clean_architecture/entities/failure_details.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'clean_architecture/types'
@@ -15,7 +16,7 @@ module CleanArchitecture
 
       attribute :type, FailureTypes
       attribute :message, Types::Strict::String
-      attribute :other_properties, Types::Strict::Hash.default({})
+      attribute :other_properties, Types::Strict::Hash.default({}.freeze)
 
       def self.from_array(array)
         new(message: array.map(&:to_s).join(', '), other_properties: {}, type: 'error')

data/lib/clean_architecture/entities/targeted_parameters.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'clean_architecture/interfaces/targeted_parameters'

data/lib/clean_architecture/entities/untargeted_parameters.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'clean_architecture/interfaces/base_parameters'

data/lib/clean_architecture/interfaces/all.rb

@@ -1,3 +1,4 @@
+# typed: strong
 # frozen_string_literal: true
 
 # THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED

data/lib/clean_architecture/interfaces/authorization_parameters.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'clean_architecture/interfaces/base_parameters'

data/lib/clean_architecture/interfaces/base_parameters.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'duckface'

data/lib/clean_architecture/interfaces/jsonable.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'duckface'

data/lib/clean_architecture/interfaces/success_payload.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'duckface'

data/lib/clean_architecture/interfaces/targeted_parameters.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'clean_architecture/interfaces/base_parameters'

data/lib/clean_architecture/interfaces/use_case.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'duckface'

data/lib/clean_architecture/interfaces/use_case_actor.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'duckface'

data/lib/clean_architecture/interfaces/use_case_target.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'duckface'

data/lib/clean_architecture/matchers/all.rb

@@ -1,3 +1,4 @@
+# typed: strong
 # frozen_string_literal: true
 
 # THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED

data/lib/clean_architecture/matchers/use_case_result.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'clean_architecture/entities/failure_details'

data/lib/clean_architecture/queries/all.rb

@@ -1,3 +1,4 @@
+# typed: strong
 # frozen_string_literal: true
 
 # THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED

data/lib/clean_architecture/queries/http_failure_code.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module CleanArchitecture

data/lib/clean_architecture/queries/http_success_code.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module CleanArchitecture

data/lib/clean_architecture/serializers/all.rb

@@ -1,3 +1,4 @@
+# typed: strong
 # frozen_string_literal: true
 
 # THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED

data/lib/clean_architecture/serializers/html_response_from_result.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'clean_architecture/entities/failure_details'

data/lib/clean_architecture/serializers/json_response_from_result.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'clean_architecture/entities/failure_details'

data/lib/clean_architecture/serializers/success_collection_payload.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'duckface'

data/lib/clean_architecture/serializers/success_payload.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'duckface'

data/lib/clean_architecture/types.rb

@@ -1,7 +1,8 @@
+# typed: ignore
 # frozen_string_literal: true
 
 require 'dry-types'
 
 module Types
-  include Dry::Types.module
+  include Dry.Types()
 end

data/lib/clean_architecture/use_cases/abstract_use_case.rb

@@ -0,0 +1,62 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'dry/monads/result'
+require 'dry/validation'
+require 'dry/matcher/result_matcher'
+require 'clean_architecture/use_cases/errors'
+require 'clean_architecture/use_cases/parameters'
+require 'clean_architecture/use_cases/contract'
+require 'clean_architecture/entities/failure_details'
+
+module CleanArchitecture
+  module UseCases
+    class AbstractUseCase
+      extend Forwardable
+
+      @contract = nil
+
+      def self.contract(base_contract = Contract)
+        @contract ||= begin
+          Class.new(base_contract, &Proc.new)
+        end
+      end
+
+      def self.parameters(params)
+        raise 'You must define a contract first' if @contract.nil?
+
+        context = params.fetch(:context, {})
+        Parameters.new(
+          context,
+          contract.new(context).call(params)
+        )
+      end
+
+      def initialize(params)
+        @params = params
+      end
+
+      def result
+        raise NotImplementedError
+      end
+
+      private
+
+      DEFAULT_FAILURE_TYPE = 'error'
+
+      def fail_with_error_message(message, failure_type = DEFAULT_FAILURE_TYPE)
+        new_errors = Errors.new(nil, failure_type)
+        new_errors.add(:base, message)
+        Dry::Monads::Failure(new_errors)
+      end
+
+      def result_of_validating_params
+        @params.to_monad
+      end
+
+      def context(key)
+        @params.context(key)
+      end
+    end
+  end
+end

data/lib/clean_architecture/use_cases/all.rb

@@ -0,0 +1,10 @@
+# typed: strong
+# frozen_string_literal: true
+
+# THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED
+
+require 'clean_architecture/use_cases/abstract_use_case'
+require 'clean_architecture/use_cases/contract'
+require 'clean_architecture/use_cases/errors'
+require 'clean_architecture/use_cases/form'
+require 'clean_architecture/use_cases/parameters'