ooxml_parser 0.23.0 → 0.26.0

data/lib/ooxml_parser/xlsx_parser/workbook/worksheet/table_part/extension_list/extension/sparkline_groups/sparkline_group/sparklines/sparkline.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for `sparkline` data
+  class Sparkline < OOXMLDocumentObject
+    # @return [String] reference to source range of sparkline
+    attr_reader :source_reference
+    # @return [String] reference to destination range of sparkline
+    attr_reader :destination_reference
+
+    # Parse Sparkline
+    # @param [Nokogiri::XML:Node] node with Sparkline
+    # @return [Sparkline] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'f'
+          @source_reference = node_child.text
+        when 'sqref'
+          @destination_reference = node_child.text
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/xlsx_parser/workbook/worksheet/table_part/extension_list/extension/sparkline_groups/sparkline_group/sparklines.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'sparklines/sparkline'
+module OoxmlParser
+  # Class for `sparklines` data
+  class Sparklines < OOXMLDocumentObject
+    # @return [Array<Sparkline>] list of sparklines
+    attr_reader :sparklines
+
+    def initialize(parent: nil)
+      @sparklines = []
+      super
+    end
+
+    # @return [Sparkline] accessor
+    def [](key)
+      sparklines[key]
+    end
+
+    # Parse Sparklines data
+    # @param [Nokogiri::XML:Element] node with Sparklines data
+    # @return [Sparklines] value of Sparklines data
+    def parse(node)
+      node.xpath('*').each do |column_node|
+        case column_node.name
+        when 'sparkline'
+          @sparklines << Sparkline.new(parent: self).parse(column_node)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/xlsx_parser/{xlsx_data/view_model/workbook → workbook}/worksheet/table_part/extension_list/extension/sparkline_groups/sparkline_group.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'sparkline_group/sparklines'
 module OoxmlParser
   # Class for `sparklineGroup` data
   class SparklineGroup < OOXMLDocumentObject
@@ -49,6 +50,8 @@ module OoxmlParser
     attr_reader :color_negative
     # @return [OoxmlColor] markers color
     attr_reader :color_markers
+    # @return [Sparklines] sparklines
+    attr_reader :sparklines
 
     # Parse SparklineGroup
     # @param [Nokogiri::XML:Node] node with SparklineGroup
@@ -107,6 +110,8 @@ module OoxmlParser
           @color_negative = OoxmlColor.new(parent: self).parse(node_child)
         when 'colorMarkers'
           @color_markers = OoxmlColor.new(parent: self).parse(node_child)
+        when 'sparklines'
+          @sparklines = Sparklines.new(parent: self).parse(node_child)
         end
       end
       self

data/lib/ooxml_parser/xlsx_parser/{xlsx_data/view_model/workbook → workbook}/worksheet/xlsx_column_properties.rb

@@ -3,7 +3,7 @@
 module OoxmlParser
   # Properties of XLSX column
   class XlsxColumnProperties < OOXMLDocumentObject
-    attr_accessor :from, :to, :width, :style
+    attr_accessor :style
     # @return [True, False] is width custom
     attr_accessor :custom_width
     # @return [True, False] Flag indicating if the
@@ -12,6 +12,14 @@ module OoxmlParser
     # @return [True, False] Flag indicating if the
     # specified column(s) is hidden
     attr_reader :hidden
+    # @return [Integer] First column affected by this 'column info' record.
+    attr_reader :min
+    # @return [Integer] Last column affected by this 'column info' record.
+    attr_reader :max
+    # @return [Float] width in pixel, as stored in xml structure
+    attr_reader :width_raw
+    # @return [Float] width, in readable format
+    attr_reader :width
 
     # Parse XlsxColumnProperties object
     # @param node [Nokogiri::XML:Element] node to parse
@@ -20,13 +28,14 @@ module OoxmlParser
       node.attributes.each do |key, value|
         case key
         when 'min'
-          @from = value.value.to_i
+          @min = value.value.to_i
         when 'max'
-          @to = value.value.to_i
+          @max = value.value.to_i
         when 'style'
           @style = root_object.style_sheet.cell_xfs.xf_array[value.value.to_i]
         when 'width'
-          @width = value.value.to_f - 0.7109375
+          @width_raw = value.value.to_f
+          @width = calculate_width(@width_raw)
         when 'customWidth'
           @custom_width = option_enabled?(node, 'customWidth')
         when 'bestFit'
@@ -38,6 +47,13 @@ module OoxmlParser
       self
     end
 
+    alias from min
+    alias to max
+
+    extend Gem::Deprecate
+    deprecate :from, 'min', 2099, 1
+    deprecate :to, 'max', 2099, 1
+
     # Parse list of XlsxColumnProperties
     # @param columns_width_node [Nokogiri::XML:Element] node to parse
     # @param parent [OOXMLDocumentObject] parent of result objects
@@ -50,5 +66,17 @@ module OoxmlParser
       end
       columns
     end
+
+    private
+
+    # TODO: Currently width calculation use some magick number from old time ago
+    #   Actual formula is way more complicated and require data about
+    #   font max width for single character.
+    #   Read more in ECMA-376, §18.3.1.13
+    # @param [Float] value raw value for width
+    # @return [Float] width value
+    def calculate_width(value)
+      value - 0.7109375
+    end
   end
 end

data/lib/ooxml_parser/xlsx_parser/{xlsx_data/view_model/workbook → workbook}/worksheet/xlsx_row/xlsx_cell.rb

@@ -12,6 +12,8 @@ module OoxmlParser
     attr_reader :style_index
     # @return [String] value of cell
     attr_reader :value
+    # @return [String] An A-1 style reference to a cell.
+    attr_reader :reference
     # @return [String] type of string
     attr_reader :type
 
@@ -31,6 +33,8 @@ module OoxmlParser
           @style_index = value.value.to_i
         when 't'
           @type = value.value.to_s
+        when 'r'
+          @reference = value.value.to_s
         end
       end
       node.xpath('*').each do |node_child|
@@ -60,6 +64,11 @@ module OoxmlParser
       @raw_text
     end
 
+    # @return [Coordinates] coordinates of cell
+    def coordinates
+      @coordinates ||= Coordinates.new.parse_string(@reference)
+    end
+
     private
 
     # @return [Nothing] parse text data

data/lib/ooxml_parser/xlsx_parser/{xlsx_data/view_model/workbook → workbook}/worksheet/xlsx_row.rb

@@ -4,13 +4,17 @@ require_relative 'xlsx_row/xlsx_cell'
 module OoxmlParser
   # Single Row of XLSX
   class XlsxRow < OOXMLDocumentObject
-    attr_accessor :cells, :height, :style, :hidden
+    attr_accessor :height, :style, :hidden
     # @return [True, False] true if the row height has been manually set.
     attr_accessor :custom_height
-    # @return [Integer] Indicates to which row in the sheet this <row> definition corresponds.
+    # @return [Integer] Indicates to which row in the sheet
+    #   this <row> definition corresponds.
     attr_accessor :index
+    # @return [Array<Cells>] cells of row, as in xml structure
+    attr_reader :cells_raw
 
     def initialize(parent: nil)
+      @cells_raw = []
       @cells = []
       super
     end
@@ -34,10 +38,22 @@ module OoxmlParser
       node.xpath('*').each do |node_child|
         case node_child.name
         when 'c'
-          @cells[Coordinates.new.parse_string(node_child.attribute('r').value.to_s).column_number.to_i - 1] = XlsxCell.new(parent: self).parse(node_child)
+          @cells_raw << XlsxCell.new(parent: self).parse(node_child)
         end
       end
       self
     end
+
+    # @return [Array<XlsxCell, nil>] list of cell in row, with nil,
+    #   if cell data is not stored in xml
+    def cells
+      return @cells if @cells.any?
+
+      cells_raw.each do |cell|
+        @cells[cell.coordinates.column_number.to_i - 1] = cell
+      end
+
+      @cells
+    end
   end
 end

data/lib/ooxml_parser/{xlsx_parser/xlsx_parser.rb → xlsx_parser.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'xlsx_data/view_model/workbook'
+require_relative 'xlsx_parser/workbook'
 
 module OoxmlParser
   # Basic class for parsing xlsx

data/lib/ooxml_parser.rb

@@ -1,23 +1,11 @@
 # frozen_string_literal: true
 
-require_relative 'ooxml_parser/common_parser/common_data/ooxml_document_object'
-require_relative 'ooxml_parser/common_parser/common_data/color'
-require_relative 'ooxml_parser/common_parser/common_data/coordinates'
-require_relative 'ooxml_parser/common_parser/common_data/font_style'
-require_relative 'ooxml_parser/common_parser/common_data/borders_properties'
-require_relative 'ooxml_parser/common_parser/common_data/hyperlink'
-require_relative 'ooxml_parser/common_parser/common_data/paragraph'
-require_relative 'ooxml_parser/common_parser/common_data/alternate_content/alternate_content'
-require_relative 'ooxml_parser/common_parser/common_data/colors/presentation_fill'
-require_relative 'ooxml_parser/common_parser/common_data/table'
-require_relative 'ooxml_parser/common_parser/common_data/relationships'
-require_relative 'ooxml_parser/common_parser/parser'
-require_relative 'ooxml_parser/common_parser/common_document_structure'
+require_relative 'ooxml_parser/common_parser'
 require_relative 'ooxml_parser/configuration'
 require_relative 'ooxml_parser/helpers/string_helper'
-require_relative 'ooxml_parser/docx_parser/docx_parser'
-require_relative 'ooxml_parser/xlsx_parser/xlsx_parser'
-require_relative 'ooxml_parser/pptx_parser/pptx_parser'
+require_relative 'ooxml_parser/docx_parser'
+require_relative 'ooxml_parser/xlsx_parser'
+require_relative 'ooxml_parser/pptx_parser'
 
 # Basic class for all parser stuff
 module OoxmlParser