shadow_controller 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55def613384ef8a44b7c5fb4cf793577bacb69d3
+  data.tar.gz: fc172ea1d6eb0c1a221c119324e2b933366a9734
+SHA512:
+  metadata.gz: 55a973fe38318f3a0513c666817919ef4c0b3ffbc8a4588ea1554e0ff5f56297542574d86720001bf207602121a24bde74626b1b260bf096b37b04e98db8d978
+  data.tar.gz: 7db6d783f93fc11f3d4500b70d574b5eac77c02ff9e4d3be06a91270d71d14de2bf1a48af44fced78d21b0b3622fea4b47ab930554bde7cce8d9ead407f5c906

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shadow_controller.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Miles Stanfield
+
+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,102 @@
+# ShadowController
+
+An RSpec helper that makes testing your rails ApplicationController a cool breeze.
+<br><br>
+Testing your ApplicationController often requires using the AnonymousController and drawing custom routes. This helper does all that for you and prevents you from having to update your AnonymousController whenever you make a change to the ApplicationController.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development, :test do
+  gem 'shadow_controller'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shadow_controller
+
+
+## Usage
+
+Include the ShadowController in your RSpec configure.
+
+```ruby
+# spec/spec_helper.rb
+RSpec.configure do |config|
+  include ShadowController
+end
+```
+
+Now cast the shadow helper in your spec
+```ruby
+# spec/controllers/application_controller_spec.rb
+require "spec_helper"
+
+describe ApplicationController, type: :controller do
+  cast_shadow ApplicationController
+
+  it "..." do
+    ...
+  end
+end
+
+```
+
+## Example
+
+Your ApplicationController
+```ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+
+  def redirect_somewhere
+    redirect_to 'http://www.example.com'
+  end
+end
+```
+
+Your controller spec
+```ruby
+# spec/controllers/application_controller_spec.rb
+require "spec_helper"
+
+describe ApplicationController, type: :controller do
+  cast_shadow ApplicationController
+
+  it "#redirect_somewhere" do
+    get :redirect_somewhere
+    expect(response).to redirect_to 'http://www.example.com'
+  end
+end
+
+```
+
+Without the ShadowController helper in use above or any other configurations, this test would have failed with the following error
+
+```ruby
+1) ApplicationController #redirect_somewhere
+     Failure/Error: get :redirect_somewhere
+
+     ActionController::UrlGenerationError:
+       No route matches {:action=>"redirect_somewhere", :controller=>"application"}
+     # ./spec/controllers/application_controller_spec.rb:8:in `block (2 levels) in <top (required)>'
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/milesstanfield/shadow_controller. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 "shadow_controller"
+
+# 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

data/bin/setup

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

data/lib/shadow_controller/version.rb

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

data/lib/shadow_controller.rb

@@ -0,0 +1,53 @@
+require "shadow_controller/version"
+
+module ShadowController
+  def cast_shadow(controller)
+    raise_misuse if misused? controller
+    mock controller
+    draw_routes controller
+  end
+
+  private
+
+  def actions(controller)
+    controller.action_methods
+  end
+
+  def raise_misuse
+    raise "ControllerMime is currently limited to use with ApplicationController only"
+  end
+
+  def misused?(controller)
+    controller != ApplicationController
+  end
+
+  def first_action(controller)
+    actions(controller).first
+  end
+
+  def draw_routes(controller)
+    before do
+      routes.draw do
+        eval dynamic_routes(controller).join(" ")
+      end
+    end
+  end
+
+  def mock(controller)
+    method = first_action(controller).to_sym
+    controller_path = controller.instance_method(method).source_location[0]
+    controller { eval File.read(controller_path) }
+  end
+
+  def dynamic_routes(controller)
+    actions(controller).map do |action|
+      %Q[
+        get "/anonymous/#{action}"
+        post "/anonymous/#{action}"
+        patch "/anonymous/#{action}"
+        put "/anonymous/#{action}"
+        delete "/anonymous/#{action}"
+      ]
+    end
+  end
+end

data/shadow_controller.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shadow_controller/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shadow_controller"
+  spec.version       = ShadowController::VERSION
+  spec.authors       = ["Miles Stanfield"]
+  spec.email         = ["milesstanfield@gmail.com"]
+
+  spec.summary       = %q{An RSpec helper that makes testing your rails ApplicationController a cool breeze.}
+  spec.description   = %q{Testing your ApplicationController often requires using the AnonymousController and drawing custom routes. This helper does all that for you and prevents you from having to update your AnonymousController whenever you make a change to the ApplicationController.'}
+  spec.homepage      = "https://github.com/milesstanfield/shadow_controller"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rspec-rails', '~> 3.4.0'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: shadow_controller
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Miles Stanfield
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+description: Testing your ApplicationController often requires using the AnonymousController
+  and drawing custom routes. This helper does all that for you and prevents you from
+  having to update your AnonymousController whenever you make a change to the ApplicationController.'
+email:
+- milesstanfield@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shadow_controller.rb
+- lib/shadow_controller/version.rb
+- shadow_controller.gemspec
+homepage: https://github.com/milesstanfield/shadow_controller
+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.2.2
+signing_key: 
+specification_version: 4
+summary: An RSpec helper that makes testing your rails ApplicationController a cool
+  breeze.
+test_files: []