Class: Axlsx::Package
- Inherits:
-
Object
- Object
- Axlsx::Package
- Includes:
- OptionsParser
- 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 Attribute Summary collapse
-
#app ⇒ Object
readonly
provides access to the app doc properties for this package see App.
-
#core ⇒ Object
readonly
provides access to the core doc properties for the package see Core.
Instance Method Summary collapse
-
#encrypt(file_name, password) ⇒ Object
Encrypt the package into a CFB using the password provided This is not ready yet.
-
#initialize(options = {}) {|_self| ... } ⇒ Package
constructor
Initializes your package.
-
#serialize(output, confirm_valid = false) ⇒ Boolean
Serialize your workbook to disk as an xlsx document.
-
#to_stream(confirm_valid = false) ⇒ StringIO|Boolean
Serialize your workbook to a StringIO instance.
-
#use_autowidth=(v) ⇒ Object
Shortcut to specify that the workbook should use autowidth.
-
#use_shared_strings ⇒ Object
Shortcut to determine if the workbook is configured to use shared strings.
-
#use_shared_strings=(v) ⇒ Object
Shortcut to specify that the workbook should use shared strings.
-
#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
Methods included from OptionsParser
Constructor Details
Instance Attribute Details
#app ⇒ Object (readonly)
provides access to the app doc properties for this package see App
10 11 12 |
# File 'lib/axlsx/package.rb', line 10 def app @app end |
#core ⇒ Object (readonly)
provides access to the core doc properties for the package see Core
14 15 16 |
# File 'lib/axlsx/package.rb', line 14 def core @core end |
Instance Method Details
#encrypt(file_name, password) ⇒ Object
Encrypt the package into a CFB using the password provided This is not ready yet
121 122 123 124 125 |
# File 'lib/axlsx/package.rb', line 121 def encrypt(file_name, password) return false # moc = MsOffCrypto.new(file_name, password) # moc.save end |
#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.
99 100 101 102 103 104 105 |
# File 'lib/axlsx/package.rb', line 99 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 |
#to_stream(confirm_valid = false) ⇒ StringIO|Boolean
Serialize your workbook to a StringIO instance
111 112 113 114 115 116 117 |
# File 'lib/axlsx/package.rb', line 111 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 |
#use_autowidth=(v) ⇒ Object
Shortcut to specify that the workbook should use autowidth
32 33 34 35 |
# File 'lib/axlsx/package.rb', line 32 def use_autowidth=(v) Axlsx::validate_boolean(v); workbook.use_autowidth = v end |
#use_shared_strings ⇒ Object
Shortcut to determine if the workbook is configured to use shared strings
47 48 49 |
# File 'lib/axlsx/package.rb', line 47 def use_shared_strings workbook.use_shared_strings end |
#use_shared_strings=(v) ⇒ Object
Shortcut to specify that the workbook should use shared strings
40 41 42 43 |
# File 'lib/axlsx/package.rb', line 40 def use_shared_strings=(v) Axlsx::validate_boolean(v); workbook.use_shared_strings = v 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.
142 143 144 145 146 147 148 |
# File 'lib/axlsx/package.rb', line 142 def validate errors = [] parts.each do |part| errors.concat validate_single_doc(part[:schema], part[:doc]) unless part[:schema].nil? end 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.
63 64 65 66 67 |
# File 'lib/axlsx/package.rb', line 63 def workbook @workbook || @workbook = Workbook.new yield @workbook if block_given? @workbook end |
#workbook=(workbook) ⇒ Object
77 |
# File 'lib/axlsx/package.rb', line 77 def workbook=(workbook) DataTypeValidator.validate "Package.workbook", Workbook, workbook; @workbook = workbook; end |