clean-architecture 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb6fbe1a9004389c1d14f8cbe72293825ffc8530
-  data.tar.gz: 13838c48fd2f72411bd17afe06d7810832f95c41
+  metadata.gz: 0355fa965f9398c91c72c743a402a76fd6d368f7
+  data.tar.gz: 1ffe824aa7cfb103368ec19def56b71303a5d03e
 SHA512:
-  metadata.gz: '084fbabf3a62f60fdc360535cd53e031892dfdcd784a1b8580edd471aa1b11d9e77b814c4ed7db6d52829fb2a854853e1967180ed3fd124fed9843e3000de509'
-  data.tar.gz: b35ef32add448162a6595debb3b7ca74b79fb5625fbe8b82a353cd54a9116678111d7391f3047b237e2378f11fb709f1786a4c5c723c9b8e2a8cfe87f5a3352f
+  metadata.gz: f2bff0f8f22af994574f97bf16c35012aebf8ef6f8476561068e6d4b7fac5fb04e68af540e7c0651056a4f1ed845e10f828043c957d02a1cf7d18b1b2845811e
+  data.tar.gz: e119b8dc2e8e9bc42684839bb5a2c5a13fc5fe09db8b08160e17f7e02d0cd0f510f318d6ef808355b25aee974fb57b7ef65e449d4b3fe849034bc7342a35dbcb

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+0.0.3
+
+  * Fix require files
+  
+0.0.2
+
+  * Add Serializers::SuccessPayload
+
 0.0.1
 
   * Initial release

data/README.md

@@ -15,3 +15,70 @@ And then execute:
 
     $ bundle install
     $ bundle binstubs clean-architecture
+
+## Usage
+
+The intention of this gem is to help you build applications that are built from the use case down,
+and decisions about I/O can be deferred until the last possible moment. It relies heavily on the
+[duckface-interfaces](https://github.com/samuelgiles/duckface) gem to enforce interface
+implementation.
+
+### Use cases as an organisational principle
+
+Uncle Bob suggests that your source code organisation should allow developers to easily find a
+listing of all use cases your application provides. Here's an example of how this might look in a
+Rails application.
+
+```
+- lib
+  - my_banking_application
+    - use_cases
+      - retail_customer_opens_bank_account.rb
+      - retail_customer_makes_a_deposit.rb
+      - ...
+```
+
+### Clean architecture principles
+
+* The code that manages your inputs (e.g. a Rails controller) instantiates a persistence layer
+  object
+  - Suggest: a class that implements both the `Persistence` interface and your own persistence
+    interface
+
+```
+  persistence = ActiveRecordPersistence.new
+```
+
+* The code that manages your inputs (e.g. a Rails controller) instantiates a use case actor
+  object
+  - Suggest: a class that implements the `UseCaseActor` interface
+
+```
+  use_case_actor = MyUseCaseActorAdapter.new(devise_current_user)
+```
+
+* The code that manages your inputs (e.g. a Rails controller) instantiates a use case input port
+  object
+  - Suggest: a class that implements the `BaseParameters` interface
+  - Suggest: implement the `AuthorizationParameters` interface if you want to make authorization
+    part of your use case logic
+  - Suggest: implement the `TargetedParameters` if your use case operates on a single object
+  - Suggest: use the `TargetedParameters` entity for an out-of-the-box class that gives you all of
+    these
+
+```
+  input_port = CleanArchitecture::Entities::TargetedParameters.new(
+    use_case_actor,
+    TargetActiveRecordClass.find(params[:id]),
+    strong_params,
+    persistence,
+    other_settings_hash
+  )
+```
+
+* The code that manages your inputs (e.g. a Rails controller) instantiates a use case object
+  - Suggest: a class that implements the `UseCase` interface
+
+```
+  use_case = MyBankingApplication::UseCases::RetailCustomerMakesADeposit.new(input_port)
+```

data/lib/clean_architecture/all.rb

@@ -2,8 +2,8 @@
 
 # THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED
 
-require 'clean_architecture/interfaces/all'
 require 'clean_architecture/entities/all'
+require 'clean_architecture/interfaces/all'
 require 'clean_architecture/queries/all'
 require 'clean_architecture/serializers/all'
 require 'clean_architecture/strategies/all'

data/lib/clean_architecture/serializers/all.rb

@@ -4,3 +4,4 @@
 
 require 'clean_architecture/serializers/html_response_from_result'
 require 'clean_architecture/serializers/json_response_from_result'
+require 'clean_architecture/serializers/success_payload'

data/lib/clean_architecture/serializers/success_payload.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'duckface'
+
+module CleanArchitecture
+  module Serializers
+    class SuccessPayload
+      implements_interface CleanArchitecture::Interfaces::SuccessPayload
+
+      attr_reader :version
+
+      def initialize(use_case_target, version)
+        @use_case_target = use_case_target
+        @version = version
+      end
+
+      def data_hash
+        {
+          type: @use_case_target.type_name,
+          id: @use_case_target.identifier,
+          attributes: @use_case_target.attribute_hash
+        }.compact
+      end
+    end
+  end
+end

data/lib/clean_architecture/strategies/actor_gets_authorized_then_does_work.rb

@@ -21,7 +21,7 @@ module CleanArchitecture
           if @authorization_check.authorized?
             @sub_strategy.result
           else
-            Dry::Monads::Failure('Unauthorized: Invalid API key')
+            Dry::Monads::Failure('Unauthorized')
           end
         end
       end

data/lib/clean_architecture/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clean-architecture
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Bellroy Tech Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-23 00:00:00.000000000 Z
+date: 2018-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-matcher
@@ -140,6 +140,7 @@ files:
 - lib/clean_architecture/serializers/all.rb
 - 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