resource_spec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41c01c8d22dd537442114ef20b0b4191620589ce
+  data.tar.gz: 08783f47f460b39eae770a759909a794b9de0cdd
+SHA512:
+  metadata.gz: 3e5a976cb1342b0d0571ae1e773c2fd10eadd710506e871b43cfd79080a4dfe788e6a2b62f5c68c8fde603cbe4d3651277f09033cda1cefce6f6b1957ada80a4
+  data.tar.gz: 6bc8512c1a5be47b889b3dc1206ceb1fb3f572b4c7fcf3fcb9136d89ef859d548cf9939512ac7d8ad920ab96443a20b7b0ccca7f3ce90b80a04c72aedeec4495

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,123 @@
+# ResourceSpec
+
+Test your RESTful Rails controllers with ease.
+
+### Motivation
+
+In every rails app we have a set of controllers which incapsulates simple CRUD logic, especially in admin area. Most of such controllers stays uncovered: it often seems excessive to test typical things. In other hand, in such typical places there always exists some unusual logic, which had to be tested. Furthermore, 100% test coverage rocks.
+
+## Simple Use Case
+
+Given we have [typical REST controller](spec/dummy/app/controllers/users_controller.rb).
+
+It can be tested with a few lines of code:
+
+```ruby
+include_context "ResourceSpec", User do
+  it_behaves_like "GET :new"
+  it_behaves_like "POST :create"
+  it_behaves_like "GET :edit"
+  it_behaves_like "PUT :update"
+  it_behaves_like "DELETE :destroy"
+  it_behaves_like "GET :index"
+end
+```
+
+`FactoryGirl` factory for `User` must be defined. Calls to `FactoryGirl` or other factory engine can be overriden with settings.
+
+## Customization
+
+Take a look at [default settings](lib/resource_spec/context.rb). All of these settings can be changed inside `include_context` block.
+
+Some examples:
+
+### Redirect to `#index` instead of `#show` on create
+
+Define override context somewhere in `support` folder:
+
+```ruby
+RSpec.shared_context "ResourceSpec overrides" do
+  let(:success_resource_url) { controller.url_for(action: :index) }
+end
+```
+
+Then include:
+
+```ruby
+include_context "ResourceSpec", User do
+  include_context "ResourceSpec overrides"
+
+  ...
+end
+```
+
+### Nesting
+
+This will make nested resources like `/category/:category_id/groups` work:
+
+```ruby
+  let(:category) { create(:category) }
+
+  include_context "ResourceSpec", Group do
+    let(:url_args) { { category_id: category.id } }
+
+    ...
+  end
+```
+
+### Skipping passwords
+
+`POST :create` and `PUT :update` examples are checking the record on compliance between params passed by request and record values saved to database. Some fields like images, generated tokens, encrypted passwords must be skipped.
+
+```ruby
+include_context "ResourceSpec", User do
+  let(:not_expected_params) do
+    %i(password password_confirmation last_sign_in_at)
+  end
+
+  ...
+end
+
+```
+
+### Timestamps
+
+If you have any DateTime fields in your model - freeze the time:
+
+```ruby
+around { |example| travel_to(Time.now, &example) }
+```
+
+If you have Date columns - use `#to_date` in factory.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "resource_spec"
+```
+
+And this to `spec_helper.rb`:
+
+```ruby
+require "resource_spec/all"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resource_spec
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gzigzigzeo/resource_spec.

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 "resource_spec"
+
+# 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/resource_spec/all.rb

@@ -0,0 +1,7 @@
+require "resource_spec/context"
+require "resource_spec/index"
+require "resource_spec/new"
+require "resource_spec/edit"
+require "resource_spec/create"
+require "resource_spec/update"
+require "resource_spec/destroy"

data/lib/resource_spec/context.rb

@@ -0,0 +1,43 @@
+RSpec.shared_context "ResourceSpec" do |model|
+  let(:model) { model }
+
+  let(:param_name) { model.model_name.param_key }
+  let(:primary_key_param_name) { :id }
+  let(:factory_name) { model }
+
+  let(:attributes) { FactoryGirl.attributes_for(factory_name).except(:id) }
+  let(:not_expected_params) { [] }
+  let(:params) { attributes }
+  let(:invalid_params) { Hash[params.keys.zip([""] * params.keys.size)] }
+  let(:params_to_expect) { params.except(*not_expected_params) }
+
+  let(:resource) { assigns[param_name] }
+  let(:instance) { FactoryGirl.create(factory_name) }
+
+  let(:collection) { assigns[param_name.to_s.pluralize.to_sym] }
+
+  let(:url_args) { {} }
+
+  let(:index_url_args) { {} }
+
+  let(:new_url_args) { url_args.merge(param_name => params) }
+
+  let(:success_resource_url) do
+    controller.url_for(action: :show, primary_key_param_name => resource.id)
+  end
+
+  let(:create_url_args) { new_url_args }
+  let(:invalid_create_url_args) { url_args.merge(param_name => invalid_params) }
+  let(:success_create_url) { success_resource_url }
+
+  let(:edit_url_args) { url_args.merge(primary_key_param_name => instance.id) }
+
+  let(:update_url_args) { edit_url_args.merge(new_url_args) }
+  let(:invalid_update_url_args) do
+    edit_url_args.merge(param_name => invalid_params)
+  end
+  let(:success_update_url) { success_resource_url }
+
+  let(:destroy_url_args) { edit_url_args }
+  let(:success_destroy_url) { controller.url_for(action: :index) }
+end

data/lib/resource_spec/create.rb

@@ -0,0 +1,20 @@
+RSpec.shared_examples "POST :create" do
+  describe "POST :create" do
+    it "301" do
+      post :create, create_url_args
+
+      expect(resource.errors).to be_blank, "Given params: #{create_url_args} failed with errors: #{resource.errors.full_messages}, "
+      expect(resource).to be_persisted
+      expect(resource.reload).to have_attributes(params_to_expect)
+
+      expect(response).to redirect_to(success_create_url)
+    end
+
+    it "422" do
+      post :create, invalid_create_url_args
+
+      expect(response).to be_success
+      expect(resource.errors).to be_present
+    end
+  end
+end

data/lib/resource_spec/destroy.rb

@@ -0,0 +1,15 @@
+RSpec.shared_examples "DELETE :destroy" do |**kwargs|
+  describe "DELETE :destroy" do
+    it "301" do
+      delete :destroy, destroy_url_args
+
+      expect(response).to redirect_to(success_destroy_url)
+
+      if kwargs[:paranoid]
+        expect(resource.deleted_at).to be_present
+      else
+        expect { resource.reload }.to raise_error(ActiveRecord::RecordNotFound)
+      end
+    end
+  end
+end

data/lib/resource_spec/edit.rb

@@ -0,0 +1,10 @@
+RSpec.shared_examples "GET :edit" do
+  describe "GET :edit" do
+    it "200" do
+      get :edit, edit_url_args
+
+      expect(response).to be_success
+      expect(resource).to eq(instance)
+    end
+  end
+end

data/lib/resource_spec/index.rb

@@ -0,0 +1,14 @@
+RSpec.shared_examples "GET :index" do
+  let!(:expected_collection) { FactoryGirl.create_list(model, rand(3) + 1) }
+
+  describe "GET :index" do
+    it "200" do
+      get :index, index_url_args
+
+      expect(response).to be_success
+      expect(collection).to be_present, "let(:collection) is blank and must point to actual collection"
+      expect(collection.size).to eq(expected_collection.size)
+      expect(collection).to include(*expected_collection)
+    end
+  end
+end

data/lib/resource_spec/new.rb

@@ -0,0 +1,12 @@
+RSpec.shared_examples "GET :new" do
+  describe "GET :new" do
+    it "200" do
+      get :new, new_url_args
+
+      expect(response).to be_success
+
+      expect(resource).to be_present, "let(:resource) must point to controller variable containing instance, assigns[#{param_name}] by default"
+      expect(resource).to be_new_record
+    end
+  end
+end

data/lib/resource_spec/update.rb

@@ -0,0 +1,19 @@
+RSpec.shared_examples "PUT :update" do
+  describe "PUT :update" do
+    it "301" do
+      put :update, update_url_args
+
+      expect(resource.errors).to be_blank, "Given params: #{create_url_args} failed with errors: #{resource.errors.full_messages}, "
+      expect(resource.reload).to have_attributes(params_to_expect)
+
+      expect(response).to redirect_to(success_update_url)
+    end
+
+    it "422" do
+      put :update, invalid_update_url_args
+
+      expect(response).to be_success
+      expect(resource.errors).to be_present
+    end
+  end
+end

data/lib/resource_spec/version.rb

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

data/lib/resource_spec.rb

@@ -0,0 +1,4 @@
+require "resource_spec/version"
+
+module ResourceSpec
+end

data/resource_spec.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "resource_spec/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "resource_spec"
+  spec.version       = ResourceSpec::VERSION
+  spec.authors       = ["Victor Sokolov"]
+  spec.email         = ["gzigzigzeo@evilmartians.com"]
+
+  spec.summary       = %(RSpec shared examples for testing Rails REST controllers)
+  spec.description   = %(RSpec shared examples for testing Rails REST controllers)
+  spec.homepage      = "https://github.com/gzigzigzeo/resource_spec"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    fail(
+      "RubyGems 2.0 or newer is required to protect against public gem pushes."
+    )
+  end
+
+  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.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "factory_girl"
+  spec.add_development_dependency "ffaker"
+  spec.add_development_dependency "responders", "~> 2.0"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_dependency "rspec"
+  spec.add_dependency "rspec-rails"
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: resource_spec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Victor Sokolov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-11 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RSpec shared examples for testing Rails REST controllers
+email:
+- gzigzigzeo@evilmartians.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/resource_spec.rb
+- lib/resource_spec/all.rb
+- lib/resource_spec/context.rb
+- lib/resource_spec/create.rb
+- lib/resource_spec/destroy.rb
+- lib/resource_spec/edit.rb
+- lib/resource_spec/index.rb
+- lib/resource_spec/new.rb
+- lib/resource_spec/update.rb
+- lib/resource_spec/version.rb
+- resource_spec.gemspec
+homepage: https://github.com/gzigzigzeo/resource_spec
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.8
+signing_key: 
+specification_version: 4
+summary: RSpec shared examples for testing Rails REST controllers
+test_files: []