use_cases 0.2.5

data/lib/use_cases/step_adapters.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "use_cases/step_adapters/step"
+require "use_cases/step_adapters/map"
+require "use_cases/step_adapters/tee"
+require "use_cases/step_adapters/try"
+require "use_cases/step_adapters/check"
+require "use_cases/step_adapters/enqueue"
+require "use_cases/step_active_job_adapter"
+
+module UseCases
+  module StepAdapters
+    def self.included(base)
+      base.class_eval do
+        register_adapter StepAdapters::Step
+        register_adapter StepAdapters::Tee
+        register_adapter StepAdapters::Try
+        register_adapter StepAdapters::Map
+        register_adapter StepAdapters::Check
+
+        register_adapter StepAdapters::Enqueue if defined? ActiveJob
+      end
+    end
+  end
+end

data/lib/use_cases/step_result.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module UseCases
+  class StepResult < Dry::Monads::Result
+    attr_reader :step, :result
+
+    def initialize(step, result)
+      super()
+      @step = step
+      @result = result
+    end
+
+    def value
+      return result if result_not_monad?
+      return nil if result_empty?
+
+      result.success? ? result.value! : result
+    end
+    alias value! value
+
+    def success?
+      !failure?
+    end
+
+    def failure?
+      value.is_a?(Dry::Monads::Result::Failure)
+    end
+
+    def failure
+      failure? && value.failure
+    end
+
+    def success
+      success? && value
+    end
+
+    def nil?
+      value.nil?
+    end
+
+    def to_result
+      value.to_result if failure?
+
+      result
+    end
+
+    def result_empty?
+      result.success? && result.value! == Dry::Monads::Unit
+    end
+
+    def result_not_monad?
+      !result.is_a?(Dry::Monads::Result)
+    end
+  end
+end

data/lib/use_cases/transaction.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module UseCases
+  module Transaction
+    class TransactionHandlerUndefined < StandardError; end
+
+    class TransactionHandlerInvalid < StandardError; end
+
+    def self.included(base)
+      base.prepend DoCallPatch
+    end
+
+    module DoCallPatch
+      def do_call(*args)
+        unless respond_to?(:transaction_handler)
+          raise TransactionHandlerUndefined, "when using *transactional*, make sure to include a transaction handler in your dependencies."
+        end
+
+        raise TransactionHandlerInvalid, "Make sure your transaction_handler implements #transaction." unless transaction_handler.respond_to?(:transaction)
+
+        transaction_handler.transaction { super }
+      end
+    end
+  end
+end

data/lib/use_cases/validate.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require "dry/validation/contract"
+
+module UseCases
+  module Validate
+    class NoValidationError < StandardError; end
+
+    def self.included(base)
+      base.class_eval do
+        extend DSL
+        extend ClassMethods
+        prepend CallPatch
+      end
+    end
+
+    module CallPatch
+      def call(*args)
+        unless stack.include_step?(:validate)
+          raise NoValidationError,
+                "Make sure to define params validations by using *params*" \
+                "*schema*, *json*, *rule* or *option* macros in your use case."
+        end
+
+        super
+      end
+    end
+
+    module DSL
+      def params(*args, &blk)
+        _setup_validation
+
+        _contract_class.params(*args, &blk)
+      end
+
+      def schema(*args, &blk)
+        _setup_validation
+
+        _contract_class.schema(*args, &blk)
+      end
+
+      def rule(*args, &blk)
+        _setup_validation
+
+        _contract_class.rule(*args, &blk)
+      end
+
+      def json(*args, &blk)
+        _setup_validation
+
+        _contract_class.json(*args, &blk)
+      end
+
+      def option(*args, &blk)
+        _contract_class.option(*args, &blk)
+      end
+    end
+
+    private
+
+    def validate(params, current_user)
+      return Failure([:validation_error, "*params* must be a hash."]) unless params.respond_to?(:merge)
+
+      validation = contract.call(params.merge(current_user: current_user))
+
+      validation.success? ? Success(validation.to_h) : Failure([:validation_error, validation.errors.to_h])
+    end
+
+    def contract
+      return self.class._contract_class.new if self.class._contract_class_defined?
+    end
+
+    module ClassMethods
+      def _setup_validation
+        _define_contract_class unless _contract_class_defined?
+        _define_validation_step unless _validation_step_defined?
+      end
+
+      def _define_validation_step
+        step :validate
+      end
+
+      def _contract_class
+        self::Contract
+      end
+
+      def _define_contract_class
+        const_set(:Contract, Class.new(Dry::Validation::Contract))
+      end
+
+      def _contract_class_name
+        "#{name}::Contract"
+      end
+
+      def _contract_class_defined?
+        Object.const_defined? _contract_class_name
+      end
+
+      def _validation_step_defined?
+        __steps__.map(&:name).include?(:validate)
+      end
+    end
+  end
+end

data/lib/use_cases/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module UseCases
+  VERSION = "0.2.5"
+end

data/lib/use_cases.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "use_case"
+require_relative "use_cases/version"
+require_relative "use_cases/base"
+
+module UseCases; end

data/use_cases.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "lib/use_cases/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "use_cases"
+  spec.version       = UseCases::VERSION
+  spec.authors       = ["Ring Twice"]
+  spec.email         = ["guilherme@listminut.com"]
+
+  spec.summary       = "Use Cases"
+  spec.description   = "A DSL to encapsulate your domain logic."
+  spec.homepage      = "https://github.com/listminut/use_cases"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.6.8"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/listminut/use_cases"
+  spec.metadata["changelog_uri"] = "https://github.com/listminut/use_cases/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "dry-events"
+  spec.add_dependency "dry-matcher"
+  spec.add_dependency "dry-monads"
+  spec.add_dependency "dry-validation"
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: use_cases
+version: !ruby/object:Gem::Version
+  version: 0.2.5
+platform: ruby
+authors:
+- Ring Twice
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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-events
+  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-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: dry-validation
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A DSL to encapsulate your domain logic.
+email:
+- guilherme@listminut.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/use_case.rb
+- lib/use_cases.rb
+- lib/use_cases/authorize.rb
+- lib/use_cases/base.rb
+- lib/use_cases/dsl.rb
+- lib/use_cases/errors.rb
+- lib/use_cases/module_optins.rb
+- lib/use_cases/notifications.rb
+- lib/use_cases/params.rb
+- lib/use_cases/prepare.rb
+- lib/use_cases/rspec/matchers.rb
+- lib/use_cases/stack.rb
+- lib/use_cases/stack_runner.rb
+- lib/use_cases/step_active_job_adapter.rb
+- lib/use_cases/step_adapters.rb
+- lib/use_cases/step_adapters/abstract.rb
+- lib/use_cases/step_adapters/authorize.rb
+- lib/use_cases/step_adapters/check.rb
+- lib/use_cases/step_adapters/enqueue.rb
+- lib/use_cases/step_adapters/map.rb
+- lib/use_cases/step_adapters/step.rb
+- lib/use_cases/step_adapters/tee.rb
+- lib/use_cases/step_adapters/try.rb
+- lib/use_cases/step_result.rb
+- lib/use_cases/transaction.rb
+- lib/use_cases/validate.rb
+- lib/use_cases/version.rb
+- use_cases.gemspec
+homepage: https://github.com/listminut/use_cases
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/listminut/use_cases
+  source_code_uri: https://github.com/listminut/use_cases
+  changelog_uri: https://github.com/listminut/use_cases/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key:
+specification_version: 4
+summary: Use Cases
+test_files: []