clean-architecture 4.0.1 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b553e98f42ca8f4d8c248a3b4cd8193c139c6ec954f3a8f48159e55071ad3dd
-  data.tar.gz: 781afce831f62564aef291aa5f78a589dd0cbf3ad08a7d12c86f6eae7b3f2817
+  metadata.gz: 428e702a6403538a70c6a095576f6eaf6cc3c50396369e2a6909d5a98f6b7abe
+  data.tar.gz: 47f51f5740280413a09444387a95dac0c5ea05aa63a1b6a3f9e34aacb43b2723
 SHA512:
-  metadata.gz: e2dd17013e0ca6ac9500cb202544f77aec084b9c1e964f21e9eea30df993a3e834bda44118d0340b694b3c52c21836c51e6a5559571fbff1ba95a3c1cc35cb79
-  data.tar.gz: e81fb39a065f1c993655e3de55d6e794f1f73e46a1deccee186de9ae116547291421eb92a9c488606d1cf41193d309cddc8acf131793078ce0cf97ff237b355e
+  metadata.gz: 934c13671b48636c3441dbde2843ae47c5e4d4b0c6dac5ae1ae347839336f04ea7f7baf600ec4003429d0a6cce81b67850bf1ab69a39b138cb01506fcf942835
+  data.tar.gz: 506932bad509e26d0f898ca94ff3256edf0034ac84aea2d694d249d7dbf46f80ed83d591ba2477faf6d5e34144fc235b99661f10d30cafae4438f9128104145f

data/.github/workflows/ci.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-18.04
     steps:
     - name: Checkout branch
-      uses: actions/checkout@v1
+      uses: actions/checkout@v2
     - name: Extract branch name
       shell: bash
       run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"

data/CHANGELOG.md

@@ -1,6 +1,10 @@
+5.0.0
+
+  * Rename persistence -> gateway to be consistent with the pattern used through our systems
+
 4.0.1
 
-  * CleanArchiecture::Serializers::JsonResponseFromResult: Pass the success value to the proc
+  * CleanArchitecture::Serializers::JsonResponseFromResult: Pass the success value to the proc
 
 4.0.0
 

data/README.md

@@ -97,7 +97,7 @@ We satisfy the SRP by following these rules:
 
 We satisfy the OCP, LSP & DIP by following these rules:
 
-- We create a clean boundary between our business logic, our persistence layer and our application-specific classes using interfaces
+- We create a clean boundary between our business logic, our gateway and our application-specific classes using interfaces
 - We use interfaces wherever possible, allowing concrete implementations of those interfaces to be extended without breaking the contract
 - We write unit tests against interfaces, never against concrete implementations (unless interfaces don't exist)
 
@@ -157,7 +157,7 @@ We satisfy the SAP by:
 
 ### Practical suggestions for implementation
 
-* The code that manages your inputs (e.g. a Rails controller) instantiates a persistence layer
+* The code that manages your inputs (e.g. a Rails controller) instantiates a gateway
   object
 
 * The code that manages your inputs (e.g. a Rails controller) instantiates a use case actor
@@ -182,7 +182,7 @@ We satisfy the SAP by:
     use_case_actor,
     TargetActiveRecordClass.find(params[:id]),
     strong_params,
-    persistence,
+    gateway,
     other_settings_hash
   )
 ```
@@ -329,7 +329,7 @@ module MyBusinessDomain
   module UseCases
     class UserUpdatesNickname < CleanArchitecture::UseCases::AbstractUseCase
       contract do
-        option :my_persistence_object
+        option :my_gateway_object
 
         params do
           required(:user_id).filled(:id)
@@ -339,7 +339,7 @@ module MyBusinessDomain
         rule(:nickname).validate(:not_already_taken)
 
         register_macro(:not_already_taken) do
-          unless my_persistence_object.username_is_available?(values[key_name])
+          unless my_gateway_object.username_is_available?(values[key_name])
             key.failure('is already taken')
           end
         end
@@ -350,7 +350,7 @@ module MyBusinessDomain
 
       def result
         valid_params = yield result_of_validating_params
-        context(:my_persistence_object).result_of_updating_nickname(
+        context(:my_gateway_object).result_of_updating_nickname(
           valid_params[:id],
           valid_params[:nickname]
         )
@@ -404,7 +404,7 @@ module MyWebApp
     def nickname_update_form
       @nickname_update_form ||= NicknameUpdateForm.new(
         params: params.permit(:user_id, :nickname),
-        context: { my_persistence_object: MyPersistence.new }
+        context: { my_gateway_object: MyGateway.new }
       )
     end
   end
@@ -436,7 +436,7 @@ module MyWebApp
 
     def user_updates_nickname_parameters
       MyBusinessDomain::UseCases::UserUpdatesNickname.parameters(
-        context: { my_persistence_object: MyPersistence.new },
+        context: { my_gateway_object: MyGateway.new },
         user_id: params[:user_id],
         nickname: params[:nickname]
       )
@@ -451,7 +451,7 @@ Elements of contracts can be shared amongst use cases, this can be very helpful
 module MyBusinessDomain
   module UseCases
     class SharedContract < CleanArchitecture::UseCases::Contract
-      option :my_persistence_object
+      option :my_gateway_object
 
       register_macro(:not_already_taken?) do
         unless not_already_taken?(values[key_name])
@@ -462,7 +462,7 @@ module MyBusinessDomain
       private
 
       def not_already_taken?(username)
-        my_persistence_object.username_is_available?(values[key_name])
+        my_gateway_object.username_is_available?(values[key_name])
       end
     end
   end
@@ -476,7 +476,7 @@ module MyBusinessDomain
   module UseCases
     class UserUpdatesNickname < CleanArchitecture::UseCases::AbstractUseCase
       contract(SharedContract) do
-        option :my_persistence_object
+        option :my_gateway_object
 
         params do
           required(:user_id).filled(:id)
@@ -517,7 +517,7 @@ end
 
 ### `#context`
 
-Any context variables defined as `option`'s in your use case contract have to be specified whenever creating an instance of the parameter objects for your use case. In practice this means you can't accidentally forget to pass in say a persistence object / repository / factory / etc.
+Any context variables defined as `option`'s in your use case contract have to be specified whenever creating an instance of the parameter objects for your use case. In practice this means you can't accidentally forget to pass in say a gateway object / repository / factory / etc.
 
 These context variables can be used within the use case using the `context` method:
 
@@ -526,7 +526,7 @@ module MyBusinessDomain
   module UseCases
     class UserUpdatesAge < CleanArchitecture::UseCases::AbstractUseCase
       contract do
-        option :required_persistence_object
+        option :required_gateway_object
 
         params do
           required(:user_id).filled(:int)
@@ -539,7 +539,7 @@ module MyBusinessDomain
       def result
         valid_params = yield result_of_validating_params
 
-        context(:required_persistence_object).update_user_age_result(
+        context(:required_gateway_object).update_user_age_result(
           valid_params[:user_id],
           valid_params[:age]
         )
@@ -560,7 +560,7 @@ module MyBusinessDomain
   module UseCases
     class UserUpdatesChristmasWishlist < CleanArchitecture::UseCases::AbstractUseCase
       contract do
-        option :required_persistence_object
+        option :required_gateway_object
 
         params do
           required(:user_id).filled(:int)
@@ -579,7 +579,7 @@ module MyBusinessDomain
           return fail_with_error_message('Uh oh, Santa has already left the North Pole!')
         end
 
-        context(:required_persistence_object).change_most_wanted_gift(user_id, most_wanted_gift)
+        context(:required_gateway_object).change_most_wanted_gift(user_id, most_wanted_gift)
       end
     end
   end

data/clean-architecture.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   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 'duckface-interfaces'
   spec.add_dependency 'sorbet-runtime'
 
   spec.add_development_dependency 'bundler'

data/lib/clean_architecture/entities/targeted_parameters.rb

@@ -7,16 +7,16 @@ require 'clean_architecture/interfaces/authorization_parameters'
 module CleanArchitecture
   module Entities
     class TargetedParameters
-      attr_reader :actor, :extra_parameters_hash, :persistence, :target, :settings
+      attr_reader :actor, :extra_parameters_hash, :gateway, :target, :settings
 
       implements_interface Interfaces::TargetedParameters
       implements_interface Interfaces::AuthorizationParameters
 
-      def initialize(actor, target, extra_parameters_hash, persistence, settings)
+      def initialize(actor, target, extra_parameters_hash, gateway, settings)
         @actor = actor
         @target = target
         @extra_parameters_hash = extra_parameters_hash
-        @persistence = persistence
+        @gateway = gateway
         @settings = settings
       end
     end

data/lib/clean_architecture/entities/untargeted_parameters.rb

@@ -6,14 +6,14 @@ require 'clean_architecture/interfaces/base_parameters'
 module CleanArchitecture
   module Entities
     class UntargetedParameters
-      attr_reader :actor, :extra_parameters_hash, :persistence, :settings
+      attr_reader :actor, :extra_parameters_hash, :gateway, :settings
 
       implements_interface Interfaces::BaseParameters
 
-      def initialize(actor, extra_parameters_hash, persistence, settings)
+      def initialize(actor, extra_parameters_hash, gateway, settings)
         @actor = actor
         @extra_parameters_hash = extra_parameters_hash
-        @persistence = persistence
+        @gateway = gateway
         @settings = settings
       end
     end

data/lib/clean_architecture/interfaces/base_parameters.rb

@@ -12,7 +12,7 @@ module CleanArchitecture
         raise NotImplementedError
       end
 
-      def persistence
+      def gateway
         raise NotImplementedError
       end
 

data/lib/clean_architecture/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module CleanArchitecture
-  VERSION = '4.0.1'
+  VERSION = '5.0.1'
 end

data/sorbet/rbi/hidden-definitions/errors.txt

@@ -195,7 +195,7 @@
 # wrong constant name define_attribute_method
 # wrong constant name define_attribute_methods
 # wrong constant name undefine_attribute_methods
-# undefined method `initialize<defaultArg>1' for class `#<Class:0x00007fc1ce88af08>'
+# undefined method `initialize<defaultArg>1' for class `#<Class:0x00007ff444bf9218>'
 # wrong constant name <Class:AttributeMethodMatch>
 # wrong constant name initialize<defaultArg>1
 # wrong constant name initialize

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clean-architecture
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 5.0.1
 platform: ruby
 authors:
 - Bellroy Tech Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-27 00:00:00.000000000 Z
+date: 2020-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement