excel2csv 0.0.7 → 0.0.8

data/README.md

@@ -34,12 +34,12 @@ Excel2CSV.foreach("path/to/file.xls") {|r| puts r}
 Excel2CSV.foreach("path/to/file.xlsx") {|r| puts r}
 
 # Read non first worksheet
-Excel2CSV.read "path/to/file.xls", index:1 #reads second sheet 
-Excel2CSV.read "path/to/file.xlsx", index:2 #reads third sheet
+Excel2CSV.read "path/to/file.xls", sheet:1 #reads second sheet 
+Excel2CSV.read "path/to/file.xlsx", sheet:2 #reads third sheet
 
 
 # Preview first N rows in big files
-Excel2CSV.read "path/to/file.xls", rows_limit: 2, preview: true
-Excel2CSV.read "path/to/file.xlsx", rows_limit: 2, preview: true
-Excel2CSV.read "path/to/file.csv", rows_limit: 2, preview: true
+Excel2CSV.read "path/to/file.xls", rows: 2, preview: true
+Excel2CSV.read "path/to/file.xlsx", rows: 2, preview: true
+Excel2CSV.read "path/to/file.csv", rows: 2, preview: true
 ```

data/lib/excel2csv/info.rb

@@ -0,0 +1,42 @@
+require "fileutils"
+
+module Excel2CSV
+  class Info
+    attr_accessor :sheets
+    attr_accessor :previews
+    attr_accessor :working_folder
+
+    def self.read working_folder
+      info = Info.new working_folder
+      info.read
+      info
+    end
+
+    def read
+      Dir["#{@working_folder}/*.csv"].map do |file|
+        name = File.basename(file)
+        m = /(?<sheet>\d+)-(?<rows>\d+)(-of-(?<total_rows>\d+))?/.match(name)
+        next if !m
+        total_rows   = (m[:total_rows] || m[:rows]).to_i
+        preview_rows = m[:rows].to_i
+        if name =~ /preview/
+          @previews << {path: file, total_rows:total_rows, rows:preview_rows}
+        else
+          @sheets << {path: file, total_rows:total_rows, rows:total_rows}
+        end
+      end
+    end 
+
+    def clean
+      FileUtils.remove_entry_secure(@working_folder, true) if @working_folder
+    end
+
+    private
+
+    def initialize working_folder
+      @working_folder = working_folder
+      @sheets = []
+      @previews = []
+    end
+  end
+end

data/lib/excel2csv/version.rb

@@ -1,3 +1,3 @@
 module Excel2CSV
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/excel2csv.rb

@@ -1,51 +1,10 @@
 require "excel2csv/version"
+require "excel2csv/info"
+
 require "csv"
 require "tmpdir"
-require "fileutils"
 
 module Excel2CSV
-
-  class Info
-    attr_accessor :sheets
-    attr_accessor :previews
-    attr_accessor :tmp_dir
-    attr_accessor :working_dir
-
-    def self.read dir, tmp_dir
-      info = Info.new dir, tmp_dir
-      info.read
-      info
-    end
-
-    def read
-      Dir["#{@working_dir}/*.csv"].map do |file|
-        name = File.basename(file)
-        m = /(?<sheet>\d+)-(?<rows>\d+)(-of-(?<total_rows>\d+))?/.match(name)
-        next if !m
-        total_rows   = (m[:total_rows] || m[:rows]).to_i
-        preview_rows = m[:rows].to_i
-        if name =~ /preview/
-          @previews << {path: file, total_rows:total_rows, rows:preview_rows}
-        else
-          @sheets << {path: file, total_rows:total_rows, rows:total_rows}
-        end
-      end
-    end 
-
-    def clean
-      FileUtils.remove_entry_secure(@tmp_dir, true) if @tmp_dir
-    end
-
-    private
-
-    def initialize working_dir, tmp_dir
-      @working_dir = working_dir
-      @tmp_dir = tmp_dir
-      @sheets = []
-      @previews = []
-    end
-
-  end
   
   def foreach(path, options = {}, &block) 
     convert(path, options) do |info|
@@ -65,7 +24,7 @@ module Excel2CSV
 
   def convert(path, options = {})
     info = options[:info]
-    if info && Dir.exists?(info.working_dir)
+    if info && Dir.exists?(info.working_folder)
       return block_given? ? yield(info) : info
     end
     begin
@@ -89,7 +48,7 @@ module Excel2CSV
     else
       collection = info.sheets
     end
-    index = (idx = options[:index]) ? idx : 0
+    index = (idx = options[:sheet]) ? idx : 0
     collection[index][:path]
   end
 
@@ -97,8 +56,8 @@ module Excel2CSV
 
   def create_cvs_files(path, options)
     tmp_dir = Dir.mktmpdir
-    dest_folder = options[:dest_folder] || tmp_dir
-    limit = options[:rows_limit]
+    working_folder = options[:working_folder] || tmp_dir
+    limit = options[:rows]
     if path =~ /\.csv$/
       total_rows = 0
       preview_rows = []
@@ -106,7 +65,7 @@ module Excel2CSV
 
       # Transcode file to utf-8, count total and gen preview
 
-      CSV.open("#{dest_folder}/1-#{total_rows}.csv", "wb") do |csv|
+      CSV.open("#{working_folder}/1-#{total_rows}.csv", "wb") do |csv|
         CSV.foreach(path, opts) do |row| 
           if limit && total_rows <= limit
             preview_rows << row
@@ -117,7 +76,7 @@ module Excel2CSV
       end
       
       if limit
-        CSV.open("#{dest_folder}/1-#{limit}-of-#{total_rows}-preview.csv", "wb") do |csv|
+        CSV.open("#{working_folder}/1-#{limit}-of-#{total_rows}-preview.csv", "wb") do |csv|
           preview_rows.each {|row| csv << row}
         end
       end
@@ -125,17 +84,17 @@ module Excel2CSV
       java_options = options[:java_options] || "-Dfile.encoding=utf8 -Xms512m -Xmx512m -XX:MaxPermSize=256m"
       rows_limit = limit ? "-r #{limit}" : ""
       jar_path = File.join(File.dirname(__FILE__), "excel2csv.jar")
-      `java #{java_options} -jar #{jar_path} #{rows_limit} #{path} #{dest_folder}`
+      `java #{java_options} -jar #{jar_path} #{rows_limit} #{path} #{working_folder}`
     end
     
-    Info.read(dest_folder, tmp_dir)
+    Info.read(working_folder)
   end
 
   module_function :create_cvs_files
 
   def clean_options options
     options.dup.delete_if do |key, value|
-      [:dest_folder, :java_options, :preview, :index, :path, :rows_limit, :info].include?(key)
+      [:working_folder, :java_options, :preview, :sheet, :path, :rows, :info].include?(key)
     end
   end
 

data/spec/excel2csv_spec.rb

@@ -35,31 +35,31 @@ describe Excel2CSV do
     count.should == 3
   end
 
-  it "removes tmp dir after work" do
-    tmp_dir = nil
+  it "removes tmp folder after work" do
+    working_folder = nil
     excel.convert xlsx_basic_types do |info|
       # puts IO.read(info.sheets.first[:path])
-      tmp_dir = info.tmp_dir
+      working_folder = info.working_folder
     end
-    tmp_dir.should_not be_nil
-    Dir.exists?(tmp_dir).should == false
+    working_folder.should_not be_nil
+    Dir.exists?(working_folder).should == false
   end
 
   it "converts once if info is passed" do
     info = excel.convert xlsx_basic_types
     info.sheets.length.should == 1
     info.previews.length.should == 0
-    info.should == excel.convert("spec/fixtures/basic_types.xlsx", info:info)
+    info.should == excel.convert(xlsx_basic_types, info:info)
   end
 
-  it "regenerate csv files if working_dir is removed" do
+  it "regenerate csv files if working_folder is removed" do
     info = excel.convert xlsx_basic_types
     info.clean
     info.should_not == excel.convert(xlsx_basic_types, info:info)
   end
 
   it "generates preview csv files with rows limit" do
-    info = excel.convert xls_basic_types, rows_limit:1
+    info = excel.convert xls_basic_types, rows:1
     info.sheets.length.should == 1
     info.previews.length.should == 1
 
@@ -71,7 +71,7 @@ describe Excel2CSV do
   end
 
   it "reads previews" do
-    data = excel.read(xls_basic_types, rows_limit:1, preview:true, index:0)
+    data = excel.read(xls_basic_types, rows:1, preview:true, sheet:0)
     data.length.should == 1
     data[0].should == ["1.00", date_24, "Hello"]
   end
@@ -85,9 +85,9 @@ describe Excel2CSV do
 
   it "reads csv files with preview" do
     data = excel.read(csv_basic_types,
-      encoding:   'windows-1251:utf-8',
-      rows_limit: 2,
-      preview:    true
+      encoding: 'windows-1251:utf-8',
+      rows:     2,
+      preview:  true
     )
     data[0].should == ["1.00","12/24/11 12:00 AM","Hello"]
     data[1].should == ["2.00","12/25/11 12:00 AM","Привет"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: excel2csv
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70102599300280 !ruby/object:Gem::Requirement
+  requirement: &70115224571500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - <=
@@ -21,7 +21,7 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70102599300280
+  version_requirements: *70115224571500
 description: gem for converting Excel files to csv
 email:
 - yury.korolev@gmail.com
@@ -36,6 +36,7 @@ files:
 - excel2csv.gemspec
 - lib/excel2csv.jar
 - lib/excel2csv.rb
+- lib/excel2csv/info.rb
 - lib/excel2csv/version.rb
 - spec/excel2csv_spec.rb
 - spec/fixtures/basic_types.csv