ooxml_parser 0.4.0 → 0.7.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'docx_color'
 require_relative 'docx_shape_size'
 require_relative 'docx_shape_line'
@@ -5,10 +7,10 @@ require_relative 'docx_shape_properties/blip_fill'
 require_relative 'docx_shape_properties/preset_geometry'
 require_relative 'docx_shape_properties/text_box'
 require_relative 'custom_geometry/ooxml_custom_geometry'
-# DOCX Shape Properties
 module OoxmlParser
+  # DOCX Shape Properties
   class DocxShapeProperties < OOXMLDocumentObject
-    attr_accessor :shape_size, :preset_geometry, :fill_color, :text_box, :line, :custom_geometry
+    attr_accessor :shape_size, :preset_geometry, :fill_color, :line, :custom_geometry
     attr_accessor :blip_fill
 
     alias transform shape_size
@@ -31,8 +33,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_properties/blip_fill.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'blip_fill/blip'
 module OoxmlParser
   # Class for parsing `a:blipFill` tag

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

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

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

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'preset_geometry/shape_adjust_value_list'
 module OoxmlParser
   # Class for describing Preset Geometry

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'shape_adjust_value_list/shape_guide'
 module OoxmlParser
   # Class for describing List of Shape Adjust Values

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for describing Shape Guide
   class ShapeGuide < OOXMLDocumentObject

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

@@ -1,5 +1,7 @@
-# Class for working with TextBox (w:txbxContent)
+# frozen_string_literal: true
+
 module OoxmlParser
+  # Class for working with TextBox (w:txbxContent)
   class TextBox
     # Parse TextBox List
     # @param [Nokogiri::XML:Node] node with TextBox
@@ -7,16 +9,15 @@ module OoxmlParser
     def self.parse_list(node, parent: nil)
       elements = []
       text_box_content_node = node.xpath('w:txbxContent').first
-      unless text_box_content_node.nil?
-        text_box_content_node.xpath('*').each_with_index do |textbox_element, i|
-          case textbox_element.name
-          when 'p'
-            DocumentStructure.default_paragraph_style = DocxParagraph.new
-            DocumentStructure.default_paragraph_style.spacing = Spacing.new(0, 0.35, 1.15, :multiple)
-            elements << DocumentStructure.default_paragraph_style.dup.parse(textbox_element, i, parent: parent)
-          when 'tbl'
-            elements << Table.new(parent: parent).parse(textbox_element, i)
-          end
+
+      text_box_content_node&.xpath('*')&.each_with_index do |textbox_element, i|
+        case textbox_element.name
+        when 'p'
+          DocumentStructure.default_paragraph_style = DocxParagraph.new
+          DocumentStructure.default_paragraph_style.spacing = Spacing.new(0, 0.35, 1.15, :multiple)
+          elements << DocumentStructure.default_paragraph_style.dup.parse(textbox_element, i, parent: parent)
+        when 'tbl'
+          elements << Table.new(parent: parent).parse(textbox_element, i)
         end
       end
       elements

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

@@ -1,9 +1,15 @@
-# Docx Shape Size
+# frozen_string_literal: true
+
 module OoxmlParser
+  # Docx Shape Size
   class DocxShapeSize < OOXMLDocumentObject
-    attr_accessor :rotation, :flip_horizontal, :flip_vertical, :offset, :extent
+    attr_accessor :rotation, :offset, :extent
     attr_accessor :child_offset
     attr_accessor :child_extent
+    # @return [True, False] is image flipped horizontally
+    attr_reader :flip_horizontal
+    # @return [True, False] is image flipped vertically
+    attr_reader :flip_vertical
 
     alias extents extent
 
@@ -14,11 +20,11 @@ module OoxmlParser
       node.attributes.each do |key, value|
         case key
         when 'rot'
-          @rotation = value.value.to_f
+          @rotation = OoxmlSize.new(value.value.to_f, :one_60000th_degree)
         when 'flipH'
-          @flip_horizontal = value.value.to_f
+          @flip_horizontal = attribute_enabled?(value)
         when 'flipV'
-          @flip_vertical = value.value.to_f
+          @flip_vertical = attribute_enabled?(value)
         end
       end
       node.xpath('*').each do |node_child|

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

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module OoxmlParser
+  # Class for working with LineEnd data
   class LineEnd < OOXMLDocumentObject
     attr_accessor :type, :length, :width
 

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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require_relative 'old_docx_group_properties'
 require_relative 'old_docx_group_element'
-# Fallback DOCX group data
 module OoxmlParser
+  # Fallback DOCX group data
   class OldDocxGroup < OOXMLDocumentObject
     attr_accessor :elements, :properties
 

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

@@ -1,5 +1,7 @@
-# Fallback DOCX Gropu Element data
+# frozen_string_literal: true
+
 module OoxmlParser
+  # Fallback DOCX group element data
   class OldDocxGroupElement
     attr_accessor :type, :object
 

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

@@ -1,5 +1,7 @@
-# Fallback DOCX group properties
+# frozen_string_literal: true
+
 module OoxmlParser
+  # Fallback DOCX group properties
   class OldDocxGroupProperties
     attr_accessor :wrap
   end

data/lib/ooxml_parser/common_parser/common_data/alternate_content/picture/old_docx_picture.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require_relative 'shape/old_docx_shape'
 require_relative 'shape/old_docx_shape_fill'
 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
@@ -18,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.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'old_docx_shape_properties'
 module OoxmlParser
   # Fallback DOCX shape data

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Fallback DOCX shape fill properties
   class OldDocxShapeFill < OOXMLDocumentObject

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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 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
@@ -11,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

@@ -1,33 +1,48 @@
-# Border Properties Data
+# frozen_string_literal: true
+
 module OoxmlParser
+  # Border Properties Data
   class BordersProperties < OOXMLDocumentObject
-    attr_accessor :color, :space, :sz, :val, :shadow, :frame, :side
+    attr_accessor :color, :space, :val, :shadow, :frame, :side
+    # @return [OoxmlSize] size of border
+    attr_reader :size
 
-    def initialize(color = :auto, sz = 0, val = :none, space = 0, parent: nil)
+    def initialize(color = :auto, size = 0, val = :none, space = 0, parent: nil)
       @color = color
-      @sz = sz
+      @size = size
       @val = val
       @space = space
       @parent = parent
     end
 
-    alias size sz
+    # @return [OoxmlSize] alias for sz
+    def sz
+      size
+    end
+
+    extend Gem::Deprecate
+    deprecate :sz, 'size', 2020, 1
 
     def nil?
-      @sz.zero? && val == :none
+      size.zero? && val == :none
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       return '' if nil?
-      "borders color: #{@color}, size: #{@sz}, space: #{@space}, value: #{@val}"
+
+      "borders color: #{@color}, size: #{size}, space: #{@space}, value: #{@val}"
     end
 
+    # Method to copy object
+    # @return [BordersProperties] copied object
     def copy
-      BordersProperties.new(@color, @sz, @val, @space)
+      BordersProperties.new(@color, size, @val, @space)
     end
 
     def visible?
       return false if nil?
+
       val != 'none'
     end
 
@@ -36,12 +51,13 @@ module OoxmlParser
     # @return [BordersProperties] value of BordersProperties
     def parse(node)
       return nil if node.attribute('val').value == 'nil'
+
       node.attributes.each do |key, value|
         case key
         when 'val'
           @val = value.value.to_sym
         when 'sz'
-          @sz = OoxmlSize.new(value.value.to_f, :one_eighth_point)
+          @size = OoxmlSize.new(value.value.to_f, :one_eighth_point)
         when 'space'
           @space = OoxmlSize.new(value.value.to_f, :point)
         when 'color'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'color/color_helper'
 require_relative 'color/ooxml_color'
 require_relative 'colors/color_alpha_channel'
@@ -6,8 +8,8 @@ require_relative 'colors/scheme_color'
 require_relative 'colors/color_properties'
 require_relative 'colors/theme_colors'
 # @author Pavel.Lobashov
-# Class for Color in RGB
 module OoxmlParser
+  # Class for Color in RGB
   class Color < OOXMLDocumentObject
     include ColorHelper
     # @return [Array] Deprecated Indexed colors
@@ -91,12 +93,14 @@ 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
@@ -115,6 +119,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'
@@ -123,38 +128,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
@@ -181,25 +194,116 @@ module OoxmlParser
       return false if none? && color_to_check.any?
       return false if !none? && color_to_check.none?
       return true if self == color_to_check
+
       red = color_to_check.red
       green = color_to_check.green
       blue = color_to_check.blue
       (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)
+      scheme_name = nil
+      scheme_color_node.xpath('*').each do |scheme_color_node_child|
+        case scheme_color_node_child.name
+        when 'lumMod'
+          hls.l = hls.l * (scheme_color_node_child.attribute('val').value.to_f / 100_000.0)
+        when 'lumOff'
+          hls.l = hls.l + (scheme_color_node_child.attribute('val').value.to_f / 100_000.0)
+        end
+      end
+      scheme_color_node.attributes.each do |key, value|
+        case key
+        when 'val'
+          scheme_name = value.to_s
+        end
+      end
+      color = hls.to_rgb
+      @red = color.red
+      @green = color.green
+      @blue = color.blue
+      @alpha_channel = ColorAlphaChannel.parse(scheme_color_node)
+      @scheme = scheme_name
+      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
+      color_model_parent_node.xpath('*').each do |color_model_node|
+        color_model_node.xpath('*').each do |color_mode_node_child|
+          case color_mode_node_child.name
+          when 'tint'
+            tint = color_mode_node_child.attribute('val').value.to_f / 100_000.0
+          end
+        end
+        case color_model_node.name
+        when 'srgbClr'
+          color = Color.new.parse_hex_string(color_model_node.attribute('val').value)
+          color.alpha_channel = ColorAlphaChannel.parse(color_model_node)
+        when 'schemeClr'
+          color = Color.new(parent: self).parse_scheme_color(color_model_node)
+        end
+      end
+      return nil unless color
+
+      color.calculate_with_tint!(1.0 - tint) if tint
+      @red = color.red
+      @green = color.green
+      @blue = color.blue
+      @alpha_channel = color.alpha_channel
+      @scheme = color.scheme
+      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'
+        color = parse_hex_string(color_node.attribute('val').value)
+        color.properties = ColorProperties.new(parent: color).parse(color_node)
+        color
+      when 'schemeClr'
+        color = SchemeColor.new(parent: parent)
+        return ValuedChild.new(:string, parent: parent).parse(color_node) unless root_object.theme
+
+        color.value = root_object.theme.color_scheme[color_node.attribute('val').value.to_sym].color
+        color.properties = ColorProperties.new(parent: color).parse(color_node)
+        color.converted_color = Color.new(parent: self).parse_scheme_color(color_node)
+        color.value.calculate_with_tint!(1.0 - color.properties.tint) if color.properties.tint
+        color
+      end
+    end
+
     class << self
+      # @return [Color] random color
       def generate_random_color
         Color.new(rand(256), rand(256), rand(256))
       end
@@ -213,17 +317,24 @@ 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]
         return :unknown if color_by_index.nil?
+
         color_by_index == 'n/a' ? Color.new : Color.new.parse_hex_string(color_by_index)
       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
@@ -235,6 +346,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
@@ -259,72 +373,6 @@ module OoxmlParser
           something
         end
       end
-
-      def parse_scheme_color(scheme_color_node)
-        color = ThemeColors.list[scheme_color_node.attribute('val').value.to_sym]
-        hls = HSLColor.rgb_to_hsl(color)
-        scheme_name = nil
-        scheme_color_node.xpath('*').each do |scheme_color_node_child|
-          case scheme_color_node_child.name
-          when 'lumMod'
-            hls.l = hls.l * (scheme_color_node_child.attribute('val').value.to_f / 100_000.0)
-          when 'lumOff'
-            hls.l = hls.l + (scheme_color_node_child.attribute('val').value.to_f / 100_000.0)
-          end
-        end
-        scheme_color_node.attributes.each do |key, value|
-          case key
-          when 'val'
-            scheme_name = value.to_s
-          end
-        end
-        color = hls.to_rgb
-        color.alpha_channel = ColorAlphaChannel.parse(scheme_color_node)
-        color.scheme = scheme_name
-        color
-      end
-
-      def parse_color_model(color_model_parent_node)
-        color = nil
-        tint = nil
-        color_model_parent_node.xpath('*').each do |color_model_node|
-          color_model_node.xpath('*').each do |color_mode_node_child|
-            case color_mode_node_child.name
-            when 'tint'
-              tint = color_mode_node_child.attribute('val').value.to_f / 100_000.0
-            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)
-          when 'schemeClr'
-            color = parse_scheme_color(color_model_node)
-          end
-        end
-        return nil unless color
-        color.calculate_with_tint!(1.0 - tint) if tint
-        color
-      end
-
-      def parse_color(color_node)
-        case color_node.name
-        when 'srgbClr'
-          color = Color.new.parse_hex_string(color_node.attribute('val').value)
-          color.properties = ColorProperties.new(parent: color).parse(color_node)
-          color
-        when 'schemeClr'
-          color = SchemeColor.new
-          color.value = ThemeColors.list[color_node.attribute('val').value.to_sym]
-          color.properties = ColorProperties.new(parent: color).parse(color_node)
-          color.converted_color = parse_scheme_color(color_node)
-          color.value.calculate_with_tint!(1.0 - color.properties.tint) if color.properties.tint
-          color
-        end
-      end
     end
   end
 end