interactor-rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0bca65a85b90ff68610e82220b275faf616b80a
+  data.tar.gz: 51f17d71cca0017ee509b37f3aa41c936db590f8
+SHA512:
+  metadata.gz: b00e58241eca2e87687fc1b2a1cdebe15dddfb42f10e716b32350c8da4c4fafd44bb6e6fdcba28870b1df6cc2d1f52100fc5c0d0d593324fc83fcee80bd57b73
+  data.tar.gz: 52620fdc3f02c27ff6be85d1e525fe49bf749cb87c7b27c140251837772f2e5ca45b9727f903e94f087eedfc9a5fff41cd075de93cd38284df02c9947fd90486

data/.gitignore

@@ -0,0 +1,6 @@
+/.bundle
+/Gemfile.lock
+/coverage
+/gemfiles/*.gemfile.lock
+/pkg
+/tmp

data/.travis.yml

@@ -0,0 +1,13 @@
+branches:
+  only:
+    - master
+gemfile:
+  - gemfiles/rails30.gemfile
+  - gemfiles/rails31.gemfile
+  - gemfiles/rails32.gemfile
+  - gemfiles/rails40.gemfile
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+script: rspec

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "aruba", "~> 0.5.3"
+  gem "coveralls", "~> 0.6.7", require: false
+  gem "rspec", "~> 2.14"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Steve Richert
+
+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,81 @@
+# Interactor Rails
+
+[![Gem Version](https://badge.fury.io/rb/interactor-rails.png)](http://badge.fury.io/rb/interactor-rails)
+[![Build Status](https://travis-ci.org/collectiveidea/interactor-rails.png?branch=master)](https://travis-ci.org/collectiveidea/interactor-rails)
+[![Code Climate](https://codeclimate.com/github/collectiveidea/interactor-rails.png)](https://codeclimate.com/github/collectiveidea/interactor-rails)
+[![Coverage Status](https://coveralls.io/repos/collectiveidea/interactor-rails/badge.png?branch=master)](https://coveralls.io/r/collectiveidea/interactor-rails?branch=master)
+[![Dependency Status](https://gemnasium.com/collectiveidea/interactor-rails.png)](https://gemnasium.com/collectiveidea/interactor-rails)
+
+Interactor Rails provides Rails support for the
+[Interactor](https://github.com/collectiveidea/interactor) gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "interactor-rails", "~> 1.0"
+```
+
+Interactor Rails is compatible with Ruby 1.9 or 2.0 on Rails 3 or 4.
+
+## Usage
+
+Interactor Rails ensures that `app/interactors` is included in your autoload
+paths, and provides generators for your convenience.
+
+```bash
+rails generate interactor authenticate_user
+```
+
+adds to `app/interactors/authenticate_user.rb`:
+
+```ruby
+class AuthenticateUser
+  include Interactor
+
+  def perform
+    # TODO
+  end
+end
+```
+
+There is also a generator for organizers.
+
+```bash
+rails generate interactor:organizer place_order charge_card send_thank_you fulfill_order
+```
+
+adds to `app/interactors/place_order.rb`:
+
+```ruby
+class PlaceOrder
+  include Interactor::Organizer
+
+  organize ChargeCard, SendThankYou, FulfillOrder
+end
+```
+
+## Contributing
+
+Interactor is open source and contributions from the community are encouraged!
+No contribution is too small. Please consider:
+
+* adding an awesome feature
+* fixing a terrible bug
+* updating documentation
+* fixing a not-so-bad bug
+* fixing typos
+
+For the best chance of having your changes merged, please:
+
+1. Ask us! We'd love to hear what you're up to.
+2. Fork the project.
+3. Commit your changes and tests (if applicable (they're applicable)).
+4. Submit a pull request with a thorough explanation and at least one animated GIF.
+
+## Thanks
+
+A very special thank you to [Attila Domokos](https://github.com/adomokos) for
+his fantastic work on [LightService](https://github.com/adomokos/light-service).
+Interactor is inspired heavily by the concepts put to code by Attila.

data/Rakefile

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

data/gemfiles/rails30.gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rails", "~> 3.0.0"
+
+group :test do
+  gem "aruba", "~> 0.5.3"
+  gem "coveralls", "~> 0.6.7", require: false
+  gem "rspec", "~> 2.14"
+end

data/gemfiles/rails31.gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rails", "~> 3.1.0"
+
+group :test do
+  gem "aruba", "~> 0.5.3"
+  gem "coveralls", "~> 0.6.7", require: false
+  gem "rspec", "~> 2.14"
+end

data/gemfiles/rails32.gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rails", "~> 3.2.0"
+
+group :test do
+  gem "aruba", "~> 0.5.3"
+  gem "coveralls", "~> 0.6.7", require: false
+  gem "rspec", "~> 2.14"
+end

data/gemfiles/rails40.gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rails", "~> 4.0.0"
+
+group :test do
+  gem "aruba", "~> 0.5.3"
+  gem "coveralls", "~> 0.6.7", require: false
+  gem "rspec", "~> 2.14"
+end

data/interactor-rails.gemspec

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name    = "interactor-rails"
+  spec.version = "1.0.0"
+
+  spec.author      = "Collective Idea"
+  spec.email       = "info@collectiveidea.com"
+  spec.description = "Interactor Rails provides Rails support for the Interactor gem."
+  spec.summary     = "Rails support for Interactor"
+  spec.homepage    = "https://github.com/collectiveidea/interactor-rails"
+  spec.license     = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(/^spec/)
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "interactor", "~> 1.0"
+  spec.add_dependency "rails", ">= 3", "< 5"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.1"
+end

data/lib/generators/interactor.rb

@@ -0,0 +1,11 @@
+module Interactor
+  class Generator < ::Rails::Generators::NamedBase
+    def self.source_root
+      File.expand_path("../templates", __FILE__)
+    end
+
+    def generate
+      template "#{self.class.generator_name}.erb", "app/interactors/#{file_name}.rb"
+    end
+  end
+end

data/lib/generators/interactor/organizer_generator.rb

@@ -0,0 +1,7 @@
+require "generators/interactor"
+
+module Interactor
+  class OrganizerGenerator < Interactor::Generator
+    argument :interactors, type: :array, default: [], banner: "name name"
+  end
+end

data/lib/generators/interactor_generator.rb

@@ -0,0 +1,4 @@
+require "generators/interactor"
+
+class InteractorGenerator < Interactor::Generator
+end

data/lib/generators/templates/interactor.erb

@@ -0,0 +1,7 @@
+class <%= class_name %>
+  include Interactor
+
+  def perform
+    # TODO
+  end
+end

data/lib/generators/templates/organizer.erb

@@ -0,0 +1,9 @@
+class <%= class_name %>
+  include Interactor::Organizer
+
+<%- if interactors.any? -%>
+  organize <%= interactors.map(&:classify).join(", ") %>
+<%- else -%>
+  # organize Interactor1, Interactor2
+<%- end -%>
+end

data/lib/interactor/rails.rb

@@ -0,0 +1,4 @@
+module Interactor
+  module Rails
+  end
+end

data/spec/interactor/rails_spec.rb

@@ -0,0 +1,101 @@
+require "spec_helper"
+
+module Interactor
+  describe Rails do
+    before do
+      run_simple <<-CMD
+        bundle exec rails new example \
+          --skip-gemfile \
+          --skip-bundle \
+          --skip-git \
+          --skip-keeps \
+          --skip-active-record \
+          --skip-sprockets \
+          --skip-javascript \
+          --skip-test-unit \
+          --quiet
+        CMD
+      cd "example"
+      write_file "Gemfile", <<-EOF
+        gem "rails"
+        gem "interactor-rails", path: "#{ROOT}"
+        EOF
+      run_simple "bundle install"
+    end
+
+    context "rails generate" do
+      context "interactor" do
+        it "generates an interactor" do
+          run_simple "bundle exec rails generate interactor place_order"
+
+          path = "app/interactors/place_order.rb"
+          check_file_presence([path], true)
+          check_exact_file_content(path, <<-EOF)
+class PlaceOrder
+  include Interactor
+
+  def perform
+    # TODO
+  end
+end
+EOF
+        end
+
+        it "requires a name" do
+          run_simple "bundle exec rails generate interactor"
+
+          check_file_presence(["app/interactors/place_order.rb"], false)
+          assert_partial_output("rails generate interactor NAME", all_stdout)
+        end
+      end
+
+      context "interactor:organizer" do
+        it "generates an organizer" do
+          run_simple <<-CMD
+            bundle exec rails generate interactor:organizer place_order
+            CMD
+
+          path = "app/interactors/place_order.rb"
+          check_file_presence([path], true)
+          check_exact_file_content(path, <<-EOF)
+class PlaceOrder
+  include Interactor::Organizer
+
+  # organize Interactor1, Interactor2
+end
+EOF
+        end
+
+        it "generates an organizer with interactors" do
+          run_simple <<-CMD
+            bundle exec rails generate interactor:organizer place_order \
+              charge_card fulfill_order
+            CMD
+
+          path = "app/interactors/place_order.rb"
+          check_file_presence([path], true)
+          check_exact_file_content(path, <<-EOF)
+class PlaceOrder
+  include Interactor::Organizer
+
+  organize ChargeCard, FulfillOrder
+end
+EOF
+        end
+
+        it "requires a name" do
+          run_simple "bundle exec rails generate interactor:organizer"
+
+          check_file_presence(["app/interactors/place_order.rb"], false)
+          assert_partial_output("rails generate interactor:organizer NAME", all_stdout)
+        end
+      end
+    end
+
+    it "auto-loads interactors" do
+      run_simple "bundle exec rails generate interactor place_order"
+
+      run_simple "bundle exec rails runner PlaceOrder"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "coveralls"
+Coveralls.wear!
+
+require "interactor/rails"
+
+require "bundler"
+Bundler.require(:test)
+
+ROOT = File.expand_path("../..", __FILE__)
+
+Dir[File.expand_path("../support/*.rb", __FILE__)].each { |f| require f }

data/spec/support/aruba.rb

@@ -0,0 +1,11 @@
+require "aruba/api"
+
+RSpec.configure do |config|
+  config.include(Aruba::Api)
+
+  config.before do
+    @aruba_timeout_seconds = 60
+    FileUtils.rm_rf(current_dir)
+    unset_bundler_env_vars
+  end
+end

data/spec/support/random.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.order = "random"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: interactor-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Collective Idea
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: interactor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+description: Interactor Rails provides Rails support for the Interactor gem.
+email: info@collectiveidea.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/rails30.gemfile
+- gemfiles/rails31.gemfile
+- gemfiles/rails32.gemfile
+- gemfiles/rails40.gemfile
+- interactor-rails.gemspec
+- lib/generators/interactor.rb
+- lib/generators/interactor/organizer_generator.rb
+- lib/generators/interactor_generator.rb
+- lib/generators/templates/interactor.erb
+- lib/generators/templates/organizer.erb
+- lib/interactor/rails.rb
+- spec/interactor/rails_spec.rb
+- spec/spec_helper.rb
+- spec/support/aruba.rb
+- spec/support/random.rb
+homepage: https://github.com/collectiveidea/interactor-rails
+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.0.5
+signing_key: 
+specification_version: 4
+summary: Rails support for Interactor
+test_files:
+- spec/interactor/rails_spec.rb
+- spec/spec_helper.rb
+- spec/support/aruba.rb
+- spec/support/random.rb