sheet2hash 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39d612017da95d04fcee0ab66f8aa7d5b840449f
+  data.tar.gz: 3cbba116e7babb690febc7a3edc10b7aaba4584b
+SHA512:
+  metadata.gz: 03e6ad958495e3a1ccbd25c6849e9b7b6d47add075346041c31c67534daa263502912a1c30368aa9f9b1e7b7cee639a4f8059e04354fda7342b4a0245d97deee
+  data.tar.gz: 91d3b21a2f50a4f05334b65a67f899ddfaa99b96a9eab568fd9c74f7e45124b8bd5d85d32ccfe94edb83725d7e00c000c4bac4361a9db39a2fcd62f99114e621

data/README.md

@@ -1,6 +1,6 @@
 # Sheet2hash
 
-Convert Excel or Spreadsheet to Ruby hash
+Convert Excel or Spreadsheet to Ruby Hash
 
 ## Installation
 

data/Rakefile

@@ -1 +1,14 @@
 require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'yard'
+
+YARD::Rake::YardocTask.new
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/lib/sheet2hash.rb

@@ -2,18 +2,36 @@ require 'roo'
 require 'sheet2hash/errors'
 require 'sheet2hash/options'
 
+# Sheet2hash
+# @author Wei-Ming Wu
 module Sheet2hash
+  # Sheet2hash::Workbook converts Excel or Spreadsheet into Ruby Hash.
+  # @author Wei-Ming Wu
   class Workbook
-    include Options
+    include Options, Errors
     
-    def initialize(path, opts = {})
+    # Creates a Workbook.
+    #
+    # @return [Workbook] a Workbook object
+    def initialize path, opts = {}
       @workbook = Roo::Spreadsheet.open path
       @opts = process_options opts
       @sheet_opts = {}
       set_sheet_attributes
     end
     
-    def turn_to(sheet, sheet_opts = {})
+    # Turns to specified sheet of this Workbook.
+    #
+    # @param sheet [String, Integer] the name or index(1-based) of a sheet
+    # @param sheet_opts [Hash] the options of turn_to
+    # @option sheet_opts [Array, Integer] :header using an Array to store the header of this sheet or choosing an index(1-based) of rows as the header
+    # @option sheet_opts [Integer] :start the index(1-based) of rows to start
+    # @option sheet_opts [Integer] :end the index(1-based) of rows to end
+    # @option sheet_opts [Integer] :keep_row the indices(1-based) of rows to keep
+    # @option sheet_opts [Integer] :skip_row the indices(1-based) of rows to skip
+    # @option sheet_opts [Integer] :keep_col the indices(1-based) of columns to keep
+    # @option sheet_opts [Integer] :skip_col the indices(1-based) of columns to skip
+    def turn_to sheet, sheet_opts = {}
       if sheet.kind_of?(Integer) && sheet <= sheets.size
         @workbook.default_sheet = sheets[sheet - 1]
         @sheet_opts = process_options sheet_opts
@@ -27,14 +45,23 @@ module Sheet2hash
       end
     end
     
+    # Returns all sheets of this Workbook.
+    #
+    # @return [Array] all sheets of this Workbook
     def sheets
       @workbook.sheets
     end
     
+    # Returns the name of current sheet.
+    #
+    # @return [String]  the name of current sheet
     def sheet
       @workbook.default_sheet
     end
     
+    # Converts all sheets to a Hash, sheet names are the keys, values are Array of Hash.
+    #
+    # @return [Hash] sheet names are the keys, values are Array of Hash
     def to_h
       hash = {}
       sheets.each do |sheet|
@@ -44,6 +71,9 @@ module Sheet2hash
       hash
     end
     
+    # Converts current sheet to an Array of Hash.
+    #
+    # @param [Array] Array of Hash
     def to_a
       ary = []
       @rows.each do |row|
@@ -55,13 +85,14 @@ module Sheet2hash
     end
     
     private
+    
     def set_sheet_attributes
       @header = header
       @rows = rows
       @columns = columns
     end
     
-    def trim_int_cell(cell)
+    def trim_int_cell cell
       cell.kind_of?(Numeric) && cell % 1 == 0 ? cell.to_i : cell
     end
     
@@ -76,7 +107,7 @@ module Sheet2hash
       end
     end
     
-    def collect_columns(columns, opts)
+    def collect_columns columns, opts
       columns.keep_if { |col| opts[:keep_col].include? col } if opts[:keep_col]
       columns = columns - opts[:skip_col] if opts[:skip_col]
       columns
@@ -88,8 +119,8 @@ module Sheet2hash
     end
     
     def last_row
-      last_row = @sheet_opts[:end] || @opts[:end]
-      last_row || @workbook.last_row
+      last_row = @sheet_opts[:end] || @opts[:end] || @workbook.last_row
+      last_row > @workbook.last_row ? @workbook.last_row : last_row
     end
     
     def rows
@@ -100,14 +131,20 @@ module Sheet2hash
       elsif @opts[:keep_row] || @opts[:skip_row]
         rows = collect_rows rows, @opts
         rows - [@opts[:header]]
+      elsif @sheet_opts[:header].kind_of?(Integer) || @sheet_opts[:header].kind_of?(Integer)
+        rows - [@sheet_opts[:header] || @sheet_opts[:header]]
       else
         rows - [@workbook.first_row]
       end
     end
     
-    def collect_rows(rows, opts)
+    def collect_rows rows, opts
       rows.keep_if { |row| opts[:keep_row].include? row } if opts[:keep_row]
       rows = rows - opts[:skip_row] if opts[:skip_row]
+      rows = rows - [@workbook.first_row] unless opts[:keep_row] && opts[:keep_row].include?(1)
+      unless opts[:header].kind_of?(Integer) && opts[:keep_row].include?(opts[:header])
+        rows = rows - [opts[:header]]
+      end
       rows
     end
     
@@ -121,11 +158,11 @@ module Sheet2hash
       match_header_with_columns header
     end
     
-    def match_header_with_columns(header)
+    def match_header_with_columns header
       header.each_with_index.select { |h, i| columns.include?(i + 1) }.map { |i| i.first }
     end
     
-    def process_header(header)
+    def process_header header
       if header.kind_of? Array
         unique_header header
       elsif header.kind_of? Integer
@@ -135,13 +172,13 @@ module Sheet2hash
       end
     end
     
-    def header_from_row(row)
+    def header_from_row row
       header = []
       (@workbook.first_column..@workbook.last_column).each { |col| header << @workbook.cell(row, col) }
       unique_header header
     end
     
-    def unique_header(header)
+    def unique_header header
       header.reverse!
       dup_header = header.dup
       header = header.map do |field|

data/lib/sheet2hash/errors.rb

@@ -1,4 +1,10 @@
 module Sheet2hash
-  class SheetNotFoundError < Exception ; end
-  class InvalidHeaderError < Exception ; end
-end
+  # Sheet2hash::Errors defines all errors of Sheet2hash.
+  # @author Wei-Ming Wu
+  module Errors
+    # SheetNotFoundError is an Exception.
+    class SheetNotFoundError < Exception ; end
+    # InvalidHeaderError is an Exception.
+    class InvalidHeaderError < Exception ; end
+  end
+end

data/lib/sheet2hash/options.rb

@@ -1,16 +1,20 @@
 module Sheet2hash
+  # Sheet2hash::Options processes the options of Sheet2hash.
+  # @author Wei-Ming Wu
   module Options
-    def process_options(opts)
+    # Regulates options of Sheet2hash.
+    def process_options opts
       regulate_options opts
       opts
     end
     
     private
-    def regulate_options(opts)
+    
+    def regulate_options opts
       opts[:keep_row] = Array(opts[:keep_row]) if opts[:keep_row]
       opts[:skip_row] = Array(opts[:skip_row]) if opts[:skip_row]
       opts[:keep_col] = Array(opts[:keep_col]) if opts[:keep_col]
       opts[:skip_col] = Array(opts[:skip_col]) if opts[:skip_col]
     end
   end
-end
+end

data/lib/sheet2hash/version.rb

@@ -1,7 +1,11 @@
 module Sheet2hash
+  # Major version of Sheet2hash
   MAJOR = 0
-  MINOR = 1
+  # Minor version of Sheet2hash
+  MINOR = 2
+  # Patch version of Sheet2hash
   PATCH = 0
 
+  # String of version of Sheet2hash
   VERSION = [MAJOR, MINOR, PATCH].compact.join('.')
 end

data/sheet2hash.gemspec

@@ -21,7 +21,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "roo"
-  
+
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "yard"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require "rubygems"
+require "bundler"
+require "json"
+require "simplecov"
+
+SimpleCov.start
+
+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 "test/unit"
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require "sheet2hash"

data/test/workbook_test.rb

@@ -0,0 +1,88 @@
+require 'test_helper'
+
+class WorkbookTest < Test::Unit::TestCase
+  include Sheet2hash::Errors
+  
+  def setup
+    @header = Sheet2hash::Workbook.new File.expand_path('../header.xls', __FILE__)
+    @no_header = Sheet2hash::Workbook.new File.expand_path('../no-header.xls', __FILE__)
+    @dup_header = Sheet2hash::Workbook.new File.expand_path('../dup-header.xls', __FILE__)
+  end
+  
+  def test_turn_to
+    @header.turn_to 'Sheet1'
+    assert_equal 'Sheet1', @header.sheet
+    @header.turn_to 1
+    assert_equal 'Sheet1', @header.sheet
+  end
+  
+  def test_turn_to_error
+    assert_raise SheetNotFoundError do
+      @header.turn_to 'No Sheet'
+    end
+  end
+  
+  def test_sheets
+    assert_equal ['Sheet1'], @header.sheets
+  end
+  
+  def test_sheet
+    assert_equal 'Sheet1', @header.sheet
+  end
+  
+  def test_to_h
+    assert_equal({ 'Sheet1' => [{ 'col1' => 1, 'col2' => 2, 'col3' => 3 }, { 'col1' => 'one', 'col2' => 'two', 'col3' => 'three' }] }, @header.to_h)
+  end
+  
+  def test_to_a
+    assert_equal [{ 'col1' => 1, 'col2' => 2, 'col3' => 3 }, { 'col1' => 'one', 'col2' => 'two', 'col3' => 'three' }], @header.to_a
+  end
+  
+  def test_option_header1
+    @header.turn_to 1, header: [:col1, :col2]
+    assert_equal [{ col1: 1, col2: 2 }, { col1: 'one', col2: 'two' }], @header.to_a
+  end
+  
+  def test_option_header2
+    @no_header.turn_to 1, header: 2
+    assert_equal [{ 'one' =>  1, 'two' => 2, 'three' => 3 }], @no_header.to_a
+  end
+  
+  def test_option_start
+    @header.turn_to 1, start: 3
+    assert_equal [{ 'col1' => 'one', 'col2' => 'two', 'col3' => 'three' }], @header.to_a
+    @header.turn_to 1, start: 4
+    assert_equal [], @header.to_a
+  end
+  
+  def test_option_end
+    @header.turn_to 1, end: 2
+    assert_equal [{ 'col1' => 1, 'col2' => 2, 'col3' => 3 }], @header.to_a
+    @header.turn_to 1, end: 4
+    assert_equal [{ 'col1' => 1, 'col2' => 2, 'col3' => 3 }, { 'col1' => 'one', 'col2' => 'two', 'col3' => 'three' }], @header.to_a
+  end
+  
+  def test_option_keep_row
+    @header.turn_to 1, keep_row: 1
+    assert_equal [{ 'col1' => 'col1', 'col2' => 'col2', 'col3' => 'col3' }], @header.to_a
+  end
+  
+  def test_option_skip_row
+    @header.turn_to 1, skip_row: 3
+    assert_equal [{ 'col1' => 1, 'col2' => 2, 'col3' => 3 }], @header.to_a
+  end
+  
+  def test_option_keep_col
+    @header.turn_to 1, keep_col: 1
+    assert_equal [{ 'col1' => 1 }, { 'col1' => 'one' }], @header.to_a
+  end
+  
+  def test_option_skip_col
+    @header.turn_to 1, skip_col: [2, 3]
+    assert_equal [{ 'col1' => 1 }, { 'col1' => 'one' }], @header.to_a
+  end
+  
+  def test_uniq_unique_header
+    assert_equal [{ 'col' => 1, 'col_dup' => 2, 'col_dup2' => 3 }, { 'col' => 'one', 'col_dup' => 'two', 'col_dup2' => 'three' }], @dup_header.to_a
+  end
+end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: sheet2hash
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Wei-Ming Wu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-30 00:00:00.000000000 Z
+date: 2013-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roo
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,34 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: yard
+  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
@@ -30,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -54,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -76,35 +97,39 @@ files:
 - lib/sheet2hash/options.rb
 - lib/sheet2hash/version.rb
 - sheet2hash.gemspec
+- test/dup-header.xls
+- test/header.xls
+- test/no-header.xls
+- test/test_helper.rb
+- test/workbook_test.rb
 homepage: http://github.com/wnameless/sheet2hash
 licenses:
 - Apache License, Version 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1249836198874523190
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1249836198874523190
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
-summary: sheet2hash-0.1.0
-test_files: []
+specification_version: 4
+summary: sheet2hash-0.2.0
+test_files:
+- test/dup-header.xls
+- test/header.xls
+- test/no-header.xls
+- test/test_helper.rb
+- test/workbook_test.rb
+has_rdoc: