module RubyXL::LegacyWorkbook

Constants

APPLICATION
APPVERSION
SHEET_NAME_TEMPLATE

Attributes

calculation_chain[RW]
chart_rels[RW]
charts[RW]
chartsheet_rels[RW]
content_types[RW]
core_properties[RW]
document_properties[RW]
drawings[RW]
drawings_rels[RW]
filepath[RW]
macros[RW]
media[RW]
printer_settings[RW]
relationship_container[RW]
root_relationship_container[RW]
shared_strings_container[RW]
stylesheet[RW]
theme[RW]
worksheet_rels[RW]
worksheets[RW]

Public Class Methods

new(worksheets=[], filepath=nil, creator=nil, modifier=nil, created_at=nil, company='', application=APPLICATION, appversion=APPVERSION, date1904=0) click to toggle source
Calls superclass method
# File lib/rubyXL/workbook.rb, line 18
def initialize(worksheets=[], filepath=nil, creator=nil, modifier=nil, created_at=nil,
               company='', application=APPLICATION,
               appversion=APPVERSION, date1904=0)
  super()

  # Order of sheets in the +worksheets+ array corresponds to the order of pages in Excel UI.
  # SheetId's, rId's, etc. are completely unrelated to ordering.
  @worksheets = worksheets
  add_worksheet if @worksheets.empty?

  @filepath            = filepath
  @creator             = creator
  @modifier            = modifier
  self.date1904        = date1904 > 0
  @media               = RubyXL::GenericStorage.new(File.join('xl', 'media')).binary
  @external_links      = RubyXL::GenericStorage.new(File.join('xl', 'externalLinks'))
  @external_links_rels = RubyXL::GenericStorage.new(File.join('xl', 'externalLinks', '_rels'))
  @drawings            = RubyXL::GenericStorage.new(File.join('xl', 'drawings'))
  @drawings_rels       = RubyXL::GenericStorage.new(File.join('xl', 'drawings', '_rels'))
  @charts              = RubyXL::GenericStorage.new(File.join('xl', 'charts'))
  @chart_rels          = RubyXL::GenericStorage.new(File.join('xl', 'charts', '_rels'))
  @worksheet_rels      = RubyXL::GenericStorage.new(File.join('xl', 'worksheets', '_rels'))
  @chartsheet_rels     = RubyXL::GenericStorage.new(File.join('xl', 'chartsheets', '_rels'))
  @printer_settings    = RubyXL::GenericStorage.new(File.join('xl', 'printerSettings')).binary
  @macros              = RubyXL::GenericStorage.new('xl').binary

  @theme                    = RubyXL::Theme.new
  @shared_strings_container = RubyXL::SharedStringsTable.new
  @stylesheet               = RubyXL::Stylesheet.default
  @document_properties      = RubyXL::DocumentProperties.new
  @core_properties          = RubyXL::CoreProperties.new
  @content_types            = RubyXL::ContentTypes.new
  @relationship_container   = RubyXL::WorkbookRelationships.new
  @root_relationship_container  = RubyXL::RootRelationships.new
  @calculation_chain        = nil

  self.company         = company
  self.application     = application
  self.appversion      = appversion

  begin
    @created_at       = DateTime.parse(created_at).strftime('%Y-%m-%dT%TZ')
  rescue
    @created_at       = Time.now.strftime('%Y-%m-%dT%TZ')
  end
  @modified_at        = @created_at
end

Public Instance Methods

[](ind) click to toggle source

Finds worksheet by its name or numerical index

# File lib/rubyXL/workbook.rb, line 67
def [](ind)
  case ind
  when Integer then worksheets[ind]
  when String  then worksheets.find { |ws| ws.sheet_name == ind }
  end
end
add_worksheet(name = nil) click to toggle source

Create new simple worksheet and add it to the workbook worksheets

@param [String] The name for the new worksheet

# File lib/rubyXL/workbook.rb, line 77
def add_worksheet(name = nil)
  if name.nil? then
    n = 0

    begin
      name = SHEET_NAME_TEMPLATE % (n += 1)
    end until self[name].nil?
  end

  new_worksheet = Worksheet.new(:workbook => self, :sheet_name => name || get_default_name)
  worksheets << new_worksheet
  new_worksheet
end
borders() click to toggle source
# File lib/rubyXL/workbook.rb, line 258
def borders # Stylesheet should be pre-filled with defaults on initialize()
  stylesheet.borders
end
cell_xfs() click to toggle source
# File lib/rubyXL/workbook.rb, line 246
def cell_xfs # Stylesheet should be pre-filled with defaults on initialize()
  stylesheet.cell_xfs
end
date_to_num(date) click to toggle source
# File lib/rubyXL/workbook.rb, line 144
def date_to_num(date)
  date && (date.ajd - base_date().ajd).to_f
end
each() { |i| ... } click to toggle source
# File lib/rubyXL/workbook.rb, line 91
def each
  worksheets.each{|i| yield i}
end
fills() click to toggle source
# File lib/rubyXL/workbook.rb, line 254
def fills # Stylesheet should be pre-filled with defaults on initialize()
  stylesheet.fills
end
fonts() click to toggle source
# File lib/rubyXL/workbook.rb, line 250
def fonts # Stylesheet should be pre-filled with defaults on initialize()
  stylesheet.fonts
end
get_fill_color(xf) click to toggle source
# File lib/rubyXL/workbook.rb, line 152
def get_fill_color(xf)
  fill = fills[xf.fill_id]
  pattern = fill && fill.pattern_fill
  color = pattern && pattern.fg_color
  color && color.rgb || 'ffffff'
end
modify_alignment(style_index, is_horizontal, alignment) click to toggle source
# File lib/rubyXL/workbook.rb, line 208
def modify_alignment(style_index, is_horizontal, alignment)
  xf = cell_xfs[style_index].dup
  xf.alignment = RubyXL::Alignment.new(:apply_alignment => true,
                                       :horizontal => is_horizontal ? alignment : nil, 
                                       :vertical   => is_horizontal ? nil : alignment)
  register_new_xf(xf, style_index)
end
modify_border(style_index, direction, weight) click to toggle source
# File lib/rubyXL/workbook.rb, line 225
def modify_border(style_index, direction, weight)
  old_xf = cell_xfs[style_index].dup
  new_border = borders[old_xf.border_id].dup
  new_border.set_edge_style(direction, weight)

  new_xf = old_xf.dup

  unless borders[old_xf.border_id].count == 1 && old_xf.border_id > 0 # If the old border not used anymore, just replace it
    new_xf.border_id = borders.find_index { |x| x == new_border } # Use existing border, if it exists
    new_xf.border_id ||= borders.size # If this border has never existed before, add it to collection.
  end

  borders[old_xf.border_id].count -= 1
  new_border.count += 1
  borders[new_xf.border_id] = new_border

  new_xf.apply_border = true

  register_new_xf(new_xf, style_index)
end
modify_fill(style_index, rgb) click to toggle source
# File lib/rubyXL/workbook.rb, line 216
def modify_fill(style_index, rgb)
  xf = cell_xfs[style_index].dup
  new_fill = RubyXL::Fill.new(:pattern_fill => 
               RubyXL::PatternFill.new(:pattern_type => 'solid',
                                       :fg_color => RubyXL::Color.new(:rgb => rgb)))
  new_xf = register_new_fill(new_fill, xf)
  register_new_xf(new_xf, style_index)
end
modify_text_wrap(style_index, wrap = false) click to toggle source
# File lib/rubyXL/workbook.rb, line 202
def modify_text_wrap(style_index, wrap = false)
  xf = cell_xfs[style_index].dup
  xf.alignment = RubyXL::Alignment.new(:wrap_text => wrap, :apply_alignment => true)
  register_new_xf(xf, style_index)
end
num_to_date(num) click to toggle source
# File lib/rubyXL/workbook.rb, line 148
def num_to_date(num)
  num && (base_date + num)
end
register_new_fill(new_fill, old_xf) click to toggle source
# File lib/rubyXL/workbook.rb, line 159
def register_new_fill(new_fill, old_xf)
  new_xf = old_xf.dup

  unless fills[old_xf.fill_id].count == 1 && old_xf.fill_id > 2 # If the old fill is not used anymore, just replace it
    new_xf.fill_id = fills.find_index { |x| x == new_fill } # Use existing fill, if it exists
    new_xf.fill_id ||= fills.size # If this fill has never existed before, add it to collection.
  end

  fills[old_xf.fill_id].count -= 1
  new_fill.count += 1
  fills[new_xf.fill_id] = new_fill

  new_xf.apply_fill = true
  new_xf
end
register_new_font(new_font, old_xf) click to toggle source
# File lib/rubyXL/workbook.rb, line 175
def register_new_font(new_font, old_xf)
  new_xf = old_xf.dup

  unless fonts[old_xf.font_id].count == 1 && old_xf.font_id > 1 # If the old font is not used anymore, just replace it
    new_xf.font_id = fonts.find_index { |x| x == new_font } # Use existing font, if it exists
    new_xf.font_id ||= fonts.size # If this font has never existed before, add it to collection.
  end

  fonts[old_xf.font_id].count -= 1
  new_font.count += 1
  fonts[new_xf.font_id] = new_font

  new_xf.apply_font = true
  new_xf
end
register_new_xf(new_xf, old_style_index) click to toggle source
# File lib/rubyXL/workbook.rb, line 191
def register_new_xf(new_xf, old_style_index)
  new_xf_id = cell_xfs.find_index { |xf| xf == new_xf } # Use existing XF, if it exists
  new_xf_id ||= cell_xfs.size # If this XF has never existed before, add it to collection.

  cell_xfs[old_style_index].count -= 1
  new_xf.count += 1
  cell_xfs[new_xf_id] = new_xf

  new_xf_id
end
write(filepath = @filepath) click to toggle source

filepath of xlsx file (including file itself)

# File lib/rubyXL/workbook.rb, line 96
def write(filepath = @filepath)
  extension = File.extname(filepath)
  unless %w{.xlsx .xlsm}.include?(extension)
    raise "Only xlsx and xlsm files are supported. Unsupported extension: #{extension}"
  end

  dirpath  = File.dirname(filepath)
  temppath = File.join(dirpath, Dir::Tmpname.make_tmpname([ File.basename(filepath), '.tmp' ], nil))
  FileUtils.mkdir_p(temppath)
  zippath  = File.join(temppath, 'file.zip')

  ::Zip::File.open(zippath, ::Zip::File::CREATE) { |zipfile|
    theme && theme.add_to_zip(zipfile)
    calculation_chain && calculation_chain.add_to_zip(zipfile)
    shared_strings_container && shared_strings_container.add_to_zip(zipfile)
    document_properties.add_to_zip(zipfile)
    core_properties.add_to_zip(zipfile)
    content_types.workbook = self
    content_types.add_to_zip(zipfile)
    relationship_container.workbook = self
    relationship_container.add_to_zip(zipfile)
    stylesheet.add_to_zip(zipfile)
    root_relationship_container.add_to_zip(zipfile)
    self.add_to_zip(zipfile)

    [ @media, @external_links, @external_links_rels,
      @drawings, @drawings_rels, @charts, @chart_rels,
      @printer_settings, @worksheet_rels, @chartsheet_rels, @macros ].each { |s| s.add_to_zip(zipfile) }

    @worksheets.each { |sheet| sheet.add_to_zip(zipfile) }
  }

  FileUtils.mv(zippath, filepath)
  FileUtils.rm_rf(temppath) if File.exist?(filepath)

  return filepath
end