ooxml_parser 0.14.1-mingw32

data/lib/ooxml_parser/docx_parser/docx_parser.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../common_parser/common_data/ooxml_document_object'
+require_relative '../common_parser/common_data/valued_child'
+require_relative 'docx_data/document_structure'
+
+module OoxmlParser
+  # Basic class for DocxParser
+  class DocxParser
+    # Parse docx file
+    # @param path_to_file [String] file path
+    # @return [DocumentStructure] result of parse
+    def self.parse_docx(path_to_file)
+      Parser.parse_format(path_to_file) do
+        DocumentStructure.parse
+      end
+    end
+  end
+end

data/lib/ooxml_parser/helpers/string_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for working with strings
+  class StringHelper
+    class << self
+      # This method check if string contains numeric
+      # @return [True, False] result of comparison
+      def numeric?(string)
+        true if Float(string)
+      rescue ArgumentError
+        false
+      end
+
+      # Check if string is complex number
+      # @return [True, False] result of comparison
+      def complex?(string)
+        true if Complex(string.tr(',', '.'))
+      rescue ArgumentError
+        false
+      end
+    end
+  end
+end

data/lib/ooxml_parser/name.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # This module holds name of product
+  module Name
+    # [String] name of the gem
+    STRING = 'ooxml_parser'
+  end
+end

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/comment_authors/comment_author.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing `cmAuthor` tag
+  class CommentAuthor < OOXMLDocumentObject
+    # @return [Integer] Comment Author ID
+    attr_reader :id
+    # @return [String] Author Name
+    attr_reader :name
+    # @return [String] Author Initials
+    attr_reader :initials
+    # @return [Integer] Index of Comment Author's last comment
+    attr_reader :last_index
+    # @return [Integer] Comment Author Color Index
+    attr_reader :color_index
+
+    # Parse CommentAuthor object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [CommentAuthor] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'id'
+          @id = value.value.to_i
+        when 'name'
+          @name = value.value.to_s
+        when 'initials'
+          @initials = value.value.to_s
+        when 'lastIdx'
+          @last_index = value.value.to_i
+        when 'clrIdx'
+          @color_index = value.value.to_i
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/comment_authors.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'comment_authors/comment_author'
+module OoxmlParser
+  # Class for parsing `commentAuthors.xml` file
+  class CommentAuthors < OOXMLDocumentObject
+    # @return [Array<CommentAuthor>] list of comment authors
+    attr_reader :list
+
+    def initialize(parent: nil)
+      @list = []
+      super
+    end
+
+    # Parse CommentAuthors object
+    # @param file [Nokogiri::XML:Element] node to parse
+    # @return [CommentAuthors] result of parsing
+    def parse(file = "#{OOXMLDocumentObject.path_to_folder}/#{OOXMLDocumentObject.root_subfolder}/commentAuthors.xml")
+      return nil unless File.exist?(file)
+
+      document = parse_xml(File.open(file))
+      node = document.xpath('*').first
+
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'cmAuthor'
+          @list << CommentAuthor.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+
+    # @param id [Integer] id of author
+    # @return [CommentAuthor] author by id
+    def author_by_id(id)
+      list.detect { |author| author.id == id }
+    end
+  end
+end

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/presentation_comments/presentation_comment.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing `p:cm` tag
+  class PresentationComment < OOXMLDocumentObject
+    # @return [Integer] id of author
+    attr_reader :author_id
+    # @return [OOXMLCoordinates] position of comment
+    attr_reader :position
+    # @return [String] text of comment
+    attr_reader :text
+
+    # @return [CommentAuthor] author of comment
+    def author
+      root_object.comment_authors.author_by_id(@author_id)
+    end
+
+    # Parse PresentationComment object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [PresentationComment] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'authorId'
+          @author_id = value.value.to_i
+        end
+      end
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'pos'
+          @position = OOXMLCoordinates.parse(node_child, x_attr: 'x', y_attr: 'y')
+        when 'text'
+          @text = node_child.text.to_s
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/presentation_comments.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'presentation_comments/presentation_comment'
+module OoxmlParser
+  # Class for parsing `comment1.xml` file
+  class PresentationComments < OOXMLDocumentObject
+    # @return [Array<PresentationComment>] list of comments
+    attr_reader :list
+
+    def initialize(parent: nil)
+      @list = []
+      super
+    end
+
+    # Parse PresentationComments object
+    # @param file [Nokogiri::XML:Element] node to parse
+    # @return [PresentationComments] result of parsing
+    def parse(file = "#{OOXMLDocumentObject.path_to_folder}/#{OOXMLDocumentObject.root_subfolder}/comments/comment1.xml")
+      return nil unless File.exist?(file)
+
+      document = parse_xml(File.open(file))
+      node = document.xpath('*').first
+
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'cm'
+          @list << PresentationComment.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/presentation_helpers.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # method to help to work with Presentation
+  module PresentationHelpers
+    # @return [True, false] if structure contain any user data
+    def with_data?
+      return true if @slides.length > 1
+
+      @slides.each do |current_slide|
+        return true if current_slide.with_data?
+      end
+      false
+    end
+  end
+end

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/presentation_theme/font_scheme/font_collection/text_font.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing `a:latin`, `a:ea`, `a:cs` tag
+  class TextFont < OOXMLDocumentObject
+    # @return [String] typeface of font
+    attr_reader :typeface
+
+    # Parse TextFont object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [TextFont] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'typeface'
+          @typeface = value.value.to_s
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/presentation_theme/font_scheme/font_collection.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'font_collection/text_font'
+module OoxmlParser
+  # Class for parsing `a:majorFont`, `a:minorFont` tag
+  class FontCollection < OOXMLDocumentObject
+    # @return [TextFont] latin text font
+    attr_reader :latin
+    # @return [TextFont] east asian text font
+    attr_reader :east_asian
+    # @return [TextFont] complex script text font
+    attr_reader :complex_script
+
+    # Parse FontCollection object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [FontCollection] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'latin'
+          @latin = TextFont.new(parent: self).parse(node_child)
+        when 'ea'
+          @east_asian = TextFont.new(parent: self).parse(node_child)
+        when 'cs'
+          @complex_script = TextFont.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/presentation_theme/font_scheme.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'font_scheme/font_collection'
+module OoxmlParser
+  # Class for parsing `fontScheme` tag
+  class FontScheme < OOXMLDocumentObject
+    # @return [String] name of font
+    attr_reader :name
+    # @return [FontCollection] major font data
+    attr_reader :major_font
+    # @return [FontCollection] minor font data
+    attr_reader :minor_font
+
+    # Parse FontScheme object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [FontScheme] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'name'
+          @name = value.value.to_s
+        end
+      end
+
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'majorFont'
+          @major_font = FontCollection.new(parent: self).parse(node_child)
+        when 'minorFont'
+          @minor_font = FontCollection.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/presentation_theme/theme_color.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing ThemeColor tags
+  class ThemeColor < OOXMLDocumentObject
+    attr_accessor :type, :value, :color
+
+    def initialize(type: '', color: nil, parent: nil)
+      @type = type
+      @color = color
+      super(parent: parent)
+    end
+
+    # Compare ThemeColor with other object
+    # @param other [Object] object to compare
+    # @return [True, False] result of comparision
+    def ==(other)
+      if other.is_a?(Color)
+        @color == other
+      else
+        all_instance_variables = instance_variables
+        all_instance_variables.each do |current_attributes|
+          return false unless instance_variable_get(current_attributes) == other.instance_variable_get(current_attributes)
+        end
+        true
+      end
+    end
+
+    # Parse ThemeColor
+    # @param node [Nokogiri::XML::Element] node to parse
+    # @return [ThemeColor] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'sysClr'
+          @type = :system
+          @value = node_child.attribute('val').value
+          @color = Color.new(parent: self).parse_hex_string(node_child.attribute('lastClr').value.to_s) unless node_child.attribute('lastClr').nil?
+        when 'srgbClr'
+          @type = :rgb
+          @color = Color.new(parent: self).parse_hex_string(node_child.attribute('val').value.to_s)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/presentation_theme.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative 'presentation_theme/font_scheme'
+require_relative 'presentation_theme/theme_color'
+module OoxmlParser
+  # Class for data for PresentationTheme
+  class PresentationTheme < OOXMLDocumentObject
+    attr_accessor :name, :color_scheme
+    # @return [FontScheme] font scheme
+    attr_accessor :font_scheme
+
+    def initialize(name = '', color_scheme = {})
+      @name = name
+      @color_scheme = color_scheme
+      super(parent: nil)
+    end
+
+    # Parse PresentationTheme
+    # @param file [String] path to file to parse
+    # @return [PresentationTheme] result of parsing
+    def self.parse(file)
+      OOXMLDocumentObject.theme = PresentationTheme.new
+      OOXMLDocumentObject.add_to_xmls_stack(file)
+      unless File.exist?(OOXMLDocumentObject.current_xml)
+        OOXMLDocumentObject.xmls_stack.pop
+        return
+      end
+      doc = OOXMLDocumentObject.theme.parse_xml(OOXMLDocumentObject.current_xml)
+      doc.xpath('a:theme').each do |theme_node|
+        OOXMLDocumentObject.theme.name = theme_node.attribute('name').value if theme_node.attribute('name')
+        theme_node.xpath('a:themeElements/*').each do |theme_element_node|
+          case theme_element_node.name
+          when 'clrScheme'
+            theme_element_node.xpath('*').each do |color_scheme_element|
+              OOXMLDocumentObject.theme.color_scheme[color_scheme_element.name.to_sym] = ThemeColor.new.parse(color_scheme_element)
+            end
+            OOXMLDocumentObject.theme.color_scheme[:background1] = OOXMLDocumentObject.theme.color_scheme[:lt1]
+            OOXMLDocumentObject.theme.color_scheme[:background2] = OOXMLDocumentObject.theme.color_scheme[:lt2]
+            OOXMLDocumentObject.theme.color_scheme[:bg1] = OOXMLDocumentObject.theme.color_scheme[:lt1]
+            OOXMLDocumentObject.theme.color_scheme[:bg2] = OOXMLDocumentObject.theme.color_scheme[:lt2]
+            OOXMLDocumentObject.theme.color_scheme[:text1] = OOXMLDocumentObject.theme.color_scheme[:dk1]
+            OOXMLDocumentObject.theme.color_scheme[:text2] = OOXMLDocumentObject.theme.color_scheme[:dk2]
+            OOXMLDocumentObject.theme.color_scheme[:tx1] = OOXMLDocumentObject.theme.color_scheme[:dk1]
+            OOXMLDocumentObject.theme.color_scheme[:tx2] = OOXMLDocumentObject.theme.color_scheme[:dk2]
+          when 'fontScheme'
+            OOXMLDocumentObject.theme.font_scheme = FontScheme.new(parent: self).parse(theme_element_node)
+          end
+        end
+      end
+      OOXMLDocumentObject.xmls_stack.pop
+      OOXMLDocumentObject.theme
+    end
+  end
+end

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/slide/background/background_properties/stretch.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing `stretch` tag
+  class Stretch < OOXMLDocumentObject
+    # Parse Stretch object
+    # @param _node [Nokogiri::XML:Element] node to parse
+    # @return [Stretch] result of parsing
+    def parse(_node)
+      self
+    end
+  end
+end

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/slide/background/background_properties.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'background_properties/stretch'
+module OoxmlParser
+  # Class for parsing `bgPr` tag
+  class BackgroundProperties < OOXMLDocumentObject
+    # @return [BlipFill]
+    attr_accessor :blip_fill
+
+    # Parse BackgroundProperties object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [BackgroundProperties] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'blipFill'
+          @blip_fill = BlipFill.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end