ooxml_parser 0.3.0 → 0.6.0

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

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
@@ -24,6 +26,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
@@ -25,7 +30,8 @@ module OoxmlParser
       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
+
+        false
       else
         self.line_rule = line_rule.to_sym if line_rule.instance_of?(String)
 
@@ -33,9 +39,9 @@ module OoxmlParser
            @after == other.after &&
            @line == other.line &&
            @line_rule.to_s == other.line_rule.to_s
-          return true
+          true
         else
-          return false
+          false
         end
       end
     end
@@ -53,10 +59,6 @@ module OoxmlParser
       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
-
     def round(count_of_digits = 1)
       before = @before.to_f.round(count_of_digits)
       after = @after.to_f.round(count_of_digits)
@@ -72,7 +74,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 +97,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

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

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

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

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
+
 require_relative 'relationships/relationship'
 module OoxmlParser
   # Class for describing list of relationships
-  class Relationships
+  class Relationships < OOXMLDocumentObject
     # @return [Array, Relationship] array of relationships
     attr_accessor :relationship
 
-    def initialize
+    def initialize(parent: nil)
       @relationship = []
+      @parent = parent
     end
 
     # @return [Array, Column] accessor for relationship
@@ -27,6 +30,20 @@ module OoxmlParser
       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
@@ -37,27 +54,15 @@ module OoxmlParser
       nil
     end
 
-    # Get target name by type
+    # Get target names by type
     # @param type [String] type of target
-    # @return [String] target name
+    # @return [Array<String>] target names
     def target_by_type(type)
+      result = []
       @relationship.each do |cur_rels|
-        return cur_rels.target if cur_rels.type.include?(type)
-      end
-      nil
-    end
-
-    # Parse .rels file
-    # @param file_path [String] path to file
-    # @return [Relationships]
-    def self.parse_rels(file_path)
-      node = Nokogiri::XML(File.open(file_path))
-      node.xpath('*').each do |node_child|
-        case node_child.name
-        when 'Relationships'
-          return Relationships.new.parse(node_child)
-        end
+        result << cur_rels.target if cur_rels.type.include?(type)
       end
+      result
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for single relationship
   class Relationship < OOXMLDocumentObject

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

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require_relative 'table/row/row'
 require_relative 'table/table_properties'
 require_relative 'table/table_grid'
 require_relative 'table/margins/table_margins'
 require_relative 'table/margins/paragraph_margins'
 module OoxmlParser
+  # Class for Table data
   class Table < OOXMLDocumentObject
     attr_accessor :grid, :rows, :properties, :number
 

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

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module OoxmlParser
+  # Class for working with ParagraphMargins
   class ParagraphMargins < TableMargins
     def initialize(top = OoxmlSize.new(0),
                    bottom = OoxmlSize.new(0),
@@ -12,14 +15,6 @@ module OoxmlParser
       @parent = parent
     end
 
-    def round(count_of_digits = 1)
-      top = @top.round(count_of_digits)
-      bottom = @bottom.round(count_of_digits)
-      left = @left.round(count_of_digits)
-      right = @right.round(count_of_digits)
-      ParagraphMargins.new(top, bottom, left, right)
-    end
-
     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

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module OoxmlParser
+  # Class for working with Table Margins
   class TableMargins < OOXMLDocumentObject
     attr_accessor :is_default, :top, :bottom, :left, :right
 

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

@@ -1,5 +1,7 @@
-# Describe single table element
+# frozen_string_literal: true
+
 module OoxmlParser
+  # Describe single table element
   class TableElement < OOXMLDocumentObject
     attr_accessor :cell_style
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `w:tblLayout` object
   # Whether a table uses a fixed width or autofit method for laying out the table

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Describe look of table, parsed `w:tblLook`
   class TableLook < OOXMLDocumentObject

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

@@ -1,11 +1,18 @@
-# Table Position Data
+# frozen_string_literal: true
+
 module OoxmlParser
+  # Table Position Data
   class TablePosition < OOXMLDocumentObject
     attr_accessor :left, :right, :top, :bottom, :position_x, :position_y, :horizontal_anchor, :vertical_anchor, :vertical_align_from_anchor,
                   :horizontal_align_from_anchor
 
     def to_s
-      'Table position left: ' + @left.to_s + ', right: ' + @right.to_s + ', top: ' + @top.to_s + ', bottom: ' + @bottom.to_s + 'position x: ' + position_x.to_s + 'position y: ' + position_x.to_s
+      "Table position left: #{left}, "\
+      "right: #{right}, "\
+      "top: #{top}, "\
+      "bottom #{bottom}, "\
+      "position x: #{position_x}, "\
+      "position y: #{position_y}"
     end
 
     # Parse TablePosition object

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

@@ -1,18 +1,31 @@
+# frozen_string_literal: true
+
 require_relative 'table_element'
-# Style of Table
 module OoxmlParser
+  # Style of Table
   class TableStyle < OOXMLDocumentObject
     attr_accessor :id, :name, :whole_table, :banding_1_horizontal, :banding_2_horizontal, :banding_1_vertical, :banding_2_vertical,
                   :last_column, :first_column, :last_row, :first_row, :southeast_cell, :southwest_cell, :northeast_cell,
                   :northwest_cell
+    # @return [String] value of table style
+    attr_reader :value
 
     # Parse TableStyle object
-    # @param style_id [String] id to parse
+    # @param node [Nokogiri::XML:Element] node to parse
     # @return [TableStyle] result of parsing
-    def parse(style_id: nil)
-      nodes = get_style_node(style_id)
-      return nil unless nodes
-      nodes.xpath('*').each do |style_node_child|
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'styleId'
+          @id = value.value.to_s
+        when 'styleName'
+          @name = value.value.to_s
+        when 'val'
+          @value = value.value.to_s
+        end
+      end
+
+      node.xpath('*').each do |style_node_child|
         case style_node_child.name
         when 'wholeTbl'
           @whole_table = TableElement.new(parent: self).parse(style_node_child)
@@ -42,18 +55,7 @@ module OoxmlParser
           @northwest_cell = TableElement.new(parent: self).parse(style_node_child)
         end
       end
-      @id = style_id
       self
     end
-
-    def get_style_node(style_id)
-      begin
-        doc = Nokogiri::XML(File.open(OOXMLDocumentObject.path_to_folder + 'ppt/tableStyles.xml'))
-      rescue StandardError
-        raise 'Can\'t find tableStyles.xml in ' + OOXMLDocumentObject.path_to_folder.to_s + '/ppt folder'
-      end
-      doc.xpath('a:tblStyleLst/a:tblStyle').each { |table_style_node| return table_style_node if table_style_node.attribute('styleId').value == style_id }
-      nil
-    end
   end
 end