actionpack 2.2.3 → 2.3.2

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of actionpack might be problematic. Click here for more details.

Files changed (264) hide show
  1. data/CHANGELOG +433 -375
  2. data/MIT-LICENSE +1 -1
  3. data/README +21 -75
  4. data/Rakefile +1 -1
  5. data/lib/action_controller.rb +80 -43
  6. data/lib/action_controller/assertions/model_assertions.rb +1 -0
  7. data/lib/action_controller/assertions/response_assertions.rb +43 -16
  8. data/lib/action_controller/assertions/routing_assertions.rb +1 -1
  9. data/lib/action_controller/assertions/selector_assertions.rb +17 -12
  10. data/lib/action_controller/assertions/tag_assertions.rb +1 -4
  11. data/lib/action_controller/base.rb +153 -82
  12. data/lib/action_controller/benchmarking.rb +9 -9
  13. data/lib/action_controller/caching.rb +9 -11
  14. data/lib/action_controller/caching/actions.rb +11 -18
  15. data/lib/action_controller/caching/fragments.rb +28 -20
  16. data/lib/action_controller/caching/pages.rb +13 -15
  17. data/lib/action_controller/caching/sweeping.rb +2 -2
  18. data/lib/action_controller/cgi_ext.rb +0 -1
  19. data/lib/action_controller/cgi_ext/cookie.rb +2 -0
  20. data/lib/action_controller/cgi_process.rb +54 -162
  21. data/lib/action_controller/cookies.rb +13 -25
  22. data/lib/action_controller/dispatcher.rb +43 -122
  23. data/lib/action_controller/failsafe.rb +52 -0
  24. data/lib/action_controller/flash.rb +38 -47
  25. data/lib/action_controller/helpers.rb +13 -9
  26. data/lib/action_controller/http_authentication.rb +203 -23
  27. data/lib/action_controller/integration.rb +126 -70
  28. data/lib/action_controller/layout.rb +36 -39
  29. data/lib/action_controller/middleware_stack.rb +119 -0
  30. data/lib/action_controller/middlewares.rb +13 -0
  31. data/lib/action_controller/mime_responds.rb +19 -4
  32. data/lib/action_controller/mime_type.rb +8 -0
  33. data/lib/action_controller/params_parser.rb +71 -0
  34. data/lib/action_controller/performance_test.rb +0 -1
  35. data/lib/action_controller/polymorphic_routes.rb +36 -30
  36. data/lib/action_controller/reloader.rb +14 -0
  37. data/lib/action_controller/request.rb +107 -499
  38. data/lib/action_controller/request_forgery_protection.rb +7 -39
  39. data/lib/action_controller/rescue.rb +55 -35
  40. data/lib/action_controller/resources.rb +34 -31
  41. data/lib/action_controller/response.rb +99 -57
  42. data/lib/action_controller/rewindable_input.rb +28 -0
  43. data/lib/action_controller/routing.rb +7 -7
  44. data/lib/action_controller/routing/builder.rb +4 -1
  45. data/lib/action_controller/routing/optimisations.rb +1 -1
  46. data/lib/action_controller/routing/recognition_optimisation.rb +1 -2
  47. data/lib/action_controller/routing/route.rb +15 -5
  48. data/lib/action_controller/routing/route_set.rb +82 -35
  49. data/lib/action_controller/routing/segments.rb +35 -0
  50. data/lib/action_controller/session/abstract_store.rb +181 -0
  51. data/lib/action_controller/session/cookie_store.rb +197 -175
  52. data/lib/action_controller/session/mem_cache_store.rb +36 -83
  53. data/lib/action_controller/session_management.rb +26 -134
  54. data/lib/action_controller/streaming.rb +24 -7
  55. data/lib/action_controller/templates/rescues/diagnostics.erb +2 -2
  56. data/lib/action_controller/templates/rescues/template_error.erb +2 -2
  57. data/lib/action_controller/test_case.rb +87 -30
  58. data/lib/action_controller/test_process.rb +145 -104
  59. data/lib/action_controller/uploaded_file.rb +44 -0
  60. data/lib/action_controller/url_rewriter.rb +3 -6
  61. data/lib/action_controller/vendor/html-scanner.rb +16 -0
  62. data/lib/action_controller/vendor/html-scanner/html/selector.rb +1 -1
  63. data/lib/action_controller/vendor/rack-1.0/rack.rb +89 -0
  64. data/lib/action_controller/vendor/rack-1.0/rack/adapter/camping.rb +22 -0
  65. data/lib/action_controller/vendor/rack-1.0/rack/auth/abstract/handler.rb +37 -0
  66. data/lib/action_controller/vendor/rack-1.0/rack/auth/abstract/request.rb +37 -0
  67. data/lib/action_controller/vendor/rack-1.0/rack/auth/basic.rb +58 -0
  68. data/lib/action_controller/vendor/rack-1.0/rack/auth/digest/md5.rb +124 -0
  69. data/lib/action_controller/vendor/rack-1.0/rack/auth/digest/nonce.rb +51 -0
  70. data/lib/action_controller/vendor/rack-1.0/rack/auth/digest/params.rb +55 -0
  71. data/lib/action_controller/vendor/rack-1.0/rack/auth/digest/request.rb +40 -0
  72. data/lib/action_controller/vendor/rack-1.0/rack/auth/openid.rb +480 -0
  73. data/lib/action_controller/vendor/rack-1.0/rack/builder.rb +63 -0
  74. data/lib/action_controller/vendor/rack-1.0/rack/cascade.rb +36 -0
  75. data/lib/action_controller/vendor/rack-1.0/rack/chunked.rb +49 -0
  76. data/lib/action_controller/vendor/rack-1.0/rack/commonlogger.rb +61 -0
  77. data/lib/action_controller/vendor/rack-1.0/rack/conditionalget.rb +45 -0
  78. data/lib/action_controller/vendor/rack-1.0/rack/content_length.rb +29 -0
  79. data/lib/action_controller/vendor/rack-1.0/rack/content_type.rb +23 -0
  80. data/lib/action_controller/vendor/rack-1.0/rack/deflater.rb +85 -0
  81. data/lib/action_controller/vendor/rack-1.0/rack/directory.rb +153 -0
  82. data/lib/action_controller/vendor/rack-1.0/rack/file.rb +88 -0
  83. data/lib/action_controller/vendor/rack-1.0/rack/handler.rb +48 -0
  84. data/lib/action_controller/vendor/rack-1.0/rack/handler/cgi.rb +61 -0
  85. data/lib/action_controller/vendor/rack-1.0/rack/handler/evented_mongrel.rb +8 -0
  86. data/lib/action_controller/vendor/rack-1.0/rack/handler/fastcgi.rb +89 -0
  87. data/lib/action_controller/vendor/rack-1.0/rack/handler/lsws.rb +55 -0
  88. data/lib/action_controller/vendor/rack-1.0/rack/handler/mongrel.rb +84 -0
  89. data/lib/action_controller/vendor/rack-1.0/rack/handler/scgi.rb +59 -0
  90. data/lib/action_controller/vendor/rack-1.0/rack/handler/swiftiplied_mongrel.rb +8 -0
  91. data/lib/action_controller/vendor/rack-1.0/rack/handler/thin.rb +18 -0
  92. data/lib/action_controller/vendor/rack-1.0/rack/handler/webrick.rb +67 -0
  93. data/lib/action_controller/vendor/rack-1.0/rack/head.rb +19 -0
  94. data/lib/action_controller/vendor/rack-1.0/rack/lint.rb +462 -0
  95. data/lib/action_controller/vendor/rack-1.0/rack/lobster.rb +65 -0
  96. data/lib/action_controller/vendor/rack-1.0/rack/lock.rb +16 -0
  97. data/lib/action_controller/vendor/rack-1.0/rack/methodoverride.rb +27 -0
  98. data/lib/action_controller/vendor/rack-1.0/rack/mime.rb +204 -0
  99. data/lib/action_controller/vendor/rack-1.0/rack/mock.rb +160 -0
  100. data/lib/action_controller/vendor/rack-1.0/rack/recursive.rb +57 -0
  101. data/lib/action_controller/vendor/rack-1.0/rack/reloader.rb +64 -0
  102. data/lib/action_controller/vendor/rack-1.0/rack/request.rb +241 -0
  103. data/lib/action_controller/vendor/rack-1.0/rack/response.rb +179 -0
  104. data/lib/action_controller/vendor/rack-1.0/rack/session/abstract/id.rb +142 -0
  105. data/lib/action_controller/vendor/rack-1.0/rack/session/cookie.rb +91 -0
  106. data/lib/action_controller/vendor/rack-1.0/rack/session/memcache.rb +109 -0
  107. data/lib/action_controller/vendor/rack-1.0/rack/session/pool.rb +100 -0
  108. data/lib/action_controller/vendor/rack-1.0/rack/showexceptions.rb +349 -0
  109. data/lib/action_controller/vendor/rack-1.0/rack/showstatus.rb +106 -0
  110. data/lib/action_controller/vendor/rack-1.0/rack/static.rb +38 -0
  111. data/lib/action_controller/vendor/rack-1.0/rack/urlmap.rb +55 -0
  112. data/lib/action_controller/vendor/rack-1.0/rack/utils.rb +392 -0
  113. data/lib/action_controller/verification.rb +1 -1
  114. data/lib/action_pack.rb +1 -1
  115. data/lib/action_pack/version.rb +2 -2
  116. data/lib/action_view.rb +22 -17
  117. data/lib/action_view/base.rb +53 -79
  118. data/lib/action_view/erb/util.rb +38 -0
  119. data/lib/action_view/helpers.rb +24 -5
  120. data/lib/action_view/helpers/active_record_helper.rb +2 -2
  121. data/lib/action_view/helpers/asset_tag_helper.rb +81 -50
  122. data/lib/action_view/helpers/atom_feed_helper.rb +1 -1
  123. data/lib/action_view/helpers/benchmark_helper.rb +26 -5
  124. data/lib/action_view/helpers/date_helper.rb +82 -7
  125. data/lib/action_view/helpers/form_helper.rb +295 -64
  126. data/lib/action_view/helpers/form_options_helper.rb +160 -18
  127. data/lib/action_view/helpers/form_tag_helper.rb +2 -2
  128. data/lib/action_view/helpers/number_helper.rb +31 -18
  129. data/lib/action_view/helpers/prototype_helper.rb +2 -12
  130. data/lib/action_view/helpers/sanitize_helper.rb +0 -10
  131. data/lib/action_view/helpers/scriptaculous_helper.rb +1 -0
  132. data/lib/action_view/helpers/tag_helper.rb +3 -4
  133. data/lib/action_view/helpers/text_helper.rb +99 -122
  134. data/lib/action_view/helpers/translation_helper.rb +19 -1
  135. data/lib/action_view/helpers/url_helper.rb +25 -2
  136. data/lib/action_view/inline_template.rb +1 -1
  137. data/lib/action_view/locale/en.yml +19 -1
  138. data/lib/action_view/partials.rb +46 -9
  139. data/lib/action_view/paths.rb +28 -84
  140. data/lib/action_view/reloadable_template.rb +117 -0
  141. data/lib/action_view/renderable.rb +28 -35
  142. data/lib/action_view/renderable_partial.rb +3 -4
  143. data/lib/action_view/template.rb +172 -31
  144. data/lib/action_view/template_error.rb +8 -9
  145. data/lib/action_view/template_handler.rb +1 -1
  146. data/lib/action_view/template_handlers.rb +9 -6
  147. data/lib/action_view/template_handlers/erb.rb +2 -39
  148. data/lib/action_view/template_handlers/rjs.rb +1 -0
  149. data/lib/action_view/test_case.rb +27 -1
  150. data/test/abstract_unit.rb +23 -17
  151. data/test/active_record_unit.rb +5 -4
  152. data/test/activerecord/active_record_store_test.rb +139 -106
  153. data/test/activerecord/render_partial_with_record_identification_test.rb +5 -21
  154. data/test/controller/action_pack_assertions_test.rb +25 -23
  155. data/test/controller/addresses_render_test.rb +3 -6
  156. data/test/controller/assert_select_test.rb +83 -70
  157. data/test/controller/base_test.rb +11 -13
  158. data/test/controller/benchmark_test.rb +3 -3
  159. data/test/controller/caching_test.rb +34 -24
  160. data/test/controller/capture_test.rb +3 -6
  161. data/test/controller/content_type_test.rb +3 -6
  162. data/test/controller/cookie_test.rb +31 -66
  163. data/test/controller/deprecation/deprecated_base_methods_test.rb +9 -11
  164. data/test/controller/dispatcher_test.rb +23 -28
  165. data/test/controller/fake_models.rb +8 -0
  166. data/test/controller/filters_test.rb +6 -2
  167. data/test/controller/flash_test.rb +2 -6
  168. data/test/controller/helper_test.rb +15 -1
  169. data/test/controller/html-scanner/document_test.rb +1 -1
  170. data/test/controller/html-scanner/sanitizer_test.rb +1 -1
  171. data/test/controller/http_basic_authentication_test.rb +88 -0
  172. data/test/controller/http_digest_authentication_test.rb +178 -0
  173. data/test/controller/integration_test.rb +56 -52
  174. data/test/controller/layout_test.rb +46 -44
  175. data/test/controller/middleware_stack_test.rb +90 -0
  176. data/test/controller/mime_responds_test.rb +7 -11
  177. data/test/controller/mime_type_test.rb +9 -0
  178. data/test/controller/polymorphic_routes_test.rb +235 -151
  179. data/test/controller/rack_test.rb +52 -81
  180. data/test/controller/redirect_test.rb +6 -14
  181. data/test/controller/render_test.rb +273 -60
  182. data/test/controller/request/json_params_parsing_test.rb +45 -0
  183. data/test/controller/request/multipart_params_parsing_test.rb +223 -0
  184. data/test/controller/request/query_string_parsing_test.rb +120 -0
  185. data/test/controller/request/url_encoded_params_parsing_test.rb +184 -0
  186. data/test/controller/request/xml_params_parsing_test.rb +88 -0
  187. data/test/controller/request_forgery_protection_test.rb +17 -98
  188. data/test/controller/request_test.rb +45 -530
  189. data/test/controller/rescue_test.rb +45 -22
  190. data/test/controller/resources_test.rb +112 -37
  191. data/test/controller/routing_test.rb +1442 -1384
  192. data/test/controller/selector_test.rb +3 -3
  193. data/test/controller/send_file_test.rb +30 -3
  194. data/test/controller/session/cookie_store_test.rb +169 -240
  195. data/test/controller/session/mem_cache_store_test.rb +94 -148
  196. data/test/controller/session/test_session_test.rb +58 -0
  197. data/test/controller/test_test.rb +32 -13
  198. data/test/controller/url_rewriter_test.rb +54 -4
  199. data/test/controller/verification_test.rb +1 -1
  200. data/test/controller/view_paths_test.rb +15 -15
  201. data/test/controller/webservice_test.rb +178 -147
  202. data/test/fixtures/alternate_helpers/foo_helper.rb +3 -0
  203. data/test/fixtures/layout_tests/alt/layouts/alt.rhtml +0 -0
  204. data/test/fixtures/layouts/default_html.html.erb +1 -0
  205. data/test/fixtures/layouts/xhr.html.erb +2 -0
  206. data/test/fixtures/multipart/empty +10 -0
  207. data/test/fixtures/multipart/hello.txt +1 -0
  208. data/test/fixtures/multipart/none +9 -0
  209. data/test/fixtures/public/500.da.html +1 -0
  210. data/test/fixtures/quiz/questions/_question.html.erb +1 -0
  211. data/test/fixtures/replies.yml +1 -1
  212. data/test/fixtures/test/_one.html.erb +1 -0
  213. data/test/fixtures/test/_two.html.erb +1 -0
  214. data/test/fixtures/test/dont_pick_me +1 -0
  215. data/test/fixtures/test/hello.builder +1 -1
  216. data/test/fixtures/test/hello_world.da.html.erb +1 -0
  217. data/test/fixtures/test/hello_world.erb~ +1 -0
  218. data/test/fixtures/test/hello_world.pt-BR.html.erb +1 -0
  219. data/test/fixtures/test/malformed/malformed.en.html.erb~ +1 -0
  220. data/test/fixtures/test/malformed/malformed.erb~ +1 -0
  221. data/test/fixtures/test/malformed/malformed.html.erb~ +1 -0
  222. data/test/fixtures/test/render_explicit_html_template.js.rjs +1 -0
  223. data/test/fixtures/test/render_implicit_html_template.js.rjs +1 -0
  224. data/test/fixtures/test/render_implicit_html_template_from_xhr_request.da.html.erb +1 -0
  225. data/test/fixtures/test/render_implicit_html_template_from_xhr_request.html.erb +1 -0
  226. data/test/fixtures/test/render_implicit_js_template_without_layout.js.erb +1 -0
  227. data/test/fixtures/test/utf8.html.erb +2 -0
  228. data/test/template/active_record_helper_i18n_test.rb +31 -33
  229. data/test/template/active_record_helper_test.rb +34 -0
  230. data/test/template/asset_tag_helper_test.rb +52 -14
  231. data/test/template/atom_feed_helper_test.rb +3 -5
  232. data/test/template/benchmark_helper_test.rb +50 -24
  233. data/test/template/compiled_templates_test.rb +177 -33
  234. data/test/template/date_helper_i18n_test.rb +88 -81
  235. data/test/template/date_helper_test.rb +427 -43
  236. data/test/template/form_helper_test.rb +243 -44
  237. data/test/template/form_options_helper_test.rb +631 -565
  238. data/test/template/form_tag_helper_test.rb +9 -2
  239. data/test/template/javascript_helper_test.rb +0 -5
  240. data/test/template/number_helper_i18n_test.rb +60 -48
  241. data/test/template/number_helper_test.rb +1 -0
  242. data/test/template/render_test.rb +117 -35
  243. data/test/template/test_test.rb +4 -6
  244. data/test/template/text_helper_test.rb +129 -50
  245. data/test/template/translation_helper_test.rb +23 -19
  246. data/test/template/url_helper_test.rb +35 -2
  247. data/test/view/test_case_test.rb +8 -0
  248. metadata +197 -23
  249. data/lib/action_controller/assertions.rb +0 -69
  250. data/lib/action_controller/caching/sql_cache.rb +0 -18
  251. data/lib/action_controller/cgi_ext/session.rb +0 -53
  252. data/lib/action_controller/components.rb +0 -169
  253. data/lib/action_controller/rack_process.rb +0 -297
  254. data/lib/action_controller/request_profiler.rb +0 -169
  255. data/lib/action_controller/session/active_record_store.rb +0 -340
  256. data/lib/action_controller/session/drb_server.rb +0 -32
  257. data/lib/action_controller/session/drb_store.rb +0 -35
  258. data/test/controller/cgi_test.rb +0 -269
  259. data/test/controller/components_test.rb +0 -156
  260. data/test/controller/http_authentication_test.rb +0 -54
  261. data/test/controller/integration_upload_test.rb +0 -43
  262. data/test/controller/session_fixation_test.rb +0 -89
  263. data/test/controller/session_management_test.rb +0 -178
  264. data/test/fixtures/test/hello_world.js +0 -1
@@ -0,0 +1,8 @@
1
+ require 'swiftcore/swiftiplied_mongrel'
2
+
3
+ module Rack
4
+ module Handler
5
+ class SwiftipliedMongrel < Handler::Mongrel
6
+ end
7
+ end
8
+ end
@@ -0,0 +1,18 @@
1
+ require "thin"
2
+ require "rack/content_length"
3
+ require "rack/chunked"
4
+
5
+ module Rack
6
+ module Handler
7
+ class Thin
8
+ def self.run(app, options={})
9
+ app = Rack::Chunked.new(Rack::ContentLength.new(app))
10
+ server = ::Thin::Server.new(options[:Host] || '0.0.0.0',
11
+ options[:Port] || 8080,
12
+ app)
13
+ yield server if block_given?
14
+ server.start
15
+ end
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,67 @@
1
+ require 'webrick'
2
+ require 'stringio'
3
+ require 'rack/content_length'
4
+
5
+ module Rack
6
+ module Handler
7
+ class WEBrick < ::WEBrick::HTTPServlet::AbstractServlet
8
+ def self.run(app, options={})
9
+ server = ::WEBrick::HTTPServer.new(options)
10
+ server.mount "/", Rack::Handler::WEBrick, app
11
+ trap(:INT) { server.shutdown }
12
+ yield server if block_given?
13
+ server.start
14
+ end
15
+
16
+ def initialize(server, app)
17
+ super server
18
+ @app = Rack::ContentLength.new(app)
19
+ end
20
+
21
+ def service(req, res)
22
+ env = req.meta_vars
23
+ env.delete_if { |k, v| v.nil? }
24
+
25
+ env.update({"rack.version" => [0,1],
26
+ "rack.input" => StringIO.new(req.body.to_s),
27
+ "rack.errors" => $stderr,
28
+
29
+ "rack.multithread" => true,
30
+ "rack.multiprocess" => false,
31
+ "rack.run_once" => false,
32
+
33
+ "rack.url_scheme" => ["yes", "on", "1"].include?(ENV["HTTPS"]) ? "https" : "http"
34
+ })
35
+
36
+ env["HTTP_VERSION"] ||= env["SERVER_PROTOCOL"]
37
+ env["QUERY_STRING"] ||= ""
38
+ env["REQUEST_PATH"] ||= "/"
39
+ if env["PATH_INFO"] == ""
40
+ env.delete "PATH_INFO"
41
+ else
42
+ path, n = req.request_uri.path, env["SCRIPT_NAME"].length
43
+ env["PATH_INFO"] = path[n, path.length-n]
44
+ end
45
+
46
+ status, headers, body = @app.call(env)
47
+ begin
48
+ res.status = status.to_i
49
+ headers.each { |k, vs|
50
+ if k.downcase == "set-cookie"
51
+ res.cookies.concat vs.split("\n")
52
+ else
53
+ vs.split("\n").each { |v|
54
+ res[k] = v
55
+ }
56
+ end
57
+ }
58
+ body.each { |part|
59
+ res.body << part
60
+ }
61
+ ensure
62
+ body.close if body.respond_to? :close
63
+ end
64
+ end
65
+ end
66
+ end
67
+ end
@@ -0,0 +1,19 @@
1
+ module Rack
2
+
3
+ class Head
4
+ def initialize(app)
5
+ @app = app
6
+ end
7
+
8
+ def call(env)
9
+ status, headers, body = @app.call(env)
10
+
11
+ if env["REQUEST_METHOD"] == "HEAD"
12
+ [status, headers, []]
13
+ else
14
+ [status, headers, body]
15
+ end
16
+ end
17
+ end
18
+
19
+ end
@@ -0,0 +1,462 @@
1
+ require 'rack/utils'
2
+
3
+ module Rack
4
+ # Rack::Lint validates your application and the requests and
5
+ # responses according to the Rack spec.
6
+
7
+ class Lint
8
+ def initialize(app)
9
+ @app = app
10
+ end
11
+
12
+ # :stopdoc:
13
+
14
+ class LintError < RuntimeError; end
15
+ module Assertion
16
+ def assert(message, &block)
17
+ unless block.call
18
+ raise LintError, message
19
+ end
20
+ end
21
+ end
22
+ include Assertion
23
+
24
+ ## This specification aims to formalize the Rack protocol. You
25
+ ## can (and should) use Rack::Lint to enforce it.
26
+ ##
27
+ ## When you develop middleware, be sure to add a Lint before and
28
+ ## after to catch all mistakes.
29
+
30
+ ## = Rack applications
31
+
32
+ ## A Rack application is an Ruby object (not a class) that
33
+ ## responds to +call+.
34
+ def call(env=nil)
35
+ dup._call(env)
36
+ end
37
+
38
+ def _call(env)
39
+ ## It takes exactly one argument, the *environment*
40
+ assert("No env given") { env }
41
+ check_env env
42
+
43
+ env['rack.input'] = InputWrapper.new(env['rack.input'])
44
+ env['rack.errors'] = ErrorWrapper.new(env['rack.errors'])
45
+
46
+ ## and returns an Array of exactly three values:
47
+ status, headers, @body = @app.call(env)
48
+ ## The *status*,
49
+ check_status status
50
+ ## the *headers*,
51
+ check_headers headers
52
+ ## and the *body*.
53
+ check_content_type status, headers
54
+ check_content_length status, headers, env
55
+ [status, headers, self]
56
+ end
57
+
58
+ ## == The Environment
59
+ def check_env(env)
60
+ ## The environment must be an true instance of Hash (no
61
+ ## subclassing allowed) that includes CGI-like headers.
62
+ ## The application is free to modify the environment.
63
+ assert("env #{env.inspect} is not a Hash, but #{env.class}") {
64
+ env.instance_of? Hash
65
+ }
66
+
67
+ ##
68
+ ## The environment is required to include these variables
69
+ ## (adopted from PEP333), except when they'd be empty, but see
70
+ ## below.
71
+
72
+ ## <tt>REQUEST_METHOD</tt>:: The HTTP request method, such as
73
+ ## "GET" or "POST". This cannot ever
74
+ ## be an empty string, and so is
75
+ ## always required.
76
+
77
+ ## <tt>SCRIPT_NAME</tt>:: The initial portion of the request
78
+ ## URL's "path" that corresponds to the
79
+ ## application object, so that the
80
+ ## application knows its virtual
81
+ ## "location". This may be an empty
82
+ ## string, if the application corresponds
83
+ ## to the "root" of the server.
84
+
85
+ ## <tt>PATH_INFO</tt>:: The remainder of the request URL's
86
+ ## "path", designating the virtual
87
+ ## "location" of the request's target
88
+ ## within the application. This may be an
89
+ ## empty string, if the request URL targets
90
+ ## the application root and does not have a
91
+ ## trailing slash. This information should be
92
+ ## decoded by the server if it comes from a
93
+ ## URL.
94
+
95
+ ## <tt>QUERY_STRING</tt>:: The portion of the request URL that
96
+ ## follows the <tt>?</tt>, if any. May be
97
+ ## empty, but is always required!
98
+
99
+ ## <tt>SERVER_NAME</tt>, <tt>SERVER_PORT</tt>:: When combined with <tt>SCRIPT_NAME</tt> and <tt>PATH_INFO</tt>, these variables can be used to complete the URL. Note, however, that <tt>HTTP_HOST</tt>, if present, should be used in preference to <tt>SERVER_NAME</tt> for reconstructing the request URL. <tt>SERVER_NAME</tt> and <tt>SERVER_PORT</tt> can never be empty strings, and so are always required.
100
+
101
+ ## <tt>HTTP_</tt> Variables:: Variables corresponding to the
102
+ ## client-supplied HTTP request
103
+ ## headers (i.e., variables whose
104
+ ## names begin with <tt>HTTP_</tt>). The
105
+ ## presence or absence of these
106
+ ## variables should correspond with
107
+ ## the presence or absence of the
108
+ ## appropriate HTTP header in the
109
+ ## request.
110
+
111
+ ## In addition to this, the Rack environment must include these
112
+ ## Rack-specific variables:
113
+
114
+ ## <tt>rack.version</tt>:: The Array [0,1], representing this version of Rack.
115
+ ## <tt>rack.url_scheme</tt>:: +http+ or +https+, depending on the request URL.
116
+ ## <tt>rack.input</tt>:: See below, the input stream.
117
+ ## <tt>rack.errors</tt>:: See below, the error stream.
118
+ ## <tt>rack.multithread</tt>:: true if the application object may be simultaneously invoked by another thread in the same process, false otherwise.
119
+ ## <tt>rack.multiprocess</tt>:: true if an equivalent application object may be simultaneously invoked by another process, false otherwise.
120
+ ## <tt>rack.run_once</tt>:: true if the server expects (but does not guarantee!) that the application will only be invoked this one time during the life of its containing process. Normally, this will only be true for a server based on CGI (or something similar).
121
+
122
+ ## The server or the application can store their own data in the
123
+ ## environment, too. The keys must contain at least one dot,
124
+ ## and should be prefixed uniquely. The prefix <tt>rack.</tt>
125
+ ## is reserved for use with the Rack core distribution and must
126
+ ## not be used otherwise.
127
+ ##
128
+
129
+ %w[REQUEST_METHOD SERVER_NAME SERVER_PORT
130
+ QUERY_STRING
131
+ rack.version rack.input rack.errors
132
+ rack.multithread rack.multiprocess rack.run_once].each { |header|
133
+ assert("env missing required key #{header}") { env.include? header }
134
+ }
135
+
136
+ ## The environment must not contain the keys
137
+ ## <tt>HTTP_CONTENT_TYPE</tt> or <tt>HTTP_CONTENT_LENGTH</tt>
138
+ ## (use the versions without <tt>HTTP_</tt>).
139
+ %w[HTTP_CONTENT_TYPE HTTP_CONTENT_LENGTH].each { |header|
140
+ assert("env contains #{header}, must use #{header[5,-1]}") {
141
+ not env.include? header
142
+ }
143
+ }
144
+
145
+ ## The CGI keys (named without a period) must have String values.
146
+ env.each { |key, value|
147
+ next if key.include? "." # Skip extensions
148
+ assert("env variable #{key} has non-string value #{value.inspect}") {
149
+ value.instance_of? String
150
+ }
151
+ }
152
+
153
+ ##
154
+ ## There are the following restrictions:
155
+
156
+ ## * <tt>rack.version</tt> must be an array of Integers.
157
+ assert("rack.version must be an Array, was #{env["rack.version"].class}") {
158
+ env["rack.version"].instance_of? Array
159
+ }
160
+ ## * <tt>rack.url_scheme</tt> must either be +http+ or +https+.
161
+ assert("rack.url_scheme unknown: #{env["rack.url_scheme"].inspect}") {
162
+ %w[http https].include? env["rack.url_scheme"]
163
+ }
164
+
165
+ ## * There must be a valid input stream in <tt>rack.input</tt>.
166
+ check_input env["rack.input"]
167
+ ## * There must be a valid error stream in <tt>rack.errors</tt>.
168
+ check_error env["rack.errors"]
169
+
170
+ ## * The <tt>REQUEST_METHOD</tt> must be a valid token.
171
+ assert("REQUEST_METHOD unknown: #{env["REQUEST_METHOD"]}") {
172
+ env["REQUEST_METHOD"] =~ /\A[0-9A-Za-z!\#$%&'*+.^_`|~-]+\z/
173
+ }
174
+
175
+ ## * The <tt>SCRIPT_NAME</tt>, if non-empty, must start with <tt>/</tt>
176
+ assert("SCRIPT_NAME must start with /") {
177
+ !env.include?("SCRIPT_NAME") ||
178
+ env["SCRIPT_NAME"] == "" ||
179
+ env["SCRIPT_NAME"] =~ /\A\//
180
+ }
181
+ ## * The <tt>PATH_INFO</tt>, if non-empty, must start with <tt>/</tt>
182
+ assert("PATH_INFO must start with /") {
183
+ !env.include?("PATH_INFO") ||
184
+ env["PATH_INFO"] == "" ||
185
+ env["PATH_INFO"] =~ /\A\//
186
+ }
187
+ ## * The <tt>CONTENT_LENGTH</tt>, if given, must consist of digits only.
188
+ assert("Invalid CONTENT_LENGTH: #{env["CONTENT_LENGTH"]}") {
189
+ !env.include?("CONTENT_LENGTH") || env["CONTENT_LENGTH"] =~ /\A\d+\z/
190
+ }
191
+
192
+ ## * One of <tt>SCRIPT_NAME</tt> or <tt>PATH_INFO</tt> must be
193
+ ## set. <tt>PATH_INFO</tt> should be <tt>/</tt> if
194
+ ## <tt>SCRIPT_NAME</tt> is empty.
195
+ assert("One of SCRIPT_NAME or PATH_INFO must be set (make PATH_INFO '/' if SCRIPT_NAME is empty)") {
196
+ env["SCRIPT_NAME"] || env["PATH_INFO"]
197
+ }
198
+ ## <tt>SCRIPT_NAME</tt> never should be <tt>/</tt>, but instead be empty.
199
+ assert("SCRIPT_NAME cannot be '/', make it '' and PATH_INFO '/'") {
200
+ env["SCRIPT_NAME"] != "/"
201
+ }
202
+ end
203
+
204
+ ## === The Input Stream
205
+ def check_input(input)
206
+ ## The input stream must respond to +gets+, +each+ and +read+.
207
+ [:gets, :each, :read].each { |method|
208
+ assert("rack.input #{input} does not respond to ##{method}") {
209
+ input.respond_to? method
210
+ }
211
+ }
212
+ end
213
+
214
+ class InputWrapper
215
+ include Assertion
216
+
217
+ def initialize(input)
218
+ @input = input
219
+ end
220
+
221
+ def size
222
+ @input.size
223
+ end
224
+
225
+ def rewind
226
+ @input.rewind
227
+ end
228
+
229
+ ## * +gets+ must be called without arguments and return a string,
230
+ ## or +nil+ on EOF.
231
+ def gets(*args)
232
+ assert("rack.input#gets called with arguments") { args.size == 0 }
233
+ v = @input.gets
234
+ assert("rack.input#gets didn't return a String") {
235
+ v.nil? or v.instance_of? String
236
+ }
237
+ v
238
+ end
239
+
240
+ ## * +read+ must be called without or with one integer argument
241
+ ## and return a string, or +nil+ on EOF.
242
+ def read(*args)
243
+ assert("rack.input#read called with too many arguments") {
244
+ args.size <= 1
245
+ }
246
+ if args.size == 1
247
+ assert("rack.input#read called with non-integer argument") {
248
+ args.first.kind_of? Integer
249
+ }
250
+ end
251
+ v = @input.read(*args)
252
+ assert("rack.input#read didn't return a String") {
253
+ v.nil? or v.instance_of? String
254
+ }
255
+ v
256
+ end
257
+
258
+ ## * +each+ must be called without arguments and only yield Strings.
259
+ def each(*args)
260
+ assert("rack.input#each called with arguments") { args.size == 0 }
261
+ @input.each { |line|
262
+ assert("rack.input#each didn't yield a String") {
263
+ line.instance_of? String
264
+ }
265
+ yield line
266
+ }
267
+ end
268
+
269
+ ## * +close+ must never be called on the input stream.
270
+ def close(*args)
271
+ assert("rack.input#close must not be called") { false }
272
+ end
273
+ end
274
+
275
+ ## === The Error Stream
276
+ def check_error(error)
277
+ ## The error stream must respond to +puts+, +write+ and +flush+.
278
+ [:puts, :write, :flush].each { |method|
279
+ assert("rack.error #{error} does not respond to ##{method}") {
280
+ error.respond_to? method
281
+ }
282
+ }
283
+ end
284
+
285
+ class ErrorWrapper
286
+ include Assertion
287
+
288
+ def initialize(error)
289
+ @error = error
290
+ end
291
+
292
+ ## * +puts+ must be called with a single argument that responds to +to_s+.
293
+ def puts(str)
294
+ @error.puts str
295
+ end
296
+
297
+ ## * +write+ must be called with a single argument that is a String.
298
+ def write(str)
299
+ assert("rack.errors#write not called with a String") { str.instance_of? String }
300
+ @error.write str
301
+ end
302
+
303
+ ## * +flush+ must be called without arguments and must be called
304
+ ## in order to make the error appear for sure.
305
+ def flush
306
+ @error.flush
307
+ end
308
+
309
+ ## * +close+ must never be called on the error stream.
310
+ def close(*args)
311
+ assert("rack.errors#close must not be called") { false }
312
+ end
313
+ end
314
+
315
+ ## == The Response
316
+
317
+ ## === The Status
318
+ def check_status(status)
319
+ ## The status, if parsed as integer (+to_i+), must be greater than or equal to 100.
320
+ assert("Status must be >=100 seen as integer") { status.to_i >= 100 }
321
+ end
322
+
323
+ ## === The Headers
324
+ def check_headers(header)
325
+ ## The header must respond to each, and yield values of key and value.
326
+ assert("headers object should respond to #each, but doesn't (got #{header.class} as headers)") {
327
+ header.respond_to? :each
328
+ }
329
+ header.each { |key, value|
330
+ ## The header keys must be Strings.
331
+ assert("header key must be a string, was #{key.class}") {
332
+ key.instance_of? String
333
+ }
334
+ ## The header must not contain a +Status+ key,
335
+ assert("header must not contain Status") { key.downcase != "status" }
336
+ ## contain keys with <tt>:</tt> or newlines in their name,
337
+ assert("header names must not contain : or \\n") { key !~ /[:\n]/ }
338
+ ## contain keys names that end in <tt>-</tt> or <tt>_</tt>,
339
+ assert("header names must not end in - or _") { key !~ /[-_]\z/ }
340
+ ## but only contain keys that consist of
341
+ ## letters, digits, <tt>_</tt> or <tt>-</tt> and start with a letter.
342
+ assert("invalid header name: #{key}") { key =~ /\A[a-zA-Z][a-zA-Z0-9_-]*\z/ }
343
+
344
+ ## The values of the header must be Strings,
345
+ assert("a header value must be a String, but the value of " +
346
+ "'#{key}' is a #{value.class}") { value.kind_of? String }
347
+ ## consisting of lines (for multiple header values) seperated by "\n".
348
+ value.split("\n").each { |item|
349
+ ## The lines must not contain characters below 037.
350
+ assert("invalid header value #{key}: #{item.inspect}") {
351
+ item !~ /[\000-\037]/
352
+ }
353
+ }
354
+ }
355
+ end
356
+
357
+ ## === The Content-Type
358
+ def check_content_type(status, headers)
359
+ headers.each { |key, value|
360
+ ## There must be a <tt>Content-Type</tt>, except when the
361
+ ## +Status+ is 1xx, 204 or 304, in which case there must be none
362
+ ## given.
363
+ if key.downcase == "content-type"
364
+ assert("Content-Type header found in #{status} response, not allowed") {
365
+ not Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include? status.to_i
366
+ }
367
+ return
368
+ end
369
+ }
370
+ assert("No Content-Type header found") {
371
+ Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include? status.to_i
372
+ }
373
+ end
374
+
375
+ ## === The Content-Length
376
+ def check_content_length(status, headers, env)
377
+ headers.each { |key, value|
378
+ if key.downcase == 'content-length'
379
+ ## There must not be a <tt>Content-Length</tt> header when the
380
+ ## +Status+ is 1xx, 204 or 304.
381
+ assert("Content-Length header found in #{status} response, not allowed") {
382
+ not Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include? status.to_i
383
+ }
384
+
385
+ bytes = 0
386
+ string_body = true
387
+
388
+ if @body.respond_to?(:to_ary)
389
+ @body.each { |part|
390
+ unless part.kind_of?(String)
391
+ string_body = false
392
+ break
393
+ end
394
+
395
+ bytes += Rack::Utils.bytesize(part)
396
+ }
397
+
398
+ if env["REQUEST_METHOD"] == "HEAD"
399
+ assert("Response body was given for HEAD request, but should be empty") {
400
+ bytes == 0
401
+ }
402
+ else
403
+ if string_body
404
+ assert("Content-Length header was #{value}, but should be #{bytes}") {
405
+ value == bytes.to_s
406
+ }
407
+ end
408
+ end
409
+ end
410
+
411
+ return
412
+ end
413
+ }
414
+ end
415
+
416
+ ## === The Body
417
+ def each
418
+ @closed = false
419
+ ## The Body must respond to #each
420
+ @body.each { |part|
421
+ ## and must only yield String values.
422
+ assert("Body yielded non-string value #{part.inspect}") {
423
+ part.instance_of? String
424
+ }
425
+ yield part
426
+ }
427
+ ##
428
+ ## If the Body responds to #close, it will be called after iteration.
429
+ # XXX howto: assert("Body has not been closed") { @closed }
430
+
431
+
432
+ ##
433
+ ## If the Body responds to #to_path, it must return a String
434
+ ## identifying the location of a file whose contents are identical
435
+ ## to that produced by calling #each.
436
+
437
+ if @body.respond_to?(:to_path)
438
+ assert("The file identified by body.to_path does not exist") {
439
+ ::File.exist? @body.to_path
440
+ }
441
+ end
442
+
443
+ ##
444
+ ## The Body commonly is an Array of Strings, the application
445
+ ## instance itself, or a File-like object.
446
+ end
447
+
448
+ def close
449
+ @closed = true
450
+ @body.close if @body.respond_to?(:close)
451
+ end
452
+
453
+ # :startdoc:
454
+
455
+ end
456
+ end
457
+
458
+ ## == Thanks
459
+ ## Some parts of this specification are adopted from PEP333: Python
460
+ ## Web Server Gateway Interface
461
+ ## v1.0 (http://www.python.org/dev/peps/pep-0333/). I'd like to thank
462
+ ## everyone involved in that effort.