remote_table 2.0.0 → 2.0.1

data/.yardopts

@@ -0,0 +1,2 @@
+--no-private
+--readme README.markdown

data/CHANGELOG

@@ -1,3 +1,10 @@
+2.0.1 / 2012-05-16
+
+* Enhancements
+
+  * For single-string transliteration to UTF-8, use ActiveSupport::Inflector.transliterate instead of Iconv - possibly a future-proof solution.
+  * For whole-file transliteration to UTF-8, warn users if iconv binary is not available in their $PATH.
+
 2.0.0 / 2012-05-08
 
 * Breaking changes

data/README.markdown

@@ -21,11 +21,9 @@ It's also a big part of
 ## Example
 
     >> require 'remote_table'
-    remote_table.rb:8:in `<top (required)>': iconv will be deprecated in the future, use String#encode instead.
-    [remote_table] Apologies - using iconv because Ruby 1.9.x's String#encode doesn't have transliteration tables (yet)
     => true
     >> t = RemoteTable.new 'http://www.fueleconomy.gov/FEG/epadata/98guide6.zip', :filename => '98guide6.csv'
-    => #<RemoteTable:0x00000101b87390 @download_count_mutex=#<Mutex:0x00000101b87228>, @iconv_mutex=#<Mutex:0x00000101b87200>, @extend_bang_mutex=#<Mutex:0x00000101b871d8>, @errata_mutex=#<Mutex:0x00000101b871b0>, @cache=[], @download_count=0, @url="http://www.fueleconomy.gov/FEG/epadata/98guide6.zip", @format=nil, @headers=:first_row, @compression=:zip, @packing=nil, @streaming=false, @warn_on_multiple_downloads=true, @delimiter=",", @sheet=nil, @keep_blank_rows=false, @form_data=nil, @skip=0, @internal_encoding="UTF-8", @row_xpath=nil, @column_xpath=nil, @row_css=nil, @column_css=nil, @glob=nil, @filename="98guide6.csv", @transform_settings=nil, @cut=nil, @crop=nil, @schema=nil, @schema_name=nil, @pre_select=nil, @pre_reject=nil, @errata_settings=nil, @other_options={}, @transformer=#<RemoteTable::Transformer:0x00000101b8c2f0 @t=#<RemoteTable:0x00000101b87390 ...>, @legacy_transformer_mutex=#<Mutex:0x00000101b8c2a0>>, @local_copy=#<RemoteTable::LocalCopy:0x00000101b8bf58 @t=#<RemoteTable:0x00000101b87390 ...>, @encoded_io_mutex=#<Mutex:0x00000101b8be18>, @generate_mutex=#<Mutex:0x00000101b8bdc8>>>
+    => #<RemoteTable:0x00000101b87390 @download_count_mutex=#<Mutex:0x00000101b87228>, @extend_bang_mutex=#<Mutex:0x00000101b871d8>, @errata_mutex=#<Mutex:0x00000101b871b0>, @cache=[], @download_count=0, @url="http://www.fueleconomy.gov/FEG/epadata/98guide6.zip", @format=nil, @headers=:first_row, @compression=:zip, @packing=nil, @streaming=false, @warn_on_multiple_downloads=true, @delimiter=",", @sheet=nil, @keep_blank_rows=false, @form_data=nil, @skip=0, @internal_encoding="UTF-8", @row_xpath=nil, @column_xpath=nil, @row_css=nil, @column_css=nil, @glob=nil, @filename="98guide6.csv", @transform_settings=nil, @cut=nil, @crop=nil, @schema=nil, @schema_name=nil, @pre_select=nil, @pre_reject=nil, @errata_settings=nil, @other_options={}, @transformer=#<RemoteTable::Transformer:0x00000101b8c2f0 @t=#<RemoteTable:0x00000101b87390 ...>, @legacy_transformer_mutex=#<Mutex:0x00000101b8c2a0>>, @local_copy=#<RemoteTable::LocalCopy:0x00000101b8bf58 @t=#<RemoteTable:0x00000101b87390 ...>, @encoded_io_mutex=#<Mutex:0x00000101b8be18>, @generate_mutex=#<Mutex:0x00000101b8bdc8>>>
     >> t.rows.length
     => 806
     >> t.rows.first.length

data/lib/remote_table/local_copy.rb

@@ -2,7 +2,8 @@ require 'fileutils'
 require 'unix_utils'
 
 class RemoteTable
-  class LocalCopy #:nodoc:all
+  # @private
+  class LocalCopy
     class << self
       def decompress(input, compression)
         output = case compression

data/lib/remote_table/plaintext.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'unix_utils'
 
 class RemoteTable
   # Helper methods that act on plaintext files before they are parsed
@@ -15,12 +16,16 @@ class RemoteTable
       local_copy.in_place :perl, "s/#{CONSIDERED_HARMFUL.join('//g; s/')}//g"
     end
     
-    # No matter what the file encoding is SUPPOSED to be, run it through iconv to make sure it's UTF-8
+    # No matter what the file encoding is SUPPOSED to be, run it through the system iconv binary to make sure it's UTF-8
     #
     # @example
     #   iconv -c -t UTF-8//TRANSLIT -f WINDOWS-1252
     def transliterate_whole_file_to_utf8!
-      local_copy.in_place :iconv, RemoteTable::EXTERNAL_ENCODING_ICONV, internal_encoding
+      if ::UnixUtils.available?('iconv')
+        local_copy.in_place :iconv, RemoteTable::EXTERNAL_ENCODING_ICONV, internal_encoding
+      else
+        ::Kernel.warn %{[remote_table] iconv not available in your $PATH, not performing transliteration}
+      end
       # now that we've force-transliterated to UTF-8, act as though this is what the user had specified
       @internal_encoding = RemoteTable::EXTERNAL_ENCODING
     end

data/lib/remote_table/version.rb

@@ -1,3 +1,3 @@
 class RemoteTable
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/lib/remote_table.rb

@@ -5,16 +5,11 @@ end
 
 require 'thread'
 
-require 'iconv'
-if RUBY_VERSION >= '1.9'
-  # for an excellent explanation see http://blog.segment7.net/2010/12/17/from-iconv-iconv-to-string-encode
-  Kernel.warn "[remote_table] Apologies - using iconv because Ruby 1.9.x's String#encode doesn't have transliteration tables (yet)"
-end
-
 require 'active_support'
 require 'active_support/version'
 if ::ActiveSupport::VERSION::MAJOR >= 3
   require 'active_support/core_ext'
+  require 'active_support/inflector/transliterate'
 end
 require 'hash_digest'
 
@@ -149,8 +144,11 @@ class RemoteTable
   
   # The URL of the local or remote file.
   #
-  # * Local: "file:///Users/myuser/Desktop/holidays.csv"
-  # * Remote: "http://data.brighterplanet.com/countries.csv"
+  # @example Local
+  #   file:///Users/myuser/Desktop/holidays.csv
+  #
+  # @example Remote
+  #   http://data.brighterplanet.com/countries.csv
   #
   # @return [String]
   attr_reader :url
@@ -347,7 +345,6 @@ class RemoteTable
   #                   :pre_select => proc { |row| row['Vehicle Age'].strip =~ /^\d+$/ }
   def initialize(*args)
     @download_count_mutex = ::Mutex.new
-    @iconv_mutex = ::Mutex.new
     @extend_bang_mutex = ::Mutex.new
     @errata_mutex = ::Mutex.new
 
@@ -509,15 +506,9 @@ class RemoteTable
     !!@fully_cached
   end
 
-  def iconv
-    @iconv || @iconv_mutex.synchronize do
-      @iconv ||= ::Iconv.new(EXTERNAL_ENCODING_ICONV, internal_encoding)
-    end
-  end
-
   def transliterate_to_utf8(str)
     if str.is_a?(::String)
-      [ iconv.iconv(str), iconv.iconv(nil) ].join
+      ::ActiveSupport::Inflector.transliterate str
     end
   end
 

data/test/test_remote_table.rb

@@ -150,4 +150,8 @@ describe RemoteTable do
     t[4]['col1'].must_equal "Manage Multiple Incentive Programs for Participants"
   end
 
+  it "doesn't get confused by :format => nil" do
+    t = RemoteTable.new :url => 'http://www.fueleconomy.gov/FEG/epadata/00data.zip', :filename => 'G6080900.xls', :format => nil
+    t[0]['Class'].must_equal 'TWO SEATERS'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: remote_table
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-08 00:00:00.000000000 Z
+date: 2012-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -135,6 +135,7 @@ extra_rdoc_files: []
 files:
 - .gitattributes
 - .gitignore
+- .yardopts
 - CHANGELOG
 - Gemfile
 - LICENSE