agate 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0e2b4338740e69cba0f1310886ed85dd2f4a655
-  data.tar.gz: 5a2cc87c8d717a13ddb5a79e97b04ffab3477ff9
+  metadata.gz: b9a0b380e4f94a1f320a0feff2b2ca0a2e7f9437
+  data.tar.gz: 305eb3e8ecbc8e1d14938560a993f89e961f8ed9
 SHA512:
-  metadata.gz: e907a04663be0722250e0e0124d52c08449aa36f3cae7118535ec87c4b0bb93e84a7c66de599c2686cc789f4d90f5582171d135b054f6ed75102bb46e306102c
-  data.tar.gz: 94d95c408b798e117040ce2589cb0cc8d26cd4d76764558eda10e6d94be77c2527fa120b0fabde3ff12951145f898673a0626c4e0a081183516674d1ce5e8c44
+  metadata.gz: e19ede1a3bb96df2ed7ce649b3c5afd29217b8299a4a06bf70b1360e64fbdc947fa393c088df85b4156dff792b01312c0a8de2c9e6683c7be0a13dff0ba7705e
+  data.tar.gz: d2da48e19e9456b1a93cfee32c062a0f2d7eaed40d33bbdf3113369855def415e2590d01d4fcc01d833f27d7ec3d9f3cadc5dca17e64169ec05a1bbf732231ad

data/README.md

@@ -1,12 +1,13 @@
 # [Agate](http://en.wikipedia.org/w/index.php?title=Ruby_character&oldid=540994629#History)
 
+[![Gem Version](https://badge.fury.io/rb/agate.png)](http://badge.fury.io/rb/agate)
 [![Build Status](https://travis-ci.org/jbhannah/agate.png?branch=master)](https://travis-ci.org/jbhannah/agate)
 [![Dependency Status](https://gemnasium.com/jbhannah/agate.png)](https://gemnasium.com/jbhannah/agate)
 [![Code Climate](https://codeclimate.com/github/jbhannah/agate.png)](https://codeclimate.com/github/jbhannah/agate)
 [![Coverage Status](https://coveralls.io/repos/jbhannah/agate/badge.png?branch=master)](https://coveralls.io/r/jbhannah/agate)
 
 Wrap ruby characters (e.g. furigana, Pinyin, Zhuyin) in text with the
-[HTML `ruby` element][].
+[HTML5 `ruby` element][].
 
 ## Usage
 
@@ -26,11 +27,15 @@ results in
 <ruby>勉<rp>【</rp><rt>べん</rt><rp>】</rp></ruby><ruby>強<rp>【</rp><rt>きょう</rt><rp>】</rp></ruby>します
 ```
 
-It's highly recommended to read the W3C's documentation on the [HTML
+which (in your browser) looks like
+
+> <ruby>勉<rp>【</rp><rt>べん</rt><rp>】</rp></ruby><ruby>強<rp>【</rp><rt>きょう</rt><rp>】</rp></ruby>します
+
+It's highly recommended to read the W3C's documentation on the [HTML5
 `ruby` element][] to understand the usage of this element. There is a
 [CSS workaround][] available that enables the display of ruby characters
 in all modern browsers, but it's up to you to test all cases where you
 intend to use the `ruby` element.
 
-[HTML `ruby` element]: http://www.w3.org/TR/html5/text-level-semantics.html#the-ruby-element
+[HTML5 `ruby` element]: http://www.w3.org/TR/html5/text-level-semantics.html#the-ruby-element
 [CSS workaround]: http://web.nickshanks.com/stylesheets/ruby.css

data/lib/agate/formatter/html.rb

@@ -0,0 +1,20 @@
+module Agate
+  module Formatter
+    # Formats text using HTML5 ruby tags, turning
+    #
+    # > 勉【べん】強【きょう】します
+    #
+    # into
+    #
+    #     <ruby>勉<rp>【</rp><rt>べん</rt><rp>】</rp></ruby><ruby>強<rp>【</rp><rt>きょう</rt><rp>】</rp></ruby>します
+    #
+    # which can then be rendered by some web browsers or formatted
+    # using CSS.
+    class HTML
+      # Turns a regexp match object into a formatted string with ruby characters
+      def format(match)
+        "<ruby>#{match[1]}<rp>#{match[2]}</rp><rt>#{match[3]}</rt><rp>#{match[4]}</rp></ruby>"
+      end
+    end
+  end
+end

data/lib/agate/parser.rb

@@ -2,15 +2,23 @@
 module Agate
   class Parser
     # Default options
-    @@defaults = {
-      :delimiters => "【】"
+    DEFAULTS = {
+      :delimiters => "【】",
+      :formatter  => :html
     }
 
     # Regexp reserved characters to escape when matching
-    @@reserved = ["(", ")", "[", "]", "{", "}", ".", ",", "+", "*"]
+    RESERVED = ["(", ")", "[", "]", "{", "}", ".", ",", "+", "*"]
 
     def initialize(options = {})
-      @options = @@defaults.merge(options)
+      @options = DEFAULTS.merge(options)
+
+      @formatter = case @options[:formatter]
+        when :html
+          Agate::Formatter::HTML.new
+        else
+          Agate::Formatter::HTML.new
+        end
     end
 
     # Parse `text` and return it with ruby character markup
@@ -18,11 +26,10 @@ module Agate
       first = @options[:delimiters].chars.first
       last  = @options[:delimiters].chars.last
 
-      first = /#{'\\' + first}/ if @@reserved.include? first
-      last  = /#{'\\' + last}/  if @@reserved.include? last
+      first = /#{'\\' + first}/ if RESERVED.include? first
+      last  = /#{'\\' + last}/  if RESERVED.include? last
 
-      text.gsub(/(\p{Han}+)(#{first})([\p{Hiragana}\p{Katakana}]+)(#{last})/,
-        '<ruby>\1<rp>\2</rp><rt>\3</rt><rp>\4</rp></ruby>')
+      text.gsub(/(\p{Han}+)(#{first})([\p{Hiragana}\p{Katakana}]+)(#{last})/) { |match| @formatter.format($~) }
     end
   end
 end

data/lib/agate/version.rb

@@ -1,3 +1,3 @@
 module Agate
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/agate.rb

@@ -1,2 +1,3 @@
+require "agate/formatter/html"
 require "agate/parser"
 require "agate/version"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: agate
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jesse B. Hannah
@@ -85,6 +85,7 @@ files:
 - agate.gemspec
 - bin/agate
 - lib/agate.rb
+- lib/agate/formatter/html.rb
 - lib/agate/parser.rb
 - lib/agate/version.rb
 - spec/lib/parser_spec.rb