icunicode 0.1.4

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+*.bundle
+*.o
+pkg
+coverage

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Justin Balthrop
+
+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.rdoc

@@ -0,0 +1,43 @@
+= ICUnicode
+
+Unicode sorting is complicated (http://unicode.org/reports/tr10), and Ruby doesn't do it
+correctly. But there is a widely-used implementation of the Unicode collation algorithm in
+the ICU (International Components for Unicode) libraries. There is also no way to do
+Transliteration in Ruby (http://userguide.icu-project.org/transforms/general). This gem is
+a simple C wrapper around ucol_getSortKey from the ICU Collation API and utrans_transUChars
+from the ICU Transliteration API. These are added as simple methods on String.
+
+== Usage:
+
+  ["cafe", "cafes", "caf\303\251"].sort
+  => ["cafe", "cafes", "caf\303\251"]
+
+  require 'icunicode'
+
+  ["cafe", "cafes", "caf\303\251"].sort_by {|s| s.unicode_sort_key}
+  => ["cafe", "caf\303\251", "cafes"]
+
+  "blueberry".transliterate("Katakana").transliterate("Latin")
+  => "burueberrui"
+
+  "blueberry".transliterate("Greek").transliterate("Latin")
+  => "blyeberry"
+
+== Install:
+
+You must install ICU first. You can download the source from http://site.icu-project.org/download,
+or on Mac, you can install with MacPorts:
+
+  sudo port install icu
+
+Then install the gem:
+
+  sudo gem install icunicode
+
+== To do:
+
+Add support for locales other than en-US. Increase buffer size or make it grow dynamically.
+
+== License:
+
+Copyright (c) 2009 Justin Balthrop, Geni.com; Published under The MIT License, see LICENSE

data/Rakefile

@@ -0,0 +1,63 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "icunicode"
+    gem.summary = %Q{Unicode Transliteration and Collation in Ruby.}
+    gem.description = "ICU Unicode Transliteration and Collation in Ruby."
+    gem.email = "code@justinbalthrop.com"
+    gem.homepage = "http://github.com/ninjudd/icunicode"
+    gem.authors = ["Justin Balthrop"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies do
+  `cd ext && ruby extconf.rb && make && cp icunicode.bundle icunicode.o ../test/`
+end
+
+
+task :default => :test
+
+task :clean do
+  `rm -rf ext/lib ext/bin ext/sbin ext/share ext/include`
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "icunicode #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:build: 
+:major: 0
+:minor: 1
+:patch: 4

data/ext/.gitignore

@@ -0,0 +1,5 @@
+Makefile
+*.bundle
+*.o
+*.so
+mkmf.log

data/ext/extconf.rb

@@ -0,0 +1,4 @@
+require 'mkmf'
+have_library('icui18n')
+have_library('icuio')
+create_makefile('icunicode')

data/ext/icunicode.c

@@ -0,0 +1,114 @@
+#include "ruby.h"
+#include "unicode/ucol.h"
+#include "unicode/utrans.h"
+#include "unicode/ustring.h"
+#include "unicode/ustdio.h"
+
+#define BUF_SIZE 1000
+
+VALUE cTransliterator;
+VALUE trans_hash;
+
+static void to_utf16(VALUE string, UChar *ustr, int32_t *ulen) {
+  UErrorCode status = U_ZERO_ERROR;
+
+  string = StringValue(string);
+  u_strFromUTF8(ustr, BUF_SIZE, ulen, RSTRING_PTR(string), RSTRING_LEN(string), &status);
+  if (status == U_INVALID_CHAR_FOUND) ulen = 0;
+}
+
+static VALUE to_utf8(UChar *ustr, int32_t ulen) {
+  char str[BUF_SIZE];
+  int32_t len = 0;
+  UErrorCode status = U_ZERO_ERROR;
+
+  u_strToUTF8(str, BUF_SIZE, &len, ustr, ulen, &status);
+  if (status == U_INVALID_CHAR_FOUND) len = 0;
+  return rb_str_new(str, len);
+}
+
+/*
+ * call-seq:
+ * string.unicode_sort_key -> string
+ *
+ * Returns a string that will sort according to the Unicode collation algorithm.
+ *
+ */
+static VALUE unicode_sort_key(VALUE string) {
+  char str[BUF_SIZE];
+  UChar ustr[BUF_SIZE];
+  int32_t len  = 0;
+  int32_t ulen = 0;
+  UErrorCode status = U_ZERO_ERROR;
+  UCollator *col;
+
+  to_utf16(string, ustr, &ulen);
+
+  col = ucol_open("en_US", &status);
+  if (U_SUCCESS(status)) {
+    len = ucol_getSortKey(col, ustr, ulen, (uint8_t*)str, BUF_SIZE);
+    ucol_close(col);
+  }
+
+  return rb_str_new(str, len - 1);
+}
+
+static void trans_free(void *trans) {
+  utrans_close(trans);
+}
+
+static UTransliterator* get_trans(VALUE transform) {
+  UChar str[BUF_SIZE];
+  int32_t len = 0;
+  UTransliterator *trans;
+  UErrorCode status = U_ZERO_ERROR;
+  VALUE obj;
+
+  obj = rb_hash_aref(trans_hash, transform);
+  if (NIL_P(obj)) {
+    to_utf16(transform, str, &len);
+    trans = utrans_openU(str, len, UTRANS_FORWARD, NULL, 0, NULL, &status);
+    if (trans) {
+      obj = Data_Wrap_Struct(rb_cObject, 0, trans_free, trans);
+      rb_hash_aset(trans_hash, transform, obj);
+    } else {
+      rb_raise(rb_eArgError, "invalid transform: %s", RSTRING_PTR(transform));
+    }
+  }
+
+  Data_Get_Struct(obj, UTransliterator, trans);
+  return trans;
+}
+
+/*
+ * call-seq:
+ * string.transliterate(transform_string) -> string
+ *
+ * Transliterates string using transform.
+ *
+ */
+static VALUE unicode_transliterate(int argc, VALUE *argv, VALUE string) {
+  UChar str[BUF_SIZE];
+  int32_t slen = 0;
+  UErrorCode status = U_ZERO_ERROR;
+  UTransliterator *trans;
+  VALUE transform;
+
+  rb_scan_args(argc, argv, "01", &transform);
+  if (NIL_P(transform)) transform = rb_str_new2("Latin; Lower; NFD; [^[:letter:] [:space:] [0-9] [:punctuation:]] Remove; NFC");
+
+  to_utf16(string, str, &slen);
+
+  trans = get_trans(transform);
+  utrans_transUChars(trans, str, &slen, BUF_SIZE, 0, &slen, &status);
+
+  to_utf8(str, slen);
+}
+
+void Init_icunicode() {
+  rb_define_method(rb_cString, "unicode_sort_key", unicode_sort_key, 0);
+  rb_define_method(rb_cString, "transliterate", unicode_transliterate, -1);
+
+  trans_hash = rb_hash_new();
+  rb_global_variable(&trans_hash);
+}

data/icunicode.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{icunicode}
+  s.version = "0.1.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Justin Balthrop"]
+  s.date = %q{2010-08-26}
+  s.description = %q{ICU Unicode Transliteration and Collation in Ruby.}
+  s.email = %q{code@justinbalthrop.com}
+  s.extensions = ["ext/extconf.rb"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "ext/.gitignore",
+     "ext/extconf.rb",
+     "ext/icunicode.c",
+     "icunicode.gemspec",
+     "test/icunicode_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/ninjudd/icunicode}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Unicode Transliteration and Collation in Ruby.}
+  s.test_files = [
+    "test/icunicode_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/test/icunicode_test.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class UnicodeCollationTest < Test::Unit::TestCase
+  should "sort using unicode collation" do
+    assert_equal ["cafe", "café", "cafes"], ["cafe", "cafes", "café"].sort_by {|s| s.unicode_sort_key}
+    assert_equal ["role", "Role", "rôle"],  ["rôle", "role", "Role"].sort_by {|s| s.unicode_sort_key}
+    assert_equal ["cote", "coté", "côte", "côté"], ["côté", "coté", "cote", "côte"].sort_by {|s| s.unicode_sort_key}
+  end
+
+  should "transliterate" do
+    assert_equal "ムクドナルデ'ス",         "mcdonald's".transliterate('Katakana')
+    assert_equal "さむらい",               "samurai".transliterate('Hiragana')
+    assert_equal "θε γρεατ γρεεκ",         "the great greek".transliterate('Greek')
+    assert_equal "фром руссиа уитх лове", "from russia with love".transliterate('Cyrillic')
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'icunicode'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: icunicode
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 4
+  version: 0.1.4
+platform: ruby
+authors: 
+- Justin Balthrop
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-26 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: ICU Unicode Transliteration and Collation in Ruby.
+email: code@justinbalthrop.com
+executables: []
+
+extensions: 
+- ext/extconf.rb
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- ext/.gitignore
+- ext/extconf.rb
+- ext/icunicode.c
+- icunicode.gemspec
+- test/icunicode_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/ninjudd/icunicode
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Unicode Transliteration and Collation in Ruby.
+test_files: 
+- test/icunicode_test.rb
+- test/test_helper.rb