excelerate 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.md

@@ -0,0 +1,76 @@
+Excelerate
+==========
+
+Excelerate is a gem that adds a modern Ruby API to the classic
+ParseExcel library. ParseExcel does a wonderful job of pulling the data
+out of an Excel file, but its usability is lacking. Excelerate is
+intended to address those woes.
+
+Installation
+------------
+
+Install via standard gem installation:
+
+    gem install excelerate
+
+Add to `Gemfile`:
+
+    gem 'excelerate'
+
+Usage
+-----
+
+Open a file via URL:
+
+    Excelerate.open 'http://example.com/example.xls'
+
+Open a local file:
+
+    Excelerate.open 'example.xls'
+
+Select a worksheet:
+
+    workbook = Excelerate.open(file)
+    first_sheet = workbook.first
+    second_sheet = workbook[1]
+
+Get column headers:
+
+    first_sheet.column_headers
+
+Loop through all cells:
+
+    first_sheet.each_cell { |cell| puts cell }
+
+Loop through rows or columns:
+
+    first_sheet.rows.each { |row| puts row }
+    first_sheet.columns.each { |row| puts columns }
+
+Grab an individual row or column:
+
+    first_sheet.row(4)
+    first_sheet.column(4)
+
+Other Features
+--------
+
+* `attr_reader` for instance variables
+* Can open files, strings, or URLs
+
+To do
+-----
+
+* Make it work on Heroku by default
+
+Contributing
+------------
+
+Just issue a pull request!
+
+License
+-------
+
+Released under the MIT license:
+
+* http://www.opensource.org/licenses/MIT

data/Rakefile

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

data/excelerate.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "excelerate/version"
+
+Gem::Specification.new do |s|
+  s.name        = "excelerate"
+  s.version     = Excelerate::VERSION
+  s.authors     = ["Matthew Culpepper"]
+  s.email       = ["culpepper.matthew@gmail.com"]
+  s.homepage    = "http://github.com/mculp/excelerate"
+  s.summary     = %q{An extension to ParseExcel}
+  s.description = %q{An extension to ParseExcel with an updated, simple-to-use API}
+
+  s.rubyforge_project = "excelerate"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'parseexcel'
+  s.add_development_dependency 'rspec'
+end

data/lib/excelerate.rb

@@ -0,0 +1,18 @@
+require "excelerate/version"
+require "excelerate/util"
+require "excelerate/parent_reader"
+
+require "delegate"
+
+require "excelerate/workbook"
+require "excelerate/worksheet"
+require "parseexcel"
+
+module Excelerate
+  def self.open(args)
+    spreadsheet_file = Util::parse_args(args)
+    workbook = Spreadsheet::ParseExcel.parse(spreadsheet_file)
+
+    Workbook.new(:workbook => workbook)
+  end
+end

data/lib/excelerate/parent_reader.rb

@@ -0,0 +1,13 @@
+module Excelerate
+  module ParentReader
+    def parent_reader(*args)
+      args.each do |arg|
+        class_eval <<-READER, __FILE__, __LINE__ + 1
+          def #{arg}
+            __getobj__.instance_variable_get(:@#{arg})
+          end
+        READER
+      end
+    end
+  end
+end

data/lib/excelerate/util.rb

@@ -0,0 +1,19 @@
+module Excelerate
+  module Util
+    def self.parse_args(args)
+      case args
+      when /^https?:\/\//
+        open_url(args)
+      when args.respond_to?(:seek)
+        args
+      when String
+        File.open(args, 'rb+')
+      end
+    end
+
+    def self.open_url(args)
+      require 'open-uri'
+      open(args)
+    end
+  end
+end

data/lib/excelerate/version.rb

@@ -0,0 +1,3 @@
+module Excelerate
+  VERSION = "0.0.1"
+end

data/lib/excelerate/workbook.rb

@@ -0,0 +1,17 @@
+module Excelerate
+  class Workbook < SimpleDelegator
+    def initialize(options = {})
+      __setobj__ options[:workbook]
+    end
+
+    def first
+      Worksheet.new(:worksheet => __getobj__.worksheet(0))
+    end
+
+    def worksheet(index)
+      Worksheet.new(:worksheet => __getobj__.worksheet(index))
+    end
+    alias_method :[], :worksheet
+
+  end
+end

data/lib/excelerate/worksheet.rb

@@ -0,0 +1,48 @@
+module Excelerate
+  class Worksheet < SimpleDelegator
+    extend ParentReader
+
+    AS_CELL = proc { |cell| Cell.new(:cell => cell) }
+
+    parent_reader :cells, :min_row, :max_row, :min_col, :max_col
+
+    def initialize(options = {})
+      __setobj__ options[:worksheet]
+    end
+
+    def each_cell(&block)
+      cells.flatten.map(&AS_CELL).each &block
+    end
+
+    def columns
+      cells.transpose.map { |c| c.map(&AS_CELL) }
+    end
+
+    def column(index)
+      columns[index]
+    end
+
+    def rows
+      cells.map { |c| c.map(&AS_CELL) }
+    end
+
+    def row(index)
+      rows[index]
+    end
+
+    def column_headers
+      rows.first.map(&AS_CELL)
+    end
+
+    class Cell < SimpleDelegator
+      def initialize(options = {})
+        __setobj__ options[:cell]
+      end
+
+      def value
+        __getobj__.value.delete("\x00")
+      end
+      alias_method :to_s, :value
+    end
+  end
+end

data/spec/lib/excelerate/util_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Excelerate::Util do
+  it "should open a local file" do
+    file_name = File.join(File.dirname(__FILE__), '..', '..', 'assets', 'example.xls')
+    file = Excelerate::Util.parse_args(file_name)
+
+    file.should respond_to(:seek)
+  end
+end

data/spec/lib/excelerate/workbook_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Excelerate::Workbook do
+  let(:workbook) { 
+    file_name = File.join(File.dirname(__FILE__), '..', '..', 'assets', 'example.xls')
+    Excelerate.open(file_name)
+  }
+
+  it "should provide a method to get a workbook index" do
+    workbook.worksheet(0).should be_a_kind_of(Excelerate::Worksheet)  
+  end
+
+  it "should provide a helper method to get first worksheet" do
+    workbook.first.should be_a_kind_of(Excelerate::Worksheet)  
+    workbook.first.to_s.should == workbook.worksheet(0).to_s
+  end
+end
+

data/spec/lib/excelerate/worksheet_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Excelerate::Worksheet do
+  let(:workbook) { 
+    file_name = File.join(File.dirname(__FILE__), '..', '..', 'assets', 'example.xls')
+    Excelerate.open(file_name)
+  }
+
+  let(:worksheet) { workbook.first }
+
+  context "Cell" do
+    it "should provide a value without null bytes" do
+      worksheet.column_headers.first.should be_a_kind_of(Excelerate::Worksheet::Cell)
+      worksheet.column_headers.first.value.should == 'VOTER'
+    end
+  end
+
+  it "should provide an array of column headers" do
+    worksheet.column_headers.first.value.should == 'VOTER'
+  end
+
+  it "should provide an array of all columns" do
+    worksheet.columns.size.should == 7
+  end
+
+  it "should provide a way to get a specific column" do
+    worksheet.column(0).to_s.should == worksheet.columns[0].to_s
+  end
+
+  it "should provide an array of all rows" do
+    worksheet.rows.size.should == 50
+  end
+
+  it "should provide a way to get a specific row" do
+    worksheet.row(0).to_s.should == worksheet.rows[0].to_s
+  end
+
+  it "should provide an enumerator for each cell" do
+    worksheet.each_cell.to_a.size.should == 350
+  end
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+
+Bundler.require
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: excelerate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matthew Culpepper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parseexcel
+  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: rspec
+  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: An extension to ParseExcel with an updated, simple-to-use API
+email:
+- culpepper.matthew@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- excelerate.gemspec
+- lib/excelerate.rb
+- lib/excelerate/parent_reader.rb
+- lib/excelerate/util.rb
+- lib/excelerate/version.rb
+- lib/excelerate/workbook.rb
+- lib/excelerate/worksheet.rb
+- spec/assets/example.xls
+- spec/lib/excelerate/util_spec.rb
+- spec/lib/excelerate/workbook_spec.rb
+- spec/lib/excelerate/worksheet_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/mculp/excelerate
+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: excelerate
+rubygems_version: 1.8.22
+signing_key: 
+specification_version: 3
+summary: An extension to ParseExcel
+test_files:
+- spec/assets/example.xls
+- spec/lib/excelerate/util_spec.rb
+- spec/lib/excelerate/workbook_spec.rb
+- spec/lib/excelerate/worksheet_spec.rb
+- spec/spec_helper.rb