ooxml_parser 0.5.1 → 0.8.0

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing `a:lnRef` tags
+  class LineReference < OOXMLDocumentObject
+    # @return [Integer] Style Matrix Index
+    attr_reader :index
+    # @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
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'idx'
+          @index = value.value.to_f
+        end
+      end
+
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'schemeClr'
+          @scheme_color = Color.new(parent: self).parse_scheme_color(node_child)
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -35,6 +35,7 @@ module OoxmlParser
       self
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       "Color: #{@color}, type: #{type}"
     end

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

@@ -23,8 +23,6 @@ module OoxmlParser
         @type = :arc
       when 'cubicBezTo'
         @type = :cubic_bezier
-      when 'quadBezTo'
-        @type = :quadratic_bezier
       when 'close'
         @type = :close
       end

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

@@ -16,6 +16,7 @@ module OoxmlParser
       @parent = parent
     end
 
+    # @return [Integer] stroke size of object
     def stroke_size
       if @color_scheme.nil? || @color_scheme.color == :none
         0

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, :text_box, :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
@@ -33,8 +43,6 @@ module OoxmlParser
           @shape_size = DocxShapeSize.new(parent: self).parse(node_child)
         when 'prstGeom'
           @preset_geometry = PresetGeometry.new(parent: self).parse(node_child)
-        when 'txbx'
-          @text_box = TextBox.parse_list(node_child)
         when 'ln'
           @line = DocxShapeLine.new(parent: self).parse(node_child)
         when 'blipFill'

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/old_docx_picture.rb

@@ -6,7 +6,7 @@ require_relative 'group/old_docx_group'
 module OoxmlParser
   # Fallback DOCX Picture
   class OldDocxPicture < OOXMLDocumentObject
-    attr_accessor :data, :type, :style_number
+    attr_accessor :data, :type
 
     # Parse OldDocxPicture object
     # @param node [Nokogiri::XML:Element] node to parse
@@ -20,8 +20,6 @@ module OoxmlParser
         when 'group'
           @type = :group
           @data = OldDocxGroup.new(parent: self).parse(node_child)
-        when 'style'
-          @style_number = node_child.attribute('val').value.to_i
         end
       end
       self

data/lib/ooxml_parser/common_parser/common_data/alternate_content/picture/shape/old_docx_shape_properties.rb

@@ -3,7 +3,7 @@
 module OoxmlParser
   # Fallback DOCX Shape Properties
   class OldDocxShapeProperties < OOXMLDocumentObject
-    attr_accessor :fill_color, :opacity, :stroke_color, :stroke_weight
+    attr_accessor :fill_color, :stroke_color, :stroke_weight
 
     # Parse OldDocxShapeProperties object
     # @param node [Nokogiri::XML:Element] node to parse
@@ -13,8 +13,6 @@ module OoxmlParser
         case key
         when 'fillcolor'
           @fill_color = Color.new(parent: self).parse_hex_string(value.value.delete('#'))
-        when 'opacity'
-          @opacity = value.value.to_f
         when 'strokecolor'
           @stroke_color = Color.new(parent: self).parse_hex_string(value.value.delete('#'))
         when 'strokeweight'

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

@@ -27,12 +27,15 @@ module OoxmlParser
       size.zero? && val == :none
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       return '' if nil?
 
       "borders color: #{@color}, size: #{size}, space: #{@space}, value: #{@val}"
     end
 
+    # Method to copy object
+    # @return [BordersProperties] copied object
     def copy
       BordersProperties.new(@color, size, @val, @space)
     end

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
@@ -93,15 +20,17 @@ module OoxmlParser
     attr_accessor :blue
     # @return [String] Value of Color Style
     attr_accessor :style
+
     alias set_style style=
     # @return [String] color scheme of color
     attr_accessor :scheme
 
     # @return [Integer] Value of alpha-channel
     attr_accessor :alpha_channel
+
     alias set_alpha_channel alpha_channel=
 
-    attr_accessor :position
+    # @return [ColorProperties] properties of color
     attr_accessor :properties
 
     # Value of color if non selected
@@ -117,6 +46,7 @@ module OoxmlParser
       @parent = parent
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       if @red == VALUE_FOR_NONE_COLOR && @green == VALUE_FOR_NONE_COLOR && @blue == VALUE_FOR_NONE_COLOR
         'none'
@@ -125,38 +55,46 @@ module OoxmlParser
       end
     end
 
+    # @return [String] inspect of object for debug means
     def inspect
       to_s
     end
 
+    # @return [String] color in hex value
     def to_hex
       (@red.to_s(16).rjust(2, '0') + @green.to_s(16).rjust(2, '0') + @blue.to_s(16).rjust(2, '0')).upcase
     end
 
     alias to_int16 to_hex
 
+    # @return [True, False] is color default
     def none?
       (@red == VALUE_FOR_NONE_COLOR) && (@green == VALUE_FOR_NONE_COLOR) && (@blue == VALUE_FOR_NONE_COLOR) ||
         (style == :nil)
     end
 
+    # @return [True, False] is color not default
     def any?
       !none?
     end
 
+    # @return [True, False] is color white
     def white?
       (@red == 255) && (@green == 255) && (@blue == 255)
     end
 
+    # Method to copy object
+    # @return [Color] copied object
     def copy
       Color.new(@red, @green, @blue)
     end
 
+    # Compare this object to other
+    # @param other [Object] any other object
+    # @return [True, False] result of comparision
     def ==(other)
       if other.is_a?(Color)
-        if nil?
-          false
-        elsif (@red == other.red) && (@green == other.green) && (@blue == other.blue)
+        if (@red == other.red) && (@green == other.green) && (@blue == other.blue)
           true
         elsif (none? && other.white?) || (white? && other.none?)
           true
@@ -190,18 +128,27 @@ module OoxmlParser
       (self.red - red).abs < delta && (self.green - green).abs < delta && (self.blue - blue).abs < delta ? true : false
     end
 
+    # Apply tint to color
+    # @param tint [Integer] tint to apply
+    # @return [void]
     def calculate_with_tint!(tint)
       @red += (tint.to_f * (255 - @red)).to_i
       @green += (tint.to_f * (255 - @green)).to_i
       @blue += (tint.to_f * (255 - @blue)).to_i
     end
 
+    # Apply shade to color
+    # @param shade [Integer] shade to apply
+    # @return [void]
     def calculate_with_shade!(shade)
       @red = (@red * shade.to_f).to_i
       @green = (@green * shade.to_f).to_i
       @blue = (@blue * shade.to_f).to_i
     end
 
+    # Parse color scheme data
+    # @param scheme_color_node [Nokogiri::XML:Element] node to parse
+    # @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)
@@ -229,6 +176,9 @@ module OoxmlParser
       self
     end
 
+    # Parse color model data
+    # @param color_model_parent_node [Nokogiri::XML:Element] node to parse
+    # @return [Color] result of parsing
     def parse_color_model(color_model_parent_node)
       color = nil
       tint = nil
@@ -240,9 +190,6 @@ module OoxmlParser
           end
         end
         case color_model_node.name
-        when 'scrgbClr'
-          color = Color.new(color_model_node.attribute('r').value.to_i, color_model_node.attribute('g').value.to_i, color_model_node.attribute('b').value.to_i)
-          color.alpha_channel = ColorAlphaChannel.parse(color_model_node)
         when 'srgbClr'
           color = Color.new.parse_hex_string(color_model_node.attribute('val').value)
           color.alpha_channel = ColorAlphaChannel.parse(color_model_node)
@@ -261,6 +208,9 @@ module OoxmlParser
       self
     end
 
+    # Parse color data
+    # @param color_node [Nokogiri::XML:Element] node to parse
+    # @return [Color] result of parsing
     def parse_color(color_node)
       case color_node.name
       when 'srgbClr'
@@ -280,6 +230,7 @@ module OoxmlParser
     end
 
     class << self
+      # @return [Color] random color
       def generate_random_color
         Color.new(rand(256), rand(256), rand(256))
       end
@@ -293,19 +244,31 @@ module OoxmlParser
         const_array_name.map { |current_color| Color.parse_string(current_color) }
       end
 
+      # @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
       def parse_string(str)
         return str if str.is_a?(Color)
         return Color.new(VALUE_FOR_NONE_COLOR, VALUE_FOR_NONE_COLOR, VALUE_FOR_NONE_COLOR) if str == 'none' || str == '' || str == 'transparent' || str.nil?
 
         split = if str.include?('RGB (') || str.include?('rgb(')
-                  str.gsub(/[(RGBrgb\(\) )]/, '').split(',')
+                  str.gsub(/[(RGBrgb() )]/, '').split(',')
                 elsif str.include?('RGB ') || str.include?('rgb')
                   str.gsub(/RGB |rgb/, '').split(', ')
                 else
@@ -317,6 +280,9 @@ module OoxmlParser
 
       alias parse parse_string
 
+      # Convert other object type to Color
+      # @param something [Object] object to convert
+      # @return [Color] result of conversion
       def to_color(something)
         case something
         when SchemeColor

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