ooxml_parser 0.14.1-mingw32

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# @author Pavel.Lobashov
+
+require_relative 'spacing/line_spacing'
+module OoxmlParser
+  # Class to describe spacing
+  class Spacing
+    # @return [Float] Spacing before paragraph
+    attr_accessor :before
+    # @return [Float] Spacing after paragraph
+    attr_accessor :after
+    # @return [Float] Spacing between lines
+    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
+      @after = after
+      @line = line
+      @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
+      self.line_rule = line_rule.to_sym if line_rule.instance_of?(String)
+
+      @before == other.before &&
+        @after == other.after &&
+        @line == other.line &&
+        @line_rule.to_s == other.line_rule.to_s
+    end
+
+    # @return [String] result of convert of object to string
+    def to_s
+      result_string = ''
+      variables = instance_variables
+      variables.each do |current_variable|
+        result_string += "#{current_variable.to_s.sub('@', '')}: #{instance_variable_get(current_variable)}\n"
+      end
+      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)
+      line = @line.to_f.round(count_of_digits)
+      Spacing.new(before, after, line, @line_rule)
+    end
+
+    # Parse data for Spacing
+    # @param [Nokogiri::XML:Element] node with Spacing
+    # @return [Nothing]
+    def parse(node)
+      node.xpath('*').each do |spacing_node_child|
+        case spacing_node_child.name
+        when 'lnSpc'
+          self.line = Spacing.parse_spacing_value(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'
+          self.after = Spacing.parse_spacing_value(spacing_node_child)
+        end
+      end
+    end
+
+    # Parse values of spacing number
+    # @param [Nokogiri::XML:Element] node with Spacing
+    # @return [Float] value of spacing number
+    def self.parse_spacing_value(node)
+      node.xpath('*').each do |spacing_node_child|
+        case spacing_node_child.name
+        when 'spcPct'
+          return OoxmlSize.new(spacing_node_child.attribute('val').value.to_f, :one_1000th_percent)
+        when 'spcPts'
+          return OoxmlSize.new(spacing_node_child.attribute('val').value.to_f, :spacing_point)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for storing `w:tab`, `a:tab` data
+  class Tab < OOXMLDocumentObject
+    # @return [Symbol] Specifies the style of the tab.
+    attr_accessor :value
+    # @return [Symbol] Specifies the leader symbol of tab
+    attr_reader :leader
+    # @return [OOxmlSize] Specifies the position of the tab stop.
+    attr_accessor :position
+
+    alias align value
+
+    # Parse ParagraphTab object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [ParagraphTab] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'algn', 'val'
+          @value = value_to_symbol(value)
+        when 'leader'
+          @leader = value_to_symbol(value)
+        when 'pos'
+          @position = OoxmlSize.new(value.value.to_f, position_unit(node))
+        end
+      end
+      self
+    end
+
+    private
+
+    # @param node [Nokogiri::XML:Element] node to determine size
+    # @return [Symbol] type of size unit
+    def position_unit(node)
+      return :emu if node.namespace.prefix == 'a'
+
+      :dxa
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'tabs/tab'
+module OoxmlParser
+  # Class for working with `w:tabs`
+  class Tabs < OOXMLDocumentObject
+    # @return [Array, ParagraphTabs]
+    attr_accessor :tabs_array
+
+    def initialize(parent: nil)
+      @tabs_array = []
+      super
+    end
+
+    # @return [Array, Column] accessor
+    def [](key)
+      @tabs_array[key]
+    end
+
+    # @return [True, False] if empty
+    def empty?
+      @tabs_array.empty?
+    end
+
+    # Parse Tabs data
+    # @param [Nokogiri::XML:Element] node with Tabs data
+    # @return [Tabs] value of Columns data
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'tab'
+          @tabs_array << Tab.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing `fld` tags
+  class TextField < OOXMLDocumentObject
+    attr_accessor :id, :type, :text
+
+    # Parse TextField object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [TextField] result of parsing
+    def parse(node)
+      @id = node.attribute('id').value
+      @type = node.attribute('type').value
+      node.xpath('*').each do |text_field_node_child|
+        case text_field_node_child.name
+        when 't'
+          @text = text_field_node_child.text
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'paragraph/paragraph_properties'
+require_relative 'paragraph/paragraph_run'
+require_relative 'paragraph/text_field'
+module OoxmlParser
+  # Class for parsing `p` tags
+  class Paragraph < OOXMLDocumentObject
+    attr_accessor :properties, :runs, :text_field, :formulas
+    # @return [AlternateContent] alternate content data
+    attr_accessor :alternate_content
+
+    def initialize(runs = [],
+                   formulas = [],
+                   parent: nil)
+      @runs = runs
+      @formulas = formulas
+      @runs = []
+      super(parent: parent)
+    end
+
+    alias characters runs
+    alias character_style_array runs
+    alias characters= runs=
+    alias character_style_array= runs=
+
+    # Parse Paragraph object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [Paragraph] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'pPr'
+          @properties = ParagraphProperties.new(parent: self).parse(node_child)
+        when 'fld'
+          @text_field = TextField.new(parent: self).parse(node_child)
+        when 'r'
+          @runs << ParagraphRun.new(parent: self).parse(node_child)
+        when 'AlternateContent'
+          @alternate_content = AlternateContent.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/common_parser/common_data/relationships/relationship.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for single relationship
+  class Relationship < OOXMLDocumentObject
+    # @return [String] id of relation
+    attr_accessor :id
+    # @return [String] type of relation
+    attr_accessor :type
+    # @return [String] target of relation
+    attr_accessor :target
+
+    # Parse Relationship
+    # @param [Nokogiri::XML:Node] node with Relationship
+    # @return [Relationship] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'Id'
+          @id = value.value
+        when 'Type'
+          @type = value.value
+        when 'Target'
+          @target = value.value
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative 'relationships/relationship'
+module OoxmlParser
+  # Class for describing list of relationships
+  class Relationships < OOXMLDocumentObject
+    # @return [Array, Relationship] array of relationships
+    attr_accessor :relationship
+
+    def initialize(parent: nil)
+      @relationship = []
+      super
+    end
+
+    # @return [Array, Column] accessor for relationship
+    def [](key)
+      @relationship[key]
+    end
+
+    # Parse Relationships
+    # @param [Nokogiri::XML:Node] node with Relationships
+    # @return [Relationships] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_children|
+        case node_children.name
+        when 'Relationship'
+          @relationship << Relationship.new(parent: self).parse(node_children)
+        end
+      end
+      self
+    end
+
+    # Parse .rels file
+    # @param file_path [String] path to file
+    # @return [Relationships]
+    def parse_file(file_path)
+      node = parse_xml(file_path)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'Relationships'
+          parse(node_child)
+        end
+      end
+      self
+    end
+
+    # Get target name by id
+    # @param id [String] id of target
+    # @return [String] target name
+    def target_by_id(id)
+      @relationship.each do |cur_rels|
+        return cur_rels.target if cur_rels.id == id
+      end
+      nil
+    end
+
+    # Get target names by type
+    # @param type [String] type of target
+    # @return [Array<String>] target names
+    def target_by_type(type)
+      result = []
+      @relationship.each do |cur_rels|
+        result << cur_rels.target if cur_rels.type.include?(type)
+      end
+      result
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for working with ParagraphMargins
+  class ParagraphMargins < TableMargins
+    def initialize(top = OoxmlSize.new(0),
+                   bottom = OoxmlSize.new(0),
+                   left = OoxmlSize.new(0),
+                   right = OoxmlSize.new(0),
+                   parent: nil)
+      super(true, top, bottom, left, right, 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
+        when 'bIns', 'marB'
+          @bottom = OoxmlSize.new(value.value.to_f, :emu)
+        when 'tIns', 'marT'
+          @top = OoxmlSize.new(value.value.to_f, :emu)
+        when 'lIns', 'marL'
+          @left = OoxmlSize.new(value.value.to_f, :emu)
+        when 'rIns', 'marR'
+          @right = OoxmlSize.new(value.value.to_f, :emu)
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for working with Table Margins
+  class TableMargins < OOXMLDocumentObject
+    attr_accessor :is_default, :top, :bottom, :left, :right
+
+    def initialize(is_default = true, top = nil, bottom = nil, left = nil, right = nil, parent: nil)
+      @is_default = is_default
+      @top = top
+      @bottom = bottom
+      @left = left
+      @right = right
+      super(parent: parent)
+    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
+        next if current_attribute == :@is_default
+        return false unless instance_variable_get(current_attribute) == other.instance_variable_get(current_attribute)
+      end
+      true
+    end
+
+    # @return [String] result of convert of object to string
+    def to_s
+      "Default: #{is_default} top: #{@top}, bottom: #{@bottom}, left: #{@left}, right: #{@right}"
+    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
+        when 'left'
+          @left = OoxmlSize.new(cell_margin_node.attribute('w').value.to_f)
+        when 'top'
+          @top = OoxmlSize.new(cell_margin_node.attribute('w').value.to_f)
+        when 'right'
+          @right = OoxmlSize.new(cell_margin_node.attribute('w').value.to_f)
+        when 'bottom'
+          @bottom = OoxmlSize.new(cell_margin_node.attribute('w').value.to_f)
+        end
+      end
+      self
+    end
+  end
+end