ooxml_parser 0.8.1 → 0.12.0

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

@@ -29,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/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

@@ -43,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
@@ -94,13 +94,9 @@ module OoxmlParser
     # @return [True, False] result of comparision
     def ==(other)
       if other.is_a?(Color)
-        if (@red == other.red) && (@green == other.green) && (@blue == other.blue)
-          true
-        elsif (none? && other.white?) || (white? && other.none?)
-          true
-        else
-          false
-        end
+        ((@red == other.red) && (@green == other.green) && (@blue == other.blue)) ||
+          (none? && other.white?) ||
+          (white? && other.none?)
       else
         false
       end
@@ -125,7 +121,7 @@ module OoxmlParser
       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
+      (self.red - red).abs < delta && (self.green - green).abs < delta && (self.blue - blue).abs < delta
     end
 
     # Apply tint to color
@@ -151,7 +147,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
@@ -268,7 +264,7 @@ module OoxmlParser
         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

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

@@ -26,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/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

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

@@ -10,7 +10,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @path = ''
-      @parent = parent
+      super
     end
 
     # Parse ImageFill object

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

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

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

@@ -15,7 +15,7 @@ module OoxmlParser
       # 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)
+      hls = themes_array[theme].color.to_hsl
       tint = 0 if tint.nil?
       hls.calculate_rgb_with_tint(tint)
     end

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

@@ -8,7 +8,7 @@ module OoxmlParser
     def initialize(offset = nil, ratio = nil, parent: nil)
       @offset = offset
       @ratio = ratio
-      @parent = parent
+      super(parent: parent)
     end
 
     # Parse Tile object

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

@@ -9,8 +9,8 @@ module OoxmlParser
     attr_accessor :content_types_list
 
     def initialize(parent: nil)
-      @parent = parent
       @content_types_list = []
+      super
     end
 
     # @return [Array] accessor
@@ -34,5 +34,12 @@ module OoxmlParser
       end
       self
     end
+
+    # Get content definition by type
+    # @param [String] type of definition
+    # @return [Object] resulting objects
+    def by_type(type)
+      @content_types_list.select { |item| item.content_type == type }
+    end
   end
 end

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

@@ -23,8 +23,8 @@ module OoxmlParser
         end
         string = string.split('!').last
         if coordinates?(string)
-          coordinates.row = string.scan(/[0-9]/).join('').to_i
-          coordinates.column = string.scan(/[A-Z]/).join('')
+          coordinates.row = string.scan(/[0-9]/).join.to_i
+          coordinates.column = string.scan(/[A-Z]/).join
         end
         coordinates
       end

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

@@ -27,8 +27,8 @@ module OoxmlParser
       @url = link
       @tooltip = tooltip
       @coordinates = coordinates
-      @parent = parent
       @runs = []
+      super(parent: parent)
     end
 
     alias link url
@@ -76,7 +76,7 @@ module OoxmlParser
         @action = :last_slide
       when 'ppaction://hlinksldjump'
         @action = :slide
-        @url = OOXMLDocumentObject.get_link_from_rels(@id).scan(/\d+/).join('').to_i
+        @url = OOXMLDocumentObject.get_link_from_rels(@id).scan(/\d+/).join.to_i
       else
         if @id && !@id.empty?
           @action = :external_link

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

@@ -108,7 +108,7 @@ module OoxmlParser
 
       # @return [String] dir to base of file
       def dir
-        OOXMLDocumentObject.path_to_folder + File.dirname(OOXMLDocumentObject.xmls_stack.last) + '/'
+        "#{OOXMLDocumentObject.path_to_folder}#{File.dirname(OOXMLDocumentObject.xmls_stack.last)}/"
       end
 
       # @return [String] path to current xml file

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

@@ -16,7 +16,7 @@ module OoxmlParser
       @runs = runs
       @formulas = formulas
       @runs = []
-      @parent = parent
+      super(parent: parent)
     end
 
     alias characters runs

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragraph_properties.rb

@@ -30,6 +30,8 @@ module OoxmlParser
     attr_accessor :contextual_spacing
     # @return [Symbol] The alignment or justification to be applied to a paragraph
     attr_accessor :justification
+    # @return [Shade] Shade property
+    attr_accessor :shade
 
     def initialize(numbering = NumberingProperties.new, parent: nil)
       @numbering = numbering
@@ -39,7 +41,7 @@ module OoxmlParser
                              :multiple)
       @keep_next = false
       @tabs = []
-      @parent = parent
+      super(parent: parent)
     end
 
     # Parse ParagraphProperties object
@@ -74,9 +76,7 @@ module OoxmlParser
           @numbering.start_at = node_child.attribute('startAt').value if node_child.attribute('startAt')
         when 'framePr'
           @frame_properties = FrameProperties.new(parent: self).parse(node_child)
-        when 'tabs'
-          @tabs = Tabs.new(parent: self).parse(node_child)
-        when 'tabLst'
+        when 'tabs', 'tabLst'
           @tabs = Tabs.new(parent: self).parse(node_child)
         when 'ind'
           @indent = Indents.new(parent: self).parse(node_child)
@@ -88,6 +88,8 @@ module OoxmlParser
           @keep_next = true
         when 'sectPr'
           @section_properties = PageProperties.new(parent: self).parse(node_child, @parent, DocxParagraphRun.new)
+        when 'shd'
+          @shade = Shade.new(parent: self).parse(node_child)
         when 'spacing'
           @spacing = ParagraphSpacing.new(parent: self).parse(node_child)
         when 'jc'

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragraph_run.rb

@@ -14,7 +14,7 @@ module OoxmlParser
     def initialize(properties = RunProperties.new, text = '', parent: nil)
       @properties = properties
       @text = text
-      @parent = parent
+      super(parent: parent)
     end
 
     # Parse ParagraphRun object

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragraph_run/run_properties.rb

@@ -56,7 +56,7 @@ module OoxmlParser
       @font_name = params.fetch(:font_name, '')
       @font_style = FontStyle.new
       @baseline = :baseline
-      @parent = params[:parent]
+      super(parent: params[:parent])
     end
 
     # Parse RunProperties object

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragraph_run/run_properties/outline.rb

@@ -11,7 +11,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @width = OoxmlSize.new(0)
-      @parent = parent
+      super
     end
 
     # Parse Outline object

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragraph_run/run_properties/shade.rb

@@ -17,7 +17,7 @@ module OoxmlParser
       @value = value
       @color = color
       @fill = fill
-      @parent = parent
+      super(parent: parent)
     end
 
     # @return [String] text representation
@@ -43,5 +43,18 @@ module OoxmlParser
       end
       self
     end
+
+    # Helper method to get background color
+    # @return [OoxmlParser::Color]
+    def to_background_color
+      return nil unless fill
+
+      background_color = fill
+      background_color.set_style(value) if value
+      background_color
+    end
+
+    extend Gem::Deprecate
+    deprecate :to_background_color, 'use shade direct methods', 2077, 1
   end
 end

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragrpah_properties/numbering_properties.rb

@@ -7,7 +7,7 @@ module OoxmlParser
 
     def initialize(ilvl = 0, parent: nil)
       @ilvl = ilvl
-      @parent = parent
+      super(parent: parent)
     end
 
     # @return [AbstractNumbering] AbstractNumbering of current properties

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragrpah_properties/spacing.rb

@@ -33,14 +33,10 @@ module OoxmlParser
       other.line_rule = :multiple if other.line_rule == :auto
       self.line_rule = line_rule.to_sym if line_rule.instance_of?(String)
 
-      if @before == other.before &&
-         @after == other.after &&
-         @line == other.line &&
-         @line_rule.to_s == other.line_rule.to_s
-        true
-      else
-        false
-      end
+      @before == other.before &&
+        @after == other.after &&
+        @line == other.line &&
+        @line_rule.to_s == other.line_rule.to_s
     end
 
     # @return [String] result of convert of object to string
@@ -48,7 +44,7 @@ module OoxmlParser
       result_string = ''
       variables = instance_variables
       variables.each do |current_variable|
-        result_string += current_variable.to_s.sub('@', '') + ': ' + instance_variable_get(current_variable).to_s + "\n"
+        result_string += "#{current_variable.to_s.sub('@', '')}: #{instance_variable_get(current_variable)}\n"
       end
       result_string
     end

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragrpah_properties/tabs.rb

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

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

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

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

@@ -12,7 +12,7 @@ module OoxmlParser
 
     def initialize(rows = [], parent: nil)
       @rows = rows
-      @parent = parent
+      super(parent: parent)
     end
 
     alias table_properties properties