From bbfb40a914e3c2bc461da90548471e9daaadbd80 Mon Sep 17 00:00:00 2001 From: schneems Date: Wed, 7 May 2014 11:50:12 -0500 Subject: [ci skip] document ActionDispatch::HTTP::Headers --- actionpack/lib/action_dispatch/http/headers.rb | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'actionpack/lib/action_dispatch') diff --git a/actionpack/lib/action_dispatch/http/headers.rb b/actionpack/lib/action_dispatch/http/headers.rb index 2666cd4b0a..afaace511a 100644 --- a/actionpack/lib/action_dispatch/http/headers.rb +++ b/actionpack/lib/action_dispatch/http/headers.rb @@ -1,5 +1,11 @@ module ActionDispatch module Http + # Provides access to the request's HTTP headers from the environment + # for example: + # + # env = { "CONTENT_TYPE" => "text/plain" } + # headers = ActionDispatch::Http::Headers.new(env) + # headers["Content-Type"] # => "text/plain" class Headers CGI_VARIABLES = %w( CONTENT_TYPE CONTENT_LENGTH -- cgit v1.2.3 From cb6622f455343bb9eddefabc2386dc7858de2e53 Mon Sep 17 00:00:00 2001 From: Vijay Dev Date: Thu, 8 May 2014 18:24:38 +0000 Subject: copy edits [ci skip] --- actionpack/lib/action_dispatch/http/headers.rb | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'actionpack/lib/action_dispatch') diff --git a/actionpack/lib/action_dispatch/http/headers.rb b/actionpack/lib/action_dispatch/http/headers.rb index afaace511a..29cd6a0c27 100644 --- a/actionpack/lib/action_dispatch/http/headers.rb +++ b/actionpack/lib/action_dispatch/http/headers.rb @@ -1,7 +1,6 @@ module ActionDispatch module Http - # Provides access to the request's HTTP headers from the environment - # for example: + # Provides access to the request's HTTP headers from the environment. # # env = { "CONTENT_TYPE" => "text/plain" } # headers = ActionDispatch::Http::Headers.new(env) -- cgit v1.2.3 From aabbf07d003d78a685c0cdcb8e8f9e7fbb02361c Mon Sep 17 00:00:00 2001 From: schneems Date: Fri, 9 May 2014 11:29:29 -0500 Subject: [ci skip] doc Http::Headers methods --- actionpack/lib/action_dispatch/http/headers.rb | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) (limited to 'actionpack/lib/action_dispatch') diff --git a/actionpack/lib/action_dispatch/http/headers.rb b/actionpack/lib/action_dispatch/http/headers.rb index 29cd6a0c27..cd133d6b99 100644 --- a/actionpack/lib/action_dispatch/http/headers.rb +++ b/actionpack/lib/action_dispatch/http/headers.rb @@ -19,14 +19,16 @@ module ActionDispatch include Enumerable attr_reader :env - def initialize(env = {}) + def initialize(env = {}) # :nodoc: @env = env end + # Returns the value for the given key mapped to @env. def [](key) @env[env_name(key)] end + # Set the given value for the key mapped to @env. def []=(key, value) @env[env_name(key)] = value end @@ -34,6 +36,12 @@ module ActionDispatch def key?(key); @env.key? key; end alias :include? :key? + + # Returns the value for the given key mapped to @env. + # If the key can’t be found, there are several options: + # with no other arguments, it will raise an KeyError exception; + # If the optional code block is specified, then that will be run and its + # result returned. def fetch(key, *args, &block) @env.fetch env_name(key), *args, &block end @@ -42,12 +50,18 @@ module ActionDispatch @env.each(&block) end + + # Returns a new Http::Headers instance containing the contents of + # headers_or_env and the original instance. def merge(headers_or_env) headers = Http::Headers.new(env.dup) headers.merge!(headers_or_env) headers end + # Adds the contents of headers_or_env to original instance + # entries with duplicate keys are overwritten with the values from + # headers_or_env. def merge!(headers_or_env) headers_or_env.each do |key, value| self[env_name(key)] = value @@ -55,6 +69,8 @@ module ActionDispatch end private + # Converts a HTTP header name to an environment variable name if it is + # not contained within the headers hash. def env_name(key) key = key.to_s if key =~ HTTP_HEADER -- cgit v1.2.3 From ffb9db0247084514adc73ae92dfe8d5a3033226b Mon Sep 17 00:00:00 2001 From: Vijay Dev Date: Sat, 10 May 2014 13:44:43 +0000 Subject: copy edits [ci skip] --- actionpack/lib/action_dispatch/http/headers.rb | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'actionpack/lib/action_dispatch') diff --git a/actionpack/lib/action_dispatch/http/headers.rb b/actionpack/lib/action_dispatch/http/headers.rb index cd133d6b99..dbf3fe51f5 100644 --- a/actionpack/lib/action_dispatch/http/headers.rb +++ b/actionpack/lib/action_dispatch/http/headers.rb @@ -28,7 +28,7 @@ module ActionDispatch @env[env_name(key)] end - # Set the given value for the key mapped to @env. + # Sets the given value for the key mapped to @env. def []=(key, value) @env[env_name(key)] = value end @@ -36,12 +36,13 @@ module ActionDispatch def key?(key); @env.key? key; end alias :include? :key? - # Returns the value for the given key mapped to @env. - # If the key can’t be found, there are several options: - # with no other arguments, it will raise an KeyError exception; - # If the optional code block is specified, then that will be run and its - # result returned. + # + # If the key is not found and an optional code block is not provided, + # raises a KeyError exception. + # + # If the code block is provided, then it will be run and + # its result returned. def fetch(key, *args, &block) @env.fetch env_name(key), *args, &block end @@ -50,7 +51,6 @@ module ActionDispatch @env.each(&block) end - # Returns a new Http::Headers instance containing the contents of # headers_or_env and the original instance. def merge(headers_or_env) @@ -60,7 +60,7 @@ module ActionDispatch end # Adds the contents of headers_or_env to original instance - # entries with duplicate keys are overwritten with the values from + # entries; duplicate keys are overwritten with the values from # headers_or_env. def merge!(headers_or_env) headers_or_env.each do |key, value| -- cgit v1.2.3