ooxml_parser 0.7.2 → 0.10.0

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

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

@@ -3,9 +3,20 @@
 module OoxmlParser
   # Class for parsing `hlinkClick`, `hyperlink` tags
   class Hyperlink < OOXMLDocumentObject
-    attr_accessor :url, :tooltip, :coordinates, :highlight_click, :action
-    attr_accessor :action_link
-    attr_accessor :id
+    # @return [OOXMLDocumentObject] url of hyperlink
+    attr_accessor :url
+    # @return [String] tooltip value
+    attr_reader :tooltip
+    # @return [Coordinates] coordinates of link
+    attr_reader :coordinates
+    # @return [True, False] should click be highlighted
+    attr_reader :highlight_click
+    # @return [Symbol] type of action
+    attr_reader :action
+    # @return [String] value of action link
+    attr_reader :action_link
+    # @return [String] id of link
+    attr_reader :id
     # @return [Array<ParagraphRun>] run of paragraph
     attr_reader :runs
 
@@ -16,8 +27,8 @@ module OoxmlParser
       @url = link
       @tooltip = tooltip
       @coordinates = coordinates
-      @parent = parent
       @runs = []
+      super(parent: parent)
     end
 
     alias link url

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

@@ -43,9 +43,13 @@ module OoxmlParser
     end
 
     class << self
+      # @return [String] path to root subfolder
       attr_accessor :root_subfolder
+      # @return [PresentationTheme] list of themes
       attr_accessor :theme
+      # @return [Array<String>] stack of xmls
       attr_accessor :xmls_stack
+      # @return [String] path to root folder
       attr_accessor :path_to_folder
 
       # @param path_to_file [String] file
@@ -104,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

@@ -39,7 +39,7 @@ module OoxmlParser
                              :multiple)
       @keep_next = false
       @tabs = []
-      @parent = parent
+      super(parent: parent)
     end
 
     # Parse ParagraphProperties object
@@ -74,9 +74,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)

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

@@ -9,12 +9,34 @@ require_relative 'run_properties/shade'
 module OoxmlParser
   # Data about `rPr` object
   class RunProperties < OOXMLDocumentObject
-    attr_accessor :font_style, :font_color, :space, :dirty, :font_name, :font_size, :baseline, :hyperlink, :caps,
-                  :vertical_align, :outline
-    attr_accessor :shadow
-    attr_accessor :emboss
-    attr_accessor :vanish
-    attr_accessor :rtl
+    # @return [FontStyle] font style of run
+    attr_accessor :font_style
+    # @return [Color, DocxColorScheme] color of run
+    attr_reader :font_color
+    # @return [OoxmlSize] space size
+    attr_reader :space
+    # @return [string] name of font
+    attr_reader :font_name
+    # @return [Float] font size
+    attr_reader :font_size
+    # @return [Symbol] baseline of run
+    attr_reader :baseline
+    # @return [Hyperlink] hyperlink of run
+    attr_reader :hyperlink
+    # @return [Symbol] caps data
+    attr_reader :caps
+    # @return [Symbol] vertical align data
+    attr_reader :vertical_align
+    # @return [Outline] outline data
+    attr_reader :outline
+    # @return [True, False] is text shadow
+    attr_reader :shadow
+    # @return [True, False] is text emboss
+    attr_reader :emboss
+    # @return [True, False] is text vanish
+    attr_reader :vanish
+    # @return [True, False] is text rtl
+    attr_reader :rtl
     # @return [Size] get run size
     attr_accessor :size
     # @return [RunSpacing] get run spacing
@@ -30,11 +52,11 @@ module OoxmlParser
     # @return [RunStyle] run style
     attr_accessor :run_style
 
-    def initialize(parent: nil)
-      @font_name = ''
+    def initialize(params = {})
+      @font_name = params.fetch(:font_name, '')
       @font_style = FontStyle.new
       @baseline = :baseline
-      @parent = parent
+      super(parent: params[:parent])
     end
 
     # Parse RunProperties object

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

@@ -4,12 +4,14 @@
 module OoxmlParser
   # Class for parsing `w:ln` tags
   class Outline < OOXMLDocumentObject
-    attr_accessor :width
-    attr_accessor :color_scheme
+    # @return [OoxmlSize] width of outline
+    attr_reader :width
+    # @return [DocxColorScheme] color of outline
+    attr_reader :color_scheme
 
     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

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

@@ -48,7 +48,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

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

@@ -8,11 +8,7 @@ module OoxmlParser
                    left = OoxmlSize.new(0),
                    right = OoxmlSize.new(0),
                    parent: nil)
-      @top = top
-      @bottom = bottom
-      @left = left
-      @right = right
-      @parent = parent
+      super(true, top, bottom, left, right, parent: parent)
     end
 
     # Parse ParagraphMargins object

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

@@ -11,7 +11,7 @@ module OoxmlParser
       @bottom = bottom
       @left = left
       @right = right
-      @parent = parent
+      super(parent: parent)
     end
 
     # TODO: Separate @is_default attribute and remove this method
@@ -29,7 +29,7 @@ module OoxmlParser
 
     # @return [String] result of convert of object to string
     def to_s
-      'Default: ' + is_default.to_s + ' top: ' + @top.to_s + ', bottom: ' + @bottom.to_s + ', left: ' + @left.to_s + ', right: ' + @right.to_s
+      "Default: #{is_default} top: #{@top}, bottom: #{@bottom}, left: #{@left}, right: #{@right}"
     end
 
     # Parse TableMargins object

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

@@ -15,7 +15,7 @@ module OoxmlParser
       @banding_column = false
       @no_horizontal_banding = false
       @no_horizontal_banding = false
-      @parent = parent
+      super
     end
 
     # Parse TableLook object

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

@@ -23,7 +23,7 @@ module OoxmlParser
       @type = type
       @run_properties = nil
       @table_cell_properties = CellProperties.new
-      @parent = parent
+      super(parent: parent)
     end
 
     # Parse table style property

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

@@ -9,7 +9,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @elements = []
-      @parent = parent
+      super
     end
 
     alias cell_properties properties

data/lib/ooxml_parser/common_parser/common_data/table/row/cell/grid_span.rb

@@ -10,15 +10,9 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @type = 'horizontal'
-      @parent = parent
+      super
     end
 
-    alias count_of_merged_cells value
-
-    extend Gem::Deprecate
-    deprecate :type, 'GridSpan always horizontal', 2069, 1
-    deprecate :count_of_merged_cells, 'value', 2069, 1
-
     # Parse Grid Span data
     # @param [Nokogiri::XML:Element] node with GridSpan data
     # @return [GridSpan] value of GridSpan

data/lib/ooxml_parser/common_parser/common_data/table/row/cell/properties/borders.rb

@@ -15,7 +15,7 @@ module OoxmlParser
       @between = BordersProperties.new
       @inner_horizontal = BordersProperties.new
       @inner_vertical = BordersProperties.new
-      @parent = parent
+      super
     end
 
     # Method to copy object

data/lib/ooxml_parser/common_parser/common_data/table/row/cell/properties/table_cell_line.rb

@@ -9,7 +9,7 @@ module OoxmlParser
     def initialize(fill = nil, line_join = nil, parent: nil)
       @fill = fill
       @line_join = line_join
-      @parent = parent
+      super(parent: parent)
     end
 
     # Parse TableCellLine object

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

@@ -9,7 +9,7 @@ module OoxmlParser
 
     def initialize(cells = [], parent: nil)
       @cells = cells
-      @parent = parent
+      super(parent: parent)
     end
 
     alias table_row_height height

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

@@ -9,7 +9,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @columns = []
-      @parent = parent
+      super
     end
 
     # Compare this object to other

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

@@ -40,7 +40,7 @@ module OoxmlParser
     def initialize(parent: nil)
       @jc = :left
       @table_borders = TableBorders.new
-      @parent = parent
+      super
     end
 
     # Parse TableProperties object