unihawk 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+.bundle*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gem 'rspec'
+gem 'simplecov'

data/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    multi_json (1.3.6)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  simplecov

data/README.md

@@ -0,0 +1,40 @@
+Unihawk
+===================
+
+Unihawk is a Rubygem that automatically detects the encoding of a file and convert the content into a target encoding.
+
+It currently supports UTF-16LE, UTF-16BE, and UTF-8. If ```unihawk``` cannot guess the encoding, it will assume UTF-8.
+
+
+How to use it
+-------------------
+
+First of all, include it in your Gemfile by adding ```gem 'unihawk'```
+
+Use ```Unihawk.convert()``` to process string read from a file.
+
+For example:
+
+```
+content = File.new('/some_path/some_file.txt').read
+content = Unihawk.convert(content, 'utf-8')
+```
+
+```content``` will be converted to UTF-8 with BOM removed, if exists.
+
+
+Author
+--------------------
+Tanin Na Nakorn (@tanin47)
+
+
+
+License
+-------------------
+Copyright (c) 2012 Twitter, Inc.
+
+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/lib/unihawk.rb

@@ -0,0 +1,33 @@
+require 'iconv'
+
+class Unihawk
+  BYTE_ORDER_MARKS = {
+    'utf-8' => [0xEF, 0xBB, 0xBF],
+    'utf-16le' => [0xFF, 0xFE],
+    'utf-16be' => [0xFE, 0xFF]
+  }
+
+  def self.convert(content, target_encoding)
+    from_encoding = ''
+    bom3 = content[0..2].scan(/./).map{|c| c[0]}
+
+    BYTE_ORDER_MARKS.each_pair { |encoding, prefix|
+      ok = true
+      prefix.each_with_index { |b, i|
+        if b != bom3[i]
+          ok = false
+          break
+        end
+      }
+
+      from_encoding = encoding if ok == true
+    }
+
+    if from_encoding == '' # assume utf-8 with no BOM
+      Iconv.conv(target_encoding, 'utf-8', content)
+    else
+      content = Iconv.conv(target_encoding, from_encoding, content)
+      content[BYTE_ORDER_MARKS[target_encoding].length..-1]
+    end
+  end
+end

data/proof.rb

@@ -0,0 +1,18 @@
+
+content = File.new('spec/assets/example-utf-16le').read
+puts content
+content.each_byte {|c| print "#{c.to_s(16)} " }
+puts
+puts
+
+content = File.new('spec/assets/example-utf-16be').read
+puts content
+content.each_byte {|c| print "#{c.to_s(16)} " }
+puts
+puts
+
+content = File.new('spec/assets/example-utf-8').read
+puts content
+content.each_byte {|c| print "#{c.to_s(16)} " }
+puts
+puts

data/spec/assets/example-utf-8

@@ -0,0 +1 @@
+test

data/spec/assets/example-utf-8-no-bom

@@ -0,0 +1 @@
+test

data/spec/read_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+ALL = [
+  { :encoding => "utf-16le", :file => File.expand_path("../assets/example-utf-16le", __FILE__) },
+  { :encoding => "utf-16be", :file => File.expand_path("../assets/example-utf-16be", __FILE__) },
+  { :encoding => "utf-8", :file => File.expand_path("../assets/example-utf-8", __FILE__) }
+]
+
+describe 'Read files' do
+  before(:all) do
+    ALL.each { |encoding|
+      encoding[:content] = File.new(encoding[:file]).read.scan(/./).map{|c| c[0]}
+      encoding[:content][0..Unihawk::BYTE_ORDER_MARKS[encoding[:encoding]].length-1].should =~ Unihawk::BYTE_ORDER_MARKS[encoding[:encoding]]
+    }
+  end
+
+  it "reads and convert correctly" do
+    ALL.each { |from|
+      ALL.each { |to|
+        puts "Convert from #{from[:encoding]} to #{to[:encoding]}"
+        content = Unihawk.convert(File.new(from[:file]).read, to[:encoding])
+
+        expected_content = to[:content][Unihawk::BYTE_ORDER_MARKS[to[:encoding]].length..-1]
+        content.scan(/./).map{|c| c[0]}.should =~ expected_content
+        puts "--OK"
+      }
+    }
+  end
+
+  it "reads no BOM into utf-8" do
+    ALL.each { |to|
+        puts "Convert from utf-8 (no BOM) to #{to[:encoding]}"
+        content = Unihawk.convert("test", to[:encoding])
+
+        expected_content = to[:content][Unihawk::BYTE_ORDER_MARKS[to[:encoding]].length..-1]
+        content.scan(/./).map{|c| c[0]}.should =~ expected_content
+        puts "--OK"
+      }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require File.expand_path("../../lib/unihawk", __FILE__)
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

data/unihawk.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "unihawk"
+  s.version     = "0.0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Tanin Na Nakorn"]
+  s.email       = ["tanin47@yahoo.com"]
+  s.homepage    = "http://github.com/twitter/unihawk"
+  s.summary     = %q{unihawk}
+  s.description = %q{Read a file in a target encoding (Only works with UTF-16LE, UTF-16BE, and UTF-8)}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {rails,spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('iconv')
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: unihawk
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Tanin Na Nakorn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-10-18 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: iconv
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Read a file in a target encoding (Only works with UTF-16LE, UTF-16BE, and UTF-8)
+email: 
+- tanin47@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/unihawk.rb
+- proof.rb
+- spec/assets/example-utf-16be
+- spec/assets/example-utf-16le
+- spec/assets/example-utf-8
+- spec/assets/example-utf-8-no-bom
+- spec/read_spec.rb
+- spec/spec_helper.rb
+- unihawk.gemspec
+has_rdoc: true
+homepage: http://github.com/twitter/unihawk
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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.6.2
+signing_key: 
+specification_version: 3
+summary: unihawk
+test_files: 
+- spec/assets/example-utf-16be
+- spec/assets/example-utf-16le
+- spec/assets/example-utf-8
+- spec/assets/example-utf-8-no-bom
+- spec/read_spec.rb
+- spec/spec_helper.rb