xls 0.1.0

data/README.md

@@ -0,0 +1,4 @@
+xls
+===
+
+A command line utility for working with data in Excel.

data/bin/xls

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+$:.unshift(File.join(File.dirname(File.expand_path(__FILE__)), '..', 'lib'))
+
+require 'rubygems'
+require 'xls'
+require 'commander/import'
+
+program :name, 'XLS'
+program :version, Xls::VERSION
+program :description, 'A command line utility for working with data in Excel.'
+
+
+################################################################################
+# Processing
+################################################################################
+
+command :columnize do |c|
+  c.syntax = 'xls columnize FILE'
+  c.description = 'Converts a worksheet formatted as table into 2-column rows using header/value.'
+  c.option('--output FILE', 'The path to the output file.')
+  c.option('--fixed-columns COLUMNS', 'The columns that should stay fixed.')
+  c.when_called do|args, options|
+    # Open input file.
+    abort("Input file required") if args.length == 0
+    workbook = Spreadsheet.open(args.first)
+    
+    # Run columnizer.
+    columnizer = Xls::Columnizer.new()
+    columnizer.fixed_columns = options.fixed_columns.to_s.split(",")
+    columnizer.execute(workbook)
+    
+    # Write output.
+    workbook.write(options.output || $stdout)
+  end
+end

data/lib/xls.rb

@@ -0,0 +1,7 @@
+require 'spreadsheet'
+
+require 'xls/columnizer'
+require 'xls/version'
+
+class Xls
+end

data/lib/xls/columnizer.rb

@@ -0,0 +1,77 @@
+class Xls
+  class Columnizer
+    ############################################################################
+    #
+    # Constructor
+    #
+    ############################################################################
+
+    def initialize(options={})
+      self.fixed_columns = options[:fixed_columns] || []
+    end
+
+
+    ############################################################################
+    #
+    # Attributes
+    #
+    ############################################################################
+
+    # A list of names of the columns that should stay fixed.
+    attr_accessor :fixed_columns
+    
+
+    ############################################################################
+    #
+    # Methods
+    #
+    ############################################################################
+    
+    # Converts the columns on the worksheets of the input workbook from
+    # n-column tables to 2-column tables.
+    #
+    # @param [Workbook]  input The input workbook.
+    #
+    # @return [Workbook]  The columnized workbook.
+    def process(input)
+      output = Spreadsheet::Workbook.new()
+      
+      (0...input.sheet_count).each do |input_sheet_index|
+        input_sheet = input.worksheet(input_sheet_index)
+        output_sheet = output.create_worksheet()
+        output_index = 1
+
+        # Process headers.
+        input_headers = input_sheet.row(0).map { |cell| cell.to_s }
+        output_sheet.row(0).replace(fixed_columns.clone.concat(['KEY', 'VALUE']))
+
+        # Process data.
+        column_range = (0...input_headers.length)
+        input_sheet.each(1) do |input_row|
+          # Determine fixed column values.
+          fixed_column_values = fixed_columns.map { '' }
+          column_range.each do |index|
+            fixed_column_index = fixed_columns.index(input_headers[index])
+            fixed_column_values[fixed_column_index] = input_row[index] unless fixed_column_index.nil?
+          end
+          
+          # Write key/value data.
+          column_range.each do |index|
+            next if fixed_columns.index(input_headers[index])
+            output_row = output_sheet.row(output_index)
+            output_row.replace(fixed_column_values)
+
+            # Write header and data.
+            output_row.push(input_headers[index])
+            output_row.push(input_row[index])
+    
+            output_index = output_index + 1
+          end
+        end
+
+      end
+      
+      return output
+    end
+  end
+end

data/lib/xls/version.rb

@@ -0,0 +1,3 @@
+class Xls
+  VERSION = "0.1.0"
+end

data/test/columnizer_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+
+class TestColumnizer < MiniTest::Unit::TestCase
+  def setup
+    @columnizer = Xls::Columnizer.new
+  end
+  
+  ######################################
+  # Execute
+  ######################################
+  
+  def test_columnize
+    input = Spreadsheet.open('fixtures/columnizer/basic.xls')
+    output = @columnizer.process(input)
+    assert_worksheet [
+      ['KEY', 'VALUE'],
+      ['col1', 'a'],
+      ['col2', 'b'],
+      ['col3', 'c'],
+      ['col4', 'd'],
+      ['col5', 'e'],
+      ['col6', 'f'],
+      ['col1', 'g'],
+      ['col2', 'h'],
+      ['col3', 'i'],
+      ['col4', 'j'],
+      ['col5', 'k'],
+      ['col6', 'l']
+      ],
+      output.worksheet(0)
+  end
+
+  def test_columnize_with_fixed_columns
+    input = Spreadsheet.open('fixtures/columnizer/fixed_columns.xls')
+    @columnizer.fixed_columns = ['fix1', 'fix2']
+    output = @columnizer.process(input)
+    assert_worksheet [
+      ['fix1', 'fix2', 'KEY', 'VALUE'],
+      ['AA', 'BB', 'col1', 'a'],
+      ['AA', 'BB', 'col2', 'b'],
+      ['AA', 'BB', 'col3', 'c'],
+      ['AA', 'BB', 'col4', 'd'],
+      ['AA', 'BB', 'col5', 'e'],
+      ['AA', 'BB', 'col6', 'f'],
+      ['CC', 'DD', 'col1', 'g'],
+      ['CC', 'DD', 'col2', 'h'],
+      ['CC', 'DD', 'col3', 'i'],
+      ['CC', 'DD', 'col4', 'j'],
+      ['CC', 'DD', 'col5', 'k'],
+      ['CC', 'DD', 'col6', 'l']
+      ],
+      output.worksheet(0)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'mocha'
+require 'unindentable'
+require 'xls'
+
+class MiniTest::Unit::TestCase
+  def assert_worksheet exp, worksheet, msg = nil
+    act = []
+    worksheet.each do |row|
+      act << row.map {|cell| cell.to_s.strip }
+    end
+    exp = exp.map {|row| row.map {|cell| '%-10s' % cell.to_s}.join('').strip}.join("\n")
+    act = act.map {|row| row.map {|cell| '%-10s' % cell.to_s}.join('').strip}.join("\n")
+    assert_equal(exp, act, msg)
+  end
+end
+

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: xls
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ben Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.3
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: spreadsheet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.6
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.5
+- !ruby/object:Gem::Dependency
+  name: unindentable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: 
+email:
+- benbjohnson@yahoo.com
+executables:
+- xls
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/xls/columnizer.rb
+- lib/xls/version.rb
+- lib/xls.rb
+- README.md
+- test/columnizer_test.rb
+- test/test_helper.rb
+- bin/xls
+homepage: http://github.com/benbjohnson/xls
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A command line utilty for working with data in Excel.
+test_files:
+- test/columnizer_test.rb
+- test/test_helper.rb