charlock_holmes-jruby 0.1.0-java

data/.rspec

@@ -0,0 +1,4 @@
+-Ilib
+--color
+--format doc
+spec

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    charlock_holmes-jruby (0.1.0-java)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.1)
+    rake (10.0.4)
+    rake-compiler (0.8.3)
+      rake
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+
+PLATFORMS
+  java
+
+DEPENDENCIES
+  charlock_holmes-jruby!
+  rake
+  rake-compiler (>= 0.7.5)
+  rspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Francis Chong francis@ignition.hk
+
+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,65 @@
+# CharlockHolmes for JRuby
+
+Character encoding detecting library for JRuby using [ICU4J](http://site.icu-project.org/).
+
+## Requirements
+
+- JRuby in 1.9 mode (or above)
+
+## Usage
+
+First you'll need to require it
+
+```
+require 'charlock_holmes'
+```
+
+## Encoding detection
+
+```ruby
+contents = File.read('test.xml')
+detection = CharlockHolmes::EncodingDetector.detect(contents)
+# => {:encoding => 'UTF-8', :confidence => 100}
+
+# optionally there will be a :language key as well, but
+# that's mostly only returned for legacy encodings like ISO-8859-1
+```
+
+NOTE: ```CharlockHolmes::EncodingDetector.detect``` will return nil if it was unable to find an encoding.
+
+## String monkey patch
+
+Alternatively, you can just use the detect_encoding method on the String class
+
+```
+require 'charlock_holmes/string'
+
+contents = File.read('test.xml')
+
+detection = contents.detect_encoding
+# => {:encoding => 'UTF-8', :confidence => 100}
+
+# this will detect and set the encoding of `contents`, then return self
+contents.detect_encoding!
+```
+
+## Transcoding
+
+Being able to detect the encoding of some arbitrary content is nice, but what you probably want is to be able to transcode that content into an encoding your application is using.
+
+```
+
+content = File.read('test2.txt')
+detection = CharlockHolmes::EncodingDetector.detect(content)
+utf8_encoded_content = CharlockHolmes::Converter.convert content, detection[:encoding], 'UTF-8'
+```
+
+The first parameter is the content to transcode, the second is the source encoding (the encoding the content is assumed to be in), and the third parameter is the destination encoding.
+
+## Installing
+
+```
+gem install charlock_holmes_jruby
+```
+
+

data/Rakefile

@@ -0,0 +1,17 @@
+$LOAD_PATH << 'lib'
+
+require 'rake/testtask'
+require 'charlock_holmes/version'
+
+task :package do
+  version_string = "v#{CharlockHolmes::VERSION}"
+  system %(gem build charlock_holmes-jruby.gemspec)
+end
+
+task :release => :package do
+  version_string = "v#{CharlockHolmes::VERSION}"
+  unless %x(git tag -l).include?(version_string)
+    system %(git tag -a #{version_string} -m #{version_string})
+  end
+  system %(gem push charlock_holmes-jruby-*.gem && mv charlock_holmes-jruby-*.gem pkg)
+end

data/charlock_holmes-jruby.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require './lib/charlock_holmes/version' unless defined? CharlockHolmes::VERSION
+
+Gem::Specification.new do |s|
+  s.name = %q{charlock_holmes-jruby}
+  s.version = CharlockHolmes::VERSION
+  s.platform = 'java'
+  s.authors = ["Francis Chong"]
+  s.date = Time.now.utc.strftime("%Y-%m-%d")
+  s.email = %q{francis@ignition.hk}
+
+  s.files = `git ls-files`.split("\n")
+  s.homepage = %q{http://github.com/siuying/charlock_holmes-jruby}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.4.2}
+  s.summary = %q{Character encoding detection, brought to you by ICU.}
+  s.description = %q{JRuby compatible ICU encoding detection build on top of ICU4J.}
+  s.test_files = `git ls-files spec`.split("\n")
+
+  s.add_development_dependency 'rake-compiler', ">= 0.7.5"
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rake'
+end

data/lib/charlock_holmes-jruby.rb

@@ -0,0 +1 @@
+require 'charlock_holmes'

data/lib/charlock_holmes.rb

@@ -0,0 +1,5 @@
+require 'charlock_holmes/version'
+require CharlockHolmes::ICU_JAR_FILENAME
+
+require 'charlock_holmes/encoding_detector'
+require 'charlock_holmes/converter'

data/lib/charlock_holmes/charset_match_ext.rb

@@ -0,0 +1,17 @@
+require_relative 'version'
+require_relative "../#{CharlockHolmes::ICU_JAR_FILENAME}"
+java_import 'com.ibm.icu.text.CharsetMatch'
+
+module CharlockHolmes
+  module CharsetMatchExt
+    def to_hash
+      {
+        encoding: self.getName(),
+        confidence: self.getConfidence(),
+        language: self.getLanguage()
+      }
+    end
+  end
+end
+
+com::ibm::icu::text::CharsetMatch.send :include, CharlockHolmes::CharsetMatchExt

data/lib/charlock_holmes/converter.rb

@@ -0,0 +1,12 @@
+module CharlockHolmes
+  module Converter
+    extend self
+
+    def convert(string, from, to)
+      raise TypeError.new("string cannot be nil") unless string
+      raise TypeError.new("from cannot be nil") unless from
+      raise TypeError.new("to cannot be nil") unless to
+      string.encode(to, from)
+    end
+  end
+end

data/lib/charlock_holmes/encoding_detector.rb

@@ -0,0 +1,54 @@
+require_relative 'version'
+require_relative "../#{CharlockHolmes::ICU_JAR_FILENAME}"
+require_relative 'charset_match_ext'
+
+java_import 'com.ibm.icu.text.CharsetDetector'
+java_import 'java.io.ByteArrayInputStream'
+
+module CharlockHolmes
+  module EncodingDetector
+    extend self
+
+    def detect(string, hint=nil)
+      detector = create_detector(string, hint)
+
+      begin
+        if charset_match = detector.detect()
+          charset_match.to_hash
+        else
+          nil
+        end
+      rescue
+        nil
+      end
+    end
+
+    def detect_all(string, hint=nil)
+      detector = create_detector(string, hint)
+
+      begin
+        if charset_matchs = detector.detectAll()
+          charset_matchs.collect {|match| match.to_hash }
+        else
+          nil
+        end
+      rescue
+        nil
+      end
+    end
+
+    def all_detectable_charsets
+      CharsetDetector.getAllDetectableCharsets().to_a
+    end
+
+    private
+    def create_detector(string, hint=nil)
+      detector = CharsetDetector.new
+      detector.setText ByteArrayInputStream.new(string.to_java_bytes)
+      detector.setDeclaredEncoding(hint)
+      detector
+    end
+  end
+
+
+end

data/lib/charlock_holmes/string.rb

@@ -0,0 +1,21 @@
+require_relative 'encoding_detector'
+
+module CharlockHolmes
+  module StringExt
+    def detect_encoding(hint=nil)
+      EncodingDetector.detect(self, hint)
+    end
+
+    def detect_encodings(hint=nil)
+      EncodingDetector.detect_all(self, hint)
+    end
+
+    def detect_encoding!(hint=nil)
+      detected = EncodingDetector.detect(self, hint)
+      self.force_encoding(detected[:encoding]) if detected[:encoding]
+      self
+    end
+  end
+end
+
+String.send :include, CharlockHolmes::StringExt

data/lib/charlock_holmes/version.rb

@@ -0,0 +1,5 @@
+module CharlockHolmes
+  VERSION           = "0.1.0"
+  ICU_VERSION       = "51.1"
+  ICU_JAR_FILENAME  = "icu4j-51_1.jar"
+end

data/lib/charlock_holmes_jruby.rb

@@ -0,0 +1 @@
+require 'charlock_holmes'

data/spec/converter_spec.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+require 'spec_helpers'
+require 'charlock_holmes'
+
+describe CharlockHolmes::Converter do
+  subject { CharlockHolmes::Converter }
+
+  describe "#convert" do 
+    it "should convert ascii from iso8859-1 to utf-16 and back" do
+      input = 'test'
+
+      output = subject.convert input, 'ISO-8859-1', 'UTF-16'
+      output.encoding.to_s.should == "UTF-16"
+      input.bytesize.should < output.bytesize
+      input.should_not == output
+
+      output = subject.convert output, 'UTF-16', 'ISO-8859-1'
+      output.encoding.to_s.should == "ISO-8859-1"
+      input.bytesize.should == output.bytesize
+      input.should == output
+    end
+
+    it "should convert utf8 to utf16 and back" do
+      input = 'λ, λ, λ'
+
+      output = subject.convert input, 'UTF-8', 'UTF-16'
+      output.encoding.to_s.should == "UTF-16"
+      input.bytesize.should < output.bytesize
+      input.should_not == output
+
+      output = subject.convert output, 'UTF-16', 'UTF-8'
+      output.encoding.to_s.should == "UTF-8"
+      input.bytesize.should == output.bytesize
+      input.should == output
+    end
+
+    it "should raise error if params are not string" do
+      expect {
+        subject.convert nil, 'UTF-8', 'UTF-16'
+      }.to raise_error(TypeError)
+
+      expect {
+        subject.convert 'lol', 'UTF-8', nil
+      }.to raise_error(TypeError)
+
+      expect {
+        subject.convert 'lol', nil, 'UTF-16'
+      }.to raise_error(TypeError)
+
+      expect {
+        subject.convert 'lol', 'UTF-8', 'UTF-8'
+      }.to_not raise_error(TypeError)
+    end
+  end
+
+end

data/spec/encoding_detector_spec.rb

@@ -0,0 +1,97 @@
+# encoding: utf-8
+
+require 'spec_helpers'
+require 'charlock_holmes'
+
+describe CharlockHolmes::EncodingDetector do
+  subject { CharlockHolmes::EncodingDetector }
+
+  describe "#detect" do
+    it "should detect encoding of string" do
+      detected = subject.detect 'hello'
+      detected[:encoding].should == 'ISO-8859-1'
+    end
+
+    it "should accept encoding hint" do
+      detected = subject.detect 'hello', 'UTF-8'
+      detected[:encoding].should == 'ISO-8859-1'
+    end
+
+    MAPPING = [
+      ['repl2.cljs', 'ISO-8859-1'],
+      ['core.rkt', 'UTF-8'],
+      ['cl-messagepack.lisp', 'ISO-8859-1'],
+      ['TwigExtensionsDate.es.yml', 'UTF-8'],
+      ['AnsiGraph.psm1', 'UTF-16LE'],
+      ['laholator.py', 'UTF-8'],
+      ['mingpao.html', 'Big5'],
+      ['shift_jis.html', 'Shift_JIS']
+    ]
+
+    MAPPING.each do |mapping|
+      file, encoding, type = mapping
+      it "should detect encoding of test file #{file}" do
+        path = File.expand_path "../fixtures/#{file}", __FILE__
+        content = File.read path
+        guessed = subject.detect content
+        guessed[:encoding].should == encoding
+        content.force_encoding guessed[:encoding]
+        content.valid_encoding?.should be_true
+      end
+    end
+  end
+  
+  describe "#detect_all" do
+    it "should returns array of possible matches" do
+      detected_list = subject.detect_all 'test'
+      detected_list.should be_a(Array)
+
+      encoding_list = detected_list.map {|d| d[:encoding] }.sort
+      encoding_list.should == ['ISO-8859-1', 'ISO-8859-2', 'UTF-8']
+    end
+
+    it "should accept encoding hint" do
+      detected_list = subject.detect_all 'test', 'UTF-8'
+      detected_list.should be_a(Array)
+
+      encoding_list = detected_list.map {|d| d[:encoding] }.sort
+      encoding_list.should == ['ISO-8859-1', 'ISO-8859-2', 'UTF-8']
+    end
+  end
+
+  describe "#all_detectable_charsets" do
+    it "should return array of charsets" do
+      list = subject.all_detectable_charsets
+      list.should be_a(Array)
+      list.should == %w{
+        UTF-8
+        UTF-16BE
+        UTF-16LE
+        UTF-32BE
+        UTF-32LE
+        Shift_JIS
+        ISO-2022-JP
+        ISO-2022-CN
+        ISO-2022-KR
+        GB18030
+        EUC-JP
+        EUC-KR
+        Big5
+        ISO-8859-1
+        ISO-8859-2
+        ISO-8859-5
+        ISO-8859-6
+        ISO-8859-7
+        ISO-8859-8
+        windows-1251
+        windows-1256
+        KOI8-R
+        ISO-8859-9
+        IBM424_rtl
+        IBM424_ltr
+        IBM420_rtl
+        IBM420_ltr
+      }
+    end
+  end
+end