ooxml_parser 0.6.0 → 0.7.0

data/lib/ooxml_parser/common_parser/common_data/colors/scheme_color.rb

@@ -11,6 +11,7 @@ module OoxmlParser
       @parent = parent
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       @converted_color.to_s
     end

data/lib/ooxml_parser/common_parser/common_data/colors/theme_colors.rb

@@ -6,6 +6,10 @@ module OoxmlParser
     # @return [Hash] list of colors
     attr_accessor :list
 
+    # Parse color theme
+    # @param theme [String] name of theme
+    # @param tint [Integer] tint of theme
+    # @return [Color] color of theme
     def parse_color_theme(theme, tint)
       themes_array = root_object.theme.color_scheme.values
       # TODO: if no swap performed - incorrect color parsing. But don't know why it needed

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

@@ -18,6 +18,8 @@ module OoxmlParser
       @content_types_list[key]
     end
 
+    # Parse ContentTypes object
+    # @return [ContentTypes] result of parsing
     def parse
       doc = Nokogiri::XML.parse(File.open("#{OOXMLDocumentObject.path_to_folder}/[Content_Types].xml"))
       node = doc.xpath('*').first

data/lib/ooxml_parser/common_parser/common_data/content_types/content_type_default.rb

@@ -8,6 +8,9 @@ module OoxmlParser
     # @return [String] extension
     attr_reader :extension
 
+    # Parse ContentTypeDefault object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [ContentTypeDefault] result of parsing
     def parse(node)
       node.attributes.each do |key, value|
         case key

data/lib/ooxml_parser/common_parser/common_data/content_types/content_type_override.rb

@@ -8,6 +8,9 @@ module OoxmlParser
     # @return [String] part name
     attr_reader :part_name
 
+    # Parse ContentTypeOverride object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [ContentTypeOverride] result of parsing
     def parse(node)
       node.attributes.each do |key, value|
         case key

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

@@ -29,6 +29,9 @@ module OoxmlParser
         coordinates
       end
 
+      # Parse range of coordinates
+      # @param arguments_string [String] data to parse
+      # @return [Array] result
       def parser_coordinates_range(arguments_string)
         return parse_coordinates_array(arguments_string) if arguments_string.include?(',')
         return warn "Formulas with # is unsupported: #{arguments_string}" if arguments_string.include?('#')
@@ -133,6 +136,7 @@ module OoxmlParser
       column_number > other_cell.column_number
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       "#{@column}#{@row} #{@list ? "list: #{@list}" : ''}"
     end
@@ -141,6 +145,9 @@ module OoxmlParser
       @column.nil? && @list.nil? && @row.nil?
     end
 
+    # Compare this object to other
+    # @param other [Object] any other object
+    # @return [True, False] result of comparision
     def ==(other)
       other.is_a?(Coordinates) ? (@row == other.row && @column == other.column) : false
     end

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

@@ -19,7 +19,12 @@ module OoxmlParser
       @parent = parent
     end
 
+    # Compare this object to other
+    # @param other [Object] any other object
+    # @return [True, False] result of comparision
     def ==(other)
+      return false if self.class != other.class
+
       instance_variables.each do |current_attribute|
         next if current_attribute == :@parent
         return false unless instance_variable_get(current_attribute) == other.instance_variable_get(current_attribute)
@@ -44,9 +49,11 @@ module OoxmlParser
       attr_accessor :path_to_folder
 
       # @param path_to_file [String] file
+      # @param ignore_system [True, False] should host system be ignored, since
+      #   this method is OS-dependent
       # @return [True, False] Check if file is protected by password on open
-      def encrypted_file?(path_to_file)
-        if Gem.win_platform?
+      def encrypted_file?(path_to_file, ignore_system: false)
+        if Gem.win_platform? || ignore_system
           warn 'FileMagic and checking file for encryption is not supported on Windows'
           return false
         end
@@ -63,6 +70,9 @@ module OoxmlParser
         false
       end
 
+      # Copy this file and rename to zip
+      # @param path [String] path to file
+      # @return [String] path to result zip
       def copy_file_and_rename_to_zip(path)
         file_name = File.basename(path)
         tmp_folder = Dir.mktmpdir('ruby-ooxml-parser')
@@ -75,6 +85,10 @@ module OoxmlParser
         file_path
       end
 
+      # Unzip specified file
+      # @param path_to_file [String] path to zip file
+      # @param destination [String] folder to extract
+      # @return [void]
       def unzip_file(path_to_file, destination)
         Zip.warn_invalid_date = false
         Zip::File.open(path_to_file) do |zip_file|
@@ -88,14 +102,19 @@ module OoxmlParser
         end
       end
 
+      # @return [String] dir to base of file
       def dir
         OOXMLDocumentObject.path_to_folder + File.dirname(OOXMLDocumentObject.xmls_stack.last) + '/'
       end
 
+      # @return [String] path to current xml file
       def current_xml
         OOXMLDocumentObject.path_to_folder + OOXMLDocumentObject.xmls_stack.last
       end
 
+      # Add file to parsing stack
+      # @param path [String] path of file to add to stack
+      # @return [void]
       def add_to_xmls_stack(path)
         OOXMLDocumentObject.xmls_stack << if path.include?('..')
                                             "#{File.dirname(OOXMLDocumentObject.xmls_stack.last)}/#{path}"
@@ -106,6 +125,9 @@ module OoxmlParser
                                           end
       end
 
+      # Get link to file from rels file
+      # @param id [String] file to get
+      # @return [String] result
       def get_link_from_rels(id)
         rels_path = dir + "_rels/#{File.basename(OOXMLDocumentObject.xmls_stack.last)}.rels"
         raise LoadError, "Cannot find .rels file by path: #{rels_path}" unless File.exist?(rels_path)

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

@@ -40,14 +40,17 @@ module OoxmlParser
       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

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

@@ -29,10 +29,6 @@ module OoxmlParser
     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 = ''
@@ -50,8 +46,6 @@ module OoxmlParser
         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'
@@ -66,8 +60,6 @@ module OoxmlParser
           case value.value.to_i
           when -25_000, -30_000
             @baseline = :subscript
-          when 30_000
-            @baseline = :superscript
           when 0
             @baseline = :baseline
           end

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

@@ -10,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
@@ -29,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

@@ -16,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

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

@@ -24,28 +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
+      self.line_rule = line_rule.to_sym if line_rule.instance_of?(String)
 
-        false
+      if @before == other.before &&
+         @after == other.after &&
+         @line == other.line &&
+         @line_rule.to_s == other.line_rule.to_s
+        true
       else
-        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
-          true
-        else
-          false
-        end
+        false
       end
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       result_string = ''
       variables = instance_variables
@@ -55,10 +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
 
+    # 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)

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

@@ -17,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

@@ -15,6 +15,9 @@ module OoxmlParser
       @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

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

@@ -15,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
@@ -24,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_position.rb

@@ -6,6 +6,7 @@ module OoxmlParser
     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}, "\
       "right: #{right}, "\

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

@@ -3,6 +3,7 @@
 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,
@@ -17,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
 

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

@@ -4,7 +4,7 @@ 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
@@ -25,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)
@@ -74,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/properties/borders.rb

@@ -18,6 +18,8 @@ module OoxmlParser
       @parent = parent
     end
 
+    # Method to copy object
+    # @return [Borders] copied object
     def copy
       new_borders = Borders.new
       new_borders.left = @left if @left
@@ -32,6 +34,9 @@ module OoxmlParser
       new_borders
     end
 
+    # Compare this object to other
+    # @param other [Object] any other object
+    # @return [True, False] result of comparision
     def ==(other)
       @left == other.left && @right == other.right && @top == other.top && @bottom == other.bottom if other.is_a?(Borders)
     end
@@ -52,6 +57,7 @@ module OoxmlParser
       yield(top)
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       "Left border: #{left}, Right: #{right}, Top: #{top}, Bottom: #{bottom}"
     end

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

@@ -12,6 +12,9 @@ module OoxmlParser
       @parent = parent
     end
 
+    # Compare this object to other
+    # @param other [Object] any other object
+    # @return [True, False] result of comparision
     def ==(other)
       @columns.each_with_index do |cur_column, index|
         return false unless cur_column == other.columns[index]

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

@@ -11,6 +11,9 @@ module OoxmlParser
       @parent = parent
     end
 
+    # Compare this object to other
+    # @param other [Object] any other object
+    # @return [True, False] result of comparision
     def ==(other)
       if other.is_a? Underline
         @style.to_sym == other.style.to_sym && @color == other.color
@@ -21,6 +24,7 @@ module OoxmlParser
       end
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       if @color.nil?
         @style.to_s