rspec_restful 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb1ea0dce5a1c6cde7c68e6eb1ef0fc34159febe
+  data.tar.gz: 08b5c56d6ee71a999aabda62259052954147a610
+SHA512:
+  metadata.gz: cc74470693516cbacd7db795ce6e57ecd5a2c8c09f303f1c036d3b521a5d9ea67092f3b5adfac3ba8dce0e0708be99002dcb9f0b4c04aac3af0bec5c5b66dbca
+  data.tar.gz: 42c910e87a5a4c16f21dd5765f5b8111d2ba2273ff3fbd3254fe08de8f558b0ee1940d14f02b54cb3fc97ba68abc30e60ac22a277b48c73daf161c5d160bd995

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,3 @@
+language: ruby
+rvm:
+  - 2.1.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jason Langenauer
+
+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,67 @@
+# RSpec-Restful
+
+Simple test helpers that provide easy speccing of basic RESTful controllers that
+only operate on a single ActiveRecord object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec_restful'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install restful_test_helpers
+
+## Usage
+
+In `spec/rails_helper.rb` add the following lines:
+```ruby
+require 'rspec_restful'
+
+#...
+
+RSpec.configure do |config|
+  config.include RspecRestful::ValidityHelpers, type: :controller
+  config.extend RspecRestful::ControllerHelpers, type: :controller
+end
+```
+
+In your controller specs, the following macros are now available to test
+the 7 basic REST actions:
+
+```ruby
+RSpec.describe WidgetsController, type: :controller do
+  let(:test_widget_params) {{ name: "Goat Herder" }}
+
+  describe_restful_index_action
+  describe_restful_new_action
+  describe_restful_create_action(Widget, url_method: :widgets_path)
+  describe_restful_edit_action(:widget)
+  describe_restful_update_action(Widget, url_method: :widgets_path)
+  describe_restful_destroy_action(Widget, url_method: :widgets_path)
+end
+```
+
+This expects that a FactoryGirl factory named `:widget` is available to create
+objects.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/restful_test_helpers/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 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "restful_test_helpers"
+
+# 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/rspec_restful/controller_helpers.rb

@@ -0,0 +1,167 @@
+module RspecRestful
+  module ControllerHelpers
+    def describe_restful_index_action
+      describe 'GET :index' do
+        before do
+          get :index
+        end
+
+        it 'renders the :index template with 200 status' do
+          expect(response).to be_success
+          expect(response).to render_template('index')
+        end
+      end
+    end
+
+    def describe_restful_show_action(resource)
+      describe 'on GET to :show' do
+        let(:item) { create(resource) }
+
+        before do
+          get :show, id: item.id
+        end
+
+        it 'renders the :show template with 200 status' do
+          expect(response).to be_success
+          expect(response).to render_template('show')
+        end
+      end
+    end
+
+    def describe_restful_new_action
+      describe 'on GET to :new' do
+        before do
+          get :new
+        end
+
+        it 'renders the :new template with 200 status' do
+          expect(response).to be_success
+          expect(response).to render_template('new')
+        end
+      end
+    end
+
+    # Expects a method called test_{class_name}_params to be defined in the
+    # current spec group. This should return a hash with the params you want
+    # passed to the action.
+    def describe_restful_create_action(klass, options = {})
+      name = klass.name.underscore
+      url_method = options[:url_method] || (name.pluralize + '_url').to_sym
+      params_method = ('test_' + name + '_params').to_sym
+      name = name.to_sym
+
+      describe 'POST :create' do
+        context 'with valid data' do
+          before do
+            stub_as_always_valid(klass)
+            post :create, name => send(params_method)
+          end
+
+          it "redirects to #{url_method}" do
+            expect(response).to be_redirect
+            expect(response).to redirect_to(send(url_method))
+          end
+
+          it "creates a #{klass.name}" do
+            expect do
+              post :create, name => send(params_method)
+            end.to change(klass, :count).by(1)
+          end
+        end
+
+        context 'with invalid data' do
+          before do
+            stub_as_never_valid(klass)
+            post :create, name => send(params_method)
+          end
+
+          it 'renders the :new template with 200 status' do
+            expect(response).to be_success
+            expect(response).to render_template(:new)
+          end
+
+          it "doesn't create a #{klass.name}" do
+            expect do
+              post :create, name => send(params_method)
+            end.not_to change(klass, :count)
+          end
+        end
+      end
+    end
+
+    def describe_restful_edit_action(resource)
+      describe 'GET :edit' do
+        let(:item) { create(resource) }
+
+        before do
+          get :edit, id: item.id
+        end
+
+        it 'renders the :edit template with 200 status' do
+          expect(response).to be_success
+          expect(response).to render_template('edit')
+        end
+      end
+    end
+
+    def describe_restful_update_action(klass, options = {})
+      name = klass.name.underscore
+      url_method = options[:url_method] || (name.pluralize + '_url').to_sym
+      params_method = ('test_' + name + '_params').to_sym
+      name = name.to_sym
+
+      describe 'on PUT to :update' do
+        before { @item = create(name) }
+
+        context 'with valid data' do
+          before do
+            stub_as_always_valid(klass)
+            put :update, id: @item.id, name => send(params_method)
+          end
+
+          it "redirects to #{url_method}" do
+            expect(response).to be_redirect
+            expect(response).to redirect_to(send(url_method))
+          end
+        end
+
+        context 'with invalid data' do
+          before do
+            stub_as_never_valid(klass)
+            put :update, id: @item.id, name => send(params_method)
+          end
+
+          it 'renders the :edit template with 200 status' do
+            expect(response).to be_success
+            expect(response).to render_template('edit')
+          end
+        end
+      end
+    end
+
+    def describe_restful_destroy_action(klass, options = {})
+      name = klass.name.underscore
+      url_method = options[:url_method] || (name.pluralize + '_url').to_sym
+      name = name.to_sym
+
+      describe 'on DELETE to :destroy' do
+        before do
+          @item = create(name)
+          delete :destroy, id: @item.id
+        end
+
+        it "redirects to #{url_method}" do
+          expect(response).to be_redirect
+          expect(response).to redirect_to(send(url_method))
+        end
+
+        it "destroys a #{klass.name}" do
+          @item = create(name)
+          expect do
+            delete :destroy, id: @item.id
+          end.to change(klass, :count).by(-1)
+        end
+      end
+    end
+  end
+end

data/lib/rspec_restful/validity_helpers.rb

@@ -0,0 +1,11 @@
+module RspecRestful
+  module ValidityHelpers
+    def stub_as_always_valid(klass)
+      allow_any_instance_of(klass).to receive(:valid?).and_return(true)
+    end
+
+    def stub_as_never_valid(klass)
+      allow_any_instance_of(klass).to receive(:valid?).and_return(false)
+    end
+  end
+end

data/lib/rspec_restful/version.rb

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

data/lib/rspec_restful.rb

@@ -0,0 +1,3 @@
+require "rspec_restful/version"
+require "rspec_restful/validity_helpers"
+require "rspec_restful/controller_helpers"

data/rspec_restful.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec_restful/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec_restful"
+  spec.version       = RspecRestful::VERSION
+  spec.authors       = ["Jason Langenauer"]
+  spec.email         = ["jasonl@jobready.com.au"]
+
+  spec.summary       = %q{RSpec helpers to easily test RESTful controllers}
+  spec.description   = %q{RSpec helpers to easily test RESTful controllers}
+  spec.homepage      = "https://github.com/jobready/rspec-restful"
+  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_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: rspec_restful
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Langenauer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: RSpec helpers to easily test RESTful controllers
+email:
+- jasonl@jobready.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec_restful.rb
+- lib/rspec_restful/controller_helpers.rb
+- lib/rspec_restful/validity_helpers.rb
+- lib/rspec_restful/version.rb
+- rspec_restful.gemspec
+homepage: https://github.com/jobready/rspec-restful
+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.6
+signing_key: 
+specification_version: 4
+summary: RSpec helpers to easily test RESTful controllers
+test_files: []
+has_rdoc: