brightbox-rspec-rails-ext 1.0

data/CHANGELOG

@@ -0,0 +1 @@
+v1.0. Initial release

data/LICENCE

@@ -0,0 +1,11 @@
+Released under the MIT Licence
+
+Copyright (c) 2008 Brightbox Systems Ltd 
+
+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.
+
+See http://www.brightbox.co.uk/ for contact details.  

data/Manifest

@@ -0,0 +1,8 @@
+CHANGELOG
+lib/controller_example_group.rb
+lib/responses.rb
+lib/rspec_rails_extensions.rb
+LICENCE
+Manifest
+Rakefile
+README.rdoc

data/README.rdoc

@@ -0,0 +1,64 @@
+= RSpec-Rails Extensions
+
+Some prettifications for RSpec Rails.  
+
+== Installation
+
+  sudo gem install brightbox-rspec-rails-ext --source=http://gems.github.com/
+  
+Then, within your config/environment.rb: 
+
+  config.gem 'brightbox-rspec-rails-ext', :lib => 'rspec_rails_extensions', :source => 'http://gems.github.com'
+
+== Matchers
+
+Some helpful matchers for testing HTTP statuses beyond the default be_success (200 OK)
+
+    # looks for a 201 Created (useful for API CREATE calls)
+    response.should be_successfully_created 
+    
+    # expects a Location field with the given URL (useful for API CREATE calls)
+    response.should point_to(url) 
+    
+    # looks for a 422 response (invalid object)
+    response.should be_unprocessable
+    
+    # looks for a 404
+    response.should be_not_found
+    
+    # looks for a 401
+    response.should be_unauthorised
+    
+    # looks for a 500
+    response.should be_an_error
+    
+== Specifying your controllers
+
+One of the issues with writing standard controller specifications, using RSpec's inbuilt mock objects is that the "flow" of your specs feels wrong.  
+
+  it "should display a page for a given thingy" do
+    @thingy = mock_model Thingy, :name => 'Wotsit'
+    Thingy.should_receive(:find).with('1').and_return(@thingy)
+    
+    get :show, :id => '1'
+    
+    response.should be_success
+    response.should render_template('thingies/show')
+  end
+    
+In other words you are setting expectations before you are doing the work - technically correct but it reads wrongly.  
+
+These extra helpers let you write specifications in a more english-like manner.  
+
+  it "should display a page for a given thingy" do
+    @thingy = mock_model Thingy
+    
+    on_getting :show, :id => '1' do
+      Thingy.should_receive(:find).with('1').and_return(@thingy)
+    end
+
+    response.should be_success
+    response.should render_template('thingies/show')
+  end
+    
+Isn't that lovely?

data/Rakefile

@@ -0,0 +1,6 @@
+require 'echoe'
+Echoe.new('rspec-rails-ext') do | gem | 
+  gem.author = 'Rahoul Baruah'
+  gem.summary = 'Helpers for prettying up your RSpec-Rails specifications'
+  gem.url = 'http://github.com/brightbox-rspec-rails-ext'
+end

data/lib/controller_example_group.rb

@@ -0,0 +1,65 @@
+module Spec
+  module Rails
+    module Example
+      class ControllerExampleGroup < FunctionalExampleGroup
+        # Perform a pseudo HTTP GET, performing any code in the block beforehand.  This is to allow you to set up expectations on your mocks whilst keeping the code readable.   
+        # For example: 
+        #   on_getting :show, :id => '25' do
+        #     @person = mock_model Person
+        #     Person.should_receive(:find).with('25').and_return(@person)
+        #   end
+        # If you want an XMLHTTPRequest pass in :as_xhr => true in the parameters
+        # (don't worry - it won't be passed to your controller)
+        # For example:
+        #   on_getting :show, :id => '25', :as_xhr => true do
+        #     whatever
+        #   end
+        def on_getting page, parameters = {}
+          yield if block_given?
+          is_xhr_request = parameters.delete(:as_xhr)
+          if is_xhr_request
+            xhr :get, page, parameters
+          else
+            get page, parameters
+          end
+        end
+
+        # Perform a pseudo HTTP POST, performing any code in the block beforehand.  This is to allow you to set up expectations on your mocks whilst keeping the code readable.   
+        # As with on_getting, use :as_xhr => true to make this an XMLHTTPRequest
+        def on_posting_to page, parameters = {}
+          yield if block_given?
+          is_xhr_request = parameters.delete(:as_xhr)
+          if is_xhr_request
+            xhr :post, page, parameters
+          else
+            post page, parameters
+          end
+        end
+        
+        # Perform a pseudo HTTP PUT, performing any code in the block beforehand.  This is to allow you to set up expectations on your mocks whilst keeping the code readable.   
+        # As with on_getting, use :as_xhr => true to make this an XMLHTTPRequest
+        def on_putting_to page, parameters = {}
+          yield if block_given?
+          is_xhr_request = parameters.delete(:as_xhr)
+          if is_xhr_request
+            xhr :put, page, parameters
+          else
+            put page, parameters
+          end
+        end
+        
+        # Perform a pseudo HTTP DELETE, performing any code in the block beforehand.  This is to allow you to set up expectations on your mocks whilst keeping the code readable.   
+        # As with on_getting, use :as_xhr => true to make this an XMLHTTPRequest
+        def on_deleting_from page, parameters = {}
+          yield if block_given?
+          is_xhr_request = parameters.delete(:as_xhr)
+          if is_xhr_request
+            xhr :delete, page, parameters
+          else
+            delete page, parameters
+          end
+        end
+      end
+    end
+  end
+end

data/lib/responses.rb

@@ -0,0 +1,81 @@
+=begin rdoc
+Module with a set of matchers for examining ActionController::Response objects
+=end
+module ResponseMatchers
+  # test for a 201 response
+  def be_successfully_created 
+    ResponseStatusMatcher.new "201 Created"
+  end
+  
+  # test for a 422 response
+  def be_unprocessable
+    ResponseStatusMatcher.new "422 Unprocessable Entity"
+  end 
+  
+  # test for a 404 response
+  def be_not_found
+    ResponseStatusMatcher.new "404 Not Found"
+  end
+  
+  # test for a 401 response
+  def be_unauthorised
+    ResponseStatusMatcher.new "401 Unauthorized"
+  end
+  alias :be_unauthorized :be_unauthorised
+  
+  # test for a 500 internal server error 
+  def be_an_error
+    ResponseStatusMatcher.new "500 Internal Error"
+  end
+  
+  # test that the location points to a given URI
+  def point_to url
+    ResponseLocationMatcher.new url
+  end
+  
+  # Response matcher that examines ActionController::Response headers for the required status code
+  class ResponseStatusMatcher
+    # Set up this matcher as required
+    def initialize status_code
+      @status_code = status_code
+    end
+
+    # Does the given target object match the required status code?
+    def matches? target
+      target.headers['Status'] == @status_code
+    end
+    
+    # What do we tell the user when it fails?
+    def failure_message
+      "expected the response to be #{@status_code}"
+    end
+    
+    # What do we tell the user when it shouldn't fail but does
+    def negative_failure_message
+      "expected the response to be different to #{@status_code}"
+    end
+  end
+  
+  # Response matcher that examines ActionController::Response headers for the given location code
+  class ResponseLocationMatcher
+    def initialize url
+      @url = url
+    end
+    
+    # Does the given target object match the required location?
+    def matches? target
+      target.headers['Location'] == @url
+    end
+    
+    # What do we tell the user when it fails?
+    def failure_message
+      "expected the location header to be #{@url}"
+    end
+    
+    # What do we tell the user when it shouldn't fail but does
+    def negative_failure_message
+      "expected the location header to be different to #{@url}"
+    end
+  end
+
+end

data/lib/rspec_rails_extensions.rb

@@ -0,0 +1,2 @@
+require 'matchers'
+require 'controller_example_group'

data/rspec-rails-ext.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rspec-rails-ext}
+  s.version = "1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rahoul Baruah"]
+  s.date = %q{2009-02-13}
+  s.description = %q{Helpers for prettying up your RSpec-Rails specifications}
+  s.email = %q{}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/controller_example_group.rb", "lib/responses.rb", "lib/rspec_rails_extensions.rb", "README.rdoc"]
+  s.files = ["CHANGELOG", "lib/controller_example_group.rb", "lib/responses.rb", "lib/rspec_rails_extensions.rb", "LICENCE", "Manifest", "Rakefile", "README.rdoc", "rspec-rails-ext.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/brightbox-rspec-rails-ext}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Rspec-rails-ext", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rspec-rails-ext}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Helpers for prettying up your RSpec-Rails specifications}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: brightbox-rspec-rails-ext
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- Rahoul Baruah
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-13 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Helpers for prettying up your RSpec-Rails specifications
+email: ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/controller_example_group.rb
+- lib/responses.rb
+- lib/rspec_rails_extensions.rb
+- README.rdoc
+files: 
+- CHANGELOG
+- lib/controller_example_group.rb
+- lib/responses.rb
+- lib/rspec_rails_extensions.rb
+- LICENCE
+- Manifest
+- Rakefile
+- README.rdoc
+- rspec-rails-ext.gemspec
+has_rdoc: true
+homepage: http://github.com/brightbox-rspec-rails-ext
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Rspec-rails-ext
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: rspec-rails-ext
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Helpers for prettying up your RSpec-Rails specifications
+test_files: []
+