ooxml_parser 0.7.0 → 0.9.0

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

@@ -8,10 +8,6 @@ module OoxmlParser
     # @return [Color] scheme color of FontReference
     attr_reader :scheme_color
 
-    def initialize(parent: nil)
-      @parent = parent
-    end
-
     # Parse FontReference object
     # @param node [Nokogiri::XML:Element] node to parse
     # @return [FontReference] result of parsing

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

@@ -8,10 +8,6 @@ module OoxmlParser
     # @return [Color] scheme color of LineReference
     attr_reader :scheme_color
 
-    def initialize(parent: nil)
-      @parent = parent
-    end
-
     # Parse LineReference object
     # @param node [Nokogiri::XML:Element] node to parse
     # @return [LineReference] result of parsing

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

@@ -7,7 +7,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @paragraphs = []
-      @parent = parent
+      super
     end
 
     # Parse TextBody object

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/shape_properties/color/docx_color_scheme.rb

@@ -8,7 +8,7 @@ module OoxmlParser
     def initialize(parent: nil)
       @color = Color.new
       @type = :unknown
-      @parent = parent
+      super
     end
 
     # Parse DocxColorScheme object

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/shape_properties/custom_geometry/docx_custom_geometry/docx_shape_line_path.rb

@@ -8,7 +8,7 @@ module OoxmlParser
 
     def initialize(elements = [], parent: nil)
       @elements = elements
-      @parent = parent
+      super(parent: parent)
     end
 
     # Parse DocxShapeLinePath object

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/shape_properties/custom_geometry/docx_custom_geometry/docx_shape_line_path/docx_shape_line_element.rb

@@ -7,7 +7,7 @@ module OoxmlParser
 
     def initialize(points = [], parent: nil)
       @points = points
-      @parent = parent
+      super(parent: parent)
     end
 
     # Parse DocxShapeLineElement

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/shape_properties/custom_geometry/ooxml_custom_geometry.rb

@@ -8,7 +8,7 @@ module OoxmlParser
 
     def initialize(paths_list = [], parent: nil)
       @paths_list = paths_list
-      @parent = parent
+      super(parent: parent)
     end
 
     # Parse OOXMLCustomGeometry object

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

@@ -13,7 +13,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @width = OoxmlSize.new(0)
-      @parent = parent
+      super
     end
 
     # @return [Integer] stroke size of object

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

@@ -10,8 +10,18 @@ require_relative 'custom_geometry/ooxml_custom_geometry'
 module OoxmlParser
   # DOCX Shape Properties
   class DocxShapeProperties < OOXMLDocumentObject
-    attr_accessor :shape_size, :preset_geometry, :fill_color, :line, :custom_geometry
-    attr_accessor :blip_fill
+    # @return [DocxShapeSize] size of shape
+    attr_reader :shape_size
+    # @return [PresetGeometry] preset geometry of object
+    attr_reader :preset_geometry
+    # @return [DocxColor] color of object
+    attr_reader :fill_color
+    # @return [DocxShapeLine] line info
+    attr_reader :line
+    # @return [PresetGeometry] is some geometry custom
+    attr_reader :custom_geometry
+    # @return [BlipFill] BlipFill data
+    attr_reader :blip_fill
 
     alias transform shape_size
     alias fill fill_color
@@ -19,7 +29,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @line = DocxShapeLine.new
-      @parent = parent
+      super
     end
 
     # Parse DocxShapeProperties object

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/shape_properties/docx_shape_properties/preset_geometry/shape_adjust_value_list.rb

@@ -9,7 +9,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @shape_guides_list = []
-      @parent = parent
+      super
     end
 
     # @return [Array, Column] accessor for relationship

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

@@ -3,9 +3,16 @@
 module OoxmlParser
   # Docx Shape Size
   class DocxShapeSize < OOXMLDocumentObject
-    attr_accessor :rotation, :offset, :extent
-    attr_accessor :child_offset
-    attr_accessor :child_extent
+    # @return [OoxmlSize] rotation info
+    attr_reader :rotation
+    # @return [OOXMLCoordinates] offset info
+    attr_reader :offset
+    # @return [OOXMLCoordinates] extent info
+    attr_reader :extent
+    # @return [OOXMLCoordinates] child offset
+    attr_reader :child_offset
+    # @return [OOXMLCoordinates] child extent
+    attr_reader :child_extent
     # @return [True, False] is image flipped horizontally
     attr_reader :flip_horizontal
     # @return [True, False] is image flipped vertically

data/lib/ooxml_parser/common_parser/common_data/alternate_content/picture/group/old_docx_group.rb

@@ -10,7 +10,7 @@ module OoxmlParser
     def initialize(properties = OldDocxGroupProperties.new, parent: nil)
       @properties = properties
       @elements = []
-      @parent = parent
+      super(parent: parent)
     end
 
     # Parse OldDocxGroup object

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

@@ -12,7 +12,7 @@ module OoxmlParser
       @size = size
       @val = val
       @space = space
-      @parent = parent
+      super(parent: parent)
     end
 
     # @return [OoxmlSize] alias for sz

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

@@ -12,79 +12,6 @@ module OoxmlParser
   # Class for Color in RGB
   class Color < OOXMLDocumentObject
     include ColorHelper
-    # @return [Array] Deprecated Indexed colors
-    # List of color duplicated from `OpenXML Sdk IndexedColors` class
-    # See https://msdn.microsoft.com/en-us/library/documentformat.openxml.spreadsheet.indexedcolors.aspx
-    COLOR_INDEXED =
-      %w[
-        000000
-        FFFFFF
-        FF0000
-        00FF00
-        0000FF
-        FFFF00
-        FF00FF
-        00FFFF
-        000000
-        FFFFFF
-        FF0000
-        00FF00
-        0000FF
-        FFFF00
-        FF00FF
-        00FFFF
-        800000
-        008000
-        000080
-        808000
-        800080
-        008080
-        C0C0C0
-        808080
-        9999FF
-        993366
-        FFFFCC
-        CCFFFF
-        660066
-        FF8080
-        0066CC
-        CCCCFF
-        000080
-        FF00FF
-        FFFF00
-        00FFFF
-        800080
-        800000
-        008080
-        0000FF
-        00CCFF
-        CCFFFF
-        CCFFCC
-        FFFF99
-        99CCFF
-        FF99CC
-        CC99FF
-        FFCC99
-        3366FF
-        33CCCC
-        99CC00
-        FFCC00
-        FF9900
-        FF6600
-        666699
-        969696
-        003366
-        339966
-        003300
-        333300
-        993300
-        993366
-        333399
-        333333
-        n/a
-        n/a
-      ].freeze
-
     # @return [Integer] Value of Red Part
     attr_accessor :red
     # @return [Integer] Value of Green Part
@@ -103,7 +30,7 @@ module OoxmlParser
 
     alias set_alpha_channel alpha_channel=
 
-    attr_accessor :position
+    # @return [ColorProperties] properties of color
     attr_accessor :properties
 
     # Value of color if non selected
@@ -116,7 +43,7 @@ module OoxmlParser
       @red = new_red
       @green = new_green
       @blue = new_blue
-      @parent = parent
+      super(parent: parent)
     end
 
     # @return [String] result of convert of object to string
@@ -224,7 +151,7 @@ module OoxmlParser
     # @return [Color] result of parsing
     def parse_scheme_color(scheme_color_node)
       color = root_object.theme.color_scheme[scheme_color_node.attribute('val').value.to_sym].color
-      hls = HSLColor.rgb_to_hsl(color)
+      hls = color.to_hsl
       scheme_name = nil
       scheme_color_node.xpath('*').each do |scheme_color_node_child|
         case scheme_color_node_child.name
@@ -320,12 +247,19 @@ module OoxmlParser
       # @param index [Integer] index to get
       # @return [Color] color by it's index
       def get_rgb_by_color_index(index)
-        color_by_index = COLOR_INDEXED[index]
+        color_by_index = color_indexes[index]
         return :unknown if color_by_index.nil?
 
         color_by_index == 'n/a' ? Color.new : Color.new.parse_hex_string(color_by_index)
       end
 
+      # @return [Array] Deprecated Indexed colors
+      #   List of color duplicated from `OpenXML Sdk IndexedColors` class
+      #   See https://msdn.microsoft.com/en-us/library/documentformat.openxml.spreadsheet.indexedcolors.aspx
+      def color_indexes
+        @color_indexes ||= File.readlines("#{__dir__}/color/color_indexes.list", chomp: true)
+      end
+
       # Parse color from string
       # @param str [String] string to parse
       # @return [Color] result of parsing

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

@@ -9,15 +9,16 @@ module OoxmlParser
       return self if %w[auto null].include?(hex_string)
 
       char_array = hex_string.split(//)
-      if char_array.length == 3
+      case char_array.length
+      when 3
         @red = char_array[0].hex
         @green = char_array[1].hex
         @blue = char_array[2].hex
-      elsif char_array.length == 6
+      when 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
+      when 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
@@ -25,5 +26,34 @@ module OoxmlParser
       end
       self
     end
+
+    # Convert color to HSLColor
+    # @return [HSLColor]
+    def to_hsl
+      hls_color = HSLColor.new
+
+      min = [red, green, blue].min.to_f
+      max = [red, green, blue].max.to_f
+
+      delta = (max - min).to_f
+      hls_color.l = (min + max) / 255.0 / 2.0
+      hls_color.alpha_channel = alpha_channel.to_f / 255.0
+
+      unless max == min
+        hls_color.s = delta / (255.0 - (255.0 - max - min).abs)
+
+        hls_color.h = if max == red && green >= blue
+                        60.0 * (green - blue) / delta
+                      elsif max == red && green < blue
+                        60.0 * (green - blue) / delta + 360.0
+                      elsif max == green
+                        60.0 * (blue - red) / delta + 120.0
+                      else
+                        60.0 * (red - green) / delta + 240.0
+                      end
+      end
+
+      hls_color
+    end
   end
 end

data/lib/ooxml_parser/common_parser/common_data/color/color_indexes.list

@@ -0,0 +1,66 @@
+000000
+FFFFFF
+FF0000
+00FF00
+0000FF
+FFFF00
+FF00FF
+00FFFF
+000000
+FFFFFF
+FF0000
+00FF00
+0000FF
+FFFF00
+FF00FF
+00FFFF
+800000
+008000
+000080
+808000
+800080
+008080
+C0C0C0
+808080
+9999FF
+993366
+FFFFCC
+CCFFFF
+660066
+FF8080
+0066CC
+CCCCFF
+000080
+FF00FF
+FFFF00
+00FFFF
+800080
+800000
+008080
+0000FF
+00CCFF
+CCFFFF
+CCFFCC
+FFFF99
+99CCFF
+FF99CC
+CC99FF
+FFCC99
+3366FF
+33CCCC
+99CC00
+FFCC00
+FF9900
+FF6600
+666699
+969696
+003366
+339966
+003300
+333300
+993300
+993366
+333399
+333333
+n/a
+n/a

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

@@ -3,8 +3,14 @@
 module OoxmlParser
   # Class for color transformations
   class ColorProperties < OOXMLDocumentObject
-    attr_accessor :alpha, :luminance_modulation, :luminance_offset
-    attr_accessor :tint
+    # @return [Integer] alpha value of color
+    attr_reader :alpha
+    # @return [Float] luminance modulation value
+    attr_reader :luminance_modulation
+    # @return [Float] luminance offset value
+    attr_reader :luminance_offset
+    # @return [Float] tint value
+    attr_reader :tint
 
     # Parse ColorProperties object
     # @param node [Nokogiri::XML:Element] node to parse

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

@@ -19,39 +19,6 @@ module OoxmlParser
       @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
-      green = rgb_color.green.to_f # / 255.0
-      blue = rgb_color.blue.to_f # / 255.0
-
-      min = [red, green, blue].min.to_f
-      max = [red, green, blue].max.to_f
-
-      delta = (max - min).to_f
-      hls_color.l = (min + max) / 255.0 / 2.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)
-
-        hls_color.h = if max == red && green >= blue
-                        60.0 * (green - blue) / delta
-                      elsif max == red && green < blue
-                        60.0 * (green - blue) / delta + 360.0
-                      elsif max == green
-                        60.0 * (blue - red) / delta + 120.0
-                      else
-                        60.0 * (red - green) / delta + 240.0
-                      end
-      end
-
-      hls_color
-    end
-
     # Chroma - The "colorfulness relative to the brightness of a similarly illuminated white".
     # @return [Color] result
     def to_rgb