ooxml_parser 0.8.0 → 0.11.0

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/pivot_cache/pivot_cache_definition/cache_fields/cache_field.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'cache_field/shared_items'
+
+module OoxmlParser
+  # Class for parsing <cacheField> tag
+  class CacheField < OOXMLDocumentObject
+    # @return [String] name of field
+    attr_reader :name
+    # @return [Integer] number format id
+    attr_reader :number_format_id
+    # @return [SharedItems] shared items
+    attr_reader :shared_items
+
+    # Parse `<cacheField>` tag
+    # # @param [Nokogiri::XML:Element] node with WorksheetSource data
+    # @return [CacheField]
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'name'
+          @name = value.value.to_s
+        when 'numFmtId'
+          @number_format_id = value.value.to_i
+        end
+      end
+
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'sharedItems'
+          @shared_items = SharedItems.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/pivot_cache/pivot_cache_definition/cache_fields/cache_field/shared_items.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing <sharedItems> tag
+  class SharedItems < OOXMLDocumentObject
+    # @return [True, False] is contains_semi_mixed_types
+    attr_reader :contains_semi_mixed_types
+    # @return [True, False] is contains_string
+    attr_reader :contains_string
+    # @return [True, False] is contains_number
+    attr_reader :contains_number
+    # @return [True, False] is contains_integer
+    attr_reader :contains_integer
+    # @return [Integer] min value
+    attr_reader :min_value
+    # @return [Integer] max value
+    attr_reader :max_value
+
+    # Parse `<sharedItems>` tag
+    # # @param [Nokogiri::XML:Element] node with WorksheetSource data
+    # @return [sharedItems]
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'containsSemiMixedTypes'
+          @contains_semi_mixed_types = attribute_enabled?(value)
+        when 'containsString'
+          @contains_string = attribute_enabled?(value)
+        when 'containsNumber'
+          @contains_number = attribute_enabled?(value)
+        when 'containsInteger'
+          @contains_integer = attribute_enabled?(value)
+        when 'minValue'
+          @min_value = value.value.to_i
+        when 'maxValue'
+          @max_value = value.value.to_i
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require_relative 'pivot_table_definition/column_row_items'
+require_relative 'pivot_table_definition/location'
+require_relative 'pivot_table_definition/pivot_fields'
+require_relative 'pivot_table_definition/pivot_table_style_info'
+
+module OoxmlParser
+  # Class for parsing <PivotTableDefinition> tag
+  class PivotTableDefinition < OOXMLDocumentObject
+    # @return [String] name of table
+    attr_reader :name
+    # @return [Integer] id of cache
+    attr_reader :cache_id
+    # @return [True, False] should number formats be applied
+    attr_reader :apply_number_formats
+    # @return [True, False] should border formats be applied
+    attr_reader :apply_border_formats
+    # @return [True, False] should font formats be applied
+    attr_reader :apply_font_formats
+    # @return [True, False] should pattern formats be applied
+    attr_reader :apply_pattern_formats
+    # @return [True, False] should alignment formats be applied
+    attr_reader :apply_alignment_formats
+    # @return [True, False] should width height formats be applied
+    attr_reader :apply_width_height_formats
+    # @return [True, False] should auto formatting be used
+    attr_reader :use_auto_formatting
+    # @return [True, False] should item print titles
+    attr_reader :item_print_titles
+    # @return [String] data caption
+    attr_reader :data_caption
+    # @return [Integer] creation version
+    attr_reader :created_version
+    # @return [Integer] indent
+    attr_reader :indent
+    # @return [True, False] outline
+    attr_reader :outline
+    # @return [True, False] outline data
+    attr_reader :outline_data
+    # @return [True, False] is there multiple fields filters
+    attr_reader :multiple_field_filters
+    # @return [Location] location data
+    attr_reader :location
+    # @return [PivotFields] pivot fields
+    attr_reader :pivot_fields
+    # @return [ColumnRowItems] column items
+    attr_reader :column_items
+    # @return [ColumnRowItems] row items
+    attr_reader :row_items
+    # @return [PivotTableStyleInfo] style info
+    attr_reader :style_info
+
+    # Parse PivotTableDefinition object
+    # @param [String] file path
+    # @return [PivotTableDefinition] result of parsing
+    def parse(file)
+      doc = Nokogiri::XML.parse(File.open("#{OOXMLDocumentObject.path_to_folder}/#{file}"))
+      node = doc.xpath('//xmlns:pivotTableDefinition').first
+      node.attributes.each do |key, value|
+        case key
+        when 'name'
+          @name = value.value.to_s
+        when 'cacheId'
+          @cache_id = value.value.to_i
+        when 'applyNumberFormats'
+          @apply_number_formats = attribute_enabled?(value)
+        when 'applyBorderFormats'
+          @apply_border_formats = attribute_enabled?(value)
+        when 'applyFontFormats'
+          @apply_font_formats = attribute_enabled?(value)
+        when 'applyPatternFormats'
+          @apply_pattern_formats = attribute_enabled?(value)
+        when 'applyAlignmentFormats'
+          @apply_alignment_formats = attribute_enabled?(value)
+        when 'applyWidthHeightFormats'
+          @apply_width_height_formats = attribute_enabled?(value)
+        when 'useAutoFormatting'
+          @use_auto_formatting = attribute_enabled?(value)
+        when 'itemPrintTitles'
+          @item_print_titles = attribute_enabled?(value)
+        when 'dataCaption'
+          @data_caption = value.value.to_s
+        when 'createdVersion'
+          @created_version = value.value.to_i
+        when 'indent'
+          @indent = value.value.to_i
+        when 'outline'
+          @outline = attribute_enabled?(value)
+        when 'outlineData'
+          @outline_data = attribute_enabled?(value)
+        when 'multipleFieldFilters'
+          @multiple_field_filters = attribute_enabled?(value)
+        end
+      end
+
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'location'
+          @location = Location.new(parent: self).parse(node_child)
+        when 'pivotFields'
+          @pivot_fields = PivotFields.new(parent: self).parse(node_child)
+        when 'rowItems'
+          @row_items = ColumnRowItems.new(parent: self).parse(node_child)
+        when 'colItems'
+          @column_items = ColumnRowItems.new(parent: self).parse(node_child)
+        when 'pivotTableStyleInfo'
+          @style_info = PivotTableStyleInfo.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'column_row_items/column_row_item'
+
+module OoxmlParser
+  # Class for parsing <rowItems> and <colItems> tag
+  class ColumnRowItems < OOXMLDocumentObject
+    # @return [Integer] count of items
+    attr_reader :count
+    # @return [Array<RowColumnItem>] list of RowColumnItem object
+    attr_reader :items
+
+    def initialize(parent: nil)
+      @items = []
+      super
+    end
+
+    # @return [RowColumnItem] accessor
+    def [](key)
+      @items[key]
+    end
+
+    # Parse `<cacheField>` tag
+    # # @param [Nokogiri::XML:Element] node with WorksheetSource data
+    # @return [CacheField]
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'count'
+          @count = value.value.to_i
+        end
+      end
+
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'i'
+          @items << ColumnRowItem.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/pivot_table_definition/column_row_items/column_row_item.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing <i> tag
+  class ColumnRowItem < OOXMLDocumentObject
+    # @return [Symbol] type of item
+    attr_reader :type
+
+    # Parse `<location>` tag
+    # @param [Nokogiri::XML:Element] node with location data
+    # @return [Location]
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 't'
+          @type = value.value.to_sym
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing <location> tag
+  class Location < OOXMLDocumentObject
+    # @return [String] ref of location
+    attr_reader :ref
+    # @return [True, False] first header row
+    attr_reader :first_header_row
+    # @return [True, False] first data row
+    attr_reader :first_data_row
+    # @return [True, False] first data column
+    attr_reader :first_data_column
+
+    # Parse `<location>` tag
+    # @param [Nokogiri::XML:Element] node with location data
+    # @return [Location]
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'ref'
+          @ref = value.value.to_s
+        when 'firstHeaderRow'
+          @first_header_row = attribute_enabled?(value)
+        when 'firstDataRow'
+          @first_data_row = attribute_enabled?(value)
+        when 'firstDataCol'
+          @first_data_column = attribute_enabled?(value)
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'pivot_fields/pivot_field'
+
+module OoxmlParser
+  # Class for parsing <pivotFields> tag
+  class PivotFields < OOXMLDocumentObject
+    # @return [Integer] count
+    attr_reader :count
+    # @return [Array<PivotField>] list of PivotField object
+    attr_reader :pivot_field
+
+    def initialize(parent: nil)
+      @pivot_field = []
+      super
+    end
+
+    # @return [PivotField] accessor
+    def [](key)
+      @pivot_field[key]
+    end
+
+    # Parse `<pivotFields>` tag
+    # @param [Nokogiri::XML:Element] node with pivotFields data
+    # @return [PivotFields]
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'count'
+          @count = value.value.to_i
+        end
+      end
+
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'pivotField'
+          @pivot_field << PivotField.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/pivot_table_definition/pivot_fields/pivot_field.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'pivot_field/items'
+
+module OoxmlParser
+  # Class for parsing <pivotField> tag
+  class PivotField < OOXMLDocumentObject
+    # @return [String] axis value
+    attr_reader :axis
+    # @return [True, False] should show all
+    attr_reader :show_all
+    # @return [Items] contain item
+    attr_reader :items
+
+    # Parse `<pivotField>` tag
+    # # @param [Nokogiri::XML:Element] node with PivotField data
+    # @return [PivotField]
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'axis'
+          @axis = value.value.to_s
+        when 'showAll'
+          @show_all = attribute_enabled?(value)
+        end
+      end
+
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'items'
+          @items = Items.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/pivot_table_definition/pivot_fields/pivot_field/items.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'items/item'
+
+module OoxmlParser
+  # Class for parsing <items> tag
+  class Items < OOXMLDocumentObject
+    # @return [Integer] count
+    attr_reader :count
+    # @return [Array<Item>] list of items
+    attr_reader :items
+
+    def initialize(parent: nil)
+      @items = []
+      super
+    end
+
+    # @return [Item] accessor
+    def [](key)
+      @items[key]
+    end
+
+    # Parse `<items>` tag
+    # @param [Nokogiri::XML:Element] node with items data
+    # @return [Items]
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'count'
+          @count = value.value.to_i
+        end
+      end
+
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'item'
+          @items << Item.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/pivot_table_definition/pivot_fields/pivot_field/items/item.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing <item> tag
+  class Item < OOXMLDocumentObject
+    # @return [Integer] index of item
+    attr_reader :index
+    # @return [Symbol] type of item
+    attr_reader :type
+
+    # Parse `<item>` tag
+    # # @param [Nokogiri::XML:Element] node with Item data
+    # @return [item]
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'x'
+          @index = value.value.to_i
+        when 't'
+          @type = value.value.to_sym
+        end
+      end
+      self
+    end
+  end
+end