ooxl 0.0.1.3 → 0.0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a113619ace35db1bf00ac13e6e87244fd2b96e63
-  data.tar.gz: 34e8bca89ac44a27f0d01c5b5ced014af9491448
+  metadata.gz: 9c035a6d25dad9b2fc7ce50c39416b21f02fdb37
+  data.tar.gz: d2a0e05e803f3342517046954320a47811ded2ec
 SHA512:
-  metadata.gz: f096acd98fa0df80d874db82f4177eb3928e3bbea95649adceadd91ea57023e426c6a0977eba1f7c9a919263245037b29b7bb8523d3af31d4203e37294f8b884
-  data.tar.gz: 05ffed4dd1358b480bc9cd89a857825e3d39498a6f466686c643e4d65629d20042133714d52a04422ad674f141ba578af0aff479d664861bcc03ee3626f68a40
+  metadata.gz: a41f60dc9727d85afa0f5962d1767b0bb4085590f30a5e27239e736b8e43c81a70cae362f9f3aeea2c4e11b400e6f97c3d629a818f2bc8783f7d934e66ed9fb7
+  data.tar.gz: 984607ce44b44d6ab6fb8d38f56a93de5225d4f09763834408081fc754be657bf23b481f494b744005ccd082759760fca79c04a206a43e55f42b1dd093c343b8

data/README.md

@@ -1,4 +1,4 @@
-# OOXML Excel
+# OOXL
 
 TODO: Description
 
@@ -7,7 +7,7 @@ TODO: Description
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'ooxml_excel'
+gem 'ooxl'
 ```
 
 And then execute:
@@ -16,85 +16,91 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install ooxml_excel
+    $ gem install ooxl
 
 ## Usage
 
-### Using `OOXML::Excel` to read spreadsheet:
+### reading an excel spreadsheet:
 ```
-ooxml_excel = OOXML::Excel.new('example.xlsx')
+ooxl = OOXL.new('example.xlsx')
+
+or
+
+ooxl = OOXL.open('example.xlsx')
 ```
 
 ### Fetching all sheets:
 ```
-ooxml_excel.sheets # ['Test Sheet 1', 'Test Sheet 2']
+ooxl.sheets # ['Test Sheet 1', 'Test Sheet 2']
 ```
 
 ### Accessing Rows and Cells
 ```
-sheet = ooxml_excel.sheet('Test Sheet 1')
+sheet = ooxl.sheet('Test Sheet 1')
 
 # Rows
-sheet[0] # Access the first row
-sheet.rows[0] # Same as above
+sheet.rows[0] # Access the first row
+sheet[0] # short version
 
 # Cells
-sheet[0].cells # Fetch all cells
-sheet.rows[0].cells # longer way to do it
+sheet.rows[0].cells # access the cells of the first row
+sheet[0].cells # short version
 
-sheet[0][0] # Access the first cell of the row
-sheet.rows[0].cells[0] # longer way to do it
+sheet.rows[0].cells[0] # Access the first cell of the row
+sheet[0][0] # short version
 
-sheet[0][0].value # Access cell value
-sheet.rows[0].cells[0].value # longer way to do it
+sheet.rows[0].cells[0].value # Access cell value
+sheet[0][0].value# short version
 
-ooxml_excel['Test Sheet 1'][0][0].value
+# Fetch cell value using the short versions
+ooxl['Test Sheet 1'][0][0].value
 ```
 
-### Iterating through each row:
+### Iteration
 ```
-# as an array of strings
-ooxml_excel.sheet('Test Sheet 1').each_row do |row|
-  # Do something here...
-  p row # ['text', 'text']
+ooxl.sheet('Test Sheet 1').each do |row|
+  row.each_with_index do |cell, cell_index|
+    # do something here..
+  end
 end
 
-# as an array of objects
-ooxml_excel.sheet('Test Sheet 1').each_row_as_object do |row|
-  # Do something here...
-  p row.cells # [OOXML::Excel::Row::Cell, ...]
+ooxl.each do |sheet|
+  sheet.each do |row|
+    row.each do |cell|
+      # do something here...
+    end
+  end
 end
-
 ```
 
 ### Fetching Columns
 ```
 # Fetch all columns
-ooxml_excel.sheet('Test Sheet 1').columns
+ooxl.sheet('Test Sheet 1').columns
 
 # Checking if the column is hidden
-ooxml_excel.sheet('Test Sheet 1').column(1).hidden? # column index
-ooxml_excel.sheet('Test Sheet 1').column('A').hidden? # column letter
+ooxl.sheet('Test Sheet 1').column(1).hidden? # column index
+ooxl.sheet('Test Sheet 1').column('A').hidden? # column letter
 ```
 
 ### Fetching Styles
 ```
 # Font
-font_object = ooxml_excel.sheet('Test Sheet 1').font('A1')
+font_object = ooxl.sheet('Test Sheet 1').font('A1')
 font_object.bold? # false
 font_object.name # Arial
 font_object.rgb_color # FFE10000
 font_object.size # 8
 
 # Cell Fill
-fill_object = ooxml_excel.sheet('Test Sheet 1').fill('A1')
+fill_object = ooxl.sheet('Test Sheet 1').fill('A1')
 fill_object.bg_color # FFE10000
 fill_object.fg_color # FFE10000
 ```
 ### Fetching Data from named/cell range
 ```
 # named range
-ooxml_excel.named_range('my_named_range') # ['value' 'from', 'range']
+ooxl.named_range('my_named_range') # ['value' 'from', 'range']
 
 # cell range
 ooxml['Lists'!$A$1:$A$6] # ['1','2','3','4','5','6']
@@ -112,7 +118,7 @@ ooxml['Lists!A1:B2'] # [['1', '2'], ['2','3']]
 ### Fetching Data Validation
 ```
 # All Validations
-data_validations = ooxml_excel.sheet('Test Sheet 1').data_validations
+data_validations = ooxl.sheet('Test Sheet 1').data_validations
 
 # Specific validation for cell
 data_validation = ooxml.sheet('Input Sheet').data_validation('D4')
@@ -131,4 +137,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/halcjames/ooxml_excel.
+Bug reports and pull requests are welcome on GitHub at https://github.com/halcjames/ooxl.

data/lib/ooxl/ooxl.rb

@@ -5,6 +5,7 @@ class OOXL
     @sheets = {}
     @styles = []
     @comments = {}
+    @relationships = {}
     parse_spreadsheet_contents(spreadsheet_filepath)
   end
 
@@ -29,7 +30,7 @@ class OOXL
 
     # shared variables
     sheet.name = sheet_name
-    sheet.comments = @comments[(sheet_index+1)]
+    sheet.comments = fetch_comments(sheet_index)
     sheet.styles = @styles
     sheet.defined_names = @workbook.defined_names
     sheet
@@ -61,6 +62,12 @@ class OOXL
   end
   alias_method :list_values, :load_list_values
 
+  def fetch_comments(sheet_index)
+    final_sheet_index = sheet_index+1
+    relationship = @relationships[final_sheet_index.to_s]
+    @comments[relationship.comment_id] if relationship.present?
+  end
+
   def parse_spreadsheet_contents(spreadsheet)
     shared_strings = []
     Zip::File.open(spreadsheet) do |spreadsheet_zip|
@@ -80,6 +87,9 @@ class OOXL
           end
         when "xl/workbook.xml"
           @workbook = OOXL::Workbook.load_from_stream(entry.get_input_stream.read)
+        when /xl\/worksheets\/_rels\/sheet\d+\.xml\.rels/
+          sheet_id = entry.name.scan(/sheet(\d+)/).flatten.first
+          @relationships[sheet_id] = Relationships.new(entry.get_input_stream.read)
         else
           # unsupported for now..
         end

data/lib/ooxl/version.rb

@@ -1,3 +1,3 @@
 class OOXL
-  VERSION = "0.0.1.3"
+  VERSION = "0.0.1.4"
 end

data/lib/ooxl/xl_objects/relationships.rb

@@ -0,0 +1,38 @@
+class OOXL
+  class Relationships
+    SUPPORTED_TYPES = ['http://schemas.openxmlformats.org/officeDocument/2006/relationships/comments']
+    def initialize(relationships_node)
+      @types = {}
+      parse_relationships(relationships_node)
+    end
+
+    def comment_id
+      @types['comments']
+    end
+
+    private
+    def parse_relationships(relationships_node)
+      relationships_node = Nokogiri.XML(relationships_node).remove_namespaces!
+      relationships_node.xpath('//Relationship').each do |relationship_node|
+        relationship_type = relationship_node.attributes["Type"].value
+        target = relationship_node.attributes["Target"].value
+        if supported_type?(relationship_type)
+          @types[extract_type(relationship_type)] = extract_file_reference(target)
+        end
+      end
+    end
+
+    def supported_type?(type)
+      SUPPORTED_TYPES.include?(type)
+    end
+
+    def extract_type(type)
+      type.split('/').last
+    end
+
+    def extract_file_reference(file)
+      file.scan(/(\d+)\.[\w]/).flatten.first
+    end
+
+  end
+end

data/lib/ooxl.rb

@@ -10,6 +10,7 @@ require "ooxl/version"
 require "ooxl/ooxl"
 require "ooxl/util"
 require "ooxl/xl_objects/workbook"
+require "ooxl/xl_objects/relationships"
 require "ooxl/xl_objects/comments"
 require "ooxl/xl_objects/styles"
 require "ooxl/xl_objects/sheet"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ooxl
 version: !ruby/object:Gem::Version
-  version: 0.0.1.3
+  version: 0.0.1.4
 platform: ruby
 authors:
 - James Mones
@@ -122,6 +122,7 @@ files:
 - lib/ooxl/xl_objects/cell.rb
 - lib/ooxl/xl_objects/column.rb
 - lib/ooxl/xl_objects/comments.rb
+- lib/ooxl/xl_objects/relationships.rb
 - lib/ooxl/xl_objects/row.rb
 - lib/ooxl/xl_objects/sheet.rb
 - lib/ooxl/xl_objects/sheet/data_validation.rb
@@ -151,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: OOXL Excel - Parse Excel Spreadsheets (xlsx, xlsm).