1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00

Improve img alt attribute for screen readers

Currently, the img_alt method in ActionView keeps underscores
in the alt attribute. Because underscores are pronounced in
Apple's VoiceOver Utility, this has serious implications for
accessibility. This patch makes underscored or hyphenated file
names (both common in projects) read more naturally in screen
readers by replacing them with spaces. See method documentation
for details.

Added documentation to image_alt method
This commit is contained in:
thenickcox 2013-02-07 23:07:42 -08:00
parent 408227d9c5
commit dd9f8bc847
3 changed files with 40 additions and 4 deletions

View file

@ -1,5 +1,26 @@
## Rails 4.0.0 (unreleased) ##
* Fix `image_alt` method to work with underscored or hyphenated file names.
Currently, underscored filenames become
`<img alt="A_long_file_name_with_underscores"` in HTML, which is
poor for accessibility; Apple's VoiceOver Utility pronounces
each underscore. "A_long_file_name" thus becomes "A underscore
long underscore file underscore name." This patch makes underscored
or hyphenated file names (both of which are very popular naming
conventions) read more naturally in screen readers by converting
both hyphens and underscores to spaces.
Example:
# current implementation
image_tag('underscored_file_name.png')
#=> <img alt="Underscored_file_name" src="/assets/underscored_file_name.png" />
# this patch
image_tag('underscored_file_name.png')
#=> <img alt="Underscored file name" src="/assets/underscored_file_name.png" />
*Nick Cox*
* We don't support the `:controller` option for route definitions
with the ruby constant notation. This will now result in an
`ArgumentError`.

View file

@ -214,10 +214,24 @@ module ActionView
end
# Returns a string suitable for an html image tag alt attribute.
# +src+ is meant to be an image file path.
# It removes the basename of the file path and the digest, if any.
# The +src+ argument is meant to be an image file path.
# The method removes the basename of the file path and the digest,
# if any. It also removes hyphens and underscores from file names and
# replaces them with spaces, returning a space-separated, titleized
# string.
#
# ==== Examples
#
# image_tag('rails.png')
# # => <img alt="Rails" src="/assets/rails.png" />
#
# image_tag('hyphenated-file-name.png')
# # => <img alt="Hyphenated file name" src="/assets/hyphenated-file-name.png" />
#
# image_tag('underscored_file_name.png')
# # => <img alt="Underscored file name" src="/assets/underscored_file_name.png" />
def image_alt(src)
File.basename(src, '.*').sub(/-[[:xdigit:]]{32}\z/, '').capitalize
File.basename(src, '.*').sub(/-[[:xdigit:]]{32}\z/, '').tr('-_', ' ').capitalize
end
# Returns an html video tag for the +sources+. If +sources+ is a string,

View file

@ -443,7 +443,8 @@ class AssetTagHelperTest < ActionView::TestCase
[nil, '/', '/foo/bar/', 'foo/bar/'].each do |prefix|
assert_equal 'Rails', image_alt("#{prefix}rails.png")
assert_equal 'Rails', image_alt("#{prefix}rails-9c0a079bdd7701d7e729bd956823d153.png")
assert_equal 'Avatar-0000', image_alt("#{prefix}avatar-0000.png")
assert_equal 'Long file name with hyphens', image_alt("#{prefix}long-file-name-with-hyphens.png")
assert_equal 'Long file name with underscores', image_alt("#{prefix}long_file_name_with_underscores.png")
end
end