clean-architecture 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c49173a8914ea9260202535efe792a4a678619d
-  data.tar.gz: 508d35b34541f7b631cf1ea8fd994b4b20e08927
+  metadata.gz: d751cba3aff6904c1fc224d28039d479ea698805
+  data.tar.gz: 37182b20aab7f39b7caf92aae13db1efb186ba10
 SHA512:
-  metadata.gz: 9cf655b8ae3fddb3071fb12b817b4b3e08863a34e0007a06d15c814c3cbde3d43057f62dca01ade1bfe02aed5634850e5b2852d6c9647a83055f598494cb6ec4
-  data.tar.gz: b92ebb0350cd0d79ed012c0318560bfef0148fa5669a6e4837f1c7f48a87611e44dafea1b6cfa75dc228946e28c34e42b44572f3a4c9c238b9e626d372c3203f
+  metadata.gz: f003370b9134dcc89007f48a3d754c4e55603aa191a12ad599107f46cc2d91088cad2d4c2f6accf61ebe87819126d289f645f0e0858dee418ca839838b93a6b7
+  data.tar.gz: 5479aaa78c7e438f581af8f8481fa025f40b6705b55181aae59389492f74d927d63a3e709b48aa7cd3377953808075968c4198591ca6697de6cc1978931c8847

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+1.0.0
+
+  * Remove strategy and command interfaces
+  * Turn Authorization into a virtual class rather than an interface
+  * Remove ActorGetsAuthorizedThenDoesWork in favour of having the Authorization virtual class
+    return a result type (use .bind in the client)
+  * Change WithAuditTrail to WriteUseCaseAuditTrail command with a result
+
 0.2.0
 
   * Add Entities::FailureDetails and support for it in the various Serializers

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    clean-architecture (0.2.0)
+    clean-architecture (1.0.0)
       dry-matcher (~> 0.0)
       dry-monads (~> 1.0)
       dry-struct (~> 0.0)

data/lib/clean_architecture/all.rb

@@ -3,6 +3,8 @@
 # THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED
 
 require 'clean_architecture/adapters/all'
+require 'clean_architecture/checks/all'
+require 'clean_architecture/commands/all'
 require 'clean_architecture/entities/all'
 require 'clean_architecture/interfaces/all'
 require 'clean_architecture/matchers/all'

data/lib/clean_architecture/checks/all.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED
+
+require 'clean_architecture/checks/authorization'

data/lib/clean_architecture/checks/authorization.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'dry/monads/all'
+require 'clean_architecture/entities/failure_details'
+
+module CleanArchitecture
+  module Checks
+    class Authorization
+      extend Forwardable
+
+      def result
+        if authorized?
+          Dry::Monads::Success(true)
+        else
+          failure_details = Entities::FailureDetails.new(
+            message: failure_message,
+            other_properties: {},
+            type: 'unauthorized'
+          )
+          Dry::Monads::Failure(failure_details)
+        end
+      end
+
+      protected
+
+      def failure_message
+        'Unauthorized'
+      end
+
+      def authorized?
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/clean_architecture/commands/all.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED
+
+require 'clean_architecture/commands/write_use_case_audit_trail'

data/lib/clean_architecture/commands/write_use_case_audit_trail.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'clean_architecture/entities/use_case_history_entry'
+require 'duckface'
+
+module CleanArchitecture
+  module Commands
+    class WriteUseCaseAuditTrail
+      extend Forwardable
+
+      def initialize(use_case_target)
+        @use_case_target = use_case_target
+      end
+
+      def result
+        @result ||= begin
+          entry = Entities::UseCaseHistoryEntry.new(@use_case_target)
+          parameters.persistence.create_use_case_history_entry(entry)
+        end
+      end
+    end
+  end
+end

data/lib/clean_architecture/entities/failure_details.rb

@@ -15,7 +15,7 @@ module CleanArchitecture
 
       attribute :type, FailureTypes
       attribute :message, Types::Strict::String
-      attribute :other_properties, Types::Strict::Hash
+      attribute :other_properties, Types::Strict::Hash.default({})
     end
   end
 end

data/lib/clean_architecture/entities/use_case_history_entry.rb

@@ -12,11 +12,12 @@ module CleanArchitecture
       implements_interface Interfaces::UseCaseHistoryEntry
       extend Forwardable
 
-      def initialize(use_case_class, use_case_parameters, use_case_result, use_case_target)
-        @use_case_class = use_case_class
-        @use_case_parameters = use_case_parameters
-        @use_case_result = use_case_result
+      def initialize(use_case, use_case_target)
+        @use_case = use_case
         @use_case_target = use_case_target
+        @use_case_class = @use_case.class
+        @use_case_parameters = @use_case.parameters
+        @use_case_result = @use_case.result
       end
 
       def extra_parameters_hash

data/lib/clean_architecture/interfaces/all.rb

@@ -2,13 +2,10 @@
 
 # THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED
 
-require 'clean_architecture/interfaces/authorization_check'
 require 'clean_architecture/interfaces/authorization_parameters'
 require 'clean_architecture/interfaces/base_parameters'
-require 'clean_architecture/interfaces/command'
 require 'clean_architecture/interfaces/jsonable'
 require 'clean_architecture/interfaces/persistence'
-require 'clean_architecture/interfaces/strategy'
 require 'clean_architecture/interfaces/success_payload'
 require 'clean_architecture/interfaces/targeted_parameters'
 require 'clean_architecture/interfaces/use_case'

data/lib/clean_architecture/strategies/all.rb

@@ -2,5 +2,3 @@
 
 # THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED
 
-require 'clean_architecture/strategies/actor_gets_authorized_then_does_work'
-require 'clean_architecture/strategies/with_audit_trail'

data/lib/clean_architecture/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CleanArchitecture
-  VERSION = '0.2.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clean-architecture
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Bellroy Tech Team
@@ -148,19 +148,20 @@ files:
 - lib/clean_architecture/adapters/all.rb
 - lib/clean_architecture/adapters/attribute_hash_base.rb
 - lib/clean_architecture/all.rb
+- lib/clean_architecture/checks/all.rb
+- lib/clean_architecture/checks/authorization.rb
+- lib/clean_architecture/commands/all.rb
+- lib/clean_architecture/commands/write_use_case_audit_trail.rb
 - lib/clean_architecture/entities/all.rb
 - lib/clean_architecture/entities/failure_details.rb
 - lib/clean_architecture/entities/targeted_parameters.rb
 - lib/clean_architecture/entities/untargeted_parameters.rb
 - lib/clean_architecture/entities/use_case_history_entry.rb
 - lib/clean_architecture/interfaces/all.rb
-- lib/clean_architecture/interfaces/authorization_check.rb
 - lib/clean_architecture/interfaces/authorization_parameters.rb
 - lib/clean_architecture/interfaces/base_parameters.rb
-- lib/clean_architecture/interfaces/command.rb
 - lib/clean_architecture/interfaces/jsonable.rb
 - lib/clean_architecture/interfaces/persistence.rb
-- lib/clean_architecture/interfaces/strategy.rb
 - lib/clean_architecture/interfaces/success_payload.rb
 - lib/clean_architecture/interfaces/targeted_parameters.rb
 - lib/clean_architecture/interfaces/use_case.rb
@@ -176,9 +177,7 @@ files:
 - lib/clean_architecture/serializers/html_response_from_result.rb
 - lib/clean_architecture/serializers/json_response_from_result.rb
 - lib/clean_architecture/serializers/success_payload.rb
-- lib/clean_architecture/strategies/actor_gets_authorized_then_does_work.rb
 - lib/clean_architecture/strategies/all.rb
-- lib/clean_architecture/strategies/with_audit_trail.rb
 - lib/clean_architecture/types.rb
 - lib/clean_architecture/version.rb
 homepage: https://bellroy.com

data/lib/clean_architecture/interfaces/authorization_check.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require 'duckface'
-
-module CleanArchitecture
-  module Interfaces
-    module AuthorizationCheck
-      extend Duckface::ActsAsInterface
-
-      def authorized?
-        raise NotImplementedError
-      end
-    end
-  end
-end

data/lib/clean_architecture/interfaces/command.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'duckface'
-
-module CleanArchitecture
-  module Interfaces
-    module Command
-      extend Duckface::ActsAsInterface
-
-      def initialize(_parameters)
-        raise NotImplementedError
-      end
-
-      def parameters
-        raise NotImplementedError
-      end
-
-      def result
-        raise NotImplementedError
-      end
-    end
-  end
-end

data/lib/clean_architecture/interfaces/strategy.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module CleanArchitecture
-  module Interfaces
-    module Strategy
-      extend Duckface::ActsAsInterface
-
-      def parameters
-        raise NotImplementedError
-      end
-
-      def result
-        raise NotImplementedError
-      end
-    end
-  end
-end

data/lib/clean_architecture/strategies/actor_gets_authorized_then_does_work.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require 'dry/monads/all'
-require 'clean_architecture/entities/failure_details'
-require 'clean_architecture/interfaces/strategy'
-
-module CleanArchitecture
-  module Strategies
-    class ActorGetsAuthorizedThenDoesWork
-      extend Forwardable
-
-      implements_interface Interfaces::Strategy
-
-      def initialize(authorization_check, sub_strategy)
-        @authorization_check = authorization_check
-        @sub_strategy = sub_strategy
-      end
-
-      def_delegator :@sub_strategy, :parameters
-
-      UNAUTHORIZED_FAILURE_DETAILS = Entities::FailureDetails.new(
-        message: 'Unauthorized',
-        other_properties: {},
-        type: 'unauthorized'
-      )
-
-      def result
-        @result ||= begin
-          if @authorization_check.authorized?
-            @sub_strategy.result
-          else
-            Dry::Monads::Failure(UNAUTHORIZED_FAILURE_DETAILS)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/clean_architecture/strategies/with_audit_trail.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require 'clean_architecture/entities/use_case_history_entry'
-require 'clean_architecture/interfaces/strategy'
-require 'duckface'
-
-module CleanArchitecture
-  module Strategies
-    class WithAuditTrail
-      implements_interface Interfaces::Strategy
-      extend Forwardable
-
-      def initialize(use_case_class, sub_strategy, use_case_target)
-        @use_case_class = use_case_class
-        @sub_strategy = sub_strategy
-        @use_case_target = use_case_target
-      end
-
-      def result
-        @result ||= begin
-          strategy_result = @sub_strategy.result
-          entry = new_use_case_history_entry(strategy_result)
-          parameters.persistence.create_use_case_history_entry(entry)
-          strategy_result
-        end
-      end
-
-      def_delegator :@sub_strategy, :parameters
-
-      private
-
-      def new_use_case_history_entry(sub_strategy_result)
-        Entities::UseCaseHistoryEntry.new(
-          @use_case_class,
-          @sub_strategy.parameters,
-          sub_strategy_result,
-          @use_case_target
-        )
-      end
-    end
-  end
-end