tpitale-shoulda 2.11.0

data/lib/shoulda/helpers.rb

@@ -0,0 +1,8 @@
+module Shoulda # :nodoc:
+  module Helpers
+    # Prints a message to stdout, tagged with the name of the calling method.
+    def report!(msg = "")
+      puts("#{caller.first}: #{msg}")
+    end
+  end
+end

data/lib/shoulda/macros.rb

@@ -0,0 +1,133 @@
+require 'shoulda/private_helpers'
+
+module Shoulda # :nodoc:
+  module Macros
+    # Macro that creates a test asserting a change between the return value
+    # of a block that is run before and after the current setup block
+    # is run. This is similar to Active Support's <tt>assert_difference</tt>
+    # assertion, but supports more than just numeric values.  See also
+    # should_not_change.
+    #
+    # The passed description will be used when generating the test name and failure messages.
+    #
+    # Example:
+    #
+    #   context "Creating a post" do
+    #     setup { Post.create }
+    #     should_change("the number of posts", :by => 1) { Post.count }
+    #   end
+    #
+    # As shown in this example, the <tt>:by</tt> option expects a numeric
+    # difference between the before and after values of the expression.  You
+    # may also specify <tt>:from</tt> and <tt>:to</tt> options:
+    #
+    #   should_change("the number of posts", :from => 0, :to => 1) { Post.count }
+    #   should_change("the post title", :from => "old", :to => "new") { @post.title }
+    #
+    # Combinations of <tt>:by</tt>, <tt>:from</tt>, and <tt>:to</tt> are allowed:
+    #
+    #   # Assert the value changed in some way:
+    #   should_change("the post title") { @post.title }
+    #
+    #   # Assert the value changed to anything other than "old:"
+    #   should_change("the post title", :from => "old") { @post.title }
+    #
+    #   # Assert the value changed to "new:"
+    #   should_change("the post title", :to => "new") { @post.title }
+    def should_change(description, options = {}, &block)
+      by, from, to = get_options!([options], :by, :from, :to)
+      stmt = "change #{description}"
+      stmt << " from #{from.inspect}" if from
+      stmt << " to #{to.inspect}" if to
+      stmt << " by #{by.inspect}" if by
+
+      if block_given?
+        code = block
+      else
+        warn "[DEPRECATION] should_change(expression, options) is deprecated. " <<
+             "Use should_change(description, options) { code } instead."
+        code = lambda { eval(description) }
+      end
+      before = lambda { @_before_should_change = code.bind(self).call }
+      should stmt, :before => before do
+        old_value = @_before_should_change
+        new_value = code.bind(self).call
+        assert_operator from, :===, old_value, "#{description} did not originally match #{from.inspect}" if from
+        assert_not_equal old_value, new_value, "#{description} did not change" unless by == 0
+        assert_operator to, :===, new_value, "#{description} was not changed to match #{to.inspect}" if to
+        assert_equal old_value + by, new_value if by
+      end
+    end
+
+    # Macro that creates a test asserting no change between the return value
+    # of a block that is run before and after the current setup block
+    # is run. This is the logical opposite of should_change.
+    #
+    # The passed description will be used when generating the test name and failure message.
+    #
+    # Example:
+    #
+    #   context "Updating a post" do
+    #     setup { @post.update_attributes(:title => "new") }
+    #     should_not_change("the number of posts") { Post.count }
+    #   end
+    def should_not_change(description, &block)
+      if block_given?
+        code = block
+      else
+        warn "[DEPRECATION] should_not_change(expression) is deprecated. " <<
+             "Use should_not_change(description) { code } instead."
+        code = lambda { eval(description) }
+      end
+      before = lambda { @_before_should_not_change = code.bind(self).call }
+      should "not change #{description}", :before => before do
+        new_value = code.bind(self).call
+        assert_equal @_before_should_not_change, new_value, "#{description} changed"
+      end
+    end
+
+    # Macro that creates a test asserting that a record of the given class was
+    # created.
+    #
+    # Example:
+    #
+    #   context "creating a post" do
+    #     setup { Post.create(post_attributes) }
+    #     should_create :post
+    #   end
+    def should_create(class_name)
+      should_change_record_count_of(class_name, 1, 'create')
+    end
+
+    # Macro that creates a test asserting that a record of the given class was
+    # destroyed.
+    #
+    # Example:
+    #
+    #   context "destroying a post" do
+    #     setup { Post.first.destroy }
+    #     should_destroy :post
+    #   end
+    def should_destroy(class_name)
+      should_change_record_count_of(class_name, -1, 'destroy')
+    end
+
+    private
+
+    def should_change_record_count_of(class_name, amount, action) # :nodoc:
+      klass = class_name.to_s.camelize.constantize
+      before = lambda do
+        @_before_change_record_count = klass.count
+      end
+      human_name = class_name.to_s.humanize.downcase
+      should "#{action} a #{human_name}", :before => before do
+        assert_equal @_before_change_record_count + amount,
+                     klass.count,
+                     "Expected to #{action} a #{human_name}"
+      end
+    end
+
+    include Shoulda::Private
+  end
+end
+

data/lib/shoulda/minitest.rb

@@ -0,0 +1,24 @@
+require 'minitest/unit'
+
+require 'shoulda/context'
+require 'shoulda/proc_extensions'
+require 'shoulda/assertions'
+require 'shoulda/macros'
+require 'shoulda/helpers'
+require 'shoulda/autoload_macros'
+require 'shoulda/rails' if defined? RAILS_ROOT
+
+module MiniTest # :nodoc: all
+  class Unit
+    class TestCase
+      include Shoulda::InstanceMethods
+      extend Shoulda::ClassMethods
+      include Shoulda::Assertions
+      extend Shoulda::Macros
+      include Shoulda::Helpers
+
+      alias :assert_not_equal :refute_equal
+    end
+  end
+end
+

data/lib/shoulda/private_helpers.rb

@@ -0,0 +1,13 @@
+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 wanted.size == 1 ? ret.first : ret
+    end
+  end
+end

data/lib/shoulda/proc_extensions.rb

@@ -0,0 +1,14 @@
+# Stolen straight from ActiveSupport
+
+class Proc #:nodoc:
+  def bind(object)
+    block, time = self, Time.now
+    (class << object; self end).class_eval do
+      method_name = "__bind_#{time.to_i}_#{time.usec}"
+      define_method(method_name, &block)
+      method = instance_method(method_name)
+      remove_method(method_name)
+      method
+    end.bind(object)
+  end
+end

data/lib/shoulda/rails.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'active_support'
+require 'shoulda'
+
+require 'shoulda/active_record'     if defined? ActiveRecord::Base
+require 'shoulda/action_controller' if defined? ActionController::Base
+require 'shoulda/action_view'       if defined? ActionView::Base
+require 'shoulda/action_mailer'     if defined? ActionMailer::Base
+
+if defined?(RAILS_ROOT)
+  # load in the 3rd party macros from vendorized plugins and gems
+  Shoulda.autoload_macros RAILS_ROOT, File.join("vendor", "{plugins,gems}", "*")
+end

data/lib/shoulda/rspec.rb

@@ -0,0 +1,11 @@
+require 'shoulda/active_record/matchers'
+require 'shoulda/action_controller/matchers'
+require 'active_support/test_case'
+
+# :enddoc:
+module ActiveSupport
+  class TestCase
+    include Shoulda::ActiveRecord::Matchers
+    include Shoulda::ActionController::Matchers
+  end
+end

data/lib/shoulda/tasks.rb

@@ -0,0 +1,3 @@
+Dir[File.join(File.dirname(__FILE__), 'tasks', '*.rake')].each do |f|
+  load f
+end

data/lib/shoulda/tasks/list_tests.rake

@@ -0,0 +1,29 @@
+namespace :shoulda do
+  desc "List the names of the test methods in a specification like format"
+  task :list do
+    $LOAD_PATH.unshift("test")
+
+    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
+      unless Object.const_defined?(klass.to_s)
+        puts "Skipping #{klass} because it doesn't map to a Class"
+        next
+      end
+      klass = klass.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/lib/shoulda/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/lib/shoulda/test_unit.rb

@@ -0,0 +1,22 @@
+require 'test/unit'
+
+require 'shoulda/context'
+require 'shoulda/proc_extensions'
+require 'shoulda/assertions'
+require 'shoulda/macros'
+require 'shoulda/helpers'
+require 'shoulda/autoload_macros'
+require 'shoulda/rails' if defined? RAILS_ROOT
+
+module Test # :nodoc: all
+  module Unit
+    class TestCase
+      include Shoulda::InstanceMethods
+      extend Shoulda::ClassMethods
+      include Shoulda::Assertions
+      extend Shoulda::Macros
+      include Shoulda::Helpers
+    end
+  end
+end
+

data/rails/init.rb

@@ -0,0 +1,7 @@
+if RAILS_ENV == 'test'
+  if defined? Spec
+    require 'shoulda/rspec'
+  else
+    require 'shoulda/rails' 
+  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 test.rb environment file
+** a migration file for each model
+** a shoulda initializer that simulates loading the plugin but without relying on vendor/plugins
+* 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 test
+** sets the rails_root
+** 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/fail_macros.rb

@@ -0,0 +1,39 @@
+module Shoulda
+  class << self
+    attr_accessor :expected_exceptions
+  end
+
+  module ClassMethods
+    # Enables the core shoulda test suite to test for failure scenarios.  For
+    # example, to ensure that a set of test macros should fail, do this:
+    #
+    #   should_fail do
+    #     should_validate_presence_of :comments
+    #     should_not_allow_mass_assignment_of :name
+    #   end
+    def should_fail(&block)
+      context "should fail when trying to run:" do
+        if defined?(Test::Unit::AssertionFailedError)
+          failures = [Test::Unit::AssertionFailedError]
+        elsif defined?(MiniTest::Assertion)
+          failures = [MiniTest::Assertion]
+        end
+        Shoulda.expected_exceptions = failures
+        yield block
+        Shoulda.expected_exceptions = nil
+      end
+    end
+  end
+
+  class Context
+    # alias_method_chain hack to allow the should_fail macro to work
+    def should_with_failure_scenario(name, options = {}, &block)
+      if Shoulda.expected_exceptions
+        expected_exceptions = Shoulda.expected_exceptions
+        failure_block = lambda { assert_raise(*expected_exceptions, &block.bind(self)) }
+      end
+      should_without_failure_scenario(name, options, &(failure_block || block))
+    end
+    alias_method_chain :should, :failure_scenario
+  end
+end

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