agate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eda63f3e809d3e097848a34b3fc9cec35cbe6ac8
+  data.tar.gz: e2548f805540a40a648ea918d7d94cba84ce965b
+SHA512:
+  metadata.gz: 1661c4901e2cf8c4f929dd7560a7da24f91284ce7647cdde9e3f1fb8c9955e2cb94d84c7c19be2c10900044216bc983a9ae6abe415e34048288b70403f502b20
+  data.tar.gz: 68ccb1be9b3b9847b087d05c2afa3f0242eb8b1a80715f4f0d6902f90c1661ffee16e648b0a695bf63c5ae80c950f4b1cda937680c769242c50beeaf671e07b4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head
+  - ree

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in agate.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jesse B. Hannah
+
+MIT License
+
+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,31 @@
+# [Agate](http://en.wikipedia.org/w/index.php?title=Ruby_character&oldid=540994629#History)
+
+[![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][].
+
+## Usage
+
+```ruby
+a = Agate::Parser.new("勉【べん】強【きょう】します")
+a.parse
+```
+
+results in
+
+```html
+<ruby>勉<rt>べん</rt></ruby><ruby>強<rt>きょう</rt></ruby>します
+```
+
+It's highly recommended to read the W3C's documentation on the [HTML
+`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
+[CSS workaround]: http://web.nickshanks.com/stylesheets/ruby.css

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/agate.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'agate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "agate"
+  spec.version       = Agate::VERSION
+  spec.authors       = ["Jesse B. Hannah"]
+  spec.email         = ["jesse@jbhannah.net"]
+  spec.description   = %q{Wrap ruby characters (e.g. furigana, Pinyin, Zhuyin) in text with the HTML ruby element.}
+  spec.summary       = %q{Wrap ruby characters (e.g. furigana, Pinyin, Zhuyin) in text with the HTML ruby element.}
+  spec.homepage      = "https://github.com/jbhannah/agate"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.2"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.13.0"
+  spec.add_development_dependency "coveralls"
+end

data/bin/agate

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'agate'

data/lib/agate.rb

@@ -0,0 +1,2 @@
+require "agate/parser"
+require "agate/version"

data/lib/agate/parser.rb

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+module Agate
+  class Parser
+    def initialize(text)
+      @text = text
+    end
+
+    def text
+      @text
+    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>')
+    end
+  end
+end

data/lib/agate/version.rb

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

data/spec/lib/parser_spec.rb

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+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>します" }
+
+  it "saves text to an instance variable" do
+    agate.text.should eql(text)
+  end
+
+  it "parses demarcated text and turns it into HTML" do
+    agate.parse.should eql(parsed_text)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+RSpec.configure do |config|
+  require "coveralls"
+  Coveralls.wear!
+
+  require "agate"
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+
+  # 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
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: agate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jesse B. Hannah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-05 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
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.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 (e.g. furigana, Pinyin, Zhuyin) in text with the
+  HTML ruby element.
+email:
+- jesse@jbhannah.net
+executables:
+- agate
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- agate.gemspec
+- bin/agate
+- lib/agate.rb
+- lib/agate/parser.rb
+- lib/agate/version.rb
+- spec/lib/parser_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jbhannah/agate
+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.0.0
+signing_key: 
+specification_version: 4
+summary: Wrap ruby characters (e.g. furigana, Pinyin, Zhuyin) in text with the HTML
+  ruby element.
+test_files:
+- spec/lib/parser_spec.rb
+- spec/spec_helper.rb