@@ -1,7 +1,7 @@ = Rack::Test -- http://gitrdoc.com/brynary/rack-test -- http://github.com/brynary/rack-test +- Code: http://github.com/brynary/rack-test +- Build: http://runcoderun.com/brynary/rack-test == Description @@ -20,23 +20,23 @@ request helpers feature. == Example require "rack/test" - + class HomepageTest < Test::Unit::TestCase include Rack::Test::Methods - + def app MyApp.new end - + def test_redirect_logged_in_users_to_dashboard authorize "bryan", "secret" get "/" follow_redirect! - + assert_equal "http://example.org/redirected", last_request.url assert last_response.ok? end - + end == Install README.rdoc @@ -1,6 +1,6 @@ module Rack - class MockSession + class MockSession # :nodoc: attr_writer :cookie_jar attr_reader :default_host lib/rack/mock_session.rb @@ -17,13 +17,22 @@ module Rack # The common base class for exceptions raised by Rack::Test class Error < StandardError; end + # This class represents a series of requests issued to a Rack app, sharing + # a single cookie jar + # + # Rack::Test::Session's methods are most often called through Rack::Test::Methods, + # which will automatically build a session when it's first used. class Session extend Forwardable include Rack::Test::Utils def_delegators :@rack_mock_session, :clear_cookies, :set_cookie, :last_response, :last_request - # Initialize a new session for the given Rack app + # Creates a Rack::Test::Session for a given Rack app or Rack::MockSession. + # + # Note: Generally, you won't need to initialize a Rack::Test::Session directly. + # Instead, you should include Rack::Test::Methods into your testing context. + # (See README.rdoc for an example) def initialize(mock_session) @headers = {} @@ -99,6 +108,9 @@ module Rack # Set a header to be included on all subsequent requests through the # session. Use a value of nil to remove a previously configured header. # + # In accordance with the Rack spec, headers will be included in the Rack + # environment hash in HTTP_USER_AGENT form. + # # Example: # header "User-Agent", "Firefox" def header(name, value) @@ -121,6 +133,11 @@ module Rack alias_method :authorize, :basic_authorize + # Set the username and password for HTTP Digest authorization, to be + # included in subsequent requests in the HTTP_AUTHORIZATION header. + # + # Example: + # digest_authorize "bryan", "secret" def digest_authorize(username, password) @digest_username = username @digest_password = password lib/rack/test.rb @@ -1,8 +1,9 @@ require "uri" + module Rack module Test - class Cookie + class Cookie # :nodoc: include Rack::Utils # :api: private @@ -93,7 +94,7 @@ module Rack end - class CookieJar + class CookieJar # :nodoc: # :api: private def initialize(cookies = [], default_host = DEFAULT_HOST) lib/rack/test/cookie_jar.rb @@ -2,67 +2,74 @@ require "forwardable" module Rack module Test + + # This module serves as the primary integration point for using Rack::Test + # in a testing environment. It depends on an app method being defined in the + # same context, and provides the Rack::Test API methods (see Rack::Test::Session + # for their documentation). + # + # Example: + # + # class HomepageTest < Test::Unit::TestCase + # include Rack::Test::Methods + # + # def app + # MyApp.new + # end + # end module Methods extend Forwardable - def rack_mock_session(name = :default) + def rack_mock_session(name = :default) # :nodoc: return build_rack_mock_session unless name @_rack_mock_sessions ||= {} @_rack_mock_sessions[name] ||= build_rack_mock_session end - def build_rack_mock_session + def build_rack_mock_session # :nodoc: Rack::MockSession.new(app) end - def rack_test_session(name = :default) + def rack_test_session(name = :default) # :nodoc: return build_rack_test_session(name) unless name @_rack_test_sessions ||= {} @_rack_test_sessions[name] ||= build_rack_test_session(name) end - def build_rack_test_session(name) + def build_rack_test_session(name) # :nodoc: Rack::Test::Session.new(rack_mock_session(name)) end - def current_session + def current_session # :nodoc: rack_test_session(_current_session_names.last) end - def with_session(name) + def with_session(name) # :nodoc: _current_session_names.push(name) yield rack_test_session(name) _current_session_names.pop end - def _current_session_names + def _current_session_names # :nodoc: @_current_session_names ||= [:default] end METHODS = [ :request, - - # HTTP verbs :get, :post, :put, :delete, :head, - - # Redirects :follow_redirect!, - - # Header-related features :header, :set_cookie, :clear_cookies, :authorize, :basic_authorize, :digest_authorize, - - # Expose the last request and response :last_response, :last_request ] lib/rack/test/methods.rb @@ -1,7 +1,8 @@ module Rack module Test - class MockDigestRequest + class MockDigestRequest # :nodoc: + def initialize(params) @params = params end @@ -21,6 +22,7 @@ module Rack def response(password) Rack::Auth::Digest::MD5.new(nil).send :digest, self, password end + end end lib/rack/test/mock_digest_request.rb @@ -3,7 +3,13 @@ require "tempfile" module Rack module Test + # Wraps a Tempfile with a content type. Including one or more UploadedFile's + # in the params causes Rack::Test to build and issue a multipart request. + # + # Example: + # post "/photos", "file" => Rack::Test::UploadedFile.new("me.jpg", "image/jpeg") class UploadedFile + # The filename, *not* including the path, of the "uploaded" file attr_reader :original_filename @@ -12,11 +18,14 @@ module Rack def initialize(path, content_type = "text/plain", binary = false) raise "#{path} file does not exist" unless ::File.exist?(path) + @content_type = content_type @original_filename = ::File.basename(path) + @tempfile = Tempfile.new(@original_filename) @tempfile.set_encoding(Encoding::BINARY) if @tempfile.respond_to?(:set_encoding) @tempfile.binmode if binary + FileUtils.copy_file(path, @tempfile.path) end lib/rack/test/uploaded_file.rb @@ -1,7 +1,7 @@ module Rack module Test - module Utils + module Utils # :nodoc: include Rack::Utils def build_nested_query(value, prefix = nil) lib/rack/test/utils.rb 4ac6d8e7915c279fd3093aad961e3b0be5fb5a43 Bryan Helmkamp bryan@brynary.com http://github.com/brynary/rack-test/commit/c39c4736f3f7743da14c1c66591848141b17288a c39c4736f3f7743da14c1c66591848141b17288a 2009-09-19T14:07:05-07:00 2009-09-19T14:07:05-07:00 Docs 9a4f836fc8ccda9b33cd7937a7ac2ebc73c2f414 Bryan Helmkamp bryan@brynary.com