clean-architecture 0.0.1

data/lib/clean_architecture/interfaces/use_case_history_entry.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'duckface'
+
+module CleanArchitecture
+  module Interfaces
+    module UseCaseHistoryEntry
+      extend Duckface::ActsAsInterface
+
+      def extra_parameters_hash
+        raise NotImplementedError
+      end
+
+      def failure_messages
+        raise NotImplementedError
+      end
+
+      def prior_target_state
+        raise NotImplementedError
+      end
+
+      def succeeded?
+        raise NotImplementedError
+      end
+
+      def target_identifier
+        raise NotImplementedError
+      end
+
+      def use_case_class_name
+        raise NotImplementedError
+      end
+
+      def user_identifier
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/clean_architecture/interfaces/use_case_target.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'duckface'
+
+module CleanArchitecture
+  module Interfaces
+    module UseCaseTarget
+      extend Duckface::ActsAsInterface
+
+      def attribute_hash
+        raise NotImplementedError
+      end
+
+      def identifier
+        raise NotImplementedError
+      end
+
+      def type_name
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/clean_architecture/queries/all.rb

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

data/lib/clean_architecture/queries/http_success_code.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module CleanArchitecture
+  module Queries
+    class HttpSuccessCode
+      def initialize(http_method)
+        @http_method = http_method
+      end
+
+      def to_sym
+        code = HTTP_METHOD_TO_SUCCESS_CODE[@http_method]
+        if code.nil?
+          raise NotImplementedError, "cannot determine success code for HTTP method #{@http_method}"
+        end
+        code
+      end
+
+      private
+
+      HTTP_METHOD_TO_SUCCESS_CODE = {
+        'GET' => :ok,
+        'POST' => :created,
+        'PUT' => :accepted,
+        'DELETE' => :ok
+      }.freeze
+    end
+  end
+end

data/lib/clean_architecture/serializers/all.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED
+
+require 'clean_architecture/serializers/html_response_from_result'
+require 'clean_architecture/serializers/json_response_from_result'

data/lib/clean_architecture/serializers/html_response_from_result.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'dry/matcher/result_matcher'
+
+module CleanArchitecture
+  module Serializers
+    class HtmlResponseFromResult
+      def initialize(result, http_method)
+        @result = result
+        @http_method = http_method
+      end
+
+      def to_h
+        Dry::Matcher::ResultMatcher.call(@result) do |matcher|
+          matcher.success do |data|
+            { status: Queries::HttpSuccessCode.new(@http_method).to_sym, data: data }
+          end
+          matcher.failure { |error_message| { status: :error, error: error_message } }
+        end
+      end
+    end
+  end
+end

data/lib/clean_architecture/serializers/json_response_from_result.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'dry-monads'
+require 'dry/matcher/result_matcher'
+
+module CleanArchitecture
+  module Serializers
+    class JsonResponseFromResult
+      def initialize(result, http_method, success_payload)
+        @result = result
+        @http_method = http_method
+        @success_payload = success_payload
+      end
+
+      def to_h
+        {
+          status: http_status_code,
+          json: json
+        }
+      end
+
+      private
+
+      def http_status_code
+        Dry::Matcher::ResultMatcher.call(@result) do |matcher|
+          matcher.success { Queries::HttpSuccessCode.new(@http_method).to_sym }
+          matcher.failure do
+            if result_is_authorization_failure?
+              :unauthorized
+            else
+              :expectation_failed
+            end
+          end
+        end
+      end
+
+      def json
+        Dry::Matcher::ResultMatcher.call(@result) do |matcher|
+          matcher.success { success_payload }
+          matcher.failure { |failure_message| error_payload(failure_message) }
+        end
+      end
+
+      def success_payload
+        {
+          jsonapi: json_api_version_hash,
+          data: @success_payload.data_hash
+        }
+      end
+
+      def error_payload(failure_message)
+        {
+          jsonapi: json_api_version_hash,
+          errors: [failure_message]
+        }
+      end
+
+      def json_api_version_hash
+        { version: @success_payload.version }
+      end
+
+      def result_is_authorization_failure?
+        !@result.failure.index('Unauthorized: ').nil?
+      end
+    end
+  end
+end

data/lib/clean_architecture/strategies/actor_gets_authorized_then_does_work.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'dry-monads'
+
+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
+
+      def result
+        @result ||= begin
+          if @authorization_check.authorized?
+            @sub_strategy.result
+          else
+            Dry::Monads::Failure('Unauthorized: Invalid API key')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/clean_architecture/strategies/all.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# 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/strategies/with_audit_trail.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+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

data/lib/clean_architecture/version.rb

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

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: clean-architecture
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bellroy Tech Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-matcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: duckface-interfaces
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: An attempt at building a reusable Clean Architecture framework for Ruby
+email:
+- tech@bellroy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".overcommit.yml"
+- ".reek"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- Rakefile
+- clean-architecture.gemspec
+- generate_require_files.rb
+- lib/clean-architecture.rb
+- lib/clean_architecture/all.rb
+- lib/clean_architecture/entities/all.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
+- lib/clean_architecture/interfaces/use_case_actor.rb
+- lib/clean_architecture/interfaces/use_case_history_entry.rb
+- lib/clean_architecture/interfaces/use_case_target.rb
+- lib/clean_architecture/queries/all.rb
+- lib/clean_architecture/queries/http_success_code.rb
+- 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/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/version.rb
+homepage: https://bellroy.com
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Bellroy Clean Architecture Framework
+test_files: []