ooxml_parser 0.12.2 → 0.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36954aec83ece68abe869fbdacc1eb46f3324ca2220fa1309480ac58c1d7a30e
-  data.tar.gz: aa146d19ad2d1791d435be68b2d13bf4f601fbea14856cd880c292c269d3fc77
+  metadata.gz: c95b99d5e8d76d3aa01ae9ede02b290bc97e8959dc61fbf33d50e51d52ec9ebc
+  data.tar.gz: 053d4bd9fcd951f1e9507adc5dd1e281227e9c1643f8fdfc0ecdefea5462bab1
 SHA512:
-  metadata.gz: d024e15631968da836ad38f32316f52eb87a9aa924cbb7240ea445162679799ce4cfc85183122e07fdc8a501b34efde6a6c3d38d179b7fd7ee12fd5e17a95693
-  data.tar.gz: e97ac2cff7f7db1f93e79bff2b7110db0c78a748f396337ac851369c799001eb9779762324dfa7c177a9583905cd435db2ba507caab7faf41a5a980e66a0f31c
+  metadata.gz: 63c6f712cb033e723c63b44067d08323408cf6fc13472a0af57425899e74630f6389bc6ea77b4bf849d2745c04378f444c4c7932dfaafc94b7108bbeaeadf3e8
+  data.tar.gz: 86d3dad08a7d0838b4a11cfaf4329b6806b786ee7f791aadf03ea68efcd8e1b94901e4a8b81420412868882b855a606b3144aa28a27d92c01c11e4ed3196881d

data/lib/ooxml_parser/common_parser/common_data/alternate_content/chart/chart.rb

@@ -53,12 +53,12 @@ module OoxmlParser
           @grouping = chart_props_node_child.attribute('val').value.to_sym
         when 'ser'
           @series << Series.new(parent: self).parse(chart_props_node_child)
-          case @type
-          when :point, :bubble
-            val = chart_props_node_child.xpath('c:yVal')[0]
-          else
-            val = chart_props_node_child.xpath('c:val')[0]
-          end
+          val = case @type
+                when :point, :bubble
+                  chart_props_node_child.xpath('c:yVal')[0]
+                else
+                  chart_props_node_child.xpath('c:val')[0]
+                end
           next unless val
           next if val.xpath('c:numRef').empty?
 

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/picture/docx_blip/file_reference.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'uri'
+
 module OoxmlParser
   # Class for storing image data
   class FileReference < OOXMLDocumentObject

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

@@ -8,7 +8,7 @@ module OoxmlParser
     def parse_hex_string(hex_string)
       return self if %w[auto null].include?(hex_string)
 
-      char_array = hex_string.split(//)
+      char_array = hex_string.chars
       case char_array.length
       when 3
         @red = char_array[0].hex

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragraph_run/run_properties/shade.rb

@@ -23,8 +23,8 @@ module OoxmlParser
     # @return [String] text representation
     def to_s
       "Value: `#{value}`, "\
-      "Color: `#{color}`, "\
-      "Fill: `#{fill}`"
+        "Color: `#{color}`, "\
+        "Fill: `#{fill}`"
     end
 
     # Parse Shade

data/lib/ooxml_parser/common_parser/common_data/table/properties/table_position.rb

@@ -9,11 +9,11 @@ module OoxmlParser
     # @return [String] result of convert of object to string
     def to_s
       "Table position left: #{left}, "\
-      "right: #{right}, "\
-      "top: #{top}, "\
-      "bottom #{bottom}, "\
-      "position x: #{position_x}, "\
-      "position y: #{position_y}"
+        "right: #{right}, "\
+        "top: #{top}, "\
+        "bottom #{bottom}, "\
+        "position x: #{position_x}, "\
+        "position y: #{position_y}"
     end
 
     # Parse TablePosition object

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

@@ -26,7 +26,7 @@ module OoxmlParser
     # @return [String] result of conversion
     def to_s
       "first line indent: #{@first_line_indent}, left indent: #{@left_indent}, "\
-      "right indent: #{@right_indent}, hanging indent: #{@hanging_indent}"
+        "right indent: #{@right_indent}, hanging indent: #{@hanging_indent}"
     end
 
     # Parse Indents

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

@@ -84,7 +84,7 @@ module OoxmlParser
 
     # @return [True, false] if structure contain any user data
     def with_data?
-      !nonempty_runs.empty? || paragraph_properties.section_properties
+      !nonempty_runs.empty? || paragraph_properties&.section_properties
     end
 
     # Compare this object to other
@@ -269,11 +269,5 @@ module OoxmlParser
       nil
     end
     deprecate :sdt, 'nonempty_runs[i]', 2020, 1
-
-    # @return [OoxmlParser::FrameProperties] Return frame properties
-    def frame_properties
-      paragraph_properties.frame_properties
-    end
-    deprecate :frame_properties, 'paragraph_properties.frame_properties', 2020, 1
   end
 end

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.12.2'
+    STRING = '0.14.2'
   end
 end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/defined_name.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing <definedName> tag
+  class DefinedName < OOXMLDocumentObject
+    # @return [String] Ranges to which defined name refers
+    attr_reader :range
+    # @return [String] Name
+    attr_reader :name
+    # @return [String] Id of sheet
+    attr_reader :local_sheet_id
+    # @return [Symbol] Specifies whether defined name is hidden
+    attr_reader :hidden
+
+    # Parse Defined Name data
+    # @param [Nokogiri::XML:Element] node with DefinedName data
+    # @return [DefinedName] value of DefinedName
+    def parse(node)
+      @range = node.text
+      node.attributes.each do |key, value|
+        case key
+        when 'name'
+          @name = value.value.to_s
+        when 'localSheetId'
+          @local_sheet_id = value.value.to_i
+        when 'hidden'
+          @hidden = attribute_enabled?(value)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part/extension_list/extension/data_validations/data_validation/data_validation_formula.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for `x14:formula1` or `x14:formula2` data
+  class DataValidationFormula < OOXMLDocumentObject
+    # @return [Formula] value of formula
+    attr_reader :formula
+
+    # Parse DataValidationFormula data
+    # @param [Nokogiri::XML:Element] node with DataValidationFormula data
+    # @return [DataValidationFormula] value of DataValidationFormula data
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'f'
+          @formula = Formula.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part/extension_list/extension/data_validations/data_validation.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative 'data_validation/data_validation_formula'
+module OoxmlParser
+  # Class for `dataValidation` data
+  class DataValidation < OOXMLDocumentObject
+    # @return [Boolean] should blank entries be valid
+    attr_reader :allow_blank
+    # @return [String] Specifies the message text of the error alert
+    attr_reader :error
+    # @return [Symbol] Type of error
+    attr_reader :error_style
+    # @return [String] The text of the title bar of the error alert
+    attr_reader :error_title
+    # @return [DataValidationFormula] first formula of data validation
+    attr_reader :formula1
+    # @return [DataValidationFormula] second formula of data validation
+    attr_reader :formula2
+    # @return [Symbol] Input Method Editor (IME) mode
+    attr_reader :ime_mode
+    # @return [Symbol] Relational operator used with this data validation
+    attr_reader :operator
+    # @return [String] Message text of the input prompt
+    attr_reader :prompt
+    # @return [String] Text of the title bar of the input prompt
+    attr_reader :prompt_title
+    # @return [String] Ranges to which data validation is applied
+    attr_reader :reference_sequence
+    # @return [Symbol] Specifies whether to display the drop-down combo box
+    attr_reader :show_dropdown
+    # @return [Symbol] Specifies whether to display the input prompt
+    attr_reader :show_input_message
+    # @return [Symbol] Specifies whether to display error alert message
+    attr_reader :show_error_message
+    # @return [Symbol] Type of validation
+    attr_reader :type
+    # @return [String] UID of validation
+    attr_reader :uid
+
+    # Parse DataValidation data
+    # @param [Nokogiri::XML:Element] node with DataValidation data
+    # @return [DataValidation] value of DataValidation data
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'allowBlank'
+          @allow_blank = attribute_enabled?(value)
+        when 'error'
+          @error = value.value.to_s
+        when 'errorStyle'
+          @error_style = value.value.to_sym
+        when 'errorTitle'
+          @error_title = value.value.to_s
+        when 'imeMode'
+          @ime_mode = value.value.to_sym
+        when 'operator'
+          @operator = value.value.to_sym
+        when 'type'
+          @type = value.value.to_sym
+        when 'prompt'
+          @prompt = value.value.to_s
+        when 'promptTitle'
+          @prompt_title = value.value.to_s
+        when 'showDropDown'
+          @show_dropdown = attribute_enabled?(value)
+        when 'showInputMessage'
+          @show_input_message = attribute_enabled?(value)
+        when 'showErrorMessage'
+          @show_error_message = attribute_enabled?(value)
+        when 'uid'
+          @uid = value.value.to_s
+        end
+      end
+
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'formula1'
+          @formula1 = DataValidationFormula.new(parent: self).parse(node_child)
+        when 'formula2'
+          @formula2 = DataValidationFormula.new(parent: self).parse(node_child)
+        when 'sqref'
+          @reference_sequence = node_child.text
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part/extension_list/extension/data_validations.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative 'data_validations/data_validation'
+
+module OoxmlParser
+  # Class for `dataValidations` data
+  class DataValidations < OOXMLDocumentObject
+    # @return [Integer] count of validations
+    attr_reader :count
+    # @return [Array<DataValidation>] list of data validations
+    attr_reader :data_validations
+    # @return [Boolean] is prompts disabled
+    attr_reader :disable_prompts
+
+    def initialize(parent: nil)
+      @data_validations = []
+      super
+    end
+
+    # @return [SparklineGroup] accessor
+    def [](key)
+      data_validations[key]
+    end
+
+    # Parse DataValidations data
+    # @param [Nokogiri::XML:Element] node with DataValidations data
+    # @return [DataValidations] value of DataValidations data
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'count'
+          @count = value.value.to_i
+        when 'disablePrompts'
+          @disable_prompts = attribute_enabled?(value)
+        end
+      end
+
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'dataValidation'
+          @data_validations << DataValidation.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part/extension_list/extension.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
+require_relative 'extension/data_validations'
 require_relative 'extension/sparkline_groups'
 require_relative 'extension/x14_table'
 module OoxmlParser
   # Class for `ext` data
   class Extension < OOXMLDocumentObject
+    # @return [DataValidations] list of data validations
+    attr_accessor :data_validations
     # @return [X14Table] table data in x14 namespace
     attr_accessor :table
     # @return [SparklineGroups] list of groups
@@ -16,6 +19,8 @@ module OoxmlParser
     def parse(node)
       node.xpath('*').each do |column_node|
         case column_node.name
+        when 'dataValidations'
+          @data_validations = DataValidations.new(parent: self).parse(column_node)
         when 'table'
           @table = X14Table.new(parent: self).parse(column_node)
         when 'sparklineGroups'

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/xlsx_header_footer/header_footer_child.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing header or footer
+  class HeaderFooterChild < OOXMLDocumentObject
+    # @return [Symbol] type of header
+    attr_reader :type
+    # @return [String] raw text of header
+    attr_reader :raw_string
+
+    def initialize(type: nil, raw_string: nil, parent: nil)
+      @type = type
+      @raw_string = raw_string
+      super(parent: parent)
+    end
+
+    # Parse HeaderFooterChild data
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [HeaderFooterChild] result of parsing
+    def parse(node)
+      @raw_string = node.text
+      self
+    end
+
+    # @return [String] right part of header
+    def right
+      return @right if @right
+
+      right = @raw_string.match(/&R(.+)/)
+      return nil unless right
+
+      @right = right[1]
+    end
+
+    # @return [String] center part of header
+    def center
+      return @center if @center
+
+      center = @raw_string.split('&R').first.match(/&C(.+)/)
+      return nil unless center
+
+      @center = center[1]
+    end
+
+    # @return [String] left part of header
+    def left
+      return @left if @left
+
+      left = @raw_string.gsub("&R#{right}", '')
+      left = left.gsub("&C#{center}", '')
+      return nil if left == ''
+
+      left.gsub('&L', '')
+    end
+  end
+end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/xlsx_header_footer.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative 'xlsx_header_footer/header_footer_child'
+module OoxmlParser
+  # Class for parsing <headerFooter> tag
+  class XlsxHeaderFooter < OOXMLDocumentObject
+    # @return [Symbol] Specifies whether to align header with margins
+    attr_reader :align_with_margins
+    # @return [Symbol] Specifies whether first header is different
+    attr_reader :different_first
+    # @return [Symbol] Specifies whether odd and even headers are different
+    attr_reader :different_odd_even
+    # @return [Symbol] Specifies whether to scale header with document
+    attr_reader :scale_with_document
+    # @return [String] odd header
+    attr_reader :odd_header
+    # @return [String] odd footer
+    attr_reader :odd_footer
+    # @return [String] even header
+    attr_reader :even_header
+    # @return [String] even footer
+    attr_reader :even_footer
+    # @return [String] first header
+    attr_reader :first_header
+    # @return [String] first footer
+    attr_reader :first_footer
+
+    # Parse Header Footer data
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [XlsxHeaderFooter] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'alignWithMargins'
+          @align_with_margins = attribute_enabled?(value)
+        when 'differentFirst'
+          @different_first = attribute_enabled?(value)
+        when 'differentOddEven'
+          @different_odd_even = attribute_enabled?(value)
+        when 'scaleWithDoc'
+          @scale_with_document = attribute_enabled?(value)
+        end
+
+        node.xpath('*').each do |node_child|
+          case node_child.name
+          when 'oddHeader'
+            @odd_header = HeaderFooterChild.new(parent: parent, type: odd_header).parse(node_child)
+          when 'oddFooter'
+            @odd_footer = HeaderFooterChild.new(parent: parent, type: odd_footer).parse(node_child)
+          when 'evenHeader'
+            @even_header = HeaderFooterChild.new(parent: parent, type: even_header).parse(node_child)
+          when 'evenFooter'
+            @even_footer = HeaderFooterChild.new(parent: parent, type: even_footer).parse(node_child)
+          when 'firstHeader'
+            @first_header = HeaderFooterChild.new(parent: parent, type: first_header).parse(node_child)
+          when 'firstFooter'
+            @first_footer = HeaderFooterChild.new(parent: parent, type: first_footer).parse(node_child)
+          end
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet.rb

@@ -10,6 +10,7 @@ require_relative 'worksheet/worksheet_helper'
 require_relative 'worksheet/xlsx_column_properties'
 require_relative 'worksheet/xlsx_drawing'
 require_relative 'worksheet/xlsx_row'
+require_relative 'worksheet/xlsx_header_footer'
 module OoxmlParser
   # Properties of worksheet
   class Worksheet < OOXMLDocumentObject
@@ -28,6 +29,8 @@ module OoxmlParser
     attr_reader :page_setup
     # @return [ExtensionList] list of extensions
     attr_accessor :extension_list
+    # @return [XlsxHeaderFooter] header and footer
+    attr_reader :header_footer
 
     def initialize(parent: nil)
       @columns = []
@@ -124,6 +127,8 @@ module OoxmlParser
           @page_setup = PageSetup.new(parent: self).parse(worksheet_node_child)
         when 'extLst'
           @extension_list = ExtensionList.new(parent: self).parse(worksheet_node_child)
+        when 'headerFooter'
+          @header_footer = XlsxHeaderFooter.new(parent: self).parse(worksheet_node_child)
         end
       end
       parse_comments

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook.rb

@@ -3,6 +3,7 @@
 require_relative 'workbook/chartsheet'
 require_relative 'workbook/pivot_cache'
 require_relative 'workbook/pivot_table_definition'
+require_relative 'workbook/defined_name'
 require_relative 'workbook/shared_string_table'
 require_relative 'workbook/style_sheet'
 require_relative 'workbook/worksheet'
@@ -24,11 +25,14 @@ module OoxmlParser
     attr_accessor :pivot_caches
     # @return [Array<PivotTableDefintion>] list of pivot table defitions
     attr_accessor :pivot_table_definitions
+    # @return [Array<DefinedName>] list of defined names
+    attr_reader :defined_names
 
     def initialize(params = {})
       @worksheets = []
       @pivot_caches = []
       @pivot_table_definitions = []
+      @defined_names = []
       super
     end
 
@@ -125,6 +129,7 @@ module OoxmlParser
       end
       parse_pivot_cache
       parse_pivot_table
+      parse_defined_names
       OOXMLDocumentObject.xmls_stack.pop
       self
     end
@@ -149,5 +154,12 @@ module OoxmlParser
         @pivot_table_definitions << PivotTableDefinition.new(parent: self).parse(file.part_name)
       end
     end
+
+    # Perform parsing of defined names
+    def parse_defined_names
+      @doc.xpath('xmlns:workbook/xmlns:definedNames/xmlns:definedName').each do |defined_name|
+        @defined_names << DefinedName.new(parent: self).parse(defined_name)
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ooxml_parser
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.14.2
 platform: ruby
 authors:
 - ONLYOFFICE
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 2021-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -486,6 +486,7 @@ files:
 - lib/ooxml_parser/version.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/chartsheet.rb
+- lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/defined_name.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/pivot_cache.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/pivot_cache/pivot_cache_definition.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/pivot_cache/pivot_cache_definition/cache_fields.rb
@@ -535,6 +536,9 @@ files:
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part/autofilter/filter_column/custom_filters/custom_filter.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part/extension_list.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part/extension_list/extension.rb
+- lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part/extension_list/extension/data_validations.rb
+- lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part/extension_list/extension/data_validations/data_validation.rb
+- lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part/extension_list/extension/data_validations/data_validation/data_validation_formula.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part/extension_list/extension/sparkline_groups.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part/extension_list/extension/sparkline_groups/sparkline_group.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part/extension_list/extension/x14_table.rb
@@ -545,6 +549,8 @@ files:
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/xlsx_column_properties.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/xlsx_drawing.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/xlsx_drawing/xlsx_drawing_position_parameters.rb
+- lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/xlsx_header_footer.rb
+- lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/xlsx_header_footer/header_footer_child.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/xlsx_row.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/xlsx_row/xlsx_cell.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/xlsx_row/xlsx_cell/formula.rb
@@ -573,7 +579,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.9
+rubygems_version: 3.2.26
 signing_key: 
 specification_version: 4
 summary: OoxmlParser Gem