encoda 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Zipme
+
+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,62 @@
+= Encoda
+
+This is a simple file encoding converter
+
+== Installation
+
+  sudo gem install Encoda
+
+== Getting Started
+
+==== Single file conversion
+
+  Encoda.convert do 
+		to_path 'convert/to/path'  
+		from_file 'path/to/your/file'    
+		from_encoding 'GB2312'
+		to_encoding 'UTF8'
+  end
+
+==== Multiple files conversion
+
+You can batch convert multiple files from a specific directory by specifying from_path
+
+  Encoda.convert do  	
+		from_path /from/path
+		to_path /to/path
+		to_encoding 'UTF8'
+  end
+
+If you specify from_path, it will alway do the batch conversion and ignore the from_path option.
+
+As you can see, if you omit the from_encoding option, the Encoda will try to guess the file's original encoding.
+The guessing feature is based on chardet library.
+
+==== Retrieve the conversion result
+
+	encoda = Encoda.convert do  	
+		from_path /from/path
+		to_path /to/path
+		to_encoding 'UTF8'
+	end
+
+	puts encoda.failed #=> ['failed_file1.txt', 'failed_file2.txt']
+	puts encoda.success #=> ['success_file1.txt', 'success_file3.txt, file4.srt']
+
+== TODOs
+
+Refactoring!!!
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Zipme. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "encoda"
+    gem.summary = %Q{Encoding converter}
+    gem.description = %Q{It's a simple file encoding converter }
+    gem.email = "genkiwow@gmail.com"
+    gem.homepage = "http://github.com/zipme/encoda"
+    gem.authors = ["Zipme"]
+    gem.add_dependency "chardet", ">=0.9.0"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # 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: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "encoda #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/encoda.gemspec

@@ -0,0 +1,66 @@
+# 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{encoda}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Zipme"]
+  s.date = %q{2010-01-07}
+  s.description = %q{It's a simple file encoding converter }
+  s.email = %q{genkiwow@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "encoda.gemspec",
+     "lib/encoda.rb",
+     "spec/encoda_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/test_files/conv_files/nedivx-tbl.big5.srt",
+     "spec/test_files/conv_files/nedivx-tbl.eng.srt",
+     "spec/test_files/conv_files/nedivx-tbl.gb.srt",
+     "spec/test_files/conv_files/utf8.gb.srt",
+     "spec/test_files/files/nedivx-tbl.big5.srt",
+     "spec/test_files/files/nedivx-tbl.eng.srt",
+     "spec/test_files/files/nedivx-tbl.gb.srt",
+     "spec/test_files/files/utf8.gb.srt"
+  ]
+  s.homepage = %q{http://github.com/zipme/encoda}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Encoding converter}
+  s.test_files = [
+    "spec/encoda_spec.rb",
+     "spec/spec_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::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<chardet>, [">= 0.9.0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<chardet>, [">= 0.9.0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<chardet>, [">= 0.9.0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/encoda.rb

@@ -0,0 +1,141 @@
+require 'rubygems'
+require 'UniversalDetector'
+require 'iconv'
+require 'ftools'
+
+class Encoda
+  
+  attr_reader :from_path, :to_path, :from_file, :to_file, 
+                :from_encoding, :to_encoding, :failed, :success
+  
+  def initialize
+    @from_path = ""
+    @to_path   = ""
+    @to_file = ""
+    @to_encoding = "UTF8"
+    @failed = []
+    @success = []
+  end
+  
+  def from_path(from_path)
+    @from_path = from_path    
+  end
+  
+  def from_file(from_file)
+    @from_file = from_file
+  end  
+  
+  def to_file(to_file)
+    @to_file = to_file
+  end
+  
+  def to_path(to_path)
+    @to_path = to_path    
+  end
+  
+  def to_encoding(to_enc)
+    @to_encoding = to_enc
+  end
+  
+  
+  def run!
+    #TODO: Add some validation against the attrs
+    process!
+  end
+  
+  #DSL API
+  def self.convert(&block)    
+    encoda = Encoda.new
+    encoda.instance_eval(&block)        
+    encoda.run!  
+    encoda    
+  end
+  
+  #Conventional API
+  def convert(from, to, from_encoding, to_encoding)
+    #TODO 
+  end
+  
+  private 
+  
+  def process!        
+    puts "convert begins!"
+    check_file_or_dir @to_path
+    if convert_from_path?
+      create_directories
+      unfinished_files.each do |filename|  
+       @failed << filename unless convert_file( "#{@from_path}/#{filename}", "#{@to_path}/#{filename}" )
+      end     
+    else
+      check_file_or_dir @from_file
+      from_file_basename = File.basename(@from_file)
+      @to_file = "converted_#{from_file_basename}" if @to_file.strip.empty?
+      @failed << @from_file unless convert_file( @from_file, "#{@to_path}/#{File.basename(@to_file)}" )
+    end
+    @success = unfinished_files - @failed
+    puts "convert finished! #{@success.size} files have been converted, #{@failed.size} failed."
+  end
+    
+  def convert_from_path?
+    !@from_path.empty? && !@from_path.nil?
+  end
+
+  def create_directories
+    check_file_or_dir @from_path
+    Dir.mkdir @to_path unless File.exist? @to_path
+  end
+
+  def check_file_or_dir(file_or_dir)
+    raise "File or directory: #{file_or_dir} cannot be found!" if ( file_or_dir.nil? || !File.exist?(file_or_dir) )    
+  end
+
+  def unfinished_files
+    @unfinished_files ||= unfinished_files!
+  end
+  
+  def unfinished_files!       
+    orin_files = Dir.glob(File.join(@from_path, "*.srt"))
+    conv_files = Dir.glob(File.join(@to_path, "*.srt"))
+    orin_files.map! { |f| File.basename(f) }
+    conv_files.map! { |f| File.basename(f) }
+    orin_files - conv_files    
+  end
+
+  def convert_file(from_file, to_file)
+    File.open(from_file,'r') do |f|        
+      if @from_encoding.nil?
+        lines = f.read
+        result = UniversalDetector::chardet(lines[0..1000])      
+        @from_encoding = result["encoding"] if result["confidence"] > 0.9
+        puts "Guessing Result: #{result.inspect} of file #{@from_file}"          
+      end
+      raise "Not specifying from_encoding" if @from_encoding.strip.empty?   
+      
+      if @from_encoding.upcase.sub("-","") == @to_encoding.upcase.sub("-","")
+        File.copy(from_file, "#{@to_path}/#{File.basename(from_file)}")
+        return true
+      end   
+      
+      begin
+        File.open(to_file, 'w') do |cf|
+          begin
+            cf.write Iconv.conv(@to_encoding, @from_encoding, lines)                                
+          rescue Exception => e
+            cf.write Iconv.conv(@to_encoding, "BIG5", lines)                       
+          end
+        end
+      rescue Exception => e   
+        puts "delete failed file"         
+        File.delete(to_file)
+        puts "#{from_file} converted failed. Msg:#{e.message}."
+        return false
+      ensure
+        @from_encoding = nil
+      end  
+            
+    end    
+    true 
+  end
+
+  
+end

data/spec/encoda_spec.rb

@@ -0,0 +1,80 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+class TempFile
+  #These variable can be set in the before block, however, it won't work with DSL APIs
+  TO_PATH = File.expand_path(File.dirname(__FILE__) + '/test_files/conv_files')
+  FROM_PATH = File.expand_path(File.dirname(__FILE__) + '/test_files/files')
+  FROM_FILE = File.expand_path(File.dirname(__FILE__) + '/test_files/files/nedivx-tbl.gb.srt')    
+  UTF8_FILE = File.expand_path(File.dirname(__FILE__) + '/test_files/files/utf8.gb.srt')
+end
+describe "Encoda" do 
+
+  describe "Providing incorrect info" do    
+    it "should raise error when providing from_path cannot be found" do
+      lambda {      
+        Encoda.convert do 
+          to_path TempFile::TO_PATH  
+          from_file 'xxx_1.srt'    
+        end
+      }.should raise_error(/xxx_1.srt cannot be found!/)    
+    end
+
+    it "should raise error when providing from_path cannot be found" do
+      lambda {
+        Encoda.convert do   
+          to_path TempFile::TO_PATH
+          from_path "xxx"
+        end
+      }.should raise_error(/xxx cannot be found!/)    
+    end
+    
+    it "should raise error when providing from_path cannot be found" do
+      lambda {
+        Encoda.convert do   
+          to_path "to_path"
+        end
+      }.should raise_error(/to_path cannot be found!/)    
+    end
+  end
+  
+  describe "Providing correct info" do    
+    
+    def conv_files
+      Dir.glob(File.join(TempFile::TO_PATH, "*.srt"))
+    end    
+    
+    before(:each) do
+      conv_files.each do |f|
+        File.delete(f)
+      end
+    end
+    
+    describe "Convert single file" do
+      it "should convert 1 file to default converted folder" do
+        Encoda.convert do  
+          from_file TempFile::FROM_FILE
+          to_path TempFile::TO_PATH
+        end
+        conv_files.should have(1).item
+      end 
+      it "should bypass the convert and copy the file directly if from_encoding is the same as to_encoding" do
+        Encoda.convert do  
+          from_file TempFile::UTF8_FILE
+          to_path TempFile::TO_PATH
+        end
+        conv_files.should have(1).item
+        File.basename(conv_files[0]).should == File.basename(TempFile::UTF8_FILE)
+      end
+    end
+    describe "Convert files under a specific folder" do
+      it "should batch convert files when specifying from_path" do
+        encoda = Encoda.convert do  
+          from_path TempFile::FROM_PATH
+          to_path TempFile::TO_PATH
+        end
+        puts encoda.inspect
+        conv_files.should have(encoda.failed.size + encoda.success.size).items
+      end
+    end
+  end
+  
+end