roo-xls 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1123a00b02f4882fe61348d8ce2e4d291ee69e18
+  data.tar.gz: 08219e99656723cb9d1d0c22439285985eb98cb5
+SHA512:
+  metadata.gz: 36d6728ac2bc30d611630220a91e16ae9dd7a37138cf10c60fec43794881a196218a7a9b8bcf69e08867e5ad54defed15f5514d72941f00b038a543d8bfb23b7
+  data.tar.gz: 0f3d5a35a4c83e19c964375cd0c1dc458bdad69b88d495b07b23595e2f0da506f4eebbc06c9222af37c3c009436543fd34d682cdafec4ba1f908f68cb4b4bbe2

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea
+.DS_Store

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  Include:
+    - '**/Rakefile'
+  Exclude:
+    - 'spec/**/*'
+Metrics/LineLength:
+  Max: 99
+Style/FileName:
+  Enabled: false
+Style/ModuleFunction:
+  Enabled: false
+Style/Encoding:
+  Enabled: false
+Documentation:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 15

data/.simplecov

@@ -0,0 +1,4 @@
+SimpleCov.start do
+  add_filter 'spec'
+  add_filter 'test'
+end

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1
+  - ruby-head
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-2
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+bundler_args: --without local_development

data/Gemfile

@@ -0,0 +1,30 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in roo-xls.gemspec
+gemspec
+
+if ENV['TRAVIS']
+  gem 'roo', '>= 2.0.0beta1', github: 'roo-rb/roo'
+else
+  gem 'roo', '>= 2.0.0beta1', path: ::File.expand_path('../../roo', __FILE__)
+end
+
+group :test do
+  # additional testing libs
+  gem 'webmock'
+  gem 'shoulda'
+  gem 'rspec', '>= 3.0.0'
+  gem 'simplecov', '>= 0.9.0', :require => false
+  gem 'coveralls', :require => false
+end
+
+group :local_development do
+  gem 'terminal-notifier-guard', require: false if RUBY_PLATFORM.downcase.include?('darwin')
+  gem 'guard-rspec', '>= 4.3.1' ,require: false
+  gem 'guard-bundler', require: false
+  gem 'guard-preek', require: false
+  gem 'guard-rubocop', require: false
+  gem 'guard-reek', git: 'https://github.com/pericles/guard-reek', require: false
+  gem 'pry'
+  gem 'transpec'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2008-2014 Thomas Preymesser, Ben Woosley
+
+MIT License
+
+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.md

@@ -0,0 +1,41 @@
+# Roo::Xls [![BuildStatus](https://travis-ci.org/roo-rb/roo-xls.svg)](https://travis-ci.org/roo-rb/roo-xls)[![Code Climate](https://codeclimate.com/github/roo-rb/roo-xls/badges/gpa.svg)](https://codeclimate.com/github/roo-rb/roo-xls)[![Coverage Status](https://coveralls.io/repos/roo-rb/roo-xls/badge.svg?branch=master)](https://coveralls.io/r/roo-rb/roo-xls?branch=master)
+
+This library extends Roo to add support for handling class Excel files, including:
+
+* .xls files
+* .xml files in the SpreadsheetML format (circa 2003)
+
+There is no support for formulas in Roo for .xls files - you can get the result
+of a formula but not the formula itself.
+
+## License
+
+While Roo and Roo::Xls are licensed under the MIT / Expat license, please note that the 'spreadsheet' gem [is released under](https://github.com/zdavatz/spreadsheet/blob/master/LICENSE.txt) the GPLv3 license.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'roo-xls'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install roo-xls
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/roo-xls/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+require 'coveralls/rake/task'
+
+# Test unit
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+# RSpec
+RSpec::Core::RakeTask.new(:spec)
+
+# Coveralls
+Coveralls::RakeTask.new
+
+default_task = [:test, :spec]
+default_task << 'coveralls:push' if ENV['TRAVIS']
+
+task default: default_task

data/defaults.reek

@@ -0,0 +1,11 @@
+---
+NestedIterators:
+  max_allowed_nesting: 2
+UtilityFunction:
+  enabled: false
+IrresponsibleModule:
+  enabled: false
+DuplicateMethodCall:
+  max_calls: 5
+FeatureEnvy:
+  enabled: false

data/lib/roo-xls.rb

@@ -0,0 +1,11 @@
+require 'roo'
+
+module Roo
+  autoload :Excel, 'roo/xls/excel'
+  autoload :Excel2003XML, 'roo/xls/excel_2003_xml'
+
+  CLASS_FOR_EXTENSION.merge!(
+    xls: Roo::Excel,
+    xml: Roo::Excel2003XML
+  )
+end

data/lib/roo/xls/excel.rb

@@ -0,0 +1,352 @@
+require 'roo/xls/version'
+require 'roo/base'
+require 'spreadsheet'
+
+module Roo
+  # Class for handling Excel-Spreadsheets
+  class Excel < Roo::Base
+    FORMULAS_MESSAGE = 'the spreadsheet gem does not support forumulas, so roo can not.'
+    CHARGUESS =
+      begin
+        require 'charguess'
+        true
+      rescue LoadError
+        false
+      end
+
+    attr_reader :workbook
+
+    # Creates a new Excel spreadsheet object.
+    # Parameter packed: :zip - File is a zip-file
+    def initialize(filename, options = {})
+      packed = options[:packed]
+      file_warning = options[:file_warning] || :error
+      mode = options[:mode] || 'rb+'
+
+      file_type_check(filename, '.xls', 'an Excel', file_warning, packed)
+      make_tmpdir do |tmpdir|
+        filename = download_uri(filename, tmpdir) if uri?(filename)
+        filename = open_from_stream(filename[7..-1], tmpdir) if filename.is_a?(::String) && filename[0, 7] == 'stream:'
+        filename = unzip(filename, tmpdir) if packed == :zip
+
+        @filename = filename
+        unless File.file?(@filename)
+          fail IOError, "file #{@filename} does not exist"
+        end
+        @workbook = ::Spreadsheet.open(filename, mode)
+      end
+      super(filename, options)
+      @formula = {}
+      @fonts = {}
+    end
+
+    attr_reader :workbook
+
+    def worksheets
+      @worksheets ||= workbook.worksheets
+    end
+
+    def encoding=(codepage)
+      @workbook.encoding = codepage
+    end
+
+    # returns an array of sheet names in the spreadsheet
+    def sheets
+      @sheets ||= worksheets.collect { |worksheet| normalize_string(worksheet.name) }
+    end
+
+    # this method lets you find the worksheet with the most data
+    def longest_sheet
+      sheet(worksheets.inject do|m, o|
+        o.row_count > m.row_count ? o : m
+      end.name)
+    end
+
+    # returns the content of a cell. The upper left corner is (1,1) or ('A',1)
+    def cell(row, col, sheet = default_sheet)
+      validate_sheet!(sheet)
+
+      read_cells(sheet)
+      fail 'should be read' unless @cells_read[sheet]
+      row, col = normalize(row, col)
+      if celltype(row, col, sheet) == :date
+        yyyy, mm, dd = @cell[sheet][[row, col]].split('-')
+        return Date.new(yyyy.to_i, mm.to_i, dd.to_i)
+      end
+      if celltype(row, col, sheet) == :string
+        return platform_specific_encoding(@cell[sheet][[row, col]])
+      else
+        if @cell[sheet] && @cell[sheet][[row, col]]
+          return @cell[sheet][[row, col]]
+        else
+          return nil
+        end
+      end
+    end
+
+    # returns the type of a cell:
+    # * :float
+    # * :string,
+    # * :date
+    # * :percentage
+    # * :formula
+    # * :time
+    # * :datetime
+    def celltype(row, col, sheet = default_sheet)
+      read_cells(sheet)
+      row, col = normalize(row, col)
+      begin
+        if @formula[sheet] && @formula[sheet][[row, col]]
+          :formula
+        elsif @cell_type[sheet]
+          @cell_type[sheet][[row, col]]
+        end
+      rescue
+        puts "Error in sheet #{sheet}, row #{row}, col #{col}"
+        raise
+      end
+    end
+
+    # returns NO formula in excel spreadsheets
+    def formula(_row, _col, _sheet = nil)
+      fail NotImplementedError, FORMULAS_MESSAGE
+    end
+    alias_method :formula?, :formula
+
+    # returns NO formulas in excel spreadsheets
+    def formulas(_sheet = nil)
+      fail NotImplementedError, FORMULAS_MESSAGE
+    end
+
+    # Given a cell, return the cell's font
+    def font(row, col, sheet = default_sheet)
+      read_cells(sheet)
+      row, col = normalize(row, col)
+      @fonts[sheet][[row, col]]
+    end
+
+    # shows the internal representation of all cells
+    # mainly for debugging purposes
+    def to_s(sheet = default_sheet)
+      read_cells(sheet)
+      @cell[sheet].inspect
+    end
+
+    private
+
+    # converts name of a sheet to index (0,1,2,..)
+    def sheet_no(name)
+      return name - 1 if name.is_a?(Fixnum)
+      i = 0
+      worksheets.each do |worksheet|
+        return i if name == normalize_string(worksheet.name)
+        i += 1
+      end
+      fail StandardError, "sheet '#{name}' not found"
+    end
+
+    def normalize_string(value)
+      value = every_second_null?(value) ? remove_every_second_null(value) : value
+      if CHARGUESS && encoding = CharGuess.guess(value)
+        encoding.encode Encoding::UTF_8
+      else
+        platform_specific_encoding(value)
+      end
+    end
+
+    def platform_specific_encoding(value)
+      result =
+        case RUBY_PLATFORM.downcase
+        when /darwin|solaris/
+          value.encode Encoding::UTF_8
+        when /mswin32/
+          value.encode Encoding::ISO_8859_1
+        else
+          value
+        end
+      if every_second_null?(result)
+        result = remove_every_second_null(result)
+      end
+      result
+    end
+
+    def every_second_null?(str)
+      result = true
+      return false if str.length < 2
+      0.upto(str.length / 2 - 1) do |i|
+        if str[i * 2 + 1, 1] != "\000"
+          result = false
+          break
+        end
+      end
+      result
+    end
+
+    def remove_every_second_null(str)
+      result = ''
+      0.upto(str.length / 2 - 1) do |i|
+        c = str[i * 2, 1]
+        result += c
+      end
+      result
+    end
+
+    # helper function to set the internal representation of cells
+    def set_cell_values(sheet, row, col, i, v, value_type, formula, _tr, font)
+      # key = "#{y},#{x+i}"
+      key = [row, col + i]
+      @cell_type[sheet] = {} unless @cell_type[sheet]
+      @cell_type[sheet][key] = value_type
+      @formula[sheet] = {} unless @formula[sheet]
+      @formula[sheet][key] = formula  if formula
+      @cell[sheet]    = {} unless @cell[sheet]
+      @fonts[sheet] = {} unless @fonts[sheet]
+      @fonts[sheet][key] = font
+
+      @cell[sheet][key] =
+        case value_type
+        when :float
+          v.to_f
+        when :string
+          v
+        when :date
+          v
+        when :datetime
+          @cell[sheet][key] = DateTime.new(v.year, v.month, v.day, v.hour, v.min, v.sec)
+        when :percentage
+          v.to_f
+        when :time
+          v
+        else
+          v
+        end
+    end
+
+    # ruby-spreadsheet has a font object so we're extending it
+    # with our own functionality but still providing full access
+    # to the user for other font information
+    module ExcelFontExtensions
+      def bold?(*_args)
+        # From ruby-spreadsheet doc: 100 <= weight <= 1000, bold => 700, normal => 400
+        weight == 700
+      end
+
+      def italic?
+        italic
+      end
+
+      def underline?
+        underline != :none
+      end
+    end
+
+    # read all cells in the selected sheet
+    def read_cells(sheet = default_sheet)
+      validate_sheet!(sheet)
+      return if @cells_read[sheet]
+
+      worksheet = @workbook.worksheet(sheet_no(sheet))
+      row_index = 1
+      worksheet.each(0) do |row|
+        (0..row.size).each do |cell_index|
+          cell = row.at(cell_index)
+          next if cell.nil?  # skip empty cells
+          next if cell.class == ::Spreadsheet::Formula && cell.value.nil? # skip empty formula cells
+          value_type, v =
+            if date_or_time?(row, cell_index)
+              read_cell_date_or_time(row, cell_index)
+            else
+              read_cell(row, cell_index)
+            end
+          formula = tr = nil # TODO:???
+          col_index = cell_index + 1
+          font = row.format(cell_index).font
+          font.extend(ExcelFontExtensions)
+          set_cell_values(sheet, row_index, col_index, 0, v, value_type, formula, tr, font)
+        end # row
+        row_index += 1
+      end # worksheet
+      @cells_read[sheet] = true
+    end
+
+    # Get the contents of a cell, accounting for the
+    # way formula stores the value
+    def read_cell_content(row, idx)
+      cell = row.at(idx)
+      cell = row[idx] if row[idx].class == ::Spreadsheet::Link
+      cell = cell.value if cell.class == ::Spreadsheet::Formula
+      cell
+    end
+
+    # Test the cell to see if it's a valid date/time.
+    def date_or_time?(row, idx)
+      format = row.format(idx)
+      if format.date_or_time?
+        cell = read_cell_content(row, idx)
+        true if Float(cell) > 0 rescue false
+      else
+        false
+      end
+    end
+
+    # Read the date-time cell and convert to,
+    # the date-time values for Roo
+    def read_cell_date_or_time(row, idx)
+      cell = read_cell_content(row, idx)
+      cell = cell.to_s.to_f
+      if cell < 1.0
+        value_type = :time
+        f = cell * 24.0 * 60.0 * 60.0
+        secs = f.round
+        h = (secs / 3600.0).floor
+        secs = secs - 3600 * h
+        m = (secs / 60.0).floor
+        secs = secs - 60 * m
+        s = secs
+        value = h * 3600 + m * 60 + s
+      else
+        if row.at(idx).class == ::Spreadsheet::Formula
+          datetime = row.send(:_datetime, cell)
+        else
+          datetime = row.datetime(idx)
+        end
+        if datetime.hour != 0 ||
+           datetime.min != 0 ||
+           datetime.sec != 0
+          value_type = :datetime
+          value = datetime
+        else
+          value_type = :date
+          if row.at(idx).class == ::Spreadsheet::Formula
+            value = row.send(:_date, cell)
+          else
+            value = row.date(idx)
+          end
+          value = sprintf('%04d-%02d-%02d', value.year, value.month, value.day)
+        end
+      end
+      [value_type, value]
+    end
+
+    # Read the cell and based on the class,
+    # return the values for Roo
+    def read_cell(row, idx)
+      cell = read_cell_content(row, idx)
+      case cell
+      when Float, Integer, Fixnum, Bignum
+        value_type = :float
+        value = cell.to_f
+      when ::Spreadsheet::Link
+        value_type = :link
+        value = cell
+      when String, TrueClass, FalseClass
+        value_type = :string
+        value = cell.to_s
+      else
+        value_type = cell.class.to_s.downcase.to_sym
+        value = nil
+      end # case
+      [value_type, value]
+    end
+  end
+end