ooxml_parser 0.7.1 → 0.9.1

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
@@ -206,7 +217,7 @@ module OoxmlParser
     # Parse default style
     # @return [void]
     def parse_default_style
-      doc = parse_xml(OOXMLDocumentObject.path_to_folder + 'word/styles.xml')
+      doc = parse_xml("#{OOXMLDocumentObject.path_to_folder}word/styles.xml")
       doc.search('//w:style').each do |style|
         next if style.attribute('default').nil?
 
@@ -273,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.rb

@@ -9,8 +9,8 @@ module OoxmlParser
 
     def initialize(params = {})
       @comments_array = []
-      @parent = params[:parent]
-      @file = params.fetch(:file, OOXMLDocumentObject.path_to_folder + 'word/comments.xml')
+      @file = params.fetch(:file, "#{OOXMLDocumentObject.path_to_folder}word/comments.xml")
+      super(parent: params[:parent])
     end
 
     # @return [Comment] accessor

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

@@ -11,7 +11,7 @@ module OoxmlParser
     def initialize(id = nil, paragraphs = [], parent: nil)
       @id = id
       @paragraphs = paragraphs
-      @parent = parent
+      super(parent: parent)
     end
 
     # Parse Comment object

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

@@ -6,7 +6,7 @@ module OoxmlParser
   class CommentsExtended < OOXMLDocumentObject
     def initialize(parent: nil)
       @comments_extended_array = []
-      @parent = parent
+      super
     end
 
     # @return [Array, CommentsExtended] accessor
@@ -17,7 +17,7 @@ module OoxmlParser
     # Parse CommentsExtended object
     # @return [CommentsExtended] result of parsing
     def parse
-      file_to_parse = OOXMLDocumentObject.path_to_folder + 'word/commentsExtended.xml'
+      file_to_parse = "#{OOXMLDocumentObject.path_to_folder}word/commentsExtended.xml"
       return nil unless File.exist?(file_to_parse)
 
       doc = parse_xml(file_to_parse)

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

@@ -12,7 +12,7 @@ module OoxmlParser
     def initialize(parent: nil)
       @color1 = nil
       @type = 'simple'
-      @parent = parent
+      super
     end
 
     # Parse DocumentBackground object

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

@@ -9,7 +9,7 @@ module OoxmlParser
     # Parse Settings object
     # @return [DocumentSettings] result of parsing
     def parse
-      settings_path = OOXMLDocumentObject.path_to_folder + 'word/settings.xml'
+      settings_path = "#{OOXMLDocumentObject.path_to_folder}word/settings.xml"
       return nil unless File.exist?(settings_path)
 
       doc = parse_xml(settings_path)

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

@@ -41,7 +41,7 @@ module OoxmlParser
     def initialize(parent: nil)
       @q_format = false
       @table_style_properties_list = []
-      @parent = parent
+      super
     end
 
     # @return [String] result of convert of object to string

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

@@ -52,7 +52,7 @@ module OoxmlParser
       @page_numbering = false
       @keep_next = false
       @orphan_control = true
-      @parent = parent
+      super
     end
 
     alias elements character_style_array
@@ -71,14 +71,10 @@ module OoxmlParser
     # @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
@@ -251,7 +247,7 @@ module OoxmlParser
     # @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 = parse_xml("#{OOXMLDocumentObject.path_to_folder}word/styles.xml")
       doc.search('//w:style').each do |style|
         next unless style.attribute('styleId').value == id
 

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

@@ -24,7 +24,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @formula_run = []
-      @parent = parent
+      super
     end
 
     # Parse DocxFormula object

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

@@ -7,7 +7,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @position = :bottom
-      @parent = parent
+      super
     end
 
     # Parse Bar object

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

@@ -7,7 +7,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @borders = false
-      @parent = parent
+      super
     end
 
     # Parse Box object

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

@@ -8,7 +8,7 @@ module OoxmlParser
     def initialize(parent: nil)
       @begin_character = '('
       @end_character = ')'
-      @parent = parent
+      super
     end
 
     # Parse Delimiter object

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

@@ -7,7 +7,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @type = :upper
-      @parent = parent
+      super
     end
 
     # Parse Limit object

data/lib/ooxml_parser/docx_parser/docx_data/document_structure/docx_paragraph/docx_formula/math_run/math_run_properties.rb

@@ -8,7 +8,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @break = false
-      @parent = parent
+      super
     end
 
     # Parse MathRunProperties

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

@@ -8,7 +8,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @rows = []
-      @parent = parent
+      super
     end
 
     # Parse Matrix object

data/lib/ooxml_parser/docx_parser/docx_data/document_structure/docx_paragraph/docx_formula/matrix/matrix_row.rb

@@ -7,7 +7,7 @@ module OoxmlParser
 
     def initialize(columns_count = 1, parent: nil)
       @columns = Array.new(columns_count)
-      @parent = parent
+      super(parent: parent)
     end
   end
 end

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

@@ -7,7 +7,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @degree = 2
-      @parent = parent
+      super
     end
 
     # Parse Radical object

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

@@ -38,7 +38,7 @@ module OoxmlParser
       @break = false
       @comments = []
       @page_number = false
-      @parent = parent
+      super
     end
 
     # Constructor for copy of object

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

@@ -51,33 +51,14 @@ module OoxmlParser
         when 'smallCaps'
           self.caps = :small_caps if option_enabled?(node_child)
         when 'color'
-          node_child.attributes.each do |key, value|
-            case key
-            when 'val'
-              self.font_color = Color.new(parent: self).parse_hex_string(value.value)
-            when 'themeColor'
-              if root_object.theme && root_object.theme.color_scheme[value.value.to_sym]
-                break if value.value == 'text2' || value.value == 'background2' || value.value.include?('accent') # Don't know why. Just works
-
-                self.font_color = root_object.theme.color_scheme[value.value.to_sym].color.dup
-              end
-            when 'themeShade'
-              font_color.calculate_with_shade!(value.value.hex.to_f / 255.0)
-            when 'themeTint'
-              font_color.calculate_with_tint!(1.0 - (value.value.hex.to_f / 255.0))
-            end
-          end
+          parse_color_tag(node_child)
         when 'shd'
           self.background_color = node_child.attribute('fill').value
           unless node_child.attribute('fill').value == 'auto' || node_child.attribute('fill').value == '' || node_child.attribute('fill').value == 'null'
             self.background_color = Color.new(parent: self).parse_hex_string(node_child.attribute('fill').value)
           end
         when 'u', 'uCs'
-          font_style.underlined = Underline.new
-          if option_enabled?(node_child)
-            font_style.underlined.style = node_child.attribute('val').value
-            font_style.underlined.color = Color.new(parent: font_style.underlined).parse_hex_string(node_child.attribute('color').value) unless node_child.attribute('color').nil?
-          end
+          parse_underline(node_child)
         when 'strike'
           font_style.strike = :single if option_enabled?(node_child)
         when 'dstrike'
@@ -86,5 +67,41 @@ module OoxmlParser
       end
       self
     end
+
+    private
+
+    # Parse `color` tag
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [nil]
+    def parse_color_tag(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'val'
+          self.font_color = Color.new(parent: self).parse_hex_string(value.value)
+        when 'themeColor'
+          if root_object.theme && root_object.theme.color_scheme[value.value.to_sym]
+            break if value.value == 'text2' || value.value == 'background2' || value.value.include?('accent') # Don't know why. Just works
+
+            self.font_color = root_object.theme.color_scheme[value.value.to_sym].color.dup
+          end
+        when 'themeShade'
+          font_color.calculate_with_shade!(value.value.hex.to_f / 255.0)
+        when 'themeTint'
+          font_color.calculate_with_tint!(1.0 - (value.value.hex.to_f / 255.0))
+        end
+      end
+    end
+
+    # Parse `u` or `uCs` tag
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [nil]
+    def parse_underline(node)
+      font_style.underlined = Underline.new
+
+      return unless option_enabled?(node)
+
+      font_style.underlined.style = node.attribute('val').value
+      font_style.underlined.color = Color.new(parent: font_style.underlined).parse_hex_string(node.attribute('color').value) unless node.attribute('color').nil?
+    end
   end
 end

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

@@ -13,7 +13,7 @@ module OoxmlParser
       @type = type
       @properties = properties
       @elements = elements
-      @parent = parent
+      super(parent: parent)
     end
 
     # Parse Shape object

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

@@ -9,7 +9,7 @@ module OoxmlParser
     def initialize(parent: nil)
       @width = OoxmlSize.new(0)
       @color_scheme = :none
-      @parent = parent
+      super
     end
 
     # Parse TextOutline object

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

@@ -10,7 +10,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @runs = []
-      @parent = parent
+      super
     end
 
     # Parse FieldSimple object

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

@@ -14,7 +14,7 @@ module OoxmlParser
       @left_indent = left_indent
       @right_indent = right_indent
       @hanging_indent = hanging_indent
-      @parent = parent
+      super(parent: parent)
     end
 
     alias first_line first_line_indent
@@ -25,8 +25,8 @@ module OoxmlParser
     # 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/docx_paragraph/sdt/sdt_content.rb

@@ -8,7 +8,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @elements = []
-      @parent = parent
+      super
     end
 
     # Parse SDTContent object

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

@@ -5,14 +5,11 @@ module OoxmlParser
   class StyleParametres < OOXMLDocumentObject
     attr_accessor :q_format, :hidden, :name
 
-    def initialize(name = nil,
-                   q_format = false,
-                   hidden = false,
-                   parent: nil)
-      @name = name
-      @q_format = q_format
-      @hidden = hidden
-      @parent = parent
+    def initialize(params = {})
+      @name = params[:name]
+      @q_format = params.fetch(:q_format, false)
+      @hidden = params.fetch(:hidden, false)
+      super(parent: params[:parent])
     end
 
     # Parse StyleParametres data

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

@@ -3,13 +3,19 @@
 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
       @elements = []
-      @parent = parent
+      super(parent: parent)
     end
 
     # @return [String] string for search of xpath

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

@@ -14,7 +14,7 @@ module OoxmlParser
     def initialize(parent: nil)
       @abstract_numbering_list = []
       @numbering_definition_list = []
-      @parent = parent
+      super
     end
 
     # Get properties by number id
@@ -38,7 +38,7 @@ module OoxmlParser
     # Parse Numbering data
     # @return [Numbering] result of parse
     def parse
-      numbering_xml = OOXMLDocumentObject.path_to_folder + 'word/numbering.xml'
+      numbering_xml = "#{OOXMLDocumentObject.path_to_folder}word/numbering.xml"
       return nil unless File.exist?(numbering_xml)
 
       node = parse_xml(File.open(numbering_xml))