creek 2.3 → 2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb5f52bba0a71fddfc27213389475ad881b61e33
-  data.tar.gz: bad18bc3dadfb9412f354a2f527ede8cb16f8828
+  metadata.gz: bee3cecfd77048fd524de90b3c59d844295ac470
+  data.tar.gz: ea3765e651c0657920c714da61492afce161dcf4
 SHA512:
-  metadata.gz: becc2db698fdc35b68279ec7df03c95c9b2d12920e2de4e34c83a724116174dfa81b4730152d5ef72b517b7cb26c4c3b5d6b89887a32f6e61bf62d2364344363
-  data.tar.gz: c3164d65efb54c5d14d31fcd91fc865db85ae1b032015076a7b80e3b329248148c62b8ec907c9098fef3f34c964bca8b650021b8bfad37062a0c58d7b8f3b4b7
+  metadata.gz: 02de0c9ccc20d4489f66fcef6468e06adfba44320e0ccaf08091827706c53331d32fa641736a904c677e55e46c9ddde61894278eb63264d3567a551f4409fba1
+  data.tar.gz: '009e354166eba703d3ecd49dbc9b48114d612cd093a6904eb75fe42136016dfe3738f6229c910cd1565cc15e3cc26fbd772626b97ebf22904d59fe5c9ce14a3f'

data/README.md

@@ -26,11 +26,19 @@ creek = Creek::Book.new 'spec/fixtures/sample.xlsx'
 sheet = creek.sheets[0]
 
 sheet.rows.each do |row|
-  puts row # => {"A1"=>"Content 1", "B1"=>nil, C1"=>nil, "D1"=>"Content 3"}
+  puts row # => {"A1"=>"Content 1", "B1"=>nil, "C1"=>nil, "D1"=>"Content 3"}
+end
+
+sheet.simple_rows.each do |row|
+  puts row # => {"A"=>"Content 1", "B"=>nil, "C"=>nil, "D"=>"Content 3"}
 end
 
 sheet.rows_with_meta_data.each do |row|
-  puts row # => {"collapsed"=>"false", "customFormat"=>"false", "customHeight"=>"true", "hidden"=>"false", "ht"=>"12.1", "outlineLevel"=>"0", "r"=>"1", "cells"=>{"A1"=>"Content 1", "B1"=>nil, C1"=>nil, "D1"=>"Content 3"}}
+  puts row # => {"collapsed"=>"false", "customFormat"=>"false", "customHeight"=>"true", "hidden"=>"false", "ht"=>"12.1", "outlineLevel"=>"0", "r"=>"1", "cells"=>{"A1"=>"Content 1", "B1"=>nil, "C1"=>nil, "D1"=>"Content 3"}}
+end
+
+sheet.simple_rows_with_meta_data.each do |row|
+  puts row # => {"collapsed"=>"false", "customFormat"=>"false", "customHeight"=>"true", "hidden"=>"false", "ht"=>"12.1", "outlineLevel"=>"0", "r"=>"1", "cells"=>{"A"=>"Content 1", "B"=>nil, "C"=>nil, "D"=>"Content 3"}}
 end
 
 sheet.state   # => 'visible'

data/lib/creek/sheet.rb

@@ -46,18 +46,33 @@ module Creek
       @drawing.images_at(cell) if @images_present
     end
 
+
+    ##
+    # Provides an Enumerator that returns a hash representing each row.
+    # The key of the hash is the column ID and the value is the value of the cell.
+    def simple_rows
+      rows_generator false, true
+    end
+
     ##
     # Provides an Enumerator that returns a hash representing each row.
     # The key of the hash is the Cell id and the value is the value of the cell.
     def rows
-      rows_generator
+      rows_generator false, false
     end
 
     ##
     # Provides an Enumerator that returns a hash representing each row.
     # The hash contains meta data of the row and a 'cells' embended hash which contains the cell contents.
     def rows_with_meta_data
-      rows_generator true
+      rows_generator true, false
+    end
+
+    ##
+    # Provides an Enumerator that returns a hash representing each row.
+    # The hash contains meta data of the row and a 'cells' embended hash which contains the cell contents.
+    def simple_rows_with_meta_data
+      rows_generator true, true
     end
 
     private
@@ -65,7 +80,7 @@ module Creek
     ##
     # Returns a hash per row that includes the cell ids and values.
     # Empty cells will be also included in the hash with a nil value.
-    def rows_generator include_meta_data=false
+    def rows_generator include_meta_data=false, use_simple_rows_format=false
       path = if @sheetfile.start_with? "/xl/" or @sheetfile.start_with? "xl/" then @sheetfile else "xl/#{@sheetfile}" end
       if @book.files.file.exist?(path)
         # SAX parsing, Each element in the stream comes through as two events:
@@ -84,7 +99,7 @@ module Creek
                 cells = Hash.new
                 y << (include_meta_data ? row : cells) if node.self_closing?
               elsif (node.name.eql? 'row') and (node.node_type.eql? closer)
-                processed_cells = fill_in_empty_cells(cells, row['r'], cell)
+                processed_cells = fill_in_empty_cells(cells, row['r'], cell, use_simple_rows_format)
 
                 if @images_present
                   processed_cells.each do |cell_name, cell_value|
@@ -99,13 +114,9 @@ module Creek
                 cell_type      = node.attributes['t']
                 cell_style_idx = node.attributes['s']
                 cell           = node.attributes['r']
-              elsif (node.name.eql? 'v') and (node.node_type.eql? opener)
-                unless cell.nil?
-                  cells[cell] = convert(node.inner_xml, cell_type, cell_style_idx)
-                end
-              elsif (node.name.eql? 't') and (node.node_type.eql? opener)
+              elsif (['v', 't'].include? node.name) and (node.node_type.eql? opener)
                 unless cell.nil?
-                  cells[cell] = convert(node.inner_xml, cell_type, cell_style_idx)
+                  cells[(use_simple_rows_format ? cell.tr("0-9", "") : cell)] = convert(node.inner_xml, cell_type, cell_style_idx)
                 end
               end
             end
@@ -129,14 +140,14 @@ module Creek
     ##
     # The unzipped XML file does not contain any node for empty cells.
     # Empty cells are being padded in using this function
-    def fill_in_empty_cells(cells, row_number, last_col)
+    def fill_in_empty_cells(cells, row_number, last_col, use_simple_rows_format)
       new_cells = Hash.new
 
       unless cells.empty?
         last_col = last_col.gsub(row_number, '')
 
         ("A"..last_col).to_a.each do |column|
-          id = "#{column}#{row_number}"
+          id = use_simple_rows_format ? "#{column}" : "#{column}#{row_number}"
           new_cells[id] = cells[id]
         end
       end

data/lib/creek/version.rb

@@ -1,3 +1,3 @@
 module Creek
-  VERSION = "2.3"
+  VERSION = "2.4"
 end

data/spec/test_spec.rb

@@ -65,6 +65,16 @@ describe 'Creek parsing a sample XLSX file' do
                     {'A6'=>'1', 'B6'=>'2', 'C6'=>'3'}, {'A7'=>'Content 15', 'B7'=>'Content 16', 'C7'=>'Content 18', 'D7'=>'Content 19'},
                     {'A8'=>nil, 'B8'=>'Content 20', 'C8'=>nil, 'D8'=>nil, 'E8'=>nil, 'F8'=>'Content 21'},
                     {'A10' => 0.15, 'B10' => 0.15}]
+
+    @expected_simple_rows = [{"A"=>"Content 1", "B"=>nil, "C"=>"Content 2", "D"=>nil, "E"=>"Content 3"},
+                    {"A"=>nil, "B"=>"Content 4", "C"=>nil, "D"=>"Content 5", "E"=>nil, "F"=>"Content 6"},
+                    {},
+                    {"A"=>"Content 7", "B"=>"Content 8", "C"=>"Content 9", "D"=>"Content 10", "E"=>"Content 11", "F"=>"Content 12"},
+                    {"A"=>nil, "B"=>nil, "C"=>nil, "D"=>nil, "E"=>nil, "F"=>nil, "G"=>nil, "H"=>nil, "I"=>nil, "J"=>nil, "K"=>nil, "L"=>nil, "M"=>nil, "N"=>nil, "O"=>nil, "P"=>nil, "Q"=>nil, "R"=>nil, "S"=>nil, "T"=>nil, "U"=>nil, "V"=>nil, "W"=>nil, "X"=>nil, "Y"=>nil, "Z"=>"Z Content", "AA"=>nil, "AB"=>nil, "AC"=>nil, "AD"=>nil, "AE"=>nil, "AF"=>nil, "AG"=>nil, "AH"=>nil, "AI"=>nil, "AJ"=>nil, "AK"=>nil, "AL"=>nil, "AM"=>nil, "AN"=>nil, "AO"=>nil, "AP"=>nil, "AQ"=>nil, "AR"=>nil, "AS"=>nil, "AT"=>nil, "AU"=>nil, "AV"=>nil, "AW"=>nil, "AX"=>nil, "AY"=>nil, "AZ"=>"Content 13"},
+                    {"A"=>"1", "B"=>"2", "C"=>"3"},
+                    {"A"=>"Content 15", "B"=>"Content 16", "C"=>"Content 18", "D"=>"Content 19"},
+                    {"A"=>nil, "B"=>"Content 20", "C"=>nil, "D"=>nil, "E"=>nil, "F"=>"Content 21"},
+                    {"A"=>0.15, "B"=>0.15}]
   end
 
   after(:all) do
@@ -83,6 +93,20 @@ describe 'Creek parsing a sample XLSX file' do
     expect(sheet.rid).to eql 'rId1'
   end
 
+  it 'Parse simple rows successfully.' do
+    rows = Array.new
+    row_count = 0
+    @creek.sheets[0].simple_rows.each do |row|
+      rows << row
+      row_count += 1
+    end
+    (0..8).each do |number|
+      expect(rows[number]).to eq(@expected_simple_rows[number])
+    end
+    expect(row_count).to eq(9)
+  end
+
+
   it 'Parse rows with empty cells successfully.' do
     rows = Array.new
     row_count = 0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: creek
 version: !ruby/object:Gem::Version
-  version: '2.3'
+  version: '2.4'
 platform: ruby
 authors:
 - pythonicrubyist