caxlsx 3.2.0 → 3.4.0

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
+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 = Axlsx.instance_values_for(self)[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,39 @@
-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

data/lib/axlsx/drawing/vml_shape.rb

@@ -1,66 +1,63 @@
-module Axlsx
-
-  # A VmlShape is used to position and render a comment.
-  class VmlShape
-
-    include Axlsx::OptionsParser
-    include Axlsx::Accessors
-
-    # Creates a new VmlShape
-    # @option options [Integer] row
-    # @option options [Integer] column
-    # @option options [Integer] left_column
-    # @option options [Integer] left_offset
-    # @option options [Integer] top_row
-    # @option options [Integer] top_offset
-    # @option options [Integer] right_column
-    # @option options [Integer] right_offset
-    # @option options [Integer] bottom_row
-    # @option options [Integer] bottom_offset
-    def initialize(options={})
-      @row = @column = @left_column = @top_row = @right_column = @bottom_row = 0
-      @left_offset = 15
-      @top_offset = 2
-      @right_offset = 50
-      @bottom_offset = 5
-      @visible = true
-      @id = (0...8).map{65.+(rand(25)).chr}.join
-      parse_options options
-      yield self if block_given?
-    end
-
-    unsigned_int_attr_accessor :row, :column, :left_column, :left_offset, :top_row, :top_offset,
-                               :right_column, :right_offset, :bottom_row, :bottom_offset
-
-    boolean_attr_accessor :visible
-
-    # serialize the shape to a string
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str ='')
-str << <<SHAME_ON_YOU
-
-<v:shape id="#{@id}" type="#_x0000_t202" fillcolor="#ffffa1 [80]" o:insetmode="auto"
-  style="visibility:#{@visible ? 'visible' : 'hidden'}">
-  <v:fill color2="#ffffa1 [80]"/>
-  <v:shadow on="t" obscured="t"/>
-  <v:path o:connecttype="none"/>
-  <v:textbox style='mso-fit-text-with-word-wrap:t'>
-   <div style='text-align:left'></div>
-  </v:textbox>
-
-  <x:ClientData ObjectType="Note">
-   <x:MoveWithCells/>
-   <x:SizeWithCells/>
-   <x:Anchor>#{left_column}, #{left_offset}, #{top_row}, #{top_offset}, #{right_column}, #{right_offset}, #{bottom_row}, #{bottom_offset}</x:Anchor>
-   <x:AutoFill>False</x:AutoFill>
-   <x:Row>#{row}</x:Row>
-   <x:Column>#{column}</x:Column>
-   #{@visible ? '<x:Visible/>' : ''}
-  </x:ClientData>
- </v:shape>
-SHAME_ON_YOU
-
-    end
-  end
-end
+module Axlsx
+  # A VmlShape is used to position and render a comment.
+  class VmlShape
+    include Axlsx::OptionsParser
+    include Axlsx::Accessors
+
+    # Creates a new VmlShape
+    # @option options [Integer] row
+    # @option options [Integer] column
+    # @option options [Integer] left_column
+    # @option options [Integer] left_offset
+    # @option options [Integer] top_row
+    # @option options [Integer] top_offset
+    # @option options [Integer] right_column
+    # @option options [Integer] right_offset
+    # @option options [Integer] bottom_row
+    # @option options [Integer] bottom_offset
+    def initialize(options = {})
+      @row = @column = @left_column = @top_row = @right_column = @bottom_row = 0
+      @left_offset = 15
+      @top_offset = 2
+      @right_offset = 50
+      @bottom_offset = 5
+      @visible = true
+      @id = (0...8).map { 65.+(rand(25)).chr }.join
+      parse_options options
+      yield self if block_given?
+    end
+
+    unsigned_int_attr_accessor :row, :column, :left_column, :left_offset, :top_row, :top_offset,
+                               :right_column, :right_offset, :bottom_row, :bottom_offset
+
+    boolean_attr_accessor :visible
+
+    # serialize the shape to a string
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << <<SHAME_ON_YOU
+
+<v:shape id="#{@id}" type="#_x0000_t202" fillcolor="#ffffa1 [80]" o:insetmode="auto"
+  style="visibility:#{@visible ? 'visible' : 'hidden'}">
+  <v:fill color2="#ffffa1 [80]"/>
+  <v:shadow on="t" obscured="t"/>
+  <v:path o:connecttype="none"/>
+  <v:textbox style='mso-fit-text-with-word-wrap:t'>
+   <div style='text-align:left'></div>
+  </v:textbox>
+
+  <x:ClientData ObjectType="Note">
+   <x:MoveWithCells/>
+   <x:SizeWithCells/>
+   <x:Anchor>#{left_column}, #{left_offset}, #{top_row}, #{top_offset}, #{right_column}, #{right_offset}, #{bottom_row}, #{bottom_offset}</x:Anchor>
+   <x:AutoFill>False</x:AutoFill>
+   <x:Row>#{row}</x:Row>
+   <x:Column>#{column}</x:Column>
+   #{@visible ? '<x:Visible/>' : ''}
+  </x:ClientData>
+ </v:shape>
+SHAME_ON_YOU
+    end
+  end
+end