cicu 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b8e72cfb8379d5249cf6965b45d6a774c1a4f8b
+  data.tar.gz: 43836e1ef235b269a90a53be442fa6fb90694a86
+SHA512:
+  metadata.gz: e9f16004c700fdf515fb0216a11af2071719fc475d65f76a0f136fa9439ca341ebfa70158db8ab716f6bafc181eea76c031ffe45230b308f956b088d5ad37a68
+  data.tar.gz: 5066582856134b980be1034fb73ca68c9fb40b5a41b95ff73b817aa46feacc87e8387a3539c65ae9de1394ce4b78b094aea1a01ac8bdb8e3e33d38b063984d24

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+language: ruby
+before_install:
+ - gem install bundler
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.0"
+  - "2.1.1"
+  - "2.1.2"
+  - "2.1.4"
+  - "2.1.8"
+  - "2.2.0"
+  - "2.3.2"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Dependencies are specified in cicu.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Benjamin Groessing
+
+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,52 @@
+# Cicu
+
+[![Build Status](https://travis-ci.org/groe/cicu.png?branch=master)](http://travis-ci.org/groe/cicu)
+
+Custom ICU rulesets for collation in ruby - requires libicu
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cicu'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cicu
+
+## Usage
+
+Create a ruleset
+
+```ruby
+ruleset = Cicu::Ruleset.new("[normalization on] & b < a < c")
+```
+
+Sort an array
+
+```ruby
+ary = %w( a b c ba bb bc )
+sorted_ary = ruleset.sort_by { |el| ruleset.sort_key(el) }
+# => "["b", "bb", "ba", "bc", "a", "c"]"
+```
+
+Get the sort key for a string
+
+```ruby
+ruleset.sort_key("abc")
+# => "*\x04)*\x05\x01\a\x01\a"
+```
+
+You can store sort keys in a database column to use them in `ORDER BY` queries. Make sure to use a column type that supports binary strings (e.g. MySQLs [VARBINARY](http://dev.mysql.com/doc/refman/5.7/en/binary-varbinary.html)).
+
+## 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,20 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'rake/extensiontask'
+
+desc "Cicu unit tests"
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.pattern = "spec/*_spec.rb"
+  t.verbose = true
+end
+
+gemspec = Gem::Specification.load('cicu.gemspec')
+Rake::ExtensionTask.new do |ext|
+  ext.name = 'cicu'
+  ext.source_pattern = "*.{c,h}"
+  ext.ext_dir = 'ext/cicu'
+  ext.lib_dir = 'lib/cicu'
+  ext.gem_spec = gemspec
+end
+
+task :default => [:compile, :test]

data/cicu.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cicu/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "cicu"
+  gem.version       = Cicu::VERSION
+  gem.authors       = ["Benjamin Groessing"]
+  gem.email         = ["contact@BYTEQ.com"]
+  gem.description   = %q{ Custom ICU rulesets for collation in ruby - requires libicu }
+  gem.summary       = %q{ Custom ICU rulesets for collation }
+  gem.homepage      = "https://github.com/groe/cicu"
+  gem.license       = "MIT"
+
+  gem.add_development_dependency "rspec", ">= 2.13.0"
+  gem.add_development_dependency "rake", ">= 1.9.1"
+  gem.add_development_dependency "rake-compiler", ">= 0.8.3"
+
+  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.extensions    = gem.files.grep(%r{/extconf\.rb$})
+  gem.require_paths = ["lib"]
+end

data/ext/cicu/cicu.c

@@ -0,0 +1,82 @@
+#include "cicu.h"
+
+#include <unicode/ustring.h>
+
+#define BUF_SIZE 10000
+
+static void str_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 ruleset_allocate(VALUE klass)
+{
+  UCollator *collator = NULL;
+
+  return Data_Wrap_Struct(klass, NULL, ruleset_deallocate, collator);
+}
+
+static void ruleset_deallocate(void * collator)
+{
+  if(collator != NULL) {
+    ucol_close(collator);
+  }
+}
+
+static VALUE ruleset_initialize(VALUE self, VALUE rules) {
+  UChar uRules[BUF_SIZE];
+  UErrorCode status = U_ZERO_ERROR;
+  int32_t uRulesLen = 0;
+  UCollator *collator;
+
+  if (TYPE(rules) != T_STRING) {
+    rb_raise(rb_eTypeError, "rules must be a string");
+  }
+  if (RSTRING_LEN(rules) > BUF_SIZE) {
+    rb_raise(rb_eArgError, "given ruleset string exceeds buffer size");
+  }
+
+  str_to_utf16(rules, uRules, &uRulesLen);
+  collator = ucol_openRules(uRules, uRulesLen, UCOL_ON, UCOL_DEFAULT_STRENGTH, NULL, &status); 
+
+  if (U_SUCCESS(status)) {
+    DATA_PTR(self) = collator;
+  }
+  else {
+    rb_raise(rb_eArgError, "Failed to initialize ICU ruleset");
+  }
+
+  return self;
+}
+
+static VALUE ruleset_sort_key(VALUE self, VALUE string) {
+  UCollator *collator;
+  char str[BUF_SIZE];
+  UChar ustr[BUF_SIZE];
+  int32_t len = 0;
+  int32_t uLen = 0;
+
+  if (TYPE(string) != T_STRING) {
+    rb_raise(rb_eTypeError, "sort_key expects a string argument");
+  }
+  if (RSTRING_LEN(string) > BUF_SIZE) {
+    rb_raise(rb_eArgError, "given string for sort_key exceeds buffer size");
+  }
+
+  Data_Get_Struct(self, UCollator, collator);
+  str_to_utf16(string, ustr, &uLen);
+  len = ucol_getSortKey(collator, ustr, uLen, (uint8_t*)str, BUF_SIZE);
+
+  return rb_str_new(str, len-1);
+}
+
+void Init_cicu() {
+  VALUE rb_mCicu = rb_define_module("Cicu");
+  VALUE rb_cRuleset = rb_define_class_under(rb_mCicu, "Ruleset", rb_cObject);
+  rb_define_alloc_func(rb_cRuleset, ruleset_allocate);
+  rb_define_method(rb_cRuleset, "initialize", ruleset_initialize, 1);
+  rb_define_method(rb_cRuleset, "sort_key", ruleset_sort_key, 1);
+}

data/ext/cicu/cicu.h

@@ -0,0 +1,14 @@
+#include <ruby.h>
+#include <unicode/ucol.h>
+
+static void str_to_utf16(VALUE, UChar *, int32_t*);
+
+static VALUE ruleset_allocate(VALUE);
+
+static void ruleset_deallocate(void *);
+
+static VALUE ruleset_initialize(VALUE, VALUE);
+
+static VALUE ruleset_sort_key(VALUE, VALUE);
+
+void Init_cicu();

data/ext/cicu/extconf.rb

@@ -0,0 +1,5 @@
+# ext/cicu/extconf.rb
+require 'mkmf'
+have_library('icui18n')
+have_library('icuio')
+create_makefile('cicu/cicu')

data/lib/cicu.rb

@@ -0,0 +1,6 @@
+require "cicu/version"
+require "cicu/cicu"
+
+module Cicu
+  
+end

data/lib/cicu/version.rb

@@ -0,0 +1,3 @@
+module Cicu
+  VERSION = "0.0.1"
+end

data/spec/cicu_spec.rb

@@ -0,0 +1,36 @@
+require 'cicu'
+
+describe Cicu::Ruleset do
+  describe "#new" do
+    it "should raise ArgumentError if rules are invalid" do
+      expect(proc { Cicu::Ruleset.new("?") }).to raise_exception(ArgumentError)
+    end
+    it "should raise TypeError if argument is not a string" do
+      expect(proc { Cicu::Ruleset.new([123]) }).to raise_exception(TypeError)
+    end
+    it "should raise ArgumentError if rules are too long" do
+      rules = "[normalization on] & " + 100_000.times.map { "a" }.join("<")
+      expect(proc { Cicu::Ruleset.new(rules) }).to raise_exception(ArgumentError)
+    end
+    it "should create a ruleset if rules are not too long" do
+      ruleset = Cicu::Ruleset.new("[normalization on] & a < a < a < a < a < a")
+      expect(ruleset.sort_key("123")).to eq("\x14\x16\x18\x01\a\x01\a")
+    end
+    it "should create a ruleset" do
+      ruleset = Cicu::Ruleset.new("[normalization on] & a")
+      expect(ruleset.sort_key("123")).to eq("\x14\x16\x18\x01\a\x01\a")
+    end
+  end
+  describe "#sort_key" do
+    it "should raise TypeErrorif argument is not a string" do
+      ruleset = Cicu::Ruleset.new("[normalization on] & b < a < c")
+      expect(proc { ruleset.sort_key([123]) }).to raise_exception(TypeError)
+    end
+    it "should sort any array according to the rukes" do
+      ary = %w( a b c ba bb bc )
+      ruleset = Cicu::Ruleset.new("[normalization on] & b < a < c")
+      sorted_ary = ary.sort_by { |el| ruleset.sort_key(el) }
+      expect(sorted_ary).to eq(%w( b bb ba bc a c ))
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: cicu
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Benjamin Groessing
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-17 00:00:00.000000000 Z
+dependencies:
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+description: " Custom ICU rulesets for collation in ruby - requires libicu "
+email:
+- contact@BYTEQ.com
+executables: []
+extensions:
+- ext/cicu/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cicu.gemspec
+- ext/cicu/cicu.c
+- ext/cicu/cicu.h
+- ext/cicu/extconf.rb
+- lib/cicu.rb
+- lib/cicu/icubo.so
+- lib/cicu/version.rb
+- spec/cicu_spec.rb
+homepage: https://github.com/groe/cicu
+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.2.5
+signing_key: 
+specification_version: 4
+summary: Custom ICU rulesets for collation
+test_files:
+- spec/cicu_spec.rb