interaptor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b58f3b9b7c1e56e301deb80b0bfcd98d4dc8a7c27e7af1c30ffa140435d22921
+  data.tar.gz: d22b577bf50b6c24f92ac9a96b2d6b7cb0895b01afee8f83b3ee07190b9a3886
+SHA512:
+  metadata.gz: c028238a455cd57814c64ca71b35e5292f34f9755b289465fc5c8d7aaa7f6e08196fd34c003674ed31ed6684e6688b06bcfca486dbc4aeb6df524910bb705223
+  data.tar.gz: 7118c2f7a2983157243105b259bf1ee2f2d991c540fb371f312d8b922845940e605ddb10209a7f9456c3e86ba887712b425366cd65c1b82926fd8f269c2f07af

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

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 TODO: Write your email address. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -0,0 +1,20 @@
+FROM ruby:2.5
+
+RUN apt-get update && apt-get install -y git
+
+RUN touch ~/.gemrc && \
+  echo "gem: --no-ri --no-rdoc" >> ~/.gemrc && \
+  gem install rubygems-update && \
+  update_rubygems && \
+  gem install bundler && \
+  mkdir -p /gem/
+
+WORKDIR /interaptor/
+ADD . /interaptor/
+RUN bundle install
+
+VOLUME .:/interaptor/
+
+
+ENTRYPOINT ["bundle", "exec"]
+CMD ["rspec", "spec"]

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in interaptor.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    interaptor (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  interaptor!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 TODO: Write your name
+
+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,154 @@
+# Interaptor
+
+[![Build Status](https://travis-ci.org/jonatasdaniel/interaptor.svg?branch=master)](https://travis-ci.org/jonatasdaniel/interaptor)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'interaptor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install interaptor
+
+## Why?
+
+Interactor is a single purpose object used to encapsulate business logic of the application. Inspired by [collectiveidea/**interactor**](https://github.com/collectiveidea/interactor).
+
+The reason of create another Interactor Ruby gem is because I would like to have object that I could instantiate and pass parameters like a PORO object. I'm not a big fan of calling my business objects using class methods.
+
+## Usage
+
+- create your interactor class
+
+```ruby
+class CreateBankAccount
+  include Interaptor
+
+  def initialize(current_user)
+    @current_user = current_user
+  end
+
+  def execute(name:, account_number:, routing_number:)
+    # do something
+    bank_account = BankAccount.create!(
+      name: name, account_number: account_number, routing_number: routing_number
+    )
+
+    return bank_account
+  end
+end
+```
+
+and `call` it
+
+```ruby
+result = CreateBankAccount.new(my_logged_user).call(**bank_account_params)
+if result.success?
+  result.value # value is the object returned in your interactor, in this case, bank_account
+else
+  result.errors.each do |error|
+    puts "Some error happened related to #{error.source}. Detail: #{error.message}"
+  end
+end
+
+```
+
+or you can `call!` expecting an exception if some error happens
+```ruby
+begin
+  bank_account = CreateBankAccount.new(my_logged_user).call!(**bank_account_params)
+rescue Interaptor::Failure => e
+  e.errors.each do |error|
+    puts "Some error happened related to #{error.source}. Detail: #{error.message}"
+  end
+end
+```
+
+To add errors inside your interactor class you have three ways:
+- add error and keep with your interactor processing (keep in mind that this option will not raise an exception when calling `call!` method)
+```ruby
+class CreateBankAccount
+  include Interaptor
+
+  def execute
+    add_error('Some error', source: 'some optional source')
+
+    #do something
+  end
+
+end
+```
+
+- add error and stop processing
+```ruby
+class CreateBankAccount
+  include Interaptor
+
+  def execute
+    fail!('Some error', source: 'some optional source')
+
+    #nothing more will be executed here
+  end
+
+end
+```
+
+- add multiple errors and stop processing
+```ruby
+class CreateBankAccount
+  include Interaptor
+
+  def execute
+    add_error('Some error', source: 'some optional source')
+    add_error('Some error again', source: 'some optional source')
+    fail!
+
+    #nothing more will be executed here
+  end
+
+end
+```
+
+You also have the option to add before/after callbacks like:
+```ruby
+class CreateBankAccount
+  include Interaptor
+
+  before do
+    # execute something before execute method
+  end
+
+  after do
+    # execute something after execute method if no exception is thrown
+  end
+
+  def execute
+    #something here
+  end
+
+end
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jonatasdaniel/interaptor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+To release a new version:
+`docker-compose run --rm -v ~/.gitconfig:/root/.gitconfig -v ~/.ssh/:/root/.ssh/ -v ~/.gem/:/root/.gem/ -v $(pwd):/gem/ -w /gem interaptor rake release`
+
+## 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 Interaptor project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jonatasdaniel/interaptor/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "interaptor"
+
+# 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/docker-compose.yml

@@ -0,0 +1,6 @@
+version: '2'
+services:
+  interaptor:
+    build: .
+    volumes:
+      - .:/interaptor

data/interaptor.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "interaptor/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "interaptor"
+  spec.version       = Interaptor::VERSION
+  spec.authors       = ["Jonatas Daniel Hermann"]
+  spec.email         = ["jonatas.hermann@gmail.com"]
+
+  spec.summary       = %q{Interactor gem for ruby apps}
+  spec.description   = %q{Easy Interactor gem for ruby apps}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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 "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/interaptor.rb

@@ -0,0 +1,51 @@
+require "interaptor/version"
+require "interaptor/result"
+require "interaptor/failure"
+require "interaptor/error"
+require "interaptor/callbacks"
+
+module Interaptor
+
+  def self.included(base)
+    base.class_eval do
+      include Callbacks
+    end
+  end
+
+  def call(*params)
+    begin
+      value = call!(*params)
+
+      if @result && !@result.success?
+        return Interaptor::Result.new(success: false, errors: @result.errors)
+      end
+
+      return Interaptor::Result.new.tap do |result|
+        result.value = value
+      end
+    rescue Interaptor::Failure => e
+      return Interaptor::Result.new(success: false, errors: e.errors)
+    end
+
+  end
+
+  def call!(*params)
+    run_before_callbacks
+    value = execute(*params)
+    run_after_callbacks
+
+    return value
+  end
+
+  def add_error(message, source: nil)
+    @result ||= Interaptor::Result.new(success: false)
+    @result.add_error(Interaptor::Error.new(message, source))
+  end
+
+  def fail!(message=nil, source: nil)
+    add_error(message, source: source) if message
+
+    raise Interaptor::Failure.new(@result ? @result.errors : [])
+  end
+
+end

data/lib/interaptor/callbacks.rb

@@ -0,0 +1,45 @@
+module Interaptor
+
+  module Callbacks
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def run_callback(callback, *args)
+      if callback.is_a?(Symbol)
+      else
+        instance_exec(*args, &callback)
+      end
+    end
+
+    def run_before_callbacks
+      self.class.before_callbacks.each { |callback| run_callback(callback) }
+    end
+
+    def run_after_callbacks
+      self.class.after_callbacks.each { |callback| run_callback(callback) }
+    end
+
+  end
+
+  module ClassMethods
+
+    def before(&block)
+      before_callbacks << block
+    end
+
+    def after(&block)
+      after_callbacks << block
+    end
+
+    def before_callbacks
+      @before_callbacks ||= []
+    end
+
+    def after_callbacks
+      @after_callbacks ||= []
+    end
+  end
+
+end

data/lib/interaptor/error.rb

@@ -0,0 +1,9 @@
+class Interaptor::Error
+
+  attr_accessor :message, :source
+
+  def initialize(message, source)
+    self.message, self.source = message, source
+  end
+
+end

data/lib/interaptor/failure.rb

@@ -0,0 +1,11 @@
+class Interaptor::Failure < StandardError
+
+  def initialize(errors)
+    @errors = errors
+  end
+
+  def errors
+    @errors || []
+  end
+
+end

data/lib/interaptor/result.rb

@@ -0,0 +1,24 @@
+class Interaptor::Result
+
+  attr_accessor :value
+
+  def initialize(success: true, errors: [])
+    @success = success
+    @errors = errors
+  end
+
+  def errors
+    @errors || []
+  end
+
+  def success?
+    @success && @errors.empty?
+  end
+
+  def add_error(error)
+    success = false
+    @errors ||= []
+    @errors << error
+  end
+
+end

data/lib/interaptor/version.rb

@@ -0,0 +1,3 @@
+module Interaptor
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: interaptor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonatas Daniel Hermann
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: Easy Interactor gem for ruby apps
+email:
+- jonatas.hermann@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- interaptor.gemspec
+- lib/interaptor.rb
+- lib/interaptor/callbacks.rb
+- lib/interaptor/error.rb
+- lib/interaptor/failure.rb
+- lib/interaptor/result.rb
+- lib/interaptor/version.rb
+homepage: 
+licenses:
+- MIT
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Interactor gem for ruby apps
+test_files: []