axlsx 1.3.1 → 1.3.2

data/lib/axlsx/drawing/drawing.rb

@@ -137,6 +137,12 @@ module Axlsx
       "#{DRAWING_RELS_PN % (index+1)}"
     end
 
+    # The index of a chart, image or hyperlink object this drawing contains
+    def index_of(object)
+      objects = charts + images + hyperlinks
+      objects.index(object)
+    end
+
     # The drawing's relationships.
     # @return [Relationships]
     def relationships

data/lib/axlsx/drawing/hyperlink.rb

@@ -5,6 +5,29 @@ module Axlsx
   # @see {file:README} README
   class Hyperlink
 
+    include Axlsx::SerializedAttributes
+    include Axlsx::OptionsParser
+
+    #Creates a hyperlink object
+    # parent must be a Pic for now, although I expect that other object support this tag and its cNvPr parent
+    # @param [Pic] parent
+    # @option options [String] tooltip message shown when hyperlinked object is hovered over with mouse.
+    # @option options [String] tgtFrame Target frame for opening hyperlink
+    # @option options [String] invalidUrl supposedly use to store the href when we know it is an invalid resource.
+    # @option options [String] href the target resource this hyperlink links to. This is actually stored on the relationship.
+    # @option options [String] action A string that can be used to perform specific actions. For excel please see this reference: http://msdn.microsoft.com/en-us/library/ff532419%28v=office.12%29.aspx
+    # @option options [Boolean] endSnd terminate any sound events when processing this link
+    # @option options [Boolean] history include this link in the list of visited links for the applications history.
+    # @option options [Boolean] highlightClick indicate that the link has already been visited.
+    def initialize(parent, options={})
+      DataTypeValidator.validate "Hyperlink.parent", [Pic], parent
+      @parent = parent
+      parse_options options
+      yield self if block_given?
+    end
+
+    serializable_attributes :invalid_url, :action, :end_snd, :highlight_click, :history, :tgt_frame, :tooltip
+
     # The destination of the hyperlink stored in the drawing's relationships document.
     # @return [String]
     attr_accessor :href
@@ -13,7 +36,9 @@ module Axlsx
     #
     # What exactly that means is beyond me so if you ever use this, let me know!
     # @return [String]
-    attr_accessor :invalidUrl
+    attr_accessor :invalid_url
+    alias :invalidUrl :invalid_url
+    alias :invalidUrl= :invalid_url=
 
     #An action to take when the link is clicked. The specification says "This can be used to specify a slide to be navigated to or a script of code to be run." but in most cases you will not need to do anything with this. MS does reserve a few interesting strings. @see http://msdn.microsoft.com/en-us/library/ff532419%28v=office.12%29.aspx
     # @return [String]
@@ -21,20 +46,24 @@ module Axlsx
 
     # Specifies if all sound events should be terminated when this link is clicked.
     # @return [Boolean]
-    attr_reader :endSnd
+    attr_reader :end_snd
+    alias :endSnd :end_snd
 
     # @see endSnd
     # @param [Boolean] v The boolean value indicating the termination of playing sounds on click
     # @return [Boolean]
-    def endSnd=(v) Axlsx::validate_boolean(v); @endSnd = v end
+    def end_snd=(v) Axlsx::validate_boolean(v); @end_snd = v end
+    alias :endSnd= :end_snd=
 
     # indicates that the link has already been clicked.
     # @return [Boolean]
-    attr_reader :highlightClick
+    attr_reader :highlight_click
+    alias :highlightClick :highlight_click
 
     # @see highlightClick
     # @param [Boolean] v The value to assign
-    def highlightClick=(v) Axlsx::validate_boolean(v); @highlightClick = v end
+    def highlight_click=(v) Axlsx::validate_boolean(v); @highlight_click = v end
+    alias :highlightClick= :highlight_click=
 
     # From the specs: Specifies whether to add this URI to the history when navigating to it. This allows for the viewing of this presentation without the storing of history information on the viewing machine. If this attribute is omitted, then a value of 1 or true is assumed.
     # @return [Boolean]
@@ -46,50 +75,29 @@ module Axlsx
 
     # From the specs: Specifies the target frame that is to be used when opening this hyperlink. When the hyperlink is activated this attribute is used to determine if a new window is launched for viewing or if an existing one can be used. If this attribute is omitted, than a new window is opened.
     # @return [String]
-    attr_accessor :tgtFrame
+    attr_accessor :tgt_frame
+    alias :tgtFrame :tgt_frame
+    alias :tgtFrame= :tgt_frame=
 
     # Text to show when you mouse over the hyperlink. If you do not set this, the href property will be shown.
     # @return [String]
     attr_accessor :tooltip
 
-    #Creates a hyperlink object
-    # parent must be a Pic for now, although I expect that other object support this tag and its cNvPr parent
-    # @param [Pic] parent
-    # @option options [String] tooltip message shown when hyperlinked object is hovered over with mouse.
-    # @option options [String] tgtFrame Target frame for opening hyperlink
-    # @option options [String] invalidUrl supposedly use to store the href when we know it is an invalid resource.
-    # @option options [String] href the target resource this hyperlink links to.
-    # @option options [String] action A string that can be used to perform specific actions. For excel please see this reference: http://msdn.microsoft.com/en-us/library/ff532419%28v=office.12%29.aspx
-    # @option options [Boolean] endSnd terminate any sound events when processing this link
-    # @option options [Boolean] history include this link in the list of visited links for the applications history.
-    # @option options [Boolean] highlightClick indicate that the link has already been visited.
-    def initialize(parent, options={})
-      DataTypeValidator.validate "Hyperlink.parent", [Pic], parent
-      @parent = parent
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-      yield self if block_given?
-
-    end
-
     # Serializes the object
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
-      h =  self.instance_values.merge({:'r:id' => "rId#{id}", :'xmlns:r' => XML_NS_R })
-      h.delete('href')
-      h.delete('parent')
       str << '<a:hlinkClick '
-      str << h.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      serialized_attributes str, {:'r:id' => "rId#{id}", :'xmlns:r' => XML_NS_R }
       str << '/>'
     end
 
     private
+
     # The relational ID for this hyperlink
     # @return [Integer]
     def id
-      @parent.anchor.drawing.charts.size + @parent.anchor.drawing.images.size + @parent.anchor.drawing.hyperlinks.index(self) + 1
+      @parent.anchor.drawing.index_of(self)+1
     end
 
   end

data/lib/axlsx/drawing/marker.rb

@@ -5,6 +5,18 @@ module Axlsx
   # @see Worksheet#add_chart
   class Marker
 
+    include Axlsx::OptionsParser
+
+    # Creates a new Marker object
+    # @option options [Integer] col
+    # @option options [Integer] colOff
+    # @option options [Integer] row
+    # @option options [Integer] rowOff
+    def initialize(options={})
+      @col, @colOff, @row, @rowOff = 0, 0, 0, 0
+      parse_options options
+    end
+
     # The column this marker anchors to
     # @return [Integer]
     attr_reader :col
@@ -21,19 +33,7 @@ module Axlsx
     # @return [Integer]
     attr_reader :rowOff
 
-    # Creates a new Marker object
-    # @option options [Integer] col
-    # @option options [Integer] colOff
-    # @option options [Integer] row
-    # @option options [Integer] rowOff
-    def initialize(options={})
-      @col, @colOff, @row, @rowOff = 0, 0, 0, 0
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
-      end
-    end
-
-    # @see col
+     # @see col
     def col=(v) Axlsx::validate_unsigned_int v; @col = v end
     # @see colOff
     def colOff=(v) Axlsx::validate_int v; @colOff = v end

data/lib/axlsx/drawing/num_data.rb

@@ -4,9 +4,7 @@ module Axlsx
   #This class specifies data for a particular data point. It is used for both numCache and numLit object
   class NumData
 
-    # A string representing the format code to apply. For more information see see the SpreadsheetML numFmt element's (§18.8.30) formatCode attribute.
-    # @return [String]
-    attr_reader :format_code
+    include Axlsx::OptionsParser
 
     # creates a new NumVal object
     # @option options [String] formatCode
@@ -15,11 +13,13 @@ module Axlsx
     def initialize(options={})
       @format_code = "General"
       @pt = SimpleTypedList.new NumVal
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
     end
 
+    # A string representing the format code to apply. For more information see see the SpreadsheetML numFmt element's (§18.8.30) formatCode attribute.
+    # @return [String]
+    attr_reader :format_code
+
     # 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=[])

data/lib/axlsx/drawing/num_data_source.rb

@@ -3,18 +3,7 @@ module Axlsx
   # A numeric data source for use by charts.
   class NumDataSource
 
-    # The tag name to use when serializing this data source.
-    # Only items defined in allowed_tag_names are allowed
-    # @return [Symbol]
-    attr_reader :tag_name
-
-    attr_reader :data
-
-    # allowed element tag names
-    # @return [Array]
-    def self.allowed_tag_names
-      [:yVal, :val]
-    end
+    include Axlsx::OptionsParser
 
     # creates a new NumDataSource object
     # @option options [Array] data An array of Cells or Numeric objects
@@ -30,12 +19,24 @@ module Axlsx
       if options[:data] && options[:data].first.is_a?(Cell)
         @f = Axlsx::cell_range(options[:data])
       end
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
+    end
+
+
+    # The tag name to use when serializing this data source.
+    # Only items defined in allowed_tag_names are allowed
+    # @return [Symbol]
+    attr_reader :tag_name
+
+    attr_reader :data
+
+    # allowed element tag names
+    # @return [Array]
+    def self.allowed_tag_names
+      [:yVal, :val]
     end
 
-    # sets the tag name for this data source
+     # sets the tag name for this data source
     # @param [Symbol] v One of the allowed_tag_names
     def tag_name=(v)
       Axlsx::RestrictionValidator.validate "#{self.class.name}.tag_name", self.class.allowed_tag_names, v

data/lib/axlsx/drawing/one_cell_anchor.rb

@@ -6,6 +6,26 @@ module Axlsx
   # @see Worksheet#add_image
   class OneCellAnchor
 
+    include Axlsx::OptionsParser
+ 
+    # Creates a new OneCellAnchor object and an Pic associated with it.
+    # @param [Drawing] drawing
+    # @option options [Array] start_at the col, row to start at
+    # @option options [Integer] width
+    # @option options [Integer] height
+    # @option options [String] image_src the file location of the image you will render
+    # @option options [String] name the name attribute for the rendered image
+    # @option options [String] descr the description of the image rendered
+    def initialize(drawing, options={})
+      @drawing = drawing
+      @width = 0
+      @height = 0
+      drawing.anchors << self
+      @from = Marker.new
+      parse_options options
+      @object = Pic.new(self, options)
+    end
+
     # A marker that defines the from cell anchor. The default from column and row are 0 and 0 respectively
     # @return [Marker]
     attr_reader :from
@@ -28,27 +48,6 @@ module Axlsx
     # @return [Integer]
     attr_reader :height
 
-
-    # Creates a new OneCellAnchor object and an Pic associated with it.
-    # @param [Drawing] drawing
-    # @option options [Array] start_at the col, row to start at
-    # @option options [Integer] width
-    # @option options [Integer] height
-    # @option options [String] image_src the file location of the image you will render
-    # @option options [String] name the name attribute for the rendered image
-    # @option options [String] descr the description of the image rendered
-    def initialize(drawing, options={})
-      @drawing = drawing
-      @width = 0
-      @height = 0
-      drawing.anchors << self
-      @from = Marker.new
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-      @object = Pic.new(self, options)
-    end
-
     # @see height
     def height=(v) Axlsx::validate_unsigned_int(v); @height = v; end
 
@@ -61,7 +60,6 @@ module Axlsx
       @drawing.anchors.index(self)
     end
 
-
     # Serializes the object
     # @param [String] str
     # @return [String]

data/lib/axlsx/drawing/pic.rb

@@ -5,6 +5,26 @@ module Axlsx
   # @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 [Intger] width
+    # @option options [Intger] height
+    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)
+    end
+
     # allowed file extenstions
     ALLOWED_EXTENSIONS = ['gif', 'jpeg', 'png', 'jpg']
 
@@ -12,7 +32,6 @@ module Axlsx
     # @return [String]
     attr_reader :name
 
-
     # A description of the picture
     # @return [String]
     attr_reader :descr
@@ -29,26 +48,6 @@ module Axlsx
     # The picture locking attributes for this picture
     attr_reader :picture_locking
 
-    # 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 [Intger] width
-    # @option options [Intger] height
-    def initialize(anchor, options={})
-      @anchor = anchor
-      @hyperlink = nil
-      @anchor.drawing.worksheet.workbook.images << self
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-      start_at(*options[:start_at]) if options[:start_at]
-      yield self if block_given?
-      @picture_locking = PictureLocking.new(options)
-    end
-
     attr_reader :hyperlink
 
     # sets or updates a hyperlink for this image.
@@ -136,8 +135,8 @@ module Axlsx
       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
+
+    # 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
@@ -148,7 +147,7 @@ module Axlsx
       @anchor.from.row = y
       @anchor.from
     end
-    
+
     # noop if not using a two cell anchor
     # @param [Integer] x The column
     # @param [Integer] y The row
@@ -178,7 +177,7 @@ module Axlsx
       str << '<a:prstGeom prst="rect"><a:avLst/></a:prstGeom></xdr:spPr></xdr:pic>'
 
     end
-     
+
     private
 
     # Changes the anchor to a one cell anchor.
@@ -186,7 +185,7 @@ module Axlsx
       return if @anchor.is_a?(OneCellAnchor)
       swap_anchor(OneCellAnchor.new(@anchor.drawing, :from => @anchor.from))
     end
-    
+
     #changes the anchor type to a two cell anchor
     def use_two_cell_anchor
       return if @anchor.is_a?(TwoCellAnchor)
@@ -202,6 +201,5 @@ module Axlsx
       @anchor.drawing.anchors[@anchor.drawing.anchors.index(@anchor)] = new_anchor
       @anchor = new_anchor
     end
-
   end
 end

data/lib/axlsx/drawing/picture_locking.rb

@@ -3,17 +3,17 @@ 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
 
-    attr_reader :noGrp
-    attr_reader :noSelect
-    attr_reader :noRot
-    attr_reader :noChangeAspect
-    attr_reader :noMove
-    attr_reader :noResize
-    attr_reader :noEditPoints
-    attr_reader :noAdjustHandles
-    attr_reader :noChangeArrowheads
-    attr_reader :noChangeShapeType
+    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
@@ -28,47 +28,15 @@ module Axlsx
     # @option options [Boolean] noChangeShapeType
     def initialize(options={})
       @noChangeAspect = true
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
     end
 
-    # @see noGrp
-    def noGrp=(v) Axlsx::validate_boolean v; @noGrp = v end
-
-    # @see noSelect
-    def noSelect=(v) Axlsx::validate_boolean v; @noSelect = v end
-
-    # @see noRot
-    def noRot=(v) Axlsx::validate_boolean v; @noRot = v end
-
-    # @see noChangeAspect
-    def noChangeAspect=(v) Axlsx::validate_boolean v; @noChangeAspect = v end
-
-    # @see noMove
-    def noMove=(v) Axlsx::validate_boolean v; @noMove = v end
-
-    # @see noResize
-    def noResize=(v) Axlsx::validate_boolean v; @noResize = v end
-
-    # @see noEditPoints
-    def noEditPoints=(v) Axlsx::validate_boolean v; @noEditPoints = v end
-
-    # @see noAdjustHandles
-    def noAdjustHandles=(v) Axlsx::validate_boolean v; @noAdjustHandles = v end
-
-    # @see noChangeArrowheads
-    def noChangeArrowheads=(v) Axlsx::validate_boolean v; @noChangeArrowheads = v end
-
-    # @see noChangeShapeType
-    def noChangeShapeType=(v) Axlsx::validate_boolean v; @noChangeShapeType = v end
-
     # Serializes the object
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
       str << '<a:picLocks '
-      str << instance_values.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      serialized_attributes str
       str << '/>'
     end