resource_spec 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41c01c8d22dd537442114ef20b0b4191620589ce
-  data.tar.gz: 08783f47f460b39eae770a759909a794b9de0cdd
+  metadata.gz: 9bb861e58b40cf18f77d6ce576d3d88f2d43e526
+  data.tar.gz: 12e5208fed9ff5cfd9be32d10429f51990da34e2
 SHA512:
-  metadata.gz: 3e5a976cb1342b0d0571ae1e773c2fd10eadd710506e871b43cfd79080a4dfe788e6a2b62f5c68c8fde603cbe4d3651277f09033cda1cefce6f6b1957ada80a4
-  data.tar.gz: 6bc8512c1a5be47b889b3dc1206ceb1fb3f572b4c7fcf3fcb9136d89ef859d548cf9939512ac7d8ad920ab96443a20b7b0ccca7f3ce90b80a04c72aedeec4495
+  metadata.gz: 459e7463835bb1d49b42316ddb43780dc71e7590cf3ee013b4e7f11a2a2e774f6e16c8bfa497acaac9bfeeedab6b184769cd8b4499f3f2d95e828d486e7dc274
+  data.tar.gz: cc0b200afaa66ae59bb5a0340783c74d03e9d222343807c201f768b0c810ceda91dbf30ef5f682f61a1d5136e0611f6b894b25776d9847ea7d6f9d70a63ca939

data/README.md

@@ -1,10 +1,16 @@
 # ResourceSpec
 
+[![Build Status](https://travis-ci.org/gzigzigzeo/resource_spec.svg)](http://travis-ci.org/gzigzigzeo/resource_spec/fias)
+
+<a href="https://evilmartians.com/?utm_source=resource_spec-gem">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
+</a>
+
 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.
+In every Rails app we have a set of controllers which encapsulates simple CRUD logic, especially in the 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
 
@@ -23,7 +29,7 @@ include_context "ResourceSpec", User do
 end
 ```
 
-`FactoryGirl` factory for `User` must be defined. Calls to `FactoryGirl` or other factory engine can be overriden with settings.
+`FactoryGirl` factory for `User` must be defined. Calls to `FactoryGirl` or other factory engine can be overridden with settings.
 
 ## Customization
 
@@ -59,7 +65,7 @@ This will make nested resources like `/category/:category_id/groups` work:
   let(:category) { create(:category) }
 
   include_context "ResourceSpec", Group do
-    let(:url_args) { { category_id: category.id } }
+    let(:base_url_args) { { category_id: category.id } }
 
     ...
   end
@@ -90,6 +96,19 @@ around { |example| travel_to(Time.now, &example) }
 
 If you have Date columns - use `#to_date` in factory.
 
+### Additional action expectations
+
+```ruby
+include_context "ResourceSpec", User do
+  it_behaves_like "GET :new" do
+    it "includes form tag" do
+      expect(response.body).to include("form")
+    end
+  end
+  ...
+end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/resource_spec/all.rb

@@ -1,4 +1,5 @@
 require "resource_spec/context"
+require "resource_spec/shared"
 require "resource_spec/index"
 require "resource_spec/new"
 require "resource_spec/edit"

data/lib/resource_spec/context.rb

@@ -2,35 +2,46 @@ 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(:primary_key_param_name) { :id } # /resource/:id/edit
+  let(:factory_name) { model } # FactoryGirl(Namespaced::Model) fails
 
   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)] }
+
+  # Used to skip values changing on record save.
+  #
+  # POST /users/create?user[name]=John&user[password]=5
+  # expect(user).to have_attributes({name: "John"})
+  #
+  # No need to check password: it's encrypted
+  let(:not_expected_params) { [] } # Usually :password, :image, etc.
   let(:params_to_expect) { params.except(*not_expected_params) }
 
+  # Valid params with blank values by default
+  let(:invalid_params) { Hash[params.keys.zip([""] * params.keys.size)] }
+
+  # Returns active object instance from controller. Could be `controller.resource` if you use decent_exposure.
   let(:resource) { assigns[param_name] }
   let(:instance) { FactoryGirl.create(factory_name) }
 
+  # Returns collection, same as :resource
   let(:collection) { assigns[param_name.to_s.pluralize.to_sym] }
 
-  let(:url_args) { {} }
+  let(:default_url_args) { {} }
 
   let(:index_url_args) { {} }
 
-  let(:new_url_args) { url_args.merge(param_name => params) }
+  let(:new_url_args) { default_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(:invalid_create_url_args) { default_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(:edit_url_args) { default_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

data/lib/resource_spec/create.rb

@@ -1,20 +1,30 @@
 RSpec.shared_examples "POST :create" do
   describe "POST :create" do
-    it "301" do
-      post :create, create_url_args
+    include_examples "POST :create, success"
+  end
+end
+
+RSpec.shared_examples "POST :create, success" do
+  context "success" do
+    let(:url_args) { create_url_args }
+    let(:redirect_url) { success_create_url }
 
-      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)
+    before { post :create, url_args }
+
+    include_examples "responds 301"
+    include_examples "resource has no errors"
+    include_examples "resource persisted"
+    include_examples "resource has expected attributes"
+  end
+end
 
-      expect(response).to redirect_to(success_create_url)
-    end
+RSpec.shared_examples "POST :create, fail" do
+  context "fail" do
+    let(:url_args) { invalid_create_url_args }
 
-    it "422" do
-      post :create, invalid_create_url_args
+    before { post :create, url_args }
 
-      expect(response).to be_success
-      expect(resource.errors).to be_present
-    end
+    include_examples "responds 200"
+    include_examples "resource has errors"
   end
 end

data/lib/resource_spec/destroy.rb

@@ -1,14 +1,21 @@
 RSpec.shared_examples "DELETE :destroy" do |**kwargs|
   describe "DELETE :destroy" do
-    it "301" do
-      delete :destroy, destroy_url_args
+    context "success" do
+      let(:url_args) { destroy_url_args }
+      let(:redirect_url) { success_destroy_url }
 
-      expect(response).to redirect_to(success_destroy_url)
+      before { delete :destroy, url_args }
 
-      if kwargs[:paranoid]
-        expect(resource.deleted_at).to be_present
-      else
-        expect { resource.reload }.to raise_error(ActiveRecord::RecordNotFound)
+      include_examples "responds 301"
+
+      it "resource destroyed" do
+        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

@@ -1,9 +1,12 @@
 RSpec.shared_examples "GET :edit" do
   describe "GET :edit" do
-    it "200" do
-      get :edit, edit_url_args
+    let(:url_args) { edit_url_args }
 
-      expect(response).to be_success
+    before { get :edit, url_args }
+
+    include_examples "responds 200"
+
+    it "resource loaded" do
       expect(resource).to eq(instance)
     end
   end

data/lib/resource_spec/new.rb

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

data/lib/resource_spec/shared.rb

@@ -0,0 +1,35 @@
+RSpec.shared_examples "responds 200" do
+  it "responds 200" do
+    expect(response).to be_success
+  end
+end
+
+RSpec.shared_examples "responds 301" do
+  it "responds 301" do
+    expect(response).to redirect_to(redirect_url)
+  end
+end
+
+RSpec.shared_examples "resource has no errors" do
+  it "resource has no errors" do
+    expect(resource.errors).to be_blank, "Given params: #{url_args} failed with errors: #{resource.errors.full_messages}"
+  end
+end
+
+RSpec.shared_examples "resource has errors" do
+  it "resource has errors" do
+    expect(resource.errors).to be_present
+  end
+end
+
+RSpec.shared_examples "resource persisted" do
+  it "resource persisted" do
+    expect(resource).to be_persisted
+  end
+end
+
+RSpec.shared_examples "resource has expected attributes" do
+  it "resource has expected attributes" do
+    expect(resource.reload).to have_attributes(params_to_expect)
+  end
+end

data/lib/resource_spec/update.rb

@@ -1,19 +1,30 @@
 RSpec.shared_examples "PUT :update" do
   describe "PUT :update" do
-    it "301" do
-      put :update, update_url_args
+    include_examples "PUT :update, success"
+    include_examples "PUT :update, fail"
+  end
+end
+
+RSpec.shared_examples "PUT :update, success" do
+  context "success" do
+    let(:url_args) { update_url_args }
+    let(:redirect_url) { success_update_url }
 
-      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)
+    before { put :update, url_args }
+
+    include_examples "responds 301"
+    include_examples "resource has no errors"
+    include_examples "resource has expected attributes"
+  end
+end
 
-      expect(response).to redirect_to(success_update_url)
-    end
+RSpec.shared_examples "PUT :update, fail" do
+  context "fail" do
+    let(:url_args) { invalid_update_url_args }
 
-    it "422" do
-      put :update, invalid_update_url_args
+    before { post :update, url_args }
 
-      expect(response).to be_success
-      expect(resource.errors).to be_present
-    end
+    include_examples "responds 200"
+    include_examples "resource has errors"
   end
 end

data/lib/resource_spec/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resource_spec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Victor Sokolov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-11 00:00:00.000000000 Z
+date: 2015-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -174,6 +174,7 @@ files:
 - lib/resource_spec/edit.rb
 - lib/resource_spec/index.rb
 - lib/resource_spec/new.rb
+- lib/resource_spec/shared.rb
 - lib/resource_spec/update.rb
 - lib/resource_spec/version.rb
 - resource_spec.gemspec