ctrlspecs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f97741e9ed5721be6e3137a3c199dcf9673c4edf
+  data.tar.gz: b7731968b9018bb6b8b0f3f3e15a1adf1614c98d
+SHA512:
+  metadata.gz: 85840d0fa5bdd15458a5447267e5f267401ddaa5ee0d1103463718a1421656f39832a2f63903ae8061c42240778a73851327c56d3628a88a20d6cb606942a4e8
+  data.tar.gz: 206b9b0141051d05c4b8e5790bcbc643adc420c8d68ef581ef785c5379197aca8bf637f4d3a3b3a06e7997adee1125e4f5bc417cf01c0ce9def513c6e475862c

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Mateusz Stebnicki
+
+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,95 @@
+# Ctrlspecs
+What's the responsibility of a controller?
+
+Render. Redirect. Flash.
+
+I'd argue that those are, in fact, the only responsibilities controllers have.
+Now, I realize controllers' actions are often burdened with resource creation, deletion and updating,
+but let's keep it real here - all this logic belongs to another object, usually a service.
+And indeed, most of the non-trivial, well designed applications use service objects,
+instead of cramming everything inside poor controllers.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ctrlspecs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ctrlspecs
+
+
+In your rails_helper.rb add:
+```ruby
+RSpec.configure do |config|
+  config.extend Ctrlspecs
+  ...
+end
+```  
+
+## Usage
+Ctrlspecs gives you a few helpers, which are basically just shared examples testing
+what your typical controller does:
+* what template does it render
+* where does it redirect to
+* what message does it flash
+* what service does it call
+
+```ruby
+subject { post :create, params } # subject is required
+
+it_renders_template :create
+it_redirects_to 'resources_path(assigns(:resource))' # the path argument will be evaled
+it_flashes notice: I18n.t('shared.created')
+it_calls_service SuchService
+```
+
+Ctrlspecs also provides contexts for testing failures:
+```ruby
+mock_save_record_failure
+mock_service_returning_error, VeryService, Response::Error
+```
+
+So, how does your typical controller action spec look like now?
+
+```ruby
+require 'rails_helper'
+
+describe PostsController do
+  describe 'POST #create' do
+    let!(:params) do
+      { post: { content: 'such content, wow' } }
+    end
+    subject { post :create, params }
+
+    context 'success' do
+      it_redirects_to 'post_path(assigns(:post))'
+      it_flashes notice: I18n.t('shared.created', resource: 'Post')
+    end
+
+    context 'failure' do
+      mock_save_record_failure
+      it_renders_template :new
+    end
+  end
+
+  describe 'GET #index' do
+    subject { get :index }
+    it_calls_service Posts::GetAllTheFrigginPosts
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/mwsteb/ctrlspecs/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/ctrlspecs.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ctrlspecs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ctrlspecs"
+  spec.version       = Ctrlspecs::VERSION
+  spec.authors       = ["Mateusz Stebnicki"]
+  spec.email         = ["mateusz.stebnicki@gmail.pl"]
+  spec.summary       = %q{Helpers for testing controller actions}
+  spec.description   = %q{so helpers, wow. amaze.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rspec-rails", "~> 3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/ctrlspecs.rb

@@ -0,0 +1,29 @@
+require 'ctrlspecs/version'
+require File.dirname(__FILE__) + "/spec/support/shared/examples.rb"
+require File.dirname(__FILE__) + "/spec/support/shared/contexts.rb"
+
+module Ctrlspecs
+  def it_renders_template tmpl_name
+    it_behaves_like 'renders template', tmpl_name
+  end
+
+  def it_redirects_to path
+    it_behaves_like 'redirects to', path
+  end
+
+  def it_flashes hsh
+    it_behaves_like 'flashes', hsh
+  end
+
+  def it_calls_service service
+    it_behaves_like 'calls service', service
+  end
+
+  def mock_save_record_failure
+    include_context 'mock save record failure'
+  end
+
+  def mock_service_returning_error service, error
+    include_context 'mock service returning error', service, error
+  end
+end

data/lib/ctrlspecs/version.rb

@@ -0,0 +1,3 @@
+module Ctrlspecs
+  VERSION = "0.0.1"
+end

data/lib/spec/support/shared/contexts.rb

@@ -0,0 +1,7 @@
+shared_context 'mock save record failure' do
+  before { allow_any_instance_of(ActiveRecord::Base).to receive(:save) { false } }
+end
+
+shared_context 'mock service returning error' do |service, error|
+  before { allow_any_instance_of(service).to receive(:call) { error } }
+end

data/lib/spec/support/shared/examples.rb

@@ -0,0 +1,21 @@
+shared_examples 'renders template' do |template|
+  it { is_expected.to render_template template }
+end
+
+shared_examples 'redirects to' do |path|
+  it { is_expected.to redirect_to eval(path) }
+end
+
+shared_examples 'flashes' do |hsh|
+  specify do
+    subject
+    expect(flash[hsh.keys.first]).to eq hsh.values.first
+  end
+end
+
+shared_examples 'calls service' do |service|
+  specify do
+    expect_any_instance_of(service).to receive(:call)
+    subject
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: ctrlspecs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mateusz Stebnicki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-12 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.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: so helpers, wow. amaze.
+email:
+- mateusz.stebnicki@gmail.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ctrlspecs.gemspec
+- lib/ctrlspecs.rb
+- lib/ctrlspecs/version.rb
+- lib/spec/support/shared/contexts.rb
+- lib/spec/support/shared/examples.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.4.3
+signing_key: 
+specification_version: 4
+summary: Helpers for testing controller actions
+test_files: []