rubypants 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8dc4efc96c1fe85653d5cfb4f6d0291a94edcdbc
-  data.tar.gz: b17cda053df199efe900caed483404b903345f9c
+SHA256:
+  metadata.gz: 766f0400e12ec2e5bb64917568fcf5dba1b7fdf7e31632c62144602e0b1bd674
+  data.tar.gz: 87de02ec38116b4d9d179e80f958f608101565a9724f63a751e7efb642dab7ff
 SHA512:
-  metadata.gz: eaebe94dfee7f1ef9295910593ff64e0b10a5147ab96e802e7ce98031a15ee4e6c78ae7ee45ccadccaeb30d2c86d96692a2625733bb6e3f7edcda3ecd995c1a6
-  data.tar.gz: 3eabe14d2d081f67239047c29d7d71e93025622cdd3f562b1f3fd2b83a26cddea359e2fbc8a20d3f9ca9f0c855c12c4fe3f76e16442e6f2898a6dc346f2e6f4e
+  metadata.gz: 543191639285ce9c53716b19fcbfa72dd6b14e96f53cb88b87a62f5cf4446725ceeb384c6ea3c7767c97409195d7e5cb11c8694d06eb93545284b230b2407bf0
+  data.tar.gz: ed420062908b83fa18c96bb8048870095350f4d9b45ac2294939a9265f775c04a1aa4c5d7e40ed8b3bee741a013103be0bf218e4d18e4e0e59dbbe3eb6cd2fc0

data/.travis.yml

@@ -1,8 +1,7 @@
 rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3.0
+  - 2.4
+  - 2.5
+  - 2.6
   - jruby
 
 # Workaround for `NoMethodError: undefined method 'spec' for nil:NilClass`,

data/lib/rubypants.rb

@@ -70,12 +70,23 @@ class RubyPants < String
 
     @options = [*options]
     @entities = default_entities
-    @entities.merge!(named_entities) if @options.include?(:named_entities)
+    @entities.merge!(named_entities)     if @options.include?(:named_entities)
     @entities.merge!(character_entities) if @options.include?(:character_entities)
-    @entities.merge!(character_spaces) if @options.include?(:character_spaces)
+    @entities.merge!(character_spaces)   if @options.include?(:character_spaces)
     @entities.merge!(entities)
+
+    @single_left_quote  = @entities[:single_left_quote]
+    @single_right_quote = @entities[:single_right_quote]
+    @double_left_quote  = @entities[:double_left_quote]
+    @double_right_quote = @entities[:double_right_quote]
+    @ellipsis           = @entities[:ellipsis]
+    @em_dash            = @entities[:em_dash]
+    @en_dash            = @entities[:en_dash]
   end
 
+  SPECIAL_HTML_TAGS = %r!\A<(/?)(pre|code|kbd|script|style|math)[\s>]!
+  NON_WHITESPACE_CHARS = /\S/
+
   # Apply SmartyPants transformations.
   def to_html
     do_quotes = do_backticks = do_dashes = do_ellipses = do_stupify = nil
@@ -102,16 +113,16 @@ class RubyPants < String
     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_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)
+    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
@@ -133,7 +144,7 @@ class RubyPants < String
         result << token[1]
         if token[1].end_with? '/>'
           # ignore self-closing tags
-        elsif token[1] =~ %r!\A<(/?)(pre|code|kbd|script|style|math)[\s>]!
+        elsif token[1] =~ SPECIAL_HTML_TAGS
           if $1 == '' && ! in_pre
             in_pre = $2
           elsif $1 == '/' && $2 == in_pre
@@ -149,36 +160,36 @@ class RubyPants < String
         unless in_pre
           t = process_escapes t
 
-          t.gsub!(/&quot;/, '"')  if convert_quotes
+          t.gsub!('&quot;', '"') if convert_quotes
 
           if do_dashes
-            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
+            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, prevent_breaks  if do_ellipses
+          t = educate_ellipses t, prevent_breaks if do_ellipses
 
           # Note: backticks need to be processed before quotes.
           if do_backticks
             t = educate_backticks t
-            t = educate_single_backticks t  if do_backticks == :both
+            t = educate_single_backticks t if do_backticks == :both
           end
 
           if do_quotes
             if t == "'"
               # Special case: single-character ' token
-              if prev_token_last_char =~ /\S/
-                t = entity(:single_right_quote)
+              if prev_token_last_char =~ NON_WHITESPACE_CHARS
+                t = @single_right_quote
               else
-                t = entity(:single_left_quote)
+                t = @single_left_quote
               end
             elsif t == '"'
               # Special case: single-character " token
-              if prev_token_last_char =~ /\S/
-                t = entity(:double_right_quote)
+              if prev_token_last_char =~ NON_WHITESPACE_CHARS
+                t = @double_right_quote
               else
-                t = entity(:double_left_quote)
+                t = @double_left_quote
               end
             else
               # Normal case:
@@ -186,7 +197,7 @@ class RubyPants < String
             end
           end
 
-          t = stupefy_entities t  if do_stupefy
+          t = stupefy_entities t if do_stupefy
         end
 
         prev_token_last_char = last_char
@@ -227,6 +238,7 @@ class RubyPants < String
 
   DOUBLE_DASH = n_of(2, '-')
   TRIPLE_DASH = n_of(3, '-')
+  TRIPLE_DOTS = n_of(3, '.')
 
   # 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
@@ -250,7 +262,7 @@ class RubyPants < String
   # em-dash HTML entity.
   #
   def educate_dashes(str, prevent_breaks=false)
-    educate(str, DOUBLE_DASH, entity(:em_dash), prevent_breaks)
+    educate(str, DOUBLE_DASH, @em_dash, prevent_breaks)
   end
 
   # Return the string, with each instance of "<tt>--</tt>" translated to an
@@ -258,8 +270,8 @@ class RubyPants < String
   # em-dash HTML entity.
   #
   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)
+    str = educate(str, TRIPLE_DASH, @em_dash, prevent_breaks)
+    educate(str, DOUBLE_DASH, @en_dash, prevent_breaks)
   end
 
   # Return the string, with each instance of "<tt>--</tt>" translated
@@ -273,18 +285,20 @@ class RubyPants < String
   # Aaron Swartz for the idea.)
   #
   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)
+    str = educate(str, TRIPLE_DASH, @en_dash, prevent_breaks)
+    educate(str, DOUBLE_DASH, @em_dash, prevent_breaks)
   end
 
+  SPACED_ELLIPSIS_PATTERN = /(?<!\.|\.[ ])\.[ ]\.[ ]\.(?!\.|[ ]\.)/
+
   # 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, prevent_breaks=false)
-    str = educate(str, RubyPants.n_of(3, '.'), entity(:ellipsis), prevent_breaks)
-    educate(str, /(?<!\.|\.[[:space:]])\.[[:space:]]\.[[:space:]]\.(?!\.|[[:space:]]\.)/,
-            entity(:ellipsis), prevent_breaks)
+    str = educate(str, TRIPLE_DOTS, @ellipsis, prevent_breaks)
+    educate(str, SPACED_ELLIPSIS_PATTERN,
+            @ellipsis, prevent_breaks)
   end
 
   # Return the string, with "<tt>``backticks''</tt>"-style single quotes
@@ -292,8 +306,8 @@ class RubyPants < String
   #
   def educate_backticks(str)
     str.
-      gsub("``", entity(:double_left_quote)).
-      gsub("''", entity(:double_right_quote))
+      gsub("``", @double_left_quote).
+      gsub("''", @double_right_quote)
   end
 
   # Return the string, with "<tt>`backticks'</tt>"-style single quotes
@@ -301,66 +315,79 @@ class RubyPants < String
   #
   def educate_single_backticks(str)
     str.
-      gsub("`", entity(:single_left_quote)).
-      gsub("'", entity(:single_right_quote))
+      gsub("`", @single_left_quote).
+      gsub("'", @single_right_quote)
   end
 
+  PUNCT_CLASS = '[!"#\$\%\'()*+,\-.\/:;<=>?\@\[\\\\\]\^_`{|}~]'.freeze
+  SNGL_QUOT_PUNCT_CASE = /^'(?=#{PUNCT_CLASS}\B)/
+  DBLE_QUOT_PUNCT_CASE = /^"(?=#{PUNCT_CLASS}\B)/
+
+  STARTS_MIXED_QUOTS_WITH_SNGL = /'"(?=\w)/
+  STARTS_MIXED_QUOTS_WITH_DBLE = /"'(?=\w)/
+
+  DECADE_ABBR_CASE = /'(?=\d\ds)/
+
+  CLOSE_CLASS = '[^\ \t\r\n\\[\{\(\-]'.freeze
+  CHAR_LEADS_SNGL_QUOTE = /(#{CLOSE_CLASS})'/
+  WHITESPACE_TRAILS_SNGL_QUOTE = /'(\s|s\b|$)/
+  CHAR_LEADS_DBLE_QUOTE = /(#{CLOSE_CLASS})"/
+  WHITESPACE_TRAILS_DBLE_QUOTE = /"(\s|s\b|$)/
+
   # Return the string, with "educated" curly quote HTML entities.
   #
   def educate_quotes(str)
-    punct_class = '[!"#\$\%\'()*+,\-.\/:;<=>?\@\[\\\\\]\^_`{|}~]'
-
     str = str.dup
 
     # Special case if the very first character is a quote followed by
     # punctuation at a non-word-break. Close the quotes by brute
     # force:
-    str.gsub!(/^'(?=#{punct_class}\B)/,
-              entity(:single_right_quote))
-    str.gsub!(/^"(?=#{punct_class}\B)/,
-              entity(:double_right_quote))
+    str.gsub!(SNGL_QUOT_PUNCT_CASE,
+              @single_right_quote)
+    str.gsub!(DBLE_QUOT_PUNCT_CASE,
+              @double_right_quote)
 
     # Special case for double sets of quotes, e.g.:
     #   <p>He said, "'Quoted' words in a larger quote."</p>
-    str.gsub!(/"'(?=\w)/,
-              "#{entity(:double_left_quote)}#{entity(:single_left_quote)}")
-    str.gsub!(/'"(?=\w)/,
-              "#{entity(:single_left_quote)}#{entity(:double_left_quote)}")
+    str.gsub!(STARTS_MIXED_QUOTS_WITH_DBLE,
+              "#{@double_left_quote}#{@single_left_quote}")
+    str.gsub!(STARTS_MIXED_QUOTS_WITH_SNGL,
+              "#{@single_left_quote}#{@double_left_quote}")
 
     # Special case for decade abbreviations (the '80s):
-    str.gsub!(/'(?=\d\ds)/,
-              entity(:single_right_quote))
+    str.gsub!(DECADE_ABBR_CASE,
+              @single_right_quote)
 
-    close_class = %![^\ \t\r\n\\[\{\(\-]!
-    dec_dashes = "#{entity(:en_dash)}|#{entity(:em_dash)}"
+    dec_dashes = "#{@en_dash}|#{@em_dash}"
+    quote_precedent = "[[:space:]]|&nbsp;|--|&[mn]dash;|#{dec_dashes}|&#x201[34];"
 
     # Get most opening single quotes:
-    str.gsub!(/([[:space:]]|&nbsp;|--|&[mn]dash;|#{dec_dashes}|&#x201[34];)'(?=\w)/,
-             '\1' + entity(:single_left_quote))
+    str.gsub!(/(#{quote_precedent})'(?=\w)/,
+             '\1' + @single_left_quote)
 
     # Single closing quotes:
-    str.gsub!(/(#{close_class})'/,
-              '\1' + entity(:single_right_quote))
-    str.gsub!(/'(\s|s\b|$)/,
-              entity(:single_right_quote) + '\1')
+    str.gsub!(CHAR_LEADS_SNGL_QUOTE,
+              '\1' + @single_right_quote)
+    str.gsub!(WHITESPACE_TRAILS_SNGL_QUOTE,
+              @single_right_quote + '\1')
 
     # Any remaining single quotes should be opening ones:
-    str.gsub!(/'/,
-              entity(:single_left_quote))
+    str.gsub!("'",
+              @single_left_quote)
 
     # Get most opening double quotes:
-    str.gsub!(/([[:space:]]|&nbsp;|--|&[mn]dash;|#{dec_dashes}|&#x201[34];)"(?=\w)/,
-             '\1' + entity(:double_left_quote))
+    str.gsub!(/(#{quote_precedent})"(?=\w)/,
+             '\1' + @double_left_quote)
 
     # Double closing quotes:
-    str.gsub!(/(#{close_class})"/,
-              '\1' + entity(:double_right_quote))
-    str.gsub!(/"(\s|s\b|$)/,
-              entity(:double_right_quote) + '\1')
+    str.gsub!(CHAR_LEADS_DBLE_QUOTE,
+              '\1' + @double_right_quote)
+    str.gsub!(WHITESPACE_TRAILS_DBLE_QUOTE,
+              @double_right_quote + '\1')
 
     # Any remaining quotes should be opening ones:
-    str.gsub!(/"/,
-              entity(:double_left_quote))
+    str.gsub!('"',
+              @double_left_quote)
 
     str
   end
@@ -382,12 +409,14 @@ class RubyPants < String
       :double_right_quote => '"',
       :ellipsis           => '...'
     }.each do |k,v|
-      new_str.gsub!(/#{entity(k)}/, v)
+      new_str.gsub!(entity(k).to_s, v)
     end
 
     new_str
   end
 
+  TAG_SOUP = /([^<]*)(<!--.*?-->|<[^>]*>)/m
+
   # Return an array of the tokens comprising the string. Each token is
   # either a tag (possibly with nested, tags contained therein, such
   # as <tt><a href="<MTFoo>"></tt>, or a run of text between
@@ -401,14 +430,12 @@ class RubyPants < String
   # Chad Miller in the Python port of SmartyPants.
   #
   def tokenize
-    tag_soup = /([^<]*)(<!--.*?-->|<[^>]*>)/m
-
     tokens = []
 
     prev_end = 0
 
-    scan(tag_soup) do
-      tokens << [:text, $1]  if $1 != ""
+    scan(TAG_SOUP) do
+      tokens << [:text, $1] if $1 != ""
       tokens << [:tag, $2]
       prev_end = $~.end(0)
     end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module RubyPantsVersion
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

data/test/rubypants_test.rb

@@ -11,6 +11,10 @@ class RubyPantsTest < Minitest::Test
     assert_equal orig, RubyPants.new(str, options, entities).to_html
   end
 
+  def refute_rp_equal(str, orig, options=[2], entities = {})
+    refute_equal orig, RubyPants.new(str, options, entities).to_html
+  end
+
   def assert_verbatim(str)
     assert_rp_equal str, str
   end
@@ -152,6 +156,28 @@ EOF
     assert_rp_equal "foo. . . .bar", 'foo. . . .bar', [:ellipses, :prevent_breaks]
     assert_rp_equal "foo . . . . bar", 'foo . . . . bar', [:ellipses, :prevent_breaks]
 
+    # dots and tab-spaces
+    refute_rp_equal "foo.	.	.bar", 'foo&#8230;bar', [:ellipses]
+    refute_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
+    refute_rp_equal "foo.	.	.bar", 'foo&#8288;&#8230;bar', [:ellipses, :prevent_breaks]
+    refute_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]
+
+    # dots and line-breaks
+    refute_rp_equal "foo.\n.\n.bar", 'foo&#8230;bar', [:ellipses]
+    refute_rp_equal "foo\n.\n.\n.\nbar", "foo\n&#8230;\nbar", [:ellipses]
+    assert_rp_equal "foo.\n.\n.\n.bar", "foo.\n.\n.\n.bar", [:ellipses]
+    assert_rp_equal "foo\n.\n.\n.\n.\nbar", "foo\n.\n.\n.\n.\nbar", [:ellipses]
+    # and with :prevent_breaks
+    refute_rp_equal "foo.\n.\n.bar", "foo&#8288;&#8230;bar", [:ellipses, :prevent_breaks]
+    refute_rp_equal "foo\n.\n.\n.\nbar", "foo&nbsp;&#8230;\nbar", [:ellipses, :prevent_breaks]
+    assert_rp_equal "foo.\n.\n.\n.bar", "foo.\n.\n.\n.bar", [:ellipses, :prevent_breaks]
+    assert_rp_equal "foo\n.\n.\n.\n.\nbar", "foo\n.\n.\n.\n.\nbar", [:ellipses, :prevent_breaks]
+
     # nasty ones
     assert_rp_equal "foo. . ..bar", 'foo. . ..bar', [:ellipses]
     assert_rp_equal "foo. . ...bar", 'foo. . &#8230;bar', [:ellipses]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubypants
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - John Gruber
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-26 00:00:00.000000000 Z
+date: 2019-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -68,8 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: RubyPants is a Ruby port of the smart-quotes library SmartyPants.