Class: Axlsx::Package
- Inherits:
-
Object
- Object
- Axlsx::Package
- Defined in:
- lib/axlsx/package.rb
Overview
Package is responsible for managing all the bits and peices that Open Office XML requires to make a valid xlsx document including valdation and serialization.
Instance Method Summary collapse
-
#initialize(options = {}) {|_self| ... } ⇒ Package
constructor
Initializes your package.
-
#serialize(output, confirm_valid = false) ⇒ Boolean
Serialize your workbook to disk as an xlsx document.
-
#validate ⇒ Array
Validate all parts of the package against xsd schema.
-
#workbook {|@workbook| ... } ⇒ Workbook
The workbook this package will serialize or validate.
- #workbook=(workbook) ⇒ Object
Constructor Details
Instance Method Details
#serialize(output, confirm_valid = false) ⇒ Boolean
A tremendous amount of effort has gone into ensuring that you cannot create invalid xlsx documents. confirm_valid should be used in the rare case that you cannot open the serialized file.
Serialize your workbook to disk as an xlsx document.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/axlsx/package.rb', line 62 def serialize(output, confirm_valid=false) return false unless !confirm_valid || self.validate.empty? p = parts Zip::ZipOutputStream.open(output) do |zip| p.each do |part| unless part[:doc].nil? zip.put_next_entry(part[:entry]); entry = ['1.9.2', '1.9.3'].include?(RUBY_VERSION) ? part[:doc].force_encoding('BINARY') : part[:doc] zip.puts(entry) end unless part[:path].nil? zip.put_next_entry(part[:entry]); # binread for 1.9.3 zip.write IO.respond_to?(:binread) ? IO.binread(part[:path]) : IO.read(part[:path]) end end end true end |
#validate ⇒ Array
This gem includes all schema from OfficeOpenXML-XMLSchema-Transitional.zip and OpenPackagingConventions-XMLSchema.zip as per ECMA-376, Third edition. opc schema require an internet connection to import remote schema from dublin core for dc, dcterms and xml namespaces. Those remote schema are included in this gem, and the original files have been altered to refer to the local versions.
If by chance you are able to creat a package that does not validate it indicates that the internal validation is not robust enough and needs to be improved. Please report your errors to the gem author.
Validate all parts of the package against xsd schema.
98 99 100 101 102 |
# File 'lib/axlsx/package.rb', line 98 def validate errors = [] parts.each { |part| errors.concat validate_single_doc(part[:schema], part[:doc]) unless part[:schema].nil? } errors end |
#workbook {|@workbook| ... } ⇒ Workbook
As there are multiple ways to instantiate a workbook for the package, here are a few examples:
# 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
The workbook this package will serialize or validate.
31 32 33 34 35 |
# File 'lib/axlsx/package.rb', line 31 def workbook @workbook || @workbook = Workbook.new yield @workbook if block_given? @workbook end |
#workbook=(workbook) ⇒ Object
45 |
# File 'lib/axlsx/package.rb', line 45 def workbook=(workbook) DataTypeValidator.validate "Package.workbook", Workbook, workbook; @workbook = workbook; end |