rubypants 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b29b8d72353258ac6b847c78c77fedaa8a9cb33
-  data.tar.gz: 965af58a1f2e7770e5a76a748e7ad564f6e24335
+  metadata.gz: 80fce7b0286c4b7268c4bbd6d73cc702acee77d5
+  data.tar.gz: b2206216e8645e82ad3705a54064e5465430eab3
 SHA512:
-  metadata.gz: 7e8c42ca85e3a117f954311cbb016779329c9e390200a70244fd2f5828959a60d4226a924ae777904032ea756f4b774367c9ddd578b241621ce18b5ff1a33f4c
-  data.tar.gz: 4456339e90147d4887917441d9400f17f1cb0f5df3a45e2528629eed88ed5da309eb99b6d0dff70819538ff1966d8351d6dd2d3e3bb3ad5ab630868db759f6f4
+  metadata.gz: 395f50ffc524bdf2e193dea148e1eec494453b4ac7a062220257d8c7514a65a7377c63ee7ecdb081fd0e625169263be6b32f1b9e0d592bb7a4537ee776fca7e0
+  data.tar.gz: 665a1f5b1d81ef0f95afaf6ad4db71ba684dfdd2b0fc2658f2628ba11d3aaec9fb41a9b50e5053ff96fc8f48ad685741f52f6d671bde8eedd10d4a5eb6c74bc2

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,18 @@
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.0
+  - jruby
+
+# Workaround for `NoMethodError: undefined method 'spec' for nil:NilClass`,
+# see https://travis-ci.org/jmcnevin/rubypants/jobs/167182556
+# and https://github.com/travis-ci/travis-ci/issues/5239
+before_install:
+  - gem install bundler
+
+# For now override the default `bundle exec rake` which fails because of an
+# unresolved superclass mismatch in `core.rb` vs. `version.rb`. This should
+# eventually be fixed in rubypants.
+script:
+  - rake

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+gemspec
+
+gem "rake"
+gem "codecov", :require => false, :group => :test

data/README.rdoc

@@ -1,6 +1,8 @@
 = RubyPants: SmartyPants for Ruby
 
-{<img src="https://img.shields.io/gem/v/rubypants.png?style=plastic">}[https://rubygems.org/gems/rubypants]
+{<img src="https://img.shields.io/gem/v/rubypants.svg?maxAge=2592000&style=plastic" alt="Gem">}[https://rubygems.org/gems/rubypants]
+{<img src="https://img.shields.io/travis/jmcnevin/rubypants.svg?maxAge=2592000&style=plastic" alt="Travis">}[https://travis-ci.org/jmcnevin/rubypants]
+{<img src="https://img.shields.io/codecov/c/github/jmcnevin/rubypants.svg?maxAge=2592000&style=plastic" alt="CodeCov">}[https://codecov.io/gh/jmcnevin/rubypants]
 
 == Synopsis
 

data/lib/rubypants/core.rb

@@ -13,20 +13,24 @@ class RubyPants < String
   # If you don't like any of these defaults, you can pass symbols to change
   # RubyPants' behavior:
   #
-  # <tt>:quotes</tt>        :: quotes
-  # <tt>:backticks</tt>     :: backtick quotes (``double'' only)
-  # <tt>:allbackticks</tt>  :: backtick quotes (``double'' and `single')
-  # <tt>:dashes</tt>        :: dashes
-  # <tt>:oldschool</tt>     :: old school dashes
-  # <tt>:inverted</tt>      :: inverted old school dashes
-  # <tt>:ellipses</tt>      :: ellipses
-  # <tt>:convertquotes</tt> :: convert <tt>&quot;</tt> entities to
-  #                            <tt>"</tt>
-  # <tt>:stupefy</tt>       :: translate RubyPants HTML entities
-  #                            to their ASCII counterparts.
+  # <tt>:quotes</tt>         :: quotes
+  # <tt>:backticks</tt>      :: backtick quotes (``double'' only)
+  # <tt>:allbackticks</tt>   :: backtick quotes (``double'' and `single')
+  # <tt>:dashes</tt>         :: dashes
+  # <tt>:oldschool</tt>      :: old school dashes
+  # <tt>:inverted</tt>       :: inverted old school dashes
+  # <tt>:ellipses</tt>       :: ellipses
+  # <tt>:prevent_breaks</tt> :: use nbsp and word-joiner to avoid breaking
+  #                             before dashes and ellipses
+  # <tt>:named_entities</tt> :: used named entities instead of the default
+  #                             decimal entities (see below)
+  # <tt>:convertquotes</tt>  :: convert <tt>&quot;</tt> entities to
+  #                             <tt>"</tt>
+  # <tt>:stupefy</tt>        :: translate RubyPants HTML entities
+  #                             to their ASCII counterparts.
   #
   # In addition, you can customize the HTML entities that will be injected by
-  # passing in a hash for the final argument.  The defaults for these entities
+  # passing in a hash for the final argument. The defaults for these entities
   # are as follows:
   #
   # <tt>:single_left_quote</tt>  :: <tt>&#8216;</tt>
@@ -36,13 +40,31 @@ class RubyPants < String
   # <tt>:em_dash</tt>            :: <tt>&#8212;</tt>
   # <tt>:en_dash</tt>            :: <tt>&#8211;</tt>
   # <tt>:ellipsis</tt>           :: <tt>&#8230;</tt>
-  # <tt>:html_quote</tt>         :: <tt>&quot; </tt>
+  # <tt>:html_quote</tt>         :: <tt>&quot;</tt>
+  # <tt>:non_breaking_space</tt> :: <tt>&nbsp;</tt>
+  # <tt>:word_joiner</tt>        :: <tt>&#8288;</tt>
+  #
+  # If the <tt>:named_entities</tt> option is used, the default entities are
+  # as follows:
+  #
+  # <tt>:single_left_quote</tt>  :: <tt>&lsquo;</tt>
+  # <tt>:double_left_quote</tt>  :: <tt>&ldquo;</tt>
+  # <tt>:single_right_quote</tt> :: <tt>&rsquo;</tt>
+  # <tt>:double_right_quote</tt> :: <tt>&rdquo;</tt>
+  # <tt>:em_dash</tt>            :: <tt>&mdash;</tt>
+  # <tt>:en_dash</tt>            :: <tt>&ndash;</tt>
+  # <tt>:ellipsis</tt>           :: <tt>&hellip;</tt>
+  # <tt>:html_quote</tt>         :: <tt>&quot;</tt>
+  # <tt>:non_breaking_space</tt> :: <tt>&nbsp;</tt>
+  # <tt>:word_joiner</tt>        :: <tt>&#8288;</tt>
   #
   def initialize(string, options=[2], entities = {})
     super string
 
     @options = [*options]
-    @entities = default_entities.update(entities)
+    @entities = default_entities
+    @entities.merge!(named_entities) if @options.include?(:named_entities)
+    @entities.merge!(entities)
   end
 
   # Apply SmartyPants transformations.
@@ -400,7 +422,22 @@ class RubyPants < String
       :ellipsis           => "&#8230;",
       :html_quote         => "&quot;",
       :non_breaking_space => "&nbsp;",
-      :word_joiner        => "&#65279;",
+      :word_joiner        => "&#8288;",
+    }
+  end
+
+  def named_entities
+    {
+      :single_left_quote  => '&lsquo;',
+      :double_left_quote  => "&ldquo;",
+      :single_right_quote => "&rsquo;",
+      :double_right_quote => "&rdquo;",
+      :em_dash            => "&mdash;",
+      :en_dash            => "&ndash;",
+      :ellipsis           => "&hellip;",
+      :html_quote         => "&quot;",
+      :non_breaking_space => "&nbsp;",
+      # :word_joiner      => N/A,
     }
   end
 

data/lib/rubypants/version.rb

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

data/test/helper.rb

@@ -0,0 +1,5 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'codecov'
+SimpleCov.formatter = SimpleCov::Formatter::Codecov

data/test/rubypants_test.rb

@@ -1,3 +1,5 @@
+require_relative 'helper'
+
 require 'minitest/autorun'
 require_relative '../lib/rubypants'
 
@@ -74,7 +76,7 @@ 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, :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]
@@ -86,13 +88,13 @@ EOF
     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, :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, :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]
@@ -104,13 +106,13 @@ EOF
     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, :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, :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]
@@ -136,7 +138,7 @@ EOF
     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…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 spaces
@@ -145,7 +147,7 @@ EOF
     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…bar', [:ellipses, :prevent_breaks]
+    assert_rp_equal "foo. . .bar", 'foo⁠…bar', [:ellipses, :prevent_breaks]
     assert_rp_equal "foo . . . bar", 'foo … bar', [:ellipses, :prevent_breaks]
     assert_rp_equal "foo. . . .bar", 'foo. . . .bar', [:ellipses, :prevent_breaks]
     assert_rp_equal "foo . . . . bar", 'foo . . . . bar', [:ellipses, :prevent_breaks]
@@ -229,4 +231,8 @@ EOF
     }
     assert_rp_equal "Testing 'FOO!'", "Testing SHAZAMFOO!POWZAP", [2], entities
   end
+
+  def test_named_entities
+    assert_rp_equal "Testing 'FOO!'", "Testing ‘FOO!’", [2, :named_entities]
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubypants
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - John Gruber
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-02 00:00:00.000000000 Z
+date: 2016-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -39,6 +39,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- Gemfile
 - LICENSE.rdoc
 - README.rdoc
 - Rakefile
@@ -46,6 +48,7 @@ files:
 - lib/rubypants/core.rb
 - lib/rubypants/version.rb
 - rubypants.gemspec
+- test/helper.rb
 - test/rubypants_test.rb
 homepage: https://github.com/jmcnevin/rubypants
 licenses:
@@ -72,4 +75,5 @@ signing_key:
 specification_version: 4
 summary: RubyPants is a Ruby port of the smart-quotes library SmartyPants.
 test_files:
+- test/helper.rb
 - test/rubypants_test.rb