act_as_interactor 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2e149d40859b964b8c4d41df750e351a644e996a2743d8114c2188e5bf7f7929
+  data.tar.gz: '019023c8e061dc31277ef6ae63f57b9fd4e2716edf3b8990dcdd7fb962336c05'
+SHA512:
+  metadata.gz: cfc5c656745be172986bdb5a01ad94bf90069b5b8c70fb4d2672487622d1baf8fb8135f2c1833670ddd51f6035293bb575262978da1999c9769b36c310504444
+  data.tar.gz: ece125a9ee276cfa0aca271f36c00e8d8297c2ca7a289c2f848c911b8558b73f916ce599ddf8ea72105da53ebf4460bd7eeb6473ccec5ce957359e6c10fd2e89

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at arefaslani@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in act_as_interactor.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'minitest', '~> 5.0'

data/Guardfile

@@ -0,0 +1,11 @@
+clearing :on
+
+guard :shell do
+  watch(/(act_as_interactor.gemspec|lib\/.*\.rb)/) do |m|
+    output = []
+    output << `bundle install`
+    output << `gem build act_as_interactor.gemspec`
+    output << `gem install act_as_interactor-#{ActAsInteractor::VERSION}.gem`
+    output.join("\n")
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Aref Aslani
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,230 @@
+# ActAsInteractor
+Simple and powerful interface for creating service objects in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'act_as_interactor'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install act_as_interactor
+
+## Usage
+Just include the interactor module in your service objects. For example if you have a service objects for creating blog posts in your app, then just include the `AtcAsInteractor` module in it and define the `execute` method inside it:
+
+```ruby
+module Posts
+  class Create
+    include ActAsInteractor
+
+    def execute(params)
+      # steps to create a blog post
+    end
+  end
+end
+```
+
+NOTE: the params argument of the execute is better to be a hash of parameters.
+
+## defining steps
+For defining steps needed for your operation, just add simple ruby methods to your service objects and pass the params hash to it. Then, using destructuring the params hash, get the values needed for that specific step and ignore the rest.
+
+```ruby
+module Posts
+  class Create
+    include ActAsInteractor
+
+    def execute(params)
+      yield create_post(params)
+    end
+
+    private
+
+    def create_post(title:, body:, **)
+      post = Post.create(title: title, body: body)
+      
+      return Failure(post.errors.messages) if post.invalid?
+
+      Success(post)
+    end
+  end
+end
+```
+NOTE: We use `Failure` and `Success` methods to wrap our steps results. Then we can use `yield` keyword to unwrap the output of the method. It also helps to halt the execution of the service objects if there is a `Failure` in execution of any of steps and returns the Failure object wrapping the real output.
+
+## Input validation
+For validating the input, you only need to add a `validator` method to your service object that returns an object that responds to call method and receives a hash of parameters. If you define the validator method, then the validation process starts automatically before executing any step in the srevice object.
+
+Adding validation using `dry-schema`:
+```Ruby
+module Posts
+  class Create
+    include ActAsInteractor
+
+    def execute(params)
+      yield create_post(params)
+    end
+
+    private
+
+    def create_post(title:, body:, **)
+      post = Post.create(title: title, body: body)
+      
+      return Failure(post.errors.messages) if post.invalid?
+
+      Success(post)
+    end
+
+    def validator
+      Dry::Schema.Params do
+        required(:title).filled(:str?)
+        required(:body).filled(:str?)
+      end
+    end
+  end
+end
+```
+
+You can also use more sophisticated validation tools like `dry-validation`:
+```Ruby
+module Posts
+  module Contract
+    class Create < Dry::Validation::Contract
+      params do
+        required(:title).filled(:str?)
+        required(:body).filled(:str?)
+        required(:author_email).filled(:str?)
+      end
+
+      rule(:author_email) do
+        unless /\A[\w+\-.]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]+\z/i.match?(value)
+          key.failure('has invalid format')
+        end
+      end
+    end
+  end
+end
+
+
+module Posts
+  class Create
+    include ActAsInteractor
+
+    def execute(params)
+      yield create_post(params)
+    end
+
+    private
+
+    def create_post(title:, body:, **)
+      post = Post.create(title: title, body: body)
+      
+      return Failure(post.errors.messages) if post.invalid?
+
+      Success(post)
+    end
+
+    def validator
+      Posts::Contract::Create.new
+    end
+  end
+end
+```
+## Getting the result
+As we've wrapped all the steps results in `Failure` or `Success` objects, then we have access to `failure?` and `success?` methods to see if the output of the serivce is successful or a failure. We also have `failure` and `success` methods to get the unwrapped output of the service objects:
+
+```ruby
+outcome = Posts::Create.call(title: "Hello world") # => Success(#<Post ...>)
+outcome.success? # => true
+outcome.success # => #<Post ...>
+```
+But wait! There's also a more interesting way to get the service object outcome, just pass a block. In this case, I want to use it inside a Rails controller action for exapmle:
+```ruby
+class PostsController
+  def create
+    Posts::Create.call(post_params.to_h) do |outcome|
+      outcome.success do |post|
+        render json: post, status: :ok
+      end
+
+      outcome.failure do |errors|
+        render json: errors, status: :unprocessable_entity
+      end
+    end
+  end
+end
+```
+
+## Better error handling (Railway Oriented)
+Based on the monadic type of the result of your service objects using this library, you can easily handle your different failure paths in a pretty shape without using if-else statements or throwing different types of exceptions (read more about Railway Oriented Programming).
+
+```ruby
+module Posts
+  class Create
+    include ActAsInteractor
+
+    def execute(params)
+      # ...
+      yield check_title(params)
+      # ...
+    end
+
+    private
+
+    def create_title(title:, **)
+      outcome = Posts::CheckTitle.call(title: title)
+
+      return Failure(:inappropriate_title) if outcome.failure?
+
+      return Success()
+    end
+
+    # ...
+  end
+end
+```
+Then in the caller method, you can check different failure paths:
+
+```ruby
+class PostsController
+  def create
+    Posts::Create.call(post_params.to_h) do |outcome|
+      # success path
+      outcome.success do |post|
+        render json: post, status: :ok
+      end
+
+      # inappropriate title failure path
+      outcome.failure(:inappropriate_title) do |_errors|
+        # do something like send a mail or notify admins etc.
+        render json: { errors: { title: ["is inappropriate"] }}
+      end
+
+      # general failure path
+      outcome.failure do |errors|
+        render json: { errors: errors }, status: :unprocessable_entity
+      end
+    end
+  end
+end
+```
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/arefaslani/act_as_interactor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/arefaslani/act_as_interactor/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActAsInteractor project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/arefaslani/act_as_interactor/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/act_as_interactor.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/act_as_interactor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'act_as_interactor'
+  spec.version       = ActAsInteractor::VERSION
+  spec.authors       = ['Aref Aslani']
+  spec.email         = ['arefaslani@gmail.com']
+
+  spec.summary       = 'Simple and powerful Ruby service objects'
+  spec.description   = 'Simple and powerful Ruby service objects using dry-rb tools.'
+  spec.homepage      = 'https://github.com/arefaslani/act_as_interactor'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'guard', '~> 2.16'
+  spec.add_development_dependency 'guard-shell', '~> 0.7'
+  spec.add_dependency 'dry-matcher', '~> 0.8.3'
+  spec.add_dependency 'dry-monads', '~> 1.3.5'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "act_as_interactor"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/act_as_interactor.rb

@@ -0,0 +1,40 @@
+require 'act_as_interactor/version'
+require 'dry/matcher/result_matcher'
+require 'dry-monads'
+
+module ActAsInteractor
+  module ClassMethods
+    def call(params, &block)
+      service_outcome = self.new.execute(params)
+      if block_given?
+        Dry::Matcher::ResultMatcher.call(service_outcome, &block)
+      else
+        service_outcome
+      end
+    end
+  end
+
+  module InstanceMethods
+    include Dry::Monads[:result, :do]
+
+    def execute(params)
+      yield validate_params(params)
+      super(params)
+    end
+    
+    def validate_params(params)
+      if self.respond_to? :validator
+        validation_outcome = self.validator.call(params)
+  
+        return Failure(validation_outcome.errors.to_h) if validation_outcome.failure?  
+      end
+
+      Success(params)
+    end
+  end
+
+  def self.included(klass)  
+    klass.prepend InstanceMethods
+    klass.extend ClassMethods
+  end
+end

data/lib/act_as_interactor/version.rb

@@ -0,0 +1,3 @@
+module ActAsInteractor
+  VERSION = '0.9.0'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: act_as_interactor
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Aref Aslani
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+- !ruby/object:Gem::Dependency
+  name: guard-shell
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: dry-matcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+description: Simple and powerful Ruby service objects using dry-rb tools.
+email:
+- arefaslani@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- act_as_interactor.gemspec
+- bin/console
+- bin/setup
+- lib/act_as_interactor.rb
+- lib/act_as_interactor/version.rb
+homepage: https://github.com/arefaslani/act_as_interactor
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/arefaslani/act_as_interactor
+  source_code_uri: https://github.com/arefaslani/act_as_interactor
+  changelog_uri: https://github.com/arefaslani/act_as_interactor
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Simple and powerful Ruby service objects
+test_files: []