Class: Axlsx::Package

Inherits:

Object

• Object
• Axlsx::Package

show all

Defined in:

lib/axlsx/package.rb

Overview

Instance Attribute Summary (collapse)

• - (Object) app readonly

  provides access to the app doc properties for this package see App.

• - (Object) core readonly

  provides access to the core doc properties for the package see Core.

Instance Method Summary (collapse)

• - (Object) encrypt(file_name, password)

  Encrypt the package into a CFB using the password provided This is not ready yet.

• - (Package) initialize(options = {}) {|_self| ... } constructor

  Initializes your package.

• - (Boolean) serialize(output, confirm_valid = false)

  Serialize your workbook to disk as an xlsx document.

• - (StringIO|Boolean) to_stream(confirm_valid = false)

  Serialize your workbook to a StringIO instance.

• - (Object) use_autowidth=(v)

  Shortcut to specify that the workbook should use autowidth.

• - (Object) use_shared_strings

  Shortcut to determine if the workbook is configured to use shared strings.

• - (Object) use_shared_strings=(v)

  Shortcut to specify that the workbook should use shared strings.

• - (Array) validate

  Validate all parts of the package against xsd schema.

• - (Workbook) workbook {|@workbook| ... }

  The workbook this package will serialize or validate.

• - (Object) workbook=(workbook)

22
23
24
25
26
27
28
29
30

# File 'lib/axlsx/package.rb', line 22

def initialize(options={})
  @workbook = nil
  @core, @app  =  Core.new, App.new
  @core.creator = options[:author] || @core.creator
  options.each do |o|
    self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
  end
  yield self if block_given?
end

10
11
12

# File 'lib/axlsx/package.rb', line 10

def app
  @app
end

14
15
16

# File 'lib/axlsx/package.rb', line 14

def core
  @core
end

119
120
121
122
123

# File 'lib/axlsx/package.rb', line 119

def encrypt(file_name, password)
  return false
  # moc = MsOffCrypto.new(file_name, password)
  # moc.save
end

# This is how easy it is to create a valid xlsx file. Of course you might want to add a sheet or two, and maybe some data, styles and charts.
# Take a look at the README for an example of how to do it!
f = File.open('test.xlsx', 'w')
Package.new.serialize(f)

# You will find a file called test.xlsx

97
98
99
100
101
102
103

# File 'lib/axlsx/package.rb', line 97

def serialize(output, confirm_valid=false)
  return false unless !confirm_valid || self.validate.empty?
  Zip::ZipOutputStream.open(output) do |zip|
    write_parts(zip)
  end
  true
end

109
110
111
112
113
114
115

# File 'lib/axlsx/package.rb', line 109

def to_stream(confirm_valid=false)
  return false unless !confirm_valid || self.validate.empty?
  zip = write_parts(Zip::ZipOutputStream.new("streamed", true))
  stream = zip.close_buffer
  stream.rewind
  stream
end

34
35
36
37

# File 'lib/axlsx/package.rb', line 34

def use_autowidth=(v)
  Axlsx::validate_boolean(v);
  workbook.use_autowidth = v
end

49
50
51

# File 'lib/axlsx/package.rb', line 49

def use_shared_strings
  workbook.use_shared_strings
end

42
43
44
45

# File 'lib/axlsx/package.rb', line 42

def use_shared_strings=(v)
  Axlsx::validate_boolean(v);
  workbook.use_shared_strings = v
end

# The following will output any error messages found in serialization.
p = Axlsx::Package.new
# ... code to create sheets, charts, styles etc.
p.validate.each { |error| puts error.message }

140
141
142
143
144
145
146

# File 'lib/axlsx/package.rb', line 140

def validate
  errors = []
  parts.each do |part|
    errors.concat validate_single_doc(part[:schema], part[:doc]) unless part[:schema].nil?
  end
  errors
end

# assign directly during package instanciation
wb = Package.new(:workbook => Workbook.new).workbook

# get a fresh workbook automatically from the package
wb = Pacakge.new().workbook
#     # set the workbook after creating the package
wb = Package.new().workbook = Workbook.new

65
66
67
68
69

# File 'lib/axlsx/package.rb', line 65

def workbook
  @workbook || @workbook = Workbook.new
  yield @workbook if block_given?
  @workbook
end

79

# File 'lib/axlsx/package.rb', line 79

def workbook=(workbook) DataTypeValidator.validate "Package.workbook", Workbook, workbook; @workbook = workbook; end