agate 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eda63f3e809d3e097848a34b3fc9cec35cbe6ac8
-  data.tar.gz: e2548f805540a40a648ea918d7d94cba84ce965b
+  metadata.gz: c0e2b4338740e69cba0f1310886ed85dd2f4a655
+  data.tar.gz: 5a2cc87c8d717a13ddb5a79e97b04ffab3477ff9
 SHA512:
-  metadata.gz: 1661c4901e2cf8c4f929dd7560a7da24f91284ce7647cdde9e3f1fb8c9955e2cb94d84c7c19be2c10900044216bc983a9ae6abe415e34048288b70403f502b20
-  data.tar.gz: 68ccb1be9b3b9847b087d05c2afa3f0242eb8b1a80715f4f0d6902f90c1661ffee16e648b0a695bf63c5ae80c950f4b1cda937680c769242c50beeaf671e07b4
+  metadata.gz: e907a04663be0722250e0e0124d52c08449aa36f3cae7118535ec87c4b0bb93e84a7c66de599c2686cc789f4d90f5582171d135b054f6ed75102bb46e306102c
+  data.tar.gz: 94d95c408b798e117040ce2589cb0cc8d26cd4d76764558eda10e6d94be77c2527fa120b0fabde3ff12951145f898673a0626c4e0a081183516674d1ce5e8c44

data/README.md

@@ -11,14 +11,19 @@ Wrap ruby characters (e.g. furigana, Pinyin, Zhuyin) in text with the
 ## Usage
 
 ```ruby
-a = Agate::Parser.new("勉【べん】強【きょう】します")
-a.parse
+options = {
+  # can be any single character or pair of characters which surround ruby characters in text to parse
+  :delimiters => "【】" # default delimiters
+}
+
+a = Agate::Parser.new(options) # call without arguments to use defaults
+a.parse("勉【べん】強【きょう】します")
 ```
 
 results in
 
 ```html
-<ruby>勉<rt>べん</rt></ruby><ruby>強<rt>きょう</rt></ruby>します
+<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

data/lib/agate/parser.rb

@@ -1,16 +1,28 @@
 # -*- coding: utf-8 -*-
 module Agate
   class Parser
-    def initialize(text)
-      @text = text
-    end
+    # Default options
+    @@defaults = {
+      :delimiters => "【】"
+    }
+
+    # Regexp reserved characters to escape when matching
+    @@reserved = ["(", ")", "[", "]", "{", "}", ".", ",", "+", "*"]
 
-    def text
-      @text
+    def initialize(options = {})
+      @options = @@defaults.merge(options)
     end
 
-    def parse
-      @parsed_text ||= @text.gsub(/(\p{Han}+)(【)([\p{Hiragana}\p{Katakana}]+)(】)/, '<ruby>\1<rp>\2</rp><rt>\3</rt><rp>\4</rp></ruby>')
+    # Parse `text` and return it with ruby character markup
+    def parse(text)
+      first = @options[:delimiters].chars.first
+      last  = @options[:delimiters].chars.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>')
     end
   end
 end

data/lib/agate/version.rb

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

data/spec/lib/parser_spec.rb

@@ -2,15 +2,35 @@
 require "spec_helper"
 
 describe Agate::Parser do
-  let!(:text) { "勉【べん】強【きょう】します" }
-  let!(:agate) { Agate::Parser.new(text) }
-  let!(:parsed_text) { "<ruby>勉<rp>【</rp><rt>べん</rt><rp>】</rp></ruby><ruby>強<rp>【</rp><rt>きょう</rt><rp>】</rp></ruby>します" }
+  context "with defaults" do
+    let(:agate)       { Agate::Parser.new }
+    let(:text)        { "勉【べん】強【きょう】します" }
+    let(:parsed_text) { "<ruby>勉<rp>【</rp><rt>べん</rt><rp>】</rp></ruby><ruby>強<rp>【</rp><rt>きょう</rt><rp>】</rp></ruby>します" }
 
-  it "saves text to an instance variable" do
-    agate.text.should eql(text)
+    it "parses delimited text and turns it into HTML" do
+      agate.parse(text).should eql(parsed_text)
+    end
   end
 
-  it "parses demarcated text and turns it into HTML" do
-    agate.parse.should eql(parsed_text)
+  context "with custom delimiters" do
+    context "from regexp-reserved character list" do
+      let(:agate) { Agate::Parser.new(:delimiters => "()") }
+      let(:text)  { "勉(べん)強(きょう)します" }
+      let(:parsed_text) { "<ruby>勉<rp>(</rp><rt>べん</rt><rp>)</rp></ruby><ruby>強<rp>(</rp><rt>きょう</rt><rp>)</rp></ruby>します" }
+
+      it "parses delimited text and turns it into HTML" do
+        agate.parse(text).should eql(parsed_text)
+      end
+    end
+
+    context "arbitrary" do
+      let(:agate) { Agate::Parser.new(:delimiters => "@") }
+      let(:text)  { "勉@べん@強@きょう@します" }
+      let(:parsed_text) { "<ruby>勉<rp>@</rp><rt>べん</rt><rp>@</rp></ruby><ruby>強<rp>@</rp><rt>きょう</rt><rp>@</rp></ruby>します" }
+
+      it "parses delimited text and turns it into HTML" do
+        agate.parse(text).should eql(parsed_text)
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: agate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jesse B. Hannah