axlsx 1.0.8 → 1.0.9

data/lib/axlsx/stylesheet/num_fmt.rb

@@ -37,11 +37,11 @@ module Axlsx
     #   48 ##0.0E+0
     #   49 @
     # @see Axlsx
-    attr_accessor :numFmtId
+    attr_reader :numFmtId
 
     # @return [String] The formatting to use for this number format. 
     # @see http://support.microsoft.com/kb/264372
-    attr_accessor :formatCode
+    attr_reader :formatCode
     def initialize(options={})
       @numFmtId = 0
       @formatCode = ""
@@ -50,7 +50,9 @@ module Axlsx
       end
     end
 
+    # @see numFmtId
     def numFmtId=(v) Axlsx::validate_unsigned_int v; @numFmtId = v end
+    # @see formatCode
     def formatCode=(v) Axlsx::validate_string v; @formatCode = v end
 
     # Creates a numFmt element applying the instance values of this object as attributes.

data/lib/axlsx/stylesheet/pattern_fill.rb

@@ -6,11 +6,11 @@ module Axlsx
 
     # The color to use for the the background in solid fills.
     # @return [Color]
-    attr_accessor :fgColor 
+    attr_reader :fgColor 
 
     # The color to use for the background of the fill when the type is not solid.
     # @return [Color]
-    attr_accessor :bgColor
+    attr_reader :bgColor
 
     # The pattern type to use
     # @note 
@@ -35,7 +35,7 @@ module Axlsx
     #   :gray125
     #   :gray0625
     # @see Office Open XML Part 1 18.18.55
-    attr_accessor :patternType
+    attr_reader :patternType
 
     # Creates a new PatternFill Object
     # @option options [Symbol] patternType
@@ -47,9 +47,11 @@ module Axlsx
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
       end
     end
-
+    # @see fgColor
     def fgColor=(v) DataTypeValidator.validate "PatternFill.fgColor", Color, v; @fgColor=v end
+    # @see bgColor
     def bgColor=(v) DataTypeValidator.validate "PatternFill.bgColor", Color, v; @bgColor=v end
+    # @see patternType
     def patternType=(v) Axlsx::validate_pattern_type v; @patternType = v end    
 
     # Serializes the pattern fill

data/lib/axlsx/stylesheet/styles.rb

@@ -197,10 +197,10 @@ module Axlsx
                  else
                    options[:num_fmt] || 0
                  end
-
+      
       borderId = options[:border] || 0
       raise ArgumentError, "Invalid borderId" unless borderId < borders.size
-
+      
       fill = if options[:bg_color]
                color = Color.new(:rgb=>options[:bg_color])
                pattern = PatternFill.new(:patternType =>:solid, :fgColor=>color)
@@ -208,7 +208,7 @@ module Axlsx
              else
                0
              end
-
+      
       fontId = if (options.values_at(:fg_color, :sz, :b, :i, :strike, :outline, :shadow, :charset, :family, :font_name).length)
                  font = Font.new()
                  [:b, :i, :strike, :outline, :shadow, :charset, :family, :sz].each { |k| font.send("#{k}=", options[k]) unless options[k].nil? }
@@ -218,11 +218,11 @@ module Axlsx
                else
                  0 
                end
-
-       applyProtection = (options[:hidden] || options[:locked]) ? 1 : 0
-       
+      
+      applyProtection = (options[:hidden] || options[:locked]) ? 1 : 0
+      
       xf = Xf.new(:fillId => fill, :fontId=>fontId, :applyFill=>1, :applyFont=>1, :numFmtId=>numFmtId, :borderId=>borderId, :applyProtection=>applyProtection)
-
+      
       if options[:alignment]
         xf.alignment = CellAlignment.new(options[:alignment])
       end
@@ -230,16 +230,16 @@ module Axlsx
       if applyProtection
         xf.protection = CellProtection.new(options)
       end
-
+      
       cellXfs << xf
-     end
-
+    end
+    
     # Serializes the styles document
     # @return [String]
     def to_xml()
       builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
         xml.styleSheet(:xmlns => XML_NS) {
-          [:numFmts, :fonts, :fills, :borders, :cellStyleXfs, :cellXfs, :dxfs, :tableStyles].each do |key|
+          [:numFmts, :fonts, :fills, :borders, :cellStyleXfs, :cellXfs, :cellStyles, :dxfs, :tableStyles].each do |key|
             self.instance_values[key.to_s].to_xml(xml)
           end
         }
@@ -280,7 +280,7 @@ module Axlsx
       @cellStyleXfs.lock
 
       @cellStyles = SimpleTypedList.new CellStyle
-      @cellStyles << CellStyle.new(:name =>"標準", :builtinId =>0, :xfId=>0)
+      @cellStyles << CellStyle.new(:name =>"Normal", :builtinId =>0, :xfId=>0)
       @cellStyles.lock
 
       @cellXfs = SimpleTypedList.new Xf, "cellXfs"

data/lib/axlsx/stylesheet/table_style.rb

@@ -5,15 +5,15 @@ module Axlsx
 
     # The name of this table style
     # @return [string]
-    attr_accessor :name
+    attr_reader :name
 
     # indicates if this style should be applied to pivot tables
     # @return [Boolean]
-    attr_accessor :pivot
+    attr_reader :pivot
 
     # indicates if this style should be applied to tables
     # @return [Boolean]
-    attr_accessor :table
+    attr_reader :table
 
     # creates a new TableStyle object
     # @raise [ArgumentError] if name option is not provided.
@@ -28,8 +28,11 @@ module Axlsx
       super TableStyleElement
     end
 
+    # @see name
     def name=(v) Axlsx::validate_string v; @name=v end
+    # @see pivot
     def pivot=(v) Axlsx::validate_boolean v; @pivot=v end
+    # @see table
     def table=(v) Axlsx::validate_boolean v; @table=v end
 
     # Serializes the table style

data/lib/axlsx/stylesheet/table_style_element.rb

@@ -32,15 +32,15 @@ module Axlsx
     #   :pageFieldLabels
     #   :pageFieldValues
     # @return [Symbol]
-    attr_accessor :type
+    attr_reader :type
 
     # Number of rows or columns used in striping when the type is firstRowStripe, secondRowStripe, firstColumnStripe, or secondColumnStripe.
     # @return [Integer]
-    attr_accessor :size
+    attr_reader :size
 
     # The dxfId this style element points to 
     # @return [Integer]
-    attr_accessor :dxfId
+    attr_reader :dxfId
 
     # creates a new TableStyleElement object
     # @option options [Symbol] type
@@ -51,9 +51,14 @@ module Axlsx
         self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
       end
     end
-    
+
+    # @see type
     def type=(v) Axlsx::validate_table_element_type v; @type = v end
+
+    # @see size
     def size=(v) Axlsx::validate_unsigned_int v; @size = v end
+
+    # @see dxfId
     def dxfId=(v) Axlsx::validate_unsigned_int v; @dxfId = v end
 
     # Serializes the table style element

data/lib/axlsx/stylesheet/table_styles.rb

@@ -5,12 +5,11 @@ module Axlsx
 
     # The default table style. The default value is 'TableStyleMedium9'
     # @return [String]
-    # 
-    attr_accessor :defaultTableStyle
+    attr_reader :defaultTableStyle
 
     # The default pivot table style. The default value is  'PivotStyleLight6'
     # @return [String]
-    attr_accessor :defaultPivotStyle
+    attr_reader :defaultPivotStyle
     
     # Creates a new TableStyles object that is a container for TableStyle objects
     # @option options [String] defaultTableStyle
@@ -20,8 +19,9 @@ module Axlsx
       @defaultPivotStyle = options[:defaultPivotStyle] || "PivotStyleLight16"      
       super TableStyle
     end
-
+    # @see defaultTableStyle
     def defaultTableStyle=(v) Axlsx::validate_string(v); @defaultTableStyle = v; end
+    # @see defaultPivotStyle
     def defaultPivotStyle=(v) Axlsx::validate_string(v); @defaultPivotStyle = v; end
 
     # Serializes the table styles element

data/lib/axlsx/stylesheet/xf.rb

@@ -1,107 +1,128 @@
 module Axlsx
-  # The Xf class defines a formatting record for use in Styles
+  # The Xf class defines a formatting record for use in Styles. The recommended way to manage styles for your workbook is with Styles#add_style
+  # @see Styles#add_style
   class Xf
     #does not support extList (ExtensionList)
 
     # The cell alignment for this style
     # @return [CellAlignment]
     # @see CellAlignment
-    attr_accessor :alignment
+    attr_reader :alignment
 
     # The cell protection for this style
     # @return [CellProtection]
     # @see CellProtection
-    attr_accessor :protection
+    attr_reader :protection
 
     # id of the numFmt to apply to this style
     # @return [Integer]
-    attr_accessor :numFmtId
+    attr_reader :numFmtId
 
     # index (0 based) of the font to be used in this style
     # @return [Integer]
-    attr_accessor :fontId
+    attr_reader :fontId
     
     # index (0 based) of the fill to be used in this style
     # @return [Integer]
-    attr_accessor :fillId
+    attr_reader :fillId
 
     # index (0 based) of the border to be used in this style
     # @return [Integer]
-    attr_accessor :borderId
+    attr_reader :borderId
 
     # index (0 based) of cellStylesXfs item to be used in this style. Only applies to cellXfs items
     # @return [Integer]
-    attr_accessor :xfId
+    attr_reader :xfId
 
     # indecates if text should be prefixed by a single quote in the cell
     # @return [Boolean]
-    attr_accessor :quotePrefix
+    attr_reader :quotePrefix
 
     # indicates if the cell has a pivot table drop down button
     # @return [Boolean]
-    attr_accessor :pivotButton
+    attr_reader :pivotButton
 
     # indicates if the numFmtId should be applied
     # @return [Boolean]
-    attr_accessor :applyNumberFormat
+    attr_reader :applyNumberFormat
 
     # indicates if the fontId should be applied
     # @return [Boolean]
-    attr_accessor :applyFont
+    attr_reader :applyFont
     
     # indicates if the fillId should be applied
     # @return [Boolean]
-    attr_accessor :applyFill
+    attr_reader :applyFill
 
     # indicates if the borderId should be applied
     # @return [Boolean]
-    attr_accessor :applyBorder
+    attr_reader :applyBorder
 
     # Indicates if the alignment options should be applied
     # @return [Boolean]
-    attr_accessor :applyAlignment
+    attr_reader :applyAlignment
 
     # Indicates if the protection options should be applied
     # @return [Boolean]
-    attr_accessor :applyProtection
+    attr_reader :applyProtection
 
     # Creates a new Xf object
-    # @option [Integer] numFmtId
-    # @option [Integer] fontId
-    # @option [Integer] fillId
-    # @option [Integer] borderId
-    # @option [Integer] xfId
-    # @option [Boolean] quotePrefix
-    # @option [Boolean] pivotButton
-    # @option [Boolean] applyNumberFormat 
-    # @option [Boolean] applyFont
-    # @option [Boolean] applyFill
-    # @option [Boolean] applyBorder
-    # @option [Boolean] applyAlignment
-    # @option [Boolean] applyProtection
-    # @option [CellAlignment] alignment
-    # @option [CellProtection] protection
+    # @option options [Integer] numFmtId
+    # @option options [Integer] fontId
+    # @option options [Integer] fillId
+    # @option options [Integer] borderId
+    # @option options [Integer] xfId
+    # @option options [Boolean] quotePrefix
+    # @option options [Boolean] pivotButton
+    # @option options [Boolean] applyNumberFormat 
+    # @option options [Boolean] applyFont
+    # @option options [Boolean] applyFill
+    # @option options [Boolean] applyBorder
+    # @option options [Boolean] applyAlignment
+    # @option options [Boolean] applyProtection
+    # @option options [CellAlignment] alignment
+    # @option options [CellProtection] protection
     def initialize(options={})
       options.each do |o|
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
       end
     end    
     
+    # @see Xf#alignment
     def alignment=(v) DataTypeValidator.validate "Xf.alignment", CellAlignment, v; @alignment = v end
+
+    # @see protection
     def protection=(v) DataTypeValidator.validate "Xf.protection", CellProtection, v; @protection = v end
 
+    # @see numFmtId
     def numFmtId=(v) Axlsx::validate_unsigned_int v; @numFmtId = v end    
+
+    # @see fontId
     def fontId=(v) Axlsx::validate_unsigned_int v; @fontId = v end    
+    # @see fillId
     def fillId=(v) Axlsx::validate_unsigned_int v; @fillId = v end    
+    # @see borderId
     def borderId=(v) Axlsx::validate_unsigned_int v; @borderId = v end    
+    # @see xfId
     def xfId=(v) Axlsx::validate_unsigned_int v; @xfId = v end    
+    # @see quotePrefix
     def quotePrefix=(v) Axlsx::validate_boolean v; @quotePrefix = v end    
+    # @see pivotButton
     def pivotButton=(v) Axlsx::validate_boolean v; @pivotButton = v end    
+    # @see applyNumberFormat
     def applyNumberFormat=(v) Axlsx::validate_boolean v; @applyNumberFormat = v end    
+    # @see applyFont
     def applyFont=(v) Axlsx::validate_boolean v; @applyFont = v end    
+    # @see applyFill
     def applyFill=(v) Axlsx::validate_boolean v; @applyFill = v end    
+
+    # @see applyBorder
     def applyBorder=(v) Axlsx::validate_boolean v; @applyBorder = v end    
+
+    # @see applyAlignment
     def applyAlignment=(v) Axlsx::validate_boolean v; @applyAlignment = v end    
+
+    # @see applyProtection
     def applyProtection=(v) Axlsx::validate_boolean v; @applyProtection = v end    
 
     # Serializes the xf elemen

data/lib/axlsx/util/validators.rb

@@ -31,7 +31,7 @@ module Axlsx
     # @raise [ArugumentError] Raised if the class of the value provided is not in the specified array of types or the block passed returns false
     # @return [Boolean] true if validation succeeds.
     # @see validate_boolean
-    def self.validate(name, types, v, other= lambda{|v| true })
+    def self.validate(name, types, v, other= lambda{|arg| true })
       types = [types] unless types.is_a? Array
       valid_type = false
       if v.class == Class
@@ -49,7 +49,7 @@ module Axlsx
   # @raise [ArgumentError] raised if the value is not a Fixnum or Integer value greater or equal to 0
   # @return [Boolean] true if the data is valid
   def self.validate_unsigned_int(v)
-    DataTypeValidator.validate(:unsigned_int, [Fixnum, Integer], v, lambda { |v| v.respond_to?(:>=) && v >= 0 })
+    DataTypeValidator.validate(:unsigned_int, [Fixnum, Integer], v, lambda { |arg| arg.respond_to?(:>=) && arg >= 0 })
   end
 
   # Requires that the value is a Fixnum or Integer
@@ -63,7 +63,7 @@ module Axlsx
   # it must be one of 0, 1, "true", "false", :true, :false, true, false, "0", or "1"
   # @param [Any] v The value validated
   def self.validate_boolean(v)
-    DataTypeValidator.validate(:boolean, [Fixnum, String, Integer, Symbol, TrueClass, FalseClass], v, lambda { |v| [0, 1, "true", "false", :true, :false, true, false, "0", "1"].include?(v) })
+    DataTypeValidator.validate(:boolean, [Fixnum, String, Integer, Symbol, TrueClass, FalseClass], v, lambda { |arg| [0, 1, "true", "false", :true, :false, true, false, "0", "1"].include?(arg) })
   end
 
   # Requires that the value is a String

data/lib/axlsx/version.rb

@@ -1,4 +1,4 @@
 module Axlsx
   # version
-  VERSION="1.0.8"
+  VERSION="1.0.9"
 end

data/lib/axlsx/workbook/workbook.rb

@@ -65,13 +65,6 @@ require 'axlsx/workbook/worksheet/worksheet.rb'
     # @return [Styles]
     attr_reader :styles
 
-     # The workbook relationships. This is managed automatically by the workbook
-    # @return [Relationships]
-    attr_reader :relationships
-
-    # Instance level access to the class variable 1904
-    # @return [Boolean]
-    attr_accessor :date1904
 
 
     # Indicates if the epoc date for serialization should be 1904. If false, 1900 is used.
@@ -89,9 +82,13 @@ require 'axlsx/workbook/worksheet/worksheet.rb'
       yield self if block_given?      
     end
 
-    def date1904=(v) Axlsx::validate_boolean v; @@date1904 = v; end
+    # Instance level access to the class variable 1904
+    # @return [Boolean]
     def date1904() @@date1904; end    
 
+    # see @date1904
+    def date1904=(v) Axlsx::validate_boolean v; @@date1904 = v; end
+
     # Sets the date1904 attribute to the provided boolean
     # @return [Boolean]
     def self.date1904=(v) Axlsx::validate_boolean v; @@date1904 = v; end
@@ -109,7 +106,9 @@ require 'axlsx/workbook/worksheet/worksheet.rb'
       yield worksheet if block_given?
       worksheet
     end
-    
+
+    # The workbook relationships. This is managed automatically by the workbook
+    # @return [Relationships]
     def relationships
       r = Relationships.new
       @worksheets.each do |sheet|