caxlsx 3.3.0 → 3.4.0

data/lib/axlsx/drawing/pic.rb

@@ -1,14 +1,13 @@
-# 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 [Boolean] :remote indicates if image_src is a remote URI
     # @option options [String] :name
     # @option options [String] :descr
     # @option options [String] :image_src
@@ -16,10 +15,11 @@ module Axlsx
     # @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={})
+    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?
@@ -56,10 +56,14 @@ module Axlsx
     # @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={})
+    def hyperlink=(v, options = {})
       options[:href] = v
       if hyperlink.is_a?(Hyperlink)
         options.each do |o|
@@ -73,8 +77,14 @@ module Axlsx
 
     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)
+      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
 
@@ -84,10 +94,17 @@ module Axlsx
     # @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 image_src.nil?
+      File.basename(image_src) unless remote? || image_src.nil?
     end
 
     # returns the extension of image_src without the preceeding '.'
@@ -105,19 +122,24 @@ module Axlsx
     # The part name for this image used in serialization and relationship building
     # @return [String]
     def pn
-      "#{IMAGE_PN % [(index+1), extname]}"
+      "#{IMAGE_PN % [(index + 1), extname]}"
     end
 
     # The relationship object for this pic.
     # @return [Relationship]
     def relationship
-      Relationship.new(self, IMAGE_R, "../#{pn}")
+      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
 
@@ -147,7 +169,7 @@ module Axlsx
     # @param [Integer] x The column
     # @param [Integer] y The row
     # @return [Marker]
-    def start_at(x, y=nil)
+    def start_at(x, y = nil)
       @anchor.start_at x, y
       @anchor.from
     end
@@ -156,7 +178,7 @@ module Axlsx
     # @param [Integer] x The column
     # @param [Integer] y The row
     # @return [Marker]
-    def end_at(x, y=nil)
+    def end_at(x, y = nil)
       use_two_cell_anchor unless @anchor.is_a?(TwoCellAnchor)
       @anchor.end_at x, y
       @anchor.to
@@ -174,7 +196,7 @@ module Axlsx
       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 << '">')
+      str << relationship_xml_portion
       if opacity
         str << "<a:alphaModFix amt=\"#{opacity}\"/>"
       end
@@ -186,16 +208,27 @@ module Axlsx
 
     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
+    # 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

data/lib/axlsx/drawing/picture_locking.rb

@@ -1,15 +1,13 @@
-# 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
+                          :noMove, :noResize, :noEditPoints, :noAdjustHandles,
+                          :noChangeArrowheads, :noChangeShapeType
 
     serializable_attributes :noGrp, :noSelect, :noRot, :noChangeAspect,
                             :noMove, :noResize, :noEditPoints, :noAdjustHandles,
@@ -26,7 +24,7 @@ module Axlsx
     # @option options [Boolean] noAdjustHandles
     # @option options [Boolean] noChangeArrowheads
     # @option options [Boolean] noChangeShapeType
-    def initialize(options={})
+    def initialize(options = {})
       @noChangeAspect = true
       parse_options options
     end
@@ -37,6 +35,5 @@ module Axlsx
     def to_xml_string(str = '')
       serialized_tag('a:picLocks', str)
     end
-
   end
 end

data/lib/axlsx/drawing/pie_3D_chart.rb

@@ -1,13 +1,9 @@
-# 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
@@ -22,11 +18,11 @@ module Axlsx
     # @option options [Integer] perspective
     # @see Chart
     # @see View3D
-    def initialize(frame, options={})
+    def initialize(frame, options = {})
       @vary_colors = true
       super(frame, options)
       @series_type = PieSeries
-      @view_3D = View3D.new({:rot_x =>30, :perspective=>30}.merge(options))
+      @view_3D = View3D.new({ :rot_x => 30, :perspective => 30 }.merge(options))
       @d_lbls = nil
     end
 
@@ -42,6 +38,5 @@ module Axlsx
         str << '</c:pie3DChart>'
       end
     end
-
   end
 end

data/lib/axlsx/drawing/pie_series.rb

@@ -1,12 +1,9 @@
-# encoding: UTF-8
 module Axlsx
-
   # A PieSeries defines the data and labels and explosion for pie charts series.
   # @note The recommended way to manage series is to use Chart#add_series
   # @see Worksheet#add_chart
   # @see Chart#add_series
   class PieSeries < Series
-
     # The data for this series.
     # @return [SimpleTypedList]
     attr_reader :data
@@ -28,7 +25,7 @@ module Axlsx
     # @option options [String] title
     # @option options [Integer] explosion
     # @param [Chart] chart
-    def initialize(chart, options={})
+    def initialize(chart, options = {})
       @explosion = nil
       @colors = []
       super(chart, options)
@@ -68,7 +65,5 @@ module Axlsx
 
     # assigns the labels for this series
     def labels=(v) DataTypeValidator.validate "Series.labels", [AxDataSource], v; @labels = v; end
-
   end
-
 end

data/lib/axlsx/drawing/scaling.rb

@@ -1,8 +1,6 @@
-# encoding: UTF-8
 module Axlsx
   # The Scaling class defines axis scaling
   class Scaling
-
     include Axlsx::OptionsParser
 
     # creates a new Scaling object
@@ -10,7 +8,7 @@ module Axlsx
     # @option options [Symbol] orientation
     # @option options [Float] max
     # @option options [Float] min
-    def initialize(options={})
+    def initialize(options = {})
       @orientation = :minMax
       @logBase, @min, @max = nil, nil, nil
       parse_options options
@@ -35,7 +33,7 @@ module Axlsx
     attr_reader :min
 
     # @see logBase
-    def logBase=(v) DataTypeValidator.validate "Scaling.logBase", [Integer], v, lambda { |arg| arg >= 2 && arg <= 1000}; @logBase = v; end
+    def logBase=(v) DataTypeValidator.validate "Scaling.logBase", [Integer], v, lambda { |arg| arg >= 2 && arg <= 1000 }; @logBase = v; end
     # @see orientation
     def orientation=(v) RestrictionValidator.validate "Scaling.orientation", [:minMax, :maxMin], v; @orientation = v; end
     # @see max
@@ -55,6 +53,5 @@ module Axlsx
       str << ('<c:max val="' << @max.to_s << '"/>') unless @max.nil?
       str << '</c:scaling>'
     end
-
   end
 end

data/lib/axlsx/drawing/scatter_chart.rb

@@ -1,12 +1,9 @@
-# encoding: UTF-8
 module Axlsx
-
   # The ScatterChart allows you to insert a scatter chart into your worksheet
   # @see Worksheet#add_chart
   # @see Chart#add_series
   # @see README for an example
   class ScatterChart < Chart
-
     include Axlsx::OptionsParser
 
     # The Style for the scatter chart
@@ -30,11 +27,11 @@ module Axlsx
     alias :yValAxis :y_val_axis
 
     # Creates a new scatter chart
-    def initialize(frame, options={})
+    def initialize(frame, options = {})
       @vary_colors = 0
       @scatter_style = :lineMarker
 
-           super(frame, options)
+      super(frame, options)
       @series_type = ScatterSeries
       @d_lbls = nil
       parse_options options

data/lib/axlsx/drawing/scatter_series.rb

@@ -1,13 +1,10 @@
-# encoding: UTF-8
 module Axlsx
-
   # A ScatterSeries defines the x and y position of data in the chart
   # @note The recommended way to manage series is to use Chart#add_series
   # @see Worksheet#add_chart
   # @see Chart#add_series
   # @see examples/example.rb
   class ScatterSeries < Series
-
     # The x data for this series.
     # @return [NamedAxisData]
     attr_reader :xData
@@ -37,7 +34,7 @@ module Axlsx
     attr_reader :marker_symbol
 
     # Creates a new ScatterSeries
-    def initialize(chart, options={})
+    def initialize(chart, options = {})
       @xData, @yData = nil
       if options[:smooth].nil?
         # If caller hasn't specified smoothing or not, turn smoothing on or off based on scatter style
@@ -53,7 +50,7 @@ module Axlsx
 
       super(chart, options)
       @xData = AxDataSource.new(:tag_name => :xVal, :data => options[:xData]) unless options[:xData].nil?
-      @yData = NumDataSource.new({:tag_name => :yVal, :data => options[:yData]}) unless options[:yData].nil?
+      @yData = NumDataSource.new({ :tag_name => :yVal, :data => options[:yData] }) unless options[:yData].nil?
     end
 
     # @see color

data/lib/axlsx/drawing/ser_axis.rb

@@ -1,8 +1,6 @@
-# encoding: UTF-8
 module Axlsx
-  #A SerAxis object defines a series axis
+  # A SerAxis object defines a series axis
   class SerAxis < Axis
-
     # The number of tick lables to skip between labels
     # @return [Integer]
     attr_reader :tick_lbl_skip
@@ -16,7 +14,7 @@ module Axlsx
     # Creates a new SerAxis object
     # @option options [Integer] tick_lbl_skip
     # @option options [Integer] tick_mark_skip
-    def initialize(options={})
+    def initialize(options = {})
       @tick_lbl_skip, @tick_mark_skip = 1, 1
       super(options)
     end
@@ -40,6 +38,4 @@ module Axlsx
       str << '</c:serAx>'
     end
   end
-
-
 end

data/lib/axlsx/drawing/series.rb

@@ -1,11 +1,9 @@
-# encoding: UTF-8
 module Axlsx
   # A Series defines the common series attributes and is the super class for all concrete series types.
   # @note The recommended way to manage series is to use Chart#add_series
   # @see Worksheet#add_chart
   # @see Chart#add_series
   class Series
-
     include Axlsx::OptionsParser
 
     # The chart that owns this series
@@ -20,7 +18,7 @@ module Axlsx
     # @param [Chart] chart
     # @option options [Integer] order
     # @option options [String] title
-    def initialize(chart, options={})
+    def initialize(chart, options = {})
       @order = nil
       self.chart = chart
       @chart.series << self
@@ -40,7 +38,7 @@ module Axlsx
     end
 
     # @see order
-    def order=(v)  Axlsx::validate_unsigned_int(v); @order = v; end
+    def order=(v) Axlsx::validate_unsigned_int(v); @order = v; end
 
     # @see title
     def title=(v)
@@ -52,7 +50,7 @@ module Axlsx
     private
 
     # assigns the chart for this series
-    def chart=(v)  DataTypeValidator.validate "Series.chart", Chart, v; @chart = v; end
+    def chart=(v) DataTypeValidator.validate "Series.chart", Chart, v; @chart = v; end
 
     # Serializes the object
     # @param [String] str

data/lib/axlsx/drawing/series_title.rb

@@ -1,8 +1,6 @@
-# encoding: UTF-8
 module Axlsx
   # A series title is a Title with a slightly different serialization than chart titles.
   class SeriesTitle < Title
-
     # Serializes the object
     # @param [String] str
     # @return [String]

data/lib/axlsx/drawing/str_data.rb

@@ -1,16 +1,13 @@
-# -*- coding: utf-8 -*-
 module Axlsx
-
-  #This specifies the last string data used for a chart. (e.g. strLit and strCache)
+  # This specifies the last string data used for a chart. (e.g. strLit and strCache)
   # This class is extended for NumData to include the formatCode attribute required for numLit and numCache
   class StrData
-
     include Axlsx::OptionsParser
 
     # creates a new StrVal object
     # @option options [Array] :data
     # @option options [String] :tag_name
-    def initialize(options={})
+    def initialize(options = {})
       @tag_prefix = :str
       @type = StrVal
       @pt = SimpleTypedList.new(@type)
@@ -19,7 +16,7 @@ module Axlsx
 
     # Creates the val objects for this data set. I am not overly confident this is going to play nicely with time and data types.
     # @param [Array] values An array of cells or values.
-    def data=(values=[])
+    def data=(values = [])
       @tag_name = values.first.is_a?(Cell) ? :strCache : :strLit
       values.each do |value|
         v = value.is_a?(Cell) ? value.value : value
@@ -36,7 +33,5 @@ module Axlsx
       end
       str << ('</c:' << @tag_name.to_s << '>')
     end
-
   end
-
 end

data/lib/axlsx/drawing/str_val.rb

@@ -1,14 +1,11 @@
-# -*- coding: utf-8 -*-
 module Axlsx
-
-  #This class specifies data for a particular data point.
+  # This class specifies data for a particular data point.
   class StrVal
-
     include Axlsx::OptionsParser
 
     # creates a new StrVal object
     # @option options [String] v
-    def initialize(options={})
+    def initialize(options = {})
       @v = ""
       @idx = 0
       parse_options options

data/lib/axlsx/drawing/title.rb

@@ -1,8 +1,6 @@
-# encoding: UTF-8
 module Axlsx
   # A Title stores information about the title of a chart
   class Title
-
     # The text to be shown. Setting this property directly with a string will remove the cell reference.
     # @return [String]
     attr_reader :text
@@ -17,7 +15,7 @@ module Axlsx
 
     # Creates a new Title object
     # @param [String, Cell] title The cell or string to be used for the chart's title
-    def initialize(title="", title_size="")
+    def initialize(title = "", title_size = "")
       self.cell = title if title.is_a?(Cell)
       self.text = title.to_s unless title.is_a?(Cell)
       if title_size.to_s.empty?
@@ -62,9 +60,9 @@ module Axlsx
     end
 
     # Not implemented at this time.
-    #def layout=(v) DataTypeValidator.validate 'Title.layout', Layout, v; @layout = v; end
-    #def overlay=(v) Axlsx::validate_boolean v; @overlay=v; end
-    #def spPr=(v) DataTypeValidator.validate 'Title.spPr', SpPr, v; @spPr = v; end
+    # def layout=(v) DataTypeValidator.validate 'Title.layout', Layout, v; @layout = v; end
+    # def overlay=(v) Axlsx::validate_boolean v; @overlay=v; end
+    # def spPr=(v) DataTypeValidator.validate 'Title.spPr', SpPr, v; @spPr = v; end
 
     # Serializes the object
     # @param [String] str
@@ -86,14 +84,14 @@ module Axlsx
           str << '</c:strRef>'
         else
           str << '<c:rich>'
-            str << '<a:bodyPr/>'
-            str << '<a:lstStyle/>'
-            str << '<a:p>'
-              str << '<a:r>'
-                str << ('<a:rPr sz="' << @text_size.to_s << '"/>')
-                str << ('<a:t>' << clean_value << '</a:t>')
-              str << '</a:r>'
-            str << '</a:p>'
+          str << '<a:bodyPr/>'
+          str << '<a:lstStyle/>'
+          str << '<a:p>'
+          str << '<a:r>'
+          str << ('<a:rPr sz="' << @text_size.to_s << '"/>')
+          str << ('<a:t>' << clean_value << '</a:t>')
+          str << '</a:r>'
+          str << '</a:p>'
           str << '</c:rich>'
         end
         str << '</c:tx>'
@@ -102,6 +100,5 @@ module Axlsx
       str << '<c:overlay val="0"/>'
       str << '</c:title>'
     end
-
   end
 end

data/lib/axlsx/drawing/two_cell_anchor.rb

@@ -1,10 +1,8 @@
-# encoding: UTF-8
 module Axlsx
   # This class details the anchor points for drawings.
   # @note The recommended way to manage drawings and charts is Worksheet#add_chart. Anchors are specified by the :start_at and :end_at options to that method.
   # @see Worksheet#add_chart
   class TwoCellAnchor
-
     include Axlsx::OptionsParser
 
     # A marker that defines the from cell anchor. The default from column and row are 0 and 0 respectively
@@ -32,10 +30,10 @@ module Axlsx
     # @param [Drawing] drawing
     # @option options [Array] :start_at the col, row to start at THIS IS DOCUMENTED BUT NOT IMPLEMENTED HERE!
     # @option options [Array] :end_at the col, row to end at
-    def initialize(drawing, options={})
+    def initialize(drawing, options = {})
       @drawing = drawing
       drawing.anchors << self
-      @from, @to =  Marker.new, Marker.new(:col => 5, :row=>10)
+      @from, @to =  Marker.new, Marker.new(:col => 5, :row => 10)
       parse_options options
 
       # bit of a hack to work around the fact that the coords for start at and end at
@@ -48,7 +46,7 @@ module Axlsx
     # @note The recommended way to set the start position for graphical
     # objects is directly thru the object.
     # @see Chart#start_at
-    def start_at(x, y=nil)
+    def start_at(x, y = nil)
       from.coord x, y
     end
 
@@ -56,7 +54,7 @@ module Axlsx
     # @note the recommended way to set the to position for graphical
     # objects is directly thru the object
     # @see Char#end_at
-    def end_at(x, y=nil)
+    def end_at(x, y = nil)
       to.coord x, y
     end
 
@@ -68,7 +66,7 @@ module Axlsx
     end
 
     # Creates an image associated with this anchor.
-    def add_pic(options={})
+    def add_pic(options = {})
       @object = Pic.new(self, options)
     end
 

data/lib/axlsx/drawing/val_axis.rb

@@ -1,8 +1,6 @@
-# encoding: UTF-8
 module Axlsx
   # the ValAxis class defines a chart value axis.
   class ValAxis < Axis
-
     # This element specifies how the value axis crosses the category axis.
     # must be one of [:between, :midCat]
     # @return [Symbol]
@@ -11,7 +9,7 @@ module Axlsx
 
     # Creates a new ValAxis object
     # @option options [Symbol] crosses_between
-    def initialize(options={})
+    def initialize(options = {})
       self.cross_between = :between
       super(options)
     end
@@ -32,6 +30,5 @@ module Axlsx
       str << ('<c:crossBetween val="' << @cross_between.to_s << '"/>')
       str << '</c:valAx>'
     end
-
   end
 end