ruby-spreadsheet 0.6.5

data/lib/spreadsheet/font.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+require 'spreadsheet/datatypes'
+require 'spreadsheet/encodings'
+
+module Spreadsheet
+  ##
+  # Font formatting data
+  class Font
+    include Spreadsheet::Datatypes
+    include Spreadsheet::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, :baltic, :cyrillic, :thai, :iso_latin2,
+                    :oem_latin1
+    def initialize name, opts={}
+      self.name = name
+      @color = :text
+      opts.each do |key, val|
+        self.send "#{key}=", val
+      end
+    end
+    ##
+    # Sets #weight to :bold if(_bool_), :normal otherwise.
+    def bold= bool
+      self.weight = bool ? :bold : nil
+    end
+    def key # :nodoc:
+      key = @name.dup
+      underscore = client('_', 'UTF-8')
+      key << underscore << client(size.to_s, 'US-ASCII')
+      key << client('_', 'UTF-8') << client(weight.to_s, 'US-ASCII')
+      key << client('_italic', 'UTF-8')    if italic?
+      key << client('_strikeout', 'UTF-8') if strikeout?
+      key << client('_outline', 'UTF-8')   if outline?
+      key << client('_shadow', 'UTF-8')    if shadow?
+      key << underscore << client(escapement.to_s, 'US-ASCII')
+      key << underscore << client(underline.to_s, 'US-ASCII')
+      key << underscore << client(color.to_s, 'US-ASCII')
+      key << underscore << client(family.to_s, 'US-ASCII')
+      key << underscore << client(encoding.to_s, 'US-ASCII')
+    end
+  end
+end

data/lib/spreadsheet/format.rb

@@ -0,0 +1,177 @@
+# encoding: utf-8
+require 'spreadsheet/datatypes'
+require 'spreadsheet/encodings'
+require 'spreadsheet/font'
+
+module Spreadsheet
+  ##
+  # Formatting data
+  class Format
+    include Spreadsheet::Datatypes
+    include Spreadsheet::Encodings
+    ##
+    # 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,
+            :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", 'UTF-8'), :family => :swiss
+      @number_format    = client 'GENERAL', 'UTF-8'
+      @rotation         = 0
+      @pattern          = 0
+      @bottom_color     = :builtin_black
+      @top_color        = :builtin_black
+      @left_color       = :builtin_black
+      @right_color      = :builtin_black
+      @diagonal_color   = :builtin_black
+      @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?
+      !!Regexp.new(client("[YMD]", 'UTF-8')).match(@number_format.to_s)
+    end
+    ##
+    # Is the cell formatted as a Date or Time?
+    def date_or_time?
+      !!Regexp.new(client("[hmsYMD]", 'UTF-8')).match(@number_format.to_s)
+    end
+    ##
+    # Is the cell formatted as a DateTime?
+    def datetime?
+      !!Regexp.new(client("([YMD].*[HS])|([HS].*[YMD])", 'UTF-8')).match(@number_format.to_s)
+    end
+    ##
+    # Is the cell formatted as a Time?
+    def time?
+      !!Regexp.new(client("[hms]", 'UTF-8')).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/helpers.rb

@@ -0,0 +1,11 @@
+class Array
+  def rcompact
+    dup.rcompact!
+  end
+  def rcompact!
+    while !empty? && last.nil?
+      pop
+    end
+    self
+  end
+end

data/lib/spreadsheet/link.rb

@@ -0,0 +1,43 @@
+require 'uri'
+require 'spreadsheet/encodings'
+
+module Spreadsheet
+  ##
+  # The Link class. Is a Subclass of String, which lets you treat a Cell that
+  # contains a Link just as if it was a String (containing the link's description
+  # if there is one or the url with fragment otherwise), but gives you access
+  # to the url, fragment and target_frame if you need it.
+  #
+  #
+  # Interesting Attributes
+  # #url          :: The Uniform Resource Location this Link points to.
+  # #fragment     :: Also called text mark: http://example.com/page.html#fragment
+  # #target_frame :: Which frame a Link should be opened in, should also support
+  #                  the special frames _blank, _parent, _self and _top.
+  # #dos          :: Excel may store a DOS-Filename together with the long
+  #                  Filename introduced in VFAT. You probably will not need this,
+  #                  but if you do, here is where you can find it.
+  class Link < String
+    include Encodings
+    attr_accessor :target_frame, :url, :dos, :fragment
+    def initialize url='', description=url, fragment=nil
+      super description
+      @url = url
+      @fragment = fragment
+    end
+    ##
+    # The Url with the fragment appended if present.
+    def href
+      href = (@url || @dos).to_s.dup
+      if @fragment
+        href << client('#', 'UTF-8') << @fragment
+      end
+      href
+    end
+    ##
+    # Attempts to parse the output of href. May raise a URI::InvalidURIError
+    def to_uri
+      URI.parse href
+    end
+  end
+end

data/lib/spreadsheet/row.rb

@@ -0,0 +1,132 @@
+require 'spreadsheet/helpers'
+
+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
+    include Datatypes
+    class << self
+      def format_updater *keys
+        keys.each do |key|
+          unless instance_methods.include? "unupdated_#{key}="
+            alias_method :"unupdated_#{key}=", :"#{key}="
+            define_method "#{key}=" do |value|
+              send "unupdated_#{key}=", value
+              @worksheet.row_updated @idx, self if @worksheet
+              value
+            end
+          end
+        end
+      end
+      def updater *keys
+        keys.each do |key|
+          ## Passing blocks to methods defined with define_method is not possible
+          #  in Ruby 1.8:
+          #  http://groups.google.com/group/ruby-talk-google/msg/778184912b769e5f
+          #  use class_eval as suggested by someone else in
+          #  http://rubyforge.org/tracker/index.php?func=detail&aid=25732&group_id=678&atid=2677
+          class_eval <<-SRC, __FILE__, __LINE__
+            def #{key}(*args)
+              res = super(*args)
+              @worksheet.row_updated @idx, self if @worksheet
+              res
+            end
+          SRC
+        end
+      end
+    end
+    attr_reader :formats, :default_format
+    attr_accessor :idx, :height, :worksheet
+    boolean :hidden, :collapsed
+    enum :outline_level, 0, Integer
+    updater :[]=, :clear, :concat, :delete, :delete_if, :fill, :insert, :map!,
+            :pop, :push, :reject!, :replace, :reverse!, :shift, :slice!,
+            :sort!, :uniq!, :unshift
+    format_updater :collapsed, :height, :hidden, :outline_level
+    def initialize worksheet, idx, cells=[]
+      @default_format = nil
+      @worksheet = worksheet
+      @idx = idx
+      super cells
+      @formats = []
+      @height = 12.1
+    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 if @worksheet
+      @default_format = format
+    end
+    format_updater :default_format
+    ##
+    # #first_used the 0-based index of the first non-blank Cell.
+    def first_used
+      [ index_of_first(self), index_of_first(@formats) ].compact.min
+    end
+    ##
+    # The Format for the Cell at _idx_ (0-based), or the first valid Format in
+    # Row#default_format, Column#default_format and Worksheet#default_format.
+    def format idx
+      @formats[idx] || @default_format \
+        || @worksheet.column(idx).default_format if @worksheet
+    end
+    ##
+    # Returns a copy of self with nil-values appended for empty cells that have
+    # an associated Format.
+    # This is primarily a helper-function for the writer classes.
+    def formatted
+      copy = dup
+      @formats.rcompact!
+      if copy.length < @formats.size
+        copy.concat Array.new(@formats.size - copy.length)
+      end
+      copy
+    end
+    ##
+    # Same as Row#size, but takes into account formatted empty cells
+    def formatted_size
+      @formats.rcompact!
+      sz = size
+      fs = @formats.size
+      fs > sz ? fs : sz
+    end
+    ##
+    # #first_unused (really last used + 1) - the 0-based index of the first of
+    # all remaining contiguous blank Cells.
+    alias :first_unused :formatted_size
+    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
+    ##
+    # 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
+    private
+    def index_of_first ary # :nodoc:
+      if first = ary.find do |elm| !elm.nil? end
+        ary.index first
+      end
+    end
+  end
+end