ooxml_parser 0.4.0 → 0.7.0

data/lib/ooxml_parser/common_parser/common_data/color/color_helper.rb

@@ -1,25 +1,29 @@
-# Helper methods for color
-module ColorHelper
-  # Parse string in hex
-  # @param [String] hex_string with or without alpha-channel
-  def parse_hex_string(hex_string)
-    return self if %w[auto null].include?(hex_string)
+# frozen_string_literal: true
 
-    char_array = hex_string.split(//)
-    if char_array.length == 3
-      @red = char_array[0].hex
-      @green = char_array[1].hex
-      @blue = char_array[2].hex
-    elsif char_array.length == 6
-      @red = (char_array[0] + char_array[1]).hex
-      @green = (char_array[2] + char_array[3]).hex
-      @blue = (char_array[4] + char_array[5]).hex
-    elsif char_array.length == 8
-      @alpha_channel = (char_array[0] + char_array[1]).hex
-      @red = (char_array[2] + char_array[3]).hex
-      @green = (char_array[4] + char_array[5]).hex
-      @blue = (char_array[6] + char_array[7]).hex
+module OoxmlParser
+  # Helper methods for color
+  module ColorHelper
+    # Parse string in hex
+    # @param [String] hex_string with or without alpha-channel
+    def parse_hex_string(hex_string)
+      return self if %w[auto null].include?(hex_string)
+
+      char_array = hex_string.split(//)
+      if char_array.length == 3
+        @red = char_array[0].hex
+        @green = char_array[1].hex
+        @blue = char_array[2].hex
+      elsif char_array.length == 6
+        @red = (char_array[0] + char_array[1]).hex
+        @green = (char_array[2] + char_array[3]).hex
+        @blue = (char_array[4] + char_array[5]).hex
+      elsif char_array.length == 8
+        @alpha_channel = (char_array[0] + char_array[1]).hex
+        @red = (char_array[2] + char_array[3]).hex
+        @green = (char_array[4] + char_array[5]).hex
+        @blue = (char_array[6] + char_array[7]).hex
+      end
+      self
     end
-    self
   end
 end

data/lib/ooxml_parser/common_parser/common_data/color/ooxml_color.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `color` tag
   class OoxmlColor < OOXMLDocumentObject
@@ -16,22 +18,29 @@ module OoxmlParser
     # @return [Color] rgb color
     attr_reader :rgb
 
+    # Convert OoxmlColor to other color type
+    # @return [Object] result of conversion
     def to_color
       return Color.get_rgb_by_color_index(indexed) if indexed
-      return ThemeColors.parse_color_theme(theme, tint) if theme
+      return ThemeColors.new(parent: self).parse_color_theme(theme, tint) if theme
       return rgb if rgb
+
       value
     end
 
+    # Compare this object to other
+    # @param other [Object] any other object
+    # @return [True, False] result of comparision
     def ==(other)
       return to_color == other if other.is_a?(Color)
       return to_color == other if other.is_a?(Symbol)
+
       super
     end
 
-    # Parse Hyperlink object
+    # Parse OoxmlColor object
     # @param node [Nokogiri::XML:Element] node to parse
-    # @return [Hyperlink] result of parsing
+    # @return [OoxmlColor] result of parsing
     def parse(node)
       node.attributes.each do |key, value|
         case key

data/lib/ooxml_parser/common_parser/common_data/colors/color_alpha_channel.rb

@@ -1,5 +1,7 @@
-# Class for working with AlphaChannel
+# frozen_string_literal: true
+
 module OoxmlParser
+  # Class for working with AlphaChannel
   class ColorAlphaChannel
     # Parse AlphaChannel value
     # @param node [Nokogiri::XML::Element] node to parse
@@ -8,6 +10,7 @@ module OoxmlParser
       alpha_channel_node = node.xpath('a:alpha', 'xmlns:a' => 'http://schemas.openxmlformats.org/drawingml/2006/main').first
       alpha_channel_node = node.xpath('w14:alpha', 'xmlns:w14' => 'http://schemas.microsoft.com/office/word/2010/wordml').first if alpha_channel_node.nil?
       return 100.0 if alpha_channel_node.nil?
+
       (alpha_channel_node.attribute('val').value.to_f / 1_000.0).round(0)
     end
   end

data/lib/ooxml_parser/common_parser/common_data/colors/color_properties.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for color transformations
   class ColorProperties < OOXMLDocumentObject

data/lib/ooxml_parser/common_parser/common_data/colors/hsl_color.rb

@@ -1,20 +1,27 @@
-# HSL is one of the most common cylindrical-coordinate representations of points in an RGB color model.
-# HSL stands for hue, saturation, and lightness, and is often also called HLS.
+# frozen_string_literal: true
+
 module OoxmlParser
+  # HSL is one of the most common cylindrical-coordinate representations of points in an RGB color model.
+  # HSL stands for hue, saturation, and lightness, and is often also called HLS.
   class HSLColor
-    attr_accessor :a, :h, :s, :l
+    attr_accessor :h, :s, :l
+    # @return [Integer] alpha channel value
+    attr_accessor :alpha_channel
 
     # Hue - The "attribute of a visual sensation according to which an area appears to be similar to one of
     # the perceived colors: red, yellow, green, and blue, or to a combination of two of them".
     # Saturation - The "colorfulness of a stimulus relative to its own brightness".
     # Lightness - The "brightness relative to the brightness of a similarly illuminated white".
-    def initialize(hue = 0, saturation = 0, lightness = 0, a = nil)
-      @a = a
+    def initialize(hue = 0, saturation = 0, lightness = 0, alpha_channel = nil)
+      @alpha_channel = alpha_channel
       @h = hue
       @s = saturation
       @l = lightness
     end
 
+    # Convert rgb color to hsl
+    # @param rgb_color [Color] color to convert
+    # @return [HSLColor] result of convert
     def self.rgb_to_hsl(rgb_color)
       hls_color = HSLColor.new
       red = rgb_color.red.to_f # / 255.0
@@ -26,7 +33,7 @@ module OoxmlParser
 
       delta = (max - min).to_f
       hls_color.l = (min + max) / 255.0 / 2.0
-      hls_color.a = rgb_color.alpha_channel.to_f / 255.0
+      hls_color.alpha_channel = rgb_color.alpha_channel.to_f / 255.0
 
       unless max == min
         hls_color.s = delta / (255.0 - (255.0 - max - min).abs)
@@ -46,6 +53,7 @@ module OoxmlParser
     end
 
     # Chroma - The "colorfulness relative to the brightness of a similarly illuminated white".
+    # @return [Color] result
     def to_rgb
       chroma = (1 - (2 * @l - 1).abs) * @s
       x = chroma * (1 - ((@h / 60.0) % 2.0 - 1).abs)
@@ -53,7 +61,7 @@ module OoxmlParser
 
       rgb = if @h.zero?
               Color.new(0, 0, 0)
-            elsif @h > 0 && @h < 60
+            elsif @h.positive? && @h < 60
               Color.new(chroma, x, 0)
             elsif @h > 60 && @h < 120
               Color.new(x, chroma, 0)
@@ -69,14 +77,21 @@ module OoxmlParser
       Color.new(((rgb.red + m) * 255.0).round, ((rgb.green + m) * 255.0).round, ((rgb.blue + m) * 255.0).round)
     end
 
+    # Get lum value of color
+    # @param tint [Integer] tint to apply
+    # @param lum [Integer] lum without tint
+    # @return [Integer] result
     def calculate_lum_value(tint, lum)
       if tint.nil?
         lum
       else
-        tint < 0 ? lum * (1.0 + tint) : lum * (1.0 - tint) + (255 - 255 * (1.0 - tint))
+        tint.negative? ? lum * (1.0 + tint) : lum * (1.0 - tint) + (255 - 255 * (1.0 - tint))
       end
     end
 
+    # Convert to rgb with applied tint
+    # @param tint [Integer] tint to apply
+    # @return [Color] result of covert
     def calculate_rgb_with_tint(tint)
       self.l = calculate_lum_value(tint, @l * 255.0) / 255.0
       to_rgb

data/lib/ooxml_parser/common_parser/common_data/colors/image_fill.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require_relative 'tile'
 module OoxmlParser
+  # Class for working with Image Fill
   class ImageFill < OOXMLDocumentObject
     attr_accessor :stretch, :tile, :properties
     # @return [FileReference] image structure

data/lib/ooxml_parser/common_parser/common_data/colors/presentation_fill.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 require_relative 'image_fill'
 require_relative 'presentation_fill/gradient_color'
 require_relative 'presentation_fill/presentation_pattern'
 module OoxmlParser
+  # Class for working with PresentationFill
   class PresentationFill < OOXMLDocumentObject
     attr_accessor :type, :image, :color, :pattern
 
@@ -10,6 +13,7 @@ module OoxmlParser
     # @return [PresentationFill] result of parsing
     def parse(node)
       return nil if node.xpath('*').empty?
+
       node.xpath('*').each do |node_child|
         case node_child.name
         when 'gradFill'
@@ -17,7 +21,7 @@ module OoxmlParser
           @color = GradientColor.new(parent: self).parse(node_child)
         when 'solidFill'
           @type = :solid
-          @color = Color.parse_color(node_child.xpath('*').first)
+          @color = Color.new(parent: self).parse_color(node_child.xpath('*').first)
         when 'blipFill'
           @type = :image
           @image = ImageFill.new(parent: self).parse(node_child)
@@ -30,6 +34,7 @@ module OoxmlParser
         end
       end
       return nil if @type.nil?
+
       self
     end
   end

data/lib/ooxml_parser/common_parser/common_data/colors/presentation_fill/gradient_color.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require_relative 'gradient_color/gradient_stop'
 require_relative 'gradient_color/linear_gradient'
 module OoxmlParser
   # Class for parsing `gradFill` tags
-  class GradientColor
+  class GradientColor < OOXMLDocumentObject
     attr_accessor :gradient_stops, :path
     # @return [LinearGradient] content of Linear Gradient
     attr_accessor :linear_gradient

data/lib/ooxml_parser/common_parser/common_data/colors/presentation_fill/gradient_color/gradient_stop.rb

@@ -1,5 +1,7 @@
-require_relative 'gradient_stop/preset_color'
+# frozen_string_literal: true
+
 module OoxmlParser
+  # Class for working with GradientStop
   class GradientStop < OOXMLDocumentObject
     attr_accessor :position, :color
 
@@ -17,9 +19,9 @@ module OoxmlParser
       node.xpath('*').each do |node_child|
         @color = case node_child.name
                  when 'prstClr'
-                   PresetColor.new(parent: self).parse(node_child)
+                   ValuedChild.new(:string, parent: self).parse(node_child)
                  else
-                   Color.parse_color(node_child)
+                   Color.new(parent: self).parse_color(node_child)
                  end
       end
       self

data/lib/ooxml_parser/common_parser/common_data/colors/presentation_fill/gradient_color/linear_gradient.rb

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

data/lib/ooxml_parser/common_parser/common_data/colors/presentation_fill/presentation_pattern.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `pattFill` tag
   class PresentationPattern < OOXMLDocumentObject
@@ -17,9 +19,9 @@ module OoxmlParser
       node.xpath('*').each do |color_node|
         case color_node.name
         when 'fgClr'
-          @foreground_color = Color.parse_color(color_node.xpath('*').first)
+          @foreground_color = Color.new(parent: self).parse_color(color_node.xpath('*').first)
         when 'bgClr'
-          @background_color = Color.parse_color(color_node.xpath('*').first)
+          @background_color = Color.new(parent: self).parse_color(color_node.xpath('*').first)
         end
       end
       self

data/lib/ooxml_parser/common_parser/common_data/colors/scheme_color.rb

@@ -1,12 +1,17 @@
+# frozen_string_literal: true
+
 module OoxmlParser
+  # Class for working with SchemeColor
   class SchemeColor
     attr_accessor :value, :properties, :converted_color
 
-    def initialize(value = nil, converted_color = 0)
+    def initialize(value = nil, converted_color = 0, parent: nil)
       @value = value
       @converted_color = converted_color
+      @parent = parent
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       @converted_color.to_s
     end

data/lib/ooxml_parser/common_parser/common_data/colors/theme_colors.rb

@@ -1,19 +1,23 @@
-# Class for hold ThemeColors list
+# frozen_string_literal: true
+
 module OoxmlParser
-  class ThemeColors
-    class << self
-      # @return [Hash] list of colors
-      attr_accessor :list
+  # Class for hold ThemeColors list
+  class ThemeColors < OOXMLDocumentObject
+    # @return [Hash] list of colors
+    attr_accessor :list
 
-      def parse_color_theme(theme, tint)
-        themes_array = ThemeColors.list.to_a
-        # TODO: if no swap performed - incorrect color parsing. But don't know why it needed
-        themes_array[0], themes_array[1] = themes_array[1], themes_array[0]
-        themes_array[2], themes_array[3] = themes_array[3], themes_array[2]
-        hls = HSLColor.rgb_to_hsl(themes_array[theme][1])
-        tint = 0 if tint.nil?
-        hls.calculate_rgb_with_tint(tint)
-      end
+    # Parse color theme
+    # @param theme [String] name of theme
+    # @param tint [Integer] tint of theme
+    # @return [Color] color of theme
+    def parse_color_theme(theme, tint)
+      themes_array = root_object.theme.color_scheme.values
+      # TODO: if no swap performed - incorrect color parsing. But don't know why it needed
+      themes_array[0], themes_array[1] = themes_array[1], themes_array[0]
+      themes_array[2], themes_array[3] = themes_array[3], themes_array[2]
+      hls = HSLColor.rgb_to_hsl(themes_array[theme].color)
+      tint = 0 if tint.nil?
+      hls.calculate_rgb_with_tint(tint)
     end
   end
 end

data/lib/ooxml_parser/common_parser/common_data/colors/tile.rb

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

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'content_types/content_type_default'
+require_relative 'content_types/content_type_override'
+module OoxmlParser
+  # Class for data from `[Content_Types].xml` file
+  class ContentTypes < OOXMLDocumentObject
+    # @return [Array] list of content types
+    attr_accessor :content_types_list
+
+    def initialize(parent: nil)
+      @parent = parent
+      @content_types_list = []
+    end
+
+    # @return [Array] accessor
+    def [](key)
+      @content_types_list[key]
+    end
+
+    # Parse ContentTypes object
+    # @return [ContentTypes] result of parsing
+    def parse
+      doc = Nokogiri::XML.parse(File.open("#{OOXMLDocumentObject.path_to_folder}/[Content_Types].xml"))
+      node = doc.xpath('*').first
+
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'Default'
+          @content_types_list << ContentTypeDefault.new(parent: self).parse(node_child)
+        when 'Override'
+          @content_types_list << ContentTypeOverride.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/common_parser/common_data/content_types/content_type_default.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for data from `Default` tag
+  class ContentTypeDefault < OOXMLDocumentObject
+    # @return [String] content type
+    attr_reader :content_type
+    # @return [String] extension
+    attr_reader :extension
+
+    # Parse ContentTypeDefault object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [ContentTypeDefault] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'ContentType'
+          @content_type = value.value.to_s
+        when 'Extension'
+          @extension = value.value.to_s
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/common_parser/common_data/content_types/content_type_override.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for data from `Override` tag
+  class ContentTypeOverride < OOXMLDocumentObject
+    # @return [String] content type
+    attr_reader :content_type
+    # @return [String] part name
+    attr_reader :part_name
+
+    # Parse ContentTypeOverride object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [ContentTypeOverride] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'ContentType'
+          @content_type = value.value.to_s
+        when 'PartName'
+          @part_name = value.value.to_s
+        end
+      end
+      self
+    end
+  end
+end