rubypants 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 505ccfdec7463152b84a66f2d0c0b6ee4df7d958
-  data.tar.gz: 8e04eed0de2037978c2733121d4021f96b6fffb7
+  metadata.gz: 0b29b8d72353258ac6b847c78c77fedaa8a9cb33
+  data.tar.gz: 965af58a1f2e7770e5a76a748e7ad564f6e24335
 SHA512:
-  metadata.gz: d87f017e65610d9c582195716164ecfef7006d4125b1754f0901b269a32f54232fa139c06c6cd1797748222e303f007e32857cdf6b2b3133dc58f4e3a7588acc
-  data.tar.gz: 07b29cb1837778b5c54bc18e6345f8202c51366d42f51c6d5436008b2e54da9d79de6a7c5bb601fefe854f0f9c04da936f0abd1b87315b6649ac8d9f6d44b952
+  metadata.gz: 7e8c42ca85e3a117f954311cbb016779329c9e390200a70244fd2f5828959a60d4226a924ae777904032ea756f4b774367c9ddd578b241621ce18b5ff1a33f4c
+  data.tar.gz: 4456339e90147d4887917441d9400f17f1cb0f5df3a45e2528629eed88ed5da309eb99b6d0dff70819538ff1966d8351d6dd2d3e3bb3ad5ab630868db759f6f4

data/lib/rubypants/core.rb

@@ -48,7 +48,7 @@ class RubyPants < String
   # Apply SmartyPants transformations.
   def to_html
     do_quotes = do_backticks = do_dashes = do_ellipses = do_stupify = nil
-    convert_quotes = false
+    convert_quotes = prevent_breaks = nil
 
     if @options.include?(0)
       # Do nothing.
@@ -68,18 +68,20 @@ class RubyPants < String
       do_dashes = :inverted
     elsif @options.include?(-1)
       do_stupefy = true
-    else
-      do_quotes      = @options.include?(:quotes)
-      do_backticks   = @options.include?(:backticks)
-      do_backticks   = :both if @options.include?(:allbackticks)
-      do_dashes      = :normal if @options.include?(:dashes)
-      do_dashes      = :oldschool if @options.include?(:oldschool)
-      do_dashes      = :inverted if @options.include?(:inverted)
-      do_ellipses    = @options.include?(:ellipses)
-      convert_quotes = @options.include?(:convertquotes)
-      do_stupefy     = @options.include?(:stupefy)
     end
 
+    # Explicit flags override numeric flag groups.
+    do_quotes      = true if @options.include?(:quotes)
+    do_backticks   = true if @options.include?(:backticks)
+    do_backticks   = :both if @options.include?(:allbackticks)
+    do_dashes      = :normal if @options.include?(:dashes)
+    do_dashes      = :oldschool if @options.include?(:oldschool)
+    do_dashes      = :inverted if @options.include?(:inverted)
+    prevent_breaks = true if @options.include?(:prevent_breaks)
+    do_ellipses    = true if @options.include?(:ellipses)
+    convert_quotes = true if @options.include?(:convertquotes)
+    do_stupefy     = true if @options.include?(:stupefy)
+
     # Parse the HTML
     tokens = tokenize
 
@@ -119,12 +121,12 @@ class RubyPants < String
           t.gsub!(/&quot;/, '"')  if convert_quotes
 
           if do_dashes
-            t = educate_dashes t            if do_dashes == :normal
-            t = educate_dashes_oldschool t  if do_dashes == :oldschool
-            t = educate_dashes_inverted t   if do_dashes == :inverted
+            t = educate_dashes t, prevent_breaks            if do_dashes == :normal
+            t = educate_dashes_oldschool t, prevent_breaks  if do_dashes == :oldschool
+            t = educate_dashes_inverted t, prevent_breaks   if do_dashes == :inverted
           end
 
-          t = educate_ellipses t  if do_ellipses
+          t = educate_ellipses t, prevent_breaks  if do_ellipses
 
           # Note: backticks need to be processed before quotes.
           if do_backticks
@@ -195,22 +197,38 @@ class RubyPants < String
   DOUBLE_DASH = n_of(2, '-')
   TRIPLE_DASH = n_of(3, '-')
 
-  # The string, with each instance of "<tt>--</tt>" translated to an
+  # Return +str+ replacing all +patt+ with +repl+. If +prevent_breaks+ is true,
+  # then replace spaces preceding +patt+ with a non-breaking space, and if there
+  # are no spaces, then insert a word-joiner.
+  #
+  def educate(str, patt, repl, prevent_breaks)
+    patt = /(?<spaces>[[:space:]]*)#{patt}/
+    str.gsub(patt) do
+      spaces = if prevent_breaks && $~['spaces'].length > 0
+                 entity(:non_breaking_space) # * $~['spaces'].length
+               elsif prevent_breaks
+                 entity(:word_joiner)
+               else
+                 $~['spaces']
+               end
+      spaces + repl
+    end
+  end
+
+  # Return the string, with each instance of "<tt>--</tt>" translated to an
   # em-dash HTML entity.
   #
-  def educate_dashes(str)
-    str.
-      gsub(DOUBLE_DASH, entity(:em_dash))
+  def educate_dashes(str, prevent_breaks=false)
+    educate(str, DOUBLE_DASH, entity(:em_dash), prevent_breaks)
   end
 
-  # The string, with each instance of "<tt>--</tt>" translated to an
+  # Return the string, with each instance of "<tt>--</tt>" translated to an
   # en-dash HTML entity, and each "<tt>---</tt>" translated to an
   # em-dash HTML entity.
   #
-  def educate_dashes_oldschool(str)
-    str.
-      gsub(TRIPLE_DASH, entity(:em_dash)).
-      gsub(DOUBLE_DASH, entity(:en_dash))
+  def educate_dashes_oldschool(str, prevent_breaks=false)
+    str = educate(str, TRIPLE_DASH, entity(:em_dash), prevent_breaks)
+    educate(str, DOUBLE_DASH, entity(:en_dash), prevent_breaks)
   end
 
   # Return the string, with each instance of "<tt>--</tt>" translated
@@ -223,20 +241,19 @@ class RubyPants < String
   # sense that the shortcut should be shorter to type. (Thanks to
   # Aaron Swartz for the idea.)
   #
-  def educate_dashes_inverted(str)
-    str.
-      gsub(TRIPLE_DASH, entity(:en_dash)).
-      gsub(DOUBLE_DASH, entity(:em_dash))
+  def educate_dashes_inverted(str, prevent_breaks=false)
+    str = educate(str, TRIPLE_DASH, entity(:en_dash), prevent_breaks)
+    educate(str, DOUBLE_DASH, entity(:em_dash), prevent_breaks)
   end
 
   # Return the string, with each instance of "<tt>...</tt>" translated
   # to an ellipsis HTML entity. Also converts the case where there are
   # spaces between the dots.
   #
-  def educate_ellipses(str)
-    str.
-      gsub(RubyPants.n_of(3, '.'), entity(:ellipsis)).
-      gsub(/(?<!\.|\. )\. \. \.(?!\.| \.)/, entity(:ellipsis))
+  def educate_ellipses(str, prevent_breaks=false)
+    str = educate(str, RubyPants.n_of(3, '.'), entity(:ellipsis), prevent_breaks)
+    educate(str, /(?<!\.|\.[[:space:]])\.[[:space:]]\.[[:space:]]\.(?!\.|[[:space:]]\.)/,
+            entity(:ellipsis), prevent_breaks)
   end
 
   # Return the string, with "<tt>``backticks''</tt>"-style single quotes
@@ -353,7 +370,7 @@ class RubyPants < String
   # Chad Miller in the Python port of SmartyPants.
   #
   def tokenize
-    tag_soup = /([^<]*)(<!--.*?-->|<[^>]*>)/
+    tag_soup = /([^<]*)(<!--.*?-->|<[^>]*>)/m
 
     tokens = []
 
@@ -381,7 +398,9 @@ class RubyPants < String
       :em_dash            => "&#8212;",
       :en_dash            => "&#8211;",
       :ellipsis           => "&#8230;",
-      :html_quote         => "&quot;"
+      :html_quote         => "&quot;",
+      :non_breaking_space => "&nbsp;",
+      :word_joiner        => "&#65279;",
     }
   end
 

data/lib/rubypants/version.rb

@@ -1,3 +1,3 @@
 class RubyPants
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/test/rubypants_test.rb

@@ -74,22 +74,53 @@ EOF
     assert_rp_equal "--foo--bar--quux--",
                     '—foo—bar—quux—', 1
 
+    assert_rp_equal "foo--bar", 'foo—bar', [1, :prevent_breaks]
+    assert_rp_equal "foo --bar", 'foo —bar', 1
+    assert_rp_equal "foo --bar", 'foo —bar', [1, :prevent_breaks]
+    assert_rp_equal "foo -- bar", 'foo — bar', [1, :prevent_breaks]
+    assert_rp_equal "foo  --bar", 'foo —bar', [1, :prevent_breaks]
+
     assert_rp_equal "foo--bar", 'foo–bar', 2
     assert_rp_equal "foo---bar", 'foo—bar', 2
     assert_rp_equal "foo----bar", 'foo----bar', 2
     assert_rp_equal "--foo--bar--quux--",
                     '–foo–bar–quux–', 2
 
+    assert_rp_equal "foo--bar", 'foo–bar', [2, :prevent_breaks]
+    assert_rp_equal "foo --bar", 'foo –bar', 2
+    assert_rp_equal "foo --bar", 'foo –bar', [2, :prevent_breaks]
+    assert_rp_equal "foo -- bar", 'foo – bar', [2, :prevent_breaks]
+    assert_rp_equal "foo  --bar", 'foo –bar', [2, :prevent_breaks]
+
+    assert_rp_equal "foo---bar", 'foo—bar', [2, :prevent_breaks]
+    assert_rp_equal "foo ---bar", 'foo —bar', 2
+    assert_rp_equal "foo ---bar", 'foo —bar', [2, :prevent_breaks]
+    assert_rp_equal "foo --- bar", 'foo — bar', [2, :prevent_breaks]
+    assert_rp_equal "foo  ---bar", 'foo —bar', [2, :prevent_breaks]
+
     assert_rp_equal "foo--bar", 'foo—bar', 3
     assert_rp_equal "foo---bar", 'foo–bar', 3
     assert_rp_equal "foo----bar", 'foo----bar', 3
     assert_rp_equal "--foo--bar--quux--",
                     '—foo—bar—quux—', 3
+
+    assert_rp_equal "foo--bar", 'foo—bar', [3, :prevent_breaks]
+    assert_rp_equal "foo --bar", 'foo —bar', 3
+    assert_rp_equal "foo --bar", 'foo —bar', [3, :prevent_breaks]
+    assert_rp_equal "foo -- bar", 'foo — bar', [3, :prevent_breaks]
+    assert_rp_equal "foo  --bar", 'foo —bar', [3, :prevent_breaks]
+
+    assert_rp_equal "foo---bar", 'foo–bar', [3, :prevent_breaks]
+    assert_rp_equal "foo ---bar", 'foo –bar', 3
+    assert_rp_equal "foo ---bar", 'foo –bar', [3, :prevent_breaks]
+    assert_rp_equal "foo --- bar", 'foo – bar', [3, :prevent_breaks]
+    assert_rp_equal "foo  ---bar", 'foo –bar', [3, :prevent_breaks]
   end
 
   def test_html_comments
     assert_verbatim "<!-- comment -->"
     assert_verbatim "<!-- <p>foo bar</p> -->"
+    assert_verbatim "<!-- <p>foo\nbar</p> -->"
     assert_rp_equal "--<!-- -- -->--", '&#8211;<!-- -- -->&#8211;'
   end
 
@@ -100,20 +131,33 @@ EOF
   end
 
   def test_ellipses
-    assert_rp_equal "foo..bar", 'foo..bar'
-    assert_rp_equal "foo...bar", 'foo&#8230;bar'
-    assert_rp_equal "foo....bar", 'foo....bar'
+    assert_rp_equal "foo..bar", 'foo..bar', [:ellipses]
+    assert_rp_equal "foo...bar", 'foo&#8230;bar', [:ellipses]
+    assert_rp_equal "foo....bar", 'foo....bar', [:ellipses]
+    # and with :prevent_breaks
+    assert_rp_equal "foo..bar", 'foo..bar', [:ellipses, :prevent_breaks]
+    assert_rp_equal "foo...bar", 'foo&#65279;&#8230;bar', [:ellipses, :prevent_breaks]
+    assert_rp_equal "foo....bar", 'foo....bar', [:ellipses, :prevent_breaks]
 
     # dots and spaces
-    assert_rp_equal "foo. . .bar", 'foo&#8230;bar'
-    assert_rp_equal "foo . . . bar", 'foo &#8230; bar'
-    assert_rp_equal "foo. . . .bar", 'foo. . . .bar'
-    assert_rp_equal "foo . . . . bar", 'foo . . . . bar'
-
-    # Nasty ones
-    assert_rp_equal "foo. . ..bar", 'foo. . ..bar'
-    assert_rp_equal "foo. . ...bar", 'foo. . &#8230;bar'
-    assert_rp_equal "foo. . ....bar", 'foo. . ....bar'
+    assert_rp_equal "foo. . .bar", 'foo&#8230;bar', [:ellipses]
+    assert_rp_equal "foo . . . bar", 'foo &#8230; bar', [:ellipses]
+    assert_rp_equal "foo. . . .bar", 'foo. . . .bar', [:ellipses]
+    assert_rp_equal "foo . . . . bar", 'foo . . . . bar', [:ellipses]
+    # and with :prevent_breaks
+    assert_rp_equal "foo. . .bar", 'foo&#65279;&#8230;bar', [:ellipses, :prevent_breaks]
+    assert_rp_equal "foo . . . bar", 'foo&nbsp;&#8230; bar', [:ellipses, :prevent_breaks]
+    assert_rp_equal "foo. . . .bar", 'foo. . . .bar', [:ellipses, :prevent_breaks]
+    assert_rp_equal "foo . . . . bar", 'foo . . . . bar', [:ellipses, :prevent_breaks]
+
+    # nasty ones
+    assert_rp_equal "foo. . ..bar", 'foo. . ..bar', [:ellipses]
+    assert_rp_equal "foo. . ...bar", 'foo. . &#8230;bar', [:ellipses]
+    assert_rp_equal "foo. . ....bar", 'foo. . ....bar', [:ellipses]
+    # and with :prevent_breaks
+    assert_rp_equal "foo. . ..bar", 'foo. . ..bar', [:ellipses, :prevent_breaks]
+    assert_rp_equal "foo. . ...bar", 'foo. .&nbsp;&#8230;bar', [:ellipses, :prevent_breaks]
+    assert_rp_equal "foo. . ....bar", 'foo. . ....bar', [:ellipses, :prevent_breaks]
   end
 
   def test_backticks

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubypants
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - John Gruber
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-06 00:00:00.000000000 Z
+date: 2016-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -67,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: RubyPants is a Ruby port of the smart-quotes library SmartyPants.