ooxml_excel 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f763147398129f0ac41335c8ddf647bb2540917e
-  data.tar.gz: e9f93a0c9ee5ec07cdcd8269f77b49b9480e7980
+  metadata.gz: e5989596afa2991677b2986fc66c4aa8be2c24af
+  data.tar.gz: ddffed3aadfe48b0f9a7d4c5299eed9a441dbe54
 SHA512:
-  metadata.gz: d3a06ce3169938a146da26eb347ffbc812b7b15627b04d237407fb25ed7138a2b31f298293a12e231a54e9a0756ab18092b9b24ac393e580b2bfb8c16727cbe0
-  data.tar.gz: cb765ec3f0bb940938f7a4ba968b7f8aa54549f0f7040eb6c4e60dd1165804ec72466c91649d24558903c7914e188ec7ecee93dd2cecac33399ed624b51eb424
+  metadata.gz: c6add5668d0617f49da6bf79f3c0dd3083ae797cfe9b2a75b844fea1091c6a396a6479ba443973b28bd74a0a7de1a6287692529b831b2816b30d320f830030b8
+  data.tar.gz: 9ee8046efadb7a0fdf9b89a12f29e7e110b3819bb49f60f3ed9f06103246f4da5ae7748b5aeb0645dc99644ca3f9caa54da4f522fb39807ba83b5fc991e630c1

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+test.rb
+test.xlsm

data/README.md

@@ -1,8 +1,6 @@
 # OOXML Excel
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ooxml_excel`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+TODO: Description
 
 ## Installation
 
@@ -22,7 +20,90 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Using `OOXML::Excel` to read spreadsheet:
+```
+ooxml_excel = OOXML::Excel.new('example.xlsx')
+```
+
+### Fetching all sheets:
+```
+ooxml_excel.sheets # ['Test Sheet 1', 'Test Sheet 2']
+```
+
+### Accessing Rows and Cells
+```
+sheet = ooxml_excel.sheet('Test Sheet 1')
+
+# Rows
+sheet[0] # Access the first row
+sheet.rows[0] # Same as above
+
+# Cells
+sheet[0].cells # Fetch all cells
+sheet.rows[0].cells # longer way to do it
+
+sheet[0][0] # Access the first cell of the row
+sheet.rows[0].cells[0] # longer way to do it
+
+sheet[0][0].value # Access cell values
+sheet.rows[0].cells[0].value # longer way to do it
+
+```
+
+### Iterating to each row:
+```
+# as an array of strings
+ooxml_excel.sheet('Test Sheet 1').each_row do |row|
+  # Do something here...
+end
+
+# as an array of objects
+ooxml_excel.sheet('Test Sheet 1').each_row_as_object do |row|
+  # Do something here...
+  p row
+end
+
+```
+
+### Fetching Columns:
+```
+# Fetch all columns
+ooxml_excel.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
+```
+
+### Fetching Styles:
+
+```
+# Font
+font_object = ooxml_excel.sheet('Test Sheet 1').font('A1')
+font.bold? # false
+font.name # Arial
+font.rgb_color # FFE10000
+font.size # 8
+
+# Cell Fill
+fill_object = ooxml_excel.sheet('Test Sheet 1').fill('A1')
+fill_object.bg_color # FFE10000
+fill_object.fg_color # FFE10000
+```
+
+### Data Validation
+```
+# All Validations
+data_validations = ooxml_excel.sheet('Test Sheet 1').data_validations
+
+# Specific validation for cell
+data_validation = ooxml.sheet('Input Sheet').data_validation('D4')
+
+data_validation.prompt # "Sample Validation Message"
+data_validation.formula # 20
+data_validation.type #textLength
+
+```
 
 ## Development
 
@@ -32,4 +113,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/[USERNAME]/ooxml_excel.
+Bug reports and pull requests are welcome on GitHub at https://github.com/halcjames/ooxml_excel.

data/lib/ooxml_excel.rb

@@ -3,6 +3,7 @@ require 'active_support/all'
 require 'zip'
 require "ooxml_excel/version"
 require "ooxml_excel/helper/list"
+require "ooxml_excel/util"
 require "ooxml_excel/excel"
 require "ooxml_excel/styles"
 require "ooxml_excel/comments"

data/lib/ooxml_excel/comments.rb

@@ -15,7 +15,15 @@ module OOXML
         comment_xml =Nokogiri.XML(comment_xml).remove_namespaces!
 
         comments = comment_xml.xpath("//comments/commentList/comment").map do |comment_node|
-          value = (comment_node.xpath('./text/r/t').last || comment_node.at_xpath('./text/r/t') || comment_node.at_xpath('./text/t')).text
+          comment_text_node = comment_node.xpath('./text/r/t')
+
+          value = if comment_text_node.is_a?(Array)
+            comment_text_node.map { |comment_text_node| comment_text_node.text }.join('')
+          else
+            comment_text_node.text
+          end
+
+          # value = (comment_node.xpath('./text/r/t').last || comment_node.at_xpath('./text/r/t') || comment_node.at_xpath('./text/t')).text
           id = comment_node.attributes["ref"].to_s
           [id, value]
         end.to_h

data/lib/ooxml_excel/sheet.rb

@@ -2,6 +2,7 @@ module OOXML
   class Excel
     class Sheet
       include OOXML::Helper::List
+      include OOXML::Util
       attr_reader :columns, :data_validations, :shared_strings
       attr_accessor :comments, :styles, :defined_names, :name
 
@@ -17,13 +18,13 @@ module OOXML
         @code_name ||= @xml.xpath('//sheetPr').attribute('codeName').try(:value)
       end
 
-      def data_validation_for_cell(cell_ref)
+      def data_validation(cell_ref)
         data_validations.find { |data_validation| data_validation.sqref_range.include?(cell_ref)}
       end
 
-
       def column(id)
-        columns.select { |column| column.id_range.include?(id)}
+        uniformed_reference = uniform_reference(id)
+        columns.find { |column| column.id_range.include?(uniformed_reference)}
       end
 
       def columns
@@ -42,6 +43,10 @@ module OOXML
         end
       end
 
+      def row(index)
+        rows.find { |row| row.id == index.to_s}
+      end
+
       def rows
         @rows ||= begin
           # TODO: get the value of merged cells
@@ -52,6 +57,18 @@ module OOXML
         end
       end
 
+      def each_row
+        rows.each_with_index do |row, row_index|
+          yield row.cells.map(&:value), row_index
+        end
+      end
+
+      def each_row_as_object
+        0.upto(rows.size).each do |row_index|
+          yield rows[row_index]
+        end
+      end
+
       def font(cell_reference)
         style_id = fetch_style_style_id(cell_reference)
         if style_id.present?
@@ -69,17 +86,6 @@ module OOXML
         end
       end
 
-      def each_row
-        rows.each_with_index do |row, row_index|
-          yield row.cells.map(&:value), row_index
-        end
-      end
-
-      def each_row_as_object
-        0.upto(rows.size).each do |row_index|
-          yield rows[row_index]
-        end
-      end
 
       def data_validations
         @data_validations ||= begin
@@ -111,6 +117,7 @@ module OOXML
       class Column
         attr_accessor :id, :width, :custom_width, :id_range, :hidden
         alias_method :hidden?, :hidden
+
         def initialize(**attrs)
           attrs.each { |property, value| send("#{property}=", value)}
         end

data/lib/ooxml_excel/util.rb

@@ -0,0 +1,16 @@
+module OOXML
+  module Util
+    COLUMN_LETTERS = ('A'..'ZZZZ').to_a
+    def letter_equivalent(index)
+      COLUMN_LETTERS.fetch(index)
+    end
+
+    def letter_index(letter)
+      COLUMN_LETTERS.index { |c_letter| c_letter == letter}
+    end
+
+    def uniform_reference(ref)
+      ref.to_s[/[A-Z]/] ? letter_index(ref) + 1 : ref
+    end
+  end
+end

data/lib/ooxml_excel/version.rb

@@ -1,5 +1,5 @@
 module OOXML
   class Excel
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ooxml_excel
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - James Mones
@@ -121,6 +121,7 @@ files:
 - lib/ooxml_excel/helper/list.rb
 - lib/ooxml_excel/sheet.rb
 - lib/ooxml_excel/styles.rb
+- lib/ooxml_excel/util.rb
 - lib/ooxml_excel/version.rb
 - lib/ooxml_excel/workbook.rb
 - ooxml_excel.gemspec