spreadsheetx 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+  gem "zipruby", "~> 0.3.6"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.6.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    zipruby (0.3.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.2)
+  rcov
+  rspec (~> 2.3.0)
+  zipruby (~> 0.3.6)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Craig Ulliott
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,27 @@
+= spreadsheetx
+
+This gem facilitates a templatized approach to working with Excel files.  It only supports Microsoft's new .xlsx format (because it's xml based and somewhat sane to work with).
+
+We use this gem to generate reports for clients, where the reports have substantial charts and styling throughout.
+
+The work flow goes a little something like this:
+* Create a report in Excel that has all your charts and styling
+* Save the report with placeholder data
+* Programmatically replace or add rows and cells
+* When the new file is opened, formatting and charts are preserved
+
+== Contributing to spreadsheetx
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Craig Ulliott. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+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 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "spreadsheetx"
+  gem.homepage = "http://github.com/craigulliott/spreadsheetx"
+  gem.license = "MIT"
+  gem.summary = %Q{Facilitates opening and modifying existing xlsx excel spreadsheets}
+  gem.description = %Q{Using an existing xlsx file as a template, it allows you to modify cell values and add rows and columns.  Facilitating a templateized approach to creating a new xlsx spreadsheet}
+  gem.email = "craigulliott@gmail.com"
+  gem.authors = ["Craig Ulliott"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "spreadsheetx #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/spreadsheetx.rb

@@ -0,0 +1,21 @@
+# zipruby is nice as it can modify an existing zip file, perfect for our usecase 
+require 'zipruby'
+# we use this because it comes with ruby
+require 'rexml/document'
+# for copying files
+require 'fileutils'
+# 
+require 'spreadsheetx/workbook'
+require 'spreadsheetx/worksheet'
+
+module SpreadsheetX
+  
+  class << self
+
+    def open(path)
+      SpreadsheetX::Workbook.new(path)
+    end
+  
+  end
+  
+end

data/lib/spreadsheetx/workbook.rb

@@ -0,0 +1,55 @@
+module SpreadsheetX
+
+  # This class represents an XLSX Document on disk
+  class Workbook
+
+    attr_reader :path
+    attr_reader :worksheets
+
+    # return a Workbook object which relates to an existing xlsx file on disk
+    def initialize(path)
+      @path = path
+      Zip::Archive.open(path) do |archive|
+        
+        # open the workbook
+        archive.fopen('xl/workbook.xml') do |f| 
+
+          # read contents of this file
+          file_contents = f.read 
+
+          #parse the XML and build the worksheets
+          @worksheets = []
+          REXML::Document.new(file_contents).elements.each('workbook/sheets/sheet') do |node|
+            sheet_id = node.attributes['sheetId'].to_i
+            r_id = node.attributes['r:id'].gsub('rId','').to_i
+            name = node.attributes['name'].to_s
+            @worksheets.push SpreadsheetX::Worksheet.new(archive, sheet_id, r_id, name)
+          end
+          
+        end
+
+      end
+    end
+    
+    # saves the binary form of the complete xlsx file to a new xlsx file
+    def save(destination_path)
+
+      # copy the xlsx file to the destination
+      FileUtils.cp(@path, destination_path)
+      
+      # replace the xlsx files with the new workbooks
+      Zip::Archive.open(destination_path) do |ar|
+        
+        # replace with the new worksheets
+        @worksheets.each do |worksheet|
+          ar.replace_buffer("xl/worksheets/sheet#{worksheet.r_id}.xml", worksheet.to_s)
+        end
+                
+      end
+
+    end
+
+  end
+  
+end
+

data/lib/spreadsheetx/worksheet.rb

@@ -0,0 +1,88 @@
+module SpreadsheetX
+
+  # Workbooks are made up of N Worksheets, this class represents a specific Worksheet.
+  class Worksheet
+
+    attr_reader :sheet_id
+    attr_reader :r_id
+    attr_reader :name
+    
+    # return a Worksheet object which relates to a specific Worksheet
+    def initialize(archive, sheet_id, r_id, name)
+      @sheet_id = sheet_id
+      @r_id = r_id
+      @name = name
+
+      # open the workbook
+      archive.fopen("xl/worksheets/sheet#{@r_id}.xml") do |f| 
+
+        # read contents of this file
+        file_contents = f.read 
+        #parse the XML and hold the doc
+        @xml_doc = REXML::Document.new(file_contents)
+
+      end
+      
+    end
+
+    # update the value of a particular cell, if the row or cell doesnt exist in the XML, then it will be created
+    def update_cell(col_number, row_number, val)
+      
+      cell_id = SpreadsheetX::Worksheet.cell_id(col_number, row_number)
+      
+      rows = @xml_doc.get_elements("worksheet/sheetData/row[@r=#{row_number}]")
+      # was this row found
+      if rows.empty?
+        # build a new row
+        row = @xml_doc.elements['worksheet'].elements['sheetData'].add_element('row', {'r' => row_number})
+      else
+        # x path returns an array, but we know there is only one row with this number
+        row = rows.first
+      end
+      
+      cells = row.get_elements("c[@r='#{cell_id}']")
+      if cells.empty?
+        cell = row.add_element('c', {'r' => cell_id})
+      else
+        # x path returns an array, but we know there is only one row with this number
+        cell = cells.first
+      end
+      
+      # first clear out any existing values
+      cell.delete_element('*')
+
+      # now we put the value in the cell
+      if val.kind_of? String
+        cell.attributes['t'] = 'inlineStr'
+        cell.add_element('is').add_element('t').add_text(val)
+      else
+        cell.attributes['t'] = nil
+        cell.add_element('v').add_text(val.to_s)
+      end
+
+    end
+    
+    # the number of rows containing data this sheet has 
+    # NOTE: this is the count of those rows, not the length of the document
+    def row_count
+      count = 0
+      @xml_doc.elements.each('worksheet/sheetData/row'){ count+=1 }
+      count
+    end
+
+    # returns the xml representation of this worksheet
+    def to_s
+      @xml_doc.to_s
+    end
+    
+    # turns a cell address into its excel name, 1,1 = A1  2,3 = C2 etc.
+    def self.cell_id(col_number, row_number)
+      letter = 'A'
+      # some day, speed this up
+      (col_number.to_i-1).times{letter = letter.succ}
+      "#{letter}#{row_number}"
+    end
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'spreadsheetx'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/spreadsheetx_spec.rb

@@ -0,0 +1,85 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Spreadsheetx" do
+  
+  it "opens xlsx files successfully" do
+    
+    # a valid xlsx file used for testing
+    empty_xlsx_file = "#{File.dirname(__FILE__)}/../templates/spec.xlsx"
+    workbook = SpreadsheetX.open(empty_xlsx_file)
+    
+  end
+  
+  it "allow accessing worksheets" do
+    
+    # a valid xlsx file used for testing
+    empty_xlsx_file = "#{File.dirname(__FILE__)}/../templates/spec.xlsx"
+    workbook = SpreadsheetX.open(empty_xlsx_file)
+    
+    workbook.worksheets.length.should == 2
+    workbook.worksheets.last.name.should == 'Test'
+    
+  end
+  
+  it "allow accessing row counts" do
+    
+    # a valid xlsx file used for testing
+    empty_xlsx_file = "#{File.dirname(__FILE__)}/../templates/spec.xlsx"
+    workbook = SpreadsheetX.open(empty_xlsx_file)
+
+    workbook.worksheets.last.row_count.should == 4
+    
+  end
+  
+  it "can be saved" do
+  
+    # a valid xlsx file used for testing
+    empty_xlsx_file = "#{File.dirname(__FILE__)}/../templates/spec.xlsx"
+    workbook = SpreadsheetX.open(empty_xlsx_file)
+  
+    new_xlsx_file = "#{File.dirname(__FILE__)}/../templates/spec_out.xlsx"
+    workbook.save(new_xlsx_file)
+  
+  end
+  
+  it "can convert an address of a cell to a cell name" do
+    
+    SpreadsheetX::Worksheet.cell_id(1, 1).should == 'A1'
+    SpreadsheetX::Worksheet.cell_id(2, 1).should == 'B1'
+    SpreadsheetX::Worksheet.cell_id(27, 9).should == 'AA9'
+    SpreadsheetX::Worksheet.cell_id(26, 4).should == 'Z4'
+    SpreadsheetX::Worksheet.cell_id(820, 496).should == 'AEN496'
+    
+    
+  end
+  
+  it "allows cell values to be updated" do
+  
+    # a valid xlsx file used for testing
+    empty_xlsx_file = "#{File.dirname(__FILE__)}/../templates/spec.xlsx"
+    workbook = SpreadsheetX.open(empty_xlsx_file)
+  
+    workbook.worksheets.last.update_cell(1, 1, 9)
+    workbook.worksheets.last.update_cell(1, 2, 'A')
+    workbook.worksheets.last.update_cell(1, 3, nil)
+
+    new_xlsx_file = "#{File.dirname(__FILE__)}/../templates/spec_changed_out.xlsx"
+    workbook.save(new_xlsx_file)
+  
+  end
+
+  it "allows cells to be added" do
+  
+    # a valid xlsx file used for testing
+    empty_xlsx_file = "#{File.dirname(__FILE__)}/../templates/spec.xlsx"
+    workbook = SpreadsheetX.open(empty_xlsx_file)
+  
+    workbook.worksheets.last.update_cell(9, 9, 9)
+    workbook.worksheets.last.update_cell(9, 10, 'A')
+
+    new_xlsx_file = "#{File.dirname(__FILE__)}/../templates/spec_added_out.xlsx"
+    workbook.save(new_xlsx_file)
+  
+  end
+  
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: spreadsheetx
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Craig Ulliott
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-02 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.2
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: zipruby
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.3.6
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: Using an existing xlsx file as a template, it allows you to modify cell values and add rows and columns.  Facilitating a templateized approach to creating a new xlsx spreadsheet
+email: craigulliott@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/spreadsheetx.rb
+- lib/spreadsheetx/workbook.rb
+- lib/spreadsheetx/worksheet.rb
+- spec/spec_helper.rb
+- spec/spreadsheetx_spec.rb
+- templates/spec.xlsx
+has_rdoc: true
+homepage: http://github.com/craigulliott/spreadsheetx
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -715639084265841052
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Facilitates opening and modifying existing xlsx excel spreadsheets
+test_files: []
+