zhongwen_tools 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36a2e0463a764596b32d674fae73e6d70d5b35b0
-  data.tar.gz: 0695198696d219b954a7842929f2f9a29c27cb30
+  metadata.gz: 0cbbd4c2a34b34b4a989f68c60d95b03581b8c95
+  data.tar.gz: 7c5500e886bd0a24733b0cb4822b08a16b88cd28
 SHA512:
-  metadata.gz: 4f3910228f09b9ee451c91d102824b69219bc0a37eec00a8cb1199978ac9c6bfd9e6f528b2dc87ec08dcf1a25171e1de1a008ed58aefa756f45b602e228f916e
-  data.tar.gz: a5e68d15248041507fe3f125f8c2de36e8a60dcd3bf2d16c8a48020b2dbcf770ce3b74ea55b3a68b0e510b1b020c03c006bb0aab4e4b6c765aa09833e8314f9d
+  metadata.gz: 208dc99b54380cf448be2c35b2a20bb47a5e2b3b537f18fde291a653962297ce093266739ae8546952e126184b2cea0a3a9b3fbb9eae99383e7f380e2033055b
+  data.tar.gz: 1048a0cfbb2077702a99a1582db7576053ac28108326c47d420aabbd5cb934f90278a2c372b01591d544f2e76373539601747fd1b6a62447f82cab056e618585

data/.travis.yml

@@ -3,7 +3,7 @@ rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1.1
 
 matrix:
   include:

data/README.md

@@ -11,6 +11,18 @@ Install as a gem
 
     $ [sudo] gem install zhongwen_tools
 
+
+Zhongwen Tools is a set of modules that makes working with Chinese
+easier. It includes the following:
+
+1. ZhongwenTools::String - deals with strings that are Chinese or pinyin.
+2. ZhongwenTools::Numbers - identifies Chinese numbers and converts numbers to and from Chinese.
+3. ZhongwenTools::Integer - converts integers into Chinese or pinyin.
+4. ZhongwenTools::Romanization - converts converting between Chinese romanization systems like Pinyin and Wade-Giles.
+5. ZhongwenTools::Conversion - converts between Chinese scripts.
+
+
+
 ## Usage
 
 Add the ZhongwenTools component you need to your classes as a module.
@@ -22,74 +34,131 @@ Add the ZhongwenTools component you need to your classes as a module.
     end
 
     str = "ni3 hao3"  #pinyin with numbers
-    str.to_pinyin     #=> "nǐ hǎo"
-    str.to_zhuyin_fuhao  #=> "ㄋㄧ3 ㄏㄠ3"
+    str.to_pinyin
+    #=> "nǐ hǎo"
+
+    str.to_zhuyin_fuhao
+    #=> "ㄋㄧ3 ㄏㄠ3"
 
     mzd = "Mao Tse-tung"
-    mzd.to_pinyin   #=> "Mao Zedong"
+    mzd.to_pinyin
+    #=> "Mao Zedong"
 
-Or you can require the components you want
+Or require the components you want.
 
     require 'zhongwen_tools/numbers'
-    ZhongwenTools::Numbers.to_pyn '一百二十' #=> 'yi1-bai2-er4-shi2'
-
-ZhongwenTools includes the following Modules:
-
-1. ZhongwenTools::String - methods for dealing with strings with Chinese and pinyin.
-2. ZhongwenTools::Numbers - methods for identifying Chinese numbers and for converting to and from Chinese.
-3. ZhongwenTools::Integer - methods for converting integers into Chinese or pinyin.
-4. ZhongwenTools::Romanization - methods for converting between Chinese romanization systems.
-5. ZhongwenTools::Conversion - methods for converting between Chinese scripts.
 
+    ZhongwenTools::Numbers.to_pyn '一百二十'
+    #=> 'yi1-bai2-er4-shi2'
 
 ### Using ZhongwenTools::String
+Zhongwen Tools has string methods for detecting different string formats
+and for converting to and from halfwidth, fullwidth, and utf-8 codepoints.
+
     require 'zhongwen_tools/string'
-    ZhongwenTools::String.ascii? 'hello'               #=> true #non-multibyle strings
-    ZhongwenTools::String.multibyte? '中文'            #=> true #multibtye strings
-    ZhongwenTools::String.halfwidth? 'hello'           #=> true
-    ZhongwenTools::String.fullwidth? 'ｈｅｌｌｏ'       #=> true
-    ZhongwenTools::String.to_halfwidth 'ｈｅｌｌｏ'     #=> 'hello'
 
-    ZhongwenTools::String.uri_encode '我太懒'             #=> '%E6%88%91%E5%A4%AA%E6%87%92'
-    ZhongwenTools::String.to_codepoint '中文'            #=> '\u4e2d\u6587'
-    ZhongwenTools::String.from_codepoint '\u4e2d\u6587'   #=> '中文' #converts string from a utf-8 codepoint.
+    ZhongwenTools::String.ascii? 'hello'
+    #=> true #non-multibyle strings
+
+    ZhongwenTools::String.multibyte? '中文'
+    #=> true #multibtye strings
+
+    ZhongwenTools::String.halfwidth? 'hello'
+    #=> true
+
+    ZhongwenTools::String.fullwidth? 'ｈｅｌｌｏ'
+    #=> true
+
+    ZhongwenTools::String.to_halfwidth 'ｈｅｌｌｏ'
+    #=> 'hello'
 
-    ZhongwenTools::String.has_zh? '1月'     #=> true
-    ZhongwenTools::String.zh? '1月'         #=> false #(The string can't be mixed.)
+    ZhongwenTools::String.uri_encode '我太懒'
+    #=> '%E6%88%91%E5%A4%AA%E6%87%92'
 
-    ZhongwenTools::String.has_zh_punctuation? '你在哪里？'    #=> true
-    ZhongwenTools::String.strip_zh_punctuation? '你在哪里？'  #=> '你在哪里'
+    ZhongwenTools::String.to_codepoint '中文'
+    #=> '\u4e2d\u6587'
+
+    ZhongwenTools::String.from_codepoint '\u4e2d\u6587'
+    #=> '中文' #converts string from a utf-8 codepoint.
+
+
+#### Detecting Chinese or Chinese Punctuation.
+Zhongwen Tools can also detect if a string is or has Chinese or Chinese
+punctuation.
+
+	require 'zhongwen_tools/string'
+    ZhongwenTools::String.has_zh? '1月'
+    #=> true
+
+    ZhongwenTools::String.zh? '1月'
+    #=> false #(The string can't be mixed.)
+
+    ZhongwenTools::String.has_zh_punctuation? '你在哪里？'
+    #=> true
+    ZhongwenTools::String.strip_zh_punctuation? '你在哪里？'
+    #=> '你在哪里'
+
+#### Converting between Traditional and Simplified Chinese
+By requiring conversion module, ZhongwenTools::String gets some
+convenience methods for converting to and from traditional and
+simplified Chinese.
 
     require 'zhongwen_tools/conversion'
-    ZhongwenTools::String.zhs? '中国'    #=> true
-    ZhongwenTools::String.zht? '中国'    #=> false
 
+    ZhongwenTools::String.zhs? '中国'
+    #=> true
+    ZhongwenTools::String.zht? '中国'
+    #=> false
+
+#### Romanization
+By requiring the romanization module ZhongwenTools::String gets some
+convenience methods for dealing with romanization.
+    require 'zhongwen_tools/romanziation'
+
+    ZhongwenTools::String.to_pinyin 'ni3 hao3'
+    #=> "nǐ hǎo"
 
-#### The following capitalization methods work for pinyin.
+
+#### Pinyin-safe String Methods
+The following capitalization methods work for pinyin.
     require 'zhongwen_tools/string'
-    ZhongwenTools::String.downcase 'Àomén'  #=> 'àomén' does pinyin/ lowercase
-    ZhongwenTools::String.upcase 'àomén'    #=> 'ÀOMÉN'
-    ZhongwenTools::String.capitalize 'àomén'  #=> 'Àomén'
+
+    ZhongwenTools::String.downcase 'Àomén'
+    #=> 'àomén' does pinyin/ lowercase
+    ZhongwenTools::String.upcase 'àomén'
+    #=> 'ÀOMÉN'
+    ZhongwenTools::String.capitalize 'àomén'
+    #=> 'Àomén'
 
 #### Ruby 1.8 safe methods
 Zhongwen Tools is tested on every ruby since 1.8.7 and lets you deal
-with multibyte strings in an simple way.
+with multibyte strings in an simple, consistent fashion regardless of
+which ruby version you are using.
 
     require 'zhongwen_tools/string'
-    ZhongwenTools::String.chars '中文' #=> ['中','文']
-    ZhongwenTools::String.size '中文'  #=> 2
-    ZhongwenTools::String.reverse '中文' #=> '文中'
-    ZhongwenTools::String.to_utf8 '\x{D6D0}\x{CEC4}' => '中文'
+    ZhongwenTools::String.chars '中文'
+    #=> ['中','文']
+    ZhongwenTools::String.size '中文'
+    #=> 2
+    ZhongwenTools::String.reverse '中文'
+    #=> '文中'
+    ZhongwenTools::String.to_utf8 '\x{D6D0}\x{CEC4}'
+    #=> '中文'
 
 
 ### Numbers
 Functions for converting to and from Chinese numbers.
 
-    ZhongwenTools::Numbers.number_to_zht :num, 12000        #=> '一萬二千'
-    ZhongwenTools::Numbers.number_to_zhs :num, 42           #=> '四十二'
-    ZhongwenTools::Numbers.number_to_pyn :num, 42        #=> 'si4-shi2-er4'
-    ZhongwenTools::Numbers.zh_number_to_number '四十二'  #=> 42
-    ZhongwenTools::Numbers.number? '四十二'        #=> true
+    ZhongwenTools::Numbers.number_to_zht :num, 12000
+    #=> '一萬二千'
+    ZhongwenTools::Numbers.number_to_zhs :num, 42
+    #=> '四十二'
+    ZhongwenTools::Numbers.number_to_pyn :num, 42
+    #=> 'si4-shi2-er4'
+    ZhongwenTools::Numbers.zh_number_to_number '四十二'
+    #=> 42
+    ZhongwenTools::Numbers.number? '四十二'
+    #=> true
 
 ### Integers
 Monkey-patch your integers for Chinese.
@@ -98,8 +167,10 @@ Monkey-patch your integers for Chinese.
       include ZhongwenTools::Integer
     end
 
-    12.to_pinyin #=> 'shi2-er4'
-    12.to_zht    #=> '十二'
+    12.to_pinyin
+    #=> 'shi2-er4'
+    12.to_zht
+    #=> '十二'
 
 
 ### Romanization
@@ -116,17 +187,25 @@ scripts. It **does not convert Chinese characters to pinyin** (see ZhongwenTools
 
     str = "ni3 hao3"
 
-    str.to_pinyin     #=> "nǐ hǎo"
-    str.to_py         #=> "nǐ hǎo"
-    str.to_pyn       #=> "ni3 hao3"
-
-    str.to_wg       #=> "ni3 hao3"    #Wade-Giles
-    str.to_bpmf     #=> "ㄋㄧ3 ㄏㄠ3" #Zhuyin Fuhao, a.k.a. Bopomofo
-    str.to_yale     #=> "ni3 hau3"
+    str.to_pinyin
+    #=> "nǐ hǎo"
+    str.to_py
+    #=> "nǐ hǎo"
+    str.to_pyn
+    #=> "ni3 hao3"
+
+    str.to_wg
+    #=> "ni3 hao3"    #Wade-Giles
+    str.to_bpmf
+    #=> "ㄋㄧ3 ㄏㄠ3" #Zhuyin Fuhao, a.k.a. Bopomofo
+    str.to_yale
+    #=> "ni3 hau3"
     str.to_typy
 
-    str.pyn? #=> true
-    str.wg?  #=> true #(There can be overlap between Wade-Giles and Pinyin)
+    str.pyn?
+    #=> true
+    str.wg?
+    #=> true #(There can be overlap between Wade-Giles and Pinyin)
 
 ### Conversion
 Functions for converting between scripts (e.g. traditional Chinese to
@@ -137,11 +216,16 @@ Conversion methods must be required explicitly.
     gem 'zhongwen_tools'
     require 'zhongwen_tools/conversion'
 
-    ZhongwenTools::Conversion.to_zhs '華語' #=> '华语'
-    ZhongwenTools::Conversion.to_zht '华语' #=> '華語'
-    ZhongwenTools::Conversion.to_zhtw '方便面' #=> '泡麵'
-    ZhongwenTools::Conversion.to_zhhk '方便面' #=> '即食麵'
-    ZhongwenTools::Conversion.to_zhcn '即食麵' #=> '方便面'
+    ZhongwenTools::Conversion.to_zhs '華語'
+    #=> '华语'
+    ZhongwenTools::Conversion.to_zht '华语'
+    #=> '華語'
+    ZhongwenTools::Conversion.to_zhtw '方便面'
+    #=> '泡麵'
+    ZhongwenTools::Conversion.to_zhhk '方便面'
+    #=> '即食麵'
+    ZhongwenTools::Conversion.to_zhcn '即食麵'
+    #=> '方便面'
 
 
 ## TODO

data/lib/zhongwen_tools/numbers.rb

@@ -1,6 +1,7 @@
 #encoding: utf-8
 module ZhongwenTools
   module Numbers
+    extend self
 
     NUMBER_MULTIPLES = '拾十百佰千仟仟万萬亿億'
 

data/lib/zhongwen_tools/version.rb

@@ -1,3 +1,3 @@
 module ZhongwenTools
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

data/test/test_numbers.rb

@@ -12,11 +12,16 @@ class TestNumbers < Minitest::Test
     #your function sucks dick man
     @numbers.each do |num|
       number = zh_number_to_number num[:zh]
-      binding.pry if num[:en] != number
       assert_equal num[:en], number
     end
   end
 
+  def test_class_methods
+    i = rand @numbers.length
+    number = @numbers[i]
+    assert_equal number[:en], ZhongwenTools::Numbers.zh_number_to_number(number[:zh])
+  end
+
   def test_convert_to_traditional_number
     zhs = @numbers[0][:zh]
     zht = number_to_zht :zht, zhs

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zhongwen_tools
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Steven Daniels