surpass 0.0.3

data/lib/style.rb

@@ -0,0 +1,179 @@
+class StyleFormat
+  attr_accessor :number_format_string
+  attr_accessor :font
+  attr_accessor :alignment
+  attr_accessor :borders
+  attr_accessor :pattern
+  attr_accessor :protection
+  
+  def initialize(hash = {})
+    @number_format_string = hash[:number_format_string] || 'General'
+
+    @font           = Font.new(hash_select(hash, /^font_/))
+    @alignment      = Alignment.new(hash_select(hash, /^text_/))
+    @borders        = Borders.new(hash_select(hash, /^border_/))
+    @pattern        = Pattern.new(hash_select(hash, /^fill_/))
+    @protection     = Protection.new
+  end
+  
+  def hash_select(hash, pattern)
+    new_hash = {}
+    hash.keys.each do |k|
+      next unless k.to_s =~ pattern
+      new_key = k.to_s.gsub(pattern, '').to_sym
+      new_hash[new_key] = hash[k]
+    end
+    new_hash
+  end
+end
+
+class StyleCollection
+  attr_accessor :fonts
+  attr_accessor :number_formats
+  attr_accessor :styles
+  attr_accessor :default_style
+  attr_accessor :default_format
+  
+  FIRST_USER_DEFINED_NUM_FORMAT_INDEX = 164
+  
+  STANDARD_NUMBER_FORMATS = [
+    'General',
+    '0',
+    '0.00',
+    '#,##0',
+    '#,##0.00',
+    '"$"#,##0_);("$"#,##',
+    '"$"#,##0_);[Red]("$"#,##',
+    '"$"#,##0.00_);("$"#,##',
+    '"$"#,##0.00_);[Red]("$"#,##',
+    '0%',
+    '0.00%',
+    '0.00E+00',
+    '# ?/?',
+    '# ??/??',
+    'M/D/YY',
+    'D-MMM-YY',
+    'D-MMM',
+    'MMM-YY',
+    'h:mm AM/PM',
+    'h:mm:ss AM/PM',
+    'h:mm',
+    'h:mm:ss',
+    'M/D/YY h:mm',
+    '_(#,##0_);(#,##0)',
+    '_(#,##0_);[Red](#,##0)',
+    '_(#,##0.00_);(#,##0.00)',
+    '_(#,##0.00_);[Red](#,##0.00)',
+    '_("$"* #,##0_);_("$"* (#,##0);_("$"* "-"_);_(@_)',
+    '_(* #,##0_);_(* (#,##0);_(* "-"_);_(@_)',
+    '_("$"* #,##0.00_);_("$"* (#,##0.00);_("$"* "-"??_);_(@_)',
+    '_(* #,##0.00_);_(* (#,##0.00);_(* "-"??_);_(@_)',
+    'mm:ss',
+    '[h]:mm:ss',
+    'mm:ss.0',
+    '##0.0E+0',
+    '@'   
+  ]
+  
+  def initialize
+    # Populate default font list.
+    @fonts = {}
+    # Initialize blank fonts into slots 0,1,2,3,5 in order to skip slot 4.
+    [0,1,2,3,5].each do |i|
+      @fonts[i] = Font.new
+    end
+    
+    # Populate default number format list.
+    @number_formats = {}
+    STANDARD_NUMBER_FORMATS.each_with_index do |s, i|
+      index = (i <= 23) ? i : i + 14
+      @number_formats[index] = s
+    end
+    
+    @styles = {}
+    @default_style = StyleFormat.new
+    
+    # Store the 6 parameters of the default_style
+    @default_format = add_style(@default_style)[0]
+  end
+  
+  def add(style)
+    if style.nil?
+      0x10 # Return the index of the default style.
+    else
+      add_style(style)[1] # Return the index of the style just stored.
+    end
+  end
+  
+  def number_format_index(number_format_string)
+    index = @number_formats.index(number_format_string)
+    if index.nil?
+      # TODO implement regex to check if valid string
+      index = FIRST_USER_DEFINED_NUM_FORMAT_INDEX + @number_formats.length - STANDARD_NUMBER_FORMATS.length
+      @number_formats[index] = number_format_string
+    end
+    index
+  end
+  
+  def font_index(font)
+    index = @fonts.index(font)
+    if index.nil?
+      index = @fonts.length + 1
+      @fonts[index] = font
+    end
+    index
+  end
+  
+  def format_index(format)
+    index = @styles.index(format)
+    if index.nil?
+      index = 0x10 + @styles.length
+      @styles[index] = format
+    end
+    index
+  end
+  
+  private
+  # This is private, please use add(style) instead.
+  def add_style(style)
+    number_format_index = number_format_index(style.number_format_string)
+    font_index = font_index(style.font)
+    
+    format = [font_index, number_format_index, style.alignment, style.borders, style.pattern, style.protection]
+    [format, format_index(format)]
+  end
+  
+  public
+  def to_biff
+    fonts_biff + number_formats_biff + cell_styles_biff + StyleRecord.new.to_biff
+  end
+  
+  # TODO use inject here?
+  def fonts_biff
+    result = ''
+    @fonts.sort.each do |i, f|
+      result += f.to_biff
+    end
+    result
+  end
+  
+  def number_formats_biff
+    result = ''
+    @number_formats.sort.each do |i, f|
+      next if i < FIRST_USER_DEFINED_NUM_FORMAT_INDEX
+      result += NumberFormatRecord.new(i, f).to_biff
+    end
+    result
+  end
+  
+  def cell_styles_biff
+    result = ''
+    0.upto(15) do |i|
+      result += XFRecord.new(@default_format, 'style').to_biff
+    end
+    @styles.sort.each do |i, f|
+      result += XFRecord.new(f).to_biff
+    end
+    result
+  end
+end

data/lib/surpass.rb

@@ -0,0 +1,51 @@
+module Surpass
+
+  # :stopdoc:
+  VERSION = '0.0.3'
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
+
+  # Returns the version string for the library.
+  #
+  def self.version
+    VERSION
+  end
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
+  end
+
+  # Returns the lpath for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    args.empty? ? PATH : ::File.join(PATH, args.flatten)
+  end
+
+  # Utility method used to require all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = "." )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+
+    Dir.glob(search_me).sort.each do |rb|
+      next if File.basename(rb) === File.basename(__FILE__) # skip surpass.rb
+      require rb
+    end
+  end
+
+end  # module Surpass
+
+Surpass.require_all_libs_relative_to(__FILE__)
+
+require 'date'

data/lib/utilities.rb

@@ -0,0 +1,86 @@
+module Utilities
+  # For ease of comparing with pyExcelerator output values
+  # python seems to automatically decode to hex values
+  def hex_array_to_binary_string(array_of_hex_values)
+    [array_of_hex_values.collect {|h| [sprintf("%02x", h)]}.join].pack('H*')
+  end
+  
+  def binary_string_to_hex_array(binary_string)
+    binary_string.unpack("H*")
+  end
+  
+  def points_to_pixels(points)
+    points*(4.0/3)
+  end
+  
+  def pixels_to_points(pixels)
+    pixels * (3.0 / 4)
+  end
+  
+  def twips_to_pixels(twips)
+    twips / 15.0
+  end
+  
+  def pixels_to_twips(pixels)
+    pixels * 15.0
+  end
+  
+  def as_excel_date(date)
+    date = DateTime.parse(date.strftime("%c")) if date.is_a?(Time)
+    excel_date = (date - Date.civil(1899, 12, 31)).to_f
+    excel_date += 1 if excel_date > 59 # Add a day for Excel's missing leap day in 1900
+    excel_date
+  end
+  
+  def mock_unicode_string(s)
+    [s.length, 0].pack('vC') + s
+  end
+  
+  
+  def as_boolean(input)
+    case input
+    when 1, true
+      true
+    when 0, false
+      false
+    else
+      raise "Can't convert #{input} from excel boolean!"
+    end
+  end
+  
+  def as_numeric(input)
+    case input
+    when true, 1
+      1
+    when false, 0
+      0
+    else
+      raise "Can't convert #{input} to excel boolean!"
+    end
+  end
+  
+  # Mimic python's "hex" function 0x00
+  def hex(value)
+    "0x" + value.to_s(16)
+  end
+end
+
+def String.random_alphanumeric(size=16)
+  s = ""
+  size.times { s << (i = Kernel.rand(62); i += ((i < 10) ? 48 : ((i < 36) ? 55 : 61 ))).chr }
+  s
+end
+
+class TrueClass
+  def to_i
+    1
+  end
+end
+
+class FalseClass
+  def to_i
+    0
+  end
+end
+
+include Utilities

data/lib/workbook.rb

@@ -0,0 +1,206 @@
+class Workbook
+  MACROS = {
+      'Consolidate_Area' => 0x00,
+      'Auto_Open' => 0x01,
+      'Auto_Close' => 0x02,
+      'Extract' => 0x03,
+      'Database' => 0x04,
+      'Criteria' => 0x05,
+      'Print_Area' => 0x06,
+      'Print_Titles' => 0x07, # in the docs it says Pint_Titles, I think its a mistake
+      'Recorder' => 0x08,
+      'Data_Form' => 0x09,
+      'Auto_Activate' => 0x0A,
+      'Auto_Deactivate' => 0x0B,
+      'Sheet_Title' => 0x0C,
+      '_FilterDatabase' => 0x0D
+  }
+  
+  attr_accessor :owner
+  attr_accessor :country_code
+  attr_accessor :wnd_protect
+  attr_accessor :obj_protect
+  attr_accessor :protect
+  attr_accessor :backup_on_save
+  attr_accessor :styles
+  attr_accessor :sst
+  
+  def hpos_twips=(value)
+    @hpos_twips = value & 0xFFFF
+  end
+  
+  attr_reader :vpos_twips
+  def vpos_twips=(value)
+    @vpos_twips = value & 0xFFFF
+  end
+  
+  attr_reader :width_twips
+  def width_twips=(value)
+    @width_twips = value & 0xFFFF
+  end
+  
+  attr_reader :height_twips
+  def height_twips=(value)
+    @height_twips = value & 0xFFFF
+  end
+  
+  attr_reader :active_sheet
+  def active_sheet=(value)
+    @active_sheet = value & 0xFFFF
+    @first_tab_index = @active_sheet
+  end
+  
+  attr_reader :tab_width_twips
+  def tab_width_twips=(value)
+    @tab_width_twips = value & 0xFFFF
+  end
+  
+  attr_reader :default_style
+
+  def initialize(filename = nil)
+    @owner = 'None'
+    @wnd_protect = 0
+    @obj_protect = 0
+    @protect = 0
+    @backup_on_save = 0
+
+    @hpos_twips = 0x01E0
+    @vpos_twips = 0x005A
+    @width_twips = 0x3FCF
+    @height_twips = 0x2A4E
+
+    @active_sheet = 0
+    @first_tab_index = 0
+    @selected_tabs = 0x01
+    @tab_width_twips = 0x0258
+
+    @wnd_hidden = false
+    @wnd_mini = false
+    @hscroll_visible = true
+    @vscroll_visible = true
+    @tabs_visible = true
+
+    @styles = ::StyleCollection.new
+
+    @dates_1904 = false
+    @use_cell_values = true
+
+    @sst = SharedStringTable.new
+
+    @worksheets = []
+    @names = []
+    @refs = []
+    
+    @filename = filename
+  end
+  
+  def add_sheet(name = nil)
+    name ||= "Sheet#{@worksheets.length + 1}"
+    s = Worksheet.new(name, self)
+    @worksheets << s
+    s
+  end
+  
+  def print_area(sheetnum, rstart, rend, cstart, cend)
+    if !sheetnum.is_a?(Integer)
+      i = 0
+      @worksheets.each_with_index do |w, i|
+        sheetnum = i+1 if w.name === sheetnum
+        break if sheetnum.is_a?(Integer)
+      end
+    end
+    
+    options = 0x0020 # see Options Flags for Name record
+     
+    # FIXME: this is just a bad hack, need to use Formula to make the rpn
+    #~ rpn = ExcelFormula.Formula('').rpn()[2:] # minus the size field
+    rpn = [0x3B, 0x0000, rstart, rend, cstart, cend].pack('Cv5')
+    args = [options, 0x00, MACROS['Print_Area'], sheetnum, rpn]
+    @names << NameRecord.new(*args).to_biff
+  end
+  
+  def to_biff
+    raise "You cannot save a workbook with no worksheets" if @worksheets.empty?
+    
+    section_1_array = []
+    section_1_array << Biff8BOFRecord.new(Biff8BOFRecord::BOOK_GLOBAL).to_biff
+    section_1_array << InterfaceHeaderRecord.new.to_biff
+    section_1_array << MMSRecord.new.to_biff
+    section_1_array << InterfaceEndRecord.new.to_biff
+    section_1_array << WriteAccessRecord.new(owner).to_biff
+    section_1_array << CodepageBiff8Record.new.to_biff
+    section_1_array << DSFRecord.new.to_biff
+    section_1_array << TabIDRecord.new(@worksheets.length).to_biff
+    section_1_array << FnGroupCountRecord.new.to_biff
+    section_1_array << WindowProtectRecord.new(as_numeric(@wnd_protect)).to_biff
+    section_1_array << ProtectRecord.new(as_numeric(@protect)).to_biff
+    section_1_array << ObjectProtectRecord.new(as_numeric(@obj_protect)).to_biff
+    section_1_array << PasswordRecord.new.to_biff
+    section_1_array << Prot4RevRecord.new.to_biff
+    section_1_array << Prot4RevPassRecord.new.to_biff
+    section_1_array << BackupRecord.new(@backup_on_save).to_biff
+    section_1_array << HideObjRecord.new.to_biff
+    section_1_array << window_1_record
+    section_1_array << DateModeRecord.new(@dates_1904).to_biff
+    section_1_array << PrecisionRecord.new(@use_cell_values).to_biff
+    section_1_array << RefreshAllRecord.new.to_biff
+    section_1_array << BookBoolRecord.new.to_biff
+    section_1_array << @styles.to_biff
+    section_1_array << '' # Palette
+    section_1_array << UseSelfsRecord.new.to_biff
+    section_1 = section_1_array.join
+
+    section_3_array = []
+    section_3_array << CountryRecord.new(@country_code, @country_code).to_biff unless @country_code.nil?
+    # section_3_array << InternalReferenceSupBookRecord.new(@worksheets.length).to_biff
+    # section_3_array << ExternSheetRecord.new(@refs).to_biff
+    # section_3_array << @names.collect {|n| n.to_biff}.join
+    section_3_array << @sst.to_biff
+    section_3 = section_3_array.join
+    
+    section_4 = '' # ExtSSTRecord
+    section_5 = EOFRecord.new.to_biff
+    
+    @worksheets[@active_sheet].selected = true
+    worksheet_biff_data = @worksheets.collect {|w| w.to_biff }
+    worksheet_biff_data_lengths = worksheet_biff_data.collect {|w| w.length }
+    section_6 = worksheet_biff_data.join
+    
+    # Need to know how long the bound sheet records will be
+    boundsheet_data_lengths = @worksheets.collect {|w| BoundSheetRecord.new(0x00, w.visibility, w.name).to_biff.length }
+    total_boundsheet_data_length = boundsheet_data_lengths.inject(0) {|sum, l| sum + l}
+    start_position = section_1.length + total_boundsheet_data_length + section_3.length + section_4.length + section_5.length
+    
+    boundsheet_records = []
+    @worksheets.each_with_index do |w, i|
+      boundsheet_records << BoundSheetRecord.new(start_position, w.visibility, w.name).to_biff
+      start_position += worksheet_biff_data_lengths[i]
+    end
+    
+    section_2 = boundsheet_records.join
+    section_1 + section_2 + section_3 + section_4 + section_5 + section_6
+  end
+  
+  def window_1_record
+    flags = 0
+    flags |= (as_numeric(@wnd_hidden)) << 0
+    flags |= (as_numeric(@wnd_mini)) << 1
+    flags |= (as_numeric(@hscroll_visible)) << 3
+    flags |= (as_numeric(@vscroll_visible)) << 4
+    flags |= (as_numeric(@tabs_visible)) << 5
+    
+    args = [@hpos_twips, @vpos_twips, @width_twips, @height_twips, flags, @active_sheet, @first_tab_index, @selected_tabs, @tab_width_twips]
+    Window1Record.new(*args).to_biff
+  end
+  
+  def data
+    doc = ExcelDocument.new
+    doc.data(to_biff)
+  end
+  
+  def save(filename = nil)
+    @filename = filename unless filename.nil?
+    doc = ExcelDocument.new
+    doc.save(@filename, to_biff)
+  end
+end