ooxml_parser 0.20.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed12c90b346ab55a8a41932a3fb957bfbddccf71fdedf15ec6f7b140b1be88eb
-  data.tar.gz: 24bff23c9c3f29cfac0e6db68def27199d984366c07b951fe5adb0f88e54468d
+  metadata.gz: a21fe67d2c235a37ec324fcd56428e39ff519f9a4f36b7c8257770b135922eec
+  data.tar.gz: c6ce18f4dd16cfc0d484ad0391b8787dbe7ba226b4fd744b5c44d7d4ac2e9f6f
 SHA512:
-  metadata.gz: '09bad9d23a5157e19fecf0989ac7c812a0b300920c5978f9f6c8ea9241e311dd4e3f3c68f965b52955eba1791c46b46ef22f47728148583e7a0a703d7aaadff0'
-  data.tar.gz: c31c20c9a9ca7e4ade83b93653d8d04eed3117a822d9a81d4b9f10f1d7323bb164c281e0f4b75a5c061acb430ee8d08e424a9a8c723c3346dbc74fddd0ed4685
+  metadata.gz: d926a20fbd8fd1e855983994f0b7e707c3d5d603247fc3b3c4bcd8e680febb19b4cf3232bc68dd3f4c55852bb342d195a62f9af875ab6ad1a69a9f86668e38d8
+  data.tar.gz: 789f9064bbd3d17a21d6d01a9e39d8203a59f622cb2ce48e09de62dadec00e16e9ca9d38f5ebc56ff53920f7c00874077ce4d5358975844c25c14e494075c0d7

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/docx_shape/shape_style/{effect_reference.rb → style_matrix_reference.rb}

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
 module OoxmlParser
-  # Class for parsing `a:effectRef` tags
-  class EffectReference < OOXMLDocumentObject
+  # Class for parsing `a:fillRef`, `a:effectRef`, `a:lnRef` tags
+  class StyleMatrixReference < OOXMLDocumentObject
     # @return [Integer] Style Matrix Index
     attr_reader :index
     # @return [Color] scheme color of EffectReference
     attr_reader :scheme_color
 
-    # Parse EffectReference object
+    # Parse StyleMatrixReference object
     # @param node [Nokogiri::XML:Element] node to parse
-    # @return [EffectReference] result of parsing
+    # @return [StyleMatrixReference] result of parsing
     def parse(node)
       node.attributes.each do |key, value|
         case key

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/docx_shape/shape_style.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'shape_style/effect_reference'
-require_relative 'shape_style/fill_reference'
+require_relative 'shape_style/style_matrix_reference'
 require_relative 'shape_style/font_reference'
-require_relative 'shape_style/line_reference'
 module OoxmlParser
   # Class for parsing `wps:style` tags
   class ShapeStyle < OOXMLDocumentObject
@@ -23,13 +21,13 @@ module OoxmlParser
       node.xpath('*').each do |node_child|
         case node_child.name
         when 'effectRef'
-          @effect_reference = EffectReference.new(parent: self).parse(node_child)
+          @effect_reference = StyleMatrixReference.new(parent: self).parse(node_child)
         when 'fillRef'
-          @fill_reference = FillReference.new(parent: self).parse(node_child)
+          @fill_reference = StyleMatrixReference.new(parent: self).parse(node_child)
         when 'fontRef'
           @font_reference = FontReference.new(parent: self).parse(node_child)
         when 'lnRef'
-          @line_reference = LineReference.new(parent: self).parse(node_child)
+          @line_reference = StyleMatrixReference.new(parent: self).parse(node_child)
         end
       end
       self

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/docx_shape.rb

@@ -10,9 +10,16 @@ module OoxmlParser
   # Class for parsing `sp`, `wsp` tags
   class DocxShape < OOXMLDocumentObject
     attr_accessor :non_visual_properties, :properties, :style, :body_properties, :text_body
+    # @return [True, False] Specifies if text in shape is locked when sheet is protected
+    attr_reader :locks_text
 
     alias shape_properties properties
 
+    def initialize(parent: nil)
+      @locks_text = true
+      super
+    end
+
     # @return [True, false] if structure contain any user data
     def with_data?
       return true if @text_body.nil?
@@ -27,6 +34,13 @@ module OoxmlParser
     # @param node [Nokogiri::XML:Element] node to parse
     # @return [DocxShape] result of parsing
     def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'fLocksText'
+          @locks_text = attribute_enabled?(value)
+        end
+      end
+
       node.xpath('*').each do |node_child|
         case node_child.name
         when 'nvSpPr'

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

@@ -12,23 +12,6 @@ module OoxmlParser
     end
 
     class << self
-      # @param [String] string to parse
-      # @return [Coordinates]
-      def parse_coordinates_from_string(string)
-        coordinates = Coordinates.new
-        begin
-          coordinates.list = string.match(/'\w+'/)[0].delete("''")
-        rescue StandardError
-          'Raise Exception'
-        end
-        string = string.split('!').last
-        if coordinates?(string)
-          coordinates.row = string.scan(/[0-9]/).join.to_i
-          coordinates.column = string.scan(/[A-Z]/).join
-        end
-        coordinates
-      end
-
       # Parse range of coordinates
       # @param arguments_string [String] data to parse
       # @return [Array] result
@@ -109,6 +92,18 @@ module OoxmlParser
       end
     end
 
+    # Parse string to coordinates
+    # @param [String] string to parse
+    # @return [Coordinates] result
+    def parse_string(string)
+      string = extract_list_from_string(string) if list_name_in_string?(string)
+      if Coordinates.coordinates?(string)
+        @row = string.scan(/\d/).join.to_i
+        @column = string.scan(/[A-Z]/).join
+      end
+      self
+    end
+
     # @return [Integer] number of column
     # This method takes @column string
     # and converts into integer
@@ -118,10 +113,6 @@ module OoxmlParser
       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
@@ -151,5 +142,23 @@ module OoxmlParser
     def ==(other)
       other.is_a?(Coordinates) ? (@row == other.row && @column == other.column) : false
     end
+
+    private
+
+    # Check if there is list name in string
+    # @param [String] string to check
+    # @return [Boolean] result
+    def list_name_in_string?(string)
+      string.include?('!')
+    end
+
+    # Extract list name and leave coordinates
+    # @param [String] string to parse
+    # @return [String] coordinates string without list
+    def extract_list_from_string(string)
+      split = string.split('!')
+      @list = split[0...-1].join('!')
+      split[-1]
+    end
   end
 end

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

@@ -43,14 +43,14 @@ module OoxmlParser
       node.attributes.each do |key, value|
         case key
         when 'location'
-          @url = Coordinates.parse_coordinates_from_string(value.value)
+          @url = Coordinates.new.parse_string(value.value)
         when 'id'
           @id = value.value
           @url = OOXMLDocumentObject.get_link_from_rels(@id) unless @id.empty?
         when 'tooltip'
           @tooltip = value.value
         when 'ref'
-          @coordinates = Coordinates.parse_coordinates_from_string(value.value)
+          @coordinates = Coordinates.new.parse_string(value.value)
         when 'action'
           @action_link = value.value
         when 'highlightClick'

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'filemagic' unless Gem.win_platform?
 require 'securerandom'
 require 'nokogiri'
 require 'zip'
+require 'ooxml_decrypt'
 require_relative 'ooxml_document_object/nokogiri_parsing_exception'
 require_relative 'ooxml_document_object/ooxml_document_object_helper'
 require_relative 'ooxml_document_object/ooxml_object_attribute_helper'
@@ -58,28 +58,6 @@ module OoxmlParser
       # @return [String] path to root folder
       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, 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`
-        # https://github.com/file/file/blob/master/ChangeLog#L217
-        if file_result.include?('encrypted') ||
-           file_result.include?('Composite Document File V2 Document, No summary info') ||
-           file_result.include?('application/CDFV2-corrupt')
-          warn("File #{path_to_file} is encrypted. Can't parse it")
-          return true
-        end
-        false
-      end
-
       # Copy this file and rename to zip
       # @param path [String] path to file
       # @return [String] path to result zip
@@ -95,6 +73,20 @@ module OoxmlParser
         file_path
       end
 
+      # Decrypt file protected with password
+      # @param path [String] path to file
+      # @param password [String] password to file
+      # @return [String] path to decrypted file
+      def decrypt_file(path, password)
+        file_name = File.basename(path)
+        tmp_folder = Dir.mktmpdir('ruby-ooxml-parser')
+        decrypted_path = "#{tmp_folder}/#{file_name}"
+        binary_password = password.encode('utf-16le').bytes.pack('c*').encode('binary')
+        OoxmlDecrypt::EncryptedFile.decrypt_to_file(path, binary_password, decrypted_path)
+
+        decrypted_path
+      end
+
       # Unzip specified file
       # @param path_to_file [String] path to zip file
       # @param destination [String] folder to extract

data/lib/ooxml_parser/common_parser/parser/encryption_checker.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Check if file is encrypted
+  class EncryptionChecker
+    def initialize(file_path, ignore_system: false)
+      @file_path = file_path
+      @ignore_system = ignore_system
+    end
+
+    # @return [Boolean] is file encrypted
+    def encrypted?
+      return false unless compatible_system?
+
+      # Support of Encrypted 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`
+      # https://github.com/file/file/blob/0eb7c1b83341cc954620b45d2e2d65ee7df1a4e7/ChangeLog#L623
+      if mime_type.include?('encrypted') ||
+         mime_type.include?('Composite Document File V2 Document, No summary info') ||
+         mime_type.include?('application/CDFV2-corrupt')
+        warn("File #{@file_path} is encrypted. Can't parse it")
+        return true
+      end
+      false
+    end
+
+    private
+
+    # Check if system is compatible with `file` utility
+    # @return [Boolean] Result of check
+    def compatible_system?
+      return true if !Gem.win_platform? && !@ignore_system
+
+      warn 'Checking file for encryption is not supported on Windows'
+      false
+    end
+
+    # @return [String] mime type of file
+    def mime_type
+      @mime_type ||= `file -b --mime "#{@file_path}"`
+    end
+  end
+end

data/lib/ooxml_parser/common_parser/parser.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'parser/encryption_checker'
+
 module OoxmlParser
   # Basic class for OoxmlParser
   class Parser
@@ -7,7 +9,7 @@ module OoxmlParser
     # @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)
+      return nil if EncryptionChecker.new(path_to_file).encrypted?
 
       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), '')
@@ -21,7 +23,8 @@ module OoxmlParser
     # Base method to parse document of any type
     # @param path_to_file [String] file
     # @return [CommonDocumentStructure] structure of doc
-    def self.parse(path_to_file)
+    def self.parse(path_to_file, password: nil)
+      path_to_file = OOXMLDocumentObject.decrypt_file(path_to_file, password) if password
       Parser.parse_format(path_to_file) do
         format = Parser.recognize_folder_format
         case format

data/lib/ooxml_parser/version.rb

@@ -4,6 +4,6 @@ module OoxmlParser
   # This module holds the RuboCop version information.
   module Version
     # [String] Version of Gem
-    STRING = '0.20.0'
+    STRING = '0.23.0'
   end
 end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/sheet.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing <sheet> tag
+  class Sheet < OOXMLDocumentObject
+    # @return [String] Name of sheet
+    attr_reader :name
+    # @return [Integer] SheetId of sheet
+    attr_reader :sheet_id
+    # @return [Symbol] Specifies if sheet is hidden
+    attr_reader :state
+    # @return [String] Id of sheet
+    attr_reader :id
+
+    def initialize(parent: nil)
+      @state = :visible
+      super
+    end
+
+    # Parse Sheet data
+    # @param [Nokogiri::XML:Element] node with Sheet data
+    # @return [Sheet] value of Sheet
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'name'
+          @name = value.value.to_s
+        when 'sheetId'
+          @sheet_id = value.value.to_i
+        when 'state'
+          @state = value.value.to_sym
+        when 'id'
+          @id = value.value.to_s
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/style_sheet/cell_xfs/cell_style/protection.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing <protection> tag
+  class Protection < OOXMLDocumentObject
+    # @return [True, False] Specifies if cell is locked
+    attr_reader :locked
+    # @return [True, False] Specifies if formulas in cell are hidden
+    attr_reader :hidden
+
+    def initialize(parent: nil)
+      @locked = true
+      @hidden = false
+      super
+    end
+
+    # Parse Protection data
+    # @param [Nokogiri::XML:Element] node with Protection data
+    # @return [Sheet] value of Protection
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'locked'
+          @locked = attribute_enabled?(value)
+        when 'hidden'
+          @hidden = attribute_enabled?(value)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/style_sheet/cell_xfs/xf.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'cell_style/alignment'
+require_relative 'cell_style/protection'
 module OoxmlParser
   # Class for parsing `xf` object
   class Xf < OOXMLDocumentObject
@@ -76,6 +77,8 @@ module OoxmlParser
     attr_reader :fill_id
     # @return [Integer] id of number format
     attr_reader :number_format_id
+    # @return [Protection] Settings of cell protection
+    attr_reader :protection
 
     def initialize(parent: nil)
       @numerical_format = 'General'
@@ -115,6 +118,8 @@ module OoxmlParser
         case node_child.name
         when 'alignment'
           @alignment.parse(node_child) if @apply_alignment
+        when 'protection'
+          @protection = Protection.new(parent: self).parse(node_child)
         end
       end
       self

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/workbook_protection.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing <workbookProtection> tag
+  class WorkbookProtection < OOXMLDocumentObject
+    # @return [True, False] Specifies if workbook structure is protected
+    attr_reader :lock_structure
+    # @return [String] name of hashing algorithm
+    attr_reader :workbook_algorithm_name
+    # @return [String] hash value for the password
+    attr_reader :workbook_hash_value
+    # @return [String] salt value for the password
+    attr_reader :workbook_salt_value
+    # @return [Integer] number of times the hashing function shall be iteratively run
+    attr_reader :workbook_spin_count
+
+    # Parse WorkbookProtection data
+    # @param [Nokogiri::XML:Element] node with WorkbookProtection data
+    # @return [Sheet] value of WorkbookProtection
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'lockStructure'
+          @lock_structure = attribute_enabled?(value)
+        when 'workbookAlgorithmName'
+          @workbook_algorithm_name = value.value.to_s
+        when 'workbookHashValue'
+          @workbook_hash_value = value.value.to_s
+        when 'workbookSaltValue'
+          @workbook_salt_value = value.value.to_s
+        when 'workbookSpinCount'
+          @workbook_spin_count = value.value.to_i
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/protected_range.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing <protectedRange> tag
+  class ProtectedRange < OOXMLDocumentObject
+    # @return [String] Name of hashing algorithm
+    attr_reader :algorithm_name
+    # @return [String] Hash value for the password
+    attr_reader :hash_value
+    # @return [String] Salt value for the password
+    attr_reader :salt_value
+    # @return [Integer] Number of times the hashing function shall be iteratively run
+    attr_reader :spin_count
+    # @return [String] Name of protected range
+    attr_accessor :name
+    # @return [String] Range reference
+    attr_reader :reference_sequence
+
+    # Parse ProtectedRange data
+    # @param [Nokogiri::XML:Element] node with ProtectedRange data
+    # @return [Sheet] value of ProtectedRange
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'algorithmName'
+          @algorithm_name = value.value.to_s
+        when 'hashValue'
+          @hash_value = value.value.to_s
+        when 'saltValue'
+          @salt_value = value.value.to_s
+        when 'spinCount'
+          @spin_count = value.value.to_i
+        when 'name'
+          @name = value.value.to_s
+        when 'sqref'
+          @reference_sequence = value.value.to_s
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/sheet_protection.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing <sheetProtection> tag
+  class SheetProtection < OOXMLDocumentObject
+    # @return [String] Name of hashing algorithm
+    attr_reader :algorithm_name
+    # @return [String] Hash value for the password
+    attr_reader :hash_value
+    # @return [String] Salt value for the password
+    attr_reader :salt_value
+    # @return [Integer] Number of times the hashing function shall be iteratively run
+    attr_reader :spin_count
+    # @return [True, False] Specifies if sheet is protected
+    attr_reader :sheet
+    # @return [True, False] Specifies if using autofilter is not allowed on protected sheet
+    attr_reader :auto_filter
+    # @return [True, False] Specifies if deleting columns is not allowed on protected sheet
+    attr_reader :delete_columns
+    # @return [True, False] Specifies if deleting rows is not allowed on protected sheet
+    attr_reader :delete_rows
+    # @return [True, False] Specifies if formatting cells is not allowed on protected sheet
+    attr_reader :format_cells
+    # @return [True, False] Specifies if formatting columns is not allowed on protected sheet
+    attr_reader :format_columns
+    # @return [True, False] Specifies if formatting rows is not allowed on protected sheet
+    attr_reader :format_rows
+    # @return [True, False] Specifies if inserting columns is not allowed on protected sheet
+    attr_reader :insert_columns
+    # @return [True, False] Specifies if inserting rows is not allowed on protected sheet
+    attr_reader :insert_rows
+    # @return [True, False] Specifies if inserting hyperlinks is not allowed on protected sheet
+    attr_reader :insert_hyperlinks
+    # @return [True, False] Specifies if editing objects is not allowed on protected sheet
+    attr_reader :objects
+    # @return [True, False] Specifies if using pivot tables is not allowed on protected sheet
+    attr_reader :pivot_tables
+    # @return [True, False] Specifies if editing scenarios is not allowed on protected sheet
+    attr_reader :scenarios
+    # @return [True, False] Specifies if selecting locked cells is not allowed on protected sheet
+    attr_reader :select_locked_cells
+    # @return [True, False] Specifies if selecting unlocked cells is not allowed on protected sheet
+    attr_reader :select_unlocked_cells
+    # @return [True, False] Specifies if sorting is not allowed on protected sheet
+    attr_reader :sort
+
+    def initialize(parent: nil)
+      @objects = false
+      @scenarios = false
+      @select_locked_cells = false
+      @select_unlocked_cells = false
+      @auto_filter = true
+      @delete_columns = true
+      @delete_rows = true
+      @format_cells = true
+      @format_columns = true
+      @format_rows = true
+      @insert_columns = true
+      @insert_rows = true
+      @insert_hyperlinks = true
+      @pivot_tables = true
+      @sort = true
+      super
+    end
+
+    # Parse SheetProtection data
+    # @param [Nokogiri::XML:Element] node with SheetProtection data
+    # @return [Sheet] value of SheetProtection
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'algorithmName'
+          @algorithm_name = value.value.to_s
+        when 'hashValue'
+          @hash_value = value.value.to_s
+        when 'saltValue'
+          @salt_value = value.value.to_s
+        when 'spinCount'
+          @spin_count = value.value.to_i
+        when 'sheet'
+          @sheet = attribute_enabled?(value)
+        when 'autoFilter'
+          @auto_filter = attribute_enabled?(value)
+        when 'deleteColumns'
+          @delete_columns = attribute_enabled?(value)
+        when 'deleteRows'
+          @delete_rows = attribute_enabled?(value)
+        when 'formatCells'
+          @format_cells = attribute_enabled?(value)
+        when 'formatColumns'
+          @format_columns = attribute_enabled?(value)
+        when 'formatRows'
+          @format_rows = attribute_enabled?(value)
+        when 'insertColumns'
+          @insert_columns = attribute_enabled?(value)
+        when 'insertRows'
+          @insert_rows = attribute_enabled?(value)
+        when 'insertHyperlinks'
+          @insert_hyperlinks = attribute_enabled?(value)
+        when 'objects'
+          @objects = attribute_enabled?(value)
+        when 'pivotTables'
+          @pivot_tables = attribute_enabled?(value)
+        when 'scenarios'
+          @scenarios = attribute_enabled?(value)
+        when 'selectLockedCells'
+          @select_locked_cells = attribute_enabled?(value)
+        when 'selectUnlockedCells'
+          @select_unlocked_cells = attribute_enabled?(value)
+        when 'sort'
+          @sort = attribute_enabled?(value)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/sheet_view/pane.rb

@@ -14,7 +14,7 @@ module OoxmlParser
         when 'state'
           @state = value.value.to_sym
         when 'topLeftCell'
-          @top_left_cell = Coordinates.parse_coordinates_from_string(value.value)
+          @top_left_cell = Coordinates.new.parse_string(value.value)
         when 'xSplit'
           @x_split = value.value
         when 'ySplit'

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/sheet_view/selection.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for `selection` data
+  class Selection < OOXMLDocumentObject
+    # @return [Coordinates] Reference to the active cell
+    attr_reader :active_cell
+    # @return [Integer] Id of active cell
+    attr_reader :active_cell_id
+    # @return [String] Selected range
+    attr_reader :reference_sequence
+
+    # Parse Selection object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [Selection] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'activeCell'
+          @active_cell = Coordinates.new.parse_string(value.value)
+        when 'activeCellId'
+          @active_cell_id = value.value.to_i
+        when 'sqref'
+          @reference_sequence = value.value.to_s
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/sheet_view.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'sheet_view/pane'
+require_relative 'sheet_view/selection'
 module OoxmlParser
   # Class for `sheetView` data
   class SheetView < OOXMLDocumentObject
@@ -9,6 +10,14 @@ module OoxmlParser
     attr_accessor :show_gridlines
     # @return [True, False] Flag indicating whether the sheet should display row and column headings.
     attr_accessor :show_row_column_headers
+    # @return [Coordinates] Reference to the top left cell
+    attr_reader :top_left_cell
+    # @return [Integer] Id of workbook view
+    attr_reader :workbook_view_id
+    # @return [Integer] Zoom scale
+    attr_reader :zoom_scale
+    # @return [Selection] Properties of selection
+    attr_reader :selection
 
     def initialize(parent: nil)
       @show_gridlines = true
@@ -20,12 +29,18 @@ module OoxmlParser
     # @param node [Nokogiri::XML:Element] node to parse
     # @return [SheetView] result of parsing
     def parse(node)
-      node.attributes.each_key do |key|
+      node.attributes.each do |key, value|
         case key
         when 'showGridLines'
-          @show_gridlines = attribute_enabled?(node, key)
+          @show_gridlines = attribute_enabled?(value)
         when 'showRowColHeaders'
-          @show_row_column_headers = attribute_enabled?(node, key)
+          @show_row_column_headers = attribute_enabled?(value)
+        when 'topLeftCell'
+          @top_left_cell = Coordinates.new.parse_string(value.value)
+        when 'workbookViewId'
+          @workbook_view_id = value.value.to_i
+        when 'zoomScale'
+          @zoom_scale = value.value.to_i
         end
       end
 
@@ -33,6 +48,8 @@ module OoxmlParser
         case node_child.name
         when 'pane'
           @pane = Pane.new(parent: self).parse(node_child)
+        when 'selection'
+          @selection = Selection.new(parent: self).parse(node_child)
         end
       end
       self

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/xlsx_drawing/client_data.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing <clientData> tag
+  class ClientData < OOXMLDocumentObject
+    # @return [True, False] Specifies if drawing is locked when sheet is protected
+    attr_reader :locks_with_sheet
+
+    def initialize(parent: nil)
+      @locks_with_sheet = true
+      super
+    end
+
+    # Parse ClientData data
+    # @param [Nokogiri::XML:Element] node with ClientData data
+    # @return [Sheet] value of ClientData
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'fLocksWithSheet'
+          @locks_with_sheet = attribute_enabled?(value)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/xlsx_drawing.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'xlsx_drawing/xlsx_drawing_position_parameters'
+require_relative 'xlsx_drawing/client_data'
 module OoxmlParser
   # Data of spreadsheet drawing
   class XlsxDrawing < OOXMLDocumentObject
@@ -11,6 +12,8 @@ module OoxmlParser
     attr_accessor :to
     # @return [GraphicFrame] graphic frame
     attr_accessor :graphic_frame
+    # @return [ClientData] client data
+    attr_accessor :client_data
 
     # Parse XlsxDrawing object
     # @param node [Nokogiri::XML:Element] node to parse
@@ -32,6 +35,8 @@ module OoxmlParser
           @graphic_frame = GraphicFrame.new(parent: self).parse(child_node)
         when 'cxnSp'
           @shape = ConnectionShape.new(parent: self).parse(child_node)
+        when 'clientData'
+          @client_data = ClientData.new(parent: self).parse(child_node)
         end
       end
       self

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/xlsx_row.rb

@@ -34,7 +34,7 @@ module OoxmlParser
       node.xpath('*').each do |node_child|
         case node_child.name
         when 'c'
-          @cells[Coordinates.parse_coordinates_from_string(node_child.attribute('r').value.to_s).column_number.to_i - 1] = XlsxCell.new(parent: self).parse(node_child)
+          @cells[Coordinates.new.parse_string(node_child.attribute('r').value.to_s).column_number.to_i - 1] = XlsxCell.new(parent: self).parse(node_child)
         end
       end
       self

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet.rb

@@ -11,6 +11,8 @@ require_relative 'worksheet/xlsx_column_properties'
 require_relative 'worksheet/xlsx_drawing'
 require_relative 'worksheet/xlsx_row'
 require_relative 'worksheet/xlsx_header_footer'
+require_relative 'worksheet/sheet_protection'
+require_relative 'worksheet/protected_range'
 module OoxmlParser
   # Properties of worksheet
   class Worksheet < OOXMLDocumentObject
@@ -33,6 +35,10 @@ module OoxmlParser
     attr_reader :header_footer
     # @return [Array<ConditionalFormatting>] list of conditional formattings
     attr_reader :conditional_formattings
+    # @return [SheetProtection] protection of sheet
+    attr_reader :sheet_protection
+    # @return [Array<ProtectedRange>] list of protected ranges
+    attr_reader :protected_ranges
 
     def initialize(parent: nil)
       @columns = []
@@ -45,6 +51,7 @@ module OoxmlParser
       @sheet_views = []
       @table_parts = []
       @conditional_formattings = []
+      @protected_ranges = []
       super
     end
 
@@ -134,6 +141,12 @@ module OoxmlParser
           @header_footer = XlsxHeaderFooter.new(parent: self).parse(worksheet_node_child)
         when 'conditionalFormatting'
           @conditional_formattings << ConditionalFormatting.new(parent: self).parse(worksheet_node_child)
+        when 'sheetProtection'
+          @sheet_protection = SheetProtection.new(parent: self).parse(worksheet_node_child)
+        when 'protectedRanges'
+          worksheet_node_child.xpath('*').each do |protected_range_node|
+            @protected_ranges << ProtectedRange.new(parent: self).parse(protected_range_node)
+          end
         end
       end
       parse_comments

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook.rb

@@ -4,15 +4,19 @@ require_relative 'workbook/chartsheet'
 require_relative 'workbook/pivot_cache'
 require_relative 'workbook/pivot_table_definition'
 require_relative 'workbook/defined_name'
+require_relative 'workbook/workbook_protection'
 require_relative 'workbook/shared_string_table'
 require_relative 'workbook/style_sheet'
 require_relative 'workbook/worksheet'
+require_relative 'workbook/sheet'
 require_relative 'workbook/workbook_helpers'
 module OoxmlParser
   # Class for storing XLSX Workbook
   class XLSXWorkbook < CommonDocumentStructure
     include WorkbookHelpers
     attr_accessor :worksheets
+    # @return [Array<Sheet>] list of sheets
+    attr_reader :sheets
     # @return [PresentationTheme] theme of Workbook
     attr_accessor :theme
     # @return [Relationships] rels of book
@@ -27,9 +31,12 @@ module OoxmlParser
     attr_accessor :pivot_table_definitions
     # @return [Array<DefinedName>] list of defined names
     attr_reader :defined_names
+    # @return [WorkbookProtection] protection of workbook structure
+    attr_reader :workbook_protection
 
     def initialize(params = {})
       @worksheets = []
+      @sheets = []
       @pivot_caches = []
       @pivot_table_definitions = []
       @defined_names = []
@@ -119,10 +126,11 @@ module OoxmlParser
       @theme = PresentationTheme.parse("xl/#{link_to_theme_xml}") if link_to_theme_xml
       @style_sheet = StyleSheet.new(parent: self).parse
       @doc.xpath('xmlns:workbook/xmlns:sheets/xmlns:sheet').each do |sheet|
+        @sheets << Sheet.new(parent: self).parse(sheet)
         file = @relationships.target_by_id(sheet.attribute('id').value)
         if file.start_with?('worksheets')
           @worksheets << Worksheet.new(parent: self).parse(file)
-          @worksheets.last.name = sheet.attribute('name').value
+          @worksheets.last.name = @sheets.last.name
         elsif file.start_with?('chartsheets')
           @worksheets << Chartsheet.new(parent: self).parse(file)
         end
@@ -130,6 +138,7 @@ module OoxmlParser
       parse_pivot_cache
       parse_pivot_table
       parse_defined_names
+      parse_workbook_protection
       OOXMLDocumentObject.xmls_stack.pop
       self
     end
@@ -161,5 +170,13 @@ module OoxmlParser
         @defined_names << DefinedName.new(parent: self).parse(defined_name)
       end
     end
+
+    # Perform parsing of workbook protection
+    def parse_workbook_protection
+      workbook_protection = @doc.search('//xmlns:workbookProtection').first
+      return nil unless workbook_protection
+
+      @workbook_protection = WorkbookProtection.new(parent: self).parse(workbook_protection)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ooxml_parser
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.23.0
 platform: ruby
 authors:
 - ONLYOFFICE
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-18 00:00:00.000000000 Z
+date: 2022-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -27,19 +27,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
-  name: ruby-filemagic
+  name: ooxml_decrypt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -250,10 +250,8 @@ files:
 - lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/docx_shape/non_visual_shape_properties/non_visual_properties/shape_placeholder.rb
 - lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/docx_shape/ooxml_text_box.rb
 - lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/docx_shape/shape_style.rb
-- lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/docx_shape/shape_style/effect_reference.rb
-- lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/docx_shape/shape_style/fill_reference.rb
 - lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/docx_shape/shape_style/font_reference.rb
-- lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/docx_shape/shape_style/line_reference.rb
+- lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/docx_shape/shape_style/style_matrix_reference.rb
 - lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/docx_shape/text_body.rb
 - lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/shape_body_properties/ooxml_shape_body_properties.rb
 - lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/shape_body_properties/ooxml_shape_body_properties/preset_text_warp.rb
@@ -360,6 +358,7 @@ files:
 - lib/ooxml_parser/common_parser/common_data/valued_child.rb
 - lib/ooxml_parser/common_parser/common_document_structure.rb
 - lib/ooxml_parser/common_parser/parser.rb
+- lib/ooxml_parser/common_parser/parser/encryption_checker.rb
 - lib/ooxml_parser/configuration.rb
 - lib/ooxml_parser/docx_parser/docx_data/document_structure.rb
 - lib/ooxml_parser/docx_parser/docx_data/document_structure/comments.rb
@@ -510,9 +509,11 @@ files:
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/pivot_table_definition/pivot_table_style_info.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/shared_string_table.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/shared_string_table/string_index.rb
+- lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/sheet.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/style_sheet.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/style_sheet/cell_xfs.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/style_sheet/cell_xfs/cell_style/alignment.rb
+- lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/style_sheet/cell_xfs/cell_style/protection.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/style_sheet/cell_xfs/xf.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/style_sheet/differential_formatting_records.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/style_sheet/fills.rb
@@ -525,6 +526,7 @@ files:
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/style_sheet/xlsx_borders.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/style_sheet/xlsx_borders/xlsx_border.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/workbook_helpers.rb
+- lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/workbook_protection.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/excel_comments.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/excel_comments/author.rb
@@ -532,9 +534,12 @@ files:
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/excel_comments/excel_comment.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/ole_objects.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/page_setup.rb
+- lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/protected_range.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/sheet_format_properties.rb
+- lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/sheet_protection.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/sheet_view.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/sheet_view/pane.rb
+- lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/sheet_view/selection.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part/autofilter.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part/autofilter/filter_column.rb
@@ -563,6 +568,7 @@ files:
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/worksheet_helper.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/xlsx_column_properties.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/xlsx_drawing.rb
+- lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/xlsx_drawing/client_data.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/xlsx_drawing/xlsx_drawing_position_parameters.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/xlsx_header_footer.rb
 - lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/xlsx_header_footer/header_footer_child.rb
@@ -588,14 +594,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.29
+rubygems_version: 3.3.12
 signing_key: 
 specification_version: 4
 summary: OoxmlParser Gem

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/docx_shape/shape_style/fill_reference.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module OoxmlParser
-  # Class for parsing `a:fillRef` tags
-  class FillReference < OOXMLDocumentObject
-    # @return [Integer] Style Matrix Index
-    attr_reader :index
-    # @return [Color] scheme color of FillReference
-    attr_reader :scheme_color
-
-    # Parse FillReference object
-    # @param node [Nokogiri::XML:Element] node to parse
-    # @return [FillReference] result of parsing
-    def parse(node)
-      node.attributes.each do |key, value|
-        case key
-        when 'idx'
-          @index = value.value.to_f
-        end
-      end
-
-      node.xpath('*').each do |node_child|
-        case node_child.name
-        when 'schemeClr'
-          @scheme_color = Color.new(parent: self).parse_scheme_color(node_child)
-        end
-      end
-      self
-    end
-  end
-end

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/docx_shape/shape_style/line_reference.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module OoxmlParser
-  # Class for parsing `a:lnRef` tags
-  class LineReference < OOXMLDocumentObject
-    # @return [Integer] Style Matrix Index
-    attr_reader :index
-    # @return [Color] scheme color of LineReference
-    attr_reader :scheme_color
-
-    # Parse LineReference object
-    # @param node [Nokogiri::XML:Element] node to parse
-    # @return [LineReference] result of parsing
-    def parse(node)
-      node.attributes.each do |key, value|
-        case key
-        when 'idx'
-          @index = value.value.to_f
-        end
-      end
-
-      node.xpath('*').each do |node_child|
-        case node_child.name
-        when 'schemeClr'
-          @scheme_color = Color.new(parent: self).parse_scheme_color(node_child)
-        end
-      end
-      self
-    end
-  end
-end