clean-architecture 0.0.1

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/clean-architecture.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clean_architecture/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'clean-architecture'
+  spec.version       = CleanArchitecture::VERSION
+  spec.authors       = ['Bellroy Tech Team']
+  spec.email         = ['tech@bellroy.com']
+
+  spec.summary       = 'Bellroy Clean Architecture Framework'
+  spec.description   = 'An attempt at building a reusable Clean Architecture framework for Ruby'
+  spec.homepage      = 'https://bellroy.com'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'dry-matcher'
+  spec.add_dependency 'dry-monads'
+  spec.add_dependency 'duckface-interfaces'
+
+  spec.add_development_dependency 'bundler', '>= 1.13'
+  spec.add_development_dependency 'rake', '>= 10.0'
+  spec.add_development_dependency 'rspec', '>= 3.0'
+end

data/generate_require_files.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+def directories_in(root)
+  Dir.entries(root).sort.select do |entry|
+    fully_qualified_entry = File.join(root, entry)
+    File.directory?(fully_qualified_entry) && !['.', '..'].include?(entry.to_s)
+  end
+end
+
+def files_in(root)
+  Dir.entries(root).sort.reject do |entry|
+    fully_qualified_entry = File.join(root, entry)
+    File.directory?(fully_qualified_entry) || entry.to_s == 'all.rb' || entry[-3..-1] != '.rb'
+  end
+end
+
+def recursive_files_in(root)
+  full_paths = Dir.glob(File.join(root, '**', '*')).sort.reject do |entry|
+    fully_qualified_entry = File.join(root, entry)
+    File.directory?(fully_qualified_entry) || entry[-7..-1] == '/all.rb' || entry[-3..-1] != '.rb'
+  end
+
+  remove_path = root.split('/')[0..-2].join('/') + '/'
+  full_paths.map { |full_path| full_path.gsub(remove_path, '') }
+end
+
+def write_require_file(root, require_prefix, require_directories, require_files)
+  require_file_path = File.join(root, 'all.rb')
+  File.open(require_file_path, 'w') do |file|
+    file.write("# frozen_string_literal: true\n\n")
+    file.write("# THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED\n\n")
+    require_directories.each do |require_directory|
+      file.write("require '#{require_prefix}/#{require_directory}/all'\n")
+    end
+    file.write("\n") unless require_directories.empty?
+    require_files.each { |require_file| file.write("require '#{require_prefix}/#{require_file[0..-4]}'\n") }
+  end
+end
+
+lib_directories = ['clean_architecture']
+lib_directories.each do |lib_directory|
+  root = File.join(__dir__, 'lib', lib_directory)
+  subdirectories = directories_in(root)
+  write_require_file(root, lib_directory, subdirectories, files_in(root))
+  subdirectories.each do |subdirectory|
+    fully_qualified_directory = File.join(root, subdirectory)
+    write_require_file(fully_qualified_directory, lib_directory, [], recursive_files_in(fully_qualified_directory))
+  end
+end

data/lib/clean-architecture.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'clean_architecture/all'

data/lib/clean_architecture/all.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED
+
+require 'clean_architecture/interfaces/all'
+require 'clean_architecture/entities/all'
+require 'clean_architecture/queries/all'
+require 'clean_architecture/serializers/all'
+require 'clean_architecture/strategies/all'
+
+require 'clean_architecture/version'

data/lib/clean_architecture/entities/all.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# THIS FILE IS AUTOGENERATED AND SHOULD NOT BE MANUALLY MODIFIED
+
+require 'clean_architecture/entities/targeted_parameters'
+require 'clean_architecture/entities/untargeted_parameters'
+require 'clean_architecture/entities/use_case_history_entry'

data/lib/clean_architecture/entities/targeted_parameters.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module CleanArchitecture
+  module Entities
+    class TargetedParameters
+      attr_reader :actor, :extra_parameters_hash, :persistence, :target, :settings
+
+      implements_interface Interfaces::TargetedParameters
+      implements_interface Interfaces::AuthorizationParameters
+
+      def initialize(actor, target, extra_parameters_hash, persistence, settings)
+        @actor = actor
+        @target = target
+        @extra_parameters_hash = extra_parameters_hash
+        @persistence = persistence
+        @settings = settings
+      end
+    end
+  end
+end

data/lib/clean_architecture/entities/untargeted_parameters.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CleanArchitecture
+  module Entities
+    class UntargetedParameters
+      attr_reader :actor, :extra_parameters_hash, :persistence, :settings
+
+      implements_interface Interfaces::BaseParameters
+
+      def initialize(actor, extra_parameters_hash, persistence, settings)
+        @actor = actor
+        @extra_parameters_hash = extra_parameters_hash
+        @persistence = persistence
+        @settings = settings
+      end
+    end
+  end
+end

data/lib/clean_architecture/entities/use_case_history_entry.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'dry-monads'
+require 'dry/matcher/result_matcher'
+require 'duckface'
+
+module CleanArchitecture
+  module Entities
+    class UseCaseHistoryEntry
+      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
+        @use_case_target = use_case_target
+      end
+
+      def extra_parameters_hash
+        @use_case_parameters.extra_parameters_hash
+      end
+
+      def failure_messages
+        Dry::Matcher::ResultMatcher.call(@use_case_result) do |matcher|
+          matcher.success { nil }
+          matcher.failure { |value| value }
+        end
+      end
+
+      def prior_target_state
+        @use_case_target.attribute_hash
+      end
+
+      def succeeded?
+        @use_case_result.success?
+      end
+
+      def target_identifier
+        @use_case_target.identifier
+      end
+
+      def use_case_class_name
+        @use_case_class.name
+      end
+
+      def user_identifier
+        @use_case_parameters.actor.user_identifier
+      end
+    end
+  end
+end

data/lib/clean_architecture/interfaces/all.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# 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'
+require 'clean_architecture/interfaces/use_case_actor'
+require 'clean_architecture/interfaces/use_case_history_entry'
+require 'clean_architecture/interfaces/use_case_target'

data/lib/clean_architecture/interfaces/authorization_check.rb

@@ -0,0 +1,15 @@
+# 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/authorization_parameters.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'clean_architecture/interfaces/base_parameters'
+require 'duckface'
+
+module CleanArchitecture
+  module Interfaces
+    module AuthorizationParameters
+      extend Duckface::ActsAsInterface
+
+      include BaseParameters
+
+      def actor
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/clean_architecture/interfaces/base_parameters.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'duckface'
+
+module CleanArchitecture
+  module Interfaces
+    module BaseParameters
+      extend Duckface::ActsAsInterface
+
+      def extra_parameters_hash
+        raise NotImplementedError
+      end
+
+      def persistence
+        raise NotImplementedError
+      end
+
+      def settings
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/clean_architecture/interfaces/command.rb

@@ -0,0 +1,23 @@
+# 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/jsonable.rb

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

data/lib/clean_architecture/interfaces/persistence.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'duckface'
+
+module CleanArchitecture
+  module Interfaces
+    module Persistence
+      extend Duckface::ActsAsInterface
+
+      def create_use_case_history_entry(_use_case_history_entry)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/clean_architecture/interfaces/strategy.rb

@@ -0,0 +1,17 @@
+# 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/interfaces/success_payload.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'duckface'
+
+module CleanArchitecture
+  module Interfaces
+    module SuccessPayload
+      extend Duckface::ActsAsInterface
+
+      def data_hash
+        raise NotImplementedError
+      end
+
+      def version
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/clean_architecture/interfaces/targeted_parameters.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'clean_architecture/interfaces/base_parameters'
+require 'duckface'
+
+module CleanArchitecture
+  module Interfaces
+    module TargetedParameters
+      extend Duckface::ActsAsInterface
+
+      include BaseParameters
+
+      def target
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/clean_architecture/interfaces/use_case.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'duckface'
+
+module CleanArchitecture
+  module Interfaces
+    module UseCase
+      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/use_case_actor.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'duckface'
+
+module CleanArchitecture
+  module Interfaces
+    module UseCaseActor
+      extend Duckface::ActsAsInterface
+
+      def authorized?(_action, _target)
+        raise NotImplementedError
+      end
+
+      def user_identifier
+        raise NotImplementedError
+      end
+    end
+  end
+end