a-b-chi 1.1.3 → 1.2.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTVjMTRmMGE5YmYzZTllN2VhZWMyMWQ4YTAwOGU4MGQyMzM3YjEwYQ==
+    NTk2NDI4YjNjYTZhZTE4ZWExODgwOGU4MjAwZGY2MDAxMmUyZWQzYw==
   data.tar.gz: !binary |-
-    YmRkODY5Y2NjMDI1YmJmMTM2ZjAyYWZhZjgyNGVjMzEzOTMxNTJjYg==
+    MzAyYzRlYzdjYjExMGQ4ZTQ0M2U5MjQ1NTg4ZmNhNmE0ZDZlMWFkOQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZGU1MzBmNDA2MzRhMDM1YmQxYzVmNjQ3OGFjMGZhNzQ4ZGI4M2ExN2Q1N2Qx
-    NTlhNDQ0MDVkNTcwMDliNzg2MjIzZWI1ZTc2Y2NjYmMxZTMyNTlkNTNiYzM2
-    ODFkYTFjODcyODcyNzk4NzFlNGUyMDU4ZGQwOTU3YzYwY2ZhMGI=
+    ZTMwZGZlYmY3MjNlZGZmYzkwMzEwNTc3MzVlYTFkNzc2YmM3NzQ4ZmUyMTk1
+    Zjg5NDY2ZTNiN2RkNmY3NjQxNTExMzQ3MmUxYzZkMDRlNjk0ODg3MjU1YTU4
+    NTc5YjFlMDlkNzAyNTUwZjU3NzJmZjFkNDllYmM2ODdiMTUzOTY=
   data.tar.gz: !binary |-
-    NjE0ZjRlYmMxNzhjNDdlNWQ4MWU3ZTIyZWFhMDg2MDYyMmU4N2ZmNWIwMzQ0
-    ODU1YWY2MjMyZDhmNjhhYzcyMjMyZTFjOTA4Njk0ZTU4NDhkYjJjOTYwOThm
-    ZGY1MGI3MTIzMzQyZDNlNjZlMjJhOTUyYjk5MmYwOTdmYWEyM2I=
+    ZDg2YzU4OWEzYWFjM2U2ZmFkY2E0OGUyYWJkYzZhY2NiOTU2YjhkOTdlMjY1
+    MmJiMjRjYTk5M2ZjYmRkMTBjZjlhYTcyMDQ5Nzk5OTYxNzAxMWRjYTZhMGIz
+    OGQ3MTYyNzk1MDI3MzFkNjRmYzVhN2I1NDk2YTViN2YxYmZiY2U=

data/README.md

@@ -0,0 +1,55 @@
+A-B-Chi
+=========
+In the Morning!
+
+A-B-Chi is a RubyGem aimed at making the process of sorting Chinese Traditional characters easy without having to change database collation settings (I personally couldnt work them out).
+
+I have been wroking in Taiwan for the last year on a CRM-type database and have learned quite a bit about Chinese Traditional characters and their attributes. after pulling my hair out over collation I decided that the best thing to do would be to make my own solution and as I notice that a lot of other people have similar problems I wanted to make this publically available.
+
+
+There are a few extra functions that I plan to implement in the future which include
+
+  - Character to BoPoMoFo (pronunciation characters) and other various things - perhaps a ruby text function or two.
+  - Handling of English and Chinese Simplified Characters.
+  - Base everything around the utf-8 character codes rather than a list of characters.
+
+Version
+-
+
+1.1.3
+
+Further Info
+-----------
+- I have compiled an extensive database of each Chinese Traditional character and its attributes indluding each different pronunciation of it and will be implementing this in awesome ways in the future. This contains just shy of 16,000 entries.
+
+- If you want to know about BoPoMoFo, I recommend reading the Wikipedia entry on it: http://en.wikipedia.org/wiki/Bopomofo
+
+- You should also check out the Taiwan Government's official write-up on their standards which can be found here: http://www.cns11643.gov.tw/AIDB/encodings_en.do
+
+
+Installation
+--------------
+
+```gem install a-b-chi```
+or for bundler add the following to your Gemfile
+```gem 'a-b-chi'```
+
+The sourcecode can be found at https://github.com/nallan/a-b-chi
+
+Usage
+--------------
+
+firstly require the file in your project
+```require 'a-b-chi'```
+next you must create a new instance of the ArrayChinese class and populate your array
+```arr = ArrayChinese.new
+arr.push "李依恬", "李雲帆", "珍項小珍", "瑞芳", "李宗翰"
+```
+finally run the sort method on this. both sort and sort! are supported
+```arr.sort
+arr.sort!```
+
+License
+-
+
+MIT

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/a-b-chi.rb

@@ -1,34 +1,39 @@
 #encoding:utf-8
 
 class ArrayChinese < Array
+  alias array_sort sort
+  alias array_sort_by sort_by
+  alias array_sort_by! sort_by!
 
   def initialize
     spec = Gem::Specification.find_by_name("a-b-chi")
     gem_root = spec.gem_dir
     gem_lib = gem_root + "/lib"
     @characters = File.read("#{gem_lib}/characters.txt").split("\n")
-
   end
 
   def sort
-    max_length = self.max_by(&:length).length
-    search_query = '['
-    for i in 0..max_length
-      unless i == max_length
-        search_query  << "@characters.index(sort_string[#{i}]), "
-      else
-        search_query  << "@characters.index(sort_string[#{i}])]"
-      end
-    end
-    self.sort_by! { |sort_string| eval(search_query) }
+    self.array_sort_by { |sort_string| eval(get_sort_query) }
   end
 
-end
+  def sort!
+    self.array_sort_by! { |sort_string| eval(get_sort_query) }
+  end
 
-class BoPoMoFo < String
-  
-  def initialize
-  
+#  def sort_by(*args)
+#    puts args.inspect  
+#    self.array_sort_by! { |sort_string| eval(get_sort_query) }
+#  end
+
+private
+
+  def get_sort_query
+    max_length = self.max_by(&:length).length
+    sort_query = '['
+      (0..max_length).each { |i| sort_query  << " @characters.index(sort_string[#{i}])," }
+      sort_query.chop!
+    sort_query << ']'
+    return sort_query
   end
-  
+
 end

data/lib/characters.txt

@@ -1,3 +1,4 @@
+ 
 八
 仈
 巴
@@ -13137,3 +13138,97 @@
 佣
 醟
 鍀
+0
+1
+2
+3
+4
+5
+6
+7
+8
+9
+A
+a
+B
+b
+C
+c
+D
+d
+E
+e
+F
+f
+G
+g
+H
+h
+I
+i
+J
+j
+K
+k
+L
+l
+M
+m
+N
+n
+O
+o
+P
+p
+Q
+q
+R
+r
+S
+s
+T
+t
+U
+u
+V
+v
+W
+w
+X
+x
+Y
+y
+Z
+z
+_
+!
+@
+#
+$
+%
+^
+&
+*
+(
+)
+-
+=
++
+`
+~
+[
+]
+{
+}
+|
+\
+;
+:
+'
+"
+,
+.
+<
+>
+/
+?

data/test/test_a-b-chi.rb

@@ -0,0 +1,35 @@
+#encoding: utf-8
+
+require 'test/unit'
+require 'a-b-chi'
+
+class ABChiTest < Test::Unit::TestCase
+
+  def test_string_sort
+    arr = ArrayChinese.new
+    arr.push "李依恬", "李雲帆", "珍項小珍", "瑞芳", "李宗翰", "李彩雲", "李璨亘", "李若喬", "李瑞雰",  "李彩喬",  "李素霞", "李依帆", "NallaN",  "彩依恬", "彩雲恬", "雲李", "雲則欣", "雲彩雲"
+    assert_equal ["李若喬", "李瑞雰", "李宗翰", "李彩喬", "李彩雲", "李璨亘", "李素霞", "李依帆", "李依恬", "李雲帆", "珍項小珍", "瑞芳", "彩依恬", "彩雲恬", "雲李", "雲則欣", "雲彩雲", "NallaN"],
+    arr.sort
+  end
+
+  def test_blank_array
+    arr = ArrayChinese.new
+    arr.push 
+    assert_equal [], arr.sort
+  end
+
+  def test_english_after_chinese
+    arr = ArrayChinese.new
+    arr.push "雲Z雲", "NallaN", "雲彩雲"
+    assert_equal ["雲彩雲", "雲Z雲", "NallaN"],
+    arr.sort
+  end
+  
+  def test_handling_of_unknown_characters
+    arr = ArrayChinese.new
+    arr.push "Z∂ß", "NallaN", "雲彩雲"
+    assert_equal ["雲彩雲", "NallaN", "Z∂ß"],
+    arr.sort
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: a-b-chi
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Nathanial Allan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-07 00:00:00.000000000 Z
+date: 2013-08-10 00:00:00.000000000 Z
 dependencies: []
 description: A gem that allows for the user to sort Chinese Traditional characters
   like a human (phonetically) rather than like a robot (stroke count)
@@ -17,15 +17,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Rakefile
+- README.md
 - lib/a-b-chi.rb
 - lib/characters.txt
+- test/test_a-b-chi.rb
 homepage: http://rubygems.org/gems/a-b-chi
 licenses:
 - MIT
 metadata: {}
-post_install_message: ! 'In The Morning to you! - I hope this makes your life easier!
-
-'
+post_install_message: ITM!
 rdoc_options: []
 require_paths:
 - lib