jekyll-pants 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 937c218b14420def96bf1b9bfea8ed597435ffb6
-  data.tar.gz: 69ab767f91cd8f89636d6f63af0d05351c5c156c
+  metadata.gz: 18cd8e967afd6c5cbe5f220f62bf0134f7a780f1
+  data.tar.gz: 2a62173d28a1f8f907e8bdcafb30a8d9a4fd8fff
 SHA512:
-  metadata.gz: 537a616a5077e5c3f6c73b9e70530bc2c1ff745229ca175071ca9e7cf8c70494eb4b61bedd5ff8c8758be671f20b514bb99899ec662685a3e7e6cf83e6980275
-  data.tar.gz: e501349f08242354c6a629ef06e2eae7e0acc3bda4c794a5ef8b1800868582898be2279a305fa1a3a3add05e3b78d16977be4ccfdd4015853464b23d8561f8a9
+  metadata.gz: d2e544e0b3be9ffac0235fda920b541a0dfb4c4a7ba92028f1075b251530fc03939bd55c27e88cf064a709836537b8786ac183220f3b0235a6ef418ee1566422
+  data.tar.gz: e926cedaba9ca6595fd245360fd0c62efe1dfd99b04755b43925c3ce712e40936644922b3c04e7dd9446c931e0def65e2eb927cc7064df5751721e8c53a90cbd

data/.gitignore

@@ -4,6 +4,7 @@
 /coverage/
 /InstalledFiles
 /pkg/
+/spec/dest/
 /spec/reports/
 /spec/examples.txt
 /test/tmp/

data/.travis.yml

@@ -5,18 +5,23 @@ rvm:
 - 2.0
 - 2.1
 - 2.2
+- 2.3.0
 matrix:
   include:
     - # GitHub Pages
       rvm: 2.1.1
       env: JEKYLL_VERSION=2.4.0
     - rvm: 1.9.3
-      env: JEKYLL_VERSION=2.5
+      env:
+        - JEKYLL_VERSION=2.5
+        # codecov pulls in json, breaks on 1.9.3
+        # https://travis-ci.org/scampersand/jekyll-pants/builds/167216488
+        - CODECOV=false
 env:
   matrix:
     - JEKYLL_VERSION=2.5
     - JEKYLL_VERSION=3.0
-    - JEKYLL_VERSION=3.2.0.pre.beta1
+    - JEKYLL_VERSION=3.2.1
 install:
 - bundle install
 script:

data/Gemfile

@@ -5,6 +5,6 @@ if ENV["JEKYLL_VERSION"]
   gem "jekyll", "~> #{ENV["JEKYLL_VERSION"]}"
 end
 
-if RUBY_VERSION >= "2"
-  gem "json"
+if ENV["CODECOV"] != "false"
+  gem 'codecov', :require => false, :group => :test
 end

data/README.md

@@ -1,4 +1,101 @@
 # jekyll-pants
 
-[![build status](https://img.shields.io/travis/agriffis/jekyll-pants/master.svg?style=plastic)](https://travis-ci.org/agriffis/jekyll-pants?branch=master)
-[![gem](https://img.shields.io/gem/v/jekyll-pants.svg)]()
+[![gem](https://img.shields.io/gem/v/jekyll-pants.svg?maxAge=2592000&style=plastic)](https://rubygems.org/gems/jekyll-pants)
+[![travis](https://img.shields.io/travis/scampersand/jekyll-pants.svg?maxAge=2592000&style=plastic)](https://travis-ci.org/agriffis/jekyll-pants)
+[![codecov](https://img.shields.io/codecov/c/github/scampersand/jekyll-pants.svg?maxAge=2592000&style=plastic)](https://codecov.io/gh/scampersand/jekyll-pants)
+
+Jekyll-Pants is a [Jekyll](http://jekyllrb.com/) plugin to convert plain ASCII
+punctuation to typographic punctuation HTML entities. It relies on
+[RubyPants](https://github.com/jmcnevin/rubypants) which is a Ruby port of the
+smart-quotes library SmartyPants.
+
+<table>
+<tr><th>Input</th><th>Output</th><th>Rendered</th></tr>
+<tr>
+<td valign=top><pre>Here's an example--as
+you can see...</pre></td>
+<td valign=top><pre>Here&amp;#8217;s an example&amp;#8212;as
+you can see&amp;#8230;</pre></td>
+<td valign=top>Here&#8217;s an example&#8212;as you can see&#8230;</td>
+</tr>
+</table>
+
+
+## Rationale
+
+This plugin exists because the default Jekyll support for smart quotes is limited to:
+
+ 1. [Markdown](https://daringfireball.net/projects/markdown/) parsed by
+    [kramdown](http://kramdown.gettalong.org/) (see note below for how to
+    disable kramdown's quoting in favor of jekyll-pants).
+
+ 2. The [smartify](https://jekyllrb.com/docs/templates/#filters) filter which is
+    actually another way to invoke kramdown's markdown processor, so it doesn't
+    work as desired on HTML.
+
+Unlike the built-in solutions, jekyll-pants works on HTML, making it suitable
+for applying typographic punctuation to an entire site of hand-authored HTML pages.
+
+## Usage
+
+Add `jekyll-pants` to your site's Gemfile in the `:jekyll-plugins` group and run
+`bundle` to install and update Gemfile.lock:
+
+```ruby
+group :jekyll_plugins do
+  gem "jekyll-pants"
+end
+```
+
+In your base layout, filter the content through the `pants` filter:
+
+```liquid
+<!DOCTYPE html>
+<html>
+  <head>...</head>
+  <body>
+    {{content|pants}}
+  </body>
+</html>
+```
+
+Since RubyPants parses HTML tags, this will apply typographic quoting, dashes
+and ellipses to text content, but will ignore preformatted text in `<pre>` and `<script>`.
+
+## Configuration
+
+By default, this plugin invokes RubyPants with no options, so RubyPants runs in
+its default mode which is "old-school." In old-school mode, double-dash
+translates to an en-dash and triple-dash translates to an em-dash.
+
+This can be modified in Jekyll's `_config.yml` under the `pants` key, for
+example:
+
+```yaml
+pants:
+  options: [1, :prevent_breaks]
+  entities: {:em_dash => '&mdash;'}
+```
+
+For the available options, see https://github.com/jmcnevin/rubypants/blob/master/lib/rubypants/core.rb
+
+## Compatibility with kramdown
+
+Jekyll's default markdown processor
+is [kramdown](http://kramdown.gettalong.org/), and by default kramdown applies
+smart quoting and typographic substitutions. Its algorithm works a little
+differently from RubyPants which means that you'll get mixed results with
+content coming from both markdown and HTML sources.
+
+Jekyll-Pants supplies a parser subclass as
+[recommended by kramdown's author](https://github.com/gettalong/kramdown/pull/379).
+The subclass is called `Pantsdown` and removes the `:smart_quotes` and
+`:typographic_syms` span parsers from the list.
+
+To use this subclass and thereby defer to RubyPants for
+quotes, dashes and ellipses, put the following in your `_config.yml`:
+
+```yaml
+kramdown:
+  input: Pantsdown
+```

data/jekyll-pants.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |spec|
   spec.name = "jekyll-pants"
   spec.summary = "Jekyll plugin to run rubypants on generated HTML"
-  spec.version = "0.1.0"
+  spec.version = "0.2.0"
   spec.authors = ["Aron Griffis"]
   spec.email = "aron@scampersand.com"
-  spec.homepage = "https://github.com/agriffis/jekyll-pants"
+  spec.homepage = "https://github.com/scampersand/jekyll-pants"
   spec.licenses = ["MIT"]
 
   spec.files = `git ls-files -z`.split("\x0")

data/lib/jekyll/jekyll-pants.rb

@@ -1,11 +1,2 @@
-require 'rubypants'
-
-module Jekyll
-  module PantsFilter
-    def pants(input)
-      RubyPants.new(input, options=[1]).to_html
-    end
-  end
-end
-
-Liquid::Template.register_filter(Jekyll::PantsFilter)
+require_relative 'pants/filter'
+require_relative 'pants/down'

data/lib/jekyll/pants/down.rb

@@ -0,0 +1,12 @@
+require 'kramdown/parser'
+
+module Kramdown
+  module Parser
+    class Pantsdown < Kramdown::Parser::Kramdown
+      def initialize(source, options)
+        super
+        @span_parsers -= [:smart_quotes, :typographic_syms]
+      end
+    end
+  end
+end

data/lib/jekyll/pants/filter.rb

@@ -0,0 +1,30 @@
+require 'rubypants'
+
+module Jekyll
+  module PantsFilter
+    def pants(input)
+      config = @context.registers[:site].config['pants'] || {}
+
+      if config.include?('entities') && ! config.include?('options')
+        Jekyll.logger.warn <<EOF
+Found pants.entities in config; you should also add pants.options
+since they're positional arguments to RubyPants.new
+EOF
+      end
+
+      args = []
+      if config.include?('options')
+        args.push(config['options'])
+      elsif config.include?('entities')
+        args.push([2])  # default in RubyPants
+      end
+      if config.include?('entities')
+        args.push(config['entities'])
+      end
+
+      RubyPants.new(input, *args).to_html
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::PantsFilter)

data/spec/jekyll-pants_spec.rb

@@ -17,13 +17,13 @@ describe(Jekyll::PantsFilter) do
   let(:markdown_output) { File.read(dest_dir("markdown/with-pants.html")) }
 
   it "makes HTML pretty" do
-    expect(html_output).to match /#{Regexp.quote "Makin’ it purty—don’t you think?"}/
+    expect(html_output).to match /#{Regexp.quote "Makin’ it purty–don’t you think?"}/
     expect(html_output).to_not match /Makin'|purty--don|don't/
   end
 
   it "preserves HTML pre" do
     expect(html_output).to match /#{Regexp.quote "But not this! This shouldn't be pretty--because it's code."}/
-    expect(html_output).to_not match /shouldn\’t|pretty\—because/
+    expect(html_output).to_not match /shouldn\’t|pretty\–because/
   end
 
   it "preserves kramdown smart quotes" do
@@ -33,7 +33,19 @@ describe(Jekyll::PantsFilter) do
 
   it "preserves code in markdown" do
     expect(markdown_output).to match /#{Regexp.quote "But not this! This shouldn't be pretty--because it's code."}/
-    expect(markdown_output).to_not match /shouldn\’t|pretty\—because/
+    expect(markdown_output).to_not match /shouldn\’t|pretty\–because/
+  end
+
+  context "with Pantsdown" do
+    let(:config) do
+      config_pantsdown = {"kramdown" => {"input" => "Pantsdown"}}
+      Jekyll.configuration(Jekyll::Utils.deep_merge_hashes(overrides, config_pantsdown))
+    end
+
+    it "makes markdown pretty" do
+      expect(markdown_output).to match /#{Regexp.quote "Makin’ it purty–don’t you think?"}/
+      expect(markdown_output).to_not match /Makin'|purty--don|don't/
+    end
   end
 
   context "without kramdown smart quotes" do
@@ -70,4 +82,38 @@ describe(Jekyll::PantsFilter) do
     end
   end
 
+  context "with config" do
+    let(:config) do
+      pants_config = {
+        'pants' => {
+          # 1 means -- is em-dash
+          'options' => [1],
+          'entities' => {:em_dash => '_mmm_', :en_dash => '_nnn_'},
+        }
+      }
+      Jekyll.configuration(Jekyll::Utils.deep_merge_hashes(overrides, pants_config))
+    end
+
+    it "honors the config" do
+      expect(html_output).to match /_mmm_/
+      expect(html_output).to_not match /_nnn_/
+    end
+  end
+
+  context "with lonely entities config" do
+    # this hits the warning and forces options => [2]
+    let(:config) do
+      pants_config = {
+        'pants' => {
+          'entities' => {:em_dash => '_mmm_', :en_dash => '_nnn_'},
+        }
+      }
+      Jekyll.configuration(Jekyll::Utils.deep_merge_hashes(overrides, pants_config))
+    end
+
+    it "honors the config" do
+      expect(html_output).to match /_nnn_/
+      expect(html_output).to_not match /_mmm_/
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,16 @@
+begin
+  require 'simplecov'
+  SimpleCov.start
+  if ENV['CI'] == 'true'
+    require 'codecov'
+    SimpleCov.formatter = SimpleCov::Formatter::Codecov
+  end
+rescue LoadError => e
+  if RUBY_VERSION >= '2'
+    raise e  # codecov should exist according to Gemfile
+  end
+end
+
 require 'jekyll'
 require File.expand_path('../lib/jekyll-pants', File.dirname(__FILE__))
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-pants
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Aron Griffis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-19 00:00:00.000000000 Z
+date: 2016-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubypants
@@ -66,10 +66,8 @@ files:
 - jekyll-pants.gemspec
 - lib/jekyll-pants.rb
 - lib/jekyll/jekyll-pants.rb
-- spec/dest/html/with-pants.html
-- spec/dest/html/without-pants.html
-- spec/dest/markdown/with-pants.html
-- spec/dest/markdown/without-pants.html
+- lib/jekyll/pants/down.rb
+- lib/jekyll/pants/filter.rb
 - spec/fixtures/_config.yml
 - spec/fixtures/_layouts/with-pants.html
 - spec/fixtures/_layouts/without-pants.html
@@ -79,7 +77,7 @@ files:
 - spec/fixtures/markdown/without-pants.md
 - spec/jekyll-pants_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/agriffis/jekyll-pants
+homepage: https://github.com/scampersand/jekyll-pants
 licenses:
 - MIT
 metadata: {}
@@ -99,15 +97,11 @@ 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: Jekyll plugin to run rubypants on generated HTML
 test_files:
-- spec/dest/html/with-pants.html
-- spec/dest/html/without-pants.html
-- spec/dest/markdown/with-pants.html
-- spec/dest/markdown/without-pants.html
 - spec/fixtures/_config.yml
 - spec/fixtures/_layouts/with-pants.html
 - spec/fixtures/_layouts/without-pants.html

data/spec/dest/html/with-pants.html

@@ -1,8 +0,0 @@
-<p>
-    Makin&#8217; it purty&#8212;don&#8217;t you think?
-</p>
-
-<pre>
-    But not this! This shouldn't be pretty--because it's code.
-</pre>
-

data/spec/dest/html/without-pants.html

@@ -1,8 +0,0 @@
-<p>
-    It ain't purty--without pants.
-</p>
-
-<pre>
-    Nor this--it ain't no better.
-</pre>
-

data/spec/dest/markdown/with-pants.html

@@ -1,6 +0,0 @@
-<p>Makin’ it purty–don’t you think?</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code>But not this! This shouldn't be pretty--because it's code.
-</code></pre>
-</div>
-

data/spec/dest/markdown/without-pants.html

@@ -1,6 +0,0 @@
-<p>It ain’t purty–without pants.</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code>Nor this--it ain't no better.
-</code></pre>
-</div>
-