ooxml_parser 0.3.0 → 0.6.0

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

@@ -1,41 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'excel_comments/author'
+require_relative 'excel_comments/comment_list'
 require_relative 'excel_comments/excel_comment'
-# All Comments of single XLSX
 module OoxmlParser
-  class ExcelComments
-    attr_accessor :authors, :comments
+  # All Comments of single XLSX
+  class ExcelComments < OOXMLDocumentObject
+    attr_accessor :authors
+    # @return [CommentList] list of comments
+    attr_reader :comment_list
+
+    def initialize(parent: nil)
+      @authors = []
+      @comment_list = []
+      @parent = parent
+    end
 
-    def initialize(authors = [], comments = [])
-      @authors = authors
-      @comments = comments
+    def comments
+      comment_list.comments
     end
 
-    def self.parse(file)
-      doc = Nokogiri::XML(File.open(file))
-      excel_comments = ExcelComments.new
-      comments_node = doc.search('//xmlns:comments').first
-      comments_node.xpath('*').each do |comments_node_child|
-        case comments_node_child.name
+    extend Gem::Deprecate
+    deprecate :comments, 'comment_list.comments', 2020, 1
+
+    def parse(file)
+      doc = parse_xml(file)
+      node = doc.xpath('*').first
+      node.xpath('*').each do |node_child|
+        case node_child.name
         when 'authors'
-          comments_node_child.xpath('xmlns:author').each do |author_node|
-            excel_comments.authors << author_node.text
-          end
+          @authors << Author.new(parent: self).parse(node_child)
         when 'commentList'
-          comments_node_child.xpath('xmlns:comment').each do |comment_node|
-            excel_comments.comments << ExcelComment.new(parent: excel_comments).parse(comment_node)
-          end
+          @comment_list = CommentList.new(parent: self).parse(node_child)
         end
       end
-      excel_comments
-    end
-
-    def self.parse_file(file_name, path_to_folder)
-      file = path_to_folder + "xl/worksheets/_rels/#{file_name}.rels"
-      return nil unless File.exist?(file)
-      relationships = Relationships.parse_rels(file)
-      target = relationships.target_by_type('comment')
-      return if target.nil?
-      comment_file = "#{OOXMLDocumentObject.path_to_folder}/#{OOXMLDocumentObject.root_subfolder}/#{target.gsub('..', '')}"
-      ExcelComments.parse(comment_file)
+      self
     end
   end
 end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Single author `author`
+  class Author < OOXMLDocumentObject
+    attr_reader :name
+
+    # Parse Author object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [Author] result of parsing
+    def parse(node)
+      @name = node.text
+      self
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Single author `commentList`
+  class CommentList < OOXMLDocumentObject
+    attr_reader :comments
+
+    def initialize(parent: nil)
+      @comments = []
+      @parent = parent
+    end
+
+    # Parse Author object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [CommentList] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'comment'
+          @comments << ExcelComment.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Single Comment of XLSX
   class ExcelComment < OOXMLDocumentObject
     attr_accessor :characters
+    # @return [String] text of comment
+    attr_reader :text
 
     def initialize(parent: nil)
       @characters = []
@@ -15,6 +19,12 @@ module OoxmlParser
       node.xpath('xmlns:text/xmlns:r').each do |node_child|
         @characters << ParagraphRun.new(parent: self).parse(node_child)
       end
+      node.xpath('xmlns:text/*').each do |node_child|
+        case node_child.name
+        when 't'
+          @text = Text.new(parent: self).parse(node_child)
+        end
+      end
       self
     end
   end

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

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

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

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing `pageSetup` tag
+  class PageSetup < OOXMLDocumentObject
+    # @return [Integer] id of paper size
+    attr_reader :paper_size
+    # @return [Symbol] orientation of page
+    attr_reader :orientation
+
+    # Parse PageSetup object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [PageSetup] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'paperSize'
+          @paper_size = value.value.to_i
+        when 'orientation'
+          @orientation = value_to_symbol(value)
+        end
+      end
+      self
+    end
+
+    # @return [String] name of paper size
+    def paper_size_name
+      paper_size_names_list[@paper_size]
+    end
+
+    private
+
+    # @return [Array <String>] list of paper size names
+    # https://msdn.microsoft.com/en-us/library/documentformat.openxml.spreadsheet.pagesetup.aspx
+    def paper_size_names_list
+      ['Default',
+       'US Letter',
+       'US Letter small',
+       'Tabloid',
+       'Ledger',
+       'US Legal',
+       'Statement',
+       'Executive',
+       'A3',
+       'A4',
+       'A4 small',
+       'A5',
+       'B4',
+       'B5',
+       'Folio',
+       'Quarto',
+       'Standard',
+       'Standard',
+       'Note',
+       'Envelope #9',
+       'Envelope #10',
+       'Envelope #11',
+       'Envelope #12',
+       'Envelope #14',
+       'C paper',
+       'D paper',
+       'E paper',
+       'Envelope DL',
+       'Envelope C5',
+       'Envelope C3',
+       'Envelope C4',
+       'Envelope C6',
+       'Envelope C65',
+       'Envelope B4',
+       'Envelope B5',
+       'Envelope B6',
+       'Italy envelope',
+       'Monarch envelope',
+       '6 3/4 envelope',
+       'US standard fanfold',
+       'German standard fanfold',
+       'German legal fanfold',
+       'B4',
+       'Japanese double postcard ',
+       'Standard',
+       'Standard',
+       'Standard',
+       'Invite envelope',
+       'Letter oversize',
+       'Legal oversize',
+       'Tabloid oversize',
+       'A4 oversize',
+       'Letter transverse paper',
+       'A4 transverse paper',
+       'Letter extra transverse paper',
+       'SuperA/SuperA/A4 paper',
+       'SuperB/SuperB/A3 paper',
+       'Letter plus paper',
+       'A4 plus paper',
+       'A5 transverse paper',
+       'JIS B5 transverse paper',
+       'A3 oversize',
+       'A5 oversize ',
+       'B5 oversize',
+       'A2 paper',
+       'A3 transverse paper',
+       'A3 extra transverse paper']
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for storing SheetFormatProperties
   class SheetFormatProperties < OOXMLDocumentObject

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'sheet_view/pane'
 module OoxmlParser
   # Class for `sheetView` data

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for `pane` data
   class Pane < OOXMLDocumentObject

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

@@ -1,12 +1,17 @@
+# frozen_string_literal: true
+
 require_relative 'table_part/autofilter'
 require_relative 'table_part/extension_list'
 require_relative 'table_part/table_style_info'
+require_relative 'table_part/table_columns'
 module OoxmlParser
   # Class for `tablePart` data
   class TablePart < OOXMLDocumentObject
     attr_accessor :name, :display_name, :reference, :autofilter, :columns
     # @return [ExtensionList] list of extensions
     attr_accessor :extension_list
+    # @return [TableColumns] list of table columns
+    attr_reader :table_columns
     # @return [TableStyleInfo] describe style of table
     attr_accessor :table_style_info
 
@@ -15,7 +20,7 @@ module OoxmlParser
     # @return [TablePart] result of parsing
     def parse(node)
       link_to_table_part_xml = OOXMLDocumentObject.get_link_from_rels(node.attribute('id').value)
-      doc = Nokogiri::XML(File.open(OOXMLDocumentObject.path_to_folder + link_to_table_part_xml.gsub('..', 'xl')))
+      doc = parse_xml(OOXMLDocumentObject.path_to_folder + link_to_table_part_xml.gsub('..', 'xl'))
       table_node = doc.xpath('xmlns:table').first
       table_node.attributes.each do |key, value|
         case key
@@ -33,6 +38,8 @@ module OoxmlParser
           @autofilter = Autofilter.new(parent: self).parse(node_child)
         when 'extLst'
           @extension_list = ExtensionList.new(parent: self).parse(node_child)
+        when 'tableColumns'
+          @table_columns = TableColumns.new(parent: self).parse(node_child)
         when 'tableStyleInfo'
           @table_style_info = TableStyleInfo.new(parent: self).parse(node_child)
         end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'autofilter/filter_column'
 module OoxmlParser
   # Class for `autoFilter` data

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part/autofilter/filter_column.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'filter_column/custom_filters'
 module OoxmlParser
   # Class for `filterColumn` data
   # The filterColumn collection identifies a particular
@@ -6,6 +9,8 @@ module OoxmlParser
   class FilterColumn < OOXMLDocumentObject
     # @return [True, False] Flag indicating whether the filter button is visible.
     attr_accessor :show_button
+    # @return [CustomFilters] list of filters
+    attr_reader :custom_filters
 
     def initialize(parent: nil)
       @show_button = true
@@ -22,6 +27,13 @@ module OoxmlParser
           @show_button = attribute_enabled?(value)
         end
       end
+
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'customFilters'
+          @custom_filters = CustomFilters.new(parent: self).parse(node_child)
+        end
+      end
       self
     end
   end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part/autofilter/filter_column/custom_filters.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'custom_filters/custom_filter'
+module OoxmlParser
+  # Class for `CustomFilters` data
+  class CustomFilters < OOXMLDocumentObject
+    # @return [Integer] and value
+    attr_reader :and
+    # @return [Array<CustomFilter>] list of filters array
+    attr_reader :filters_array
+
+    def initialize(parent: nil)
+      @filters_array = []
+      @parent = parent
+    end
+
+    # @return [Array, CustomFilter] accessor
+    def [](key)
+      @filters_array[key]
+    end
+
+    # Parse CustomFilters data
+    # @param [Nokogiri::XML:Element] node with CustomFilters data
+    # @return [CustomFilters] value of CustomFilters data
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'and'
+          @and = value.value.to_i
+        end
+      end
+
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'customFilter'
+          @filters_array << CustomFilter.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part/autofilter/filter_column/custom_filters/custom_filter.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for `CustomFilter` data
+  class CustomFilter < OOXMLDocumentObject
+    # @return [Symbol] operator for filter
+    attr_reader :operator
+    # @return [Integer] value of filter
+    attr_reader :value
+
+    # Parse CustomFilter data
+    # @param [Nokogiri::XML:Element] node with CustomFilter data
+    # @return [CustomFilter] value of CustomFilter data
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'operator'
+          @operator = value_to_symbol(value)
+        when 'val'
+          @value = value.value.to_i
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'extension_list/extension'
 module OoxmlParser
   # Class for `extLst` data

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part/extension_list/extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'extension/sparkline_groups'
 require_relative 'extension/x14_table'
 module OoxmlParser

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part/extension_list/extension/sparkline_groups.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'sparkline_groups/sparkline_group'
 module OoxmlParser
   # Class for `sparklineGroups` data
@@ -10,7 +12,7 @@ module OoxmlParser
       @parent = parent
     end
 
-    # @return [Array, SparklineGroups] accessor
+    # @return [SparklineGroup] accessor
     def [](key)
       sparklines_groups[key]
     end

data/lib/ooxml_parser/xlsx_parser/xlsx_data/view_model/workbook/worksheet/table_part/extension_list/extension/sparkline_groups/sparkline_group.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for `sparklineGroup` data
   class SparklineGroup < OOXMLDocumentObject