aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib
diff options
context:
space:
mode:
authorGeorge Claghorn <george.claghorn@gmail.com>2015-02-13 23:41:19 -0500
committerGeorge Claghorn <george@basecamp.com>2015-03-24 12:49:27 -0500
commit9d9cc4777be3787ed3645d704f02e5ba1228be13 (patch)
tree1175ed3d033c08cdadedc15f50b144f085e60854 /actionpack/lib
parentd024bad4d1f8307a66fd6684dc658fddee37147e (diff)
downloadrails-9d9cc4777be3787ed3645d704f02e5ba1228be13.tar.gz
rails-9d9cc4777be3787ed3645d704f02e5ba1228be13.tar.bz2
rails-9d9cc4777be3787ed3645d704f02e5ba1228be13.zip
Provide friendlier access to request variants
Closes #18933.
Diffstat (limited to 'actionpack/lib')
-rw-r--r--actionpack/lib/action_controller/metal/mime_responds.rb13
-rw-r--r--actionpack/lib/action_dispatch/http/mime_negotiation.rb41
2 files changed, 41 insertions, 13 deletions
diff --git a/actionpack/lib/action_controller/metal/mime_responds.rb b/actionpack/lib/action_controller/metal/mime_responds.rb
index 7dae171215..fab1be3459 100644
--- a/actionpack/lib/action_controller/metal/mime_responds.rb
+++ b/actionpack/lib/action_controller/metal/mime_responds.rb
@@ -288,16 +288,17 @@ module ActionController #:nodoc:
end
def variant
- if @variant.nil?
+ if @variant.empty?
@variants[:none] || @variants[:any]
- elsif (@variants.keys & @variant).any?
- @variant.each do |v|
- return @variants[v] if @variants.key?(v)
- end
else
- @variants[:any]
+ @variants[variant_key]
end
end
+
+ private
+ def variant_key
+ @variant.find { |variant| @variants.key?(variant) } || :any
+ end
end
end
end
diff --git a/actionpack/lib/action_dispatch/http/mime_negotiation.rb b/actionpack/lib/action_dispatch/http/mime_negotiation.rb
index 53a98c5d0a..6544aff7d2 100644
--- a/actionpack/lib/action_dispatch/http/mime_negotiation.rb
+++ b/actionpack/lib/action_dispatch/http/mime_negotiation.rb
@@ -10,8 +10,6 @@ module ActionDispatch
self.ignore_accept_header = false
end
- attr_reader :variant
-
# The MIME type of the HTTP request, such as Mime::XML.
#
# For backward compatibility, the post \format is extracted from the
@@ -75,18 +73,22 @@ module ActionDispatch
# Sets the \variant for template.
def variant=(variant)
- if variant.is_a?(Symbol)
- @variant = [variant]
- elsif variant.nil? || variant.is_a?(Array) && variant.any? && variant.all?{ |v| v.is_a?(Symbol) }
- @variant = variant
+ variant = Array(variant)
+
+ if variant.all? { |v| v.is_a?(Symbol) }
+ @variant = VariantInquirer.new(variant)
else
- raise ArgumentError, "request.variant must be set to a Symbol or an Array of Symbols, not a #{variant.class}. " \
+ raise ArgumentError, "request.variant must be set to a Symbol or an Array of Symbols. " \
"For security reasons, never directly set the variant to a user-provided value, " \
"like params[:variant].to_sym. Check user-provided value against a whitelist first, " \
"then set the variant: request.variant = :tablet if params[:variant] == 'tablet'"
end
end
+ def variant
+ @variant ||= VariantInquirer.new
+ end
+
# Sets the \format by string extension, which can be used to force custom formats
# that are not controlled by the extension.
#
@@ -139,6 +141,31 @@ module ActionDispatch
order.include?(Mime::ALL) ? format : nil
end
+ class VariantInquirer # :nodoc:
+ delegate :each, :empty?, to: :@variants
+
+ def initialize(variants = [])
+ @variants = variants
+ end
+
+ def any?(*candidates)
+ (@variants & candidates).any?
+ end
+
+ def to_ary
+ @variants
+ end
+
+ private
+ def method_missing(name, *args)
+ if name[-1] == '?'
+ any? name[0..-2].to_sym
+ else
+ super
+ end
+ end
+ end
+
protected
BROWSER_LIKE_ACCEPTS = /,\s*\*\/\*|\*\/\*\s*,/