ooxml_parser 0.4.0 → 0.7.0

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing `w:bookmarkEnd` tags
+  class BookmarkEnd < OOXMLDocumentObject
+    # @return [Integer] id of bookmark
+    attr_reader :id
+
+    # Parse BookmarkEnd object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [BookmarkEnd] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'id'
+          @id = value.value.to_i
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing `w:bookmarkStart` tags
+  class BookmarkStart < OOXMLDocumentObject
+    # @return [Integer] id of bookmark
+    attr_reader :id
+    # @return [String] name of bookmark
+    attr_reader :name
+
+    # Parse BookmarkStart object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [BookmarkStart] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'id'
+          @id = value.value.to_i
+        when 'name'
+          @name = value.value
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing `w:commentRangeEnd` tags
+  class CommentRangeEnd < OOXMLDocumentObject
+    # @return [Integer] id of bookmark
+    attr_reader :id
+
+    # Parse CommentRangeEnd object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [CommentRangeEnd] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'id'
+          @id = value.value.to_i
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing `w:CommentRangeStart` tags
+  class CommentRangeStart < OOXMLDocumentObject
+    # @return [Integer] id of bookmark
+    attr_reader :id
+
+    # Parse CommentRangeStart object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [CommentRangeStart] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'id'
+          @id = value.value.to_i
+        end
+      end
+      self
+    end
+
+    # @return [Comment] object of current comment range
+    def comment
+      root_object.comments.comments_array.detect { |comment| comment.id == id }
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'docx_formula/accent'
 require_relative 'docx_formula/argument_properties'
 require_relative 'docx_formula/bar'
@@ -66,6 +68,7 @@ module OoxmlParser
         end
       end
       return nil if @formula_run.empty?
+
       self
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for `acc` data
   class Accent < OOXMLDocumentObject

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'argument_properties/argument_size'
 module OoxmlParser
   # Class for parsing `m:argPr` object

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `m:argSz` object
   class ArgumentSize < OOXMLDocumentObject

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for `bar` data
   class Bar < OOXMLDocumentObject

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for `box`, `borderBox` data
   class Box < OOXMLDocumentObject

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for `d` data
   class Delimiter < OOXMLDocumentObject

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for 'f' data
   class Fraction < OOXMLDocumentObject

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for `func` data
   class Function < OOXMLDocumentObject

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for `groupChr` data
   class GroupChar < OOXMLDocumentObject

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for 'sSubSup', 'sSup', 'sSub' data
   class Index < OOXMLDocumentObject

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for `limUpp`, `limLow` data
   class Limit < OOXMLDocumentObject
@@ -8,9 +10,9 @@ module OoxmlParser
       @parent = parent
     end
 
-    # Parse Accent object
+    # Parse Limit object
     # @param node [Nokogiri::XML:Element] node to parse
-    # @return [Accent] result of parsing
+    # @return [Limit] result of parsing
     def parse(node)
       @type = :lower if node.name == 'limLow'
       node.xpath('*').each do |node_child|

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'math_run/math_run_properties'
 module OoxmlParser
   # Class for parsing `m:r` object

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `m:rPr` object
   class MathRunProperties < OOXMLDocumentObject

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'matrix/matrix_row'
 module OoxmlParser
   # Class for 'm' data

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for 'm:mr' data
   class MatrixRow < OOXMLDocumentObject

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'nary/nary_properties'
 module OoxmlParser
   # Class for parsing `m:nary` object

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'nary_properties/nary_grow'
 require_relative 'nary_properties/nary_limit_location'
 module OoxmlParser

data/lib/ooxml_parser/docx_parser/docx_data/document_structure/docx_paragraph/docx_formula/nary/nary_properties/nary_grow.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `m:grow` object
   class NaryGrow < OOXMLDocumentObject

data/lib/ooxml_parser/docx_parser/docx_data/document_structure/docx_paragraph/docx_formula/nary/nary_properties/nary_limit_location.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `m:limLoc` object
   class NaryLimitLocation < OOXMLDocumentObject

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `m:sPre` object
   class PreSubSuperscript < OOXMLDocumentObject
@@ -10,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_formula/radical.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for `rad` data
   class Radical < OOXMLDocumentObject
@@ -8,9 +10,9 @@ module OoxmlParser
       @parent = parent
     end
 
-    # Parse Function object
+    # Parse Radical object
     # @param node [Nokogiri::XML:Element] node to parse
-    # @return [Function] result of parsing
+    # @return [Radical] 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_helper.rb

@@ -1,8 +1,13 @@
-# Stuff for help working with paragraph
-module DocxParagraphHelper
-  # @return [Nil, CommentExtended] extended data for this comment
-  def comment_extend_data
-    return if @paragraph_id.nil?
-    root_object.comments_extended.by_id(@paragraph_id)
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Stuff for help working with paragraph
+  module DocxParagraphHelper
+    # @return [Nil, CommentExtended] extended data for this comment
+    def comment_extend_data
+      return if @paragraph_id.nil?
+
+      root_object.comments_extended.by_id(@paragraph_id)
+    end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # noinspection RubyTooManyInstanceVariablesInspection
 require_relative 'docx_paragraph_run/docx_paragraph_run_helpers'
 require_relative 'docx_paragraph_run/object'
@@ -6,6 +8,7 @@ require_relative 'docx_paragraph_run/text_fill'
 require_relative 'docx_paragraph_run/shape'
 
 module OoxmlParser
+  # Class for working with DocxParagraphRun
   class DocxParagraphRun < OOXMLDocumentObject
     include DocxParagraphRunHelpers
     attr_accessor :number, :font, :vertical_align, :size, :font_color, :background_color, :font_style, :text, :drawings,
@@ -20,7 +23,7 @@ module OoxmlParser
     # @return [RunObject] object of run
     attr_accessor :object
 
-    def initialize
+    def initialize(parent: nil)
       @number = 0
       @font = 'Arial'
       @vertical_align = :baseline
@@ -35,19 +38,39 @@ module OoxmlParser
       @break = false
       @comments = []
       @page_number = false
+      @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
     end
 
+    # @return [True, False] is current run empty
+    def empty?
+      text.empty? &&
+        !alternate_content &&
+        !drawing &&
+        !object &&
+        !shape &&
+        !footnote &&
+        !endnote &&
+        !@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
@@ -58,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')
@@ -105,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'
@@ -115,24 +141,5 @@ module OoxmlParser
       end
       @number = char_number
     end
-
-    def self.parse_font_by_theme(theme)
-      doc = Nokogiri::XML(File.open("#{OOXMLDocumentObject.path_to_folder}/#{OOXMLDocumentObject.root_subfolder}/theme/theme1.xml"))
-      doc.search('//a:fontScheme').each do |font_scheme|
-        if theme.include?('major')
-          font_scheme.xpath('a:majorFont').each do |major_font|
-            major_font.xpath('a:latin').each do |latin|
-              return latin.attribute('typeface').value
-            end
-          end
-        elsif theme.include?('minor')
-          font_scheme.xpath('a:minorFont').each do |minor_font|
-            minor_font.xpath('a:latin').each do |latin|
-              return latin.attribute('typeface').value
-            end
-          end
-        end
-      end
-    end
   end
 end

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

@@ -1,6 +1,12 @@
+# frozen_string_literal: true
+
 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
@@ -8,7 +14,11 @@ module OoxmlParser
           node_child.attributes.each do |font_attribute, value|
             case font_attribute
             when 'asciiTheme'
-              self.font = DocxParagraphRun.parse_font_by_theme(node_child.attribute('asciiTheme').value)
+              theme = node_child.attribute('asciiTheme').value
+              next unless root_object.theme
+
+              self.font = root_object.theme.font_scheme.major_font.latin.typeface if theme.include?('major')
+              self.font = root_object.theme.font_scheme.minor_font.latin.typeface if theme.include?('minor')
             when 'ascii'
               self.font = value.value
               break
@@ -46,9 +56,10 @@ module OoxmlParser
             when 'val'
               self.font_color = Color.new(parent: self).parse_hex_string(value.value)
             when 'themeColor'
-              unless ThemeColors.list[value.value.to_sym].nil?
+              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 = ThemeColors.list[value.value.to_sym].dup
+
+                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)