ooxml_parser 0.5.1 → 0.8.0

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragrpah_properties/spacing.rb

@@ -24,28 +24,26 @@ module OoxmlParser
       @line_rule = line_rule
     end
 
+    # Compare this object to other
+    # @param other [Object] any other object
+    # @return [True, False] result of comparision
     def ==(other)
       self.line_rule = :at_least if line_rule == 'atLeast'
       self.line_rule = :multiple if line_rule == :auto
       other.line_rule = :multiple if other.line_rule == :auto
-      if self.class == NilClass || other.class == NilClass
-        return true if self.class == NilClass && other.class == NilClass
+      self.line_rule = line_rule.to_sym if line_rule.instance_of?(String)
 
-        false
+      if @before == other.before &&
+         @after == other.after &&
+         @line == other.line &&
+         @line_rule.to_s == other.line_rule.to_s
+        true
       else
-        self.line_rule = line_rule.to_sym if line_rule.instance_of?(String)
-
-        if @before == other.before &&
-           @after == other.after &&
-           @line == other.line &&
-           @line_rule.to_s == other.line_rule.to_s
-          true
-        else
-          false
-        end
+        false
       end
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       result_string = ''
       variables = instance_variables
@@ -55,10 +53,15 @@ module OoxmlParser
       result_string
     end
 
+    # Method to copy object
+    # @return [Spacing] copied object
     def copy
       Spacing.new(@before, @after, @line, @line_rule)
     end
 
+    # Round value of spacing
+    # @param count_of_digits [Integer] how digits to left
+    # @return [Spacing] result of round
     def round(count_of_digits = 1)
       before = @before.to_f.round(count_of_digits)
       after = @after.to_f.round(count_of_digits)

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

@@ -17,10 +17,12 @@ module OoxmlParser
 
     alias table_properties properties
 
+    # @return [String] result of convert of object to string
     def to_s
       "Rows: #{@rows.join(',')}"
     end
 
+    # @return [String] inspect of object for debug means
     def inspect
       to_s
     end

data/lib/ooxml_parser/common_parser/common_data/table/margins/paragraph_margins.rb

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

data/lib/ooxml_parser/common_parser/common_data/table/margins/table_margins.rb

@@ -15,6 +15,9 @@ module OoxmlParser
     end
 
     # TODO: Separate @is_default attribute and remove this method
+    # Compare this object to other
+    # @param other [Object] any other object
+    # @return [True, False] result of comparision
     def ==(other)
       instance_variables.each do |current_attribute|
         next if current_attribute == :@parent
@@ -24,10 +27,14 @@ module OoxmlParser
       true
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       'Default: ' + is_default.to_s + ' top: ' + @top.to_s + ', bottom: ' + @bottom.to_s + ', left: ' + @left.to_s + ', right: ' + @right.to_s
     end
 
+    # Parse TableMargins object
+    # @param margin_node [Nokogiri::XML:Element] node to parse
+    # @return [TableMargins] result of parsing
     def parse(margin_node)
       margin_node.xpath('*').each do |cell_margin_node|
         case cell_margin_node.name

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

@@ -6,6 +6,7 @@ module OoxmlParser
     attr_accessor :left, :right, :top, :bottom, :position_x, :position_y, :horizontal_anchor, :vertical_anchor, :vertical_align_from_anchor,
                   :horizontal_align_from_anchor
 
+    # @return [String] result of convert of object to string
     def to_s
       "Table position left: #{left}, "\
       "right: #{right}, "\

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

@@ -16,6 +16,7 @@ module OoxmlParser
     attr_reader :table_row_properties
     # @return [ParagraphProperties] properties of paragraph
     attr_accessor :paragraph_properties
+
     alias cell_properties table_cell_properties
 
     def initialize(type: nil, parent: nil)

data/lib/ooxml_parser/common_parser/common_data/table/properties/table_style_properties/table_style_properties_helper.rb

@@ -3,6 +3,7 @@
 module OoxmlParser
   # Helper method for working with TableStyleProperties
   module TableStylePropertiesHelper
+    # [Hash] short names for table styles
     TABLE_STYLES_NAMES_HASH = { first_column: :firstCol,
                                 last_column: :lastCol,
                                 whole_table: :wholeTbl,
@@ -17,12 +18,11 @@ module OoxmlParser
                                 first_row: :firstRow,
                                 last_row: :lastRow }.freeze
 
-    TABLE_STYLES_NAMES_HASH.each_key do |table_style_name|
-      define_method(table_style_name) do
+    TABLE_STYLES_NAMES_HASH.each do |key, value|
+      define_method(key) do
         @table_style_properties_list.each do |table_style|
-          return table_style if table_style.type == TABLE_STYLES_NAMES_HASH[table_style_name]
+          return table_style if table_style.type == value
         end
-        nil
       end
     end
 

data/lib/ooxml_parser/common_parser/common_data/table/row/cell/cell_properties.rb

@@ -4,7 +4,7 @@ require_relative 'grid_span'
 module OoxmlParser
   # Class for parsing 'w:tcPr' element
   class CellProperties < OOXMLDocumentObject
-    attr_accessor :fill, :color, :borders, :text_direction, :anchor, :anchor_center, :horizontal_overflow, :table_cell_width, :borders_properties, :vertical_align
+    attr_accessor :fill, :color, :borders, :text_direction, :anchor, :table_cell_width, :borders_properties, :vertical_align
     # @return [GridSpan] data about grid span
     attr_accessor :grid_span
     # @return [TableMargins] margins
@@ -25,6 +25,9 @@ module OoxmlParser
 
     alias table_cell_borders borders_properties
 
+    # Parse CellProperties object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [CellProperties] result of parsing
     def parse(node)
       @borders_properties = Borders.new
       @margins = ParagraphMargins.new(parent: self).parse(node)
@@ -78,10 +81,6 @@ module OoxmlParser
           @text_direction = value.value.to_sym
         when 'anchor'
           @anchor = value_to_symbol(value)
-        when 'anchorCtr'
-          @anchor_center = value.value
-        when 'horzOverflow'
-          @horizontal_overflow = value.value.to_sym
         end
       end
       self

data/lib/ooxml_parser/common_parser/common_data/table/row/cell/properties/borders.rb

@@ -18,6 +18,8 @@ module OoxmlParser
       @parent = parent
     end
 
+    # Method to copy object
+    # @return [Borders] copied object
     def copy
       new_borders = Borders.new
       new_borders.left = @left if @left
@@ -32,6 +34,9 @@ module OoxmlParser
       new_borders
     end
 
+    # Compare this object to other
+    # @param other [Object] any other object
+    # @return [True, False] result of comparision
     def ==(other)
       @left == other.left && @right == other.right && @top == other.top && @bottom == other.bottom if other.is_a?(Borders)
     end
@@ -52,6 +57,7 @@ module OoxmlParser
       yield(top)
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       "Left border: #{left}, Right: #{right}, Top: #{top}, Bottom: #{bottom}"
     end

data/lib/ooxml_parser/common_parser/common_data/table/table_grid.rb

@@ -12,6 +12,9 @@ module OoxmlParser
       @parent = parent
     end
 
+    # Compare this object to other
+    # @param other [Object] any other object
+    # @return [True, False] result of comparision
     def ==(other)
       @columns.each_with_index do |cur_column, index|
         return false unless cur_column == other.columns[index]

data/lib/ooxml_parser/common_parser/common_data/underline.rb

@@ -11,16 +11,21 @@ module OoxmlParser
       @parent = parent
     end
 
+    # Compare this object to other
+    # @param other [Object] any other object
+    # @return [True, False] result of comparision
     def ==(other)
-      if other.is_a? Underline
+      case other
+      when Underline
         @style.to_sym == other.style.to_sym && @color == other.color
-      elsif other.is_a? Symbol
+      when Symbol
         @style.to_sym == other
       else
         false
       end
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       if @color.nil?
         @style.to_s

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

@@ -18,12 +18,23 @@ module OoxmlParser
   class DocumentStructure < CommonDocumentStructure
     include DocumentStyleHelper
     include DocumentStructureHelpers
-    attr_accessor :elements, :page_properties, :notes, :background, :document_properties, :comments
-
+    # @return [Array<OOXMLDocumentObject>] list of elements
+    attr_accessor :elements
+    # @return [PageProperties] properties of document
+    attr_accessor :page_properties
+    # @return [Note] notes of document
+    attr_accessor :notes
+    # @return [DocumentBackground] background of document
+    attr_accessor :background
+    # @return [DocumentProperties] properties of document
+    attr_accessor :document_properties
+    # @return [Comments] comment of document
+    attr_accessor :comments
     # @return [Numbering] store numbering data
     attr_accessor :numbering
     # @return [Styles] styles of document
     attr_accessor :styles
+    # @return [PresentationTheme] theme of docx
     attr_accessor :theme
     # @return [Relationships] relationships
     attr_accessor :relationships
@@ -44,6 +55,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 +67,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 +113,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 +123,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 +135,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 +155,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 +214,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 +229,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 +251,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
@@ -249,10 +284,7 @@ module OoxmlParser
     end
 
     class << self
-      attr_accessor :default_table_run_style
-      attr_accessor :default_table_paragraph_style
-      attr_accessor :default_paragraph_style
-      attr_accessor :default_run_style
+      attr_accessor :default_table_run_style, :default_table_paragraph_style, :default_paragraph_style, :default_run_style
     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

@@ -35,6 +35,7 @@ module OoxmlParser
     # Used to determine if current style is visible in style list in editors
     # According to http://www.wordarticles.com/Articles/WordStyles/LatentStyles.php
     attr_accessor :q_format
+
     alias visible? q_format
 
     def initialize(parent: nil)
@@ -43,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,16 +68,13 @@ 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)
+        case cur_run
+        when DocxParagraphRun, ParagraphRun
           !cur_run.empty?
-        elsif cur_run.is_a?(DocxFormula) ||
-              cur_run.is_a?(StructuredDocumentTag) ||
-              cur_run.is_a?(BookmarkStart) ||
-              cur_run.is_a?(BookmarkEnd) ||
-              cur_run.is_a?(CommentRangeStart) ||
-              cur_run.is_a?(CommentRangeEnd)
+        when DocxFormula, StructuredDocumentTag, BookmarkStart, BookmarkEnd, CommentRangeStart, CommentRangeEnd
           true
         end
       end
@@ -87,6 +87,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 +100,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 +183,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 +242,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 +256,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