interactor-strict 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a672dc50d21ef4b2abc5fb2b15dce9a76215db114b90e6e875f245257022e09
+  data.tar.gz: af00d3e146d703307f507db32c7fc285b62b7e5c52cbf9011e33fd4c8b5b016d
+SHA512:
+  metadata.gz: 0f5d50fc187bfa3a146df6f6aed6c1171bd6d98f8cd0c5e5ff1cb1bb6f9730849ec35a87ee09853b8d3e6b50d03d86472395ccee04af3f8161a0f4201fedca4a
+  data.tar.gz: fdf36277e93030d0da8be725b5d9ec4b1de057ba34c302816f830afac108f02cbd51e30883f7e7caa28ff3f884331db03cb181e2acfb2d5a76057536875d4c88

data/.github/workflows/tests.yml

@@ -0,0 +1,35 @@
+name: Run Tests
+
+on:
+  push:
+    branches:
+      - "master"
+      - "v3"
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  spec:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby_version:
+          - "2.7"
+          - "3.0"
+          - "3.1"
+          - "3.2"
+          - "head"
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+        bundler-cache: true
+
+    - name: Run Tests
+      run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--order random
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,4 @@
+ruby_version: 2.3.0
+ignore:
+  - 'spec/**/*':
+    - Lint/AmbiguousBlockAssociation

data/CHANGELOG.md

@@ -0,0 +1,53 @@
+## 3.2.0 / Unreleased
+* [BUGFIX] Raise failures from nested contexts [#170]
+
+## 3.1.2 / 2019-12-29
+* [BUGFIX] Fix Context#fail! on Ruby 2.7
+
+## 3.1.1 / 2018-05-30
+
+* [BUGFIX] Allow Context#fail! to accept a hash with string keys
+* [ENHANCEMENT] Many documentation updates
+
+## 3.1.0 / 2014-10-13
+
+* [FEATURE] Add around hooks
+
+## 3.0.1 / 2014-09-09
+
+* [ENHANCEMENT] Add TomDoc code documentation
+
+## 3.0.0 / 2014-09-07
+
+* [FEATURE] Remove "magical" access to the context through the interactor
+* [FEATURE] Manage context values via setters/getters rather than hash access
+* [FEATURE] Change the primary interactor API method from "perform" to "call"
+* [FEATURE] Return the mutated context rather than the interactor instance
+* [FEATURE] Replace interactor setup with before and after hooks
+* [FEATURE] Abort execution immediately upon interactor failure
+* [ENHANCEMENT] Build a suite of realistic integration tests
+* [ENHANCEMENT] Move rollback responsibility into the context
+
+## 2.1.1 / 2014-09-30
+
+* [FEATURE] Halt performance if the interactor fails prior
+* [ENHANCEMENT] Add support for Ruby 2.1
+
+## 2.1.0 / 2013-09-05
+
+* [FEATURE] Roll back when an interactor within an organizer raises an error
+* [BUGFIX] Ensure that context-deferred methods respect string keys
+* [FEATURE] Respect context initialization from an indifferent access hash
+
+## 2.0.1 / 2013-08-28
+
+* [BUGFIX] Allow YAML (de)serialization by fixing interactor allocation
+
+## 2.0.0 / 2013-08-19
+
+* [BUGFIX] Fix rollback behavior within nested organizers
+* [BUGFIX] Skip rollback for the failed interactor
+
+## 1.0.0 / 2013-08-17
+
+* Initial release!

data/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing to Interactor
+
+Interactor is open source and contributions from the community are encouraged!
+No contribution is too small.
+
+Please consider:
+
+* adding a feature
+* squashing a bug
+* writing [documentation](http://tomdoc.org)
+* reporting an issue
+* fixing a typo
+* correcting [style](https://github.com/styleguide/ruby)
+
+## How do I contribute?
+
+For the best chance of having your changes merged, please:
+
+1. [Fork](https://github.com/collectiveidea/interactor/fork) the project.
+2. [Write](http://en.wikipedia.org/wiki/Test-driven_development) a failing test.
+3. [Commit](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) changes that fix the tests.
+4. [Submit](https://github.com/collectiveidea/interactor/pulls) a pull request with *at least* one animated GIF.
+5. Be patient.
+
+## Bug Reports
+
+If you are experiencing unexpected behavior and, after having read Interactor's
+documentation, are convinced this behavior is a bug, please:
+
+1. [Search](https://github.com/collectiveidea/interactor/issues) existing issues.
+2. Collect enough information to reproduce the issue:
+  * Interactor version
+  * Ruby version
+  * Rails version (if applicable)
+  * Specific setup conditions
+  * Description of expected behavior
+  * Description of actual behavior
+3. [Submit](https://github.com/collectiveidea/interactor/issues/new) an issue.
+4. Be patient.

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "standard"
+
+group :test do
+  gem "codeclimate-test-reporter", require: false
+  gem "rspec", "~> 3.7"
+end

data/LICENSE.txt

@@ -0,0 +1,48 @@
+Copyright (c) 2023 Marcelo Jacobus
+
+MIT License
+
+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.
+Copyright (c) 2023 Marcelo Jacobus
+
+----------------------------------------------------------------------
+Original License:
+----------------------------------------------------------------------
+
+MIT License
+
+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,64 @@
+# Interactor::Strict
+
+A stricter version of [`Interactor`](https://github.com/collectiveidea/interactor).
+
+[![Gem Version](https://img.shields.io/gem/v/interactor-strict.svg)](http://rubygems.org/gems/interactor-strict)
+[![Build Status](https://github.com/mjacobus/interactor-strict/actions/workflows/tests.yml/badge.svg)](https://github.com/mjacobus/interactor-strict/actions/workflows/tests.yml)
+[![Maintainability](https://img.shields.io/codeclimate/maintainability/mjacobus/interactor-strict.svg)](https://codeclimate.com/github/mjacobus/interactor-strict)
+[![Test Coverage](https://img.shields.io/codeclimate/coverage-letter/mjacobus/interactor-strict.svg)](https://codeclimate.com/github/mjacobus/interactor-strict)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+
+## Getting Started
+
+Add interactor-strict to your Gemfile and `bundle install`.
+
+```ruby
+gem "interactor-strict"
+```
+
+## How to use
+
+Include the `Interactor` module as well as the `Intractor::Strict`. That will allow you to use keyword arguments. The of keyword arguments is that you may not miss them, as they will be required by the interpreter. Also, you'll not need to document your params in comments, because the method signature will do that for you.
+
+```ruby
+class SomeService
+  include Interactor
+  include Interactor::Strict # that will allow you to use keywords
+
+  def call(foo:, bar:, with_default: 'default')
+    context.result = [foo, bar, with_default]
+  end
+end
+
+SomeService.call(foo: "the-foo", bar: "the-bar")
+```
+
+Without the strict interactor module, you would have implemented that service more or less like:
+
+```ruby
+class SomeService
+  include Interactor
+
+  def call
+    raise "missing foo" if context.foo.nil?
+    raise "missing bar" if context.bar.nil?
+    context.result = [context.foo, context.bar, context.with_default || "default"]
+  end
+end
+
+SomeService.call(foo: "the-foo", bar: "the-bar")
+```
+
+## Credits
+
+This code started as a fork of [mjacobus/interactor](https://github.com/mjacobus/interactor).
+
+## Disclaimer/Opinion
+
+The Interactor gem provides a DSL for a very common design of service classes in ruby.
+
+I don't particularly support this type of service. I don't like its design because this is not really OOP. `Service.call` is a function attached to a namespace.
+
+Also, it imposes on your API/Interface, providing a DSL that brings no real value. You should decide how your services should be designed.
+
+However, if you do think Interactor provides a good pattern - or you happen to work in a project that uses this heavily - you are better off with this stricter extension.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standard/rake"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:spec, :standard]

data/interactor-strict.gemspec

@@ -0,0 +1,20 @@
+require "English"
+
+Gem::Specification.new do |spec|
+  spec.name = "interactor-strict"
+  spec.version = "1.0.0"
+
+  spec.author = "Marcelo Jacobus"
+  spec.email = "marcelo.jacobus@gmail.com"
+  spec.description = "Extends the interactor gem"
+  spec.summary = "Extends the interactor gem"
+  spec.homepage = "https://github.com/mjacobus/interactor-strict"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.test_files = spec.files.grep(/^spec/)
+
+  spec.add_dependency "interactor"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+end

data/lib/interactor/strict.rb

@@ -0,0 +1,40 @@
+require "interactor"
+
+module Interactor
+  module Strict
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+      end
+    end
+
+    def initialize(*args, **kargs)
+      unless args.empty?
+        raise ArgumentError, "wrong number of arguments (given #{args.size}, expected 0)"
+      end
+
+      @kargs = kargs
+      @context = Context.build(*args)
+    end
+
+    def run!
+      with_hooks do
+        call(**@kargs)
+        context.called!(self)
+      end
+    rescue
+      context.rollback!
+      raise
+    end
+
+    module ClassMethods
+      def call(*args, **kargs)
+        new(*args, **kargs).tap(&:run).context
+      end
+
+      def call!(*args, **kargs)
+        new(*args, **kargs).tap(&:run!).context
+      end
+    end
+  end
+end