ooxml_parser 0.6.0 → 0.7.0

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/slide/slide/timing/time_node.rb

@@ -30,6 +30,9 @@ module OoxmlParser
       self
     end
 
+    # Parse list of timing nodes
+    # @param timing_list_node [Nokogiri::XML::Element] node to parse
+    # @return [Array<TimeNode>] list of nodes
     def self.parse_list(timing_list_node)
       timings = []
       timing_list_node.xpath('*').each do |time_node|

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/slide/slide_helper.rb

@@ -3,10 +3,12 @@
 module OoxmlParser
   # Methods to help working with slide data
   module SlideHelper
+    # @return [Array] list of not empty element on slide
     def nonempty_elements
       elements.reject { |cur_shape| cur_shape.text_body.paragraphs.first.characters.empty? }
     end
 
+    # @return [Array<GraphicFrame>] list GraphicFrame elements on slide
     def graphic_frames
       elements.select { |cur_element| cur_element.is_a?(GraphicFrame) }
     end
@@ -17,7 +19,7 @@ module OoxmlParser
     def transform_of_object(object)
       case object
       when :image
-        elements.find { |e| e.is_a? Picture }.properties.transform
+        elements.find { |e| e.is_a? DocxPicture }.properties.transform
       when :chart
         elements.find { |e| e.is_a? GraphicFrame }.transform
       when :table
@@ -29,6 +31,10 @@ module OoxmlParser
       end
     end
 
+    # Get horizontal align of object on slide
+    # @param object [Symbol] object to get
+    # @param slide_size [SlideSize] size of slide
+    # @return [Symbol] type of align
     def content_horizontal_align(object, slide_size)
       transform = transform_of_object(object)
       return :left if transform.offset.x.zero?
@@ -38,6 +44,10 @@ module OoxmlParser
       :unknown
     end
 
+    # Get vertical align of object on slide
+    # @param object [Symbol] object to get
+    # @param slide_size [SlideSize] size of slide
+    # @return [Symbol] type of align
     def content_vertical_align(object, slide_size)
       transform = transform_of_object(object)
       return :top if transform.offset.y.zero?
@@ -47,6 +57,10 @@ module OoxmlParser
       :unknown
     end
 
+    # Get content distribution of object
+    # @param object [Symbol] object to get
+    # @param slide_size [SlideSize] size of slide
+    # @return [Array<Symbol>] type of align
     def content_distribute(object, slide_size)
       return %i[horizontally vertically] if content_horizontal_align(object, slide_size) == :center && content_vertical_align(object, slide_size) == :middle
       return [:horizontally] if content_horizontal_align(object, slide_size) == :center

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/slide/transition/transition.rb

@@ -7,6 +7,9 @@ module OoxmlParser
   class Transition < OOXMLDocumentObject
     attr_accessor :speed, :properties, :sound_action, :advance_on_click, :delay, :duration
 
+    # Parse Transition object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [Transition] result of parsing
     def parse(node)
       node.xpath('*').each do |node_child|
         @properties = TransitionProperties.new(parent: self).parse(node_child)

data/lib/ooxml_parser/pptx_parser/pptx_parser.rb

@@ -5,6 +5,9 @@ require_relative 'pptx_data/presentation.rb'
 module OoxmlParser
   # Basic class for parsing pptx
   class PptxParser
+    # Parse pptx file
+    # @param path_to_file [String] file path
+    # @return [Presentation] result of parse
     def self.parse_pptx(path_to_file)
       Parser.parse_format(path_to_file) do
         Presentation.new.parse

data/lib/ooxml_parser/version.rb

@@ -3,6 +3,7 @@
 module OoxmlParser
   # This module holds the RuboCop version information.
   module Version
-    STRING = '0.6.0'
+    # [String] Version of Gem
+    STRING = '0.7.0'
   end
 end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'workbook/chartsheet'
+require_relative 'workbook/pivot_cache'
 require_relative 'workbook/shared_string_table'
 require_relative 'workbook/style_sheet'
 require_relative 'workbook/worksheet'
@@ -18,12 +19,20 @@ module OoxmlParser
     attr_accessor :style_sheet
     # @return [SharedStringTable] styles of book
     attr_accessor :shared_strings_table
+    # @return [Array<PivotCache>] list of pivot caches
+    attr_accessor :pivot_caches
 
     def initialize(params = {})
       @worksheets = []
+      @pivot_caches = []
       super
     end
 
+    # Return cell by coordinates
+    # @param column [String, Integer] number or numeric digit of column
+    # @param row [Integer] row to find
+    # @param sheet [Integer] number of sheet
+    # @return [XlsxCell] result
     def cell(column, row, sheet = 0)
       column = Coordinates.new(row, column).column_number unless StringHelper.numeric?(column.to_s)
 
@@ -88,6 +97,8 @@ module OoxmlParser
       @shared_strings_table = SharedStringTable.new(parent: self).parse(shared_string_file)
     end
 
+    # Parse content of Workbook
+    # @return [XLSXWorkbook]
     def parse
       @content_types = ContentTypes.new(parent: self).parse
       @relationships = Relationships.new(parent: self).parse_file("#{OOXMLDocumentObject.path_to_folder}xl/_rels/workbook.xml.rels")
@@ -95,10 +106,10 @@ module OoxmlParser
       OOXMLDocumentObject.xmls_stack = []
       OOXMLDocumentObject.root_subfolder = 'xl/'
       OOXMLDocumentObject.add_to_xmls_stack('xl/workbook.xml')
-      doc = Nokogiri::XML.parse(File.open(OOXMLDocumentObject.current_xml))
+      @doc = Nokogiri::XML.parse(File.open(OOXMLDocumentObject.current_xml))
       @theme = PresentationTheme.parse("xl/#{link_to_theme_xml}") if link_to_theme_xml
       @style_sheet = StyleSheet.new(parent: self).parse
-      doc.xpath('xmlns:workbook/xmlns:sheets/xmlns:sheet').each do |sheet|
+      @doc.xpath('xmlns:workbook/xmlns:sheets/xmlns:sheet').each do |sheet|
         file = @relationships.target_by_id(sheet.attribute('id').value)
         if file.start_with?('worksheets')
           @worksheets << Worksheet.new(parent: self).parse(file)
@@ -107,6 +118,7 @@ module OoxmlParser
           @worksheets << Chartsheet.new(parent: self).parse(file)
         end
       end
+      parse_pivot_cache
       OOXMLDocumentObject.xmls_stack.pop
       self
     end
@@ -116,5 +128,12 @@ module OoxmlParser
     def link_to_theme_xml
       relationships.target_by_type('theme').first
     end
+
+    # Perform parsing of pivot cache
+    def parse_pivot_cache
+      @doc.xpath('xmlns:workbook/xmlns:pivotCaches/xmlns:pivotCache').each do |pivot_cache|
+        @pivot_caches << PivotCache.new(parent: self).parse(pivot_cache)
+      end
+    end
   end
 end

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

@@ -11,6 +11,9 @@ module OoxmlParser
       @parent = parent
     end
 
+    # Parse Chartsheet object
+    # @param file [String] file to parse
+    # @return [Chartsheet] result of parsing
     def parse(file)
       OOXMLDocumentObject.add_to_xmls_stack(OOXMLDocumentObject.root_subfolder + file)
       doc = parse_xml(OOXMLDocumentObject.current_xml)

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'pivot_cache/pivot_cache_definition'
+
+module OoxmlParser
+  # Class for parsing <pivotCache> tag
+  class PivotCache < OOXMLDocumentObject
+    # @return [Integer] cacheId of pivot cache
+    attr_reader :cache_id
+    # @return [String] id of pivot cache
+    attr_reader :id
+    # @return [PivotCacheDefinition] parsed pivot cache definition
+    attr_reader :pivot_cache_definition
+
+    # Parse Pivot Cache data
+    # @param [Nokogiri::XML:Element] node with Pivot Cache data
+    # @return [PivotCache] value of PivotCache
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'cacheId'
+          @cache_id = value.value.to_i
+        when 'id'
+          @id = value.value.to_s
+        end
+      end
+      parse_pivot_cache_definition
+      self
+    end
+
+    private
+
+    # @return [PivotCacheDefinition] pivot cache definition for current pivot cache
+    def parse_pivot_cache_definition
+      definition_file = root_object.relationships.target_by_id(id)
+      full_file_path = "#{OOXMLDocumentObject.path_to_folder}/xl/#{definition_file}"
+      @pivot_cache_definition = PivotCacheDefinition.new(parent: root_object)
+                                                    .parse(full_file_path)
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'pivot_cache_definition/cache_source'
+module OoxmlParser
+  # Class for parsing <pivotCacheDefinition> file
+  class PivotCacheDefinition < OOXMLDocumentObject
+    # @return [String] id of pivot cache definition
+    attr_reader :id
+    # @return [CacheSource] source of pivot cache
+    attr_reader :cache_source
+
+    # Parse PivotCacheDefinition file
+    # @param file [String] path to file
+    # @return [PivotCacheDefinition]
+    def parse(file)
+      return nil unless File.exist?(file)
+
+      document = parse_xml(file)
+      node = document.xpath('*').first
+
+      node.attributes.each do |key, value|
+        case key
+        when 'id'
+          @id = value.value.to_s
+        end
+      end
+
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'cacheSource'
+          @cache_source = CacheSource.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_source.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'cache_source/worksheet_source'
+
+module OoxmlParser
+  # Class for parsing <cacheSource> file
+  class CacheSource < OOXMLDocumentObject
+    # @return [String] type
+    attr_reader :type
+    # @return [WorksheetSource] source of worksheet data
+    attr_reader :worksheet_source
+
+    # Parse `<cacheSource>` tag
+    # # @param [Nokogiri::XML:Element] node with CacheSource data
+    # @return [CacheSource]
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'type'
+          @type = value.value.to_s
+        end
+      end
+
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'worksheetSource'
+          @worksheet_source = WorksheetSource.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_source/worksheet_source.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing <worksheetSource> file
+  class WorksheetSource < OOXMLDocumentObject
+    # @return [String] ref of cells
+    attr_reader :ref
+    # @return [String] sheet name
+    attr_reader :sheet
+
+    # Parse `<worksheetSource>` tag
+    # # @param [Nokogiri::XML:Element] node with WorksheetSource data
+    # @return [WorksheetSource]
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'ref'
+          @ref = value.value.to_s
+        when 'sheet'
+          @sheet = value.value.to_s
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -26,6 +26,8 @@ module OoxmlParser
       @parent = parent
     end
 
+    # Parse StyleSheet object
+    # @return [StyleSheet] result of parsing
     def parse
       doc = parse_xml("#{OOXMLDocumentObject.path_to_folder}/#{OOXMLDocumentObject.root_subfolder}/styles.xml")
       doc.root.xpath('*').each do |node_child|

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/style_sheet/cell_xfs/xf.rb

@@ -4,6 +4,7 @@ require_relative 'cell_style/alignment'
 module OoxmlParser
   # Class for parsing `xf` object
   class Xf < OOXMLDocumentObject
+    # [Array<String,nil>] list of predefined format values
     ALL_FORMAT_VALUE = ['General',
                         '0',
                         '0.00',
@@ -119,18 +120,22 @@ module OoxmlParser
       self
     end
 
+    # @return [Font] font of object
     def font
       root_object.style_sheet.fonts[@font_id]
     end
 
+    # @return [XlsxBorder] border of object
     def borders
       root_object.style_sheet.borders.borders_array[@border_id] if @apply_border
     end
 
+    # @return [Fill] fill color of object
     def fill_color
       root_object.style_sheet.fills[@fill_id] if @apply_fill
     end
 
+    # @return [String] numerical format of object
     def numerical_format
       return @numerical_format unless @apply_number_format
 

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/style_sheet/fills/fill.rb

@@ -40,6 +40,8 @@ module OoxmlParser
       self
     end
 
+    # Convert Fill to color
+    # @return [OoxmlColor] result
     def to_color
       pattern_fill.foreground_color
     end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/style_sheet/fonts/font.rb

@@ -13,6 +13,9 @@ module OoxmlParser
       @parent = parent
     end
 
+    # Parse Font object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [Font] result of parsing
     def parse(node)
       @font_style = FontStyle.new
       node.xpath('*').each do |node_child|

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

@@ -42,6 +42,8 @@ module OoxmlParser
       @parent = parent
     end
 
+    # Perform parsing of relationships
+    # @return [nil]
     def parse_relationships
       OOXMLDocumentObject.add_to_xmls_stack("#{OOXMLDocumentObject.root_subfolder}/worksheets/_rels/#{@xml_name}.rels")
       @relationships = Relationships.new(parent: self).parse_file(OOXMLDocumentObject.current_xml) if File.exist?(OOXMLDocumentObject.current_xml)
@@ -67,6 +69,9 @@ module OoxmlParser
       end
     end
 
+    # Parse data of Worksheet
+    # @param path_to_xml_file [String] path to file to parse
+    # @return [Worksheet] parsed worksheet
     def parse(path_to_xml_file)
       @xml_name = File.basename path_to_xml_file
       parse_relationships

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

@@ -16,6 +16,7 @@ module OoxmlParser
       @parent = parent
     end
 
+    # @return [Array<ExcelComment>] list of comments
     def comments
       comment_list.comments
     end
@@ -23,6 +24,9 @@ module OoxmlParser
     extend Gem::Deprecate
     deprecate :comments, 'comment_list.comments', 2020, 1
 
+    # Parse file with ExcelComments
+    # @param file [String] file to parse
+    # @return [ExcelComments] object with data
     def parse(file)
       doc = parse_xml(file)
       node = doc.xpath('*').first

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

@@ -38,6 +38,10 @@ module OoxmlParser
       self
     end
 
+    # Parse list of XlsxColumnProperties
+    # @param columns_width_node [Nokogiri::XML:Element] node to parse
+    # @param parent [OOXMLDocumentObject] parent of result objects
+    # @return [Array<XlsxColumnProperties>] list of XlsxColumnProperties
     def self.parse_list(columns_width_node, parent: nil)
       columns = []
       columns_width_node.xpath('xmlns:col').each do |col_node|

data/lib/ooxml_parser/xlsx_parser/xlsx_parser.rb

@@ -5,6 +5,9 @@ require_relative 'xlsx_data/view_model/workbook'
 module OoxmlParser
   # Basic class for parsing xlsx
   class XlsxParser
+    # Parse xlsx file
+    # @param path_to_file [String] file path
+    # @return [XLSXWorkbook] result of parse
     def self.parse_xlsx(path_to_file)
       Parser.parse_format(path_to_file) do
         XLSXWorkbook.new.parse

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ooxml_parser
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - ONLYOFFICE
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-29 00:00:00.000000000 Z
+date: 2020-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -74,6 +74,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.87.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.87.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.42.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.42.0
 description: Parse OOXML files (docx, xlsx, pptx)
 email:
 - shockwavenn@gmail.com
@@ -365,6 +421,10 @@ 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/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_source.rb
+- lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/pivot_cache/pivot_cache_definition/cache_source/worksheet_source.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/shared_string_table.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/shared_string_table/string_index.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/style_sheet.rb
@@ -429,14 +489,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.0.pre1
 signing_key: 
 specification_version: 4
 summary: OoxmlParser Gem