agate 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61b8714f36f8ffd5ce16f726b8e825e87fce1675
-  data.tar.gz: 971c067f88323df3644029a93403d29ee4fcaade
+  metadata.gz: 082fa68e924d6ca49504cc5b5add126064803671
+  data.tar.gz: 5c19845e152f54b321f964f5f0d44dcea4f18250
 SHA512:
-  metadata.gz: 5f68ea896b142d190f95e801487fc0986ed39a9f07b10be2491a17e3868b6c4bb55856fcfbf419a4883fed0971230a31de911beaee596267ece5d7c999651534
-  data.tar.gz: 681afdb738799121773ff70375a20b07d481c78bf86fbe0bec7a4df8416e639dd3ac540eb5bfcf1bf90f6e19d33cb5818faf1b5d5956faccc8d19b743b77e0be
+  metadata.gz: abedee9fda0c7d0d3fa0c3d1547fcf86fceb29fedacc11cbc312a920d43c44477277b278d05391935a68f1f4e1a47d7ae9bcc953ef0a7d7448f7342211407d28
+  data.tar.gz: a6a2e3352ae201ab8ac4eb8104f52fed3e52cbf195e1fdde4d8ca8cd0b1000e7c78ae69449dd7795359bf7d89395eaa088f91fe9e5ac072174631ae6ba789a5c

data/.travis.yml

@@ -3,7 +3,6 @@ rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1.2
   - jruby-19mode
-  - rbx-19mode
-  - ruby-head
-  - jruby-head
+  - rbx-2

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.5.0 / 2014-08-30
+
+ * Plaintext parser.
+ * Structural cleanup.
+
 # 0.4.1 / 2013-03-06
 
  * Documentation fixes.

data/README.md

@@ -1,14 +1,18 @@
 # [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)
+[![Gem Version](https://badge.fury.io/rb/agate.svg)](http://badge.fury.io/rb/agate)
+[![Build Status](https://travis-ci.org/jbhannah/agate.svg?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)
+[![Code Climate](https://codeclimate.com/github/jbhannah/agate/badges/gpa.svg)](https://codeclimate.com/github/jbhannah/agate)
+[![Coverage Status](https://img.shields.io/coveralls/jbhannah/agate.svg)](https://coveralls.io/r/jbhannah/agate?branch=master)
 
-Wrap ruby characters (currently only furigana) in text with the
-[HTML5 `ruby` element][]. **Requires Ruby 1.9 or later (or compabible
-engine).**
+Format ruby characters (currently only furigana) in text for display. **Requires
+Ruby 1.9 or later (or compatible engine).**
+
+## Formatters
+
+ * Plain text (echoes back passed text)
+ * [HTML5 (`ruby` element)][]
 
 ## Usage
 
@@ -31,8 +35,8 @@ require "agate"
 options = {
   # can be any single character or pair of characters which surround ruby characters in text to parse
   :delimiters => "【】" # default delimiters
-  # markup formatter to use (options: :html)
-  :formatter => :html # default (and currently only) formatter
+  # markup formatter to use (options: :plain (default), :html)
+  :formatter => :html
 }
 
 a = Agate::Parser.new(options) # call without arguments to use defaults
@@ -55,5 +59,5 @@ It's highly recommended to read the W3C's documentation on the [HTML5
 in all modern browsers, but it's up to you to test all cases where you
 intend to use the `ruby` element.
 
-[HTML5 `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/agate.gemspec

@@ -5,11 +5,11 @@ require 'agate/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "agate"
-  spec.version       = Agate::VERSION
+  spec.version       = Agate::VERSION.join('.')
   spec.authors       = ["Jesse B. Hannah"]
   spec.email         = ["jesse@jbhannah.net"]
-  spec.description   = %q{Wrap ruby characters (currently only furigana) in text with the HTML5 ruby element.}
-  spec.summary       = %q{Wrap ruby characters (currently only furigana) in text with the HTML5 ruby element.}
+  spec.description   = %q{Format ruby characters (currently only furigana) in text for display.}
+  spec.summary       = %q{Format ruby characters (currently only furigana) in text for display.}
   spec.homepage      = "https://github.com/jbhannah/agate"
   spec.license       = "MIT"
 
@@ -20,6 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.2"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 2.13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "coveralls"
 end

data/bin/agate

@@ -2,4 +2,4 @@
 
 require 'agate/cli'
 
-Agate::CLI.instance.start
+puts Agate::CLI.new.parse

data/lib/agate.rb

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

data/lib/agate/cli.rb

@@ -5,42 +5,40 @@ require 'optparse'
 
 module Agate
   class CLI
-    include Singleton
-
     def initialize
       @options = {}
     end
 
-    def start
+    def parse
       parse_opts
 
       agate = Agate::Parser.new(@options)
-      puts agate.parse(ARGV.join)
+      agate.parse(ARGV.join)
     end
 
   private
     def parse_opts
-      opts = OptionParser.new do |opts|
-        opts.banner = "Usage: agate [options] text-to-convert"
+      opts = OptionParser.new do |o|
+        o.banner = "Usage: agate [options] text-to-convert"
 
-        opts.separator ""
-        opts.separator "Options:"
+        o.separator ""
+        o.separator "Options:"
 
-        opts.on("-d", "--delimiters DELIMITERS", "Specify custom delimiters for ruby text (default: 【】)") do |delims|
+        o.on("-d", "--delimiters DELIMITERS", "Specify custom delimiters for ruby text (default: 【】)") do |delims|
           @options[:delimiters] = delims
         end
 
-        opts.on("-f", "--formatter FORMAT", "Specify a formatter to use (default/fallback: HTML)") do |format|
+        o.on("-f", "--formatter FORMAT", "Specify a formatter to use (default/fallback: plain text)") do |format|
           @options[:formatter] = format.to_sym
         end
 
-        opts.on_tail("-h", "--help", "Show this message") do
-          puts opts
+        o.on_tail("-h", "--help", "Show this message") do
+          puts o
           exit
         end
 
-        opts.on_tail("-v", "--version", "Show version") do
-          puts Agate::VERSION
+        o.on_tail("-v", "--version", "Show version") do
+          puts Agate::VERSION.join('.')
           exit
         end
       end

data/lib/agate/formatter/html.rb

@@ -1,4 +1,6 @@
 # -*- coding: utf-8 -*-
+require 'singleton'
+
 module Agate
   module Formatter
     # Formats text using HTML5 ruby tags, turning
@@ -12,8 +14,10 @@ module Agate
     # which can then be rendered by some web browsers or formatted
     # using CSS.
     class HTML
+      include Singleton
+
       # Turns a regexp match object into a formatted string with ruby characters
-      def format(match)
+      def self.format(match)
         "<ruby>#{match[1]}<rp>#{match[2]}</rp><rt>#{match[3]}</rt><rp>#{match[4]}</rp></ruby>"
       end
     end

data/lib/agate/formatter/plain.rb

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+require 'singleton'
+
+module Agate
+  module Formatter
+    # Echoes back the text passed to it.
+    #
+    # > 勉【べん】強【きょう】します
+    class Plain
+      include Singleton
+
+      # Turns a regexp match object into a formatted string with ruby characters
+      def self.format(match)
+        "#{match[1]}#{match[2]}#{match[3]}#{match[4]}"
+      end
+    end
+  end
+end

data/lib/agate/parser.rb

@@ -1,10 +1,13 @@
 # -*- coding: utf-8 -*-
+require "agate/formatter/html"
+require "agate/formatter/plain"
+
 module Agate
   class Parser
     # Default options
     DEFAULTS = {
       :delimiters => "【】",
-      :formatter  => :html
+      :formatter  => :plain
     }
 
     def initialize(options = {})
@@ -12,9 +15,11 @@ module Agate
 
       @formatter = case @options[:formatter]
         when :html
-          Agate::Formatter::HTML.new
+          Agate::Formatter::HTML
+        when :plain
+          Agate::Formatter::Plain
         else
-          Agate::Formatter::HTML.new
+          Agate::Formatter::Plain
         end
     end
 

data/lib/agate/version.rb

@@ -1,3 +1,3 @@
 module Agate
-  VERSION = "0.4.1"
+  VERSION = ["0", "5", "0"]
 end

data/spec/agate/cli_spec.rb

@@ -0,0 +1,72 @@
+# -*- coding: utf-8 -*-
+require "spec_helper"
+require "agate/cli"
+
+RSpec.describe Agate::CLI do
+  let(:cli)  { File.join(File.expand_path(File.dirname(__FILE__)), "..", "..", "bin", "agate") }
+  let(:text) { "勉【べん】強【きょう】します" }
+
+  context "with help option" do
+    it "shows the help message and exits" do
+      stub_const("Agate::CLI::ARGV", ["-h"])
+
+      text = <<-eos
+Usage: agate [options] text-to-convert
+
+Options:
+    -d, --delimiters DELIMITERS      Specify custom delimiters for ruby text (default: 【】)
+    -f, --formatter FORMAT           Specify a formatter to use (default/fallback: plain text)
+    -h, --help                       Show this message
+    -v, --version                    Show version
+eos
+
+      expect do
+        begin
+          load cli
+        rescue SystemExit
+        end
+      end.to output(text).to_stdout
+    end
+  end
+
+  context "with version option" do
+    it "shows the version and exits" do
+      version = ["1", "2", "3"]
+
+      stub_const("Agate::CLI::ARGV", ["-v"])
+      stub_const("Agate::VERSION", version)
+
+      expect do
+        begin
+          load cli
+        rescue SystemExit
+        end
+      end.to output(version.join('.') + "\n").to_stdout
+    end
+  end
+
+  context "with defaults" do
+    it "parses delimited text and echoes it back" do
+      stub_const("Agate::CLI::ARGV", [text])
+      expect { load cli }.to output(text + "\n").to_stdout
+    end
+  end
+
+  context "with custom delimiters" do
+    let(:text) { "勉(べん)強(きょう)します" }
+
+    it "parses delimited text and echoes it back" do
+      stub_const("Agate::CLI::ARGV", ["-d", "\"()\"", text])
+      expect { load cli }.to output(text + "\n").to_stdout
+    end
+  end
+
+  context "with formatter" do
+    let(:formatted_text) { "<ruby>勉<rp>【</rp><rt>べん</rt><rp>】</rp></ruby><ruby>強<rp>【</rp><rt>きょう</rt><rp>】</rp></ruby>します" }
+
+    it "parses delimited text and echoes it back" do
+      stub_const("Agate::CLI::ARGV", ["-f", "html", text])
+      expect { load cli }.to output(formatted_text + "\n").to_stdout
+    end
+  end
+end

data/spec/agate/formatter/html_spec.rb

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+require "spec_helper"
+require "agate/formatter/html"
+
+RSpec.describe Agate::Formatter::HTML do
+  let(:text)           { "勉【べん】" }
+  let(:formatted_text) { "<ruby>勉<rp>【</rp><rt>べん</rt><rp>】</rp></ruby>" }
+  let(:expr)           { /(\p{Han}+)(【)([\p{Hiragana}\p{Katakana}]+)(】)/u }
+
+  it "returns the string formatted as HTML5 ruby" do
+    expect(text.gsub(expr) { |match| Agate::Formatter::HTML.format($~) }).to eql(formatted_text)
+  end
+end

data/spec/agate/formatter/plain_spec.rb

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+require "spec_helper"
+require "agate/formatter/plain"
+
+RSpec.describe Agate::Formatter::Plain do
+  let(:text) { "勉【べん】" }
+  let(:expr) { /(\p{Han}+)(【)([\p{Hiragana}\p{Katakana}]+)(】)/u }
+
+  it "echoes back the original string" do
+    expect(text.gsub(expr) { |match| Agate::Formatter::Plain.format($~) }).to eql(text)
+  end
+end

data/spec/agate/parser_spec.rb

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+require "spec_helper"
+require "agate/parser"
+
+RSpec.describe Agate::Parser do
+  context "with defaults" do
+    let(:agate) { Agate::Parser.new }
+    let(:text)  { "勉【べん】強【きょう】します" }
+
+    it "parses delimited text and echoes it back" do
+      expect(agate.parse(text)).to eql(text)
+    end
+  end
+
+  context "with custom delimiters" do
+    context "from regexp-reserved character list" do
+      let(:agate) { Agate::Parser.new(:delimiters => "()") }
+      let(:text)  { "勉(べん)強(きょう)します" }
+
+      it "parses delimited text and echoes it back" do
+        expect(agate.parse(text)).to eql(text)
+      end
+    end
+
+    context "arbitrary" do
+      let(:agate) { Agate::Parser.new(:delimiters => "@") }
+      let(:text)  { "勉@べん@強@きょう@します" }
+
+      it "parses delimited text and echoes it back" do
+        expect(agate.parse(text)).to eql(text)
+      end
+    end
+  end
+
+  context "with formatter" do
+    context "HTML" do
+      let(:agate)          { Agate::Parser.new(:formatter => :html) }
+      let(:text)           { "勉【べん】強【きょう】します" }
+      let(:formatted_text) { "<ruby>勉<rp>【</rp><rt>べん</rt><rp>】</rp></ruby><ruby>強<rp>【</rp><rt>きょう</rt><rp>】</rp></ruby>します" }
+
+      it "parses delimited text and formats it with the specified formatter" do
+        expect(agate.parse(text)).to eql(formatted_text)
+      end
+    end
+
+    context "not matching an available formatter" do
+      let(:agate) { Agate::Parser.new(:formatter => :foobar) }
+      let(:text)  { "勉【べん】強【きょう】します" }
+
+      it "parses delimited text and echoes it back" do
+        expect(agate.parse(text)).to eql(text)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -9,9 +9,7 @@ RSpec.configure do |config|
   require "coveralls"
   Coveralls.wear!
 
-  require "agate"
-
-  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.raise_errors_for_deprecations!
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing

metadata

@@ -1,73 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: agate
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Jesse B. Hannah
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-06 00:00:00.000000000 Z
+date: 2014-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rake
   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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   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: Wrap ruby characters (currently only furigana) in text with the HTML5
-  ruby element.
+description: Format ruby characters (currently only furigana) in text for display.
 email:
 - jesse@jbhannah.net
 executables:
@@ -75,9 +74,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -88,9 +87,13 @@ files:
 - lib/agate.rb
 - lib/agate/cli.rb
 - lib/agate/formatter/html.rb
+- lib/agate/formatter/plain.rb
 - lib/agate/parser.rb
 - lib/agate/version.rb
-- spec/lib/parser_spec.rb
+- spec/agate/cli_spec.rb
+- spec/agate/formatter/html_spec.rb
+- spec/agate/formatter/plain_spec.rb
+- spec/agate/parser_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jbhannah/agate
 licenses:
@@ -102,21 +105,23 @@ 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.0.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Wrap ruby characters (currently only furigana) in text with the HTML5 ruby
-  element.
+summary: Format ruby characters (currently only furigana) in text for display.
 test_files:
-- spec/lib/parser_spec.rb
+- spec/agate/cli_spec.rb
+- spec/agate/formatter/html_spec.rb
+- spec/agate/formatter/plain_spec.rb
+- spec/agate/parser_spec.rb
 - spec/spec_helper.rb

data/spec/lib/parser_spec.rb

@@ -1,58 +0,0 @@
-# -*- coding: utf-8 -*-
-require "spec_helper"
-
-describe Agate::Parser do
-  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 "parses delimited text and turns it into HTML" do
-      agate.parse(text).should eql(parsed_text)
-    end
-  end
-
-  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
-
-  context "with formatter" do
-    context "HTML" do
-      let(:agate)       { Agate::Parser.new(:formatter => :html) }
-      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 "not matching an available formatter" do
-      let(:agate)       { Agate::Parser.new(:formatter => :foobar) }
-      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