caxlsx 3.2.0 → 3.4.0

data/lib/axlsx/workbook/worksheet/worksheet_comments.rb

@@ -1,58 +1,58 @@
-module Axlsx
-
-  # A wraper class for comments that defines its on worksheet
-  # serailization
-  class WorksheetComments
-
-    # Creates a new WorksheetComments object
-    # param [Worksheet] worksheet The worksheet comments in thes object belong to
-    def initialize(worksheet)
-      raise ArugumentError, 'You must provide a worksheet' unless worksheet.is_a?(Worksheet)
-      @worksheet = worksheet
-    end
-
-    attr_reader :worksheet
-
-    # The comments for this worksheet.
-    # @return [Comments]
-    def comments
-      @comments ||= Comments.new(worksheet)
-    end
-
-    # Adds a comment
-    # @param [Hash] options
-    # @see Comments#add_comment
-    def add_comment(options={})
-      comments.add_comment(options)
-    end 
-
-    # The relationships defined by this objects comments collection
-    # @return [Relationships]
-    def relationships
-      return [] unless has_comments?
-      comments.relationships
-    end
-
-
-    # Helper method to tell us if there are comments in the comments collection
-    # @return [Boolean]
-    def has_comments?
-      !comments.empty?
-    end
-
-    # The relationship id of the VML drawing that will render the comments.
-    # @see Relationship#Id
-    # @return [String]
-    def drawing_rId
-      comments.relationships.find{ |r| r.Type == VML_DRAWING_R }.Id
-    end
-
-    # Seraalize the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      return unless has_comments?
-      str << "<legacyDrawing r:id='#{drawing_rId}' />"
-    end
-  end
-end
+module Axlsx
+  # A wraper class for comments that defines its on worksheet
+  # serailization
+  class WorksheetComments
+    # Creates a new WorksheetComments object
+    # param [Worksheet] worksheet The worksheet comments in thes object belong to
+    def initialize(worksheet)
+      raise ArugumentError, 'You must provide a worksheet' unless worksheet.is_a?(Worksheet)
+
+      @worksheet = worksheet
+    end
+
+    attr_reader :worksheet
+
+    # The comments for this worksheet.
+    # @return [Comments]
+    def comments
+      @comments ||= Comments.new(worksheet)
+    end
+
+    # Adds a comment
+    # @param [Hash] options
+    # @see Comments#add_comment
+    def add_comment(options = {})
+      comments.add_comment(options)
+    end
+
+    # The relationships defined by this objects comments collection
+    # @return [Relationships]
+    def relationships
+      return [] unless has_comments?
+
+      comments.relationships
+    end
+
+    # Helper method to tell us if there are comments in the comments collection
+    # @return [Boolean]
+    def has_comments?
+      !comments.empty?
+    end
+
+    # The relationship id of the VML drawing that will render the comments.
+    # @see Relationship#Id
+    # @return [String]
+    def drawing_rId
+      comments.relationships.find { |r| r.Type == VML_DRAWING_R }.Id
+    end
+
+    # Seraalize the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      return unless has_comments?
+
+      str << "<legacyDrawing r:id='#{drawing_rId}' />"
+    end
+  end
+end

data/lib/axlsx/workbook/worksheet/worksheet_drawing.rb

@@ -1,58 +1,59 @@
-module Axlsx
-
-  # This is a utility class for serialing the drawing node in a
-  # worksheet. Drawing objects have their own serialization that exports
-  # a drawing document. This is only for the single node in the
-  # worksheet
-  class WorksheetDrawing
-
-    # Creates a new WorksheetDrawing
-    # @param [Worksheet] worksheet
-    def initialize(worksheet)
-      raise ArgumentError, 'you must provide a worksheet' unless worksheet.is_a?(Worksheet)
-      @worksheet = worksheet
-      @drawing = nil
-    end
-
-    attr_reader :worksheet
-
-    attr_reader :drawing
-
-    # adds a chart to the drawing object
-    # @param [Class] chart_type The type of chart to add
-    # @param [Hash] options Options to pass on to the drawing and chart
-    # @see Worksheet#add_chart
-    def add_chart(chart_type, options)
-      @drawing ||= Drawing.new worksheet
-      drawing.add_chart(chart_type, options)
-    end
-
-    # adds an image to the drawing object
-    # @param [Hash] options Options to pass on to the drawing and image
-    # @see Worksheet#add_image
-    def add_image(options)
-      @drawing ||= Drawing.new(worksheet)
-      drawing.add_image(options)
-    end
-
-    # helper method to tell us if the drawing has something in it or not
-    # @return [Boolean]
-    def has_drawing?
-      @drawing.is_a? Drawing
-    end
-
-    # The relationship instance for this drawing.
-    # @return [Relationship]
-    def relationship
-      return unless has_drawing?
-      Relationship.new(self, DRAWING_R, "../#{drawing.pn}")
-    end
-
-    # Serialize the drawing for the worksheet
-    # @param [String] str
-    def to_xml_string(str = '')
-      return unless has_drawing?
-      str << "<drawing r:id='#{relationship.Id}'/>"
-    end
-  end
-end
+module Axlsx
+  # This is a utility class for serialing the drawing node in a
+  # worksheet. Drawing objects have their own serialization that exports
+  # a drawing document. This is only for the single node in the
+  # worksheet
+  class WorksheetDrawing
+    # Creates a new WorksheetDrawing
+    # @param [Worksheet] worksheet
+    def initialize(worksheet)
+      raise ArgumentError, 'you must provide a worksheet' unless worksheet.is_a?(Worksheet)
+
+      @worksheet = worksheet
+      @drawing = nil
+    end
+
+    attr_reader :worksheet
+
+    attr_reader :drawing
+
+    # adds a chart to the drawing object
+    # @param [Class] chart_type The type of chart to add
+    # @param [Hash] options Options to pass on to the drawing and chart
+    # @see Worksheet#add_chart
+    def add_chart(chart_type, options)
+      @drawing ||= Drawing.new worksheet
+      drawing.add_chart(chart_type, options)
+    end
+
+    # adds an image to the drawing object
+    # @param [Hash] options Options to pass on to the drawing and image
+    # @see Worksheet#add_image
+    def add_image(options)
+      @drawing ||= Drawing.new(worksheet)
+      drawing.add_image(options)
+    end
+
+    # helper method to tell us if the drawing has something in it or not
+    # @return [Boolean]
+    def has_drawing?
+      @drawing.is_a? Drawing
+    end
+
+    # The relationship instance for this drawing.
+    # @return [Relationship]
+    def relationship
+      return unless has_drawing?
+
+      Relationship.new(self, DRAWING_R, "../#{drawing.pn}")
+    end
+
+    # Serialize the drawing for the worksheet
+    # @param [String] str
+    def to_xml_string(str = '')
+      return unless has_drawing?
+
+      str << "<drawing r:id='#{relationship.Id}'/>"
+    end
+  end
+end

data/lib/axlsx/workbook/worksheet/worksheet_hyperlink.rb

@@ -1,74 +1,73 @@
-module Axlsx
-
-  # A worksheet hyperlink object. Note that this is not the same as a drawing hyperlink object.
-  class WorksheetHyperlink
-
-    include Axlsx::OptionsParser
-    include Axlsx::Accessors
-    include Axlsx::SerializedAttributes
-    # Creates a new hyperlink object.
-    # @note the preferred way to add hyperlinks to your worksheet is the Worksheet#add_hyperlink method
-    # @param [Worksheet] worksheet the Worksheet that owns this hyperlink
-    # @param [Hash] options options to use when creating this hyperlink
-    # @option [String] display Display string, if different from string in string table. This is a property on the hyperlink object, but does not need to appear in the spreadsheet application UI.
-    # @option [String] location Location within target. If target is a workbook (or this workbook) this shall refer to a sheet and cell or a defined name. Can also be an HTML anchor if target is HTML file.
-    # @option [String] tooltip The tip to display when the user positions the mouse cursor over this hyperlink
-    # @option [Symbol] target This is :external by default. If you set it to anything else, the location is interpreted to be the current workbook.
-    # @option [String|Cell] ref The location of this hyperlink in the worksheet
-    def initialize(worksheet, options={})
-      DataTypeValidator.validate "Hyperlink.worksheet", [Worksheet], worksheet
-      @worksheet = worksheet
-      @target = :external
-      parse_options options
-      yield self if block_given?
-    end
-
-    string_attr_accessor :display, :location, :tooltip
-
-    serializable_attributes :display, :tooltip, :ref
-
-    #Cell location of hyperlink on worksheet.
-    # @return [String]
-    attr_reader :ref
-
-    # Sets the target for this hyperlink. Anything other than :external instructs the library to treat the location as an in-workbook reference.
-    # @param [Symbol] target
-    def target=(target)
-      @target = target
-    end
-
-    # Sets the cell location of this hyperlink in the worksheet
-    # @param [String|Cell] cell_reference The string reference or cell that defines where this hyperlink shows in the worksheet.
-    def ref=(cell_reference)
-      cell_reference = cell_reference.r if cell_reference.is_a?(Cell)
-      Axlsx::validate_string cell_reference
-      @ref = cell_reference
-    end
-
-    # The relationship instance for this hyperlink.
-    # A relationship is only required if `@target` is `:external`. If not, this method will simply return `nil`.
-    # @see #target=
-    # @return [Relationship]
-    def relationship
-      return unless @target == :external
-      Relationship.new(self, HYPERLINK_R, location, :target_mode => :External)
-    end
-
-    # Seralize the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str='')
-      str << '<hyperlink '
-      serialized_attributes str, location_or_id
-      str << '/>'
-    end
-
-    # The values to be used in serialization based on the target.
-    # location should only be specified for non-external targets.
-    # r:id should only be specified for external targets.
-    # @return [Hash]
-    def location_or_id
-      @target == :external ?  { :"r:id" => relationship.Id } : { :location => Axlsx::coder.encode(location) }
-    end
-  end
-end
+module Axlsx
+  # A worksheet hyperlink object. Note that this is not the same as a drawing hyperlink object.
+  class WorksheetHyperlink
+    include Axlsx::OptionsParser
+    include Axlsx::Accessors
+    include Axlsx::SerializedAttributes
+    # Creates a new hyperlink object.
+    # @note the preferred way to add hyperlinks to your worksheet is the Worksheet#add_hyperlink method
+    # @param [Worksheet] worksheet the Worksheet that owns this hyperlink
+    # @param [Hash] options options to use when creating this hyperlink
+    # @option [String] display Display string, if different from string in string table. This is a property on the hyperlink object, but does not need to appear in the spreadsheet application UI.
+    # @option [String] location Location within target. If target is a workbook (or this workbook) this shall refer to a sheet and cell or a defined name. Can also be an HTML anchor if target is HTML file.
+    # @option [String] tooltip The tip to display when the user positions the mouse cursor over this hyperlink
+    # @option [Symbol] target This is :external by default. If you set it to anything else, the location is interpreted to be the current workbook.
+    # @option [String|Cell] ref The location of this hyperlink in the worksheet
+    def initialize(worksheet, options = {})
+      DataTypeValidator.validate "Hyperlink.worksheet", [Worksheet], worksheet
+      @worksheet = worksheet
+      @target = :external
+      parse_options options
+      yield self if block_given?
+    end
+
+    string_attr_accessor :display, :location, :tooltip
+
+    serializable_attributes :display, :tooltip, :ref
+
+    # Cell location of hyperlink on worksheet.
+    # @return [String]
+    attr_reader :ref
+
+    # Sets the target for this hyperlink. Anything other than :external instructs the library to treat the location as an in-workbook reference.
+    # @param [Symbol] target
+    def target=(target)
+      @target = target
+    end
+
+    # Sets the cell location of this hyperlink in the worksheet
+    # @param [String|Cell] cell_reference The string reference or cell that defines where this hyperlink shows in the worksheet.
+    def ref=(cell_reference)
+      cell_reference = cell_reference.r if cell_reference.is_a?(Cell)
+      Axlsx::validate_string cell_reference
+      @ref = cell_reference
+    end
+
+    # The relationship instance for this hyperlink.
+    # A relationship is only required if `@target` is `:external`. If not, this method will simply return `nil`.
+    # @see #target=
+    # @return [Relationship]
+    def relationship
+      return unless @target == :external
+
+      Relationship.new(self, HYPERLINK_R, location, :target_mode => :External)
+    end
+
+    # Seralize the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<hyperlink '
+      serialized_attributes str, location_or_id
+      str << '/>'
+    end
+
+    # The values to be used in serialization based on the target.
+    # location should only be specified for non-external targets.
+    # r:id should only be specified for external targets.
+    # @return [Hash]
+    def location_or_id
+      @target == :external ? { :"r:id" => relationship.Id } : { :location => Axlsx::coder.encode(location) }
+    end
+  end
+end

data/lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb

@@ -1,38 +1,38 @@
-module Axlsx
-
-  #A collection of hyperlink objects for a worksheet
-  class WorksheetHyperlinks < SimpleTypedList
-
-    # Creates a new Hyperlinks collection
-    # @param [Worksheet] worksheet the worksheet that owns these hyperlinks
-    def initialize(worksheet)
-      DataTypeValidator.validate "Hyperlinks.worksheet", [Worksheet], worksheet
-      @worksheet = worksheet
-      super WorksheetHyperlink
-    end
-
-    # Creates and adds a new hyperlink based on the options provided
-    # @see WorksheetHyperlink#initialize
-    # @return [WorksheetHyperlink]
-    def add(options)
-      self << WorksheetHyperlink.new(@worksheet, options)
-      last
-    end
-
-    # The relationships required by this collection's hyperlinks
-    # @return Array
-    def relationships
-      return [] if empty?
-      map { |hyperlink| hyperlink.relationship }
-    end
-
-    # seralize the collection of hyperlinks
-    # @return [String]
-    def to_xml_string(str='')
-      return if empty?
-      str << '<hyperlinks>'
-      each { |hyperlink| hyperlink.to_xml_string(str) }
-      str << '</hyperlinks>'
-    end
-  end
-end
+module Axlsx
+  # A collection of hyperlink objects for a worksheet
+  class WorksheetHyperlinks < SimpleTypedList
+    # Creates a new Hyperlinks collection
+    # @param [Worksheet] worksheet the worksheet that owns these hyperlinks
+    def initialize(worksheet)
+      DataTypeValidator.validate "Hyperlinks.worksheet", [Worksheet], worksheet
+      @worksheet = worksheet
+      super WorksheetHyperlink
+    end
+
+    # Creates and adds a new hyperlink based on the options provided
+    # @see WorksheetHyperlink#initialize
+    # @return [WorksheetHyperlink]
+    def add(options)
+      self << WorksheetHyperlink.new(@worksheet, options)
+      last
+    end
+
+    # The relationships required by this collection's hyperlinks
+    # @return Array
+    def relationships
+      return [] if empty?
+
+      map { |hyperlink| hyperlink.relationship }
+    end
+
+    # seralize the collection of hyperlinks
+    # @return [String]
+    def to_xml_string(str = '')
+      return if empty?
+
+      str << '<hyperlinks>'
+      each { |hyperlink| hyperlink.to_xml_string(str) }
+      str << '</hyperlinks>'
+    end
+  end
+end