rtypeset 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b8ea4e5bc767657e85cce15701a16bd5d7509758
+  data.tar.gz: a5fb8f89579eeb8343354e42a75ef533e77a7c2d
+SHA512:
+  metadata.gz: d6c17fb385f25ec901ba85fa1f713f34ccf15ca6b9ce366d6a89355f4e2f1932984c18a8a49214f142582c77c8b94f33b16aca6430e332ca61de892acc01b81b
+  data.tar.gz: eee4219f33268dc297a300ed3040eb185ad463376b97be164f9e510d8bbb122b2d4e567a2e800da2192edc1ed1b9d49bf7ea89d959c04d0e913ad84faaccfd05

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.2
+  - 2.1.0
+  - 2.1.5

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "text-hyphen", "~> 1.4"
+gem "nokogiri", ">= 1.6"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "minitest", ">= 5.8.0"
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Trevor Fountain
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# An HTML pre-processor for web typography
+
+[![Build Status](https://travis-ci.org/doches/rtypeset.png)](https://travis-ci.org/doches/rtypeset)
+[![Documentation Status](https://inch-ci.org/github/doches/rtypeset.svg?branch=master)](https://inch-ci.org/github/doches/rtypeset)
+
+a pure Ruby typographic pre-processor for HTML inspired by [Typeset.js](https://github.com/davidmerfield/Typeset) that gives you:
+
+    * Real hang­ing punc­tu­a­tion
+    * Soft hy­phen in­ser­tion
+    * Op­ti­cal mar­gin out­dents
+    * Small-caps conversion
+    * Punc­tu­a­tion sub­sti­tu­tion
+    * Space sub­sti­tu­tion
+
+## Installation
+
+    gem install rtypeset
+
+## Usage
+
+Just require the `typeset` gem and then call `#typeset` to receive beautifully-formatted
+HTML:
+
+    require 'typeset'
+
+    raw_html = <<HTM
+    <p>Yjarni Sigurðardóttir spoke to NATO from Iceland yesterday:
+    "Light of my life, fire of my florins -- my sin, my soul.
+    The tip of the tongue taking a trip to 118° 19' 43.5".":</p>
+    HTM
+
+    # Output beautifully-formatted HTML
+    puts Typeset.typeset(raw_html)
+
+Want more control over your typesetting? You can selectively disable Typeset features by passing
+in an options hash to `#typeset`:
+
+    # Disable hyphenation and small caps conversion.
+    options = {:disable => [:hyphenate, :small-caps]}
+    Typeset.typeset(raw_html, options)
+
+The full list of disablable modules is: `:quotes`, `:hanging_punctuation`, `:spaces`, `:small_caps`, `:hyphenate`, `:ligatures` and `:punctuation`.

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "rtypeset"
+  gem.homepage = "http://github.com/doches/rtypeset"
+  gem.license = "MIT"
+  gem.summary = %Q{An HTML pre-processor for web typography}
+  gem.description = %Q{A pure Ruby implementation of Typeset.js, an HTML pre-processor for web typography}
+  gem.email = "trevor@texasexpat.net"
+  gem.authors = ["Trevor Fountain"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rtypeset #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/demo/demo.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'typeset'
+
+puts Typeset.typeset(STDIN.readlines().join(""))

data/demo/raw.html

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>Typeset.js – an HTML pre-processor for web typography</title>
+  <link rel="icon" type="image/png" href="./demo/favicon.png">
+  <link href='http://fonts.googleapis.com/css?family=Slabo+27px' rel='stylesheet' type='text/css'>
+  <link rel="stylesheet" href="./style.css">
+  <link rel="stylesheet" href="./typeset.css">
+</head>
+<body>
+  <div class="demo">
+    <p>Yjarni Sigurðardóttir spoke to NATO from Iceland yesterday: "Light of my life, fire of my florins -- my sin, my soul. The tip of the tongue taking a trip to 118° 19' 43.5"."</p>
+
+    <p>"She's faster than a 120' 4" whale." <em>Piña co­ladas</em> were widely consumed in Götterdämmerung from 1880–1912. For the low price of $20 / year from Ex­hi­bits A–E... Then the <em>duplex</em> came forward. "Thrice the tower, he mounted the round gunrest, 'awaking' HTML. He can print a fixed num­ber of dots in a square inch (for in­stance, 600 × 600)."</p>
+  </div>
+</body>
+</html>

data/demo/style.css

@@ -0,0 +1,61 @@
+@import url(http://fonts.googleapis.com/css?family=Alegreya+SC);
+@import url(http://fonts.googleapis.com/css?family=Alegreya);
+@import url(http://fonts.googleapis.com/css?family=Inconsolata);
+
+body {
+  font-family: 'Alegreya', serif;
+}
+
+p {
+  font-size: x-large;
+}
+
+.demo {
+  border-left: 4px solid #ddd;
+  border-radius: 2px;
+  padding-left: 8px;
+}
+
+.container {
+  width: 600px;
+  margin: 3em auto;
+}
+
+li {
+  list-style-type: none;
+  display: block;
+  width: 40%;
+  float: left;
+  margin-right: 1em;
+  margin-bottom: 0.33em;
+}
+
+.prefooter {
+  clear: both;
+  height: 1px;
+  display: block;
+}
+
+h2,h3,h4,h5 {
+  font-family: 'Alegreya SC', serif;
+  text-transform: lowercase;
+  color: #222;
+  width: 100%;
+  border-bottom-color: #ddd;
+  border-bottom-width: 1px;
+  border-bottom-style: solid;
+}
+
+h3 {
+  border-bottom-color: #F0aCaC;
+  color: #F03C3C;
+}
+
+.code {
+  font-family: 'Inconsolata', monospace;
+}
+
+a {
+  text-decoration: none;
+  color: #F03C3C;
+}

data/demo/typeset.css

@@ -0,0 +1,23 @@
+/* Small caps */
+.small-caps {
+  font-family: 'Alegreya SC', sans-serif;
+  text-transform: lowercase;
+}
+
+/* Double quote (") marks */
+.pull-double{margin-left:-.38em}
+.push-double{margin-right:.38em}
+
+/* Single quote (') marks */
+.pull-single{margin-left:-.15em}
+.push-single{margin-right:.15em}
+
+/* Optical margin alignment for particular letters */
+.pull-T, .pull-V, .pull-W, .pull-Y {margin-left: -0.07em}
+.push-T, .push-V, .push-W, .push-Y {margin-right: 0.07em}
+
+.pull-O, .pull-C, .pull-o, .pull-c {margin-left: -0.04em}
+.push-O, .push-C, .push-o, .push-c {margin-right: 0.04em}
+
+.pull-A {margin-left: -0.03em}
+.push-A {margin-right: 0.03em}

data/index.html

@@ -0,0 +1,52 @@
+<!DOCTYPE html>
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>  <span class="pull-T">T</span>ype­set.js – an <span class="small-caps">HTML</span> pre-proces­sor ­for<span class="push-w"></span>  <span class="pull-w">w</span>eb ­ty­pog­ra­phy<span class="push-T"></span>  </title>
+  <link rel="icon" type="image/png" href="./demo/favicon.png">
+  <link rel="stylesheet" href="./demo/style.css">
+  <link rel="stylesheet" href="./demo/typeset.css">
+</head>
+<body>
+  <div class="container">
+    <h1>rTypeset</h1>
+    <p>A typographic pre-processor for <span class='small-caps'>HTML</span> inspired by <a href="https://blot.im/typeset/">Typeset.js</a> that gives you:</p>
+    <ul>
+        <li>Real hang­ing punc­tu­a­tion</li>
+        <li>Soft hy­phen in­ser­tion</li>
+        <li><span class="pull-O">O</span>p­ti­cal mar­gin<span class="push-o"></span> <span class="pull-o">o</span>ut­dents</li>
+        <li>Small-caps<span class="push-c"></span> <span class="pull-c">c</span>on­ver­sion</li>
+        <li>Punc­tu­a­tion sub­sti­tu­tion</li>
+        <li>Space sub­sti­tu­tion</li>
+    </ul>
+    <div class='prefooter'>&nbsp;</div>
+    <h3>Raw</h3>
+    <div class="demo">
+      <p>Yjarni Sigurðardóttir spoke to NATO from Iceland yesterday: "Light of my life, fire of my florins -- my sin, my soul. The tip of the tongue taking a trip to 118° 19' 43.5"."</p>
+      <p>"She's faster than a 120' 4" whale." <em>Piña co­ladas</em> were widely consumed in Götterdämmerung from 1880–1912. For the low price of $20 / year from Ex­hi­bits A–E... Then the <em>duplex</em> came forward. "Thrice the tower, he mounted the round gunrest, 'awaking' HTML. He can print a fixed num­ber of dots in a square inch (for in­stance, 600 × 600)."</p>
+    </div>
+    <h3>Typeset</h3>
+    <div class="demo">
+      <p><span class="pull-Y">Y</span>jarni Sig­urðardót­tir spoke to <span class="small-caps">NATO</span> from Ice­land yes­ter­day:<span class="push-double"></span>  <span class="pull-double">“</span>Light<span class="push-o"></span>  <span class="pull-o">o</span>f my life, ­fire<span class="push-o"></span>  <span class="pull-o">o</span>f my florin­s – my s­in, my ­soul.<span class="push-T"></span>  <span class="pull-T">T</span>he tip<span class="push-o"></span>  <span class="pull-o">o</span>f the ­tongue ­tak­ing a trip ­to 118° 19′ 43.5″.”<span class="push-Y"></span><span class="push-Y"></span></p>
+      <p><span class="pull-double">“</span>She’s ­faster than a 120′ 4″<span class="push-w"></span>  <span class="pull-w">w</span>hale.”<span class="push-double"></span>  <em>Piña<span class="push-c"></span>  <span class="pull-c">c</span>o­ladas</em>  <span class="pull-w">w</span>ere<span class="push-w"></span>  <span class="pull-w">w</span>idely<span class="push-c"></span>  <span class="pull-c">c</span>onsumed in Göt­ter­däm­merung from 1880–1912. ­For the low price<span class="push-o"></span>  <span class="pull-o">o</span>f $20 / year from Ex­hi­bits<span class="push-A"></span>  <span class="pull-A">A</span>–E…<span class="push-T"></span>  <span class="pull-T">T</span>hen the<span class="push-w"></span>  <em>duplex</em>  <span class="pull-c">c</span>ame ­for­ward.<span class="push-double"></span>  <span class="pull-double">“</span>Thrice the ­tow­er, he ­mount­ed the round ­gun­rest,<span class="push-single"></span>  <span class="pull-single">‘</span>awak­ing’ <span class="small-caps">HTML</span>. He<span class="push-c"></span>  <span class="pull-c">c</span>an print­ a ­fixed num­ber<span class="push-o"></span>  <span class="pull-o">o</span>f dot­s in a square inch (­for in­s­tance, 600 × 600).”<span class="push-c"></span></p>
+    </div>
+    <h2>Installation</h2>
+    <code class='code'>
+      gem install rtypeset
+    </code>
+    <h2>Usage</h2>
+    <pre class='code'>
+require 'typeset'
+
+raw_html = &lt;&lt;HTM
+&lt;p&gt;Yjarni Sigurðardóttir spoke to NATO from Iceland yesterday:
+"Light of my life, fire of my florins -- my sin, my soul.
+The tip of the tongue taking a trip to 118° 19' 43.5".":&lt;/p&gt;
+HTM
+
+# Output beautifully-formatted HTML
+puts Typeset.typeset(raw_html)
+    </pre>
+  </div>
+</body>
+</html>

data/lib/typeset.rb

@@ -0,0 +1,59 @@
+require 'typeset/quotes'
+require 'typeset/hyphenate'
+require 'typeset/ligatures'
+require 'typeset/small_caps'
+require 'typeset/punctuation'
+require 'typeset/hanging_punctuation'
+require 'typeset/spaces'
+require 'nokogiri'
+
+# Contains all of our typeset-related class methods. Mix this module into a
+# class, or just call `Typeset#typset` directly
+module Typeset
+  # Parse an HTML fragment with Nokogiri and apply a function to all of the
+  # descendant text nodes
+  def self.apply_to_text_nodes(html, &func)
+    doc = Nokogiri::HTML("<div id='rtypeset_internal'>#{html}</div>", nil,"UTF-8",Nokogiri::XML::ParseOptions::NOENT)
+    doc.search('//text()').each do |node|
+      old_content = node.content
+      new_content = func.call(node.content.strip)
+      if old_content =~ /^(\s+)/
+        new_content = " #{new_content}"
+      end
+      if old_content =~ /(\s+)$/
+        new_content = "#{new_content} "
+      end
+      node.replace(new_content)
+    end
+    content = doc.css("#rtypeset_internal")[0].children.map { |child| child.to_html }
+    return content.join("")
+  end
+
+  # The main entry point for Typeset. Pass in raw HTML or text, along with an
+  # optional options block.
+  def self.typeset(html, options={})
+    methods = [
+      [:quotes, true],
+      [:hanging_punctuation, true],
+      [:spaces, true],
+      [:small_caps, true],
+      [:hyphenate, true],
+      [:ligatures, false],
+      [:punctuation, false]
+    ]
+
+    options[:disable] ||= []
+    methods.reject! { |method| options[:disable].include?(method[0]) }
+
+    methods.each do |func, use_text_nodes|
+      new_html = html
+      if use_text_nodes
+        new_html = Typeset.apply_to_text_nodes(html) { |content| Typeset.send(func, content, options) }
+      else
+        new_html = Typeset.send(func, html, options).strip
+      end
+      html = new_html
+    end
+    return html
+  end
+end

data/lib/typeset/hanging_punctuation.rb

@@ -0,0 +1,64 @@
+module Typeset
+  # Contains constants and methods specific to our hanging punctuation implementation
+  module HangingPunctuation
+    # Characters that need a double-width pull
+    DoubleWidth = ['"', '"', "“", "„", "”", "“", "“", "“", "“", "”", "”", '”', '”', '„', '„', '„']
+    # Characters that need a single-width pull
+    SingleWidth = ["'", '′', ''', '‘', '’', '‘', '’']
+
+    # Wrap a piece of content in a pull class
+    def self.pull(classname, content='')
+      HangingPunctuation.wrap("pull", classname, content)
+    end
+
+    # Wrap a piece of content in a push class
+    def self.push(classname, content='')
+      HangingPunctuation.wrap("push", classname, content)
+    end
+
+    # Wrap a piece of content in an arbitrary class. Convenience method for
+    # implementing #push and #pull
+    def self.wrap(type, classname, content='')
+      "<span class=\"#{type}-#{classname}\">#{content}</span>"
+    end
+  end
+
+  # Add push/pull spans for hanging punctuation to text.
+  def self.hanging_punctuation(text, options)
+    return text if text.length < 2
+
+    aligns = "CcOoYTAVvWwY".split('')
+    words = text.split(/\s+/)
+    words.each_with_index do |word, i|
+      aligns.each do |align|
+        if word[0] == align
+          words[i] = "#{HangingPunctuation.pull(align, align)}#{word.slice(1,word.length)}"
+
+          if not words[i-1].nil?
+            words[i-1] = "#{words[i-1]}#{HangingPunctuation.push(align)}"
+          end
+        end
+      end
+      HangingPunctuation::SingleWidth.each do |punctuation|
+        if word[0] == punctuation
+          words[i] = "#{HangingPunctuation.pull('single', punctuation)}#{word.slice(1,word.length)}"
+
+          if not words[i-1].nil?
+            words[i-1] = "#{words[i-1]}#{HangingPunctuation.push('single')}"
+          end
+        end
+      end
+      HangingPunctuation::DoubleWidth.each do |punctuation|
+        if word[0] == punctuation
+          words[i] = "#{HangingPunctuation.pull('double', punctuation)}#{word.slice(1,word.length)}"
+
+          if not words[i-1].nil?
+            words[i-1] = "#{words[i-1]}#{HangingPunctuation.push('double')}"
+          end
+        end
+      end
+    end
+
+    return words.join(" ")
+  end
+end

data/lib/typeset/hyphenate.rb

@@ -0,0 +1,16 @@
+require 'text/hyphen'
+
+module Typeset
+  # Hyphenate text, inserting soft hyphenation markers. Specify the language
+  # for hyphenation by passing in an options block to your typeset call, e.g.:
+  #
+  #     Typeset.typeset("do hyphenation on this", {:language => "en_gb"})
+  def self.hyphenate(text, options)
+    options[:language] ||= 'en_us'
+    hyphen = Text::Hyphen.new(:language => options[:language])
+
+    text = hyphen.visualise(text, "\u00AD")
+
+    return text
+  end
+end

data/lib/typeset/ligatures.rb

@@ -0,0 +1,30 @@
+module Typeset
+  # Map of raw text sequences to unicode ligatures
+  Ligatures = {
+    'ffi' => 'ffi',
+    'ffl' => 'ffl',
+    'fi' => 'fi',
+    'fl' => 'fl',
+    'st' => 'st',
+    'ff' => 'ff',
+    'ue' => 'ᵫ'
+  }
+
+  # List of ligatures to process by default
+  DefaultLigatures = %w{ffi ffl fi fl ff}
+
+  # Find and replace sequences of text with their unicode ligature equivalents.
+  # Override the set of ligatures to find by passing in a custom options hash, e.g.:
+  #
+  #     Typeset.typeset("flue", {:ligatures => ["fl", "ue"]})
+  #     # -> returns "flᵫ"
+  def self.ligatures(text, options)
+    options[:ligatures] ||= DefaultLigatures
+
+    options[:ligatures].each do |ligature|
+      text.gsub!(ligature, Ligatures[ligature])
+    end
+
+    return text
+  end
+end

data/lib/typeset/punctuation.rb

@@ -0,0 +1,23 @@
+module Typeset
+  # Make dashes, elipses, and start/end punctuation a little prettier.
+  def self.punctuation(text, options)
+    # Dashes
+    text.gsub!('--', '–')
+    text.gsub!(' – ', "\u2009–\u2009")
+
+    # Elipses
+    text.gsub!('...', '…')
+
+    # Non-breaking space for start/end punctuation with spaces.
+    start_punc = /([«¿¡\[\(]) /
+    if text =~ start_punc
+      text.gsub!(start_punc, "#{$1} ")
+    end
+    end_punc = / ([\!\?:;\.,‽»\]\)])/
+    if text =~ end_punc
+      text.gsub!(end_punc," #{$1}")
+    end
+
+    return text
+  end
+end

data/lib/typeset/quotes.rb

@@ -0,0 +1,45 @@
+module Typeset
+  # A poor-man's Smarty Pants implementation. Converts single & double quotes,
+  # tick marks, backticks, and primes into prettier unicode equivalents.
+  def self.quotes(text, options)
+    # Unencode encoded characters, so our regex mess below works
+    text.gsub!(''',"\'")
+    text.gsub!('"',"\"")
+
+    if text =~ /(\W|^)"(\S+)/
+      text.gsub!(/(\W|^)"(\S+)/, "#{$1}\u201c#{$2}") # beginning "
+    end
+    if text =~ /(\u201c[^"]*)"([^"]*$|[^\u201c"]*\u201c)/
+      text.gsub!(/(\u201c[^"]*)"([^"]*$|[^\u201c"]*\u201c)/, "#{$1}\u201d#{$2}") # ending "
+    end
+    if text =~ /([^0-9])"/
+      text.gsub!(/([^0-9])"/, "#{$1}\u201d") # remaining " at end of word
+    end
+    if text =~ /(\W|^)'(\S)/
+      text.gsub!(/(\W|^)'(\S)/, "#{$1}\u2018#{$2}") # beginning '
+    end
+    if text =~ /([a-z])'([a-z])/i
+      text.gsub!(/([a-z])'([a-z])/i, "#{$1}\u2019#{$2}") # conjunction's possession
+    end
+    if text =~ /((\u2018[^']*)|[a-z])'([^0-9]|$)/i
+      text.gsub!(/((\u2018[^']*)|[a-z])'([^0-9]|$)/i, "#{$1}\u2019#{$3}") # ending '
+    end
+    if text =~ /(\u2018)([0-9]{2}[^\u2019]*)(\u2018([^0-9]|$)|$|\u2019[a-z])/i
+      text.gsub!(/(\u2018)([0-9]{2}[^\u2019]*)(\u2018([^0-9]|$)|$|\u2019[a-z])/i, "\u2019#{$2}#{$3}") # abbrev. years like '93
+    end
+    if text =~ /(\B|^)\u2018(?=([^\u2019]*\u2019\b)*([^\u2019\u2018]*\W[\u2019\u2018]\b|[^\u2019\u2018]*$))/i
+      text.gsub!(/(\B|^)\u2018(?=([^\u2019]*\u2019\b)*([^\u2019\u2018]*\W[\u2019\u2018]\b|[^\u2019\u2018]*$))/i, "#{$1}\u2019") # backwards apostrophe
+    end
+    text.gsub!(/'''/, "\u2034") # triple prime
+    text.gsub!(/("|'')/, "\u2033") # double prime
+    text.gsub!(/'/, "\u2032")
+
+    # Allow escaped quotes
+    text.gsub!('\\\“','\"')
+    text.gsub!('\\\”','\"')
+    text.gsub!('\\\’','\'')
+    text.gsub!('\\\‘','\'')
+
+    return text
+  end
+end

data/lib/typeset/small_caps.rb

@@ -0,0 +1,13 @@
+module Typeset
+  # Identify likely acronyms, and wrap them in a 'small-caps' span.
+  def self.small_caps(text, options)
+    words = text.split(" ")
+    words.each_with_index do |word, i|
+      if word =~ /^\W*([[:upper:]][[:upper:]][[:upper:]]+)\W*/
+        leading,trailing = word.split($1)
+        words[i] = "#{leading}<span class=\"small-caps\">#{$1}</span>#{trailing}"
+      end
+    end
+    return words.map { |x| x.strip }.join(" ")
+  end
+end

data/lib/typeset/spaces.rb

@@ -0,0 +1,11 @@
+module Typeset
+  # Replace wide (normal) spaces around math operators with hair spaces.
+  def self.spaces(text, options)
+    text.gsub!(" / ", "\u2009/\u2009")
+    text.gsub!(" × ", "\u2009×\u2009")
+    text.gsub!(" % ", "\u2009%\u2009")
+    text.gsub!(" + ", "\u2009+\u2009")
+
+    return text
+  end
+end

data/test/helper.rb

@@ -0,0 +1,35 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_profile 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'minitest'
+require 'minitest/autorun'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'typeset'
+
+class Minitest::Test
+end

data/test/test_typeset.rb

@@ -0,0 +1,59 @@
+require 'helper'
+
+class TestTypeset < Minitest::Test
+  Lorem = "Lorem ipsum dolor, sit <em class=\"latin\">amet</em>"
+  OptNoHyphenate = {:disable => [:hyphenate]}
+
+  def setup
+    assert_equal Lorem, Typeset.typeset(Lorem, OptNoHyphenate)
+  end
+
+  def test_quotes
+    assert_equal "“foo”", Typeset.typeset("\"foo\"", {:disable => [:hanging_punctuation]})
+    assert_equal "19′ 43.5″", Typeset.typeset("19\' 43.5\"")
+  end
+
+  def test_spaces
+    assert_equal "1\u2009/\u20092", Typeset.typeset("1 / 2")
+    assert_equal "1\u2009×\u20092", Typeset.typeset("1 × 2")
+  end
+
+  def test_punctuation
+    assert_equal "…", Typeset.typeset("...")
+    assert_equal "foo–bar", Typeset.typeset("foo--bar")
+    assert_equal "foo\u2009–\u2009bar", Typeset.typeset("foo -- bar")
+
+    assert_equal "¿&nbsp;foo&nbsp;?", Typeset.typeset("¿ foo ?", OptNoHyphenate)
+    assert_equal "bar [&nbsp;foo&nbsp;] baz", Typeset.typeset("bar [ foo ] baz", OptNoHyphenate)
+  end
+
+  def test_small_caps
+    assert_equal "an <span class=\"small-caps\">FBI</span> agent", Typeset.typeset("an FBI agent")
+    assert_equal "The <span class=\"small-caps\">CIA</span>", Typeset.typeset("The CIA", {:disable => [:hanging_punctuation, :hyphenate]})
+    assert_equal "<span class=\"small-caps\">NCSA</span>", Typeset.typeset("NCSA", OptNoHyphenate)
+    assert_equal "<span class=\"small-caps\">NCSA</span> Mosaic", Typeset.typeset("NCSA Mosaic", OptNoHyphenate)
+    assert_equal "developed by <span class=\"small-caps\">NCSA</span>.", Typeset.typeset("developed by NCSA.", OptNoHyphenate)
+    assert_equal "mCAT", Typeset.typeset("mCAT", OptNoHyphenate)
+    assert_equal "<span class=\"small-caps\">CAT</span>-5", Typeset.typeset("CAT-5", {:disable => [:hanging_punctuation, :hyphenate]})
+  end
+
+  def test_ligatures
+    assert_equal "ffoo", Typeset.typeset("ffoo")
+    assert_equal "fioo", Typeset.typeset("fioo")
+    assert_equal "floo", Typeset.typeset("floo")
+    assert_equal "ffioo", Typeset.typeset("ffioo")
+    assert_equal "ffloo", Typeset.typeset("ffloo")
+
+    # Ensure extended ligatures don't work by default...
+    assert_equal "flue", Typeset.typeset("flue")
+    assert_equal "due", Typeset.typeset("due")
+
+    # ...but do work on request
+    assert_equal "stoo", Typeset.typeset("stoo", {:ligatures => [Typeset::DefaultLigatures, 'st'].flatten})
+    assert_equal "ᵫoo", Typeset.typeset("ueoo", {:ligatures => [Typeset::DefaultLigatures, 'ue'].flatten})
+  end
+
+  def test_hyphenate
+    assert_equal "do hy\u00ADphen\u00ADation", Typeset.typeset("do hyphenation")
+  end
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: rtypeset
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Trevor Fountain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: text-hyphen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.8.0
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A pure Ruby implementation of Typeset.js, an HTML pre-processor for web
+  typography
+email: trevor@texasexpat.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- demo/demo.rb
+- demo/raw.html
+- demo/style.css
+- demo/typeset.css
+- index.html
+- lib/typeset.rb
+- lib/typeset/hanging_punctuation.rb
+- lib/typeset/hyphenate.rb
+- lib/typeset/ligatures.rb
+- lib/typeset/punctuation.rb
+- lib/typeset/quotes.rb
+- lib/typeset/small_caps.rb
+- lib/typeset/spaces.rb
+- test/helper.rb
+- test/test_typeset.rb
+homepage: http://github.com/doches/rtypeset
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: An HTML pre-processor for web typography
+test_files: []