ooxml_parser 0.25.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 409ce77d24b38512604d5215a2bd6a54f887685db71cd9942c81935ef678f3b0
-  data.tar.gz: 4f7edddf4bab2d5d6ab9485754b333a2943d2df96fdcc933d671e820cd9dc70d
+  metadata.gz: 8d10481491c8a8bb901c8514f5a7c19ee3b6482e8fb943f39b9191dbd057d395
+  data.tar.gz: efbdbe106e2e88c584e428b8536cedb96972033434b5e1457f6ae2b31946cdd4
 SHA512:
-  metadata.gz: aad06b0a4dd775d5efe4411d43b87ebda68fe05a5a15924fb6773d77169141284baaf8047eee042634a2e6145649ac0fce2e9aa143d401587434598eeff5f73d
-  data.tar.gz: c2ab404a2ab3f559a312da5953da7a668b4ae1c359ff790bc4b4d577ccbd453e4314844125cc64e144c884f9e187389586c98f085c4d27ca5837d8a1b9e61f9d
+  metadata.gz: b553b7f055d43a6a355592ac8c2d28b085795b0faadf12531f119d4a1d15b1c7bcd45a5a661aad611799aa3286266469b88c12792bb4c3bba0b6c3fac2a0f54d
+  data.tar.gz: 1a68d32efafe9ee2921ffd6c75a794dd340a4b6d814e4aa7daa6348fb1246644a12b99a071df7e7e1bfe84de02f15c96a4068f6227008ec051a1932b0bdb01db

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/drawing_properties/docx_wrap_drawing.rb

@@ -4,6 +4,16 @@ module OoxmlParser
   # Docx Wrap Drawing
   class DocxWrapDrawing < OOXMLDocumentObject
     attr_accessor :wrap_text, :distance_from_text
+    # @return [Boolean] Specifies whether this floating DrawingML
+    #   object is displayed behind the text of the
+    #   document when the document is displayed.
+    #   When a DrawingML object is displayed
+    #   within a WordprocessingML document,
+    #   that object can intersect with text in the
+    #   document. This attribute shall determine
+    #   whether the text or the object is rendered on
+    #   top in case of overlapping.
+    attr_reader :behind_doc
 
     def initialize(parent: nil)
       @wrap_text = :none
@@ -14,10 +24,16 @@ module OoxmlParser
     # @param node [Nokogiri::XML:Element] node to parse
     # @return [DocxWrapDrawing] result of parsing
     def parse(node)
-      unless node.attribute('behindDoc').nil?
-        @wrap_text = :behind if node.attribute('behindDoc').value == '1'
-        @wrap_text = :infront if node.attribute('behindDoc').value == '0'
+      node.attributes.each do |key, value|
+        case key
+        when 'behindDoc'
+          @behind_doc = attribute_enabled?(value)
+        end
       end
+
+      @wrap_text = :behind if @behind_doc == true
+      @wrap_text = :infront if @behind_doc == false
+
       node.xpath('*').each do |node_child|
         case node_child.name
         when 'wrapSquare'

data/lib/ooxml_parser/common_parser/common_data/color.rb

@@ -60,8 +60,10 @@ module OoxmlParser
       to_s
     end
 
-    # @return [String] color in hex value
+    # @return [String, nil] color in hex value or `nil` if color is not defined
     def to_hex
+      return nil if none?
+
       (@red.to_s(16).rjust(2, '0') + @green.to_s(16).rjust(2, '0') + @blue.to_s(16).rjust(2, '0')).upcase
     end
 

data/lib/ooxml_parser/docx_parser/document_structure/docx_paragraph/docx_paragraph_run.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# noinspection RubyTooManyInstanceVariablesInspection
 require_relative 'docx_paragraph_run/docx_paragraph_run_helpers'
 require_relative 'docx_paragraph_run/instruction_text'
 require_relative 'docx_paragraph_run/object'

data/lib/ooxml_parser/docx_parser/document_structure/docx_paragraph.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# noinspection RubyTooManyInstanceVariablesInspection
 require_relative 'docx_paragraph/bookmark_start'
 require_relative 'docx_paragraph/bookmark_end'
 require_relative 'docx_paragraph/comment_range_end'

data/lib/ooxml_parser/docx_parser/document_structure.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# noinspection RubyInstanceMethodNamingConvention
 require_relative 'document_structure/comments'
 require_relative 'document_structure/comments_extended'
 require_relative 'document_structure/docx_paragraph'

data/lib/ooxml_parser/version.rb

@@ -4,6 +4,6 @@ module OoxmlParser
   # This module holds the RuboCop version information.
   module Version
     # [String] Version of Gem
-    STRING = '0.25.0'
+    STRING = '0.26.0'
   end
 end

data/lib/ooxml_parser/xlsx_parser/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/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/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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ooxml_parser
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.26.0
 platform: ruby
 authors:
 - ONLYOFFICE
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-28 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -605,7 +605,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.19
+rubygems_version: 3.3.20
 signing_key: 
 specification_version: 4
 summary: OoxmlParser Gem