typogruby 1.0.10 → 1.0.11

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    typogruby (1.0.10)
+    typogruby (1.0.11)
       rubypants
 
 GEM

data/HISTORY.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.0.11
+
+* Excluded more typography-sensitive tags from filtering (thanks Justin Hileman)
+
 ## 1.0.10
 
 * Decoupled jeweler, which is no longer a dependency.

data/README.md

@@ -57,9 +57,13 @@ See HISTORY.md for the complete changelog.
 
 By Arjan van der Gaag ([avdgaag @ github][6]) based on the hard work of lots of others. See LICENSE for license details (same as Ruby).
 
+This gem includes contributions by:
+
+* Justin Hileman
+
 [1]: http://jeffcroft.com/blog/2007/may/29/typogrify-easily-produce-web-typography-doesnt-suc/
 [2]: http://github.com/hunter/typography-helper
 [3]: http://code.google.com/p/typogrify
 [4]: http://avdgaag.github.com/typogruby
 [5]: http://github.com/avdgaag/Typography-tmbundle
-[6]: http://github.com/avdgaag
+[6]: http://github.com/avdgaag

data/lib/typogruby.rb

@@ -57,7 +57,7 @@ module Typogruby
   # @return [String] input text with ampersands wrapped
   def amp(text)
     # $1 is an excluded HTML tag, $2 is the part before the caps and $3 is the amp match
-    ignore_scripts(text) do |t|
+    exclude_sensitive_tags(text) do |t|
       t.gsub(/<(code|pre).+?<\/\1>|(\s|&nbsp;)&(?:amp;|#38;)?(\s|&nbsp;)/) { |str|
         $1 ? str : $2 + '<span class="amp">&amp;</span>' + $3
       }.gsub(/(\w+)="(.*?)<span class="amp">&amp;<\/span>(.*?)"/, '\1="\2&amp;\3"')
@@ -108,7 +108,7 @@ module Typogruby
   # @param [String] text input text
   # @return [String] input text with non-breaking spaces inserted
   def widont(text)
-    ignore_scripts(text) do |t|
+    exclude_sensitive_tags(text) do |t|
       t.gsub(%r{
         ((?:</?(?:a|em|span|strong|i|b)[^>]*>)|[^<>\s]) # must be proceeded by an approved inline opening or closing tag or a nontag/nonspace
         \s+                                             # the space to replace
@@ -144,7 +144,7 @@ module Typogruby
   # @param [String] text input text
   # @return [String] input text with caps wrapped
   def caps(text)
-    ignore_scripts(text) do |t|
+    exclude_sensitive_tags(text) do |t|
       # $1 and $2 are excluded HTML tags, $3 is the part before the caps and $4 is the caps match
       t.gsub(%r{
           (?i:<(code|pre).+?</\1>)|     # Ignore the contents of code and pre elements
@@ -190,7 +190,7 @@ module Typogruby
   # @return [String] input text with initial quotes wrapped
   def initial_quotes(text)
     # $1 is the initial part of the string, $2 is the quote or entitity, and $3 is the double quote
-    ignore_scripts(text) do |t|
+    exclude_sensitive_tags(text) do |t|
       t.gsub(/((?:<(?:h[1-6]|p|li|dt|dd)[^>]*>|^)\s*(?:<(?:a|em|strong|span)[^>]*>)?)('|&#8216;|&lsquo;|("|&#8220;|&ldquo;))/) {$1 + "<span class=\"#{'d' if $3}quo\">#{$2}</span>"}
     end
   end
@@ -254,29 +254,36 @@ private
     end
   end
 
-  # Hackish text filter that will make sure our text filters leave inline
-  # javascript alone without resorting to a full-blown HTML parser.
+  # Hackish text filter that will make sure our text filters leave 
+  # sensitive tags alone without resorting to a full-blown HTML parser.
+  #
+  # Sensitive tags are tags with literal contents, which we do not
+  # want to change. It currently ignores: <pre>, <code>, <kbd>, <math>
+  # and <script>.
   #
   # The idea is simple: every text filter is applied as a block to this
-  # method. This will preprocess the text and replace any inline scripts
+  # method. This will preprocess the text and replace any sensitive tags
   # with a MD5 hash of its entire contents. Then the filter is called,
   # and then the hashes are replaced back with their original content.
   #
-  # @yield [hashed_text] Hands you the input text with all script tags
+  # @yield [hashed_text] Hands you the input text with all sensitive tags
   #   hashed. The block's result will be unhashed and then returned.
   # @param [String] text
-  # @return [String] input with script tags restored
-  def ignore_scripts(text)
-    @ignored_scripts = {}
-    modified_text = text.gsub(/<script[^>]*>.*?<\/script>/mi) do |script|
+  # @return [String] input with sensitive tags restored
+  def exclude_sensitive_tags(text)
+    @exluded_sensitive_tags = {}
+    modified_text = text.gsub(/<(#{EXCLUDED_TAGS .join('|')})[^>]*>.*?<\/\1>/mi) do |script|
       hash = Digest::MD5.hexdigest(script)
-      @ignored_scripts[hash] = script
+      @exluded_sensitive_tags[hash] = script
       hash
     end
-    yield(modified_text).gsub(/#{@ignored_scripts.keys.join('|')}/) do |h|
-      @ignored_scripts.delete(h)
+    yield(modified_text).gsub(/#{@exluded_sensitive_tags.keys.join('|')}/) do |h|
+      @exluded_sensitive_tags.delete(h)
     end
   end
 
+  # Array of all the senstive tags that should be ignored by all the text filters.
+  EXCLUDED_TAGS  = %w{pre code kbd math script}
+
   extend self
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Typogruby
-  VERSION = '1.0.10'
+  VERSION = '1.0.11'
 end

data/test/test_typogruby.rb

@@ -97,4 +97,11 @@ class TestTypogruby < Test::Unit::TestCase
     assert_equal "Vari&euml;ren&hellip;", entities('Variëren…')
     assert_equal "<p>Ol&eacute;</p>", entities('<p>Olé</p>')
   end
+
+  def test_should_leave_sensitive_tags_alone
+    %w{script pre code kbd math}.each do |tag_name|
+      test_string = "<#{tag_name}>“CAPS & chårs” and widows</#{tag_name}>"
+      assert_equal test_string, improve(test_string)
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: typogruby
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: 
   segments: 
   - 1
   - 0
-  - 10
-  version: 1.0.10
+  - 11
+  version: 1.0.11
 platform: ruby
 authors: 
 - Arjan van der Gaag
@@ -15,13 +15,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-15 00:00:00 +01:00
+date: 2011-02-24 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rubypants
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  type: :runtime
+  name: rubypants
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -30,12 +31,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
-  version_requirements: *id001
+  requirement: *id001
 - !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  type: :development
+  name: yard
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -44,12 +45,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  version_requirements: *id002
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  type: :development
+  name: rake
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -58,12 +59,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  version_requirements: *id003
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
-  name: aruba
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  type: :development
+  name: aruba
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -72,12 +73,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  version_requirements: *id004
+  requirement: *id004
 - !ruby/object:Gem::Dependency 
-  name: cucumber
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  type: :development
+  name: cucumber
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -86,12 +87,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  version_requirements: *id005
+  requirement: *id005
 - !ruby/object:Gem::Dependency 
-  name: rcov
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  type: :development
+  name: rcov
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -100,12 +101,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  version_requirements: *id006
+  requirement: *id006
 - !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  type: :development
+  name: rspec
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -114,12 +115,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  version_requirements: *id007
+  requirement: *id007
 - !ruby/object:Gem::Dependency 
-  name: bluecloth
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  type: :development
+  name: bluecloth
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -128,8 +129,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  version_requirements: *id008
+  requirement: *id008
 description: Improve web typography using various text filters. This gem prevents widows and applies markup to ampersans, consecutive capitals and initial quotes.
 email: arjan@arjanvandergaag.nl
 executables: