ooxml_parser 0.4.1 → 0.7.1

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

@@ -1,9 +1,12 @@
+# 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

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

@@ -1,13 +1,22 @@
+# 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
     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)
@@ -15,7 +24,7 @@ module OoxmlParser
         OOXMLDocumentObject.xmls_stack.pop
         return
       end
-      doc = Nokogiri::XML(File.open(OOXMLDocumentObject.current_xml))
+      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|
@@ -32,12 +41,12 @@ module OoxmlParser
             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
-      ThemeColors.list = {}
-      OOXMLDocumentObject.theme.color_scheme.each { |key, value| ThemeColors.list[key] = value.color }
       OOXMLDocumentObject.theme
     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/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/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/theme_color.rb

@@ -1,13 +1,19 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing ThemeColor tags
   class ThemeColor < OOXMLDocumentObject
     attr_accessor :type, :value, :color
 
-    def initialize(parent: nil)
-      @type = ''
+    def initialize(type: '', color: nil, parent: nil)
+      @type = type
+      @color = color
       @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
@@ -23,16 +29,16 @@ module OoxmlParser
     # Parse ThemeColor
     # @param node [Nokogiri::XML::Element] node to parse
     # @return [ThemeColor] result of parsing
-    def parse(color_node)
-      color_node.xpath('*').each do |color_node_child|
-        case color_node_child.name
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
         when 'sysClr'
           @type = :system
-          @value = color_node_child.attribute('val').value
-          @color = Color.new(parent: self).parse_hex_string(color_node_child.attribute('lastClr').value.to_s) unless color_node_child.attribute('lastClr').nil?
+          @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(color_node_child.attribute('val').value.to_s)
+          @color = Color.new(parent: self).parse_hex_string(node_child.attribute('val').value.to_s)
         end
       end
       self

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'slide/presentation_alternate_content'
 require_relative 'slide/background'
 require_relative 'slide/common_slide_data'
@@ -26,18 +28,22 @@ module OoxmlParser
       @xml_path = xml_path
     end
 
+    # @return [True, False] is slide with data
     def with_data?
       return true unless background.nil?
+
       elements.each do |current_element|
         return true if current_element.with_data?
       end
       false
     end
 
+    # @return <Array> List of elements on slide
     def elements
       @common_slide_data.shape_tree.elements
     end
 
+    # @return [Background] background of slide
     def background
       @common_slide_data.background
     end
@@ -47,7 +53,7 @@ module OoxmlParser
     def parse
       OOXMLDocumentObject.add_to_xmls_stack(@xml_path)
       @name = File.basename(@xml_path, '.*')
-      node = Nokogiri::XML(File.open(OOXMLDocumentObject.current_xml))
+      node = parse_xml(OOXMLDocumentObject.current_xml)
       node.xpath('//p:sld/*').each do |node_child|
         case node_child.name
         when 'cSld'
@@ -61,7 +67,7 @@ module OoxmlParser
         end
       end
       OOXMLDocumentObject.xmls_stack.pop
-      @relationships = Relationships.parse_rels("#{OOXMLDocumentObject.path_to_folder}#{File.dirname(@xml_path)}/_rels/#{@name}.xml.rels")
+      @relationships = Relationships.new(parent: self).parse_file("#{OOXMLDocumentObject.path_to_folder}#{File.dirname(@xml_path)}/_rels/#{@name}.xml.rels")
       parse_note
       self
     end
@@ -71,8 +77,9 @@ module OoxmlParser
     # Parse slide notes if present
     def parse_note
       notes_target = @relationships.target_by_type('notes')
-      return nil unless notes_target
-      @note = PresentationNotes.new(parent: self).parse("#{OOXMLDocumentObject.path_to_folder}#{File.dirname(@xml_path)}/#{notes_target}")
+      return nil if notes_target.empty?
+
+      @note = PresentationNotes.new(parent: self).parse("#{OOXMLDocumentObject.path_to_folder}#{File.dirname(@xml_path)}/#{notes_target.first}")
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'background/background_properties'
 module OoxmlParser
   # Class for parsing `bg` tag
@@ -6,8 +8,9 @@ module OoxmlParser
     # @return [BackgroundProperties] properties
     attr_accessor :properties
 
-    def initialize(type = nil)
+    def initialize(type = nil, parent: nil)
       @type = type
+      @parent = parent
     end
 
     # Parse Background object

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'background_properties/stretch'
 module OoxmlParser
   # Class for parsing `bgPr` tag

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

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

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/slide/common_slide_data.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'common_slide_data/shape_tree'
 
 module OoxmlParser

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/slide/common_slide_data/shape_tree.rb

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

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/slide/connection_shape.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for storing `cxnSp` data
   class ConnectionShape < DocxShape

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/slide/graphic_frame/graphic_frame.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `graphicFrame`
   class GraphicFrame < OOXMLDocumentObject
@@ -5,8 +7,9 @@ module OoxmlParser
     # @return [NonVisualShapeProperties] non visual properties
     attr_accessor :non_visual_properties
 
-    def initialize(graphic_data = [])
+    def initialize(graphic_data = [], parent: nil)
       @graphic_data = graphic_data
+      @parent = parent
     end
 
     # Parse GraphicFrame object
@@ -28,7 +31,7 @@ module OoxmlParser
                   graphic_data << Table.new(parent: self).parse(graphic_node_child)
                 when 'chart'
                   OOXMLDocumentObject.add_to_xmls_stack(OOXMLDocumentObject.get_link_from_rels(graphic_node_child.attribute('id').value))
-                  graphic_data << Chart.parse
+                  graphic_data << Chart.parse(parent: self)
                   OOXMLDocumentObject.xmls_stack.pop
                 when 'oleObj'
                   graphic_data << OleObject.new(parent: self).parse(graphic_node_child)

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/slide/presentation_alternate_content.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'transition/transition'
 module OoxmlParser
   # Class for parsing `AlternateContent`
@@ -15,12 +17,8 @@ module OoxmlParser
     def parse(node)
       node.xpath('mc:Choice/*', 'xmlns:mc' => 'http://schemas.openxmlformats.org/markup-compatibility/2006').each do |node_child|
         case node_child.name
-        when 'timing'
-          @timing = Timing.new(parent: self).parse(node_child)
         when 'transition'
           @transition = Transition.new(parent: self).parse(node_child)
-        when 'sp'
-          @elements << DocxShape.new(parent: self).parse(node_child)
         end
       end
       self

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/slide/presentation_notes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for p:notes
   class PresentationNotes < OOXMLDocumentObject
@@ -8,7 +10,7 @@ module OoxmlParser
     # @param file [String] file to parse
     # @return [PresentationNotes] result of parsing
     def parse(file)
-      node = Nokogiri::XML(File.open(file))
+      node = parse_xml(file)
       node.xpath('p:notes/*').each do |node_child|
         case node_child.name
         when 'cSld'

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/slide/shape/non_visual_shape_properties/hyperlinks/hyperlink_for_hover.rb

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

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/slide/slide/shapes_grouping.rb

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

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/slide/slide/timing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'timing/time_node'
 module OoxmlParser
   # Class for parsing `timing`

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/slide/slide/timing/animation_effect/animation_effect.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module OoxmlParser
+  # Class for data for animation effect
   class AnimationEffect < OOXMLDocumentObject
     attr_accessor :transition, :filter, :behavior
 

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/slide/slide/timing/set_time_node/behavior/behavior.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require_relative 'target_element'
 module OoxmlParser
+  # Class for data for Behavior
   class Behavior < OOXMLDocumentObject
     attr_accessor :common_time_node, :attribute_name_list, :target
 

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/slide/slide/timing/set_time_node/behavior/target_element.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module OoxmlParser
+  # Class for data for Target Element
   class TargetElement < OOXMLDocumentObject
     attr_accessor :type, :id, :name, :built_in
 
@@ -14,18 +17,9 @@ module OoxmlParser
     def parse(node)
       node.xpath('*').each do |node_child|
         case node_child.name
-        when 'sldTgt'
-          @type = :slide
-        when 'sndTgt'
-          @type = :sound
-          @name = node_child.attribute('name').value
-          @built_in = node_child.attribute('builtIn').value ? StringHelper.to_bool(node_child.attribute('builtIn').value) : false
         when 'spTgt'
           @type = :shape
           @id = node_child.attribute('spid').value
-        when 'inkTgt'
-          @type = :ink
-          @id = node_child.attribute('spid').value
         end
       end
       self

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/slide/slide/timing/set_time_node/set_time_node.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require_relative 'behavior/behavior'
 
 module OoxmlParser
+  # Class for data for Set Time Node
   class SetTimeNode < OOXMLDocumentObject
     attr_accessor :behavior, :to
 

data/lib/ooxml_parser/pptx_parser/pptx_data/presentation/slide/slide/timing/time_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'time_node/common_timing'
 require_relative 'animation_effect/animation_effect'
 require_relative 'set_time_node/set_time_node'
@@ -22,12 +24,15 @@ module OoxmlParser
         when 'cTn'
           @common_time_node = CommonTiming.new(parent: self).parse(node_child)
         when 'prevCondLst'
-          @previous_conditions_list = Condition.parse_list(node_child)
+          @previous_conditions_list = ConditionList.new(parent: self).parse(node_child)
         end
       end
       self
     end
 
+    # Parse list of timing nodes
+    # @param timing_list_node [Nokogiri::XML::Element] node to parse
+    # @return [Array<TimeNode>] list of nodes
     def self.parse_list(timing_list_node)
       timings = []
       timing_list_node.xpath('*').each do |time_node|
@@ -36,8 +41,6 @@ module OoxmlParser
           timings << TimeNode.new(:parallel, parent: timings).parse(time_node)
         when 'seq'
           timings << TimeNode.new(:sequence, parent: timings).parse(time_node)
-        when 'excl'
-          timings << TimeNode.new(:exclusive, parent: timings).parse(time_node)
         when 'anim'
           timings << TimeNode.new(:animate, parent: timings).parse(time_node)
         when 'set'
@@ -47,7 +50,7 @@ module OoxmlParser
         when 'video'
           timings << :video
         when 'audio'
-          timings << :audio
+          timings << TimeNode.new(:audio, parent: timings).parse(time_node)
         end
       end
       timings