caxlsx 3.1.1 → 3.2.0

data/lib/axlsx/drawing/two_cell_anchor.rb

@@ -1,97 +1,97 @@
-# 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
-    # @return [Marker]
-    attr_reader :from
-    # A marker that returns the to cell anchor. The default to column and row are 5 and 10 respectively
-    # @return [Marker]
-    attr_reader :to
-
-    # The frame for your chart
-    # @note this will be discontinued in version 2.0 please use object
-    # @return [GraphicFrame]
-    # attr_reader :graphic_frame
-
-    # The object this anchor hosts
-    # @return [Pic, GraphicFrame]
-    attr_reader :object
-
-    # The drawing that holds this anchor
-    # @return [Drawing]
-    attr_reader :drawing
-
-    # Creates a new TwoCellAnchor object
-    # c.start_at 5, 9
-    # @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={})
-      @drawing = drawing
-      drawing.anchors << self
-      @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
-      # are passed in as an array when specified in intialization options - however
-      start_at(*options[:start_at]) if options[:start_at]
-      end_at(*options[:end_at]) if options[:end_at]
-    end
-
-    # sets the col, row attributes for the from marker.
-    # @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)
-      from.coord x, y
-    end
-
-    # sets the col, row attributes for the to marker
-    # @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)
-      to.coord x, y
-    end
-
-    # Creates a graphic frame and chart object associated with this anchor
-    # @return [Chart]
-    def add_chart(chart_type, options)
-      @object = GraphicFrame.new(self, chart_type, options)
-      @object.chart
-    end
-
-    # Creates an image associated with this anchor.
-    def add_pic(options={})
-      @object = Pic.new(self, options)
-    end
-
-    # The index of this anchor in the drawing
-    # @return [Integer]
-    def index
-      @drawing.anchors.index(self)
-    end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<xdr:twoCellAnchor>'
-      str << '<xdr:from>'
-      from.to_xml_string str
-      str << '</xdr:from>'
-      str << '<xdr:to>'
-      to.to_xml_string str
-      str << '</xdr:to>'
-      object.to_xml_string(str)
-      str << '<xdr:clientData/>'
-      str << '</xdr:twoCellAnchor>'
-    end
-  end
-end
+# 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
+    # @return [Marker]
+    attr_reader :from
+    # A marker that returns the to cell anchor. The default to column and row are 5 and 10 respectively
+    # @return [Marker]
+    attr_reader :to
+
+    # The frame for your chart
+    # @note this will be discontinued in version 2.0 please use object
+    # @return [GraphicFrame]
+    # attr_reader :graphic_frame
+
+    # The object this anchor hosts
+    # @return [Pic, GraphicFrame]
+    attr_reader :object
+
+    # The drawing that holds this anchor
+    # @return [Drawing]
+    attr_reader :drawing
+
+    # Creates a new TwoCellAnchor object
+    # c.start_at 5, 9
+    # @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={})
+      @drawing = drawing
+      drawing.anchors << self
+      @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
+      # are passed in as an array when specified in intialization options - however
+      start_at(*options[:start_at]) if options[:start_at]
+      end_at(*options[:end_at]) if options[:end_at]
+    end
+
+    # sets the col, row attributes for the from marker.
+    # @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)
+      from.coord x, y
+    end
+
+    # sets the col, row attributes for the to marker
+    # @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)
+      to.coord x, y
+    end
+
+    # Creates a graphic frame and chart object associated with this anchor
+    # @return [Chart]
+    def add_chart(chart_type, options)
+      @object = GraphicFrame.new(self, chart_type, options)
+      @object.chart
+    end
+
+    # Creates an image associated with this anchor.
+    def add_pic(options={})
+      @object = Pic.new(self, options)
+    end
+
+    # The index of this anchor in the drawing
+    # @return [Integer]
+    def index
+      @drawing.anchors.index(self)
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<xdr:twoCellAnchor>'
+      str << '<xdr:from>'
+      from.to_xml_string str
+      str << '</xdr:from>'
+      str << '<xdr:to>'
+      to.to_xml_string str
+      str << '</xdr:to>'
+      object.to_xml_string(str)
+      str << '<xdr:clientData/>'
+      str << '</xdr:twoCellAnchor>'
+    end
+  end
+end

data/lib/axlsx/drawing/val_axis.rb

@@ -1,37 +1,37 @@
-# 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]
-    attr_reader :cross_between
-    alias :crossBetween :cross_between
-
-    # Creates a new ValAxis object
-    # @option options [Symbol] crosses_between
-    def initialize(options={})
-      self.cross_between = :between
-      super(options)
-    end
-
-    # @see cross_between
-    def cross_between=(v)
-      RestrictionValidator.validate "ValAxis.cross_between", [:between, :midCat], v
-      @cross_between = v
-    end
-    alias :crossBetween= :cross_between=
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<c:valAx>'
-      super(str)
-      str << ('<c:crossBetween val="' << @cross_between.to_s << '"/>')
-      str << '</c:valAx>'
-    end
-
-  end
-end
+# 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]
+    attr_reader :cross_between
+    alias :crossBetween :cross_between
+
+    # Creates a new ValAxis object
+    # @option options [Symbol] crosses_between
+    def initialize(options={})
+      self.cross_between = :between
+      super(options)
+    end
+
+    # @see cross_between
+    def cross_between=(v)
+      RestrictionValidator.validate "ValAxis.cross_between", [:between, :midCat], v
+      @cross_between = v
+    end
+    alias :crossBetween= :cross_between=
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<c:valAx>'
+      super(str)
+      str << ('<c:crossBetween val="' << @cross_between.to_s << '"/>')
+      str << '</c:valAx>'
+    end
+
+  end
+end

data/lib/axlsx/drawing/view_3D.rb

@@ -1,115 +1,115 @@
-# encoding: UTF-8
-module Axlsx
-  # 3D attributes for a chart.
-  class View3D
-
-    include Axlsx::OptionsParser
-
-    # Creates a new View3D for charts
-    # @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
-    def initialize(options={})
-      @rot_x, @h_percent, @rot_y, @depth_percent, @r_ang_ax, @perspective  = nil, nil, nil, nil, nil, nil
-      parse_options options
-    end
-
-    # Validation for hPercent
-    H_PERCENT_REGEX = /0*(([5-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)/
-
-    # validation for depthPercent
-    DEPTH_PERCENT_REGEX = /0*(([2-9][0-9])|([1-9][0-9][0-9])|(1[0-9][0-9][0-9])|2000)/
-
-    # x rotation for the chart
-    # must be between -90 and 90
-    # @return [Integer]
-    attr_reader :rot_x
-    alias :rotX :rot_x
-
-    # height of chart as % of chart width
-    # must be between 5% and 500%
-    # @return [String]
-    attr_reader :h_percent
-    alias :hPercent :h_percent
-
-    # y rotation for the chart
-    # must be between 0 and 360
-    # @return [Integer]
-    attr_reader :rot_y
-    alias :rotY :rot_y
-
-    # depth or chart as % of chart width
-    # must be between 20% and 2000%
-    # @return [String]
-    attr_reader :depth_percent
-    alias :depthPercent :depth_percent
-
-    # Chart axis are at right angles
-    # @return [Boolean]
-    attr_reader :r_ang_ax
-    alias :rAngAx :r_ang_ax
-
-    # field of view angle
-    # @return [Integer]
-    attr_reader :perspective
-
-    # @see rot_x
-    def rot_x=(v)
-      RangeValidator.validate "View3D.rot_x", -90, 90, v
-      @rot_x = v
-    end
-    alias :rotX= :rot_x=
-
-      # @see h_percent
-      def h_percent=(v)
-        RegexValidator.validate "#{self.class}.h_percent", H_PERCENT_REGEX, v
-        @h_percent = v
-      end
-    alias :hPercent= :h_percent=
-
-      # @see rot_y
-      def rot_y=(v) 
-        RangeValidator.validate "View3D.rot_y", 0, 360, v
-        @rot_y = v
-      end
-    alias :rotY= :rot_y=
-
-      # @see depth_percent
-      def depth_percent=(v) RegexValidator.validate "#{self.class}.depth_percent", DEPTH_PERCENT_REGEX, v; @depth_percent = v; end
-    alias :depthPercent= :depth_percent=
-
-      # @see r_ang_ax
-      def r_ang_ax=(v) Axlsx::validate_boolean(v); @r_ang_ax = v; end
-    alias :rAngAx= :r_ang_ax=
-
-      # @see perspective
-      def perspective=(v)
-        RangeValidator.validate "View3D.perspective", 0, 240, v
-        @perspective = v
-      end
-
-    # DataTypeValidator.validate "#{self.class}.perspective", [Integer], v, lambda {|arg| arg >= 0 && arg <= 240 }; @perspective = v; end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<c:view3D>'
-      %w(rot_x h_percent rot_y depth_percent r_ang_ax perspective).each do |key|
-        str << element_for_attribute(key, 'c')
-      end
-      str << '</c:view3D>'
-    end
-
-    private
-    # Note: move this to Axlsx module if we find the smae pattern elsewhere.
-    def element_for_attribute(name, namespace='')
-      val = instance_values[name]
-      return "" if val == nil
-      "<%s:%s val='%s'/>" % [namespace, Axlsx::camel(name, false), val]
-    end
-  end
-end
+# encoding: UTF-8
+module Axlsx
+  # 3D attributes for a chart.
+  class View3D
+
+    include Axlsx::OptionsParser
+
+    # Creates a new View3D for charts
+    # @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
+    def initialize(options={})
+      @rot_x, @h_percent, @rot_y, @depth_percent, @r_ang_ax, @perspective  = nil, nil, nil, nil, nil, nil
+      parse_options options
+    end
+
+    # Validation for hPercent
+    H_PERCENT_REGEX = /0*(([5-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)/
+
+    # validation for depthPercent
+    DEPTH_PERCENT_REGEX = /0*(([2-9][0-9])|([1-9][0-9][0-9])|(1[0-9][0-9][0-9])|2000)/
+
+    # x rotation for the chart
+    # must be between -90 and 90
+    # @return [Integer]
+    attr_reader :rot_x
+    alias :rotX :rot_x
+
+    # height of chart as % of chart width
+    # must be between 5% and 500%
+    # @return [String]
+    attr_reader :h_percent
+    alias :hPercent :h_percent
+
+    # y rotation for the chart
+    # must be between 0 and 360
+    # @return [Integer]
+    attr_reader :rot_y
+    alias :rotY :rot_y
+
+    # depth or chart as % of chart width
+    # must be between 20% and 2000%
+    # @return [String]
+    attr_reader :depth_percent
+    alias :depthPercent :depth_percent
+
+    # Chart axis are at right angles
+    # @return [Boolean]
+    attr_reader :r_ang_ax
+    alias :rAngAx :r_ang_ax
+
+    # field of view angle
+    # @return [Integer]
+    attr_reader :perspective
+
+    # @see rot_x
+    def rot_x=(v)
+      RangeValidator.validate "View3D.rot_x", -90, 90, v
+      @rot_x = v
+    end
+    alias :rotX= :rot_x=
+
+      # @see h_percent
+      def h_percent=(v)
+        RegexValidator.validate "#{self.class}.h_percent", H_PERCENT_REGEX, v
+        @h_percent = v
+      end
+    alias :hPercent= :h_percent=
+
+      # @see rot_y
+      def rot_y=(v) 
+        RangeValidator.validate "View3D.rot_y", 0, 360, v
+        @rot_y = v
+      end
+    alias :rotY= :rot_y=
+
+      # @see depth_percent
+      def depth_percent=(v) RegexValidator.validate "#{self.class}.depth_percent", DEPTH_PERCENT_REGEX, v; @depth_percent = v; end
+    alias :depthPercent= :depth_percent=
+
+      # @see r_ang_ax
+      def r_ang_ax=(v) Axlsx::validate_boolean(v); @r_ang_ax = v; end
+    alias :rAngAx= :r_ang_ax=
+
+      # @see perspective
+      def perspective=(v)
+        RangeValidator.validate "View3D.perspective", 0, 240, v
+        @perspective = v
+      end
+
+    # DataTypeValidator.validate "#{self.class}.perspective", [Integer], v, lambda {|arg| arg >= 0 && arg <= 240 }; @perspective = v; end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<c:view3D>'
+      %w(rot_x h_percent rot_y depth_percent r_ang_ax perspective).each do |key|
+        str << element_for_attribute(key, 'c')
+      end
+      str << '</c:view3D>'
+    end
+
+    private
+    # Note: move this to Axlsx module if we find the smae pattern elsewhere.
+    def element_for_attribute(name, namespace='')
+      val = instance_values[name]
+      return "" if val == nil
+      "<%s:%s val='%s'/>" % [namespace, Axlsx::camel(name, false), val]
+    end
+  end
+end

data/lib/axlsx/drawing/vml_drawing.rb

@@ -1,42 +1,42 @@
-module Axlsx
-
-  # a vml drawing used for comments in excel.
-  class VmlDrawing
-
-    # creates a new Vml Drawing object.
-    # @param [Comments] comments the comments object this drawing is associated with
-    def initialize(comments)
-      raise ArgumentError, "you must provide a comments object" unless comments.is_a?(Comments)
-      @comments = comments
-    end
-
-    # The part name for this vml drawing
-    # @return [String]
-    def pn
-      "#{VML_DRAWING_PN}" % (@comments.worksheet.index + 1)
-    end
-
-    # serialize the vml_drawing to xml.
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << <<BAD_PROGRAMMER
-<xml xmlns:v="urn:schemas-microsoft-com:vml"
- xmlns:o="urn:schemas-microsoft-com:office:office"
- xmlns:x="urn:schemas-microsoft-com:office:excel">
- <o:shapelayout v:ext="edit">
-  <o:idmap v:ext="edit" data="#{@comments.worksheet.index+1}"/>
- </o:shapelayout>
- <v:shapetype id="_x0000_t202" coordsize="21600,21600" o:spt="202"
-  path="m0,0l0,21600,21600,21600,21600,0xe">
-  <v:stroke joinstyle="miter"/>
-  <v:path gradientshapeok="t" o:connecttype="rect"/>
- </v:shapetype>
-BAD_PROGRAMMER
-      @comments.each { |comment| comment.vml_shape.to_xml_string str }
-      str << "</xml>"
-
-    end
-
-  end
-end
+module Axlsx
+
+  # a vml drawing used for comments in excel.
+  class VmlDrawing
+
+    # creates a new Vml Drawing object.
+    # @param [Comments] comments the comments object this drawing is associated with
+    def initialize(comments)
+      raise ArgumentError, "you must provide a comments object" unless comments.is_a?(Comments)
+      @comments = comments
+    end
+
+    # The part name for this vml drawing
+    # @return [String]
+    def pn
+      "#{VML_DRAWING_PN}" % (@comments.worksheet.index + 1)
+    end
+
+    # serialize the vml_drawing to xml.
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << <<BAD_PROGRAMMER
+<xml xmlns:v="urn:schemas-microsoft-com:vml"
+ xmlns:o="urn:schemas-microsoft-com:office:office"
+ xmlns:x="urn:schemas-microsoft-com:office:excel">
+ <o:shapelayout v:ext="edit">
+  <o:idmap v:ext="edit" data="#{@comments.worksheet.index+1}"/>
+ </o:shapelayout>
+ <v:shapetype id="_x0000_t202" coordsize="21600,21600" o:spt="202"
+  path="m0,0l0,21600,21600,21600,21600,0xe">
+  <v:stroke joinstyle="miter"/>
+  <v:path gradientshapeok="t" o:connecttype="rect"/>
+ </v:shapetype>
+BAD_PROGRAMMER
+      @comments.each { |comment| comment.vml_shape.to_xml_string str }
+      str << "</xml>"
+
+    end
+
+  end
+end