axlsx 1.0.12 → 1.0.13

data/lib/axlsx/workbook/workbook.rb

@@ -0,0 +1,160 @@
+# -*- coding: utf-8 -*-
+module Axlsx 
+
+require 'axlsx/workbook/worksheet/cell.rb'
+require 'axlsx/workbook/worksheet/row.rb'
+require 'axlsx/workbook/worksheet/worksheet.rb'
+
+  # The Workbook class is an xlsx workbook that manages worksheets, charts, drawings and styles.
+  # The following parts of the Office Open XML spreadsheet specification are not implimented in this version.
+  # 
+  #   bookViews
+  #   calcPr
+  #   customWorkbookViews
+  #   definedNames
+  #   externalReferences
+  #   extLst
+  #   fileRecoveryPr
+  #   fileSharing
+  #   fileVersion
+  #   functionGroups
+  #   oleSize
+  #   pivotCaches
+  #   smartTagPr
+  #   smartTagTypes
+  #   webPublishing
+  #   webPublishObjects
+  #   workbookProtection
+  #   workbookPr*
+  #
+  #   *workbookPr is only supported to the extend of date1904
+  class Workbook
+
+    # A collection of worksheets associated with this workbook. 
+    # @note The recommended way to manage worksheets is add_worksheet
+    # @see Workbook#add_worksheet
+    # @see Worksheet
+    # @return [SimpleTypedList]
+    attr_reader :worksheets
+
+    # A colllection of charts associated with this workbook
+    # @note The recommended way to manage charts is Worksheet#add_chart
+    # @see Worksheet#add_chart
+    # @see Chart
+    # @return [SimpleTypedList]
+    attr_reader :charts
+
+    # A colllection of images associated with this workbook
+    # @note The recommended way to manage images is Worksheet#add_image
+    # @see Worksheet#add_image
+    # @see Pic
+    # @return [SimpleTypedList]
+    attr_reader :images
+
+    # A colllection of drawings associated with this workbook
+    # @note The recommended way to manage drawings is Worksheet#add_chart
+    # @see Worksheet#add_chart
+    # @see Drawing
+    # @return [SimpleTypedList]
+    attr_reader :drawings
+
+    # The styles associated with this workbook
+    # @note The recommended way to manage styles is Styles#add_style
+    # @see Style#add_style
+    # @see Style
+    # @return [Styles]
+    def styles
+      yield @styles if block_given?
+      @styles
+    end
+
+
+    # Indicates if the epoc date for serialization should be 1904. If false, 1900 is used.
+    @@date1904 = false
+
+    # lets come back to this later when we are ready for parsing. 
+    #def self.parse entry
+    #  io = entry.get_input_stream
+    #  w = self.new
+    #  w.parser_xml = Nokogiri::XML(io.read)
+    #  w.parse_string :date1904, "//xmlns:workbookPr/@date1904"      
+    #  w
+    #end
+
+    # Creates a new Workbook
+    # @option options [Boolean] date1904
+    def initialize(options={})
+      @styles = Styles.new
+      @worksheets = SimpleTypedList.new Worksheet
+      @drawings = SimpleTypedList.new Drawing
+      @charts = SimpleTypedList.new Chart
+      @images = SimpleTypedList.new Pic
+      self.date1904= options[:date1904] unless options[:date1904].nil?
+      yield self if block_given?      
+    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
+
+    # retrieves the date1904 attribute
+    # @return [Boolean]
+    def self.date1904() @@date1904; end
+
+    # Adds a worksheet to this workbook
+    # @return [Worksheet]
+    # @option options [String] name The name of the worksheet.
+    # @see Worksheet#initialize
+    def add_worksheet(options={})
+      worksheet = Worksheet.new(self, options)
+      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|
+        r << Relationship.new(WORKSHEET_R, WORKSHEET_PN % (r.size+1))
+      end 
+      r << Relationship.new(STYLES_R,  STYLES_PN)
+      r
+    end
+
+    # returns a range of cells in a worksheet
+    # @param [String] cell_def The excel style reference defining the worksheet and cells. The range must specify the sheet to 
+    # retrieve the cells from. e.g. range('Sheet1!A1:B2') will return an array of four cells [A1, A2, B1, B2] while range('Sheet1!A1') will return a single Cell.
+    # @return [Cell, Array]
+    def [](cell_def)
+      sheet_name = cell_def.split('!')[0] if cell_def.match('!')
+      worksheet =  self.worksheets.select { |s| s.name == sheet_name }.first
+      raise ArgumentError, 'Unknown Sheet' unless sheet_name && worksheet.is_a?(Worksheet) 
+      worksheet[cell_def.gsub(/.+!/,"")]
+    end
+
+    # Serializes the workbook document
+    # @return [String]
+    def to_xml()
+      add_worksheet unless worksheets.size > 0
+      builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
+        xml.workbook(:xmlns => XML_NS, :'xmlns:r' => XML_NS_R) {
+          xml.workbookPr(:date1904=>@@date1904)
+          xml.sheets {
+            @worksheets.each_with_index do |sheet, index|              
+              xml.sheet(:name=>sheet.name, :sheetId=>index+1, :"r:id"=>sheet.rId)
+            end
+          }
+        }
+      end      
+      builder.to_xml(:indent=>0)
+    end
+  end
+end

data/lib/axlsx/workbook/worksheet/cell.rb

@@ -0,0 +1,337 @@
+# -*- coding: utf-8 -*-
+module Axlsx
+  # A cell in a worksheet. 
+  # Cell stores inforamation requried to serialize a single worksheet cell to xml. You must provde the Row that the cell belongs to and the cells value. The data type will automatically be determed if you do not specify the :type option. The default style will be applied if you do not supply the :style option. Changing the cell's type will recast the value to the type specified. Altering the cell's value via the property accessor will also automatically cast the provided value to the cell's type.
+  # @example Manually creating and manipulating Cell objects
+  #   ws = Workbook.new.add_worksheet 
+  #   # This is the simple, and recommended way to create cells. Data types will automatically be determined for you.
+  #   ws.add_row :values => [1,"fish",Time.now]
+  #
+  #   # but you can also do this
+  #   r = ws.add_row
+  #   r.add_cell 1
+  # 
+  #   # or even this
+  #   r = ws.add_row
+  #   c = Cell.new row, 1, :value=>integer
+  #
+  #   # cells can also be accessed via Row#cells. The example here changes the cells type, which will automatically updated the value from 1 to 1.0
+  #   r.cells.last.type = :float
+  # 
+  # @note The recommended way to generate cells is via Worksheet#add_row
+  # 
+  # @see Worksheet#add_row
+  class Cell
+
+    # The index of the cellXfs item to be applied to this cell.
+    # @return [Integer] 
+    # @see Axlsx::Styles
+    attr_reader :style
+
+    # The row this cell belongs to.
+    # @return [Row]
+    attr_reader :row
+    
+    # The cell's data type. Currently only four types are supported, :time, :float, :integer and :string.
+    # Changing the type for a cell will recast the value into that type. If no type option is specified in the constructor, the type is 
+    # automatically determed.
+    # @see Cell#cell_type_from_value
+    # @return [Symbol] The type of data this cell's value is cast to. 
+    # @raise [ArgumentExeption] Cell.type must be one of [:time, :float, :integer, :string]
+    # @note 
+    #  If the value provided cannot be cast into the type specified, type is changed to :string and the following logic is applied.
+    #   :string to :integer or :float, type coversions always return 0 or 0.0    
+    #   :string, :integer, or :float to :time conversions always return the original value as a string and set the cells type to :string.
+    #  No support is currently implemented for parsing time strings.
+    attr_reader :type
+    # @see type
+    def type=(v) 
+      RestrictionValidator.validate "Cell.type", [:time, :float, :integer, :string], v      
+      @type=v 
+      self.value = @value
+    end
+
+
+    # The value of this cell.
+    # @return [String, Integer, Float, Time] casted value based on cell's type attribute.
+    attr_reader :value
+    # @see value
+    def value=(v)
+      #TODO: consider doing value based type determination first?
+      @value = cast_value(v)
+    end
+    
+    # The inline font_name property for the cell
+    # @return [String]
+    attr_reader :font_name
+    # @see font_name
+    def font_name=(v) Axlsx::validate_string(v); @font_name = v; end
+
+    # The inline charset property for the cell
+    # @return [String]
+    attr_reader :charset
+    # @see charset
+    def charset=(v) Axlsx::validate_unsigned_int(v); @charset = v; end
+
+    # The inline family property for the cell
+    # @return [String]
+    attr_reader :family
+    # @see family
+    def family=(v) Axlsx::validate_string(v); @family = v; end
+
+    # The inline bold property for the cell
+    # @return [Boolean]
+    attr_reader :b
+    # @see b
+    def b=(v) Axlsx::validate_boolean(v); @b = v; end
+
+    # The inline italic property for the cell
+    # @return [Boolean]
+    attr_reader :i
+    # @see i
+    def i=(v) Axlsx::validate_boolean(v); @i = v; end
+
+    # The inline strike property for the cell
+    # @return [Boolean]
+    attr_reader :strike
+    # @see strike
+    def strike=(v) Axlsx::validate_boolean(v); @strike = v; end
+
+    # The inline outline property for the cell
+    # @return [Boolean]
+    attr_reader :outline
+    # @see outline
+    def outline=(v) Axlsx::validate_boolean(v); @outline = v; end
+
+    # The inline shadow property for the cell
+    # @return [Boolean]
+    attr_reader :shadow
+    # @see shadow
+    def shadow=(v) Axlsx::validate_boolean(v); @shadow = v; end
+
+    # The inline condense property for the cell
+    # @return [Boolean]
+    attr_reader :condense
+    # @see condense
+    def condense=(v) Axlsx::validate_boolean(v); @condense = v; end
+
+    # The inline extend property for the cell
+    # @return [Boolean]
+    attr_reader :extend
+    # @see extend
+    def extend=(v) Axlsx::validate_boolean(v); @extend = v; end
+
+    # The inline underline property for the cell
+    # @return [Boolean]
+    attr_reader :u
+    # @see u
+    def u=(v) Axlsx::validate_boolean(v); @u = v; end
+
+    # The inline color property for the cell
+    # @return [Color]
+    attr_reader :color
+    # @param [String] The 8 character representation for an rgb color #FFFFFFFF"
+    def color=(v) 
+      @color = v.is_a?(Color) ? v : Color.new(:rgb=>v)
+    end
+
+    # The inline sz property for the cell
+    # @return [Boolean]
+    attr_reader :sz
+    # @see sz
+    def sz=(v) Axlsx::validate_unsigned_int(v); @sz = v; end
+
+    # The inline vertical alignment property for the cell
+    # this must be one of [:baseline, :subscript, :superscript]
+    # @return [Symbol]
+    attr_reader :vertAlign
+    # @see vertAlign
+    def vertAlign=(v) RestrictionValidator.validate "Cell.vertAlign", [:baseline, :subscript, :superscript], v; @vertAlign = v; end
+
+    # The inline scheme property for the cell
+    # this must be one of [:none, major, minor]
+    # @return [Symbol]
+    attr_reader :scheme
+    # @see scheme
+    def scheme=(v) RestrictionValidator.validate "Cell.schema", [:none, :major, :minor], v; @scheme = v; end
+
+    # @param [Row] row The row this cell belongs to.
+    # @param [Any] value The value associated with this cell. 
+    # @option options [Symbol] type The intended data type for this cell. If not specified the data type will be determined internally based on the vlue provided.
+    # @option options [Integer] style The index of the cellXfs item to be applied to this cell. If not specified, the default style (0) will be applied.
+    # @option options [String] font_name
+    # @option options [Integer] charset
+    # @option options [String] family
+    # @option options [Boolean] b
+    # @option options [Boolean] i
+    # @option options [Boolean] strike
+    # @option options [Boolean] outline
+    # @option options [Boolean] shadow
+    # @option options [Boolean] condense
+    # @option options [Boolean] extend
+    # @option options [Boolean] u
+    # @option options [Symbol] vertAlign must be one of :baseline, :subscript, :superscript
+    # @option options [Integer] sz
+    # @option options [String] color an 8 letter rgb specification
+    # @option options [Symbol] scheme must be one of :none, major, :minor
+    def initialize(row, value="", options={})
+      self.row=row
+      @styles = row.worksheet.workbook.styles
+      @style = 0 
+      @type = cell_type_from_value(value)
+      @row.cells << self      
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+      @value = cast_value(value)
+    end
+
+    # @return [Integer] The index of the cell in the containing row.
+    def index
+      @row.cells.index(self)
+    end
+
+    # @return [String] The alpha(column)numeric(row) reference for this sell.
+    # @example Relative Cell Reference
+    #   ws.rows.first.cells.first.r #=> "A1" 
+    def r
+      "#{col_ref}#{@row.index+1}"      
+    end
+
+    # @return [String] The absolute alpha(column)numeric(row) reference for this sell.
+    # @example Absolute Cell Reference
+    #   ws.rows.first.cells.first.r #=> "$A$1" 
+    def r_abs
+      "$#{r.split('').join('$')}"
+    end
+
+    # @return [Integer] The cellXfs item index applied to this cell.
+    # @raise [ArgumentError] Invalid cellXfs id if the value provided is not within cellXfs items range.
+    def style=(v)
+      Axlsx::validate_unsigned_int(v)
+      count = @styles.cellXfs.size
+      raise ArgumentError, "Invalid cellXfs id" unless v < count
+      @style = v
+    end
+
+    # @return [Array] of x/y coordinates in the cheet for this cell.
+    def pos
+      [index, row.index]
+    end
+
+    # Serializes the cell
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # @return [String] xml text for the cell
+    # @note
+    #   Shared Strings are not used in this library. All values are set directly in the each sheet.
+    def to_xml(xml)
+      
+      # however nokogiri does a nice 'force_encoding' which we shall remove!
+      if @type == :string 
+        #parse formula
+        if @value.start_with?('=')
+          xml.c(:r => r, :t=>:str, :s=>style) {
+            xml.f @value.to_s.gsub('=', '')
+          }
+        else
+          #parse standard string
+          #xml.c(:r => r, :t=>:inlineStr, :s=>style) {
+          #  xml.is { xml.t @value.to_s } 
+          #}
+          #parse styled string
+          xml.c(:r => r, :s=>style, :t => :inlineStr) {
+            xml.is {
+              xml.r {
+                xml.rPr {
+                  xml.rFont(:val=>@font_name) if @font_name
+                  xml.charset(:val=>@charset) if @charset
+                  xml.family(:val=>@family) if @family
+                  xml.b(:val=>@b) if @b
+                  xml.i(:val=>@i) if @i
+                  xml.strike(:val=>@strike) if @strike
+                  xml.outline(:val=>@outline) if @outline
+                  xml.shadow(:val=>@shadow) if @shadow
+                  xml.condense(:val=>@condense) if @condense
+                  xml.extend(:val=>@extend) if @extend
+                  @color.to_xml(xml) if @color
+                  xml.sz(:val=>@sz) if @sz
+                  xml.u(:val=>@u) if @u
+                  # :baseline, :subscript, :superscript
+                  xml.vertAlign(:val=>@vertAlign) if @verAlign
+                  # :none, major, :minor
+                  xml.scheme(:val=>@scheme) if @scheme
+                }
+                xml.t @value.to_s
+              }
+            }
+          }
+        end
+      else
+        xml.c(:r => r, :s => style) { xml.v value }
+      end
+    end
+
+
+    private 
+
+    # assigns the owning row for this cell.
+    def row=(v) DataTypeValidator.validate "Cell.row", Row, v; @row=v end
+    
+    # converts the column index into alphabetical values.
+    # @note This follows the standard spreadsheet convention of naming columns A to Z, followed by AA to AZ etc.
+    # @return [String]
+    def col_ref
+      chars = []
+      index = self.index
+      while index >= 26 do
+        chars << ((index % 26) + 65).chr
+        index /= 26
+      end
+      chars << ((chars.empty? ? index : index-1) + 65).chr
+      chars.reverse.join
+    end
+
+    # Determines the cell type based on the cell value. 
+    # @note This is only used when a cell is created but no :type option is specified, the following rules apply:
+    #   1. If the value is an instance of Time, the type is set to :time
+    #   2. :float and :integer types are determined by regular expression matching.
+    #   3. Anything that does not meet either of the above is determined to be :string.
+    # @return [Symbol] The determined type
+    def cell_type_from_value(v)      
+      if v.is_a? Time
+        :time
+      elsif v.to_s.match(/\A[+-]?\d+?\Z/) #numeric
+        :integer
+      elsif v.to_s.match(/\A[+-]?\d+\.\d+?\Z/) #float
+        :float
+      else
+        :string
+      end
+    end
+
+    # Cast the value into this cells data type. 
+    # @note 
+    #   About Time - Time in OOXML is *different* from what you might expect. The history as to why is interesting,  but you can safely assume that if you are generating docs on a mac, you will want to specify Workbook.1904 as true when using time typed values.
+    # @see Axlsx#date1904
+    def cast_value(v)
+      if (@type == :time && v.is_a?(Time)) || (@type == :time && v.respond_to?(:to_time))
+        v = v.respond_to?(:to_time) ? v.to_time : v
+        self.style = STYLE_DATE if self.style == 0
+        # Using hardcoded offsets here as some operating systems will not except a 'negative' offset from the ruby epoc.
+        # (1970)
+        epoc1900 = -2209021200 #Time.local(1900, 1, 1) 
+        epoc1904 = -2082877200 #Time.local(1904, 1, 1) 
+        epoc = Workbook.date1904 ? epoc1904 : epoc1900
+        v = ((v.localtime.to_f - epoc) /60.0/60.0/24.0).to_f
+        ((v * 10**11).round.to_f / 10**11)
+      elsif @type == :float
+        v.to_f
+      elsif @type == :integer
+        v.to_i
+      else
+        @type = :string
+        v.to_s
+      end
+    end    
+  end
+end