ooxml_parser 0.4.1 → 0.7.1

data/lib/ooxml_parser/common_parser/common_data/ooxml_document_object/ooxml_object_attribute_helper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Module for stroing some attribute helpers for objects
+  module OoxmlObjectAttributeHelper
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @param attribute_name [String] name of attribute
+    # @return [True, False] is option enabled
+    def option_enabled?(node, attribute_name = 'val')
+      return true if node.attributes.empty?
+      return true if node.to_s == '1'
+      return false if node.to_s == '0'
+      return false if node.attribute(attribute_name).nil?
+
+      status = node.attribute(attribute_name).value
+      !%w[false off 0].include?(status)
+    end
+
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @param attribute_name [String] name of attribute
+    # @return [True, False] is attribute enabled
+    def attribute_enabled?(node, attribute_name = 'val')
+      return true if node.to_s == '1'
+      return false if node.to_s == '0'
+      return false if node.attribute(attribute_name).nil?
+
+      status = node.attribute(attribute_name).value
+      %w[true on 1].include?(status)
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'paragraph/paragraph_properties'
 require_relative 'paragraph/paragraph_run'
 require_relative 'paragraph/text_field'

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragraph_properties.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require_relative 'paragrpah_properties/numbering_properties'
 require_relative 'paragrpah_properties/paragraph_borders'
 require_relative 'paragrpah_properties/paragraph_spacing'
 require_relative 'paragrpah_properties/spacing'
 require_relative 'paragrpah_properties/tabs'
 module OoxmlParser
+  # Class for data for ParagraphProperties
   class ParagraphProperties < OOXMLDocumentObject
     attr_accessor :align, :numbering, :level, :spacing, :spacing_before, :spacing_after, :indent, :margin_left, :margin_right
     # @return [FrameProperties] frame properties

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragraph_run.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'paragraph_run/run_properties'
 require_relative 'paragraph_run/text'
 module OoxmlParser
@@ -32,5 +34,30 @@ module OoxmlParser
       end
       self
     end
+
+    # @return [True, False] is current run empty
+    def empty?
+      text.empty?
+    end
+
+    # @return [String] instruction applied to paragraph
+    def instruction
+      parent.instruction
+    end
+
+    # @return [True, False] is page number applyed
+    def page_number
+      parent.page_numbering?
+    end
+
+    # @return [Hyperlink] link of run
+    def link
+      parent.parent.hyperlink
+    end
+
+    extend Gem::Deprecate
+    deprecate :instruction, 'parent.instruction', 2020, 1
+    deprecate :page_number, 'parent.page_numbering?', 2020, 1
+    deprecate :link, 'parent.parent.hyperlink', 2020, 1
   end
 end

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragraph_run/run_properties.rb

@@ -1,4 +1,5 @@
-require_relative 'run_properties/language'
+# frozen_string_literal: true
+
 require_relative 'run_properties/outline'
 require_relative 'run_properties/position'
 require_relative 'run_properties/size'
@@ -20,18 +21,14 @@ module OoxmlParser
     attr_accessor :spacing
     # @return [RunSpacing] get color
     attr_accessor :color
-    # @return [Language] language property
-    attr_accessor :language
+    # @return [ValuedChild] language property
+    attr_reader :language
     # @return [Position] position property
     attr_accessor :position
     # @return [Shade] shade property
     attr_accessor :shade
     # @return [RunStyle] run style
     attr_accessor :run_style
-    # @return [Float]
-    # This element specifies the font size which shall be applied to all
-    # complex script characters in the contents of this run when displayed
-    attr_accessor :font_size_complex
 
     def initialize(parent: nil)
       @font_name = ''
@@ -44,13 +41,11 @@ module OoxmlParser
     # @param node [Nokogiri::XML:Element] node to parse
     # @return [RunProperties] result of parsing
     def parse(node)
-      @font_style = Presentation.current_font_style.dup
+      @font_style = root_object.default_font_style.dup
       node.attributes.each do |key, value|
         case key
         when 'sz'
           @font_size = value.value.to_f / 100.0
-        when 'szCs'
-          @font_size_complex = node.attribute('val').value.to_i / 2.0
         when 'spc'
           @space = OoxmlSize.new(value.value.to_f, :one_100th_point)
         when 'b'
@@ -91,7 +86,7 @@ module OoxmlParser
         when 'color'
           @color = OoxmlColor.new(parent: self).parse(node_child)
         when 'solidFill'
-          @font_color = Color.parse_color(node_child.xpath('*').first)
+          @font_color = Color.new(parent: self).parse_color(node_child.xpath('*').first)
         when 'latin'
           @font_name = node_child.attribute('typeface').value
         when 'b'
@@ -113,7 +108,7 @@ module OoxmlParser
         when 'ln'
           @outline = Outline.new(parent: self).parse(node_child)
         when 'lang'
-          @language = Language.new(parent: self).parse(node_child)
+          @language = ValuedChild.new(:string, parent: self).parse(node_child)
         when 'position'
           @position = Position.new(parent: self).parse(node_child)
         when 'shd'
@@ -123,8 +118,8 @@ module OoxmlParser
         end
       end
       @font_color = DocxColorScheme.new(parent: self).parse(node)
-      @font_name = Presentation.default_font_typeface if @font_name.empty?
-      @font_size = Presentation.default_font_size if @font_size.nil?
+      @font_name = root_object.default_font_typeface if @font_name.empty?
+      @font_size ||= root_object.default_font_size
       self
     end
   end

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragraph_run/run_properties/outline.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Class for parsing Run Outline properties
 module OoxmlParser
   # Class for parsing `w:ln` tags

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragraph_run/run_properties/position.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `w:position` object
   class Position < OOXMLDocumentObject

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragraph_run/run_properties/run_spacing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `w:sz` object
   class RunSpacing < OOXMLDocumentObject

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragraph_run/run_properties/run_style.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `w:rStyle` object
   class RunStyle < OOXMLDocumentObject

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragraph_run/run_properties/shade.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `w:shd` object
   class Shade < OOXMLDocumentObject
@@ -18,6 +20,13 @@ module OoxmlParser
       @parent = parent
     end
 
+    # @return [String] text representation
+    def to_s
+      "Value: `#{value}`, "\
+      "Color: `#{color}`, "\
+      "Fill: `#{fill}`"
+    end
+
     # Parse Shade
     # @param [Nokogiri::XML:Node] node with Shade
     # @return [Shade] result of parsing

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragraph_run/run_properties/size.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `w:sz` object
   class Size < OOXMLDocumentObject

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragraph_run/text.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `t` tags
   class Text < OOXMLDocumentObject

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `numPr` tags
   class NumberingProperties < OOXMLDocumentObject
@@ -8,6 +10,7 @@ module OoxmlParser
       @parent = parent
     end
 
+    # @return [AbstractNumbering] AbstractNumbering of current properties
     def abstruct_numbering
       root_object.numbering.properties_by_num_id(@numbering_properties)
     end
@@ -27,6 +30,7 @@ module OoxmlParser
       self
     end
 
+    # @return [AbstractNumbering] level list of current numbering
     def numbering_level_current
       abstruct_numbering.level_list.each do |current_ilvl|
         return current_ilvl if current_ilvl.ilvl == @ilvl

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `w:pBdr` element
   class ParagraphBorders < OOXMLDocumentObject
@@ -14,6 +16,7 @@ module OoxmlParser
     # @return [BordersProperties] bar properties
     attr_accessor :bar
 
+    # @return [Symbol] type of border in visual editor
     def border_visual_type
       result = []
       result << :left if @left.val == :single
@@ -24,6 +27,7 @@ module OoxmlParser
       return :none if result == []
       return :all if result == %i[left right top bottom inner]
       return :outer if result == %i[left right top bottom]
+
       result.first if result.size == 1
     end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing Paragraph Spacing in paragraph properties `w:spacing`
   class ParagraphSpacing < OOXMLDocumentObject
@@ -10,9 +12,9 @@ module OoxmlParser
     # @return [Symbol] value of line rule style
     attr_accessor :line_rule
 
-    # Parse Position
-    # @param [Nokogiri::XML:Node] node with Position
-    # @return [Position] result of parsing
+    # Parse ParagraphSpacing
+    # @param [Nokogiri::XML:Node] node with ParagraphSpacing
+    # @return [ParagraphSpacing] result of parsing
     def parse(node)
       node.attributes.each do |key, value|
         case key

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

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 # @author Pavel.Lobashov
 
-# Class to describe spacing
+require_relative 'spacing/line_spacing'
 module OoxmlParser
+  # Class to describe spacing
   class Spacing
     # @return [Float] Spacing before paragraph
     attr_accessor :before
@@ -11,6 +14,8 @@ module OoxmlParser
     attr_accessor :line
     # @return [String] Spacing line rule
     attr_accessor :line_rule
+    # @return [LineSpacing] line spacing data
+    attr_reader :line_spacing
 
     def initialize(before = nil, after = 0.35, line = nil, line_rule = nil)
       @before = before
@@ -19,27 +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
-        return false
-      else
-        self.line_rule = line_rule.to_sym if line_rule.instance_of?(String)
+      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
-          return true
-        else
-          return false
-        end
+      if @before == other.before &&
+         @after == other.after &&
+         @line == other.line &&
+         @line_rule.to_s == other.line_rule.to_s
+        true
+      else
+        false
       end
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       result_string = ''
       variables = instance_variables
@@ -49,14 +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
 
-    def self.default_spacing_canvas(line_spacing = 1.15)
-      Spacing.new(0.0, 0.35277777777777775, line_spacing)
-    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)
@@ -72,7 +77,8 @@ module OoxmlParser
         case spacing_node_child.name
         when 'lnSpc'
           self.line = Spacing.parse_spacing_value(spacing_node_child)
-          self.line_rule = Spacing.parse_spacing_rule(spacing_node_child)
+          @line_spacing = LineSpacing.new(parent: self).parse(spacing_node_child)
+          self.line_rule = @line_spacing.rule
         when 'spcBef'
           self.before = Spacing.parse_spacing_value(spacing_node_child)
         when 'spcAft'
@@ -94,21 +100,5 @@ module OoxmlParser
         end
       end
     end
-
-    # Parse spacing rule
-    # @param [Nokogiri::XML:Element] node with Spacing
-    # @return [Symbol] type of spacing rule
-    def self.parse_spacing_rule(node)
-      node.xpath('*').each do |spacing_node_child|
-        case spacing_node_child.name
-        when 'spcPct'
-          return :multiple
-        when 'spcPts'
-          return :exact
-        else
-          return :at_least
-        end
-      end
-    end
   end
 end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class to describe spacing
+  class LineSpacing < OOXMLDocumentObject
+    # @return [ValuedChild] spacing percent
+    attr_reader :spacing_percent
+    # @return [ValuedChild] spacing point
+    attr_reader :spacing_points
+
+    # Parse LineSpacing object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [LineSpacing] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'spcPct'
+          @spacing_percent = ValuedChild.new(:integer, parent: self).parse(node_child)
+        when 'spcPts'
+          @spacing_points = ValuedChild.new(:integer, parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+
+    # @return [Symbol] rule used to determine line spacing
+    def rule
+      return :multiple if @spacing_percent
+
+      :exact
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'tabs/tab'
 module OoxmlParser
   # Class for working with `w:tabs`

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragrpah_properties/tabs/tab.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for storing `w:tab`, `a:tab` data
   class Tab < OOXMLDocumentObject
@@ -33,6 +35,7 @@ module OoxmlParser
     # @return [Symbol] type of size unit
     def position_unit(node)
       return :emu if node.namespace.prefix == 'a'
+
       :dxa
     end
   end