technicalpickles-shoulda 2.0.0

data/lib/shoulda/controller/routing.rb

@@ -0,0 +1,10 @@
+require 'shoulda'
+require 'shoulda/controller/routing/macros'
+
+module Test # :nodoc: all
+  module Unit
+    class TestCase
+      extend ThoughtBot::Shoulda::Controller::Routing::Macros
+    end
+  end
+end

data/lib/shoulda/controller.rb

@@ -0,0 +1,31 @@
+require 'shoulda'
+require 'shoulda/controller/helpers'
+require 'shoulda/controller/resource_options'
+require 'shoulda/controller/macros'
+require 'shoulda/controller/routing'
+
+module Test # :nodoc: all
+  module Unit
+    class TestCase
+      extend ThoughtBot::Shoulda::Controller::Macros
+      include ThoughtBot::Shoulda::Controller::Helpers
+      ThoughtBot::Shoulda::Controller::VALID_FORMATS.each do |format|
+        include "ThoughtBot::Shoulda::Controller::#{format.to_s.upcase}".constantize
+      end
+    end
+  end
+end
+
+require 'shoulda/active_record/assertions'
+require 'shoulda/action_mailer/assertions'
+
+module ActionController #:nodoc: all
+  module Integration
+    class Session
+      include ThoughtBot::Shoulda::Assertions
+      include ThoughtBot::Shoulda::Helpers
+      include ThoughtBot::Shoulda::ActiveRecord::Assertions
+      include ThoughtBot::Shoulda::ActionMailer::Assertions
+    end
+  end
+end

data/lib/shoulda/helpers.rb

@@ -0,0 +1,10 @@
+module ThoughtBot # :nodoc:
+  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
+end

data/lib/shoulda/macros.rb

@@ -0,0 +1,80 @@
+require 'shoulda/private_helpers'
+
+module ThoughtBot # :nodoc:
+  module Shoulda # :nodoc:
+    module Macros
+      # Macro that creates a test asserting a change between the return value
+      # of an expression 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.
+      #
+      # Example:
+      #
+      #   context "Creating a post"
+      #     setup do
+      #       Post.create
+      #     end
+      #
+      #     should_change "Post.count", :by => 1
+      #   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 "Post.count", :from => 0, :to => 1
+      #   should_change "@post.title", :from => "old", :to => "new"
+      #
+      # Combinations of <tt>:by</tt>, <tt>:from</tt>, and <tt>:to</tt> are allowed:
+      #
+      #   should_change "@post.title"                # => assert the value changed in some way
+      #   should_change "@post.title" :from => "old" # => assert the value changed to anything other than "old"
+      #   should_change "@post.title" :to   => "new" # => assert the value changed from anything other than "new"
+      def should_change(expression, options = {})
+        by, from, to = get_options!([options], :by, :from, :to)
+        stmt = "change #{expression.inspect}"
+        stmt << " from #{from.inspect}" if from
+        stmt << " to #{to.inspect}" if to
+        stmt << " by #{by.inspect}" if by
+
+        expression_eval = lambda { eval(expression) }
+        before = lambda { @_before_should_change = expression_eval.bind(self).call }
+        should stmt, :before => before do
+          old_value = @_before_should_change
+          new_value = expression_eval.bind(self).call
+          assert_operator from, :===, old_value, "#{expression.inspect} did not originally match #{from.inspect}" if from
+          assert_not_equal old_value, new_value, "#{expression.inspect} did not change" unless by == 0
+          assert_operator to, :===, new_value, "#{expression.inspect} 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 an expression that is run before and after the current setup block
+      # is run. This is the logical opposite of should_change.
+      #
+      # Example:
+      #
+      #   context "Updating a post"
+      #     setup do
+      #       @post.update_attributes(:title => "new")
+      #     end
+      #
+      #     should_not_change "Post.count"
+      #   end
+      def should_not_change(expression)
+        expression_eval = lambda { eval(expression) }
+        before = lambda { @_before_should_not_change = expression_eval.bind(self).call }
+        should "not change #{expression.inspect}", :before => before do
+          new_value = expression_eval.bind(self).call
+          assert_equal @_before_should_not_change, new_value, "#{expression.inspect} changed"
+        end
+      end
+
+      private
+
+      include ThoughtBot::Shoulda::Private
+    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/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,19 @@
+require 'rubygems'
+require 'active_support'
+require 'shoulda'
+
+require 'shoulda/active_record' if defined? ActiveRecord::Base
+require 'shoulda/controller'    if defined? ActionController::Base
+require 'shoulda/action_mailer' if defined? ActionMailer::Base
+
+if defined?(RAILS_ROOT)
+  # load in the 3rd party macros from vendorized plugins and gems
+  Dir[File.join(RAILS_ROOT, "vendor", "{plugins,gems}", "*", "shoulda_macros", "*.rb")].each do |macro_file_path|
+    require macro_file_path
+  end
+
+  # load in the local application specific macros
+  Dir[File.join(RAILS_ROOT, "test", "shoulda_macros", "*.rb")].each do |macro_file_path|
+    require macro_file_path
+  end
+end

data/lib/shoulda/tasks/list_tests.rake

@@ -0,0 +1,24 @@
+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.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/tasks.rb

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

data/lib/shoulda.rb

@@ -0,0 +1,16 @@
+require 'shoulda/context'
+require 'shoulda/proc_extensions'
+require 'shoulda/assertions'
+require 'shoulda/macros'
+require 'shoulda/helpers'
+
+module Test # :nodoc: all
+  module Unit
+    class TestCase
+      extend Thoughtbot::Shoulda
+      include ThoughtBot::Shoulda::Assertions
+      extend ThoughtBot::Shoulda::Macros
+      include ThoughtBot::Shoulda::Helpers
+    end
+  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
+** 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 sqlite3
+** 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/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,72 @@
+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
+  fixtures :all
+
+  def setup
+    @controller = PostsController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+    @post       = Post.find(:first)
+  end
+  
+  # autodetects the :controller
+  should_route :get,    '/posts',     :action => :index
+  # explicitly specify :controller
+  should_route :post,   '/posts',     :controller => :posts, :action => :create
+  # non-string parameter
+  should_route :get,    '/posts/1',   :action => :show, :id => 1
+  # string-parameter
+  should_route :put,    '/posts/1',   :action => :update, :id => "1"
+  should_route :delete, '/posts/1',   :action => :destroy, :id => 1
+  should_route :get,    '/posts/new', :action => :new
+  
+  # Test the nested routes
+  should_route :get,    '/users/5/posts',     :action => :index, :user_id => 5
+  should_route :post,   '/users/5/posts',     :action => :create, :user_id => 5
+  should_route :get,    '/users/5/posts/1',   :action => :show, :id => 1, :user_id => 5
+  should_route :delete, '/users/5/posts/1',   :action => :destroy, :id => 1, :user_id => 5
+  should_route :get,    '/users/5/posts/new', :action => :new, :user_id => 5
+  should_route :put,    '/users/5/posts/1',   :action => :update, :id => 1, :user_id => 5
+
+  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
+
+    context "viewing posts for a user" do
+      setup do
+        get :index, :user_id => users(:first)
+      end
+      should_respond_with :success
+      should_assign_to :user, :posts
+      should_not_assign_to :foo, :bar
+    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
+  fixtures :all
+
+  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

data/test/other/context_test.rb

@@ -0,0 +1,145 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class ContextTest < Test::Unit::TestCase # :nodoc:
+  
+  def self.context_macro(&blk)
+    context "with a subcontext made by a macro" do
+      setup { @context_macro = :foo }
+
+      merge_block &blk 
+    end
+  end
+
+  # def self.context_macro(&blk)
+  #   context "with a subcontext made by a macro" do
+  #     setup { @context_macro = :foo }
+  #     yield # <- this doesn't work.
+  #   end
+  # end
+
+  context "context with setup block" do
+    setup do
+      @blah = "blah"
+    end
+    
+    should "run the setup block" do
+      assert_equal "blah", @blah
+    end
+    
+    should "have name set right" do
+      assert_match(/^test: context with setup block/, self.to_s)
+    end
+
+    context "and a subcontext" do
+      setup do
+        @blah = "#{@blah} twice"
+      end
+      
+      should "be named correctly" do
+        assert_match(/^test: context with setup block and a subcontext should be named correctly/, self.to_s)
+      end
+      
+      should "run the setup blocks in order" do
+        assert_equal @blah, "blah twice"
+      end
+    end
+
+    context_macro do
+      should "have name set right" do
+        assert_match(/^test: context with setup block with a subcontext made by a macro should have name set right/, self.to_s)
+      end
+
+      should "run the setup block of that context macro" do
+        assert_equal :foo, @context_macro
+      end
+
+      should "run the setup block of the main context" do
+        assert_equal "blah", @blah
+      end
+    end
+
+  end
+
+  context "another context with setup block" do
+    setup do
+      @blah = "foo"
+    end
+    
+    should "have @blah == 'foo'" do
+      assert_equal "foo", @blah
+    end
+
+    should "have name set right" do
+      assert_match(/^test: another context with setup block/, self.to_s)
+    end
+  end
+  
+  context "context with method definition" do
+    setup do
+      def hello; "hi"; end
+    end
+    
+    should "be able to read that method" do
+      assert_equal "hi", hello
+    end
+
+    should "have name set right" do
+      assert_match(/^test: context with method definition/, self.to_s)
+    end
+  end
+  
+  context "another context" do
+    should "not define @blah" do
+      assert_nil @blah
+    end
+  end
+    
+  context "context with multiple setups and/or teardowns" do
+    
+    cleanup_count = 0
+        
+    2.times do |i|
+      setup { cleanup_count += 1 }
+      teardown { cleanup_count -= 1 }
+    end
+    
+    2.times do |i|
+      should "call all setups and all teardowns (check ##{i + 1})" do
+        assert_equal 2, cleanup_count
+      end
+    end
+    
+    context "subcontexts" do
+      
+      2.times do |i|
+        setup { cleanup_count += 1 }
+        teardown { cleanup_count -= 1 }
+      end
+                  
+      2.times do |i|
+        should "also call all setups and all teardowns in parent and subcontext (check ##{i + 1})" do
+          assert_equal 4, cleanup_count
+        end
+      end
+      
+    end
+    
+  end
+  
+  should_eventually "pass, since it's unimplemented" do
+    flunk "what?"
+  end
+
+  should_eventually "not require a block when using should_eventually"
+  should "pass without a block, as that causes it to piggyback to should_eventually"
+  
+  context "context for testing should piggybacking" do
+    should "call should_eventually as we are not passing a block"
+  end
+
+  context "context" do
+    context "with nested subcontexts" do
+      should_eventually "only print this statement once for a should_eventually"
+    end
+  end
+end

data/test/other/convert_to_should_syntax_test.rb

@@ -0,0 +1,63 @@
+require 'test/unit'
+
+class ConvertToShouldSyntaxTest < Test::Unit::TestCase # :nodoc:
+
+  BEFORE_FIXTURE = <<-EOS
+    class DummyTest < Test::Unit::TestCase
+
+      should "Not change this_word_with_underscores" do
+      end
+
+      def test_should_be_working
+        assert true
+      end
+
+      def test_some_cool_stuff
+        assert true
+      end
+
+      def non_test_method
+      end
+
+    end
+  EOS
+
+  AFTER_FIXTURE = <<-EOS
+    class DummyTest < Test::Unit::TestCase
+
+      should "Not change this_word_with_underscores" do
+      end
+
+      should "be working" do
+        assert true
+      end
+
+      should "RENAME ME: test some cool stuff" do
+        assert true
+      end
+
+      def non_test_method
+      end
+
+    end
+  EOS
+  
+  FIXTURE_PATH = "./convert_to_should_syntax_fixture.dat"
+
+  RUBY = ENV['RUBY'] || 'ruby'
+
+  def test_convert_to_should_syntax
+    File.open(FIXTURE_PATH, "w") {|f| f.write(BEFORE_FIXTURE)}
+    cmd = "#{RUBY} #{File.join(File.dirname(__FILE__), '../../bin/convert_to_should_syntax')} #{FIXTURE_PATH}"
+    output = `#{cmd}`
+    File.unlink($1) if output.match(/has been stored in '([^']+)/)
+    assert_match(/has been converted/, output)
+    result = IO.read(FIXTURE_PATH)
+    assert_equal result, AFTER_FIXTURE
+  end
+
+  def teardown
+    File.unlink(FIXTURE_PATH)
+  end
+
+end