tabular_code 0.1.0

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 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Zejun Wu
+
+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,62 @@
+# TabularCode
+
+Convertion for tabular codes like
+Chinese [quwei](http://zh.wikipedia.org/wiki/%E5%8C%BA%E4%BD%8D%E7%A0%81_%28%E5%9B%BD%E6%A0%87%29)
+and
+Japanese [kuten](http://ja.wikipedia.org/wiki/JIS_X_0208).
+
+Supported row-cell notations:
+
+| Module  | Language           | National standard | Alternative name |
+|---------|--------------------|-------------------|------------------|
+| Quwei   | Simplified Chinese | GB 2312-80        | Quwei 区位       |
+| Kuten   | Japanese           | JIS X 0208:1997   | Kuten 区点       |
+| KSX1001 | Korean             | KS X 1001:1992    |                  |
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tabular_code'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tabular_code
+
+## Usage
+
+Example program:
+
+    require 'tabular_code'
+
+    puts Quwei.to_str([4444] * 44)
+    [Quwei, Kuten, KSX1001].each do |i|
+      p [i.from_char('一'), i.to_char(5050)]
+    end
+    p '我爱你'.quwei
+    p '愛してる'.kuten
+    p '사랑해요'.ksx1001
+
+Example output:
+
+    烫烫烫烫
+    5027	  说
+    1676	  傍
+    7673	  綱
+    [4650, 1614, 3667]
+    [1606, 423, 438, 475]
+    [2771, 2291, 3956, 3168]
+
+See rdoc and rspec tests for more details.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/tabular_code.rb

@@ -0,0 +1,26 @@
+require "tabular_code/version"
+require "tabular_code/base"
+require "tabular_code/quwei"
+require "tabular_code/kuten"
+require "tabular_code/ksx1001"
+
+Quwei = TabularCode::Quwei
+Kuten = TabularCode::Kuten
+KSX1001 = TabularCode::KSX1001
+
+class String
+  # Returns an Array of quwei codes
+  def quwei
+    Quwei.from_str self
+  end
+
+  # Returns an Array of kuten codes
+  def kuten
+    Kuten.from_str self
+  end
+
+  # Returns an Array of ksx1001 codes
+  def ksx1001
+    KSX1001.from_str self
+  end
+end

data/lib/tabular_code/base.rb

@@ -0,0 +1,62 @@
+module TabularCode
+  class Error < RuntimeError
+  end
+
+  # Raised when conversion fails.
+  class ConversionError < Error
+  end
+
+  module Base
+    # Converts a character to corresponding row-cell notation.
+    #
+    # Returns +nil+ if no such notation exists.
+    def from_char(c)
+      c = c.encode(@encoding).ord rescue (return nil)
+      x = c / 0x100 - 0xA0
+      y = c % 0x100 - 0xA0
+      valid?(x, y) ? x * 100 + y : nil
+    end
+
+    # Converts a row-cell notation to corresponding character.
+    #
+    # Returns +nil+ if no such character exists.
+    def to_char(c)
+      x = c / 100
+      y = c % 100
+      c = valid?(x, y) ? (0xA0 + x) * 0x100 + (0xA0 + y) : nil
+      c.chr(@encoding).encode(Encoding::UTF_8) rescue (return nil)
+    end
+
+    # Converts a String to an Array of row-cell notations.
+    #
+    # If +:replace+ is given, replaces undefined characters with +:replace+.
+    # Otherwise, raises ConversionError for undefined characters.
+    def from_str(s, options = {:replace => nil})
+      ret = s.chars.map{|i| from_char(i)}
+      raise ConversionError if !options.has_key?(:replace) && ret.include?(nil)
+      ret.map{|i| i.nil? ? options[:replace] : i}
+    end
+
+    # Converts an Array of row-cell notations to a String.
+    #
+    # If +:replace+ is given, replaces undefined characters with +:replace+.
+    # Otherwise, raises ConversionError for undefined characters.
+    def to_str(s, options = {:replace => nil})
+      ret = s.map{|i| to_char(i)}
+      raise ConversionError if !options.has_key?(:replace) && ret.include?(nil)
+      ret.map{|i| i.nil? ? options[:replace] : i} * ''
+    end
+
+    protected
+    # :nodoc:
+    def encoding=(encoding)
+      @encoding = encoding
+    end
+
+    private
+    # :nodoc:
+    def valid?(x, y)
+      (1..94).include?(x) && (1..94).include?(y)
+    end
+  end
+end

data/lib/tabular_code/ksx1001.rb

@@ -0,0 +1,32 @@
+require "tabular_code/base"
+
+module TabularCode
+  # KSX1001 code.
+  #
+  # [Language] Korean
+  # [National standard] KS X 1001:1992
+  # [Size] 8224 characters (2350 hangul, 4888 hanja)
+  # [Layout]
+  #   * *01-02* General graphic characters (163 characters)
+  #   * *03* Full-width ASCII characters (94 characters)
+  #   * *04* Hangul letters (94 characters)
+  #   * *05* Roman numerals (20 characters) and Greek letters (48 characters)
+  #   * *06* Box drawing characters (68 characters)
+  #   * *07* Units of measurement (79 characters)
+  #   * *08* Latin capital letters (11 characters), ordinal indicator (2 characters), circled characters (69 characters) and vulgar fractions (9 characters)
+  #   * *09* Latin small letters (16 characters), parenthesized characters (69 characters), superscripts (5 characters) and subscripts (4 characters)
+  #   * *10* Hiragana (83 characters)
+  #   * *11* Katakana (86 characters)
+  #   * *12* Cyrillic letters (66 characters)
+  #   * *16-40* Hangul characters (2350 characters)
+  #   * *41* User-definable positions (94 positions)
+  #   * *42-93* Hanja characters (4888 characters),
+  #     with 268 duplicate hanja
+  #   * *94* User-definable positions (94 positions)
+  #   * Empty positions (424 positions)
+  module KSX1001
+    extend Base
+
+    self.encoding = Encoding::EUC_KR
+  end
+end

data/lib/tabular_code/kuten.rb

@@ -0,0 +1,26 @@
+require "tabular_code/base"
+
+module TabularCode
+  # Kuten code.
+  #
+  # [Language] Japanese
+  # [National standard] JIS X 0208:1997
+  # [Size] 6879 characters (6355 kanji)
+  # [Layout]
+  #   * *01-02* Special characters (147 characters)
+  #   * *03* Digits (10 characters) and Latin letters (52 characters)
+  #   * *04* Hiragana (83 characters)
+  #   * *05* Katakana (86 characters)
+  #   * *06* Greek letters (48 characters)
+  #   * *07* Cyrillic letters (66 characters)
+  #   * *08* Box drawing characters (32 characters)
+  #   * *16-47* The kanji in level 1, arranged according to
+  #     representative reading (2965 characters)
+  #   * *48-84* The kanji in level 2, arranged according to
+  #     primary radical and stroke count (3390 characters)
+  module Kuten
+    extend Base
+
+    self.encoding = Encoding::EUC_JP
+  end
+end

data/lib/tabular_code/quwei.rb

@@ -0,0 +1,28 @@
+require "tabular_code/base"
+
+module TabularCode
+  # Quwei code.
+  #
+  # [Language] Simplified Chinese
+  # [National standard] GB 2312-80
+  # [Size] 7445 characters (6763 Chinese characters)
+  # [Layout]
+  #   * *01* Comprising punctuation and other special characters (94 characters)
+  #   * *02* Numerals (72 characters)
+  #   * *03* Full-width ASCII characters (94 characters)
+  #   * *04* Hiragana (83 characters)
+  #   * *05* Katakana (86 characters)
+  #   * *06* Greek letters (48 characters)
+  #   * *07* Cyrillic letters (66 characters)
+  #   * *08* Pinyin (26 characters) and Bopomofo (37 characters)
+  #   * *09* Box drawing characters (76 characters)
+  #   * *16-55* the first plane for Chinese characters,
+  #     arranged according to pinyin (3755 characters)
+  #   * *56-87* the second plane for Chinese characters,
+  #     arranged according to radical and strokes (3008 characters)
+  module Quwei
+    extend Base
+
+    self.encoding = Encoding::EUC_CN
+  end
+end

data/lib/tabular_code/version.rb

@@ -0,0 +1,4 @@
+module TabularCode
+  # :nodoc:
+  VERSION = "0.1.0"
+end

data/spec/tabular_code/ksx1001_spec.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'tabular_code/ksx1001'
+
+tests = {
+  '我' => 6818,
+  '愛' => 6881,
+  '안' => 3040,
+  '녕' => 1971,
+  'あ' => 1002,
+  'イ' => 1104,
+  'Ａ' => 333,
+  '　' => 101,
+  '。' => 103
+}
+
+describe TabularCode::KSX1001 do
+  describe '.from_char' do
+    it 'converts valid character to corresponding code' do
+      tests.each do |i, j|
+        TabularCode::KSX1001.from_char(i).should == j
+      end
+    end
+
+    it 'converts invalid character to nil' do
+      %w(垚 爱 ℵ 펲).each do |i|
+        TabularCode::KSX1001.from_char(i).should be_nil
+      end
+    end
+  end
+
+  describe '.to_char' do
+    it 'converts valid code to corresponding character' do
+      tests.each do |i, j|
+        TabularCode::KSX1001.to_char(j).should == i
+      end
+    end
+
+    it 'converts invalid code to nil' do
+      [-1, 32, 1234, 3600, 9999].each do |i|
+        TabularCode::KSX1001.to_char(i).should be_nil
+      end
+    end
+  end
+end

data/spec/tabular_code/kuten_spec.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'tabular_code/kuten'
+
+tests = {
+  '我' => 1870,
+  '愛' => 1606,
+  '氷' => 4125,
+  '妛' => 5412,
+  'あ' => 402,
+  'イ' => 504,
+  'Ａ' => 333,
+  '　' => 101,
+  '。' => 103
+}
+
+describe TabularCode::Kuten do
+  describe '.from_char' do
+    it 'converts valid character to corresponding kuten code' do
+      tests.each do |i, j|
+        TabularCode::Kuten.from_char(i).should == j
+      end
+    end
+
+    it 'converts invalid character to nil' do
+      %w(垚 爱 ℵ 한).each do |i|
+        TabularCode::Kuten.from_char(i).should be_nil
+      end
+    end
+  end
+
+  describe '.to_char' do
+    it 'converts valid kuten code to corresponding character' do
+      tests.each do |i, j|
+        TabularCode::Kuten.to_char(j).should == i
+      end
+    end
+
+    it 'converts invalid kuten code to nil' do
+      [-1, 32, 1234, 3600, 9999].each do |i|
+        TabularCode::Kuten.to_char(i).should be_nil
+      end
+    end
+  end
+end

data/spec/tabular_code/quwei_spec.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+
+require 'tabular_code/quwei'
+
+tests = {
+  '我' => 4650,
+  '爱' => 1614,
+  '你' => 3667,
+  'あ' => 402,
+  'イ' => 504,
+  'Ａ' => 333,
+  '　' => 101,
+  '。' => 103
+}
+
+
+describe TabularCode::Quwei do
+  describe '.from_char' do
+    it 'converts valid character to corresponding quwei code' do
+      tests.each do |i, j|
+        TabularCode::Quwei.from_char(i).should == j
+      end
+    end
+
+    it 'converts invalid character to nil' do
+      %w(圡 喆 ℵ 한).each do |i|
+        TabularCode::Quwei.from_char(i).should be_nil
+      end
+    end
+  end
+
+  describe '.to_char' do
+    it 'converts valid quwei code to corresponding character' do
+      tests.each do |i, j|
+        TabularCode::Quwei.to_char(j).should == i
+      end
+    end
+
+    it 'converts invalid quwei code to nil' do
+      [-1, 32, 1234, 3600, 9999].each do |i|
+        TabularCode::Quwei.to_char(i).should be_nil
+      end
+    end
+  end
+
+  describe '.from_str' do
+    it 'converts string to array of quwei codes' do
+      TabularCode::Quwei.from_str('榕溶熔').
+        should == [7337, 4060, 4059]
+    end
+
+    it 'replaces bad characters with nil' do
+      TabularCode::Quwei.from_str('镕榕溶熔塎').
+        should == [nil, 7337, 4060, 4059, nil]
+    end
+
+    it 'replaces bad characters with :replace' do
+      TabularCode::Quwei.from_str('镕榕溶熔塎', :replace => -1).
+        should == [-1, 7337, 4060, 4059, -1]
+    end
+
+    it 'raises error when :replace is empty' do
+      ->{ TabularCode::Quwei.from_str('镕榕溶熔塎', {}) }.
+        should raise_error(TabularCode::ConversionError)
+    end
+  end
+
+  describe '.to_str' do
+    it 'converts array of quwei codes to string' do
+      TabularCode::Quwei.to_str([*1601 .. 1605]).
+        should == '啊阿埃挨哎'
+    end
+
+    it 'ignores bad codes' do
+      TabularCode::Quwei.to_str([*1600 .. 1605]).
+        should == '啊阿埃挨哎'
+    end
+
+    it 'replaces bad codes with :replace' do
+      TabularCode::Quwei.to_str([*1600 .. 1605], :replace => '?').
+        should == '?啊阿埃挨哎'
+    end
+
+    it 'raises error when :replace is empty' do
+      ->{ TabularCode::Quwei.to_str([*1600 .. 1605], {}) }.
+        should raise_error(TabularCode::ConversionError)
+    end
+  end
+end

data/tabular_code.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tabular_code/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "tabular_code"
+  gem.version       = TabularCode::VERSION
+  gem.authors       = ["Zejun Wu"]
+  gem.email         = ["zejun.wu@gmail.com"]
+  gem.description   = %q{Convertion for tabular codes like Chinese quwei and Japanese kuten}
+  gem.summary       = %q{Convertion for tabular codes like quwei and kuten}
+  gem.homepage      = "https://github.com/watashi/tabular_code"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: tabular_code
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Zejun Wu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-19 00:00:00.000000000 Z
+dependencies: []
+description: Convertion for tabular codes like Chinese quwei and Japanese kuten
+email:
+- zejun.wu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tabular_code.rb
+- lib/tabular_code/base.rb
+- lib/tabular_code/ksx1001.rb
+- lib/tabular_code/kuten.rb
+- lib/tabular_code/quwei.rb
+- lib/tabular_code/version.rb
+- spec/tabular_code/ksx1001_spec.rb
+- spec/tabular_code/kuten_spec.rb
+- spec/tabular_code/quwei_spec.rb
+- tabular_code.gemspec
+homepage: https://github.com/watashi/tabular_code
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Convertion for tabular codes like quwei and kuten
+test_files:
+- spec/tabular_code/ksx1001_spec.rb
+- spec/tabular_code/kuten_spec.rb
+- spec/tabular_code/quwei_spec.rb