spreadsheet 0.6.0

data/lib/spreadsheet/font.rb

@@ -0,0 +1,86 @@
+require 'spreadsheet/datatypes'
+require 'spreadsheet/encodings'
+
+module Spreadsheet
+  ##
+  # Font formatting data
+  class Font
+    include Datatypes
+    include Encodings
+    attr_accessor :name
+    ##
+    # You can set the following boolean Font attributes
+    # * #italic
+    # * #strikeout
+    # * #outline
+    # * #shadow
+    boolean :italic, :strikeout, :outline, :shadow
+    ##
+    # Font color
+    colors :color
+    ##
+    # Font weight
+    # Valid values: :normal, :bold or any positive Integer.
+    # In Excel:
+    #  100 <= weight <= 1000
+    #  :bold   => 700
+    #  :normal => 400
+    # Default:      :normal
+    enum :weight, :normal, :bold, Integer, :bold => :b
+    ##
+    # Escapement
+    # Valid values: :normal, :superscript or :subscript.
+    # Default:      :normal
+    enum :escapement, :normal, :superscript, :subscript,
+         :subscript   => :sub,
+         :superscript => :super
+    # Font size
+    # Valid values: Any positive Integer.
+    # Default:      10
+    enum :size, 10, Numeric
+    # Underline type
+    # Valid values: :none, :single, :double, :single_accounting and
+    #               :double_accounting.
+    # Default:      :none
+    enum :underline, :none, :single, :double,
+                     :single_accounting, :double_accounting,
+         :single => true
+    # Font Family
+    # Valid values: :none, :roman, :swiss, :modern, :script, :decorative
+    # Default:      :none
+    enum :family, :none, :roman, :swiss, :modern, :script, :decorative
+    # Font Family
+    # Valid values: :default, :iso_latin1, :symbol, :apple_roman, :shift_jis,
+    #               :korean_hangul, :korean_johab, :chinese_simplified,
+    #               :chinese_traditional, :greek, :turkish, :vietnamese,
+    #               :hebrew, :arabic, :cyrillic, :thai, :iso_latin2, :oem_latin1
+    # Default:      :default
+    enum :encoding, :default, :iso_latin1, :symbol, :apple_roman, :shift_jis,
+                    :korean_hangul, :korean_johab, :chinese_simplified,
+                    :chinese_traditional, :greek, :turkish, :vietnamese,
+                    :hebrew, :arabic, :cyrillic, :thai, :iso_latin2, :oem_latin1
+    def initialize name
+      self.name = name
+      @color = :text
+    end
+    ##
+    # Sets #weight to :bold if(_bool_), :normal otherwise.
+    def bold= bool
+      self.weight = bool ? :bold : nil
+    end
+    def key # :nodoc:
+      key = @name.dup
+      key << '_' << size.to_s
+      key << '_' << weight.to_s
+      key << '_italic'    if italic?
+      key << '_strikeout' if strikeout?
+      key << '_outline'   if outline?
+      key << '_shadow'    if shadow?
+      key << '_' << escapement.to_s
+      key << '_' << underline.to_s
+      key << '_' << color.to_s
+      key << '_' << family.to_s
+      key << '_' << encoding.to_s
+    end
+  end
+end

data/lib/spreadsheet/format.rb

@@ -0,0 +1,172 @@
+require 'spreadsheet/datatypes'
+require 'spreadsheet/encodings'
+require 'spreadsheet/font'
+
+module Spreadsheet
+  ##
+  # Formatting data
+  class Format
+    include Encodings
+    include Datatypes
+    ##
+    # You can set the following boolean attributes:
+    # #cross_down::       Draws a Line from the top-left to the bottom-right
+    #                     corner of a cell.
+    # #cross_up::         Draws a Line from the bottom-left to the top-right
+    #                     corner of a cell.
+    # #hidden::           The cell is hidden.
+    # #locked::           The cell is locked.
+    # #merge_range::      The cell is in a merged range.
+    # #shrink::           Shrink the contents to fit the cell.
+    # #text_justlast::    Force the last line of a cell to be justified. This
+    #                     probably makes sense if horizontal_align = :justify
+    # #left::             Draw a border to the left of the cell.
+    # #right::            Draw a border to the right of the cell.
+    # #top::              Draw a border at the top of the cell.
+    # #bottom::           Draw a border at the bottom of the cell.
+    # #rotation_stacked:: Characters in the cell are stacked on top of each
+    #                     other. Excel will ignore other rotation values if
+    #                     this is set.
+    boolean :cross_down, :cross_up, :hidden, :locked,
+            :merge_range, :shrink, :text_justlast, :text_wrap, :left, :right,
+            :top, :bottom, :rotation_stacked
+    ##
+    # Color attributes
+    colors  :bottom_color, :top_color, :left_color, :right_color,
+            :bg_color, :pattern_fg_color, :pattern_bg_color,
+            :diagonal_color
+    ##
+    # Text direction
+    # Valid values: :context, :left_to_right, :right_to_left
+    # Default:      :context
+    enum :text_direction, :context, :left_to_right, :right_to_left,
+         :left_to_right => [:ltr, :l2r],
+         :right_to_left => [:rtl, :r2l]
+    alias :reading_order  :text_direction
+    alias :reading_order= :text_direction=
+    ##
+    # Indentation level
+    enum :indent_level, 0, Integer
+    alias :indent  :indent_level
+    alias :indent= :indent_level=
+    ##
+    # Horizontal alignment
+    # Valid values: :default, :left, :center, :right, :fill, :justify, :merge,
+    #               :distributed
+    # Default:      :default
+    enum :horizontal_align, :default, :left, :center, :right, :fill, :justify,
+                            :merge, :distributed,
+         :center      => :centre,
+         :merge       => [ :center_across, :centre_across ],
+         :distributed => :equal_space
+    ##
+    # Vertical alignment
+    # Valid values: :bottom, :top, :middle, :justify, :distributed
+    # Default:      :bottom
+    enum :vertical_align, :bottom, :top, :middle, :justify, :distributed,
+         :distributed => [:vdistributed, :vequal_space, :equal_space],
+         :justify     => :vjustify,
+         :middle      => [:vcenter, :vcentre, :center, :centre]
+    attr_accessor :font, :number_format, :name, :pattern, :used_merge
+    ##
+    # Text rotation
+    attr_reader :rotation
+    def initialize opts={}
+      @font             = Font.new client("Arial", 'UTF8')
+      @number_format    = client 'General', 'UTF8'
+      @rotation         = 0
+      @bg_color         = :pattern_bg
+      @pattern          = 0
+      @bottom_color     = :border
+      @top_color        = :border
+      @left_color       = :border
+      @right_color      = :border
+      @diagonal_color   = :border
+      @pattern_fg_color = :border
+      @pattern_bg_color = :pattern_bg
+      # Temp code to prevent merged formats in non-merged cells.
+      @used_merge    = 0
+      opts.each do |key, val|
+        writer = "#{key}="
+        if @font.respond_to? writer
+          @font.send writer, val
+        else
+          self.send writer, val
+        end
+      end
+      yield self if block_given?
+    end
+    ##
+    # Combined method for both horizontal and vertical alignment. Sets the
+    # first valid value (e.g. Format#align = :justify only sets the horizontal
+    # alignment. Use one of the aliases prefixed with :v if you need to
+    # disambiguate.)
+    #
+    # This is essentially a backward-compatibility method and may be removed at
+    # some point in the future.
+    def align= location
+      self.horizontal_align = location
+    rescue ArgumentError
+      self.vertical_align = location rescue ArgumentError
+    end
+    ##
+    # Returns an Array containing the status of the four borders:
+    # bottom, top, right, left
+    def border
+      [bottom,top,right,left]
+    end
+    ##
+    # Activate or deactivate all four borders (left, right, top, bottom)
+    def border=(boolean)
+      [:bottom=, :top=, :right=, :left=].each do |writer| send writer, boolean end
+    end
+    ##
+    # Returns an Array containing the colors of the four borders:
+    # bottom, top, right, left
+    def border_color
+      [@bottom_color,@top_color,@left_color,@right_color]
+    end
+    ##
+    # Set all four border colors to _color_ (left, right, top, bottom)
+    def border_color=(color)
+      [:bottom_color=, :top_color=, :right_color=, :left_color=].each do |writer|
+        send writer, color end
+    end
+    ##
+    # Set the Text rotation
+    # Valid values: Integers from -90 to 90,
+    # or :stacked (sets #rotation_stacked to true)
+    def rotation=(rot)
+      if rot.to_s.downcase == 'stacked'
+        @rotation_stacked = true
+        @rotation = 0
+      elsif rot.kind_of?(Integer)
+        @rotation_stacked = false
+        @rotation = rot % 360
+      else
+        raise TypeError, "rotation value must be an Integer or the String 'stacked'"
+      end
+    end
+    ##
+    # Backward compatibility method. May disappear at some point in the future.
+    def center_across!
+      self.horizontal_align = :merge
+    end
+    alias :merge! :center_across!
+    ##
+    # Is the cell formatted as a Date?
+    def date?
+      !!/[YMD]/.match(@number_format.to_s)
+    end
+    ##
+    # Is the cell formatted as a DateTime?
+    def datetime?
+      !!/([YMD].*[hms])|([hms].*[YMD])/.match(@number_format.to_s)
+    end
+    ##
+    # Is the cell formatted as a Time?
+    def time?
+      !!/[hms]/.match(@number_format.to_s)
+    end
+  end
+end

data/lib/spreadsheet/formula.rb

@@ -0,0 +1,9 @@
+module Spreadsheet
+  ##
+  # Formula implementation. At the moment this is just a placeholder.
+  # You may access the last calculated #value, other attributes are needed for
+  # writing the Formula back into modified Excel Files.
+  class Formula
+    attr_accessor :data, :value, :shared
+  end
+end

data/lib/spreadsheet/row.rb

@@ -0,0 +1,87 @@
+module Spreadsheet
+  ##
+  # The Row class. Encapsulates Cell data and formatting.
+  # Since Row is a subclass of Array, you may use all the standard Array methods
+  # to manipulate a Row.
+  # By convention, Row#at will give you raw values, while Row#[] may be
+  # overridden to return enriched data if necessary (see also the Date- and
+  # DateTime-handling in Excel::Row#[]
+  #
+  # Useful Attributes are:
+  # #idx::            The 0-based index of this Row in its Worksheet.
+  # #formats::        A parallel array containing Formatting information for
+  #                   all cells stored in a Row.
+  # #default_format:: The default Format used when writing a Cell if no explicit
+  #                   Format is stored in #formats for the cell.
+  # #height::         The height of this Row in points (defaults to 12).
+  class Row < Array
+    class << self
+      def updater *keys
+        keys.each do |key|
+          define_method key do |*args|
+            res = super
+            @worksheet.row_updated @idx, self if @worksheet
+            res
+          end
+        end
+      end
+    end
+    attr_reader :formats, :default_format
+    attr_accessor :idx, :height, :worksheet
+    updater :[]=, :clear, :concat, :delete, :delete_if, :fill, :insert, :map!,
+            :pop, :push, :reject!, :replace, :reverse!, :shift, :slice!,
+            :sort!, :uniq!, :unshift
+    def initialize worksheet, idx, cells=[]
+      @worksheet = worksheet
+      @idx = idx
+      while !cells.empty? && !cells.last
+        cells.pop
+      end
+      super cells
+      @first_used ||= index_of_first self
+      @first_unused ||= size
+      @formats = []
+      @height = 12
+    end
+    ##
+    # Set the default Format used when writing a Cell if no explicit Format is
+    # stored for the cell.
+    def default_format= format
+      @worksheet.add_format format
+      @default_format = format
+    end
+    ##
+    # #first_unused (really last used + 1) - the 0-based index of the first of
+    # all remaining contiguous blank Cells.
+    alias :first_unused :size
+    ##
+    # #first_used the 0-based index of the first non-blank Cell.
+    def first_used
+      index_of_first self
+    end
+    ##
+    # The Format for the Cell at _idx_ (0-based), or default_format
+    # if no Format is set.
+    def format idx
+      @formats[idx] || @default_format
+    end
+    ##
+    # Set the Format for the Cell at _idx_ (0-based).
+    def set_format idx, fmt
+      @formats[idx] = fmt
+      @worksheet.add_format fmt
+      @worksheet.row_updated @idx, self if @worksheet
+      fmt
+    end
+    def inspect
+      variables = instance_variables.collect do |name|
+        "%s=%s" % [name, instance_variable_get(name)]
+      end.join(' ')
+      sprintf "#<%s:0x%014x %s %s>", self.class, object_id, variables, super
+    end
+    private
+    def index_of_first ary # :nodoc:
+      ary.index(ary.find do |elm| elm end)
+    end
+  end
+end

data/lib/spreadsheet/workbook.rb

@@ -0,0 +1,120 @@
+require 'spreadsheet/format'
+require 'spreadsheet/encodings'
+
+module Spreadsheet
+  ##
+  # The Workbook class represents a Spreadsheet-Document and is the entry point
+  # for all Spreadsheet manipulation.
+  #
+  # Interesting Attributes:
+  # #default_format:: The default format used for all cells in this Workbook.
+  #                   that have no format set explicitly or in
+  #                   Row#default_format or Worksheet#default_format.
+  class Workbook
+    include Encodings
+    attr_reader :io, :worksheets, :formats, :fonts
+    attr_accessor :encoding, :version, :default_format
+    def initialize io = nil, opts={:default_format => Format.new}
+      @worksheets = []
+      @io = io
+      @fonts = []
+      @formats = []
+      if @default_format = opts[:default_format]
+        @formats.push @default_format
+      end
+    end
+    ##
+    # Add a Font to the Workbook. Used by the parser. You should not need to
+    # use this Method.
+    def add_font font
+      @fonts.push font
+    end
+    ##
+    # Add a Format to the Workbook. If you use Row#set_format, you should not
+    # need to use this Method.
+    def add_format format
+      @formats.push(format).uniq!
+      format
+    end
+    ##
+    # Add a Worksheet to the Workbook.
+    def add_worksheet worksheet
+      worksheet.workbook = self
+      @worksheets.push worksheet
+      worksheet
+    end
+    ##
+    # Create a new Worksheet in this Workbook.
+    # Used without options this creates a Worksheet with the name 'WorksheetN'
+    # where the new Worksheet is the Nth Worksheet in this Workbook.
+    #
+    # Use the option <em>:name => 'My pretty Name'</em> to override this
+    # behavior.
+    def create_worksheet opts = {}
+      opts[:name] ||= client("Worksheet#{@worksheets.size.next}", 'UTF8')
+      add_worksheet Worksheet.new(opts)
+    end
+    ##
+    # The Font at _idx_
+    def font idx
+      @fonts[idx]
+    end
+    ##
+    # The Format at _idx_, or - if _idx_ is a String -
+    # the Format with name == _idx_
+    def format idx
+      case idx
+      when Integer
+        @formats[idx] || @default_format
+      when String
+        @formats.find do |fmt| fmt.name == idx end
+      end
+    end
+    def inspect
+      "#<#{self.class}:#{object_id} "
+      variables = (instance_variables - uninspect_variables).collect do |name|
+        "%s=%s" % [name, instance_variable_get(name)]
+      end.join(' ')
+      uninspect = uninspect_variables.collect do |name|
+        var = instance_variable_get name
+        "%s=%s[%i]" % [name, var.class, var.size]
+      end.join(' ')
+      sprintf "#<%s:0x%014x %s %s>", self.class, object_id,
+                                     variables, uninspect
+    end
+    def uninspect_variables # :nodoc:
+      %w{@formats @fonts @worksheets}
+    end
+    ##
+    # The Worksheet at _idx_, or - if _idx_ is a String -
+    # the Worksheet with name == _idx_
+    def worksheet idx
+      case idx
+      when Integer
+        @worksheets[idx]
+      when String
+        @worksheets.find do |sheet| sheet.name == idx end
+      end
+    end
+    ##
+    # Write this Workbook to a File, IO Stream or Writer Object. The latter will
+    # make more sense once there are more than just an Excel-Writer available.
+    def write io_path_or_writer
+      if io_path_or_writer.is_a? Writer
+        io_path_or_writer.write self
+      else
+        writer(io_path_or_writer).write(self)
+      end
+    end
+    ##
+    # Returns a new instance of the default Writer class for this Workbook (can
+    # only be an Excel::Writer::Workbook at this time)
+    def writer io_or_path, type=Excel, version=self.version
+      if type == Excel
+        Excel::Writer::Workbook.new io_or_path
+      else
+        raise NotImplementedError, "No Writer defined for #{type}"
+      end
+    end
+  end
+end