caxlsx 3.1.1 → 3.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +9 -9
- data/.yardopts_guide +18 -18
- data/CHANGELOG.md +354 -343
- data/LICENSE +21 -21
- data/README.md +168 -172
- data/Rakefile +29 -29
- data/examples/generate.rb +15 -15
- data/lib/axlsx/content_type/abstract_content_type.rb +32 -32
- data/lib/axlsx/content_type/content_type.rb +26 -26
- data/lib/axlsx/content_type/default.rb +25 -25
- data/lib/axlsx/content_type/override.rb +25 -25
- data/lib/axlsx/doc_props/app.rb +235 -235
- data/lib/axlsx/doc_props/core.rb +39 -39
- data/lib/axlsx/drawing/area_chart.rb +99 -99
- data/lib/axlsx/drawing/area_series.rb +110 -110
- data/lib/axlsx/drawing/ax_data_source.rb +26 -26
- data/lib/axlsx/drawing/axes.rb +61 -61
- data/lib/axlsx/drawing/axis.rb +190 -190
- data/lib/axlsx/drawing/bar_3D_chart.rb +148 -148
- data/lib/axlsx/drawing/bar_chart.rb +138 -138
- data/lib/axlsx/drawing/bar_series.rb +97 -97
- data/lib/axlsx/drawing/bubble_chart.rb +59 -59
- data/lib/axlsx/drawing/bubble_series.rb +63 -63
- data/lib/axlsx/drawing/cat_axis.rb +85 -85
- data/lib/axlsx/drawing/chart.rb +276 -276
- data/lib/axlsx/drawing/d_lbls.rb +90 -90
- data/lib/axlsx/drawing/drawing.rb +167 -167
- data/lib/axlsx/drawing/graphic_frame.rb +54 -54
- data/lib/axlsx/drawing/hyperlink.rb +100 -100
- data/lib/axlsx/drawing/line_3D_chart.rb +68 -68
- data/lib/axlsx/drawing/line_chart.rb +99 -99
- data/lib/axlsx/drawing/line_series.rb +110 -110
- data/lib/axlsx/drawing/marker.rb +84 -84
- data/lib/axlsx/drawing/num_data.rb +52 -52
- data/lib/axlsx/drawing/num_data_source.rb +62 -62
- data/lib/axlsx/drawing/num_val.rb +34 -34
- data/lib/axlsx/drawing/one_cell_anchor.rb +99 -99
- data/lib/axlsx/drawing/pic.rb +211 -211
- data/lib/axlsx/drawing/picture_locking.rb +42 -42
- data/lib/axlsx/drawing/pie_3D_chart.rb +47 -47
- data/lib/axlsx/drawing/pie_series.rb +74 -74
- data/lib/axlsx/drawing/scaling.rb +60 -60
- data/lib/axlsx/drawing/scatter_chart.rb +74 -74
- data/lib/axlsx/drawing/scatter_series.rb +129 -98
- data/lib/axlsx/drawing/ser_axis.rb +45 -45
- data/lib/axlsx/drawing/series.rb +69 -69
- data/lib/axlsx/drawing/series_title.rb +25 -25
- data/lib/axlsx/drawing/str_data.rb +42 -42
- data/lib/axlsx/drawing/str_val.rb +34 -34
- data/lib/axlsx/drawing/title.rb +97 -97
- data/lib/axlsx/drawing/two_cell_anchor.rb +97 -97
- data/lib/axlsx/drawing/val_axis.rb +37 -37
- data/lib/axlsx/drawing/view_3D.rb +115 -115
- data/lib/axlsx/drawing/vml_drawing.rb +42 -42
- data/lib/axlsx/drawing/vml_shape.rb +66 -66
- data/lib/axlsx/package.rb +388 -388
- data/lib/axlsx/rels/relationship.rb +130 -130
- data/lib/axlsx/rels/relationships.rb +32 -32
- data/lib/axlsx/stylesheet/border.rb +73 -71
- data/lib/axlsx/stylesheet/border_pr.rb +71 -71
- data/lib/axlsx/stylesheet/cell_alignment.rb +132 -132
- data/lib/axlsx/stylesheet/cell_protection.rb +41 -41
- data/lib/axlsx/stylesheet/cell_style.rb +72 -72
- data/lib/axlsx/stylesheet/color.rb +76 -76
- data/lib/axlsx/stylesheet/dxf.rb +79 -79
- data/lib/axlsx/stylesheet/fill.rb +35 -35
- data/lib/axlsx/stylesheet/font.rb +156 -156
- data/lib/axlsx/stylesheet/gradient_fill.rb +103 -103
- data/lib/axlsx/stylesheet/gradient_stop.rb +37 -37
- data/lib/axlsx/stylesheet/num_fmt.rb +86 -86
- data/lib/axlsx/stylesheet/pattern_fill.rb +73 -73
- data/lib/axlsx/stylesheet/styles.rb +494 -420
- data/lib/axlsx/stylesheet/table_style.rb +54 -54
- data/lib/axlsx/stylesheet/table_style_element.rb +77 -77
- data/lib/axlsx/stylesheet/table_styles.rb +46 -46
- data/lib/axlsx/stylesheet/xf.rb +147 -147
- data/lib/axlsx/util/accessors.rb +64 -64
- data/lib/axlsx/util/constants.rb +410 -401
- data/lib/axlsx/util/mime_type_utils.rb +11 -11
- data/lib/axlsx/util/options_parser.rb +16 -16
- data/lib/axlsx/util/serialized_attributes.rb +89 -89
- data/lib/axlsx/util/simple_typed_list.rb +179 -179
- data/lib/axlsx/util/storage.rb +146 -146
- data/lib/axlsx/util/validators.rb +312 -312
- data/lib/axlsx/util/zip_command.rb +73 -73
- data/lib/axlsx/version.rb +5 -5
- data/lib/axlsx/workbook/defined_name.rb +128 -128
- data/lib/axlsx/workbook/defined_names.rb +21 -21
- data/lib/axlsx/workbook/shared_strings_table.rb +77 -77
- data/lib/axlsx/workbook/workbook.rb +395 -370
- data/lib/axlsx/workbook/workbook_view.rb +80 -80
- data/lib/axlsx/workbook/workbook_views.rb +22 -22
- data/lib/axlsx/workbook/worksheet/auto_filter/auto_filter.rb +77 -77
- data/lib/axlsx/workbook/worksheet/auto_filter/filter_column.rb +94 -94
- data/lib/axlsx/workbook/worksheet/auto_filter/filters.rb +244 -244
- data/lib/axlsx/workbook/worksheet/break.rb +35 -35
- data/lib/axlsx/workbook/worksheet/cell.rb +506 -505
- data/lib/axlsx/workbook/worksheet/cell_serializer.rb +164 -164
- data/lib/axlsx/workbook/worksheet/cfvo.rb +60 -60
- data/lib/axlsx/workbook/worksheet/cfvos.rb +18 -18
- data/lib/axlsx/workbook/worksheet/col.rb +145 -145
- data/lib/axlsx/workbook/worksheet/col_breaks.rb +35 -35
- data/lib/axlsx/workbook/worksheet/color_scale.rb +110 -110
- data/lib/axlsx/workbook/worksheet/cols.rb +23 -23
- data/lib/axlsx/workbook/worksheet/comment.rb +91 -91
- data/lib/axlsx/workbook/worksheet/comments.rb +82 -82
- data/lib/axlsx/workbook/worksheet/conditional_formatting.rb +82 -82
- data/lib/axlsx/workbook/worksheet/conditional_formatting_rule.rb +220 -220
- data/lib/axlsx/workbook/worksheet/conditional_formattings.rb +25 -25
- data/lib/axlsx/workbook/worksheet/data_bar.rb +129 -129
- data/lib/axlsx/workbook/worksheet/data_validation.rb +246 -246
- data/lib/axlsx/workbook/worksheet/data_validations.rb +28 -28
- data/lib/axlsx/workbook/worksheet/date_time_converter.rb +30 -30
- data/lib/axlsx/workbook/worksheet/dimension.rb +64 -64
- data/lib/axlsx/workbook/worksheet/header_footer.rb +52 -52
- data/lib/axlsx/workbook/worksheet/icon_set.rb +81 -81
- data/lib/axlsx/workbook/worksheet/merged_cells.rb +37 -37
- data/lib/axlsx/workbook/worksheet/outline_pr.rb +33 -33
- data/lib/axlsx/workbook/worksheet/page_margins.rb +97 -97
- data/lib/axlsx/workbook/worksheet/page_set_up_pr.rb +44 -44
- data/lib/axlsx/workbook/worksheet/page_setup.rb +240 -240
- data/lib/axlsx/workbook/worksheet/pane.rb +139 -139
- data/lib/axlsx/workbook/worksheet/pivot_table.rb +296 -294
- data/lib/axlsx/workbook/worksheet/pivot_table_cache_definition.rb +66 -66
- data/lib/axlsx/workbook/worksheet/pivot_tables.rb +24 -24
- data/lib/axlsx/workbook/worksheet/print_options.rb +39 -39
- data/lib/axlsx/workbook/worksheet/protected_range.rb +47 -47
- data/lib/axlsx/workbook/worksheet/protected_ranges.rb +37 -37
- data/lib/axlsx/workbook/worksheet/rich_text.rb +55 -55
- data/lib/axlsx/workbook/worksheet/rich_text_run.rb +250 -250
- data/lib/axlsx/workbook/worksheet/row.rb +164 -164
- data/lib/axlsx/workbook/worksheet/row_breaks.rb +33 -33
- data/lib/axlsx/workbook/worksheet/selection.rb +101 -101
- data/lib/axlsx/workbook/worksheet/sheet_calc_pr.rb +29 -29
- data/lib/axlsx/workbook/worksheet/sheet_data.rb +27 -27
- data/lib/axlsx/workbook/worksheet/sheet_pr.rb +87 -87
- data/lib/axlsx/workbook/worksheet/sheet_protection.rb +118 -118
- data/lib/axlsx/workbook/worksheet/sheet_view.rb +213 -213
- data/lib/axlsx/workbook/worksheet/table.rb +102 -102
- data/lib/axlsx/workbook/worksheet/table_style_info.rb +49 -49
- data/lib/axlsx/workbook/worksheet/tables.rb +34 -34
- data/lib/axlsx/workbook/worksheet/worksheet.rb +786 -768
- data/lib/axlsx/workbook/worksheet/worksheet_comments.rb +58 -58
- data/lib/axlsx/workbook/worksheet/worksheet_drawing.rb +58 -58
- data/lib/axlsx/workbook/worksheet/worksheet_hyperlink.rb +74 -74
- data/lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb +38 -38
- data/lib/axlsx.rb +185 -171
- data/lib/caxlsx.rb +2 -2
- data/lib/schema/dc.xsd +118 -118
- data/lib/schema/dcmitype.xsd +51 -51
- data/lib/schema/dcterms.xsd +331 -331
- data/lib/schema/dml-chartDrawing.xsd +146 -146
- data/lib/schema/dml-compatibility.xsd +14 -14
- data/lib/schema/dml-lockedCanvas.xsd +11 -11
- data/lib/schema/dml-main.xsd +3048 -3048
- data/lib/schema/dml-picture.xsd +23 -23
- data/lib/schema/dml-spreadsheetDrawing.xsd +185 -185
- data/lib/schema/dml-wordprocessingDrawing.xsd +185 -185
- data/lib/schema/shared-additionalCharacteristics.xsd +28 -28
- data/lib/schema/shared-bibliography.xsd +144 -144
- data/lib/schema/shared-commonSimpleTypes.xsd +166 -166
- data/lib/schema/shared-customXmlDataProperties.xsd +25 -25
- data/lib/schema/shared-customXmlSchemaProperties.xsd +18 -18
- data/lib/schema/shared-documentPropertiesCustom.xsd +59 -59
- data/lib/schema/shared-documentPropertiesExtended.xsd +56 -56
- data/lib/schema/shared-documentPropertiesVariantTypes.xsd +195 -195
- data/lib/schema/shared-relationshipReference.xsd +25 -25
- data/lib/schema/vml-main.xsd +569 -569
- data/lib/schema/vml-officeDrawing.xsd +509 -509
- data/lib/schema/vml-presentationDrawing.xsd +12 -12
- data/lib/schema/vml-spreadsheetDrawing.xsd +108 -108
- data/lib/schema/vml-wordprocessingDrawing.xsd +96 -96
- data/lib/schema/xml.xsd +116 -116
- data/test/benchmark.rb +72 -72
- data/test/content_type/tc_content_type.rb +76 -76
- data/test/content_type/tc_default.rb +16 -16
- data/test/content_type/tc_override.rb +14 -14
- data/test/doc_props/tc_app.rb +43 -43
- data/test/doc_props/tc_core.rb +42 -42
- data/test/drawing/tc_area_chart.rb +39 -39
- data/test/drawing/tc_area_series.rb +71 -71
- data/test/drawing/tc_axes.rb +7 -7
- data/test/drawing/tc_axis.rb +112 -112
- data/test/drawing/tc_bar_3D_chart.rb +86 -86
- data/test/drawing/tc_bar_chart.rb +86 -86
- data/test/drawing/tc_bar_series.rb +46 -46
- data/test/drawing/tc_bubble_chart.rb +44 -44
- data/test/drawing/tc_bubble_series.rb +21 -21
- data/test/drawing/tc_cat_axis.rb +31 -31
- data/test/drawing/tc_cat_axis_data.rb +27 -27
- data/test/drawing/tc_chart.rb +123 -123
- data/test/drawing/tc_d_lbls.rb +57 -57
- data/test/drawing/tc_data_source.rb +23 -23
- data/test/drawing/tc_drawing.rb +80 -80
- data/test/drawing/tc_graphic_frame.rb +27 -27
- data/test/drawing/tc_hyperlink.rb +64 -64
- data/test/drawing/tc_line_3d_chart.rb +47 -47
- data/test/drawing/tc_line_chart.rb +39 -39
- data/test/drawing/tc_line_series.rb +71 -71
- data/test/drawing/tc_marker.rb +44 -44
- data/test/drawing/tc_named_axis_data.rb +27 -27
- data/test/drawing/tc_num_data.rb +31 -31
- data/test/drawing/tc_num_val.rb +29 -29
- data/test/drawing/tc_one_cell_anchor.rb +66 -66
- data/test/drawing/tc_pic.rb +103 -103
- data/test/drawing/tc_picture_locking.rb +72 -72
- data/test/drawing/tc_pie_3D_chart.rb +28 -28
- data/test/drawing/tc_pie_series.rb +33 -33
- data/test/drawing/tc_scaling.rb +36 -36
- data/test/drawing/tc_scatter_chart.rb +48 -48
- data/test/drawing/tc_scatter_series.rb +74 -56
- data/test/drawing/tc_ser_axis.rb +31 -31
- data/test/drawing/tc_series.rb +23 -23
- data/test/drawing/tc_series_title.rb +54 -54
- data/test/drawing/tc_str_data.rb +18 -18
- data/test/drawing/tc_str_val.rb +30 -30
- data/test/drawing/tc_title.rb +70 -70
- data/test/drawing/tc_two_cell_anchor.rb +36 -36
- data/test/drawing/tc_val_axis.rb +24 -24
- data/test/drawing/tc_view_3D.rb +54 -54
- data/test/drawing/tc_vml_drawing.rb +25 -25
- data/test/drawing/tc_vml_shape.rb +106 -106
- data/test/profile.rb +24 -24
- data/test/rels/tc_relationship.rb +52 -52
- data/test/rels/tc_relationships.rb +37 -37
- data/test/stylesheet/tc_border.rb +37 -37
- data/test/stylesheet/tc_border_pr.rb +32 -32
- data/test/stylesheet/tc_cell_alignment.rb +81 -81
- data/test/stylesheet/tc_cell_protection.rb +29 -29
- data/test/stylesheet/tc_cell_style.rb +57 -57
- data/test/stylesheet/tc_color.rb +43 -43
- data/test/stylesheet/tc_dxf.rb +81 -81
- data/test/stylesheet/tc_fill.rb +18 -18
- data/test/stylesheet/tc_font.rb +133 -133
- data/test/stylesheet/tc_gradient_fill.rb +72 -72
- data/test/stylesheet/tc_gradient_stop.rb +31 -31
- data/test/stylesheet/tc_num_fmt.rb +30 -30
- data/test/stylesheet/tc_pattern_fill.rb +43 -43
- data/test/stylesheet/tc_styles.rb +309 -261
- data/test/stylesheet/tc_table_style.rb +44 -44
- data/test/stylesheet/tc_table_style_element.rb +45 -45
- data/test/stylesheet/tc_table_styles.rb +29 -29
- data/test/stylesheet/tc_xf.rb +120 -120
- data/test/tc_axlsx.rb +109 -109
- data/test/tc_helper.rb +10 -10
- data/test/tc_package.rb +317 -314
- data/test/util/tc_mime_type_utils.rb +13 -13
- data/test/util/tc_serialized_attributes.rb +19 -19
- data/test/util/tc_simple_typed_list.rb +77 -77
- data/test/util/tc_validators.rb +210 -210
- data/test/workbook/tc_defined_name.rb +49 -49
- data/test/workbook/tc_shared_strings_table.rb +59 -59
- data/test/workbook/tc_workbook.rb +165 -160
- data/test/workbook/tc_workbook_view.rb +50 -50
- data/test/workbook/worksheet/auto_filter/tc_auto_filter.rb +38 -38
- data/test/workbook/worksheet/auto_filter/tc_filter_column.rb +76 -76
- data/test/workbook/worksheet/auto_filter/tc_filters.rb +50 -50
- data/test/workbook/worksheet/tc_break.rb +49 -49
- data/test/workbook/worksheet/tc_cell.rb +465 -453
- data/test/workbook/worksheet/tc_cfvo.rb +31 -31
- data/test/workbook/worksheet/tc_col.rb +93 -93
- data/test/workbook/worksheet/tc_color_scale.rb +58 -58
- data/test/workbook/worksheet/tc_comment.rb +72 -72
- data/test/workbook/worksheet/tc_comments.rb +57 -57
- data/test/workbook/worksheet/tc_conditional_formatting.rb +224 -224
- data/test/workbook/worksheet/tc_data_bar.rb +46 -46
- data/test/workbook/worksheet/tc_data_validation.rb +265 -265
- data/test/workbook/worksheet/tc_date_time_converter.rb +124 -124
- data/test/workbook/worksheet/tc_header_footer.rb +151 -151
- data/test/workbook/worksheet/tc_icon_set.rb +45 -45
- data/test/workbook/worksheet/tc_outline_pr.rb +19 -19
- data/test/workbook/worksheet/tc_page_margins.rb +97 -97
- data/test/workbook/worksheet/tc_page_set_up_pr.rb +15 -15
- data/test/workbook/worksheet/tc_page_setup.rb +143 -143
- data/test/workbook/worksheet/tc_pane.rb +54 -54
- data/test/workbook/worksheet/tc_pivot_table.rb +180 -143
- data/test/workbook/worksheet/tc_pivot_table_cache_definition.rb +62 -62
- data/test/workbook/worksheet/tc_print_options.rb +72 -72
- data/test/workbook/worksheet/tc_protected_range.rb +17 -17
- data/test/workbook/worksheet/tc_rich_text.rb +44 -44
- data/test/workbook/worksheet/tc_rich_text_run.rb +173 -173
- data/test/workbook/worksheet/tc_row.rb +160 -160
- data/test/workbook/worksheet/tc_selection.rb +55 -55
- data/test/workbook/worksheet/tc_sheet_calc_pr.rb +18 -18
- data/test/workbook/worksheet/tc_sheet_format_pr.rb +88 -88
- data/test/workbook/worksheet/tc_sheet_pr.rb +49 -49
- data/test/workbook/worksheet/tc_sheet_protection.rb +117 -117
- data/test/workbook/worksheet/tc_sheet_view.rb +214 -214
- data/test/workbook/worksheet/tc_table.rb +77 -77
- data/test/workbook/worksheet/tc_table_style_info.rb +53 -53
- data/test/workbook/worksheet/tc_worksheet.rb +632 -601
- data/test/workbook/worksheet/tc_worksheet_hyperlink.rb +55 -55
- metadata +101 -101
data/lib/axlsx/package.rb
CHANGED
@@ -1,388 +1,388 @@
|
|
1
|
-
# encoding: utf-8
|
2
|
-
module Axlsx
|
3
|
-
# Package is responsible for managing all the bits and peices that Open Office XML requires to make a valid
|
4
|
-
# xlsx document including validation and serialization.
|
5
|
-
class Package
|
6
|
-
include Axlsx::OptionsParser
|
7
|
-
|
8
|
-
# provides access to the app doc properties for this package
|
9
|
-
# see App
|
10
|
-
attr_reader :app
|
11
|
-
|
12
|
-
# provides access to the core doc properties for the package
|
13
|
-
# see Core
|
14
|
-
attr_reader :core
|
15
|
-
|
16
|
-
# Initializes your package
|
17
|
-
#
|
18
|
-
# @param [Hash] options A hash that you can use to specify the author and workbook for this package.
|
19
|
-
# @option options [String] :author The author of the document
|
20
|
-
# @option options [Time] :created_at Timestamp in the document properties (defaults to current time).
|
21
|
-
# @option options [Boolean] :use_shared_strings This is passed to the workbook to specify that shared strings should be used when serializing the package.
|
22
|
-
# @example Package.new :author => 'you!', :workbook => Workbook.new
|
23
|
-
def initialize(options={})
|
24
|
-
@workbook = nil
|
25
|
-
@core, @app = Core.new, App.new
|
26
|
-
@core.creator = options[:author] || @core.creator
|
27
|
-
@core.created = options[:created_at]
|
28
|
-
parse_options options
|
29
|
-
yield self if block_given?
|
30
|
-
end
|
31
|
-
|
32
|
-
# Shortcut to specify that the workbook should use autowidth
|
33
|
-
# @see Workbook#use_autowidth
|
34
|
-
def use_autowidth=(v)
|
35
|
-
Axlsx::validate_boolean(v);
|
36
|
-
workbook.use_autowidth = v
|
37
|
-
end
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
# Shortcut to determine if the workbook is configured to use shared strings
|
42
|
-
# @see Workbook#use_shared_strings
|
43
|
-
def use_shared_strings
|
44
|
-
workbook.use_shared_strings
|
45
|
-
end
|
46
|
-
|
47
|
-
# Shortcut to specify that the workbook should use shared strings
|
48
|
-
# @see Workbook#use_shared_strings
|
49
|
-
def use_shared_strings=(v)
|
50
|
-
Axlsx::validate_boolean(v);
|
51
|
-
workbook.use_shared_strings = v
|
52
|
-
end
|
53
|
-
# The workbook this package will serialize or validate.
|
54
|
-
# @return [Workbook] If no workbook instance has been assigned with this package a new Workbook instance is returned.
|
55
|
-
# @raise ArgumentError if workbook parameter is not a Workbook instance.
|
56
|
-
# @note As there are multiple ways to instantiate a workbook for the package,
|
57
|
-
# here are a few examples:
|
58
|
-
# # assign directly during package instanciation
|
59
|
-
# wb = Package.new(:workbook => Workbook.new).workbook
|
60
|
-
#
|
61
|
-
# # get a fresh workbook automatically from the package
|
62
|
-
# wb = Pacakge.new().workbook
|
63
|
-
# # # set the workbook after creating the package
|
64
|
-
# wb = Package.new().workbook = Workbook.new
|
65
|
-
def workbook
|
66
|
-
@workbook || @workbook = Workbook.new
|
67
|
-
yield @workbook if block_given?
|
68
|
-
@workbook
|
69
|
-
end
|
70
|
-
|
71
|
-
# @see workbook
|
72
|
-
def workbook=(workbook) DataTypeValidator.validate :Package_workbook, Workbook, workbook; @workbook = workbook; end
|
73
|
-
|
74
|
-
# Serialize your workbook to disk as an xlsx document.
|
75
|
-
#
|
76
|
-
# @param [String] output The name of the file you want to serialize your package to
|
77
|
-
# @param [Hash] options
|
78
|
-
# @option options [Boolean] :confirm_valid Validate the package prior to serialization.
|
79
|
-
# @option options [String] :zip_command When `nil`, `#serialize` with RubyZip to
|
80
|
-
# zip the XLSX file contents. When a String, the provided zip command (e.g.,
|
81
|
-
# "zip") is used to zip the file contents (may be faster for large files)
|
82
|
-
# @return [Boolean] False if confirm_valid and validation errors exist. True if the package was serialized
|
83
|
-
# @note A tremendous amount of effort has gone into ensuring that you cannot create invalid xlsx documents.
|
84
|
-
# options[:confirm_valid] should be used in the rare case that you cannot open the serialized file.
|
85
|
-
# @see Package#validate
|
86
|
-
# @example
|
87
|
-
# # 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.
|
88
|
-
# # Take a look at the README for an example of how to do it!
|
89
|
-
#
|
90
|
-
# #serialize to a file
|
91
|
-
# p = Axlsx::Package.new
|
92
|
-
# # ......add cool stuff to your workbook......
|
93
|
-
# p.serialize("example.xlsx")
|
94
|
-
#
|
95
|
-
# # Serialize to a file, using a system zip binary
|
96
|
-
# p.serialize("example.xlsx", zip_command: "zip", confirm_valid: false)
|
97
|
-
# p.serialize("example.xlsx", zip_command: "/path/to/zip")
|
98
|
-
# p.serialize("example.xlsx", zip_command: "zip -1")
|
99
|
-
#
|
100
|
-
# # Serialize to a stream
|
101
|
-
# s = p.to_stream()
|
102
|
-
# File.open('example_streamed.xlsx', 'w') { |f| f.write(s.read) }
|
103
|
-
def serialize(output, options = {}, secondary_options = nil)
|
104
|
-
confirm_valid, zip_command = parse_serialize_options(options, secondary_options)
|
105
|
-
return false unless !confirm_valid || self.validate.empty?
|
106
|
-
zip_provider = if zip_command
|
107
|
-
ZipCommand.new(zip_command)
|
108
|
-
else
|
109
|
-
Zip::OutputStream
|
110
|
-
end
|
111
|
-
Relationship.initialize_ids_cache
|
112
|
-
zip_provider.open(output) do |zip|
|
113
|
-
write_parts(zip)
|
114
|
-
end
|
115
|
-
true
|
116
|
-
ensure
|
117
|
-
Relationship.clear_ids_cache
|
118
|
-
end
|
119
|
-
|
120
|
-
|
121
|
-
# Serialize your workbook to a StringIO instance
|
122
|
-
# @param [Boolean] confirm_valid Validate the package prior to serialization.
|
123
|
-
# @return [StringIO|Boolean] False if confirm_valid and validation errors exist. rewound string IO if not.
|
124
|
-
def to_stream(confirm_valid=false)
|
125
|
-
return false unless !confirm_valid || self.validate.empty?
|
126
|
-
Relationship.initialize_ids_cache
|
127
|
-
zip = write_parts(Zip::OutputStream.new(StringIO.new, true))
|
128
|
-
stream = zip.close_buffer
|
129
|
-
stream.rewind
|
130
|
-
stream
|
131
|
-
ensure
|
132
|
-
Relationship.clear_ids_cache
|
133
|
-
end
|
134
|
-
|
135
|
-
# Encrypt the package into a CFB using the password provided
|
136
|
-
# This is not ready yet
|
137
|
-
def encrypt(file_name, password)
|
138
|
-
return false
|
139
|
-
# moc = MsOffCrypto.new(file_name, password)
|
140
|
-
# moc.save
|
141
|
-
end
|
142
|
-
|
143
|
-
# Validate all parts of the package against xsd schema.
|
144
|
-
# @return [Array] An array of all validation errors found.
|
145
|
-
# @note This gem includes all schema from OfficeOpenXML-XMLSchema-Transitional.zip and OpenPackagingConventions-XMLSchema.zip
|
146
|
-
# as per ECMA-376, Third edition. opc schema require an internet connection to import remote schema from dublin core for dc,
|
147
|
-
# dcterms and xml namespaces. Those remote schema are included in this gem, and the original files have been altered to
|
148
|
-
# refer to the local versions.
|
149
|
-
#
|
150
|
-
# If by chance you are able to create a package that does not validate it indicates that the internal
|
151
|
-
# validation is not robust enough and needs to be improved. Please report your errors to the gem author.
|
152
|
-
# @see http://www.ecma-international.org/publications/standards/Ecma-376.htm
|
153
|
-
# @example
|
154
|
-
# # The following will output any error messages found in serialization.
|
155
|
-
# p = Axlsx::Package.new
|
156
|
-
# # ... code to create sheets, charts, styles etc.
|
157
|
-
# p.validate.each { |error| puts error.message }
|
158
|
-
def validate
|
159
|
-
errors = []
|
160
|
-
parts.each do |part|
|
161
|
-
unless part[:schema].nil?
|
162
|
-
errors.concat validate_single_doc(part[:schema], part[:doc].to_xml_string)
|
163
|
-
end
|
164
|
-
end
|
165
|
-
errors
|
166
|
-
end
|
167
|
-
|
168
|
-
private
|
169
|
-
|
170
|
-
# Writes the package parts to a zip archive.
|
171
|
-
# @param [Zip::OutputStream, ZipCommand] zip
|
172
|
-
# @return [Zip::OutputStream, ZipCommand]
|
173
|
-
def write_parts(zip)
|
174
|
-
p = parts
|
175
|
-
p.each do |part|
|
176
|
-
unless part[:doc].nil?
|
177
|
-
zip.put_next_entry(zip_entry_for_part(part))
|
178
|
-
part[:doc].to_xml_string(zip)
|
179
|
-
end
|
180
|
-
unless part[:path].nil?
|
181
|
-
zip.put_next_entry(zip_entry_for_part(part))
|
182
|
-
zip.write IO.read(part[:path], mode: "rb")
|
183
|
-
end
|
184
|
-
end
|
185
|
-
zip
|
186
|
-
end
|
187
|
-
|
188
|
-
# Generate a Entry for the given package part.
|
189
|
-
# The important part here is to explicitly set the timestamp for the zip entry: Serializing axlsx packages
|
190
|
-
# with identical contents should result in identical zip files – however, the timestamp of a zip entry
|
191
|
-
# defaults to the time of serialization and therefore the zip file contents would be different every time
|
192
|
-
# the package is serialized.
|
193
|
-
#
|
194
|
-
# Note: {Core#created} also defaults to the current time – so to generate identical axlsx packages you have
|
195
|
-
# to set this explicitly, too (eg. with `Package.new(created_at: Time.local(2013, 1, 1))`).
|
196
|
-
#
|
197
|
-
# @param part A hash describing a part of this pacakge (see {#parts})
|
198
|
-
# @return [Zip::Entry]
|
199
|
-
def zip_entry_for_part(part)
|
200
|
-
timestamp = Zip::DOSTime.at(@core.created.to_i)
|
201
|
-
Zip::Entry.new("", part[:entry], "", "", 0, 0, Zip::Entry::DEFLATED, 0, timestamp)
|
202
|
-
end
|
203
|
-
|
204
|
-
# The parts of a package
|
205
|
-
# @return [Array] An array of hashes that define the entry, document and schema for each part of the package.
|
206
|
-
# @private
|
207
|
-
def parts
|
208
|
-
parts = [
|
209
|
-
{:entry => RELS_PN, :doc => relationships, :schema => RELS_XSD},
|
210
|
-
{:entry => "xl/#{STYLES_PN}", :doc => workbook.styles, :schema => SML_XSD},
|
211
|
-
{:entry => CORE_PN, :doc => @core, :schema => CORE_XSD},
|
212
|
-
{:entry => APP_PN, :doc => @app, :schema => APP_XSD},
|
213
|
-
{:entry => WORKBOOK_RELS_PN, :doc => workbook.relationships, :schema => RELS_XSD},
|
214
|
-
{:entry => CONTENT_TYPES_PN, :doc => content_types, :schema => CONTENT_TYPES_XSD},
|
215
|
-
{:entry => WORKBOOK_PN, :doc => workbook, :schema => SML_XSD}
|
216
|
-
]
|
217
|
-
|
218
|
-
workbook.drawings.each do |drawing|
|
219
|
-
parts << {:entry => "xl/#{drawing.rels_pn}", :doc => drawing.relationships, :schema => RELS_XSD}
|
220
|
-
parts << {:entry => "xl/#{drawing.pn}", :doc => drawing, :schema => DRAWING_XSD}
|
221
|
-
end
|
222
|
-
|
223
|
-
|
224
|
-
workbook.tables.each do |table|
|
225
|
-
parts << {:entry => "xl/#{table.pn}", :doc => table, :schema => SML_XSD}
|
226
|
-
end
|
227
|
-
workbook.pivot_tables.each do |pivot_table|
|
228
|
-
cache_definition = pivot_table.cache_definition
|
229
|
-
parts << {:entry => "xl/#{pivot_table.rels_pn}", :doc => pivot_table.relationships, :schema => RELS_XSD}
|
230
|
-
parts << {:entry => "xl/#{pivot_table.pn}", :doc => pivot_table} #, :schema => SML_XSD}
|
231
|
-
parts << {:entry => "xl/#{cache_definition.pn}", :doc => cache_definition} #, :schema => SML_XSD}
|
232
|
-
end
|
233
|
-
|
234
|
-
workbook.comments.each do|comment|
|
235
|
-
if comment.size > 0
|
236
|
-
parts << { :entry => "xl/#{comment.pn}", :doc => comment, :schema => SML_XSD }
|
237
|
-
parts << { :entry => "xl/#{comment.vml_drawing.pn}", :doc => comment.vml_drawing, :schema => nil }
|
238
|
-
end
|
239
|
-
end
|
240
|
-
|
241
|
-
workbook.charts.each do |chart|
|
242
|
-
parts << {:entry => "xl/#{chart.pn}", :doc => chart, :schema => DRAWING_XSD}
|
243
|
-
end
|
244
|
-
|
245
|
-
workbook.images.each do |image|
|
246
|
-
parts << {:entry => "xl/#{image.pn}", :path => image.image_src}
|
247
|
-
end
|
248
|
-
|
249
|
-
if use_shared_strings
|
250
|
-
parts << {:entry => "xl/#{SHARED_STRINGS_PN}", :doc => workbook.shared_strings, :schema => SML_XSD}
|
251
|
-
end
|
252
|
-
|
253
|
-
workbook.worksheets.each do |sheet|
|
254
|
-
parts << {:entry => "xl/#{sheet.rels_pn}", :doc => sheet.relationships, :schema => RELS_XSD}
|
255
|
-
parts << {:entry => "xl/#{sheet.pn}", :doc => sheet, :schema => SML_XSD}
|
256
|
-
end
|
257
|
-
|
258
|
-
# Sort parts for correct MIME detection
|
259
|
-
parts.sort_by { |part| part[:entry] }
|
260
|
-
end
|
261
|
-
|
262
|
-
# Performs xsd validation for a signle document
|
263
|
-
#
|
264
|
-
# @param [String] schema path to the xsd schema to be used in validation.
|
265
|
-
# @param [String] doc The xml text to be validated
|
266
|
-
# @return [Array] An array of all validation errors encountered.
|
267
|
-
# @private
|
268
|
-
def validate_single_doc(schema, doc)
|
269
|
-
schema = Nokogiri::XML::Schema(File.open(schema))
|
270
|
-
doc = Nokogiri::XML(doc)
|
271
|
-
errors = []
|
272
|
-
schema.validate(doc).each do |error|
|
273
|
-
errors << error
|
274
|
-
end
|
275
|
-
errors
|
276
|
-
end
|
277
|
-
|
278
|
-
# Appends override objects for drawings, charts, and sheets as they exist in your workbook to the default content types.
|
279
|
-
# @return [ContentType]
|
280
|
-
# @private
|
281
|
-
def content_types
|
282
|
-
c_types = base_content_types
|
283
|
-
workbook.drawings.each do |drawing|
|
284
|
-
c_types << Axlsx::Override.new(:PartName => "/xl/#{drawing.pn}",
|
285
|
-
:ContentType => DRAWING_CT)
|
286
|
-
end
|
287
|
-
|
288
|
-
workbook.charts.each do |chart|
|
289
|
-
c_types << Axlsx::Override.new(:PartName => "/xl/#{chart.pn}",
|
290
|
-
:ContentType => CHART_CT)
|
291
|
-
end
|
292
|
-
|
293
|
-
workbook.tables.each do |table|
|
294
|
-
c_types << Axlsx::Override.new(:PartName => "/xl/#{table.pn}",
|
295
|
-
:ContentType => TABLE_CT)
|
296
|
-
end
|
297
|
-
|
298
|
-
workbook.pivot_tables.each do |pivot_table|
|
299
|
-
c_types << Axlsx::Override.new(:PartName => "/xl/#{pivot_table.pn}",
|
300
|
-
:ContentType => PIVOT_TABLE_CT)
|
301
|
-
c_types << Axlsx::Override.new(:PartName => "/xl/#{pivot_table.cache_definition.pn}",
|
302
|
-
:ContentType => PIVOT_TABLE_CACHE_DEFINITION_CT)
|
303
|
-
end
|
304
|
-
|
305
|
-
workbook.comments.each do |comment|
|
306
|
-
if comment.size > 0
|
307
|
-
c_types << Axlsx::Override.new(:PartName => "/xl/#{comment.pn}",
|
308
|
-
:ContentType => COMMENT_CT)
|
309
|
-
end
|
310
|
-
end
|
311
|
-
|
312
|
-
if workbook.comments.size > 0
|
313
|
-
c_types << Axlsx::Default.new(:Extension => "vml", :ContentType => VML_DRAWING_CT)
|
314
|
-
end
|
315
|
-
|
316
|
-
workbook.worksheets.each do |sheet|
|
317
|
-
c_types << Axlsx::Override.new(:PartName => "/xl/#{sheet.pn}",
|
318
|
-
:ContentType => WORKSHEET_CT)
|
319
|
-
end
|
320
|
-
exts = workbook.images.map { |image| image.extname.downcase }
|
321
|
-
exts.uniq.each do |ext|
|
322
|
-
ct = if ['jpeg', 'jpg'].include?(ext)
|
323
|
-
JPEG_CT
|
324
|
-
elsif ext == 'gif'
|
325
|
-
GIF_CT
|
326
|
-
elsif ext == 'png'
|
327
|
-
PNG_CT
|
328
|
-
end
|
329
|
-
c_types << Axlsx::Default.new(:ContentType => ct, :Extension => ext )
|
330
|
-
end
|
331
|
-
if use_shared_strings
|
332
|
-
c_types << Axlsx::Override.new(:PartName => "/xl/#{SHARED_STRINGS_PN}",
|
333
|
-
:ContentType => SHARED_STRINGS_CT)
|
334
|
-
end
|
335
|
-
c_types
|
336
|
-
end
|
337
|
-
|
338
|
-
# Creates the minimum content types for generating a valid xlsx document.
|
339
|
-
# @return [ContentType]
|
340
|
-
# @private
|
341
|
-
def base_content_types
|
342
|
-
c_types = ContentType.new()
|
343
|
-
c_types << Default.new(:ContentType => RELS_CT, :Extension => RELS_EX)
|
344
|
-
c_types << Default.new(:Extension => XML_EX, :ContentType => XML_CT)
|
345
|
-
c_types << Override.new(:PartName => "/#{APP_PN}", :ContentType => APP_CT)
|
346
|
-
c_types << Override.new(:PartName => "/#{CORE_PN}", :ContentType => CORE_CT)
|
347
|
-
c_types << Override.new(:PartName => "/xl/#{STYLES_PN}", :ContentType => STYLES_CT)
|
348
|
-
c_types << Axlsx::Override.new(:PartName => "/#{WORKBOOK_PN}", :ContentType => WORKBOOK_CT)
|
349
|
-
c_types.lock
|
350
|
-
c_types
|
351
|
-
end
|
352
|
-
|
353
|
-
# Creates the relationships required for a valid xlsx document
|
354
|
-
# @return [Relationships]
|
355
|
-
# @private
|
356
|
-
def relationships
|
357
|
-
rels = Axlsx::Relationships.new
|
358
|
-
rels << Relationship.new(self, WORKBOOK_R, WORKBOOK_PN)
|
359
|
-
rels << Relationship.new(self, CORE_R, CORE_PN)
|
360
|
-
rels << Relationship.new(self, APP_R, APP_PN)
|
361
|
-
rels.lock
|
362
|
-
rels
|
363
|
-
end
|
364
|
-
|
365
|
-
# Parse the arguments of `#serialize`
|
366
|
-
# @return [Boolean, (String or nil)] Returns an array where the first value is
|
367
|
-
# `confirm_valid` and the second is the `zip_command`.
|
368
|
-
# @private
|
369
|
-
def parse_serialize_options(options, secondary_options)
|
370
|
-
if secondary_options
|
371
|
-
warn "[DEPRECATION] Axlsx::Package#serialize with 3 arguments is deprecated. " +
|
372
|
-
"Use keyword args instead e.g., package.serialize(output, confirm_valid: false, zip_command: 'zip')"
|
373
|
-
end
|
374
|
-
if options.is_a?(Hash)
|
375
|
-
options.merge!(secondary_options || {})
|
376
|
-
invalid_keys = options.keys - [:confirm_valid, :zip_command]
|
377
|
-
if invalid_keys.any?
|
378
|
-
raise ArgumentError.new("Invalid keyword arguments: #{invalid_keys}")
|
379
|
-
end
|
380
|
-
[options.fetch(:confirm_valid, false), options.fetch(:zip_command, nil)]
|
381
|
-
else
|
382
|
-
warn "[DEPRECATION] Axlsx::Package#serialize with confirm_valid as a boolean is deprecated. " +
|
383
|
-
"Use keyword args instead e.g., package.serialize(output, confirm_valid: false)"
|
384
|
-
parse_serialize_options((secondary_options || {}).merge(confirm_valid: options), nil)
|
385
|
-
end
|
386
|
-
end
|
387
|
-
end
|
388
|
-
end
|
1
|
+
# encoding: utf-8
|
2
|
+
module Axlsx
|
3
|
+
# Package is responsible for managing all the bits and peices that Open Office XML requires to make a valid
|
4
|
+
# xlsx document including validation and serialization.
|
5
|
+
class Package
|
6
|
+
include Axlsx::OptionsParser
|
7
|
+
|
8
|
+
# provides access to the app doc properties for this package
|
9
|
+
# see App
|
10
|
+
attr_reader :app
|
11
|
+
|
12
|
+
# provides access to the core doc properties for the package
|
13
|
+
# see Core
|
14
|
+
attr_reader :core
|
15
|
+
|
16
|
+
# Initializes your package
|
17
|
+
#
|
18
|
+
# @param [Hash] options A hash that you can use to specify the author and workbook for this package.
|
19
|
+
# @option options [String] :author The author of the document
|
20
|
+
# @option options [Time] :created_at Timestamp in the document properties (defaults to current time).
|
21
|
+
# @option options [Boolean] :use_shared_strings This is passed to the workbook to specify that shared strings should be used when serializing the package.
|
22
|
+
# @example Package.new :author => 'you!', :workbook => Workbook.new
|
23
|
+
def initialize(options={})
|
24
|
+
@workbook = nil
|
25
|
+
@core, @app = Core.new, App.new
|
26
|
+
@core.creator = options[:author] || @core.creator
|
27
|
+
@core.created = options[:created_at]
|
28
|
+
parse_options options
|
29
|
+
yield self if block_given?
|
30
|
+
end
|
31
|
+
|
32
|
+
# Shortcut to specify that the workbook should use autowidth
|
33
|
+
# @see Workbook#use_autowidth
|
34
|
+
def use_autowidth=(v)
|
35
|
+
Axlsx::validate_boolean(v);
|
36
|
+
workbook.use_autowidth = v
|
37
|
+
end
|
38
|
+
|
39
|
+
|
40
|
+
|
41
|
+
# Shortcut to determine if the workbook is configured to use shared strings
|
42
|
+
# @see Workbook#use_shared_strings
|
43
|
+
def use_shared_strings
|
44
|
+
workbook.use_shared_strings
|
45
|
+
end
|
46
|
+
|
47
|
+
# Shortcut to specify that the workbook should use shared strings
|
48
|
+
# @see Workbook#use_shared_strings
|
49
|
+
def use_shared_strings=(v)
|
50
|
+
Axlsx::validate_boolean(v);
|
51
|
+
workbook.use_shared_strings = v
|
52
|
+
end
|
53
|
+
# The workbook this package will serialize or validate.
|
54
|
+
# @return [Workbook] If no workbook instance has been assigned with this package a new Workbook instance is returned.
|
55
|
+
# @raise ArgumentError if workbook parameter is not a Workbook instance.
|
56
|
+
# @note As there are multiple ways to instantiate a workbook for the package,
|
57
|
+
# here are a few examples:
|
58
|
+
# # assign directly during package instanciation
|
59
|
+
# wb = Package.new(:workbook => Workbook.new).workbook
|
60
|
+
#
|
61
|
+
# # get a fresh workbook automatically from the package
|
62
|
+
# wb = Pacakge.new().workbook
|
63
|
+
# # # set the workbook after creating the package
|
64
|
+
# wb = Package.new().workbook = Workbook.new
|
65
|
+
def workbook
|
66
|
+
@workbook || @workbook = Workbook.new
|
67
|
+
yield @workbook if block_given?
|
68
|
+
@workbook
|
69
|
+
end
|
70
|
+
|
71
|
+
# @see workbook
|
72
|
+
def workbook=(workbook) DataTypeValidator.validate :Package_workbook, Workbook, workbook; @workbook = workbook; end
|
73
|
+
|
74
|
+
# Serialize your workbook to disk as an xlsx document.
|
75
|
+
#
|
76
|
+
# @param [String] output The name of the file you want to serialize your package to
|
77
|
+
# @param [Hash] options
|
78
|
+
# @option options [Boolean] :confirm_valid Validate the package prior to serialization.
|
79
|
+
# @option options [String] :zip_command When `nil`, `#serialize` with RubyZip to
|
80
|
+
# zip the XLSX file contents. When a String, the provided zip command (e.g.,
|
81
|
+
# "zip") is used to zip the file contents (may be faster for large files)
|
82
|
+
# @return [Boolean] False if confirm_valid and validation errors exist. True if the package was serialized
|
83
|
+
# @note A tremendous amount of effort has gone into ensuring that you cannot create invalid xlsx documents.
|
84
|
+
# options[:confirm_valid] should be used in the rare case that you cannot open the serialized file.
|
85
|
+
# @see Package#validate
|
86
|
+
# @example
|
87
|
+
# # 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.
|
88
|
+
# # Take a look at the README for an example of how to do it!
|
89
|
+
#
|
90
|
+
# #serialize to a file
|
91
|
+
# p = Axlsx::Package.new
|
92
|
+
# # ......add cool stuff to your workbook......
|
93
|
+
# p.serialize("example.xlsx")
|
94
|
+
#
|
95
|
+
# # Serialize to a file, using a system zip binary
|
96
|
+
# p.serialize("example.xlsx", zip_command: "zip", confirm_valid: false)
|
97
|
+
# p.serialize("example.xlsx", zip_command: "/path/to/zip")
|
98
|
+
# p.serialize("example.xlsx", zip_command: "zip -1")
|
99
|
+
#
|
100
|
+
# # Serialize to a stream
|
101
|
+
# s = p.to_stream()
|
102
|
+
# File.open('example_streamed.xlsx', 'w') { |f| f.write(s.read) }
|
103
|
+
def serialize(output, options = {}, secondary_options = nil)
|
104
|
+
confirm_valid, zip_command = parse_serialize_options(options, secondary_options)
|
105
|
+
return false unless !confirm_valid || self.validate.empty?
|
106
|
+
zip_provider = if zip_command
|
107
|
+
ZipCommand.new(zip_command)
|
108
|
+
else
|
109
|
+
Zip::OutputStream
|
110
|
+
end
|
111
|
+
Relationship.initialize_ids_cache
|
112
|
+
zip_provider.open(output) do |zip|
|
113
|
+
write_parts(zip)
|
114
|
+
end
|
115
|
+
true
|
116
|
+
ensure
|
117
|
+
Relationship.clear_ids_cache
|
118
|
+
end
|
119
|
+
|
120
|
+
|
121
|
+
# Serialize your workbook to a StringIO instance
|
122
|
+
# @param [Boolean] confirm_valid Validate the package prior to serialization.
|
123
|
+
# @return [StringIO|Boolean] False if confirm_valid and validation errors exist. rewound string IO if not.
|
124
|
+
def to_stream(confirm_valid=false)
|
125
|
+
return false unless !confirm_valid || self.validate.empty?
|
126
|
+
Relationship.initialize_ids_cache
|
127
|
+
zip = write_parts(Zip::OutputStream.new(StringIO.new.binmode, true))
|
128
|
+
stream = zip.close_buffer
|
129
|
+
stream.rewind
|
130
|
+
stream
|
131
|
+
ensure
|
132
|
+
Relationship.clear_ids_cache
|
133
|
+
end
|
134
|
+
|
135
|
+
# Encrypt the package into a CFB using the password provided
|
136
|
+
# This is not ready yet
|
137
|
+
def encrypt(file_name, password)
|
138
|
+
return false
|
139
|
+
# moc = MsOffCrypto.new(file_name, password)
|
140
|
+
# moc.save
|
141
|
+
end
|
142
|
+
|
143
|
+
# Validate all parts of the package against xsd schema.
|
144
|
+
# @return [Array] An array of all validation errors found.
|
145
|
+
# @note This gem includes all schema from OfficeOpenXML-XMLSchema-Transitional.zip and OpenPackagingConventions-XMLSchema.zip
|
146
|
+
# as per ECMA-376, Third edition. opc schema require an internet connection to import remote schema from dublin core for dc,
|
147
|
+
# dcterms and xml namespaces. Those remote schema are included in this gem, and the original files have been altered to
|
148
|
+
# refer to the local versions.
|
149
|
+
#
|
150
|
+
# If by chance you are able to create a package that does not validate it indicates that the internal
|
151
|
+
# validation is not robust enough and needs to be improved. Please report your errors to the gem author.
|
152
|
+
# @see http://www.ecma-international.org/publications/standards/Ecma-376.htm
|
153
|
+
# @example
|
154
|
+
# # The following will output any error messages found in serialization.
|
155
|
+
# p = Axlsx::Package.new
|
156
|
+
# # ... code to create sheets, charts, styles etc.
|
157
|
+
# p.validate.each { |error| puts error.message }
|
158
|
+
def validate
|
159
|
+
errors = []
|
160
|
+
parts.each do |part|
|
161
|
+
unless part[:schema].nil?
|
162
|
+
errors.concat validate_single_doc(part[:schema], part[:doc].to_xml_string)
|
163
|
+
end
|
164
|
+
end
|
165
|
+
errors
|
166
|
+
end
|
167
|
+
|
168
|
+
private
|
169
|
+
|
170
|
+
# Writes the package parts to a zip archive.
|
171
|
+
# @param [Zip::OutputStream, ZipCommand] zip
|
172
|
+
# @return [Zip::OutputStream, ZipCommand]
|
173
|
+
def write_parts(zip)
|
174
|
+
p = parts
|
175
|
+
p.each do |part|
|
176
|
+
unless part[:doc].nil?
|
177
|
+
zip.put_next_entry(zip_entry_for_part(part))
|
178
|
+
part[:doc].to_xml_string(zip)
|
179
|
+
end
|
180
|
+
unless part[:path].nil?
|
181
|
+
zip.put_next_entry(zip_entry_for_part(part))
|
182
|
+
zip.write IO.read(part[:path], mode: "rb")
|
183
|
+
end
|
184
|
+
end
|
185
|
+
zip
|
186
|
+
end
|
187
|
+
|
188
|
+
# Generate a Entry for the given package part.
|
189
|
+
# The important part here is to explicitly set the timestamp for the zip entry: Serializing axlsx packages
|
190
|
+
# with identical contents should result in identical zip files – however, the timestamp of a zip entry
|
191
|
+
# defaults to the time of serialization and therefore the zip file contents would be different every time
|
192
|
+
# the package is serialized.
|
193
|
+
#
|
194
|
+
# Note: {Core#created} also defaults to the current time – so to generate identical axlsx packages you have
|
195
|
+
# to set this explicitly, too (eg. with `Package.new(created_at: Time.local(2013, 1, 1))`).
|
196
|
+
#
|
197
|
+
# @param part A hash describing a part of this pacakge (see {#parts})
|
198
|
+
# @return [Zip::Entry]
|
199
|
+
def zip_entry_for_part(part)
|
200
|
+
timestamp = Zip::DOSTime.at(@core.created.to_i)
|
201
|
+
Zip::Entry.new("", part[:entry], "", "", 0, 0, Zip::Entry::DEFLATED, 0, timestamp)
|
202
|
+
end
|
203
|
+
|
204
|
+
# The parts of a package
|
205
|
+
# @return [Array] An array of hashes that define the entry, document and schema for each part of the package.
|
206
|
+
# @private
|
207
|
+
def parts
|
208
|
+
parts = [
|
209
|
+
{:entry => RELS_PN, :doc => relationships, :schema => RELS_XSD},
|
210
|
+
{:entry => "xl/#{STYLES_PN}", :doc => workbook.styles, :schema => SML_XSD},
|
211
|
+
{:entry => CORE_PN, :doc => @core, :schema => CORE_XSD},
|
212
|
+
{:entry => APP_PN, :doc => @app, :schema => APP_XSD},
|
213
|
+
{:entry => WORKBOOK_RELS_PN, :doc => workbook.relationships, :schema => RELS_XSD},
|
214
|
+
{:entry => CONTENT_TYPES_PN, :doc => content_types, :schema => CONTENT_TYPES_XSD},
|
215
|
+
{:entry => WORKBOOK_PN, :doc => workbook, :schema => SML_XSD}
|
216
|
+
]
|
217
|
+
|
218
|
+
workbook.drawings.each do |drawing|
|
219
|
+
parts << {:entry => "xl/#{drawing.rels_pn}", :doc => drawing.relationships, :schema => RELS_XSD}
|
220
|
+
parts << {:entry => "xl/#{drawing.pn}", :doc => drawing, :schema => DRAWING_XSD}
|
221
|
+
end
|
222
|
+
|
223
|
+
|
224
|
+
workbook.tables.each do |table|
|
225
|
+
parts << {:entry => "xl/#{table.pn}", :doc => table, :schema => SML_XSD}
|
226
|
+
end
|
227
|
+
workbook.pivot_tables.each do |pivot_table|
|
228
|
+
cache_definition = pivot_table.cache_definition
|
229
|
+
parts << {:entry => "xl/#{pivot_table.rels_pn}", :doc => pivot_table.relationships, :schema => RELS_XSD}
|
230
|
+
parts << {:entry => "xl/#{pivot_table.pn}", :doc => pivot_table} #, :schema => SML_XSD}
|
231
|
+
parts << {:entry => "xl/#{cache_definition.pn}", :doc => cache_definition} #, :schema => SML_XSD}
|
232
|
+
end
|
233
|
+
|
234
|
+
workbook.comments.each do|comment|
|
235
|
+
if comment.size > 0
|
236
|
+
parts << { :entry => "xl/#{comment.pn}", :doc => comment, :schema => SML_XSD }
|
237
|
+
parts << { :entry => "xl/#{comment.vml_drawing.pn}", :doc => comment.vml_drawing, :schema => nil }
|
238
|
+
end
|
239
|
+
end
|
240
|
+
|
241
|
+
workbook.charts.each do |chart|
|
242
|
+
parts << {:entry => "xl/#{chart.pn}", :doc => chart, :schema => DRAWING_XSD}
|
243
|
+
end
|
244
|
+
|
245
|
+
workbook.images.each do |image|
|
246
|
+
parts << {:entry => "xl/#{image.pn}", :path => image.image_src}
|
247
|
+
end
|
248
|
+
|
249
|
+
if use_shared_strings
|
250
|
+
parts << {:entry => "xl/#{SHARED_STRINGS_PN}", :doc => workbook.shared_strings, :schema => SML_XSD}
|
251
|
+
end
|
252
|
+
|
253
|
+
workbook.worksheets.each do |sheet|
|
254
|
+
parts << {:entry => "xl/#{sheet.rels_pn}", :doc => sheet.relationships, :schema => RELS_XSD}
|
255
|
+
parts << {:entry => "xl/#{sheet.pn}", :doc => sheet, :schema => SML_XSD}
|
256
|
+
end
|
257
|
+
|
258
|
+
# Sort parts for correct MIME detection
|
259
|
+
parts.sort_by { |part| part[:entry] }
|
260
|
+
end
|
261
|
+
|
262
|
+
# Performs xsd validation for a signle document
|
263
|
+
#
|
264
|
+
# @param [String] schema path to the xsd schema to be used in validation.
|
265
|
+
# @param [String] doc The xml text to be validated
|
266
|
+
# @return [Array] An array of all validation errors encountered.
|
267
|
+
# @private
|
268
|
+
def validate_single_doc(schema, doc)
|
269
|
+
schema = Nokogiri::XML::Schema(File.open(schema))
|
270
|
+
doc = Nokogiri::XML(doc)
|
271
|
+
errors = []
|
272
|
+
schema.validate(doc).each do |error|
|
273
|
+
errors << error
|
274
|
+
end
|
275
|
+
errors
|
276
|
+
end
|
277
|
+
|
278
|
+
# Appends override objects for drawings, charts, and sheets as they exist in your workbook to the default content types.
|
279
|
+
# @return [ContentType]
|
280
|
+
# @private
|
281
|
+
def content_types
|
282
|
+
c_types = base_content_types
|
283
|
+
workbook.drawings.each do |drawing|
|
284
|
+
c_types << Axlsx::Override.new(:PartName => "/xl/#{drawing.pn}",
|
285
|
+
:ContentType => DRAWING_CT)
|
286
|
+
end
|
287
|
+
|
288
|
+
workbook.charts.each do |chart|
|
289
|
+
c_types << Axlsx::Override.new(:PartName => "/xl/#{chart.pn}",
|
290
|
+
:ContentType => CHART_CT)
|
291
|
+
end
|
292
|
+
|
293
|
+
workbook.tables.each do |table|
|
294
|
+
c_types << Axlsx::Override.new(:PartName => "/xl/#{table.pn}",
|
295
|
+
:ContentType => TABLE_CT)
|
296
|
+
end
|
297
|
+
|
298
|
+
workbook.pivot_tables.each do |pivot_table|
|
299
|
+
c_types << Axlsx::Override.new(:PartName => "/xl/#{pivot_table.pn}",
|
300
|
+
:ContentType => PIVOT_TABLE_CT)
|
301
|
+
c_types << Axlsx::Override.new(:PartName => "/xl/#{pivot_table.cache_definition.pn}",
|
302
|
+
:ContentType => PIVOT_TABLE_CACHE_DEFINITION_CT)
|
303
|
+
end
|
304
|
+
|
305
|
+
workbook.comments.each do |comment|
|
306
|
+
if comment.size > 0
|
307
|
+
c_types << Axlsx::Override.new(:PartName => "/xl/#{comment.pn}",
|
308
|
+
:ContentType => COMMENT_CT)
|
309
|
+
end
|
310
|
+
end
|
311
|
+
|
312
|
+
if workbook.comments.size > 0
|
313
|
+
c_types << Axlsx::Default.new(:Extension => "vml", :ContentType => VML_DRAWING_CT)
|
314
|
+
end
|
315
|
+
|
316
|
+
workbook.worksheets.each do |sheet|
|
317
|
+
c_types << Axlsx::Override.new(:PartName => "/xl/#{sheet.pn}",
|
318
|
+
:ContentType => WORKSHEET_CT)
|
319
|
+
end
|
320
|
+
exts = workbook.images.map { |image| image.extname.downcase }
|
321
|
+
exts.uniq.each do |ext|
|
322
|
+
ct = if ['jpeg', 'jpg'].include?(ext)
|
323
|
+
JPEG_CT
|
324
|
+
elsif ext == 'gif'
|
325
|
+
GIF_CT
|
326
|
+
elsif ext == 'png'
|
327
|
+
PNG_CT
|
328
|
+
end
|
329
|
+
c_types << Axlsx::Default.new(:ContentType => ct, :Extension => ext )
|
330
|
+
end
|
331
|
+
if use_shared_strings
|
332
|
+
c_types << Axlsx::Override.new(:PartName => "/xl/#{SHARED_STRINGS_PN}",
|
333
|
+
:ContentType => SHARED_STRINGS_CT)
|
334
|
+
end
|
335
|
+
c_types
|
336
|
+
end
|
337
|
+
|
338
|
+
# Creates the minimum content types for generating a valid xlsx document.
|
339
|
+
# @return [ContentType]
|
340
|
+
# @private
|
341
|
+
def base_content_types
|
342
|
+
c_types = ContentType.new()
|
343
|
+
c_types << Default.new(:ContentType => RELS_CT, :Extension => RELS_EX)
|
344
|
+
c_types << Default.new(:Extension => XML_EX, :ContentType => XML_CT)
|
345
|
+
c_types << Override.new(:PartName => "/#{APP_PN}", :ContentType => APP_CT)
|
346
|
+
c_types << Override.new(:PartName => "/#{CORE_PN}", :ContentType => CORE_CT)
|
347
|
+
c_types << Override.new(:PartName => "/xl/#{STYLES_PN}", :ContentType => STYLES_CT)
|
348
|
+
c_types << Axlsx::Override.new(:PartName => "/#{WORKBOOK_PN}", :ContentType => WORKBOOK_CT)
|
349
|
+
c_types.lock
|
350
|
+
c_types
|
351
|
+
end
|
352
|
+
|
353
|
+
# Creates the relationships required for a valid xlsx document
|
354
|
+
# @return [Relationships]
|
355
|
+
# @private
|
356
|
+
def relationships
|
357
|
+
rels = Axlsx::Relationships.new
|
358
|
+
rels << Relationship.new(self, WORKBOOK_R, WORKBOOK_PN)
|
359
|
+
rels << Relationship.new(self, CORE_R, CORE_PN)
|
360
|
+
rels << Relationship.new(self, APP_R, APP_PN)
|
361
|
+
rels.lock
|
362
|
+
rels
|
363
|
+
end
|
364
|
+
|
365
|
+
# Parse the arguments of `#serialize`
|
366
|
+
# @return [Boolean, (String or nil)] Returns an array where the first value is
|
367
|
+
# `confirm_valid` and the second is the `zip_command`.
|
368
|
+
# @private
|
369
|
+
def parse_serialize_options(options, secondary_options)
|
370
|
+
if secondary_options
|
371
|
+
warn "[DEPRECATION] Axlsx::Package#serialize with 3 arguments is deprecated. " +
|
372
|
+
"Use keyword args instead e.g., package.serialize(output, confirm_valid: false, zip_command: 'zip')"
|
373
|
+
end
|
374
|
+
if options.is_a?(Hash)
|
375
|
+
options.merge!(secondary_options || {})
|
376
|
+
invalid_keys = options.keys - [:confirm_valid, :zip_command]
|
377
|
+
if invalid_keys.any?
|
378
|
+
raise ArgumentError.new("Invalid keyword arguments: #{invalid_keys}")
|
379
|
+
end
|
380
|
+
[options.fetch(:confirm_valid, false), options.fetch(:zip_command, nil)]
|
381
|
+
else
|
382
|
+
warn "[DEPRECATION] Axlsx::Package#serialize with confirm_valid as a boolean is deprecated. " +
|
383
|
+
"Use keyword args instead e.g., package.serialize(output, confirm_valid: false)"
|
384
|
+
parse_serialize_options((secondary_options || {}).merge(confirm_valid: options), nil)
|
385
|
+
end
|
386
|
+
end
|
387
|
+
end
|
388
|
+
end
|