ooxml_parser 0.6.0 → 0.7.0

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

@@ -44,6 +44,9 @@ module OoxmlParser
 
     alias theme_colors theme
 
+    # Compare this object to other
+    # @param other [Object] any other object
+    # @return [True, False] result of comparision
     def ==(other)
       @elements == other.elements &&
         @page_properties == other.page_properties &&
@@ -53,6 +56,10 @@ module OoxmlParser
         @comments == other.comments
     end
 
+    # Get element by it's type
+    # @param location [Symbol] location of object
+    # @param type [Symbol] type of object
+    # @return [OOXMLDocumentObject]
     def element_by_description(location: :canvas, type: :docx_paragraph)
       case location
       when :canvas
@@ -95,6 +102,9 @@ module OoxmlParser
       end
     end
 
+    # Get note by it's description
+    # @param type [Symbol] note type
+    # @return [Note]
     def note_by_description(type)
       notes.each do |note|
         return note if note.type.to_sym == type
@@ -102,6 +112,11 @@ module OoxmlParser
       raise 'There isn\'t this type of the note'
     end
 
+    # Detect numbering type
+    # @param location [Symbol] location of object
+    # @param type [Symbol] type of object
+    # @param paragraph_number [Integer] number of object
+    # @return [Array<String,String>] type of numbering
     def recognize_numbering(location: :canvas, type: :simple, paragraph_number: 0)
       elements = element_by_description(location: location, type: type)
       lvl_text = elements[paragraph_number].numbering.abstruct_numbering.level_list[0].text.value
@@ -109,6 +124,11 @@ module OoxmlParser
       [num_format, lvl_text]
     end
 
+    # Return outline type
+    # @param location [Symbol] location of object
+    # @param type [Symbol] type of object
+    # @param levels_count [Integer] count of levels to detect
+    # @return [Array<String,String>] type of outline
     def outline(location: :canvas, type: :simple, levels_count: 1)
       elements = element_by_description(location: location, type: type)
       set = []
@@ -124,6 +144,8 @@ module OoxmlParser
       styles.styles
     end
 
+    # Parse docx file
+    # @return [DocumentStructure] parsed structure
     def self.parse
       doc_structure = DocumentStructure.new
       doc_structure.content_types = ContentTypes.new(parent: doc_structure).parse
@@ -181,6 +203,8 @@ module OoxmlParser
       doc_structure
     end
 
+    # Parse default style
+    # @return [void]
     def parse_default_style
       doc = parse_xml(OOXMLDocumentObject.path_to_folder + 'word/styles.xml')
       doc.search('//w:style').each do |style|
@@ -194,14 +218,14 @@ module OoxmlParser
             DocumentStructure.default_paragraph_style = DocxParagraph.new.parse_paragraph_style(paragraph_pr_tag, DocumentStructure.default_run_style)
           end
           style.xpath('w:rPr').each do |character_pr_tag|
-            DocumentStructure.default_run_style.parse_properties(character_pr_tag, DocumentStructure.default_run_style)
+            DocumentStructure.default_run_style.parse_properties(character_pr_tag)
           end
         elsif (style.attribute('default').value == '1' ||
                style.attribute('default').value == 'on' ||
                style.attribute('default').value == 'true') &&
               style.attribute('type').value == 'character'
           style.xpath('w:rPr').each do |character_pr_tag|
-            DocumentStructure.default_run_style.parse_properties(character_pr_tag, DocumentStructure.default_run_style)
+            DocumentStructure.default_run_style.parse_properties(character_pr_tag)
           end
         end
       end
@@ -216,7 +240,7 @@ module OoxmlParser
                     style.attribute('type').value == 'table'
 
         style.xpath('w:rPr').each do |table_character_pr_tag|
-          DocumentStructure.default_table_run_style.parse_properties(table_character_pr_tag, DocumentStructure.default_run_style)
+          DocumentStructure.default_table_run_style.parse_properties(table_character_pr_tag)
         end
       end
     end

data/lib/ooxml_parser/docx_parser/docx_data/document_structure/comments/comment.rb

@@ -14,6 +14,9 @@ module OoxmlParser
       @parent = parent
     end
 
+    # Parse Comment object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [Comment] result of parsing
     def parse(node)
       node.attributes.each do |key, value|
         case key

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

@@ -44,10 +44,12 @@ module OoxmlParser
       @parent = parent
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       "Table style properties list: #{@table_style_properties_list.join(',')}"
     end
 
+    # @return [String] inspect of object for debug means
     def inspect
       to_s
     end

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

@@ -57,6 +57,9 @@ module OoxmlParser
 
     alias elements character_style_array
 
+    # Constructor for copy of object
+    # @param source [DocxParagraph] original object
+    # @return [void]
     def initialize_copy(source)
       super
       @bookmark_start = source.bookmark_start.clone
@@ -65,6 +68,7 @@ module OoxmlParser
       @spacing = source.spacing.clone
     end
 
+    # @return [Array<OOXMLDocumentObject>] array of child objects that contains data
     def nonempty_runs
       @character_style_array.select do |cur_run|
         if cur_run.is_a?(DocxParagraphRun) || cur_run.is_a?(ParagraphRun)
@@ -87,6 +91,9 @@ module OoxmlParser
       !nonempty_runs.empty? || paragraph_properties.section_properties
     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
@@ -97,6 +104,12 @@ module OoxmlParser
       true
     end
 
+    # Parse object
+    # @param node [Nokogiri::XML:Node] node with DocxParagraph
+    # @param par_number [Integer] number of paragraph
+    # @param default_character [DocxParagraphRun] style for paragraph
+    # @param parent [OOXMLDocumentObject] parent of run
+    # @return [DocxParagraph] result of parse
     def parse(node, par_number = 0, default_character = DocxParagraphRun.new, parent: nil)
       @parent ||= parent
       default_character_style = default_character.dup
@@ -174,6 +187,10 @@ module OoxmlParser
       self
     end
 
+    # Parse style
+    # @param node [Nokogiri::XML:Node] node with style
+    # @param default_char_style [DocxParagraphRun] style for paragraph
+    # @return [DocxParagraph] result of parse
     def parse_paragraph_style(node, default_char_style = DocxParagraphRun.new(parent: self))
       node.xpath('*').each do |node_child|
         case node_child.name
@@ -229,6 +246,10 @@ module OoxmlParser
       self
     end
 
+    # Parse style xml
+    # @param id [String] id of style to parse
+    # @param character_style [DocxParagraphRun] style to parse
+    # @return [void]
     def parse_paragraph_style_xml(id, character_style)
       doc = parse_xml(OOXMLDocumentObject.path_to_folder + 'word/styles.xml')
       doc.search('//w:style').each do |style|
@@ -239,7 +260,7 @@ module OoxmlParser
           @style = StyleParametres.new(parent: self).parse(style)
         end
         style.xpath('w:rPr').each do |r_pr|
-          character_style.parse_properties(r_pr, DocumentStructure.default_run_style)
+          character_style.parse_properties(r_pr)
         end
         break
       end

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,6 +22,8 @@ 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}"

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

@@ -32,8 +32,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/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]

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

@@ -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