Module: IMW::Formats::Excel

Includes:
Enumerable
Defined in:
lib/imw/formats/excel.rb

Overview

Defines methods for reading and writing Microsoft Excel data.

Instance Method Summary collapse

Instance Method Details

#each {|Spreadsheet::Excel::Row| ... } ⇒ Object

Yield each row of this Excel document.

Will loop from one worksheet to the next.

Yields:

  • (Spreadsheet::Excel::Row) 


38
39
40
41
42
43
 
# File 'lib/imw/formats/excel.rb', line 38

def each &block
  require 'spreadsheet'
  Spreadsheet.open(path).worksheets.each do |worksheet|
    worksheet.each(&block)
  end
end

#load ⇒ Array<Array>

Return the data in this Excel document as an array of arrays.

Data from consecutive worksheets will be concatenated into a single outer array.

Returns:



19
20
21
22
23
24
25
26
27
28
 
# File 'lib/imw/formats/excel.rb', line 19

def load
  require 'spreadsheet'
  data = []
  Spreadsheet.open(path).worksheets.each do |worksheet|
    data += worksheet.map do |row|
      row.to_a
    end
  end
  data
end

#num_lines ⇒ Integer

Return the number of lines in this Excel document.

Measured across worksheets.

Returns:

  • (Integer) 


50
51
52
53
54
55
 
# File 'lib/imw/formats/excel.rb', line 50

def num_lines
  require 'spreadsheet'
  Spreadsheet.open(path).worksheets.inject(0) do |sum, worksheet|
    sum += worksheet.row_count
  end
end

#snippet ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/imw/formats/excel.rb', line 76

def snippet
  require 'spreadsheet'
  returning([]) do |snip|
    row_num = 1
    Spreadsheet.open(path).worksheets.each do |worksheet|
      worksheet.each do |row|
        break if row_num > 10
        snip << row.to_a
        row_num += 1
      end
      break if row_num > 10
    end
  end
end

#validate_schema! ⇒ Object

Ensure that this Excel resource is described by a an ordered collection of flat fields.

Raises:



9
10
11
 
# File 'lib/imw/formats/excel.rb', line 9

def validate_schema!
  raise IMW::SchemaError.new("#{self.class} resources must be described by an ordered set of flat fields") if schema.any?(&:nested?)
end