axlsx 1.0.8 → 1.0.9

data/lib/axlsx/drawing/pie_series.rb

@@ -15,7 +15,7 @@ module Axlsx
 
     # The explosion for this series
     # @return [Integert]
-    attr_accessor :explosion
+    attr_reader :explosion
 
     # Creates a new series
     # @option options [Array, SimpleTypedList] data
@@ -24,21 +24,23 @@ module Axlsx
     # @option options [Integer] explosion
     # @param [Chart] chart
     def initialize(chart, options={})
+      @explosion = nil
       super(chart, options)
       self.labels = CatAxisData.new(options[:labels]) unless options[:labels].nil?
       self.data = ValAxisData.new(options[:data]) unless options[:data].nil?
     end 
     
+    # @see explosion
     def explosion=(v) Axlsx::validate_unsigned_int(v); @explosion = v; end
 
     # Serializes the series
     # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
     # @return [String]
     def to_xml(xml)
-      super(xml) do  |xml|
-        xml.send('c:explosion', :val=>@explosion) unless @explosion.nil?
-        @labels.to_xml(xml) unless @labels.nil?
-        @data.to_xml(xml) unless @data.nil?
+      super(xml) do  |xml_inner|
+        xml_inner.send('c:explosion', :val=>@explosion) unless @explosion.nil?
+        @labels.to_xml(xml_inner) unless @labels.nil?
+        @data.to_xml(xml_inner) unless @data.nil?
       end      
     end
     private 

data/lib/axlsx/drawing/scaling.rb

@@ -5,20 +5,20 @@ module Axlsx
     # logarithmic base for a logarithmic axis.
     # must be between 2 and 1000
     # @return [Integer]
-    attr_accessor :logBase
+    attr_reader :logBase
 
     # the orientation of the axis
     # must be one of [:minMax, :maxMin]
     # @return [Symbol]
-    attr_accessor :orientation
+    attr_reader :orientation
 
     # the maximum scaling
     # @return [Float]
-    attr_accessor :max
+    attr_reader :max
 
     # the minimu scaling
     # @return [Float]
-    attr_accessor :min
+    attr_reader :min
 
     # creates a new Scaling object
     # @option options [Integer, Fixnum] logBase
@@ -27,14 +27,20 @@ module Axlsx
     # @option options [Float] min
     def initialize(options={})
       @orientation = :minMax
+      @logBase, @min, @max = nil, nil, nil
       options.each do |o|
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
       end
     end
     
-    def logBase=(v) DataTypeValidator.validate "Scaling.logBase", [Integer, Fixnum], v, lambda { |v| v >= 2 && v <= 1000}; @logBase = v; end
+    # @see logBase
+    def logBase=(v) DataTypeValidator.validate "Scaling.logBase", [Integer, Fixnum], 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
     def max=(v) DataTypeValidator.validate "Scaling.max", Float, v; @max = v; end
+
+    # @see min
     def min=(v) DataTypeValidator.validate "Scaling.min", Float, v; @min = v; end
 
     # Serializes the axId

data/lib/axlsx/drawing/ser_axis.rb

@@ -4,11 +4,11 @@ module Axlsx
 
     # The number of tick lables to skip between labels
     # @return [Integer]
-    attr_accessor :tickLblSkip
+    attr_reader :tickLblSkip
 
     # The number of tickmarks to be skipped before the next one is rendered.
     # @return [Boolean]
-    attr_accessor :tickMarkSkip
+    attr_reader :tickMarkSkip
 
     # Creates a new SerAxis object
     # @param [Integer] axId the id of this axis. Inherited
@@ -19,10 +19,14 @@ module Axlsx
     # @option options [Integer] tickLblSkip
     # @option options [Integer] tickMarkSkip
     def initialize(axId, crossAx, options={})
+      @tickLblSkip, @tickMarkSkip = nil, nil
       super(axId, crossAx, options)
     end 
 
+    # @see tickLblSkip
     def tickLblSkip=(v) Axlsx::validate_unsigned_int(v); @tickLblSkip = v; end
+
+    # @see tickMarkSkip
     def tickMarkSkip=(v) Axlsx::validate_unsigned_int(v); @tickMarkSkip = v; end
 
     # Serializes the series axis

data/lib/axlsx/drawing/series.rb

@@ -9,40 +9,40 @@ module Axlsx
     # @return [Chart]
     attr_reader :chart
 
-    # The index of this series in the chart's series.
-    # @return [Integer]
-    attr_reader :index
-
-    # The order of this series in the chart's series. By default the order is the index of the series.
-    # @return [Integer]
-    attr_accessor :order
-
     # The title of the series
     # @return [SeriesTitle]
-    attr_accessor :title
+    attr_reader :title
 
     # Creates a new series
     # @param [Chart] chart
     # @option options [Integer] order
     # @option options [String] title
     def initialize(chart, options={})
+      @order = nil
       self.chart = chart
       @chart.series << self
       options.each do |o|
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
       end
     end    
-    
+
+    # The index of this series in the chart's series.
+    # @return [Integer]
     def index
       @chart.series.index(self)
     end
 
-    def order=(v)  Axlsx::validate_unsigned_int(v); @order = v; end
 
+    # The order of this series in the chart's series. By default the order is the index of the series.
+    # @return [Integer]
     def order
       @order || index
     end
 
+    # @see order
+    def order=(v)  Axlsx::validate_unsigned_int(v); @order = v; end
+
+    # @see title
     def title=(v) 
       v = SeriesTitle.new(v) if v.is_a?(String) || v.is_a?(Cell)
       DataTypeValidator.validate "#{self.class}.title", SeriesTitle, v

data/lib/axlsx/drawing/series_title.rb

@@ -8,7 +8,7 @@ module Axlsx
     def to_xml(xml)
       xml.send('c:tx') {
         xml.send('c:strRef') {
-          xml.send('c:f', range)
+          xml.send('c:f', Axlsx::cell_range([@cell]))
           xml.send('c:strCache') {
             xml.send('c:ptCount', :val=>1)
             xml.send('c:pt', :idx=>0) {

data/lib/axlsx/drawing/title.rb

@@ -4,11 +4,11 @@ module Axlsx
     
     # The text to be shown. Setting this property directly with a string will remove the cell reference.
     # @return [String]
-    attr_accessor :text
+    attr_reader :text
 
     # The cell that holds the text for the title. Setting this property will automatically update the text attribute.
     # @return [Cell]
-    attr_accessor :cell
+    attr_reader :cell
 
     # Creates a new Title object
     # @param [String, Cell] title The cell or string to be used for the chart's title
@@ -17,6 +17,7 @@ module Axlsx
       self.text = title.to_s unless title.is_a?(Cell)
     end
     
+    # @see text
     def text=(v) 
       DataTypeValidator.validate 'Title.text', String, v
       @text = v
@@ -24,6 +25,7 @@ module Axlsx
       v
     end
 
+    # @see cell
     def cell=(v)
       DataTypeValidator.validate 'Title.text', Cell, v
       @cell = v
@@ -43,7 +45,7 @@ module Axlsx
       xml.send('c:title') {
         xml.send('c:tx') {
           xml.send('c:strRef') {
-            xml.send('c:f', range)
+            xml.send('c:f', Axlsx::cell_range([@cell]))
             xml.send('c:strCache') {
               xml.send('c:ptCount', :val=>1)
               xml.send('c:pt', :idx=>0) {
@@ -55,14 +57,5 @@ module Axlsx
       }      
     end
     
-    private 
-
-    # returns the excel style abslute reference for the title when title is a Cell object
-    # @return [String]
-    def range
-      return "" unless @data.is_a?(Cell)
-      "#{@data.row.worksheet.name}!#{data.row.r_abs}"
-    end
-
   end
 end

data/lib/axlsx/drawing/two_cell_anchor.rb

@@ -24,9 +24,6 @@ module Axlsx
     # @return [Drawing]
     attr_reader :drawing
 
-    # The index of this anchor in the drawing
-    # @return [Integer]
-    attr_reader :index
 
     # Creates a new TwoCellAnchor object and sets up a reference to the from and to markers in the 
     # graphic_frame's chart. That means that you can do stuff like
@@ -51,6 +48,8 @@ module Axlsx
       @object.chart
     end
 
+    # The index of this anchor in the drawing
+    # @return [Integer]
     def index
       @drawing.anchors.index(self)
     end

data/lib/axlsx/drawing/val_axis.rb

@@ -5,7 +5,7 @@ module Axlsx
     # This element specifies how the value axis crosses the category axis.
     # must be one of [:between, :midCat]
     # @return [Symbol]
-    attr_accessor :crossBetween
+    attr_reader :crossBetween
 
     # Creates a new ValAxis object
     # @param [Integer] axId the id of this axis
@@ -18,7 +18,7 @@ module Axlsx
       self.crossBetween = :between
       super(axId, crossAx, options)
     end
-    
+    # @see crossBetween
     def crossBetween=(v) RestrictionValidator.validate "ValAxis.crossBetween", [:between, :midCat], v; @crossBetween = v; end
 
     # Serializes the value axis

data/lib/axlsx/drawing/view_3D.rb

@@ -11,30 +11,30 @@ module Axlsx
     # x rotation for the chart 
     # must be between -90 and 90
     # @return [Integer]
-    attr_accessor :rotX
+    attr_reader :rotX
     
     # height of chart as % of chart
     # must be between 5% and 500%
     # @return [String]
-    attr_accessor :hPercent
+    attr_reader :hPercent
     
     # y rotation for the chart
     # must be between 0 and 360
     # @return [Integer]
-    attr_accessor :rotY
+    attr_reader :rotY
     
     # depth or chart as % of chart width
     # must be between 20% and 2000%
     # @return [String]
-    attr_accessor :depthPercent
+    attr_reader :depthPercent
     
     # Chart axis are at right angles
     # @return [Boolean]
-    attr_accessor :rAngAx
+    attr_reader :rAngAx
     
     # field of view angle
     # @return [Integer]
-    attr_accessor :perspective
+    attr_reader :perspective
 
     # Creates a new View3D for charts
     # @option options [Integer] rotX
@@ -44,22 +44,29 @@ module Axlsx
     # @option options [Boolean] rAngAx
     # @option options [Integer] perspective
     def initialize(options={})
+      @rotX, @hPercent, @rotY, @depthPercent, @rAngAx, @perspective  = nil, nil, nil, nil, nil, nil 
       options.each do |o|
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
       end    
     end
 
-    def rotX=(v) DataTypeValidator.validate "#{self.class}.rotX", [Integer, Fixnum], v, lambda {|v| v >= -90 && v <= 90 }; @rotX = v; end
+    # @see rotX
+    def rotX=(v) DataTypeValidator.validate "#{self.class}.rotX", [Integer, Fixnum], v, lambda {|arg| arg >= -90 && arg <= 90 }; @rotX = v; end
 
+    # @see hPercent
     def hPercent=(v) RegexValidator.validate "#{self.class}.rotX", H_PERCENT_REGEX, v; @hPercent = v; end
 
-    def rotY=(v) DataTypeValidator.validate "#{self.class}.rotY", [Integer, Fixnum], v, lambda {|v| v >= 0 && v <= 360 }; @rotY = v; end
+    # @see rotY
+    def rotY=(v) DataTypeValidator.validate "#{self.class}.rotY", [Integer, Fixnum], v, lambda {|arg| arg >= 0 && arg <= 360 }; @rotY = v; end
 
+    # @see depthPercent
     def depthPercent=(v) RegexValidator.validate "#{self.class}.depthPercent", DEPTH_PERCENT_REGEX, v; @depthPercent = v; end
 
+    # @see rAngAx
     def rAngAx=(v) Axlsx::validate_boolean(v); @rAngAx = v; end
 
-    def perspective=(v) DataTypeValidator.validate "#{self.class}.perspective", [Integer, Fixnum], v, lambda {|v| v >= 0 && v <= 240 }; @perspective = v; end
+    # @see perspective
+    def perspective=(v) DataTypeValidator.validate "#{self.class}.perspective", [Integer, Fixnum], v, lambda {|arg| arg >= 0 && arg <= 240 }; @perspective = v; end
 
     # Serializes the view3D properties
     # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.

data/lib/axlsx/package.rb

@@ -1,12 +1,23 @@
 # -*- coding: utf-8 -*-
-# Create Office Open XML Spreadsheets (xlsx) with safe and full control over cell styles, automatically resized column widths and 3D pie charts.
 module Axlsx
   # Package is responsible for managing all the bits and peices that Open Office XML requires to make a valid
   # xlsx document including valdation and serialization.
   class Package
 
+    # Initializes your package
+    #
+    # @param [Hash] options A hash that you can use to specify the author and workbook for this package.
+    # @option options [String] :author The author of the document
+    # @example Package.new :author => 'you!', :workbook => Workbook.new
+    def initialize(options={})
+      @workbook = nil
+      @core, @app = Core.new, App.new
+      @core.creator = options[:author] || @core.creator
+      yield self if block_given?
+    end
+    
+
     # The workbook this package will serialize or validate.
-    # @attribute
     # @return [Workbook] If no workbook instance has been assigned with this package a new Workbook instance is returned.
     # @raise ArgumentError if workbook parameter is not a Workbook instance.
     # @note As there are multiple ways to instantiate a workbook for the package, 
@@ -18,25 +29,13 @@ module Axlsx
     #     wb = Pacakge.new().workbook
     #     #     # set the workbook after creating the package
     #     wb = Package.new().workbook = Workbook.new
-    attr_accessor :workbook
-
-    # Initializes your package
-    #
-    # @param [Hash] options A hash that you can use to specify the author and workbook for this package.
-    # @option options [String] :author The author of the document
-    # @example Package.new :author => 'you!', :workbook => Workbook.new
-    def initialize(options={})
-      @core, @app = Core.new, App.new
-      @core.creator = options[:author] || @core.creator
-      yield self if block_given?
-    end
-
-    def workbook=(workbook) DataTypeValidator.validate "Package.workbook", Workbook, workbook; @workbook = workbook; end
-
     def workbook
       @workbook || @workbook = Workbook.new
     end
 
+    # @see workbook
+    def workbook=(workbook) DataTypeValidator.validate "Package.workbook", Workbook, workbook; @workbook = workbook; end
+
     # Serialize your workbook to disk as an xlsx document.
     #
     # @param [File] output The file you want to serialize your package to
@@ -57,18 +56,17 @@ module Axlsx
       p = parts
       Zip::ZipOutputStream.open(output) do |zip|
         p.each do |part| 
-          zip.put_next_entry(part[:entry]); zip.puts(part[:doc]) unless part[:doc].nil?
-        end
-      end
-      Zip::ZipFile.open(output) do |zip|
-        p.each do |part|
-          if part[:path]
-            zip.add(part[:entry], part[:path], &proc{ true })
+          unless part[:doc].nil?
+            zip.put_next_entry(part[:entry]); 
+            zip.puts(part[:doc])
           end
-        end                  
+          unless part[:path].nil?
+            zip.put_next_entry(part[:entry]); 
+            # binread for 1.9.3
+            zip.write IO.respond_to?(:binread) ? IO.binread(part[:path]) : IO.read(part[:path])
+          end          
+        end
       end
-
-
       true
     end
 

data/lib/axlsx/rels/relationship.rb

@@ -5,7 +5,7 @@ module Axlsx
 
     # The location of the relationship target
     # @return [String]
-    attr_accessor :Target
+    attr_reader :Target
 
     # The type of relationship
     # @note Supported types are defined as constants in Axlsx:
@@ -20,13 +20,15 @@ module Axlsx
     # @see CHART_R
     # @see DRAWING_R
     # @return [String]
-    attr_accessor :Type
+    attr_reader :Type
     def initialize(type, target)
       self.Target=target
       self.Type=type
     end
 
+    # @see Target
     def Target=(v) Axlsx::validate_string v; @Target = v end
+    # @see Type
     def Type=(v) Axlsx::validate_relationship_type v; @Type = v end
 
     # Serializes the relationship    

data/lib/axlsx/stylesheet/border.rb

@@ -3,13 +3,13 @@ module Axlsx
   class Border
 
     # @return [Boolean] The diagonal up property for the border that indicates if the border should include a diagonal line from the bottom left to the top right of the cell. 
-    attr_accessor :diagonalUp
+    attr_reader :diagonalUp
     
     # @return [Boolean] The diagonal down property for the border that indicates if the border should include a diagonal line from the top left to the top right of the cell.
-    attr_accessor :diagonalDown
+    attr_reader :diagonalDown
 
     # @return [Boolean] The outline property for the border indicating that top, left, right and bottom borders should only be applied to the outside border of a range of cells.
-    attr_accessor :outline
+    attr_reader :outline
 
     # @return [SimpleTypedList] A list of BorderPr objects for this border. 
     attr_reader :prs
@@ -35,8 +35,11 @@ module Axlsx
       end
     end        
 
+    # @see diagonalUp
     def diagonalUp=(v) Axlsx::validate_boolean v; @diagonalUp = v end
+    # @see diagonalDown
     def diagonalDown=(v) Axlsx::validate_boolean v; @diagonalDown = v end
+    # @see outline
     def outline=(v) Axlsx::validate_boolean v; @outline = v end
 
     # Serializes the border element
@@ -44,7 +47,9 @@ module Axlsx
     def to_xml(xml)
       xml.border(self.instance_values.select{ |k,v| [:diagonalUp, :diagonalDown, :outline].include? k }) {
         [:start, :end, :left, :right, :top, :bottom, :diagonal, :vertical, :horizontal].each do |k|
-          @prs.select { |pr| pr.name == k }.each { |pr| pr.to_xml(xml) }
+          @prs.select { |pr| pr.name == k }.each do |part| 
+            part.to_xml(xml) 
+          end
         end
       }
     end