shoulda 2.0.0

data/lib/shoulda/controller/resource_options.rb

@@ -0,0 +1,236 @@
+module ThoughtBot # :nodoc:
+  module Shoulda # :nodoc:
+    module Controller
+      # Formats tested by #should_be_restful.  Defaults to [:html, :xml]
+      VALID_FORMATS = Dir.glob(File.join(File.dirname(__FILE__), 'formats', '*.rb')).map { |f| File.basename(f, '.rb') }.map(&:to_sym) # :doc:
+      VALID_FORMATS.each {|f| require "shoulda/controller/formats/#{f}"}
+
+      # Actions tested by #should_be_restful
+      VALID_ACTIONS = [:index, :show, :new, :edit, :create, :update, :destroy] # :doc:
+
+      # A ResourceOptions object is passed into should_be_restful in order to configure the tests for your controller.
+      #
+      # Example:
+      #   class UsersControllerTest < Test::Unit::TestCase
+      #     fixtures :all
+      #
+      #     def setup
+      #       ...normal setup code...
+      #       @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}
+      #       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
+      #
+      # Whenever possible, the resource attributes will be set to sensible defaults.
+      #
+      class ResourceOptions
+        # Configuration options for the create, update, destroy actions under should_be_restful
+        class ActionOptions
+          # String evaled to get the target of the redirection.
+          # All of the instance variables set by the controller will be available to the
+          # evaled code.
+          #
+          # Example:
+          #   resource.create.redirect  = "user_url(@user.company, @user)"
+          #
+          # Defaults to a generated url based on the name of the controller, the action, and the resource.parents list.
+          attr_accessor :redirect
+
+          # String or Regexp describing a value expected in the flash.  Will match against any flash key.
+          #
+          # Defaults:
+          # destroy:: /removed/
+          # create::  /created/
+          # update::  /updated/
+          attr_accessor :flash
+
+          # Hash describing the params that should be sent in with this action.
+          attr_accessor :params
+        end
+
+        # Configuration options for the denied actions under should_be_restful
+        #
+        # Example:
+        #   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 = /get outta here/i
+        #       resource.denied.redirect = 'new_session_url'
+        #     end
+        #   end
+        #
+        class DeniedOptions
+          # String evaled to get the target of the redirection.
+          # All of the instance variables set by the controller will be available to the
+          # evaled code.
+          #
+          # Example:
+          #   resource.create.redirect  = "user_url(@user.company, @user)"
+          attr_accessor :redirect
+
+          # String or Regexp describing a value expected in the flash.  Will match against any flash key.
+          #
+          # Example:
+          #   resource.create.flash = /created/
+          attr_accessor :flash
+
+          # Actions that should be denied (only used by resource.denied).  <i>Note that these actions will
+          # only be tested if they are also listed in +resource.actions+</i>
+          # The special value of :all will deny all of the REST actions.
+          attr_accessor :actions
+        end
+
+        # Name of key in params that references the primary key.
+        # Will almost always be :id (default), unless you are using a plugin or have patched rails.
+        attr_accessor :identifier
+
+        # Name of the ActiveRecord class this resource is responsible for.  Automatically determined from
+        # test class if not explicitly set.  UserTest => "User"
+        attr_accessor :klass
+
+        # Name of the instantiated ActiveRecord object that should be used by some of the tests.
+        # Defaults to the underscored name of the AR class.  CompanyManager => :company_manager
+        attr_accessor :object
+
+        # Name of the parent AR objects.  Can be set as parent= or parents=, and can take either
+        # the name of the parent resource (if there's only one), or an array of names (if there's
+        # more than one).
+        #
+        # Example:
+        #   # in the routes...
+        #   map.resources :companies do
+        #     map.resources :people do
+        #       map.resources :limbs
+        #     end
+        #   end
+        #
+        #   # in the tests...
+        #   class PeopleControllerTest < Test::Unit::TestCase
+        #     should_be_restful do |resource|
+        #       resource.parent = :companies
+        #     end
+        #   end
+        #
+        #   class LimbsControllerTest < Test::Unit::TestCase
+        #     should_be_restful do |resource|
+        #       resource.parents = [:companies, :people]
+        #     end
+        #   end
+        attr_accessor :parent
+        alias parents parent
+        alias parents= parent=
+
+        # Actions that should be tested.  Must be a subset of VALID_ACTIONS (default).
+        # Tests for each actionw will only be generated if the action is listed here.
+        # The special value of :all will test all of the REST actions.
+        #
+        # Example (for a read-only controller):
+        #   resource.actions = [:show, :index]
+        attr_accessor :actions
+
+        # Formats that should be tested.  Must be a subset of VALID_FORMATS (default).
+        # Each action will be tested against the formats listed here.  The special value
+        # of :all will test all of the supported formats.
+        #
+        # Example:
+        #   resource.actions = [:html, :xml]
+        attr_accessor :formats
+
+        # ActionOptions object specifying options for the create action.
+        attr_accessor :create
+
+        # ActionOptions object specifying options for the update action.
+        attr_accessor :update
+
+        # ActionOptions object specifying options for the desrtoy action.
+        attr_accessor :destroy
+
+        # DeniedOptions object specifying which actions should return deny a request, and what should happen in that case.
+        attr_accessor :denied
+
+        def initialize # :nodoc:
+          @create  = ActionOptions.new
+          @update  = ActionOptions.new
+          @destroy = ActionOptions.new
+          @denied  = DeniedOptions.new
+
+          @create.flash  ||= /created/i
+          @update.flash  ||= /updated/i
+          @destroy.flash ||= /removed/i
+          @denied.flash  ||= /denied/i
+
+          @create.params  ||= {}
+          @update.params  ||= {}
+
+          @actions = VALID_ACTIONS
+          @formats = VALID_FORMATS
+          @denied.actions = []
+        end
+
+        def normalize!(target) # :nodoc:
+          @denied.actions  = VALID_ACTIONS if @denied.actions == :all
+          @actions         = VALID_ACTIONS if @actions        == :all
+          @formats         = VALID_FORMATS if @formats        == :all
+
+          @denied.actions  = @denied.actions.map(&:to_sym)
+          @actions         = @actions.map(&:to_sym)
+          @formats         = @formats.map(&:to_sym)
+
+          ensure_valid_members(@actions,        VALID_ACTIONS, 'actions')
+          ensure_valid_members(@denied.actions, VALID_ACTIONS, 'denied.actions')
+          ensure_valid_members(@formats,        VALID_FORMATS, 'formats')
+
+          @identifier    ||= :id
+          @klass         ||= target.name.gsub(/ControllerTest$/, '').singularize.constantize
+          @object        ||= @klass.name.tableize.singularize
+          @parent        ||= []
+          @parent          = [@parent] unless @parent.is_a? Array
+
+          collection_helper = [@parent, @object.to_s.pluralize, 'url'].flatten.join('_')
+          collection_args   = @parent.map {|n| "@#{object}.#{n}"}.join(', ')
+          @destroy.redirect ||= "#{collection_helper}(#{collection_args})"
+
+          member_helper = [@parent, @object, 'url'].flatten.join('_')
+          member_args   = [@parent.map {|n| "@#{object}.#{n}"}, "@#{object}"].flatten.join(', ')
+          @create.redirect  ||= "#{member_helper}(#{member_args})"
+          @update.redirect  ||= "#{member_helper}(#{member_args})"
+          @denied.redirect  ||= "new_session_url"
+        end
+
+        private
+
+        def ensure_valid_members(ary, valid_members, name)  # :nodoc:
+          invalid = ary - valid_members
+          raise ArgumentError, "Unsupported #{name}: #{invalid.inspect}" unless invalid.empty?
+        end
+      end
+    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.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,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