rtypeset 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8ea4e5bc767657e85cce15701a16bd5d7509758
-  data.tar.gz: a5fb8f89579eeb8343354e42a75ef533e77a7c2d
+  metadata.gz: 6c6a2fbd26527d3299578780c904e7912d54b5d8
+  data.tar.gz: 88cabe98ef680e1fd514cb5e31355036f243ea0e
 SHA512:
-  metadata.gz: d6c17fb385f25ec901ba85fa1f713f34ccf15ca6b9ce366d6a89355f4e2f1932984c18a8a49214f142582c77c8b94f33b16aca6430e332ca61de892acc01b81b
-  data.tar.gz: eee4219f33268dc297a300ed3040eb185ad463376b97be164f9e510d8bbb122b2d4e567a2e800da2192edc1ed1b9d49bf7ea89d959c04d0e913ad84faaccfd05
+  metadata.gz: 4502d70a2721ca59b1a30ce00fdb1f149188cbde94db7161fd3ff3ea3823bcaa990dd3052d5242c6b9373ad6dc9461422f1b78c15653b2c94031cbb4decacd0e
+  data.tar.gz: f94bf56385b52360b2307235b6f5beb789014dc05c01ae12d70a6b463263b08a64c4ab76e708a47e1b4f8c9e0d0bc0ba8dc2dd4ae684daf82ff22f99df4a7ff8

data/.travis.yml

@@ -3,3 +3,6 @@ rvm:
   - 2.1.2
   - 2.1.0
   - 2.1.5
+addons:
+  code_climate:
+    repo_token: 4b280ed6ddcce4c38b7daa1cdf99ce3c49c858f6c7beb7d41fa99938e47b140e

data/Gemfile

@@ -15,3 +15,7 @@ group :development do
   gem "jeweler", "~> 2.0.1"
   gem "simplecov", ">= 0"
 end
+
+group :test do
+  gem "codeclimate-test-reporter"
+end

data/README.md

@@ -1,7 +1,10 @@
 # An HTML pre-processor for web typography
 
+[![Gem Version](https://badge.fury.io/rb/rtypeset.svg)](http://badge.fury.io/rb/rtypeset)
 [![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)
+[![Documentation Status](https://inch-ci.org/github/doches/rtypeset.svg)](https://inch-ci.org/github/doches/rtypeset)
+[![Code Climate](https://codeclimate.com/github/doches/rtypeset/badges/gpa.svg)](https://codeclimate.com/github/doches/rtypeset)
+[![Test Coverage](https://codeclimate.com/github/doches/rtypeset/badges/coverage.svg)](https://codeclimate.com/github/doches/rtypeset/coverage)
 
 a pure Ruby typographic pre-processor for HTML inspired by [Typeset.js](https://github.com/davidmerfield/Typeset) that gives you:
 
@@ -32,11 +35,22 @@ HTML:
     # 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`:
+### Customisation
+
+Want more control over your typesetting? 
+
+#### Disabling Features
+
+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`.
+The full list of modules is: `:quotes`, `:hanging_punctuation`, `:spaces`, `:small_caps`, `:hyphenate`, `:ligatures` and `:punctuation`.
+
+#### Hyphenation Language
+
+If you're using hyphenation (it's on by default!) you may want to specify the language (the default is `en_us`):
+
+    Typeset.typeset(raw_html, {:language => "en_us"})

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/typeset.rb

@@ -29,20 +29,28 @@ module Typeset
     return content.join("")
   end
 
+  # The default typesetting methods and their configuration. Add new methods here
+  # in whatever order makes sense.
+  DefaultMethods = [
+    [:quotes, true],
+    [:hanging_punctuation, true],
+    [:spaces, true],
+    [:small_caps, true],
+    [:ligatures, false],
+    [:punctuation, false],
+    [:hyphenate, true]
+  ]
+
+  DefaultOptions = {
+    :disable => [],
+    :language => "en_us"
+  }
+
   # 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] ||= []
+  def self.typeset(html, options=Typeset::DefaultOptions)
+    methods = Typeset::DefaultMethods.dup
+    options[:disable] ||= DefaultOptions[:disable]
     methods.reject! { |method| options[:disable].include?(method[0]) }
 
     methods.each do |func, use_text_nodes|

data/lib/typeset/hanging_punctuation.rb

@@ -30,30 +30,16 @@ module Typeset
     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')}"
+      [[aligns, false],
+       [HangingPunctuation::SingleWidth, 'single'],
+       [HangingPunctuation::DoubleWidth, 'double']].each do |pair|
+        pair[0].each do |signal|
+          if word[0] == signal
+            words[i] = "#{HangingPunctuation.pull(pair[1], signal)}#{word.slice(1,word.length)}"
+
+            if not words[i-1].nil?
+              words[i-1] = "#{words[i-1]}#{HangingPunctuation.push(pair[1] ? pair[1] : signal)}"
+            end
           end
         end
       end

data/lib/typeset/hyphenate.rb

@@ -7,7 +7,7 @@ module Typeset
   #     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])
+    hyphen = Text::Hyphen.new(:language => options[:language], :left => 0, :right => 0)
 
     text = hyphen.visualise(text, "\u00AD")
 

data/rtypeset.gemspec

@@ -0,0 +1,84 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: rtypeset 0.1.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "rtypeset"
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Trevor Fountain"]
+  s.date = "2015-08-20"
+  s.description = "A pure Ruby implementation of Typeset.js, an HTML pre-processor for web typography"
+  s.email = "trevor@texasexpat.net"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.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",
+    "rtypeset.gemspec",
+    "test/helper.rb",
+    "test/test_typeset.rb"
+  ]
+  s.homepage = "http://github.com/doches/rtypeset"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.7"
+  s.summary = "An HTML pre-processor for web typography"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<text-hyphen>, ["~> 1.4"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 1.6"])
+      s.add_development_dependency(%q<minitest>, [">= 5.8.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<text-hyphen>, ["~> 1.4"])
+      s.add_dependency(%q<nokogiri>, [">= 1.6"])
+      s.add_dependency(%q<minitest>, [">= 5.8.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<text-hyphen>, ["~> 1.4"])
+    s.add_dependency(%q<nokogiri>, [">= 1.6"])
+    s.add_dependency(%q<minitest>, [">= 5.8.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -1,3 +1,5 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
 require 'simplecov'
 
 module SimpleCov::Configuration

data/test/test_typeset.rb

@@ -9,7 +9,7 @@ class TestTypeset < Minitest::Test
   end
 
   def test_quotes
-    assert_equal "“foo”", Typeset.typeset("\"foo\"", {:disable => [:hanging_punctuation]})
+    assert_equal "“foo”", Typeset.typeset("\"foo\"", {:disable => [:hanging_punctuation, :hyphenate]})
     assert_equal "19′ 43.5″", Typeset.typeset("19\' 43.5\"")
   end
 
@@ -28,7 +28,7 @@ class TestTypeset < Minitest::Test
   end
 
   def test_small_caps
-    assert_equal "an <span class=\"small-caps\">FBI</span> agent", Typeset.typeset("an FBI agent")
+    assert_equal "an <span class=\"small-caps\">FBI</span> agent", Typeset.typeset("an FBI agent", OptNoHyphenate)
     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)
@@ -54,6 +54,6 @@ class TestTypeset < Minitest::Test
   end
 
   def test_hyphenate
-    assert_equal "do hy\u00ADphen\u00ADation", Typeset.typeset("do hyphenation")
+    assert_equal "do hy\u00ADphen\u00ADation", Typeset.typeset("do hyphenation", Typeset::DefaultOptions)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rtypeset
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Trevor Fountain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-18 00:00:00.000000000 Z
+date: 2015-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: text-hyphen
@@ -151,6 +151,7 @@ files:
 - lib/typeset/quotes.rb
 - lib/typeset/small_caps.rb
 - lib/typeset/spaces.rb
+- rtypeset.gemspec
 - test/helper.rb
 - test/test_typeset.rb
 homepage: http://github.com/doches/rtypeset