sheet2hash 0.1.0

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+.project
+*.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sheet2hash.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2013 Wei-Ming Wu
+
+Licensed under the Apache License, Version 2.0 (the "License"); you
+may not use this file except in compliance with the License. You may
+obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied. See the License for the specific language governing
+permissions and limitations under the License.

data/README.md

@@ -0,0 +1,62 @@
+# Sheet2hash
+
+Convert Excel or Spreadsheet to Ruby hash
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sheet2hash'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sheet2hash
+
+## Usage
+
+Basic:
+
+    wb = Sheet2hash.workbook.new 'path/to/your/excel_or_spreadsheet'
+    wb.to_a # convert default sheet to array of hash
+            # [{ field1 => data, field2 => data, ...}, { field1 => data, field2 => data, ...}, ...]
+            # each hash is a row of sheet
+            # the first row is used to be the keys of hash
+    wb.to_h # convert all sheets to hash
+            # the output will be { 'name_of_sheet' => [{ field => data, ... }, ...] }
+            
+Advanced:
+
+    # All sheets are count from 1, NOT 0
+    wb.sheets                           # list all sheets in the workbook
+    wb.sheet                            # show the name of current workbook
+    wb.turn_to(2)                       # make sheet 2 as current sheet
+    wb.turn_to('name_of_the_3rd_sheet') # make sheet 3 as current sheet
+
+Options:
+
+     # All rows, columns are count from 1, NOT 0
+    wb = Sheet2hash.workbook.new 'path/to/your/excel_or_spreadsheet',
+      :header   => 3,                     # use specific row as header 
+      :header   => ['col1', 'col2', ...], # use self-defined header
+      :start    => 4,                     # start at row 4
+      :end      => 20,                    # end at row 20
+      :keep_row => [4, 5],                # only convert row 4 and 5
+      :skip_row => [6, 7],                # skip row 6 and 7
+      :keep_col => [1],                   # only convert column 1
+      :skip_col => [2, 3]                 # skip column 2 and 3
+      
+    wb.turn_to(2, :herder => 3, ...)      # global options can be overrided by passing options to specfic sheet
+                                          # global options will still affect after turning to another sheet
+      
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/sheet2hash/errors.rb

@@ -0,0 +1,4 @@
+module Sheet2hash
+  class SheetNotFoundError < Exception ; end
+  class InvalidHeaderError < Exception ; end
+end

data/lib/sheet2hash/options.rb

@@ -0,0 +1,16 @@
+module Sheet2hash
+  module Options
+    def process_options(opts)
+      regulate_options opts
+      opts
+    end
+    
+    private
+    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

data/lib/sheet2hash/version.rb

@@ -0,0 +1,7 @@
+module Sheet2hash
+  MAJOR = 0
+  MINOR = 1
+  PATCH = 0
+
+  VERSION = [MAJOR, MINOR, PATCH].compact.join('.')
+end

data/lib/sheet2hash.rb

@@ -0,0 +1,162 @@
+require 'roo'
+require 'sheet2hash/errors'
+require 'sheet2hash/options'
+
+module Sheet2hash
+  class Workbook
+    include Options
+    
+    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 = {})
+      if sheet.kind_of?(Integer) && sheet <= sheets.size
+        @workbook.default_sheet = sheets[sheet - 1]
+        @sheet_opts = process_options sheet_opts
+        set_sheet_attributes
+      elsif sheet.kind_of?(String) && sheets.include?(sheet)
+        @workbook.default_sheet = sheet
+        @sheet_opts = process_options sheet_opts
+        set_sheet_attributes
+      else
+        raise SheetNotFoundError
+      end
+    end
+    
+    def sheets
+      @workbook.sheets
+    end
+    
+    def sheet
+      @workbook.default_sheet
+    end
+    
+    def to_h
+      hash = {}
+      sheets.each do |sheet|
+        turn_to sheet
+        hash[sheet] = to_a
+      end
+      hash
+    end
+    
+    def to_a
+      ary = []
+      @rows.each do |row|
+        record = []
+        @columns.each { |col| record << trim_int_cell(@workbook.cell(row, col)) }
+        ary << Hash[ @header.zip record ]
+      end
+      ary
+    end
+    
+    private
+    def set_sheet_attributes
+      @header = header
+      @rows = rows
+      @columns = columns
+    end
+    
+    def trim_int_cell(cell)
+      cell.kind_of?(Numeric) && cell % 1 == 0 ? cell.to_i : cell
+    end
+    
+    def columns
+      columns = (@workbook.first_column..@workbook.last_column).to_a
+      if @sheet_opts[:skip_col] || @sheet_opts[:keep_col]
+        collect_columns columns, @sheet_opts
+      elsif @opts[:skip_col] || @opts[:keep_col]
+        collect_columns columns, @opts
+      else
+        columns
+      end
+    end
+    
+    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
+    end
+    
+    def first_row
+      first_row = @sheet_opts[:start] || @opts[:start]
+      first_row || @workbook.first_row
+    end
+    
+    def last_row
+      last_row = @sheet_opts[:end] || @opts[:end]
+      last_row || @workbook.last_row
+    end
+    
+    def rows
+      rows = (first_row..last_row).to_a
+      if @sheet_opts[:keep_row] || @sheet_opts[:skip_row]
+        rows = collect_rows rows, @sheet_opts
+        rows - [@sheet_opts[:header]]
+      elsif @opts[:keep_row] || @opts[:skip_row]
+        rows = collect_rows rows, @opts
+        rows - [@opts[:header]]
+      else
+        rows - [@workbook.first_row]
+      end
+    end
+    
+    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
+    end
+    
+    def header
+      header = @sheet_opts[:header] || @opts[:header]
+      if header
+        header = process_header header
+      else
+        header = header_from_row @workbook.first_row
+      end
+      match_header_with_columns header
+    end
+    
+    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)
+      if header.kind_of? Array
+        unique_header header
+      elsif header.kind_of? Integer
+        header_from_row header
+      else
+        raise InvalidHeaderError
+      end
+    end
+    
+    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)
+      header.reverse!
+      dup_header = header.dup
+      header = header.map do |field|
+        count = dup_header.count field
+        if count == 2
+          dup_header.delete_at dup_header.find_index(field)
+          "#{field}_dup"
+        elsif count > 1
+          dup_header.delete_at dup_header.find_index(field)
+          "#{field}_dup#{count - 1}"
+        else
+          field
+        end
+      end
+      header.reverse!
+    end
+  end
+end

data/sheet2hash.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sheet2hash/version'
+require 'date'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sheet2hash"
+  spec.version       = Sheet2hash::VERSION
+  spec.authors       = ["Wei-Ming Wu"]
+  spec.email         = ["wnameless@gmail.com"]
+  spec.description   = %q{Convert Excel or Spreadsheet to Ruby hash}
+  spec.date          = "#{Date.today.to_s}"
+  spec.summary       = "sheet2hash-#{Sheet2hash::VERSION}"
+  spec.homepage      = "http://github.com/wnameless/sheet2hash"
+  spec.license       = "Apache License, Version 2.0"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "roo"
+  
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: sheet2hash
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Wei-Ming Wu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: roo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Convert Excel or Spreadsheet to Ruby hash
+email:
+- wnameless@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sheet2hash.rb
+- lib/sheet2hash/errors.rb
+- lib/sheet2hash/options.rb
+- lib/sheet2hash/version.rb
+- sheet2hash.gemspec
+homepage: http://github.com/wnameless/sheet2hash
+licenses:
+- Apache License, Version 2.0
+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
+signing_key: 
+specification_version: 3
+summary: sheet2hash-0.1.0
+test_files: []