ooxml_parser 0.4.1 → 0.7.1

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
 
@@ -14,10 +17,12 @@ module OoxmlParser
 
     alias table_properties properties
 
+    # @return [String] result of convert of object to string
     def to_s
       "Rows: #{@rows.join(',')}"
     end
 
+    # @return [String] inspect of object for debug means
     def inspect
       to_s
     end

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,9 @@ 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
-
+    # 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

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
 
@@ -12,6 +15,9 @@ module OoxmlParser
     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
@@ -21,10 +27,14 @@ module OoxmlParser
       true
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       'Default: ' + is_default.to_s + ' top: ' + @top.to_s + ', bottom: ' + @bottom.to_s + ', left: ' + @left.to_s + ', right: ' + @right.to_s
     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

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,19 @@
-# 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
 
+    # @return [String] result of convert of object to string
     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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `w:tblStyleColBandSize` object
   # When a style specifies the format for a band of columns in a

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'table_style_properties/table_style_properties_helper'
 module OoxmlParser
   # Class for parsing `w:tblStylePr`
@@ -14,6 +16,7 @@ module OoxmlParser
     attr_reader :table_row_properties
     # @return [ParagraphProperties] properties of paragraph
     attr_accessor :paragraph_properties
+
     alias cell_properties table_cell_properties
 
     def initialize(type: nil, parent: nil)

data/lib/ooxml_parser/common_parser/common_data/table/properties/table_style_properties/table_style_properties_helper.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Helper method for working with TableStyleProperties
   module TableStylePropertiesHelper
+    # [Hash] short names for table styles
     TABLE_STYLES_NAMES_HASH = { first_column: :firstCol,
                                 last_column: :lastCol,
                                 whole_table: :wholeTbl,
-                                banding_1_horizontal:  :band1Horz,
+                                banding_1_horizontal: :band1Horz,
                                 banding_2_horizontal: :band2Horz,
                                 banding_1_vertical: :band1Vert,
                                 banding_2_vertical: :band2Vert,
@@ -15,12 +18,11 @@ module OoxmlParser
                                 first_row: :firstRow,
                                 last_row: :lastRow }.freeze
 
-    TABLE_STYLES_NAMES_HASH.each_key do |table_style_name|
-      define_method(table_style_name) do
+    TABLE_STYLES_NAMES_HASH.each do |key, value|
+      define_method(key) do
         @table_style_properties_list.each do |table_style|
-          return table_style if table_style.type == TABLE_STYLES_NAMES_HASH[table_style_name]
+          return table_style if table_style.type == value
         end
-        nil
       end
     end
 
@@ -35,6 +37,7 @@ module OoxmlParser
           style_exist = true if existing_style.type == current_table_style
         end
         next if style_exist
+
         @table_style_properties_list << TableStyleProperties.new(type: current_table_style)
       end
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `w:tblStyleRowBandSize` object
   # When a style specifies the format for a band for
@@ -9,7 +11,7 @@ module OoxmlParser
 
     # Parse TableStyleRowBandSize
     # @param [Nokogiri::XML:Node] node with TableStyleRowBandSize
-    # @return [TableStyleColumnBandSize] result of parsing
+    # @return [TableStyleRowBandSize] result of parsing
     def parse(node)
       node.attributes.each do |key, value|
         case key

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'properties/borders'
 require_relative 'cell_properties'
 module OoxmlParser
@@ -38,6 +40,8 @@ module OoxmlParser
                                                                                  0,
                                                                                  DocumentStructure.default_table_run_style,
                                                                                  parent: self)
+        when 'sdt'
+          @elements << StructuredDocumentTag.new(parent: self).parse(node_child)
         when 'tbl'
           @elements << Table.new(parent: self).parse(node_child)
         end

data/lib/ooxml_parser/common_parser/common_data/table/row/cell/cell_properties.rb

@@ -1,9 +1,10 @@
-require_relative 'cell_properties/vertical_merge'
-require_relative 'merge'
+# frozen_string_literal: true
+
+require_relative 'grid_span'
 module OoxmlParser
   # Class for parsing 'w:tcPr' element
   class CellProperties < OOXMLDocumentObject
-    attr_accessor :fill, :color, :borders, :text_direction, :anchor, :anchor_center, :horizontal_overflow, :table_cell_width, :borders_properties, :vertical_align
+    attr_accessor :fill, :color, :borders, :text_direction, :anchor, :table_cell_width, :borders_properties, :vertical_align
     # @return [GridSpan] data about grid span
     attr_accessor :grid_span
     # @return [TableMargins] margins
@@ -24,6 +25,9 @@ module OoxmlParser
 
     alias table_cell_borders borders_properties
 
+    # Parse CellProperties object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [CellProperties] result of parsing
     def parse(node)
       @borders_properties = Borders.new
       @margins = ParagraphMargins.new(parent: self).parse(node)
@@ -32,11 +36,11 @@ module OoxmlParser
       node.xpath('*').each do |node_child|
         case node_child.name
         when 'vMerge'
-          @vertical_merge = VerticalMerge.new.parse(node_child)
+          @vertical_merge = ValuedChild.new(:symbol, parent: self).parse(node_child)
         when 'vAlign'
           @vertical_align = node_child.attribute('val').value.to_sym
         when 'gridSpan'
-          @grid_span = GridSpan.new.parse(node_child)
+          @grid_span = GridSpan.new(parent: self).parse(node_child)
         when 'tcW'
           @table_cell_width = OoxmlSize.new(node_child.attribute('w').value.to_f)
         when 'tcMar'
@@ -49,6 +53,8 @@ module OoxmlParser
           @shade = Shade.new(parent: self).parse(node_child)
         when 'fill'
           @fill = DocxColorScheme.new(parent: self).parse(node_child)
+        when 'tcBdr'
+          @borders_properties = Borders.new(parent: self).parse(node_child)
         when 'tcBorders'
           node_child.xpath('*').each do |border_child|
             case border_child.name
@@ -71,14 +77,8 @@ module OoxmlParser
 
       node.attributes.each do |key, value|
         case key
-        when 'vert'
-          @text_direction = value.value.to_sym
         when 'anchor'
           @anchor = value_to_symbol(value)
-        when 'anchorCtr'
-          @anchor_center = value.value
-        when 'horzOverflow'
-          @horizontal_overflow = value.value.to_sym
         end
       end
       self

data/lib/ooxml_parser/common_parser/common_data/table/row/cell/grid_span.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for describing `gridSpan` tag
+  class GridSpan < OOXMLDocumentObject
+    # @return [String] type of grid span
+    attr_reader :type
+    # @return [String] value of grid span merged cells
+    attr_reader :value
+
+    def initialize(parent: nil)
+      @type = 'horizontal'
+      @parent = parent
+    end
+
+    alias count_of_merged_cells value
+
+    extend Gem::Deprecate
+    deprecate :type, 'GridSpan always horizontal', 2069, 1
+    deprecate :count_of_merged_cells, 'value', 2069, 1
+
+    # Parse Grid Span data
+    # @param [Nokogiri::XML:Element] node with GridSpan data
+    # @return [GridSpan] value of GridSpan
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'val'
+          @value = value.value.to_i
+        end
+      end
+      self
+    end
+  end
+end