ooxml_parser 0.4.1 → 0.5.0

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`

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Helper method for working with TableStyleProperties
   module TableStylePropertiesHelper
     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,
@@ -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,5 +1,6 @@
-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
@@ -32,11 +33,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 +50,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

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'table_cell_line'
 module OoxmlParser
   # Border Data

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

@@ -1,30 +1,34 @@
+# frozen_string_literal: true
+
 require_relative 'border'
 module OoxmlParser
+  # Borders data
   class Borders < ParagraphBorders
     attr_accessor :left, :right, :top, :bottom, :inner_vertical, :inner_horizontal, :display, :between, :bar,
                   :top_left_to_bottom_right, :top_right_to_bottom_left, :offset_from
 
-    def initialize(left = BordersProperties.new,
-                   right = BordersProperties.new,
-                   top = BordersProperties.new,
-                   bottom = BordersProperties.new,
-                   between = BordersProperties.new,
-                   parent: nil)
-      @left = left
-      @right = right
-      @top = top
-      @bottom = bottom
-      @between = between
+    def initialize(parent: nil)
+      @left = BordersProperties.new
+      @right = BordersProperties.new
+      @top = BordersProperties.new
+      @bottom = BordersProperties.new
+      @between = BordersProperties.new
+      @inner_horizontal = BordersProperties.new
+      @inner_vertical = BordersProperties.new
       @parent = parent
     end
 
     def copy
-      new_borders = Borders.new(@left, @right, @top, @bottom)
-      new_borders.inner_vertical = @inner_vertical unless @inner_vertical.nil?
-      new_borders.inner_horizontal = @inner_horizontal unless @inner_horizontal.nil?
-      new_borders.between = @between unless @between.nil?
-      new_borders.display = @display unless @display.nil?
-      new_borders.bar = @bar unless bar.nil?
+      new_borders = Borders.new
+      new_borders.left = @left if @left
+      new_borders.right = @right if @right
+      new_borders.top = @top if @top
+      new_borders.bottom = @bottom if @bottom
+      new_borders.inner_vertical = @inner_vertical if @inner_vertical
+      new_borders.inner_horizontal = @inner_horizontal if @inner_horizontal
+      new_borders.between = @between if @between
+      new_borders.display = @display if @display
+      new_borders.bar = @bar if @bar
       new_borders
     end
 
@@ -74,10 +78,6 @@ module OoxmlParser
           @top = TableCellLine.new(parent: self).parse(node_child)
         when 'lnB', 'bottom'
           @bottom = TableCellLine.new(parent: self).parse(node_child)
-        when 'lnTlToBr', 'tl2br'
-          @top_left_to_bottom_right = TableCellLine.new(parent: self).parse(node_child)
-        when 'lnBlToTr', 'tr2bl'
-          @top_right_to_bottom_left = TableCellLine.new(parent: self).parse(node_child)
         when 'insideV'
           @inner_vertical = TableCellLine.new(parent: self).parse(node_child)
         when 'insideH'
@@ -86,23 +86,5 @@ module OoxmlParser
       end
       self
     end
-
-    def self.parse_from_style(style_number)
-      node = XLSXWorkbook.styles_node.xpath('//xmlns:border')[style_number.to_i]
-      cell_borders = Borders.new
-      node.xpath('*').each do |node_child|
-        case node_child.name
-        when 'bottom'
-          cell_borders.bottom = Border.new(parent: cell_borders).parse(node_child)
-        when 'top'
-          cell_borders.top = Border.new(parent: cell_borders).parse(node_child)
-        when 'right'
-          cell_borders.right = Border.new(parent: cell_borders).parse(node_child)
-        when 'left'
-          cell_borders.left = Border.new(parent: cell_borders).parse(node_child)
-        end
-      end
-      cell_borders
-    end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'table_cell_line/line_join'
 module OoxmlParser
   # Class for parsing Table Cell Lines

data/lib/ooxml_parser/common_parser/common_data/table/row/cell/properties/table_cell_line/line_join.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module OoxmlParser
+  # LineJoin data
   class LineJoin < OOXMLDocumentObject
-    attr_accessor :type, :limit
+    attr_accessor :type
 
     # Parse LineJoin object
     # @param node [Nokogiri::XML:Element] node to parse
@@ -10,9 +13,6 @@ module OoxmlParser
         case node_child.name
         when 'round', 'bevel'
           @type = node_child.name.to_sym
-        when 'miter'
-          @type = :miter
-          @limit = node_child.attribute('lim').value.to_f
         end
       end
       self

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

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require_relative 'cell/cell'
 require_relative 'row/table_row_properties'
 module OoxmlParser
+  # Class for data of TableRow
   class TableRow < OOXMLDocumentObject
     attr_accessor :height, :cells, :table_row_properties
 
@@ -15,7 +18,7 @@ module OoxmlParser
     # @param node [Nokogiri::XML:Element] node to parse
     # @return [TableRow] result of parsing
     def parse(node)
-      Presentation.current_font_style = FontStyle.new(true) # TODO: Add correct parsing of TableStyle.xml file and use it
+      root_object.default_font_style = FontStyle.new(true) # TODO: Add correct parsing of TableStyle.xml file and use it
       node.attributes.each do |key, value|
         case key
         when 'h'
@@ -30,7 +33,7 @@ module OoxmlParser
           @cells << TableCell.new(parent: self).parse(node_child)
         end
       end
-      Presentation.current_font_style = FontStyle.new
+      root_object.default_font_style = FontStyle.new
       self
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'table_row_properties/table_row_height'
 module OoxmlParser
   # Class for describing Table Row Properties

data/lib/ooxml_parser/common_parser/common_data/table/row/row/table_row_properties/table_row_height.rb

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'table_grid/grid_column'
 module OoxmlParser
   # Class for parsing `w:tblGrid` object

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `w:gridCol` object
   class GridColumn < OOXMLDocumentObject
@@ -11,7 +13,7 @@ module OoxmlParser
       node.attributes.each do |key, value|
         case key
         when 'w'
-          @width = OoxmlSize.new(value.value.to_f)
+          @width = OoxmlSize.new(value.value.to_f, :emu)
         end
       end
       self

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Table Properties Data
 require_relative 'properties/table_layout'
 require_relative 'properties/table_look'
@@ -10,8 +12,10 @@ require_relative 'table_properties/table_borders'
 module OoxmlParser
   # Class for parsing `w:tblPr` tags
   class TableProperties < OOXMLDocumentObject
-    attr_accessor :jc, :table_width, :table_borders, :table_positon, :table_cell_margin, :table_indent, :stretching, :table_style, :row_banding_size,
-                  :column_banding_size, :table_look, :grid_column, :style
+    attr_accessor :jc, :table_width, :table_borders, :table_positon, :table_cell_margin, :table_indent, :stretching, :row_banding_size,
+                  :column_banding_size, :table_look, :grid_column
+    # @return [String] id of table style
+    attr_reader :table_style_id
     # @return [TableStyleColumnBandSize] table style column band size
     attr_accessor :table_style_column_band_size
     # @return [TableStyleRowBandSize] table style row band size
@@ -26,6 +30,10 @@ module OoxmlParser
     attr_accessor :caption
     # @return [ValuedChild] description of table
     attr_accessor :description
+    # @return [Color] fill type
+    attr_reader :fill
+    # @return [TableStyle] element of table style
+    attr_reader :table_style_element
 
     alias table_properties table_positon
 
@@ -42,17 +50,20 @@ module OoxmlParser
       node.xpath('*').each do |node_child|
         case node_child.name
         when 'tableStyleId'
-          @style = TableStyle.new(parent: self).parse(style_id: node_child.text)
+          @table_style_id = node_child.text
         when 'tblBorders'
           @table_borders = TableBorders.new(parent: self).parse(node_child)
         when 'tblStyle'
-          @table_style = root_object.document_style_by_id(node_child.attribute('val').value)
+          # TODO: Incorrect but to keep compatibility
+          @table_style_element = TableStyle.new(parent: self).parse(node_child)
         when 'tblW'
           @table_width = OoxmlSize.new.parse(node_child)
         when 'jc'
           @jc = node_child.attribute('val').text.to_sym
         when 'shd'
           @shade = Shade.new(parent: self).parse(node_child)
+        when 'solidFill'
+          @fill = PresentationFill.new(parent: self).parse(node)
         when 'tblLook'
           @table_look = TableLook.new(parent: self).parse(node_child)
         when 'tblInd'
@@ -78,5 +89,16 @@ module OoxmlParser
       @table_look = TableLook.new(parent: self).parse(node) if @table_look.nil?
       self
     end
+
+    # @return [TableStyle] style of table
+    def style
+      root_object.table_styles.style_by_id(table_style_id)
+    end
+
+    # For compatibility reasons
+    # @return [DocumentStyle] table style of table
+    def table_style
+      root_object.document_style_by_id(table_style_element.value)
+    end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for describing Table Border Propertie
   class TableBorders < OOXMLDocumentObject

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

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for working with any tag contained only value
   class ValuedChild < OOXMLDocumentObject

data/lib/ooxml_parser/common_parser/common_document_structure.rb

@@ -1,7 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'common_data/content_types'
 module OoxmlParser
   # Common document structure for DOCX, XLSX, PPTX file
   class CommonDocumentStructure < OOXMLDocumentObject
     # @return [String] path to original file
     attr_accessor :file_path
+    # @return [Integer] default font size
+    attr_reader :default_font_size
+    # @return [Integer] default font typeface
+    attr_reader :default_font_typeface
+    # @return [FontStyle] Default font style of presentation
+    attr_accessor :default_font_style
+    # @return [ContentTypes] data about content types
+    attr_accessor :content_types
+
+    def initialize(params = {})
+      @default_font_size = params.fetch(:default_font_size, 18)
+      @default_font_typeface = params.fetch(:default_font_typeface, 'Arial')
+      @default_font_style = FontStyle.new
+    end
   end
 end

data/lib/ooxml_parser/common_parser/parser.rb

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 module OoxmlParser
+  # Basic class for OoxmlParser
   class Parser
     # Base method to yield parse document of any type
     # @param path_to_file [String] file
     # @return [CommonDocumentStructure] structure of doc
     def self.parse_format(path_to_file)
       return nil if OOXMLDocumentObject.encrypted_file?(path_to_file)
+
       path_to_zip_file = OOXMLDocumentObject.copy_file_and_rename_to_zip(path_to_file)
       OOXMLDocumentObject.path_to_folder = path_to_zip_file.sub(File.basename(path_to_zip_file), '')
       OOXMLDocumentObject.unzip_file(path_to_zip_file, OOXMLDocumentObject.path_to_folder)
@@ -24,9 +28,9 @@ module OoxmlParser
         when :docx
           DocumentStructure.parse
         when :xlsx
-          XLSXWorkbook.parse
+          XLSXWorkbook.new.parse
         when :pptx
-          Presentation.parse
+          Presentation.new.parse
         else
           warn "#{path_to_file} is a simple zip file without OOXML content"
         end