jcnetdev-shoulda 4.2

data/lib/shoulda/general.rb

@@ -0,0 +1,118 @@
+module ThoughtBot # :nodoc:
+  module Shoulda # :nodoc:
+    module General
+      def self.included(other) # :nodoc:
+        other.class_eval do
+          extend ThoughtBot::Shoulda::General::ClassMethods
+        end
+      end
+      
+      module ClassMethods
+        # Loads all fixture files (<tt>test/fixtures/*.yml</tt>)
+        def load_all_fixtures
+          all_fixtures = Dir.glob(File.join(Test::Unit::TestCase.fixture_path, "*.yml")).collect do |f| 
+            File.basename(f, '.yml').to_sym
+          end
+          fixtures *all_fixtures
+        end
+      end
+      
+      # Prints a message to stdout, tagged with the name of the calling method.
+      def report!(msg = "")
+        puts("#{caller.first}: #{msg}")
+      end
+
+      # Asserts that two arrays contain the same elements, the same number of times.  Essentially ==, but unordered.
+      #
+      #   assert_same_elements([:a, :b, :c], [:c, :a, :b]) => passes
+      def assert_same_elements(a1, a2, msg = nil)
+        [:select, :inject, :size].each do |m|
+          [a1, a2].each {|a| assert_respond_to(a, m, "Are you sure that #{a.inspect} is an array?  It doesn't respond to #{m}.") }
+        end
+
+        assert a1h = a1.inject({}) { |h,e| h[e] = a1.select { |i| i == e }.size; h }
+        assert a2h = a2.inject({}) { |h,e| h[e] = a2.select { |i| i == e }.size; h }
+
+        assert_equal(a1h, a2h, msg)
+      end
+
+      # Asserts that the given collection contains item x.  If x is a regular expression, ensure that
+      # at least one element from the collection matches x.  +extra_msg+ is appended to the error message if the assertion fails.
+      #
+      #   assert_contains(['a', '1'], /\d/) => passes
+      #   assert_contains(['a', '1'], 'a') => passes
+      #   assert_contains(['a', '1'], /not there/) => fails
+      def assert_contains(collection, x, extra_msg = "")
+        collection = [collection] unless collection.is_a?(Array)
+        msg = "#{x.inspect} not found in #{collection.to_a.inspect} #{extra_msg}"
+        case x
+        when Regexp: assert(collection.detect { |e| e =~ x }, msg)
+        else         assert(collection.include?(x), msg)
+        end        
+      end
+
+      # Asserts that the given collection does not contain item x.  If x is a regular expression, ensure that
+      # none of the elements from the collection match x.
+      def assert_does_not_contain(collection, x, extra_msg = "")
+        collection = [collection] unless collection.is_a?(Array)
+        msg = "#{x.inspect} found in #{collection.to_a.inspect} " + extra_msg
+        case x
+        when Regexp: assert(!collection.detect { |e| e =~ x }, msg)
+        else         assert(!collection.include?(x), msg)
+        end        
+      end
+      
+      # Asserts that the given object can be saved
+      #
+      #  assert_save User.new(params)
+      def assert_save(obj)
+        assert obj.save, "Errors: #{pretty_error_messages obj}"
+        obj.reload
+      end
+
+      # Asserts that the given object is valid
+      #
+      #  assert_valid User.new(params)
+      def assert_valid(obj)
+        assert obj.valid?, "Errors: #{pretty_error_messages obj}"
+      end
+      
+      # Asserts that an email was delivered.  Can take a block that can further
+      # narrow down the types of emails you're expecting. 
+      #
+      #  assert_sent_email 
+      #
+      # Passes if ActionMailer::Base.deliveries has an email
+      #  
+      #  assert_sent_email do |email|
+      #    email.subject =~ /hi there/ && email.to.include?('none@none.com')
+      #  end
+      #  
+      # Passes if there is an email with subject containing 'hi there' and
+      # 'none@none.com' as one of the recipients.
+      #    
+      def assert_sent_email
+        emails = ActionMailer::Base.deliveries
+        assert !emails.empty?, "No emails were sent"
+        if block_given?
+          matching_emails = emails.select {|email| yield email }
+          assert !matching_emails.empty?, "None of the emails matched."
+        end
+      end
+
+      # Asserts that no ActionMailer mails were delivered
+      #
+      #  assert_did_not_send_email
+      def assert_did_not_send_email
+        msg = "Sent #{ActionMailer::Base.deliveries.size} emails.\n"
+        ActionMailer::Base.deliveries.each { |m| msg << "  '#{m.subject}' sent to #{m.to.to_sentence}\n" }
+        assert ActionMailer::Base.deliveries.empty?, msg
+      end
+
+      def pretty_error_messages(obj)
+        obj.errors.map { |a, m| "#{a} #{m} (#{obj.send(a).inspect})" }
+      end
+      
+    end
+  end
+end

data/lib/shoulda/private_helpers.rb

@@ -0,0 +1,22 @@
+module ThoughtBot # :nodoc:
+  module Shoulda # :nodoc:
+    module Private # :nodoc:
+      # Returns the values for the entries in the args hash who's keys are listed in the wanted array.
+      # Will raise if there are keys in the args hash that aren't listed.
+      def get_options!(args, *wanted)
+        ret  = []
+        opts = (args.last.is_a?(Hash) ? args.pop : {})
+        wanted.each {|w| ret << opts.delete(w)}
+        raise ArgumentError, "Unsupported options given: #{opts.keys.join(', ')}" unless opts.keys.empty?
+        return *ret
+      end
+
+      # Returns the model class constant, as determined by the test class name.
+      #
+      #   class TestUser; model_class; end => User
+      def model_class
+        self.name.gsub(/Test$/, '').constantize
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'shoulda'

data/shoulda.gemspec

@@ -0,0 +1,109 @@
+Gem::Specification.new do |s|
+  s.name = 'shoulda'
+  s.version = '4.2'
+  s.date = '2008-07-04'
+  
+  s.summary = "Makes tests easy on the fingers and the eyes"
+  s.description = "Shoulda consists of test macros, assertions, and helpers added on to the Test::Unit framework"
+  
+  s.authors = ['Tammer Saleh']
+  s.email = 'tsaleh@thoughtbot.com'
+  s.homepage = 'http://github.com/thoughtbot/shoulda'
+
+  s.has_rdoc = true
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.extra_rdoc_files = ["README.rdoc"]
+
+  s.add_dependency 'rails', ['>= 2.1']
+  
+  s.files = ["CONTRIBUTION_GUIDELINES.rdoc",
+              "MIT-LICENSE",
+              "README.rdoc",
+              "Rakefile",
+              "bin/convert_to_should_syntax",
+              "init.rb",
+              "lib/shoulda/active_record_helpers.rb",
+              "lib/shoulda/color.rb",
+              "lib/shoulda/controller_tests",
+              "lib/shoulda/controller_tests/controller_tests.rb",
+              "lib/shoulda/controller_tests/formats",
+              "lib/shoulda/controller_tests/formats/html.rb",
+              "lib/shoulda/controller_tests/formats/xml.rb",
+              "lib/shoulda/gem/proc_extensions.rb",
+              "lib/shoulda/gem/shoulda.rb",
+              "lib/shoulda/general.rb",
+              "lib/shoulda/private_helpers.rb",
+              "lib/shoulda.rb",
+              "rails/init.rb",
+              "shoulda.gemspec",
+              "tasks/list_tests.rake",
+              "tasks/yaml_to_shoulda.rake"]
+  
+  s.test_files = ["test/fixtures/addresses.yml",
+                   "test/fixtures/posts.yml",
+                   "test/fixtures/taggings.yml",
+                   "test/fixtures/tags.yml",
+                   "test/fixtures/users.yml",
+                   "test/functional/posts_controller_test.rb",
+                   "test/functional/users_controller_test.rb",
+                   "test/other/context_test.rb",
+                   "test/other/helpers_test.rb",
+                   "test/other/private_helpers_test.rb",
+                   "test/rails_root/app/controllers/application.rb",
+                   "test/rails_root/app/controllers/posts_controller.rb",
+                   "test/rails_root/app/controllers/users_controller.rb",
+                   "test/rails_root/app/helpers/application_helper.rb",
+                   "test/rails_root/app/helpers/posts_helper.rb",
+                   "test/rails_root/app/helpers/users_helper.rb",
+                   "test/rails_root/app/models/address.rb",
+                   "test/rails_root/app/models/dog.rb",
+                   "test/rails_root/app/models/flea.rb",
+                   "test/rails_root/app/models/post.rb",
+                   "test/rails_root/app/models/tag.rb",
+                   "test/rails_root/app/models/tagging.rb",
+                   "test/rails_root/app/models/user.rb",
+                   "test/rails_root/app/views/layouts/posts.rhtml",
+                   "test/rails_root/app/views/layouts/users.rhtml",
+                   "test/rails_root/app/views/posts/edit.rhtml",
+                   "test/rails_root/app/views/posts/index.rhtml",
+                   "test/rails_root/app/views/posts/new.rhtml",
+                   "test/rails_root/app/views/posts/show.rhtml",
+                   "test/rails_root/app/views/users/edit.rhtml",
+                   "test/rails_root/app/views/users/index.rhtml",
+                   "test/rails_root/app/views/users/new.rhtml",
+                   "test/rails_root/app/views/users/show.rhtml",
+                   "test/rails_root/config/boot.rb",
+                   "test/rails_root/config/database.yml",
+                   "test/rails_root/config/environment.rb",
+                   "test/rails_root/config/environments/sqlite3.rb",
+                   "test/rails_root/config/initializers/new_rails_defaults.rb",
+                   "test/rails_root/config/routes.rb",
+                   "test/rails_root/db/migrate/001_create_users.rb",
+                   "test/rails_root/db/migrate/002_create_posts.rb",
+                   "test/rails_root/db/migrate/003_create_taggings.rb",
+                   "test/rails_root/db/migrate/004_create_tags.rb",
+                   "test/rails_root/db/migrate/005_create_dogs.rb",
+                   "test/rails_root/db/migrate/006_create_addresses.rb",
+                   "test/rails_root/db/migrate/007_create_fleas.rb",
+                   "test/rails_root/db/migrate/008_create_dogs_fleas.rb",
+                   "test/rails_root/db/migrate/009_add_ssn_to_users.rb",
+                   "test/rails_root/db/schema.rb",
+                   "test/rails_root/log/.keep",
+                   "test/rails_root/public/.htaccess",
+                   "test/rails_root/public/404.html",
+                   "test/rails_root/public/422.html",
+                   "test/rails_root/public/500.html",
+                   "test/rails_root/script/console",
+                   "test/rails_root/script/generate",
+                   "test/rails_root/vendor/plugins/.keep",
+                   "test/README",
+                   "test/test_helper.rb",
+                   "test/unit/address_test.rb",
+                   "test/unit/dog_test.rb",
+                   "test/unit/flea_test.rb",
+                   "test/unit/post_test.rb",
+                   "test/unit/tag_test.rb",
+                   "test/unit/tagging_test.rb",
+                   "test/unit/user_test.rb"]
+
+end

data/tasks/list_tests.rake

@@ -0,0 +1,23 @@
+namespace :shoulda do
+  desc "List the names of the test methods in a specification like format"
+  task :list do
+
+    require 'test/unit'
+    require 'rubygems'
+    require 'active_support'
+
+    # bug in test unit.  Set to true to stop from running.
+    Test::Unit.run = true
+
+    test_files = Dir.glob(File.join('test', '**', '*_test.rb'))
+    test_files.each do |file|
+      load file
+      klass = File.basename(file, '.rb').classify.constantize
+      
+      puts klass.name.gsub('Test', '')
+
+      test_methods = klass.instance_methods.grep(/^test/).map {|s| s.gsub(/^test: /, '')}.sort
+      test_methods.each {|m| puts "  " + m }
+    end
+  end
+end

data/tasks/yaml_to_shoulda.rake

@@ -0,0 +1,28 @@
+namespace :shoulda do
+  # From http://blog.internautdesign.com/2007/11/2/a-yaml_to_shoulda-rake-task
+  # David.Lowenfels@gmail.com
+  desc "Converts a YAML file (FILE=./path/to/yaml) into a Shoulda skeleton" 
+  task :from_yaml do
+    require 'yaml'
+    
+    def yaml_to_context(hash, indent = 0)
+      indent1 = '  ' * indent
+      indent2 = '  ' * (indent + 1)
+      hash.each_pair do |context, shoulds|
+        puts indent1 + "context \"#{context}\" do" 
+        puts    
+        shoulds.each do |should|
+          yaml_to_context( should, indent + 1 ) and next if should.is_a?( Hash )
+          puts indent2 + "should_eventually \"" + should.gsub(/^should +/,'') + "\" do" 
+          puts indent2 + "end" 
+          puts
+        end
+        puts indent1 + "end" 
+      end
+    end 
+    
+    puts("Please pass in a FILE argument.") and exit unless ENV['FILE']
+      
+    yaml_to_context( YAML.load_file( ENV['FILE'] ) )
+  end
+end

data/test/README

@@ -0,0 +1,36 @@
+The Shoulda test suite (in particular - the tests that test shoulda)
+
+Quick overview:
+
+The test directory contains the following files and subdirectories:
+
+* rails_root - contains the stripped down rails application that the tests run against.  The rails root contains:
+** the models, controllers, and views defined under app/
+** the sqlite3.rb environment file
+** a migration file for each model
+* fixtures - contain the sample DB data for each model
+* functional - controller tests for each of the controllers under rails_root/app
+* unit - model tests for each of the models under rails_root/app
+* other - tests for the shoulda contexts, should statements, and assertions
+* test_helper.rb - responsible for initializing the test environment
+** sets the rails_env to sqlite3
+** sets the rails_root
+** creates the rails_root/vendor/plugins/shoulda symlink
+** runs all the migrations against the in-memory sqlite3 db
+** adds some magic to load the right fixture files
+
+In order to add a new model (or controller) to the test suite:
+
+* add that model to rails_root/app/models
+* add a migration for that model
+* add a fixture file
+* add a test for that file under test/units
+
+Dependencies:
+
+* Rails gem installed in the host system
+* A working sqlite3 installation.
+
+If you have problems running these tests, please notify the mailing list:  shoulda@googlegroups.com
+
+- Tammer Saleh <tsaleh@thoughtbot.com>

data/test/fixtures/addresses.yml

@@ -0,0 +1,3 @@
+first:
+  title: Home
+  addressable: first (User)

data/test/fixtures/posts.yml

@@ -0,0 +1,5 @@
+first:
+  id: 1
+  title: My Cute Kitten!
+  body: This is totally a cute kitten
+  user_id: 1

data/test/fixtures/tags.yml

@@ -0,0 +1,9 @@
+first:
+  id: 1
+  name: Stuff
+second:
+  id: 2
+  name: Rails
+third:
+  id: 3
+  name: Nothing

data/test/fixtures/users.yml

@@ -0,0 +1,6 @@
+first:
+  id: 1
+  name: Some dude
+  age: 2
+  email: none@none.com
+  ssn: 123456789

data/test/functional/posts_controller_test.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require 'posts_controller'
+
+# Re-raise errors caught by the controller.
+class PostsController; def rescue_action(e) raise e end; end
+
+class PostsControllerTest < Test::Unit::TestCase
+  load_all_fixtures
+
+  def setup
+    @controller = PostsController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+    @post       = Post.find(:first)
+  end
+
+  context "The public" do
+    setup do
+      @request.session[:logged_in] = false
+    end
+
+    should_be_restful do |resource|
+      resource.parent = :user
+
+      resource.denied.actions = [:index, :show, :edit, :new, :create, :update, :destroy]
+      resource.denied.flash = /what/i
+      resource.denied.redirect = '"/"'
+    end    
+  end
+
+  context "Logged in" do
+    setup do
+      @request.session[:logged_in] = true
+    end
+    
+    should_be_restful do |resource|
+      resource.parent = :user
+
+      resource.create.params = { :title => "first post", :body => 'blah blah blah'}
+      resource.update.params = { :title => "changed" }
+    end
+  end
+end

data/test/functional/users_controller_test.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require 'users_controller'
+
+# Re-raise errors caught by the controller.
+class UsersController; def rescue_action(e) raise e end; end
+
+class UsersControllerTest < Test::Unit::TestCase
+  load_all_fixtures
+
+  def setup
+    @controller = UsersController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+    @user       = User.find(:first)
+  end
+
+  should_be_restful do |resource|
+    resource.identifier = :id
+    resource.klass      = User
+    resource.object     = :user
+    resource.parent     = []
+    resource.actions    = [:index, :show, :new, :edit, :update, :create, :destroy]
+    resource.formats    = [:html, :xml]
+    
+    resource.create.params = { :name => "bob", :email => 'bob@bob.com', :age => 13, :ssn => "123456789"}
+    resource.update.params = { :name => "sue" }
+    
+    resource.create.redirect  = "user_url(@user)"
+    resource.update.redirect  = "user_url(@user)"
+    resource.destroy.redirect = "users_url"
+    
+    resource.create.flash  = /created/i
+    resource.update.flash  = /updated/i
+    resource.destroy.flash = /removed/i    
+  end
+end