interactor 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 25b48da784666d96730a23662bfe915115ce6be9
-  data.tar.gz: 5c7b218d7ff5857fef8d1faf6ea9e596ac3d9d49
+SHA256:
+  metadata.gz: 46223de1a4e39c98aa604fcfc35f3c68bf27112ddb92c38b19dcd660ea35cb23
+  data.tar.gz: dced8f4dbc38e443cf11009bce3728a5268aeca3dba204a96c04e99a30f6cea1
 SHA512:
-  metadata.gz: 8df8db25f4fd3c5dee6fee8d4440480539886d244fdb8dc19365ced9b506875966e3347cf5a4cd579042037c66242bc019961797f938d46518e701952b1edb73
-  data.tar.gz: b5f3f10d429f80c5f13f7bd5bc0a0c886440de435583fad49c57e28e145d2e6bb3c0085b2909077d58531d42d4cf07f7ab95bc82ca8a04fe3dbd675006e26ab1
+  metadata.gz: a817f4a3c31553afd48ad04f2315abb640351bb629ea813d361212cd2d43c9b7b6af9d185614ef03c1f136649f33235fd3f7574ac5ebf992f7e681512e368337
+  data.tar.gz: 2a871976402baea2a0de705130d17216c9b7fa8438cdb7550829ba31e9fa7b06bc79e8d11b38712dcaa11eb9d6a4ad8eeefc44d06e6b2120860ac4e45ba59c8f

data/.travis.yml

@@ -1,3 +1,5 @@
+after_success:
+  - bundle exec codeclimate-test-reporter
 before_install:
   - gem update bundler rake
 branches:
@@ -13,10 +15,21 @@ env:
 language: ruby
 matrix:
   allow_failures:
+    - rvm: "2.0"
+    - rvm: "2.1"
+    - rvm: "2.2"
     - rvm: ruby-head
+notifications:
+  webhooks:
+    on_start: always
+    urls:
+      - http://buildlight.collectiveidea.com/
 rvm:
-  - 1.9.3
   - "2.0"
   - "2.1"
+  - "2.2"
+  - "2.3"
+  - "2.4"
+  - "2.5"
   - ruby-head
 script: bundle exec rspec

data/CHANGELOG.md

@@ -1,11 +1,18 @@
+## 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] Halt performance if the interactor fails prior
-* [ENHANCEMENT] Add support for Ruby 2.1
 * [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"
@@ -15,6 +22,11 @@
 * [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

data/Gemfile

@@ -4,5 +4,5 @@ gemspec
 
 group :test do
   gem "codeclimate-test-reporter", require: false
-  gem "rspec", "~> 3.1"
+  gem "rspec", "~> 3.7"
 end

data/README.md

@@ -1,10 +1,9 @@
 # Interactor
 
-[![Gem Version](https://img.shields.io/gem/v/interactor.svg?style=flat-square)](http://rubygems.org/gems/interactor)
-[![Build Status](https://img.shields.io/travis/collectiveidea/interactor/master.svg?style=flat-square)](https://travis-ci.org/collectiveidea/interactor)
-[![Code Climate](https://img.shields.io/codeclimate/github/collectiveidea/interactor.svg?style=flat-square)](https://codeclimate.com/github/collectiveidea/interactor)
-[![Test Coverage](http://img.shields.io/codeclimate/coverage/github/collectiveidea/interactor.svg?style=flat-square)](https://codeclimate.com/github/collectiveidea/interactor)
-[![Dependency Status](https://img.shields.io/gemnasium/collectiveidea/interactor.svg?style=flat-square)](https://gemnasium.com/collectiveidea/interactor)
+[![Gem Version](https://img.shields.io/gem/v/interactor.svg)](http://rubygems.org/gems/interactor)
+[![Build Status](https://img.shields.io/travis/collectiveidea/interactor/master.svg)](https://travis-ci.org/collectiveidea/interactor)
+[![Maintainability](https://img.shields.io/codeclimate/maintainability/collectiveidea/interactor.svg)](https://codeclimate.com/github/collectiveidea/interactor)
+[![Test Coverage](https://img.shields.io/codeclimate/coverage-letter/collectiveidea/interactor.svg)](https://codeclimate.com/github/collectiveidea/interactor)
 
 ## Getting Started
 
@@ -74,6 +73,16 @@ context.fail!
 context.success? # => false
 ```
 
+#### Dealing with Failure
+
+`context.fail!` always throws an exception of type `Interactor::Failure`.
+
+Normally, however, these exceptions are not seen. In the recommended usage, the controller invokes the interactor using the class method `call`, then checks the `success?` method of the context.
+
+This works because the `call` class method swallows exceptions.  When unit testing an interactor, if calling custom business logic methods directly and bypassing `call`, be aware that `fail!` will generate such exceptions.
+
+See *Interactors in the Controller*, below, for the recommended usage of `call` and `success?`.
+
 ### Hooks
 
 #### Before Hooks
@@ -92,7 +101,7 @@ A symbol argument can also be given, rather than a block.
 ```ruby
 before :zero_emails_sent
 
-def zero_email_sent
+def zero_emails_sent
   context.emails_sent = 0
 end
 ```
@@ -108,6 +117,8 @@ after do
 end
 ```
 
+NB: After hooks are only run on success.  If the `fail!` method is called, the interactor's after hooks are not run.
+
 #### Around Hooks
 
 You can also define around hooks in the same way as before or after hooks, using
@@ -135,6 +146,8 @@ def time_execution(interactor)
 end
 ```
 
+NB: If the `fail!` method is called, all of the interactor's around hooks cease execution, and no code after `interactor.call` will be run.
+
 #### Hook Sequence
 
 Before hooks are invoked in the order in which they were defined while after
@@ -260,7 +273,7 @@ class SessionsController < ApplicationController
 
     if result.success?
       session[:user_token] = result.token
-      redirect_to root_path
+      redirect_to result.user
     else
       flash.now[:message] = t(result.message)
       render :new
@@ -291,7 +304,7 @@ class SessionsController < ApplicationController
 
     if result.success?
       session[:user_token] = result.token
-      redirect_to root_path
+      redirect_to result.user
     else
       flash.now[:message] = t(result.message)
       render :new
@@ -337,7 +350,7 @@ account cancellation interaction takes on more responsibility in the future.
 
 ### The Future™
 
-**SPOLIER ALERT:** Your use case won't *stay* so simple.
+**SPOILER ALERT:** Your use case won't *stay* so simple.
 
 In [our](http://collectiveidea.com) experience, a simple task like
 authenticating a user will eventually take on multiple responsibilities:
@@ -481,11 +494,9 @@ context.
 
 ```ruby
 describe AuthenticateUser do
-  describe "#call" do
-
-    let(:interactor) { AuthenticateUser.new(email: "john@example.com", password: "secret") }
-    let(:context) { interactor.context }
+  subject(:context) { AuthenticateUser.call(email: "john@example.com", password: "secret") }
 
+  describe ".call" do
     context "when given valid credentials" do
       let(:user) { double(:user, secret_token: "token") }
 
@@ -494,25 +505,15 @@ describe AuthenticateUser do
       end
 
       it "succeeds" do
-        interactor.call
-
         expect(context).to be_a_success
       end
 
       it "provides the user" do
-        expect {
-          interactor.call
-        }.to change {
-          context.user
-        }.from(nil).to(user)
+        expect(context.user).to eq(user)
       end
 
       it "provides the user's secret token" do
-        expect {
-          interactor.call
-        }.to change {
-          context.token
-        }.from(nil).to("token")
+        expect(context.token).to eq("token")
       end
     end
 
@@ -522,17 +523,11 @@ describe AuthenticateUser do
       end
 
       it "fails" do
-        interactor.call
-
         expect(context).to be_a_failure
       end
 
       it "provides a failure message" do
-        expect {
-          interactor.call
-        }.to change {
-          context.message
-        }.from(nil).to be_present
+        expect(context.message).to be_present
       end
     end
   end
@@ -610,7 +605,7 @@ class SessionsController < ApplicationController
 
     if result.success?
       session[:user_token] = result.token
-      redirect_to root_path
+      redirect_to result.user
     else
       flash.now[:message] = t(result.message)
       render :new
@@ -633,7 +628,7 @@ describe SessionsController do
     end
 
     context "when successful" do
-      let(:user) { double(:user) }
+      let(:user) { double(:user, id: 1) }
       let(:context) { double(:context, success?: true, user: user, token: "token") }
 
       it "saves the user's secret token in the session" do
@@ -647,7 +642,7 @@ describe SessionsController do
       it "redirects to the homepage" do
         response = post :create, session: { email: "john@doe.com", password: "secret" }
 
-        expect(response).to redirect_to(root_path)
+        expect(response).to redirect_to(user_path(user))
       end
     end
 

data/interactor.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name    = "interactor"
-  spec.version = "3.1.0"
+  spec.version = "3.1.1"
 
   spec.author      = "Collective Idea"
   spec.email       = "info@collectiveidea.com"
@@ -14,6 +14,6 @@ Gem::Specification.new do |spec|
   spec.files      = `git ls-files`.split($/)
   spec.test_files = spec.files.grep(/^spec/)
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
 end

data/lib/interactor/context.rb

@@ -10,7 +10,7 @@ module Interactor
   # the context is responsible for tracking individual interactor invocations
   # for the purpose of rollback.
   #
-  # The context may be maniupulated using arbitrary getter and setter methods.
+  # The context may be manipulated using arbitrary getter and setter methods.
   #
   # Examples
   #
@@ -121,7 +121,7 @@ module Interactor
     #
     # Raises Interactor::Failure initialized with the Interactor::Context.
     def fail!(context = {})
-      modifiable.update(context)
+      context.each { |key, value| modifiable[key.to_sym] = value }
       @failure = true
       raise Failure, self
     end

data/lib/interactor/organizer.rb

@@ -24,7 +24,7 @@ module Interactor
     # Internal: Interactor::Organizer class methods.
     module ClassMethods
       # Public: Declare Interactors to be invoked as part of the
-      # Interactor::Organizer's invocation. These interactors will invoked in
+      # Interactor::Organizer's invocation. These interactors are invoked in
       # the order in which they are declared.
       #
       # interactors - Zero or more (or an Array of) Interactor classes.
@@ -55,7 +55,7 @@ module Interactor
       #   class MyOrganizer
       #     include Interactor::Organizer
       #
-      #     organizer InteractorOne, InteractorTwo
+      #     organize InteractorOne, InteractorTwo
       #   end
       #
       #   MyOrganizer.organized
@@ -70,7 +70,7 @@ module Interactor
     # Internal: Interactor::Organizer instance methods.
     module InstanceMethods
       # Internal: Invoke the organized Interactors. An Interactor::Organizer is
-      # expected not to define its own "call" method in favor of this default
+      # expected not to define its own "#call" method in favor of this default
       # implementation.
       #
       # Returns nothing.

data/spec/interactor/context_spec.rb

@@ -101,6 +101,14 @@ module Interactor
         }.from("bar").to("baz")
       end
 
+      it "updates the context with a string key" do
+        expect {
+          context.fail!("foo" => "baz") rescue nil
+        }.to change {
+          context.foo
+        }.from("bar").to("baz")
+      end
+
       it "raises failure" do
         expect {
           context.fail!

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 if ENV["CODECLIMATE_REPO_TOKEN"]
-  require "codeclimate-test-reporter"
-  CodeClimate::TestReporter.start
+  require "simplecov"
+  SimpleCov.start
 end
 
 require "interactor"

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: interactor
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Collective Idea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-13 00:00:00.000000000 Z
+date: 2018-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0'
 description: Interactor provides a common interface for performing complex user interactions.
 email: info@collectiveidea.com
 executables: []
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Simple interactor implementation