ooxml_parser 0.5.1 → 0.8.0

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

@@ -6,7 +6,7 @@ module OoxmlParser
     # @return [Integer] id of bookmark
     attr_reader :id
 
-    # Parse BookmarkStart object
+    # Parse BookmarkEnd object
     # @param node [Nokogiri::XML:Element] node to parse
     # @return [BookmarkEnd] result of parsing
     def parse(node)

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

@@ -19,6 +19,7 @@ module OoxmlParser
       self
     end
 
+    # @return [Comment] object of current comment range
     def comment
       root_object.comments.comments_array.detect { |comment| comment.id == id }
     end

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

@@ -12,6 +12,9 @@ module OoxmlParser
     # @return [DocxFormula] base
     attr_accessor :base
 
+    # Parse PreSubSuperscript
+    # @param [Nokogiri::XML:Node] node with PreSubSuperscript
+    # @return [PreSubSuperscript] result of parsing
     def parse(node)
       node.xpath('*').each do |node_child|
         case node_child.name

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

@@ -41,12 +41,16 @@ module OoxmlParser
       @parent = parent
     end
 
+    # Constructor for copy of object
+    # @param source [DocxParagraphRun] original object
+    # @return [void]
     def initialize_copy(source)
       super
       @drawings = source.drawings.clone
       @comments = source.comments.clone
     end
 
+    # @return [Array, nil] Drawings of Run
     def drawing
       # TODO: Rewrite all tests without this methos
       @drawings.empty? ? nil : drawings.first
@@ -64,6 +68,9 @@ module OoxmlParser
         !@break
     end
 
+    # Compare this object to other
+    # @param other [Object] any other object
+    # @return [True, False] result of comparision
     def ==(other)
       ignored_attributes = %i[@number @parent]
       all_instance_variables = instance_variables
@@ -74,12 +81,17 @@ module OoxmlParser
       true
     end
 
+    # Parse object
+    # @param r_tag [Nokogiri::XML:Node] node with DocxParagraphRun
+    # @param char_number [Integer] number of run
+    # @param parent [OOXMLDocumentObject] parent of run
+    # @return [void]
     def parse(r_tag, char_number, parent: nil)
       @parent = parent
       r_tag.xpath('*').each do |node_child|
         case node_child.name
         when 'rPr'
-          parse_properties(node_child, DocumentStructure.default_run_style)
+          parse_properties(node_child)
           @run_properties = RunProperties.new(parent: self).parse(node_child)
         when 'instrText'
           if node_child.text.include?('HYPERLINK')
@@ -121,8 +133,6 @@ module OoxmlParser
               @shape = Shape.new(parent: self).parse(pict_node_child, :shape)
             when 'rect'
               @shape = Shape.new(parent: self).parse(pict_node_child, :rectangle)
-            when 'oval'
-              @shape = Shape.new(parent: self).parse(pict_node_child, :oval)
             end
           end
         when 'object'

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

@@ -3,7 +3,10 @@
 module OoxmlParser
   # Module for some helpers for ParagraphRun
   module DocxParagraphRunHelpers
-    def parse_properties(node, _default_character = DocumentStructure.default_run_style)
+    # Parse other properties
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [DocxParagraphRun] result of parse
+    def parse_properties(node)
       self.font_style = FontStyle.new
       node.xpath('*').each do |node_child|
         case node_child.name

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

@@ -53,8 +53,6 @@ module OoxmlParser
           @properties.margins.top = property.split(':').last
         elsif property.include?('margin-left')
           @properties.margins.left = property.split(':').last
-        elsif property.include?('margin-right')
-          @properties.margins.right = property.split(':').last
         elsif property.include?('width')
           @properties.size.width = property.split(':').last
         elsif property.include?('height')

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

@@ -7,6 +7,9 @@ module OoxmlParser
                   :horizontal_align, :vertical_align, :anchor_lock, :vertical_space, :horizontal_space,
                   :horizontal_position, :vertical_position
 
+    # Parse FrameProperties
+    # @param node [Nokogiri::XML:Element] with FrameProperties
+    # @return [FrameProperties] parsed result
     def parse(node)
       node.attributes.each do |key, value|
         case key

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

@@ -22,9 +22,11 @@ module OoxmlParser
     alias right right_indent
     alias hanging hanging_indent
 
+    # Convert to string
+    # @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}"
+      "first line indent: #{@first_line_indent}, left indent: #{@left_indent}, "\
+      "right indent: #{@right_indent}, hanging indent: #{@hanging_indent}"
     end
 
     # Parse Indents

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

@@ -3,8 +3,14 @@
 module OoxmlParser
   # Class Header Footer classes
   class HeaderFooter < OOXMLDocumentObject
-    attr_accessor :id, :elements, :type
-    attr_accessor :path_suffix
+    # @return [Integer] id of header-footer
+    attr_reader :id
+    # @return [Array<OOXMLDocumentObject>] list of elements if object
+    attr_reader :elements
+    # @return [Symbol] `:header` or `:footer`
+    attr_reader :type
+    # @return [String] suffix for object files
+    attr_reader :path_suffix
 
     def initialize(type = :header, parent: nil)
       @type = type
@@ -32,8 +38,6 @@ module OoxmlParser
       when 'endnoteReference'
         @path_suffix = 'endnote'
         @type = :footer
-      else
-        warn "Unknown HeaderFooter type: #{node.name}"
       end
     end
 

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

@@ -17,6 +17,9 @@ module OoxmlParser
       @parent = parent
     end
 
+    # Get properties by number id
+    # @param num_id [Integer] index of number id
+    # @return [nil, AbstractNumbering] result of search
     def properties_by_num_id(num_id)
       abstract_num_id = nil
       @numbering_definition_list.each do |num_def|
@@ -32,6 +35,8 @@ module OoxmlParser
       end
     end
 
+    # Parse Numbering data
+    # @return [Numbering] result of parse
     def parse
       numbering_xml = OOXMLDocumentObject.path_to_folder + 'word/numbering.xml'
       return nil unless File.exist?(numbering_xml)

data/lib/ooxml_parser/docx_parser/docx_data/document_structure/page_properties/columns.rb

@@ -4,9 +4,12 @@ require_relative 'columns/column'
 module OoxmlParser
   # Class for data of Columns
   class Columns < OOXMLDocumentObject
+    # @return [Integer] count of columns
     attr_accessor :count
+    # @return [True, False] is columns are equal width
     attr_accessor :equal_width
     alias equal_width? equal_width
+    # @return [Array<Column>] list of colujmns
     attr_accessor :column_array
     # @return [Boolean] Draw Line Between Columns
     attr_reader :separator

data/lib/ooxml_parser/docx_parser/docx_data/document_structure/page_properties/note.rb

@@ -9,6 +9,9 @@ module OoxmlParser
       @elements = []
     end
 
+    # Parse note data
+    # @param params [Hash] data to parse
+    # @return [Note] result of parsing
     def self.parse(params)
       note = Note.new
       note.type = params[:type]
@@ -23,10 +26,11 @@ module OoxmlParser
       doc.search(xpath_note).each do |ftr|
         number = 0
         ftr.xpath('*').each do |sub_element|
-          if sub_element.name == 'p'
+          case sub_element.name
+          when 'p'
             note.elements << params[:default_paragraph].dup.parse(sub_element, number, params[:default_character], parent: note)
             number += 1
-          elsif sub_element.name == 'tbl'
+          when 'tbl'
             note.elements << Table.new(parent: note).parse(sub_element, number)
             number += 1
           end

data/lib/ooxml_parser/docx_parser/docx_data/document_structure/page_properties/page_size.rb

@@ -11,6 +11,7 @@ module OoxmlParser
       @orientation = orientation
     end
 
+    # @return [String] convert to string
     def to_s
       'Height: ' + @height.to_s + ' Width: ' + @width.to_s + ' Orientation: ' + @orientation.to_s
     end

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

@@ -14,6 +14,8 @@ module OoxmlParser
       @parent = parent
     end
 
+    # Parse styles data
+    # @return [Styles] result of parsing
     def parse
       doc = parse_xml(OOXMLDocumentObject.path_to_folder + 'word/styles.xml')
       doc.xpath('w:styles/*').each do |node_child|

data/lib/ooxml_parser/docx_parser/docx_parser.rb

@@ -7,6 +7,9 @@ require_relative 'docx_data/document_structure'
 module OoxmlParser
   # Basic class for DocxParser
   class DocxParser
+    # Parse docx file
+    # @param path_to_file [String] file path
+    # @return [DocumentStructure] result of parse
     def self.parse_docx(path_to_file)
       Parser.parse_format(path_to_file) do
         DocumentStructure.parse

data/lib/ooxml_parser/name.rb

@@ -3,6 +3,7 @@
 module OoxmlParser
   # This module holds name of product
   module Name
+    # [String] name of the gem
     STRING = 'ooxml_parser'
   end
 end

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

@@ -27,6 +27,8 @@ module OoxmlParser
       super
     end
 
+    # Parse data of presentation
+    # @return [Presentation] parsed presentation
     def parse
       @content_types = ContentTypes.new(parent: self).parse
       OOXMLDocumentObject.root_subfolder = 'ppt/'

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/presentation_theme.rb

@@ -14,6 +14,9 @@ module OoxmlParser
       @color_scheme = color_scheme
     end
 
+    # Parse PresentationTheme
+    # @param file [String] path to file to parse
+    # @return [PresentationTheme] result of parsing
     def self.parse(file)
       OOXMLDocumentObject.theme = PresentationTheme.new
       OOXMLDocumentObject.add_to_xmls_stack(file)

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/presentation_theme/theme_color.rb

@@ -11,6 +11,9 @@ module OoxmlParser
       @parent = parent
     end
 
+    # Compare ThemeColor with other object
+    # @param other [Object] object to compare
+    # @return [True, False] result of comparision
     def ==(other)
       if other.is_a?(Color)
         @color == other

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

@@ -3,8 +3,8 @@
 require_relative 'slide/presentation_alternate_content'
 require_relative 'slide/background'
 require_relative 'slide/common_slide_data'
-require_relative 'slide/connection_shape.rb'
-require_relative 'slide/presentation_notes.rb'
+require_relative 'slide/connection_shape'
+require_relative 'slide/presentation_notes'
 require_relative 'slide/graphic_frame/graphic_frame'
 require_relative 'slide/slide/shapes_grouping'
 require_relative 'slide/slide/timing'
@@ -28,6 +28,7 @@ module OoxmlParser
       @xml_path = xml_path
     end
 
+    # @return [True, False] is slide with data
     def with_data?
       return true unless background.nil?
 
@@ -37,10 +38,12 @@ module OoxmlParser
       false
     end
 
+    # @return <Array> List of elements on slide
     def elements
       @common_slide_data.shape_tree.elements
     end
 
+    # @return [Background] background of slide
     def background
       @common_slide_data.background
     end

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

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
-require_relative 'pptx_data/presentation.rb'
+require_relative 'pptx_data/presentation'
 
 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.5.1'
+    # [String] Version of Gem
+    STRING = '0.8.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