caxlsx 3.2.0 → 3.4.0

data/lib/axlsx/drawing/pic.rb

@@ -1,211 +1,244 @@
-# encoding: UTF-8
-module Axlsx
-  # a Pic object represents an image in your worksheet
-  # Worksheet#add_image is the recommended way to manage images in your sheets
-  # @see Worksheet#add_image
-  class Pic
-
-    include Axlsx::OptionsParser
-
-    # Creates a new Pic(ture) object
-    # @param [Anchor] anchor the anchor that holds this image
-    # @option options [String] :name
-    # @option options [String] :descr
-    # @option options [String] :image_src
-    # @option options [Array] :start_at
-    # @option options [Integer] :width
-    # @option options [Integer] :height
-    # @option options [Float] :opacity - set the picture opacity, accepts a value between 0.0 and 1.0
-    def initialize(anchor, options={})
-      @anchor = anchor
-      @hyperlink = nil
-      @anchor.drawing.worksheet.workbook.images << self
-      parse_options options
-      start_at(*options[:start_at]) if options[:start_at]
-      yield self if block_given?
-      @picture_locking = PictureLocking.new(options)
-      @opacity = (options[:opacity] * 100000).round if options[:opacity]
-    end
-
-    # allowed mime types
-    ALLOWED_MIME_TYPES = %w(image/jpeg image/png image/gif)
-
-    # The name to use for this picture
-    # @return [String]
-    attr_reader :name
-
-    # A description of the picture
-    # @return [String]
-    attr_reader :descr
-
-    # The path to the image you want to include
-    # Only local images are supported at this time.
-    # @return [String]
-    attr_reader :image_src
-
-    # The anchor for this image
-    # @return [OneCellAnchor]
-    attr_reader :anchor
-
-    # The picture locking attributes for this picture
-    attr_reader :picture_locking
-
-    attr_reader :hyperlink
-
-    # Picture opacity
-    # @return [Integer]
-    attr_reader :opacity
-
-    # sets or updates a hyperlink for this image.
-    # @param [String] v The href value for the hyper link
-    # @option options @see Hyperlink#initialize All options available to the Hyperlink class apply - however href will be overridden with the v parameter value.
-    def hyperlink=(v, options={})
-      options[:href] = v
-      if hyperlink.is_a?(Hyperlink)
-        options.each do |o|
-          hyperlink.send("#{o[0]}=", o[1]) if hyperlink.respond_to? "#{o[0]}="
-        end
-      else
-        @hyperlink = Hyperlink.new(self, options)
-      end
-      hyperlink
-    end
-
-    def image_src=(v)
-      Axlsx::validate_string(v)
-      RestrictionValidator.validate 'Pic.image_src', ALLOWED_MIME_TYPES, MimeTypeUtils.get_mime_type(v)
-      raise ArgumentError, "File does not exist" unless File.exist?(v)
-      @image_src = v
-    end
-
-    # @see name
-    def name=(v) Axlsx::validate_string(v); @name = v; end
-
-    # @see descr
-    def descr=(v) Axlsx::validate_string(v); @descr = v; end
-
-    # The file name of image_src without any path information
-    # @return [String]
-    def file_name
-      File.basename(image_src) unless image_src.nil?
-    end
-
-    # returns the extension of image_src without the preceeding '.'
-    # @return [String]
-    def extname
-      File.extname(image_src).delete('.') unless image_src.nil?
-    end
-
-    # The index of this image in the workbooks images collections
-    # @return [Index]
-    def index
-      @anchor.drawing.worksheet.workbook.images.index(self)
-    end
-
-    # The part name for this image used in serialization and relationship building
-    # @return [String]
-    def pn
-      "#{IMAGE_PN % [(index+1), extname]}"
-    end
-
-    # The relationship object for this pic.
-    # @return [Relationship]
-    def relationship
-      Relationship.new(self, IMAGE_R, "../#{pn}")
-    end
-
-    # providing access to the anchor's width attribute
-    # @see OneCellAnchor.width
-    def width
-      return unless @anchor.is_a?(OneCellAnchor)
-      @anchor.width
-    end
-
-    # @see width
-    def width=(v)
-      use_one_cell_anchor unless @anchor.is_a?(OneCellAnchor)
-      @anchor.width = v
-    end
-
-    # providing access to update the anchor's height attribute
-    # @see OneCellAnchor.width
-    # @note this is a noop if you are using a TwoCellAnchor
-    def height
-      @anchor.height
-    end
-
-    # @see height
-    # @note This is a noop if you are using a TwoCellAnchor
-    def height=(v)
-      use_one_cell_anchor unless @anchor.is_a?(OneCellAnchor)
-      @anchor.height = v
-    end
-
-    # This is a short cut method to set the start anchor position
-    # If you need finer granularity in positioning use
-    # graphic_frame.anchor.from.colOff / rowOff
-    # @param [Integer] x The column
-    # @param [Integer] y The row
-    # @return [Marker]
-    def start_at(x, y=nil)
-      @anchor.start_at x, y
-      @anchor.from
-    end
-
-    # noop if not using a two cell anchor
-    # @param [Integer] x The column
-    # @param [Integer] y The row
-    # @return [Marker]
-    def end_at(x, y=nil)
-      use_two_cell_anchor unless @anchor.is_a?(TwoCellAnchor)
-      @anchor.end_at x, y
-      @anchor.to
-    end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<xdr:pic>'
-      str << '<xdr:nvPicPr>'
-      str << ('<xdr:cNvPr id="2" name="' << name.to_s << '" descr="' << descr.to_s << '">')
-      hyperlink.to_xml_string(str) if hyperlink.is_a?(Hyperlink)
-      str << '</xdr:cNvPr><xdr:cNvPicPr>'
-      picture_locking.to_xml_string(str)
-      str << '</xdr:cNvPicPr></xdr:nvPicPr>'
-      str << '<xdr:blipFill>'
-      str << ('<a:blip xmlns:r ="' << XML_NS_R << '" r:embed="' << relationship.Id << '">')
-      if opacity
-        str << "<a:alphaModFix amt=\"#{opacity}\"/>"
-      end
-      str << '</a:blip>'
-      str << '<a:stretch><a:fillRect/></a:stretch></xdr:blipFill><xdr:spPr>'
-      str << '<a:xfrm><a:off x="0" y="0"/><a:ext cx="2336800" cy="2161540"/></a:xfrm>'
-      str << '<a:prstGeom prst="rect"><a:avLst/></a:prstGeom></xdr:spPr></xdr:pic>'
-    end
-
-    private
-
-    # Changes the anchor to a one cell anchor.
-    def use_one_cell_anchor
-      return if @anchor.is_a?(OneCellAnchor)
-      new_anchor = OneCellAnchor.new(@anchor.drawing, :start_at => [@anchor.from.col, @anchor.from.row])
-      swap_anchor(new_anchor)
-    end
-
-    #changes the anchor type to a two cell anchor
-    def use_two_cell_anchor
-      return if @anchor.is_a?(TwoCellAnchor)
-      new_anchor = TwoCellAnchor.new(@anchor.drawing, :start_at => [@anchor.from.col, @anchor.from.row])
-      swap_anchor(new_anchor)
-    end
-
-    # refactoring of swapping code, law of demeter be damned!
-    def swap_anchor(new_anchor)
-      new_anchor.drawing.anchors.delete(new_anchor)
-      @anchor.drawing.anchors[@anchor.drawing.anchors.index(@anchor)] = new_anchor
-      new_anchor.instance_variable_set "@object", @anchor.object
-      @anchor = new_anchor
-    end
-  end
-end
+module Axlsx
+  # a Pic object represents an image in your worksheet
+  # Worksheet#add_image is the recommended way to manage images in your sheets
+  # @see Worksheet#add_image
+  class Pic
+    include Axlsx::OptionsParser
+
+    # Creates a new Pic(ture) object
+    # @param [Anchor] anchor the anchor that holds this image
+    # @option options [Boolean] :remote indicates if image_src is a remote URI
+    # @option options [String] :name
+    # @option options [String] :descr
+    # @option options [String] :image_src
+    # @option options [Array] :start_at
+    # @option options [Integer] :width
+    # @option options [Integer] :height
+    # @option options [Float] :opacity - set the picture opacity, accepts a value between 0.0 and 1.0
+    def initialize(anchor, options = {})
+      @anchor = anchor
+      @hyperlink = nil
+      @anchor.drawing.worksheet.workbook.images << self
+      @remote = options[:remote]
+      parse_options options
+      start_at(*options[:start_at]) if options[:start_at]
+      yield self if block_given?
+      @picture_locking = PictureLocking.new(options)
+      @opacity = (options[:opacity] * 100000).round if options[:opacity]
+    end
+
+    # allowed mime types
+    ALLOWED_MIME_TYPES = %w(image/jpeg image/png image/gif)
+
+    # The name to use for this picture
+    # @return [String]
+    attr_reader :name
+
+    # A description of the picture
+    # @return [String]
+    attr_reader :descr
+
+    # The path to the image you want to include
+    # Only local images are supported at this time.
+    # @return [String]
+    attr_reader :image_src
+
+    # The anchor for this image
+    # @return [OneCellAnchor]
+    attr_reader :anchor
+
+    # The picture locking attributes for this picture
+    attr_reader :picture_locking
+
+    attr_reader :hyperlink
+
+    # Picture opacity
+    # @return [Integer]
+    attr_reader :opacity
+
+    # Flag for remote picture (from URI)
+    # @return [Boolean]
+    attr_reader :remote
+
+    # sets or updates a hyperlink for this image.
+    # @param [String] v The href value for the hyper link
+    # @option options @see Hyperlink#initialize All options available to the Hyperlink class apply - however href will be overridden with the v parameter value.
+    def hyperlink=(v, options = {})
+      options[:href] = v
+      if hyperlink.is_a?(Hyperlink)
+        options.each do |o|
+          hyperlink.send("#{o[0]}=", o[1]) if hyperlink.respond_to? "#{o[0]}="
+        end
+      else
+        @hyperlink = Hyperlink.new(self, options)
+      end
+      hyperlink
+    end
+
+    def image_src=(v)
+      Axlsx::validate_string(v)
+      if remote?
+        RegexValidator.validate('Pic.image_src', /\A#{URI::DEFAULT_PARSER.make_regexp}\z/, v)
+        RestrictionValidator.validate 'Pic.image_src', ALLOWED_MIME_TYPES, MimeTypeUtils.get_mime_type_from_uri(v)
+      else
+        RestrictionValidator.validate 'Pic.image_src', ALLOWED_MIME_TYPES, MimeTypeUtils.get_mime_type(v)
+        raise ArgumentError, "File does not exist" unless File.exist?(v)
+      end
+
+      @image_src = v
+    end
+
+    # @see name
+    def name=(v) Axlsx::validate_string(v); @name = v; end
+
+    # @see descr
+    def descr=(v) Axlsx::validate_string(v); @descr = v; end
+
+    # @see remote
+    def remote=(v) Axlsx::validate_boolean(v); @remote = v; end
+
+    def remote?
+      remote == 1 || remote.to_s == 'true'
+    end
+
+    # The file name of image_src without any path information
+    # @return [String]
+    def file_name
+      File.basename(image_src) unless remote? || image_src.nil?
+    end
+
+    # returns the extension of image_src without the preceeding '.'
+    # @return [String]
+    def extname
+      File.extname(image_src).delete('.') unless image_src.nil?
+    end
+
+    # The index of this image in the workbooks images collections
+    # @return [Index]
+    def index
+      @anchor.drawing.worksheet.workbook.images.index(self)
+    end
+
+    # The part name for this image used in serialization and relationship building
+    # @return [String]
+    def pn
+      "#{IMAGE_PN % [(index + 1), extname]}"
+    end
+
+    # The relationship object for this pic.
+    # @return [Relationship]
+    def relationship
+      if remote?
+        Relationship.new(self, IMAGE_R, "#{image_src}", target_mode: :External)
+      else
+        Relationship.new(self, IMAGE_R, "../#{pn}")
+      end
+    end
+
+    # providing access to the anchor's width attribute
+    # @see OneCellAnchor.width
+    def width
+      return unless @anchor.is_a?(OneCellAnchor)
+
+      @anchor.width
+    end
+
+    # @see width
+    def width=(v)
+      use_one_cell_anchor unless @anchor.is_a?(OneCellAnchor)
+      @anchor.width = v
+    end
+
+    # providing access to update the anchor's height attribute
+    # @see OneCellAnchor.width
+    # @note this is a noop if you are using a TwoCellAnchor
+    def height
+      @anchor.height
+    end
+
+    # @see height
+    # @note This is a noop if you are using a TwoCellAnchor
+    def height=(v)
+      use_one_cell_anchor unless @anchor.is_a?(OneCellAnchor)
+      @anchor.height = v
+    end
+
+    # This is a short cut method to set the start anchor position
+    # If you need finer granularity in positioning use
+    # graphic_frame.anchor.from.colOff / rowOff
+    # @param [Integer] x The column
+    # @param [Integer] y The row
+    # @return [Marker]
+    def start_at(x, y = nil)
+      @anchor.start_at x, y
+      @anchor.from
+    end
+
+    # noop if not using a two cell anchor
+    # @param [Integer] x The column
+    # @param [Integer] y The row
+    # @return [Marker]
+    def end_at(x, y = nil)
+      use_two_cell_anchor unless @anchor.is_a?(TwoCellAnchor)
+      @anchor.end_at x, y
+      @anchor.to
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<xdr:pic>'
+      str << '<xdr:nvPicPr>'
+      str << ('<xdr:cNvPr id="2" name="' << name.to_s << '" descr="' << descr.to_s << '">')
+      hyperlink.to_xml_string(str) if hyperlink.is_a?(Hyperlink)
+      str << '</xdr:cNvPr><xdr:cNvPicPr>'
+      picture_locking.to_xml_string(str)
+      str << '</xdr:cNvPicPr></xdr:nvPicPr>'
+      str << '<xdr:blipFill>'
+      str << relationship_xml_portion
+      if opacity
+        str << "<a:alphaModFix amt=\"#{opacity}\"/>"
+      end
+      str << '</a:blip>'
+      str << '<a:stretch><a:fillRect/></a:stretch></xdr:blipFill><xdr:spPr>'
+      str << '<a:xfrm><a:off x="0" y="0"/><a:ext cx="2336800" cy="2161540"/></a:xfrm>'
+      str << '<a:prstGeom prst="rect"><a:avLst/></a:prstGeom></xdr:spPr></xdr:pic>'
+    end
+
+    private
+
+    # Return correct xml relationship string portion
+    def relationship_xml_portion
+      if remote?
+        ('<a:blip xmlns:r ="' << XML_NS_R << '" r:link="' << relationship.Id << '">')
+      else
+        ('<a:blip xmlns:r ="' << XML_NS_R << '" r:embed="' << relationship.Id << '">')
+      end
+    end
+
+    # Changes the anchor to a one cell anchor.
+    def use_one_cell_anchor
+      return if @anchor.is_a?(OneCellAnchor)
+
+      new_anchor = OneCellAnchor.new(@anchor.drawing, :start_at => [@anchor.from.col, @anchor.from.row])
+      swap_anchor(new_anchor)
+    end
+
+    # changes the anchor type to a two cell anchor
+    def use_two_cell_anchor
+      return if @anchor.is_a?(TwoCellAnchor)
+
+      new_anchor = TwoCellAnchor.new(@anchor.drawing, :start_at => [@anchor.from.col, @anchor.from.row])
+      swap_anchor(new_anchor)
+    end
+
+    # refactoring of swapping code, law of demeter be damned!
+    def swap_anchor(new_anchor)
+      new_anchor.drawing.anchors.delete(new_anchor)
+      @anchor.drawing.anchors[@anchor.drawing.anchors.index(@anchor)] = new_anchor
+      new_anchor.instance_variable_set "@object", @anchor.object
+      @anchor = new_anchor
+    end
+  end
+end

data/lib/axlsx/drawing/picture_locking.rb

@@ -1,42 +1,39 @@
-# encoding: UTF-8
-module Axlsx
-  # The picture locking class defines the locking properties for pictures in your workbook.
-  class PictureLocking
-
-    include Axlsx::OptionsParser
-    include Axlsx::SerializedAttributes
-    include Axlsx::Accessors
-
-    boolean_attr_accessor :noGrp, :noSelect, :noRot, :noChangeAspect,
-                            :noMove, :noResize, :noEditPoints, :noAdjustHandles,
-                            :noChangeArrowheads, :noChangeShapeType
-
-    serializable_attributes :noGrp, :noSelect, :noRot, :noChangeAspect,
-                            :noMove, :noResize, :noEditPoints, :noAdjustHandles,
-                            :noChangeArrowheads, :noChangeShapeType
-
-    # Creates a new PictureLocking object
-    # @option options [Boolean] noGrp
-    # @option options [Boolean] noSelect
-    # @option options [Boolean] noRot
-    # @option options [Boolean] noChangeAspect
-    # @option options [Boolean] noMove
-    # @option options [Boolean] noResize
-    # @option options [Boolean] noEditPoints
-    # @option options [Boolean] noAdjustHandles
-    # @option options [Boolean] noChangeArrowheads
-    # @option options [Boolean] noChangeShapeType
-    def initialize(options={})
-      @noChangeAspect = true
-      parse_options options
-    end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      serialized_tag('a:picLocks', str)
-    end
-
-  end
-end
+module Axlsx
+  # The picture locking class defines the locking properties for pictures in your workbook.
+  class PictureLocking
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+    include Axlsx::Accessors
+
+    boolean_attr_accessor :noGrp, :noSelect, :noRot, :noChangeAspect,
+                          :noMove, :noResize, :noEditPoints, :noAdjustHandles,
+                          :noChangeArrowheads, :noChangeShapeType
+
+    serializable_attributes :noGrp, :noSelect, :noRot, :noChangeAspect,
+                            :noMove, :noResize, :noEditPoints, :noAdjustHandles,
+                            :noChangeArrowheads, :noChangeShapeType
+
+    # Creates a new PictureLocking object
+    # @option options [Boolean] noGrp
+    # @option options [Boolean] noSelect
+    # @option options [Boolean] noRot
+    # @option options [Boolean] noChangeAspect
+    # @option options [Boolean] noMove
+    # @option options [Boolean] noResize
+    # @option options [Boolean] noEditPoints
+    # @option options [Boolean] noAdjustHandles
+    # @option options [Boolean] noChangeArrowheads
+    # @option options [Boolean] noChangeShapeType
+    def initialize(options = {})
+      @noChangeAspect = true
+      parse_options options
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      serialized_tag('a:picLocks', str)
+    end
+  end
+end

data/lib/axlsx/drawing/pie_3D_chart.rb

@@ -1,47 +1,42 @@
-# encoding: UTF-8
-module Axlsx
-
-
-  # The Pie3DChart is a three dimentional piechart (who would have guessed?) that you can add to your worksheet.
-  # @see Worksheet#add_chart
-  # @see Chart#add_series
-  # @see README for an example
-  class Pie3DChart < Chart
-
-    # Creates a new pie chart object
-    # @param [GraphicFrame] frame The workbook that owns this chart.
-    # @option options [Cell, String] title
-    # @option options [Boolean] show_legend
-    # @option options [Symbol] grouping
-    # @option options [String] gap_depth
-    # @option options [Integer] rot_x
-    # @option options [String] h_percent
-    # @option options [Integer] rot_y
-    # @option options [String] depth_percent
-    # @option options [Boolean] r_ang_ax
-    # @option options [Integer] perspective
-    # @see Chart
-    # @see View3D
-    def initialize(frame, options={})
-      @vary_colors = true
-      super(frame, options)
-      @series_type = PieSeries
-      @view_3D = View3D.new({:rot_x =>30, :perspective=>30}.merge(options))
-      @d_lbls = nil
-    end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      super(str) do
-        str << '<c:pie3DChart>'
-        str << ('<c:varyColors val="' << vary_colors.to_s << '"/>')
-        @series.each { |ser| ser.to_xml_string(str) }
-        d_lbls.to_xml_string(str) if @d_lbls
-        str << '</c:pie3DChart>'
-      end
-    end
-
-  end
-end
+module Axlsx
+  # The Pie3DChart is a three dimentional piechart (who would have guessed?) that you can add to your worksheet.
+  # @see Worksheet#add_chart
+  # @see Chart#add_series
+  # @see README for an example
+  class Pie3DChart < Chart
+    # Creates a new pie chart object
+    # @param [GraphicFrame] frame The workbook that owns this chart.
+    # @option options [Cell, String] title
+    # @option options [Boolean] show_legend
+    # @option options [Symbol] grouping
+    # @option options [String] gap_depth
+    # @option options [Integer] rot_x
+    # @option options [String] h_percent
+    # @option options [Integer] rot_y
+    # @option options [String] depth_percent
+    # @option options [Boolean] r_ang_ax
+    # @option options [Integer] perspective
+    # @see Chart
+    # @see View3D
+    def initialize(frame, options = {})
+      @vary_colors = true
+      super(frame, options)
+      @series_type = PieSeries
+      @view_3D = View3D.new({ :rot_x => 30, :perspective => 30 }.merge(options))
+      @d_lbls = nil
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do
+        str << '<c:pie3DChart>'
+        str << ('<c:varyColors val="' << vary_colors.to_s << '"/>')
+        @series.each { |ser| ser.to_xml_string(str) }
+        d_lbls.to_xml_string(str) if @d_lbls
+        str << '</c:pie3DChart>'
+      end
+    end
+  end
+end