transpotter 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0e9af441f608c47ca93a652fe45b09382e231c7
+  data.tar.gz: f1f5e7af6dc0b522b39d72763a131070316bd265
+SHA512:
+  metadata.gz: 327e1f1101c81f53f8e22256af4934e8332b48f97a2bf90b4dd0c6794dd85a7848d235a102674db6cd25800547f7b4e868027b501587c8d934106f3e6993b5e2
+  data.tar.gz: 4ab1d9ddf081ad2aeee632e448ca2602f75a5ba36c8e4cf852a9ee96960f9b72b1cae6b2685e8c774b29ed3a6ca3bb79c2e6733d586f41695389fab0b8d4b4af

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.5

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+gem 'charlock_holmes'
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec"
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler"
+  gem "pry"
+end

data/Gemfile.lock

@@ -0,0 +1,93 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.6)
+    atomic (1.1.14)
+    builder (3.2.2)
+    charlock_holmes (0.6.9.4)
+    coderay (1.1.0)
+    descendants_tracker (0.0.3)
+    diff-lcs (1.2.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.8)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (3.3.2)
+    highline (1.6.21)
+    i18n (0.6.9)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (1.2.0)
+    method_source (0.8.2)
+    mini_portile (0.6.2)
+    minitest (4.7.5)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.5)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.0)
+    rake (10.4.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.6)
+    shoulda-matchers (2.5.0)
+      activesupport (>= 3.0.0)
+    slop (3.6.0)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  charlock_holmes
+  jeweler
+  pry
+  rdoc (~> 3.12)
+  rspec
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Kevin Bacha
+
+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,33 @@
+# Installation
+
+```bash
+$ gem install transpotter
+```
+
+# Usage
+
+```ruby
+transpotter = Transpotter.new('path/to/file')
+
+# Determine the encoding
+encoding = transpotter.detect
+
+# Transcode the file
+transpotter.output_to('path/to/new_file')
+```
+
+# Contributing to transpotter
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+# Copyright
+
+Copyright (c) 2013 Kevin Bacha. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "transpotter"
+  gem.homepage = "http://github.com/kbacha/transpotter"
+  gem.license = "MIT"
+  gem.summary = %Q{TODO: one-line summary of your gem}
+  gem.description = %Q{TODO: longer description of your gem}
+  gem.email = "bacha@nationbuilder.com"
+  gem.authors = ["Kevin Bacha"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "transpotter #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.4

data/lib/transpotter.rb

@@ -0,0 +1,120 @@
+require 'charlock_holmes/string'
+
+class Transpotter
+  attr_reader :filename
+
+  DEFAULT_SAMPLE_SIZE = 1024 * 1024 # 1 MB
+
+  # Determined from here:
+  # http://w3techs.com/technologies/overview/character_encoding/all
+  MOST_COMMON_ENCODINGS = (%w{
+    UTF-8
+    ISO-8859-1
+    Windows-1251
+    GB2312
+    SJIS
+    Windows-1252
+    GBK
+    ISO-8859-2
+    EUC-JP
+    Windows-1256
+    ISO-8859-15
+    ISO-8859-9
+    EUC-KR
+    Windows-1250
+    Windows-1254
+    Big5
+    Windows-874
+    US-ASCII
+    TIS-620
+  } + Encoding.name_list).uniq.map { |name| Encoding.find(name) }
+
+  ENCODING_ERRORS = [
+    Encoding::InvalidByteSequenceError,
+    Encoding::UndefinedConversionError,
+    Encoding::ConverterNotFoundError
+  ]
+
+  def initialize(filename, data = nil, samplesize = nil)
+    @samplesize = samplesize || DEFAULT_SAMPLE_SIZE
+    @filename = filename
+    @data = data
+  end
+
+  def encoding
+    @encoding ||= (charlock || brute_force)
+  end
+
+  def read
+    return unless sample # don't do anything if we can't grab sample
+    if @filename
+      open_encoded_file do |io|
+        return convert(io.read)
+      end
+    elsif @data
+      convert(@data)
+    end
+  end
+
+  def each_line
+    return unless sample # don't do anything if we can't grab sample
+    if @filename
+      open_encoded_file do |io|
+        io.each(line_endings.encode(@encoding)) { |line| yield convert(line) }
+      end
+    elsif @data
+      convert(@data).split(line_endings).each { |line| yield line }
+    end
+  end
+
+  private
+
+  def open_encoded_file
+    File.open(@filename,
+              'rb',
+              external_encoding: encoding,
+              internal_encoding: encoding) do |io|
+      yield io
+    end
+  end
+
+  def line_endings
+    @line_endings = case convert(sample)
+                    when /\r\n/ then "\r\n"
+                    when /\n/ then "\n"
+                    when /\r/ then "\r"
+                    else "\n"
+                    end
+  end
+
+  def convert(string)
+    return string if encoding == 'UTF-8'
+    string.force_encoding(encoding).encode('UTF-8')
+  end
+
+  def sample
+    @sample ||= File.read(@filename, @samplesize) if File.file?(@filename.to_s)
+    @sample ||= @data
+  end
+
+  def charlock
+    if sample
+      encoding = sample.detect_encoding
+      encoding[:encoding] if encoding[:confidence] > 75
+    end
+  end
+
+  def brute_force
+    return nil if sample.nil?
+    MOST_COMMON_ENCODINGS.each do |encoding|
+      return encoding.name if valid_encoding?(encoding)
+    end
+    nil
+  end
+
+  def valid_encoding?(encoding)
+    sample.force_encoding(encoding.name).encode('UTF-8').valid_encoding?
+  rescue *ENCODING_ERRORS
+    return false
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+  config.color = true
+end
+
+require_relative '../lib/transpotter'
+FIXTURE_ROOT = File.join(File.dirname(__FILE__), 'fixtures')

data/spec/transpotter_spec.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'tempfile'
+
+describe Transpotter do
+  shared_examples 'a transpotter' do
+    let(:file) { Tempfile.new('transpotter') }
+    let(:encoded_data) do
+      data.encode(encoding, replace: '')
+    end
+
+    before do
+      File.open(file.path, 'w') do |io|
+        io.write encoded_data
+      end
+    end
+
+    context 'file' do
+      let(:spotter) { Transpotter.new(file.path) }
+
+      it 'can detect the encoding of a file' do
+        spotter.encoding.should eq encoding
+      end
+
+      it 'can see every line' do
+        spotter.each_line { |line| line.encoding.name.should eq 'UTF-8' }
+      end
+
+      it 'can read the whole document' do
+        expect(spotter.read.encoding.name).to eq 'UTF-8'
+      end
+    end
+
+    context 'data' do
+      let(:spotter) { Transpotter.new(nil, encoded_data) }
+
+      it 'can detect the encoding of a file' do
+        spotter.encoding.should eq encoding
+      end
+
+      it 'can see every line' do
+        spotter.each_line { |line| line.encoding.name.should eq 'UTF-8' }
+      end
+    end
+  end
+
+  %w{
+    UTF-8
+    ISO-8859-1
+    Big5
+    Shift_JIS
+  }.each do |encoding|
+    context encoding do
+      let(:data) do
+        "圖形碼helloｗ ｘ ｙ ｚ白いÇ  Α Β Γ Δ Ε Ζ Η Θ Ι Κ Λ Μ中文數位化技術推廣委員會" * 1025
+      end
+      let(:encoding) { encoding }
+
+      it_behaves_like 'a transpotter'
+    end
+  end
+
+  context 'nil input' do
+    it 'will not break if nil is given' do
+      spotter = Transpotter.new(nil, nil)
+      spotter.each_line { fail 'should not be called' }
+    end
+
+    it 'will return no encoding if no data is given' do
+      Transpotter.new(nil, nil).encoding.should be_nil
+    end
+  end
+
+  context 'bad file' do
+    it 'will return nothing if an invalid file is provided' do
+      Transpotter.new('path/to/no/where').each_line { fail }
+    end
+
+    it 'will return no encoding if an invalid file is provided' do
+      Transpotter.new('path/to/no/where').encoding.should be_nil
+    end
+
+    it 'will return nothing if an invalid file is provided' do
+      Transpotter.new('/dev/null').encoding.should be_nil
+    end
+  end
+end

data/transpotter.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: transpotter 0.1.4 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "transpotter"
+  s.version = "0.1.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Kevin Bacha"]
+  s.date = "2015-05-29"
+  s.description = "Gem to handle transcoding in ruby"
+  s.email = "bacha@nationbuilder.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".ruby-version",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/transpotter.rb",
+    "spec/spec_helper.rb",
+    "spec/transpotter_spec.rb",
+    "transpotter.gemspec"
+  ]
+  s.homepage = "http://github.com/kbacha/transpotter"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.3"
+  s.summary = "Gem to handle transcoding in ruby"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<charlock_holmes>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+    else
+      s.add_dependency(%q<charlock_holmes>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<pry>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<charlock_holmes>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<pry>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: transpotter
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Kevin Bacha
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: charlock_holmes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem to handle transcoding in ruby
+email: bacha@nationbuilder.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/transpotter.rb
+- spec/spec_helper.rb
+- spec/transpotter_spec.rb
+- transpotter.gemspec
+homepage: http://github.com/kbacha/transpotter
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Gem to handle transcoding in ruby
+test_files: []