ooxml_parser 0.4.0 → 0.7.0

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

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module OoxmlParser
+  # Class for working with coordinates
   class Coordinates
     attr_accessor :row, :column, :list
 
@@ -26,10 +29,14 @@ 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?('#')
         return warn 'Formulas consists from `!` only' if arguments_string == '!'
+
         sheet_name = 'Sheet1'
 
         if arguments_string.include?('!')
@@ -68,8 +75,6 @@ module OoxmlParser
               end
             end
           end
-        else
-          raise 'Wrong arguments format'
         end
         arguments_array
       end
@@ -100,20 +105,23 @@ module OoxmlParser
       #    StringHelper.get_column_name('45')  #=> "AS"
       #    StringHelper.get_column_name('287')  #=> "KA"
       def get_column_name(number)
-        (number.to_i > 0 ? ('A'..'Z').to_a[(number.to_i - 1) % 26] + get_column_name((number.to_i - 1) / 26).reverse : '').reverse
+        (number.to_i.positive? ? ('A'..'Z').to_a[(number.to_i - 1) % 26] + get_column_name((number.to_i - 1) / 26).reverse : '').reverse
       end
     end
 
-    # get_column_number -> integer
     # @return [Integer] number of column
     # This method takes @column string
     # and converts into integer
-    def get_column_number
+    def column_number
       @column.reverse.each_char.reduce(0) do |result, char|
         result + (char.downcase.ord - 96) * (26**@column.reverse.index(char))
       end
     end
 
+    alias get_column_number column_number
+    extend Gem::Deprecate
+    deprecate :get_column_number, 'column_number', 2020, 1
+
     # Compares rows of two cells
     # @param [Coordinates] other_cell other cell coordinates
     # @return [true, false] true, if row greater, than other row
@@ -125,9 +133,10 @@ module OoxmlParser
     # @param [Coordinates] other_cell other cell coordinates
     # @return [true, false] true, if column greater, than other row
     def column_greater_that_other?(other_cell)
-      get_column_number > other_cell.get_column_number
+      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
@@ -136,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/font_style.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require_relative 'underline'
 # @author Pavel.Lobashov
-# Class for working with font styles (bold,italic,underlined,strike)
-# noinspection RubyClassMethodNamingConvention
 module OoxmlParser
+  # Class for working with font styles (bold,italic,underlined,strike)
   class FontStyle
     # @return [false,true] is bold?
     attr_accessor :bold

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `hlinkClick`, `hyperlink` tags
   class Hyperlink < OOXMLDocumentObject
@@ -33,7 +35,7 @@ module OoxmlParser
           @url = Coordinates.parse_coordinates_from_string(value.value)
         when 'id'
           @id = value.value
-          @url = OOXMLDocumentObject.get_link_from_rels(@id)
+          @url = OOXMLDocumentObject.get_link_from_rels(@id) unless @id.empty?
         when 'tooltip'
           @tooltip = value.value
         when 'ref'
@@ -65,7 +67,7 @@ module OoxmlParser
         @action = :slide
         @url = OOXMLDocumentObject.get_link_from_rels(@id).scan(/\d+/).join('').to_i
       else
-        unless @id.nil?
+        if @id && !@id.empty?
           @action = :external_link
           @url = OOXMLDocumentObject.get_link_from_rels(@id)
         end

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

@@ -1,12 +1,17 @@
-require 'filemagic'
+# frozen_string_literal: true
+
+require 'filemagic' unless Gem.win_platform?
 require 'securerandom'
 require 'nokogiri'
 require 'zip'
 require_relative 'ooxml_document_object/ooxml_document_object_helper'
+require_relative 'ooxml_document_object/ooxml_object_attribute_helper'
 
 module OoxmlParser
+  # Basic class for any OOXML Document Object
   class OOXMLDocumentObject
     include OoxmlDocumentObjectHelper
+    include OoxmlObjectAttributeHelper
     # @return [OOXMLDocumentObject] object which hold current object
     attr_accessor :parent
 
@@ -14,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)
@@ -27,6 +37,11 @@ module OoxmlParser
       true
     end
 
+    # @return [Nokogiri::XML::Document] result of parsing xml via nokogiri
+    def parse_xml(xml_path)
+      Nokogiri::XML(File.open(xml_path), &:strict)
+    end
+
     class << self
       attr_accessor :root_subfolder
       attr_accessor :theme
@@ -34,8 +49,14 @@ 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)
+      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
         file_result = FileMagic.new(:mime).file(path_to_file)
         # Support of Encrtypted status in `file` util was introduced in file v5.20
         # but LTS version of ubuntu before 16.04 uses older `file` and it return `Composite Document`
@@ -49,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')
@@ -56,14 +80,20 @@ module OoxmlParser
         FileUtils.rm_rf(tmp_folder) if File.directory?(tmp_folder)
         FileUtils.mkdir_p(tmp_folder)
         raise "Cannot find file by path #{path}" unless File.exist?(path)
+
         FileUtils.cp path, tmp_folder
         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|
           raise LoadError, "There is no files in zip #{path_to_file}" if zip_file.entries.empty?
+
           zip_file.each do |file|
             file_path = File.join(destination, file.name)
             FileUtils.mkdir_p(File.dirname(file_path))
@@ -72,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}"
@@ -90,10 +125,14 @@ 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)
-        relationships = Relationships.parse_rels(rels_path)
+
+        relationships = Relationships.new.parse_file(rels_path)
         relationships.target_by_id(id)
       end
     end

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

@@ -1,126 +1,117 @@
-# Module for helper methods for OOXMLDocumentObject
-module OoxmlDocumentObjectHelper
-  # Convert object to hash
-  # @return [Hash]
-  def to_hash
-    result_hash = {}
-    instance_variables.each do |current_attribute|
-      next if current_attribute == :@parent
-      attribute_value = instance_variable_get(current_attribute)
-      next unless attribute_value
-      if attribute_value.is_a?(Array)
-        attribute_value.each_with_index do |object_element, index|
-          result_hash["#{current_attribute}_#{index}".to_sym] = object_element.to_hash
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Module for helper methods for OOXMLDocumentObject
+  module OoxmlDocumentObjectHelper
+    # Convert object to hash
+    # @return [Hash]
+    def to_hash
+      result_hash = {}
+      instance_variables.each do |current_attribute|
+        next if current_attribute == :@parent
+
+        attribute_value = instance_variable_get(current_attribute)
+        next unless attribute_value
+
+        if attribute_value.is_a?(Array)
+          attribute_value.each_with_index do |object_element, index|
+            result_hash["#{current_attribute}_#{index}".to_sym] = object_element.to_hash
+          end
+        else
+          result_hash[current_attribute.to_sym] = if attribute_value.respond_to?(:to_hash)
+                                                    attribute_value.to_hash
+                                                  else
+                                                    attribute_value.to_s
+                                                  end
         end
-      else
-        result_hash[current_attribute.to_sym] = if attribute_value.respond_to?(:to_hash)
-                                                  attribute_value.to_hash
-                                                else
-                                                  attribute_value.to_s
-                                                end
       end
+      result_hash
     end
-    result_hash
-  end
-
-  private
 
-  VALUE_TO_SYMBOL_HASH = { l: :left,
-                           ctr: :center,
-                           r: :right,
-                           just: :justify,
-                           b: :bottom,
-                           t: :top,
-                           tr: :top_right,
-                           tl: :top_left,
-                           br: :bottom_right,
-                           bl: :bottom_left,
-                           contentLocked: :content_locked,
-                           dist: :distributed,
-                           tb: :horizontal,
-                           rl: :rotate_on_90,
-                           lr: :rotate_on_270,
-                           inset: :in,
-                           lu: :left_up,
-                           ru: :right_up,
-                           ld: :left_down,
-                           rd: :right_down,
-                           d: :down,
-                           u: :up,
-                           lg: :large,
-                           med: :medium,
-                           sm: :small,
-                           beneathText: :beneath_text,
-                           pageBottom: :page_bottom,
-                           sectEnd: :section_end,
-                           docEnd: :document_end,
-                           eachSect: :each_section,
-                           eachPage: :each_page,
-                           sngStrike: :single,
-                           dblStrike: :double,
-                           noStrike: :none,
-                           lgDash: :large_dash,
-                           dashDot: :dash_dot,
-                           dashDotDot: :dash_dot_dot,
-                           mediumDashed: :medium_dashed,
-                           mediumDashDot: :medium_dash_dot,
-                           mediumDashDotDot: :medium_dash_dot_dot,
-                           lgDashDot: :large_dash_dot,
-                           lgDashDotDot: :large_dash_dot_dot,
-                           sdtLocked: :sdt_locked,
-                           sdtContentLocked: :sdt_content_locked,
-                           sysDash: :system_dash,
-                           sysDot: :system_dot,
-                           sysDashDot: :system_dash_dot,
-                           sysDashDotDot: :system_dash_dot_dot,
-                           rightMargin: :right_margin,
-                           leftMargin: :left_margin,
-                           bottomMargin: :bottom_margin,
-                           topMargin: :top_margin,
-                           undOvr: :under_over,
-                           subSup: :subscript_superscript,
-                           lrTb: :left_to_right_top_to_bottom,
-                           tbRl: :top_to_bottom_right_to_left,
-                           btLr: :bottom_to_top_left_to_right,
-                           singlelevel: :single_level,
-                           maxMin: :max_min,
-                           middleDot: :middle_dot,
-                           minMax: :min_max,
-                           multilevel: :multi_level,
-                           nextTo: :next_to,
-                           hybridMultilevel: :hybrid_multi_level,
-                           rnd: :round,
-                           sq: :square }.freeze
+    private
 
-  # Convert value to human readable symbol
-  # @param [String] value to convert
-  # @return [Symbol]
-  def value_to_symbol(value)
-    symbol = VALUE_TO_SYMBOL_HASH[value.value.to_sym]
-    return value.value.to_sym if symbol.nil?
-    symbol
-  end
+    VALUE_TO_SYMBOL_HASH = { l: :left,
+                             ctr: :center,
+                             r: :right,
+                             just: :justify,
+                             b: :bottom,
+                             t: :top,
+                             tr: :top_right,
+                             tl: :top_left,
+                             br: :bottom_right,
+                             bl: :bottom_left,
+                             contentLocked: :content_locked,
+                             dist: :distributed,
+                             tb: :horizontal,
+                             rl: :rotate_on_90,
+                             lr: :rotate_on_270,
+                             inset: :in,
+                             lu: :left_up,
+                             ru: :right_up,
+                             ld: :left_down,
+                             rd: :right_down,
+                             d: :down,
+                             u: :up,
+                             lg: :large,
+                             med: :medium,
+                             sm: :small,
+                             beneathText: :beneath_text,
+                             greaterThan: :greater_than,
+                             pageBottom: :page_bottom,
+                             sectEnd: :section_end,
+                             docEnd: :document_end,
+                             eachSect: :each_section,
+                             eachPage: :each_page,
+                             sngStrike: :single,
+                             dblStrike: :double,
+                             noStrike: :none,
+                             lgDash: :large_dash,
+                             dashDot: :dash_dot,
+                             dashDotDot: :dash_dot_dot,
+                             mediumDashed: :medium_dashed,
+                             mediumDashDot: :medium_dash_dot,
+                             mediumDashDotDot: :medium_dash_dot_dot,
+                             lgDashDot: :large_dash_dot,
+                             lgDashDotDot: :large_dash_dot_dot,
+                             sdtLocked: :sdt_locked,
+                             sdtContentLocked: :sdt_content_locked,
+                             sysDash: :system_dash,
+                             sysDot: :system_dot,
+                             sysDashDot: :system_dash_dot,
+                             sysDashDotDot: :system_dash_dot_dot,
+                             rightMargin: :right_margin,
+                             leftMargin: :left_margin,
+                             bottomMargin: :bottom_margin,
+                             topMargin: :top_margin,
+                             undOvr: :under_over,
+                             subSup: :subscript_superscript,
+                             lrTb: :left_to_right_top_to_bottom,
+                             tbRl: :top_to_bottom_right_to_left,
+                             btLr: :bottom_to_top_left_to_right,
+                             singlelevel: :single_level,
+                             maxMin: :max_min,
+                             middleDot: :middle_dot,
+                             minMax: :min_max,
+                             multilevel: :multi_level,
+                             nextTo: :next_to,
+                             hybridMultilevel: :hybrid_multi_level,
+                             rnd: :round,
+                             sq: :square }.freeze
 
-  def option_enabled?(node, attribute_name = 'val')
-    return true if node.attributes.empty?
-    return true if node.to_s == '1'
-    return false if node.to_s == '0'
-    return false if node.attribute(attribute_name).nil?
-    status = node.attribute(attribute_name).value
-    !(status == 'false' || status == 'off' || status == '0')
-  end
+    # Convert value to human readable symbol
+    # @param [String] value to convert
+    # @return [Symbol]
+    def value_to_symbol(value)
+      symbol = VALUE_TO_SYMBOL_HASH[value.value.to_sym]
+      return value.value.to_sym if symbol.nil?
 
-  def attribute_enabled?(node, attribute_name = 'val')
-    return true if node.to_s == '1'
-    return false if node.to_s == '0'
-    return false if node.attribute(attribute_name).nil?
-    status = node.attribute(attribute_name).value
-    status == 'true' || status == 'on' || status == '1'
-  end
+      symbol
+    end
 
-  def root_object
-    tree_object = self
-    tree_object = tree_object.parent until tree_object.parent.nil?
-    tree_object
+    def root_object
+      tree_object = self
+      tree_object = tree_object.parent until tree_object.parent.nil?
+      tree_object
+    end
   end
 end