@@ -2,5 +2,5 @@ require "typography_helper" class ActionView::Base - include TypographyHelper + include TypographyHelper end \ No newline at end of file init.rb @@ -3,81 +3,81 @@ module TypographyHelper - # converts a & surrounded by optional whitespace or a non-breaking space - # to the HTML entity and surrounds it in a span with a styled class - def amp(text) - # $1 is an excluded HTML tag, $2 is the part before the caps and $3 is the amp match - text.gsub(/<(code|pre).+?<\/\1>|(\s| )&(\s| )/) {|str| - $1 ? str : $2 + '<span class="amp">&</span>' + $3 } - end + # converts a & surrounded by optional whitespace or a non-breaking space + # to the HTML entity and surrounds it in a span with a styled class + def amp(text) + # $1 is an excluded HTML tag, $2 is the part before the caps and $3 is the amp match + text.gsub(/<(code|pre).+?<\/\1>|(\s| )&(\s| )/) {|str| + $1 ? str : $2 + '<span class="amp">&</span>' + $3 } + end - # based on http://mucur.name/posts/widon-t-and-smartypants-helpers-for-rails - # original concept from http://shauninman.com/archive/2006/08/22/widont_wordpress_plugin - # - # replaces space(s) before the last word (or tag before the last word) - # before an optional closing element (a, em, span, strong) - # before a closing tag (p, h[1-6], li, dt, dd) or the end of the string - def widont(text) - text.gsub(%r/ - (\s+) # some whitespace group 1 - ( # capture group 2 - (?:<(?:a|em|span|strong|i|b)[^>]*?>\s*)? # an optional opening tag - [^<>\s]+ # the matched word itself - (?:<\/(?:a|em|span|strong|i|b)[^>]*?>\s*)? # optional inline closing tags - (?:\s*?<\/(?:p|h[1-6]|li|dt|dd)>) # a closing element - )/x, ' \2') - end + # based on http://mucur.name/posts/widon-t-and-smartypants-helpers-for-rails + # original concept from http://shauninman.com/archive/2006/08/22/widont_wordpress_plugin + # + # replaces space(s) before the last word (or tag before the last word) + # before an optional closing element (a, em, span, strong) + # before a closing tag (p, h[1-6], li, dt, dd) or the end of the string + def widont(text) + text.gsub(%r/ + (\s+) # some whitespace group 1 + ( # capture group 2 + (?:<(?:a|em|span|strong|i|b)[^>]*?>\s*)? # an optional opening tag + [^<>\s]+ # the matched word itself + (?:<\/(?:a|em|span|strong|i|b)[^>]*?>\s*)? # optional inline closing tags + (?:\s*?<\/(?:p|h[1-6]|li|dt|dd)>) # a closing element + )/x, ' \2') + end - # speedier method for one-line elements only (if you care about performance) - # taken from http://mucur.name/posts/widon-t-and-smartypants-helpers-for-rails - def widont_single(text) - text.strip! - text[text.rindex(' '), 1] = ' ' if text.rindex(' ') - text - end + # speedier method for one-line elements only (if you care about performance) + # taken from http://mucur.name/posts/widon-t-and-smartypants-helpers-for-rails + def widont_single(text) + text.strip! + text[text.rindex(' '), 1] = ' ' if text.rindex(' ') + text + end - # surrounds two or more consecutive captial letters, perhaps with interspersed digits and periods - # in a span with a styled class - def caps(text) - # $1 is an excluded HTML tag, $2 is the part before the caps and $3 is the caps match - text.gsub(/<(code|pre).+?<\/\1>|(\s| |^|'|"|(?:<(?:h[1-6]|p|li|dt|dd)[^>]*>|^))([A-Z][A-Z\d\.]{1,})(?!\w)/) { |str| - $1 ? str : $2 + '<span class="caps">' + $3 + '</span>' - } - end + # surrounds two or more consecutive captial letters, perhaps with interspersed digits and periods + # in a span with a styled class + def caps(text) + # $1 is an excluded HTML tag, $2 is the part before the caps and $3 is the caps match + text.gsub(/<(code|pre).+?<\/\1>|(\s| |^|'|"|(?:<(?:h[1-6]|p|li|dt|dd)[^>]*>|^))([A-Z][A-Z\d\.]{1,})(?!\w)/) { |str| + $1 ? str : $2 + '<span class="caps">' + $3 + '</span>' + } + end - # encloses initial single or double quote, or their entities - # (optionally preceeded by a block element and perhaps an inline element) - # with a span that can be styled - def initial_quotes(text) - # $1 is the initial part of the string, $2 is the quote or entitity, and $3 is the double quote - text.gsub(/((?:<(?:h[1-6]|p|li|dt|dd)[^>]*>|^)\s*(?:<(?:a|em|strong|span)[^>]*>)?)('|‘|("|“))/) {$1 + "<span class=\"#{'d' if $3}quo\">#{$2}</span>"} - end + # encloses initial single or double quote, or their entities + # (optionally preceeded by a block element and perhaps an inline element) + # with a span that can be styled + def initial_quotes(text) + # $1 is the initial part of the string, $2 is the quote or entitity, and $3 is the double quote + text.gsub(/((?:<(?:h[1-6]|p|li|dt|dd)[^>]*>|^)\s*(?:<(?:a|em|strong|span)[^>]*>)?)('|‘|("|“))/) {$1 + "<span class=\"#{'d' if $3}quo\">#{$2}</span>"} + end - # uses RubyPants to transform various typographical thingys to proper HTML entities - # requires the RubyPants gem http://www.gemjack.com/gems/rubypants-0.2.0/classes/RubyPants.html - # Based on SmartyPants http://daringfireball.net/projects/smartypants - def rubypants(text) - require 'rubygems' - require 'rubypants' - RubyPants.new(text).to_html - end - - # main function to do all the functions from the method - def rubyshirt(text) - initial_quotes( amp( caps( widont( text ) ) ) ) - end - - # function to perform rubyshirt and rubypants - def rubyoutfit(text) - rubyshirt rubypants(text) - end - - # perform the Rails safe-proofing filter and then perform the typography filters - def th(text) - rubyoutfit(h(text)) - end - - # alias the rubyshirt method to make views cleaner - alias_method :t, :rubyoutfit + # uses RubyPants to transform various typographical thingys to proper HTML entities + # requires the RubyPants gem http://www.gemjack.com/gems/rubypants-0.2.0/classes/RubyPants.html + # Based on SmartyPants http://daringfireball.net/projects/smartypants + def rubypants(text) + require 'rubygems' + require 'rubypants' + RubyPants.new(text).to_html + end + + # main function to do all the functions from the method + def rubyshirt(text) + initial_quotes( amp( caps( widont( text ) ) ) ) + end + + # function to perform rubyshirt and rubypants + def rubyoutfit(text) + rubyshirt rubypants(text) + end + + # perform the Rails safe-proofing filter and then perform the typography filters + def th(text) + rubyoutfit(h(text)) + end + + # alias the rubyshirt method to make views cleaner + alias_method :t, :rubyoutfit end \ No newline at end of file lib/typography_helper.rb @@ -6,70 +6,70 @@ require 'rubypants' class TypographyHelperTest < Test::Unit::TestCase - # Explicitly include the module - include TypographyHelper + # Explicitly include the module + include TypographyHelper - def setup - @test_string1 = "<p>OU & UT</p>" - @test_string2 = "<p>'Meeting at 9 P.M.'</p>" - @test_string3 = '<p>eat at <a class="some_class">joe\'s</a></p>' - @test_string4 = '<h2>Standard HTML Header Tag -- fun</h2>' - @test_string5 = '<h1>this is THE title</h1><p>"this is a paragraph"</p>' - @test_string6 = '<a href="http://topfunky.com/clients/peepcode/REST-cheatsheet.pdf">Handy Cheat Sheet</a>' - @test_string7 = '<code>Test CAPS and & in code</code> & and CAPS outside' - @test_string8 = '<p>Testing closing inline tag with a space after it <span>span</span> </p>' - end + def setup + @test_string1 = "<p>OU & UT</p>" + @test_string2 = "<p>'Meeting at 9 P.M.'</p>" + @test_string3 = '<p>eat at <a class="some_class">joe\'s</a></p>' + @test_string4 = '<h2>Standard HTML Header Tag -- fun</h2>' + @test_string5 = '<h1>this is THE title</h1><p>"this is a paragraph"</p>' + @test_string6 = '<a href="http://topfunky.com/clients/peepcode/REST-cheatsheet.pdf">Handy Cheat Sheet</a>' + @test_string7 = '<code>Test CAPS and & in code</code> & and CAPS outside' + @test_string8 = '<p>Testing closing inline tag with a space after it <span>span</span> </p>' + end - def test_amp - assert_equal '<p>OU <span class="amp">&</span> UT</p>', amp(@test_string1) - assert_equal '<p>\'Meeting at 9 P.M.\'</p>', amp(@test_string2) - assert_equal '<p>eat at <a class="some_class">joe\'s</a></p>', amp(@test_string3) - assert_equal '<h2>Standard HTML Header Tag -- fun</h2>', amp(@test_string4) - assert_equal '<h1>this is THE title</h1><p>"this is a paragraph"</p>', amp(@test_string5) - assert_equal '<code>Test CAPS and & in code</code> <span class="amp">&</span> and CAPS outside', amp(@test_string7) - end + def test_amp + assert_equal '<p>OU <span class="amp">&</span> UT</p>', amp(@test_string1) + assert_equal '<p>\'Meeting at 9 P.M.\'</p>', amp(@test_string2) + assert_equal '<p>eat at <a class="some_class">joe\'s</a></p>', amp(@test_string3) + assert_equal '<h2>Standard HTML Header Tag -- fun</h2>', amp(@test_string4) + assert_equal '<h1>this is THE title</h1><p>"this is a paragraph"</p>', amp(@test_string5) + assert_equal '<code>Test CAPS and & in code</code> <span class="amp">&</span> and CAPS outside', amp(@test_string7) + end - def test_caps - assert_equal '<p><span class="caps">OU</span> & <span class="caps">UT</span></p>', caps(@test_string1) - assert_equal '<p>\'Meeting at 9 <span class="caps">P.M.</span>\'</p>', caps(@test_string2) - assert_equal '<p>eat at <a class="some_class">joe\'s</a></p>', caps(@test_string3) - assert_equal '<h2>Standard <span class="caps">HTML</span> Header Tag -- fun</h2>', caps(@test_string4) - assert_equal '<h1>this is <span class="caps">THE</span> title</h1><p>"this is a paragraph"</p>', caps(@test_string5) - assert_equal '<a href="http://topfunky.com/clients/peepcode/REST-cheatsheet.pdf">Handy Cheat Sheet</a>', caps(@test_string6) - assert_equal '<code>Test CAPS and & in code</code> & and <span class="caps">CAPS</span> outside', caps(@test_string7) - end + def test_caps + assert_equal '<p><span class="caps">OU</span> & <span class="caps">UT</span></p>', caps(@test_string1) + assert_equal '<p>\'Meeting at 9 <span class="caps">P.M.</span>\'</p>', caps(@test_string2) + assert_equal '<p>eat at <a class="some_class">joe\'s</a></p>', caps(@test_string3) + assert_equal '<h2>Standard <span class="caps">HTML</span> Header Tag -- fun</h2>', caps(@test_string4) + assert_equal '<h1>this is <span class="caps">THE</span> title</h1><p>"this is a paragraph"</p>', caps(@test_string5) + assert_equal '<a href="http://topfunky.com/clients/peepcode/REST-cheatsheet.pdf">Handy Cheat Sheet</a>', caps(@test_string6) + assert_equal '<code>Test CAPS and & in code</code> & and <span class="caps">CAPS</span> outside', caps(@test_string7) + end - def test_widont - assert_equal '<p>OU & UT</p>', widont(@test_string1) - assert_equal '<p>\'Meeting at 9 P.M.\'</p>', widont(@test_string2) - assert_equal '<p>eat at <a class="some_class">joe\'s</a></p>', widont(@test_string3) - assert_equal '<h2>Standard HTML Header Tag -- fun</h2>', widont(@test_string4) - assert_equal '<h1>this is THE title</h1><p>"this is a paragraph"</p>', widont(@test_string5) - assert_equal '<p>Testing closing inline tag with a space after it <span>span</span> </p>', widont(@test_string8) - end + def test_widont + assert_equal '<p>OU & UT</p>', widont(@test_string1) + assert_equal '<p>\'Meeting at 9 P.M.\'</p>', widont(@test_string2) + assert_equal '<p>eat at <a class="some_class">joe\'s</a></p>', widont(@test_string3) + assert_equal '<h2>Standard HTML Header Tag -- fun</h2>', widont(@test_string4) + assert_equal '<h1>this is THE title</h1><p>"this is a paragraph"</p>', widont(@test_string5) + assert_equal '<p>Testing closing inline tag with a space after it <span>span</span> </p>', widont(@test_string8) + end - def test_inital_quotes - assert_equal '<p>OU & UT</p>', initial_quotes(@test_string1) - assert_equal '<p><span class="quo">\'</span>Meeting at 9 P.M.\'</p>', initial_quotes(@test_string2) - assert_equal '<p>eat at <a class="some_class">joe\'s</a></p>', initial_quotes(@test_string3) - assert_equal '<h2>Standard HTML Header Tag -- fun</h2>', initial_quotes(@test_string4) - assert_equal '<h1>this is THE title</h1><p><span class="dquo">"</span>this is a paragraph"</p>', initial_quotes(@test_string5) - end - - def test_rubypants - assert_equal '<p>OU & UT</p>', rubypants(@test_string1) - assert_equal '<p>‘Meeting at 9 P.M.’</p>', rubypants(@test_string2) - assert_equal '<p>eat at <a class="some_class">joe’s</a></p>', rubypants(@test_string3) - assert_equal '<h2>Standard HTML Header Tag – fun</h2>', rubypants(@test_string4) - assert_equal '<h1>this is THE title</h1><p>“this is a paragraph”</p>', rubypants(@test_string5) - end + def test_inital_quotes + assert_equal '<p>OU & UT</p>', initial_quotes(@test_string1) + assert_equal '<p><span class="quo">\'</span>Meeting at 9 P.M.\'</p>', initial_quotes(@test_string2) + assert_equal '<p>eat at <a class="some_class">joe\'s</a></p>', initial_quotes(@test_string3) + assert_equal '<h2>Standard HTML Header Tag -- fun</h2>', initial_quotes(@test_string4) + assert_equal '<h1>this is THE title</h1><p><span class="dquo">"</span>this is a paragraph"</p>', initial_quotes(@test_string5) + end + + def test_rubypants + assert_equal '<p>OU & UT</p>', rubypants(@test_string1) + assert_equal '<p>‘Meeting at 9 P.M.’</p>', rubypants(@test_string2) + assert_equal '<p>eat at <a class="some_class">joe’s</a></p>', rubypants(@test_string3) + assert_equal '<h2>Standard HTML Header Tag – fun</h2>', rubypants(@test_string4) + assert_equal '<h1>this is THE title</h1><p>“this is a paragraph”</p>', rubypants(@test_string5) + end - def test_outfit - assert_equal '<p><span class="caps">OU</span> <span class="amp">&</span> <span class="caps">UT</span></p>', rubyoutfit(@test_string1) - assert_equal '<p><span class="quo">‘</span>Meeting at 9 <span class="caps">P.M.</span>’</p>', rubyoutfit(@test_string2) - assert_equal '<p>eat at <a class="some_class">joe’s</a></p>', rubyoutfit(@test_string3) - assert_equal '<h2>Standard <span class="caps">HTML</span> Header Tag – fun</h2>', rubyoutfit(@test_string4) - assert_equal '<h1>this is <span class="caps">THE</span> title</h1><p><span class="dquo">“</span>this is a paragraph”</p>', rubyoutfit(@test_string5) - end + def test_outfit + assert_equal '<p><span class="caps">OU</span> <span class="amp">&</span> <span class="caps">UT</span></p>', rubyoutfit(@test_string1) + assert_equal '<p><span class="quo">‘</span>Meeting at 9 <span class="caps">P.M.</span>’</p>', rubyoutfit(@test_string2) + assert_equal '<p>eat at <a class="some_class">joe’s</a></p>', rubyoutfit(@test_string3) + assert_equal '<h2>Standard <span class="caps">HTML</span> Header Tag – fun</h2>', rubyoutfit(@test_string4) + assert_equal '<h1>this is <span class="caps">THE</span> title</h1><p><span class="dquo">“</span>this is a paragraph”</p>', rubyoutfit(@test_string5) + end end test/typography_helper_test.rb eb2c85e9f8d4fd5496ca2ca4edf02a57eb757eed brandonaaron brandon.aaron@gmail.com http://github.com/brandonaaron/typography-helper/commit/32964b8c49bb97eeebd15d0623d2de462bccf5e2 32964b8c49bb97eeebd15d0623d2de462bccf5e2

2009-02-27T12:56:58-08:00

switching tabs to spaces 155e9facbc95688b50c78af6df028ece70e5817b brandonaaron brandon.aaron@gmail.com