dg-axlsx 2.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (324) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +9 -0
  3. data/.yardopts_guide +19 -0
  4. data/CHANGELOG.md +239 -0
  5. data/LICENSE +22 -0
  6. data/README.md +259 -0
  7. data/Rakefile +30 -0
  8. data/examples/2010_comments.rb +17 -0
  9. data/examples/anchor_swapping.rb +28 -0
  10. data/examples/auto_filter.rb +25 -0
  11. data/examples/basic_charts.rb +58 -0
  12. data/examples/chart_colors.rb +88 -0
  13. data/examples/colored_links.rb +59 -0
  14. data/examples/conditional_formatting/example_conditional_formatting.rb +89 -0
  15. data/examples/conditional_formatting/getting_barred.rb +37 -0
  16. data/examples/conditional_formatting/hitting_the_high_notes.rb +37 -0
  17. data/examples/conditional_formatting/scaled_colors.rb +39 -0
  18. data/examples/conditional_formatting/stop_and_go.rb +37 -0
  19. data/examples/data_validation.rb +50 -0
  20. data/examples/example.rb +875 -0
  21. data/examples/extractive.rb +45 -0
  22. data/examples/image1.jpeg +0 -0
  23. data/examples/ios_preview.rb +14 -0
  24. data/examples/merge_cells.rb +17 -0
  25. data/examples/no_grid_with_borders.rb +18 -0
  26. data/examples/page_setup.rb +11 -0
  27. data/examples/pivot_table.rb +39 -0
  28. data/examples/pivot_test.rb +63 -0
  29. data/examples/sheet_protection.rb +10 -0
  30. data/examples/skydrive/real_example.rb +63 -0
  31. data/examples/split.rb +16 -0
  32. data/examples/styles.rb +66 -0
  33. data/examples/underline.rb +13 -0
  34. data/examples/wrap_text.rb +21 -0
  35. data/lib/axlsx.rb +168 -0
  36. data/lib/axlsx/content_type/abstract_content_type.rb +32 -0
  37. data/lib/axlsx/content_type/content_type.rb +26 -0
  38. data/lib/axlsx/content_type/default.rb +25 -0
  39. data/lib/axlsx/content_type/override.rb +25 -0
  40. data/lib/axlsx/doc_props/app.rb +235 -0
  41. data/lib/axlsx/doc_props/core.rb +39 -0
  42. data/lib/axlsx/drawing/ax_data_source.rb +26 -0
  43. data/lib/axlsx/drawing/axes.rb +61 -0
  44. data/lib/axlsx/drawing/axis.rb +190 -0
  45. data/lib/axlsx/drawing/bar_3D_chart.rb +151 -0
  46. data/lib/axlsx/drawing/bar_series.rb +82 -0
  47. data/lib/axlsx/drawing/bubble_chart.rb +59 -0
  48. data/lib/axlsx/drawing/bubble_series.rb +63 -0
  49. data/lib/axlsx/drawing/cat_axis.rb +85 -0
  50. data/lib/axlsx/drawing/chart.rb +269 -0
  51. data/lib/axlsx/drawing/d_lbls.rb +90 -0
  52. data/lib/axlsx/drawing/drawing.rb +164 -0
  53. data/lib/axlsx/drawing/graphic_frame.rb +54 -0
  54. data/lib/axlsx/drawing/hyperlink.rb +100 -0
  55. data/lib/axlsx/drawing/line_3D_chart.rb +68 -0
  56. data/lib/axlsx/drawing/line_chart.rb +99 -0
  57. data/lib/axlsx/drawing/line_series.rb +110 -0
  58. data/lib/axlsx/drawing/marker.rb +84 -0
  59. data/lib/axlsx/drawing/num_data.rb +52 -0
  60. data/lib/axlsx/drawing/num_data_source.rb +62 -0
  61. data/lib/axlsx/drawing/num_val.rb +32 -0
  62. data/lib/axlsx/drawing/one_cell_anchor.rb +98 -0
  63. data/lib/axlsx/drawing/pic.rb +213 -0
  64. data/lib/axlsx/drawing/picture_locking.rb +42 -0
  65. data/lib/axlsx/drawing/pie_3D_chart.rb +47 -0
  66. data/lib/axlsx/drawing/pie_series.rb +74 -0
  67. data/lib/axlsx/drawing/scaling.rb +60 -0
  68. data/lib/axlsx/drawing/scatter_chart.rb +74 -0
  69. data/lib/axlsx/drawing/scatter_series.rb +84 -0
  70. data/lib/axlsx/drawing/ser_axis.rb +45 -0
  71. data/lib/axlsx/drawing/series.rb +69 -0
  72. data/lib/axlsx/drawing/series_title.rb +23 -0
  73. data/lib/axlsx/drawing/str_data.rb +42 -0
  74. data/lib/axlsx/drawing/str_val.rb +32 -0
  75. data/lib/axlsx/drawing/title.rb +78 -0
  76. data/lib/axlsx/drawing/two_cell_anchor.rb +92 -0
  77. data/lib/axlsx/drawing/val_axis.rb +37 -0
  78. data/lib/axlsx/drawing/view_3D.rb +115 -0
  79. data/lib/axlsx/drawing/vml_drawing.rb +42 -0
  80. data/lib/axlsx/drawing/vml_shape.rb +66 -0
  81. data/lib/axlsx/package.rb +363 -0
  82. data/lib/axlsx/rels/relationship.rb +129 -0
  83. data/lib/axlsx/rels/relationships.rb +29 -0
  84. data/lib/axlsx/stylesheet/border.rb +71 -0
  85. data/lib/axlsx/stylesheet/border_pr.rb +71 -0
  86. data/lib/axlsx/stylesheet/cell_alignment.rb +132 -0
  87. data/lib/axlsx/stylesheet/cell_protection.rb +41 -0
  88. data/lib/axlsx/stylesheet/cell_style.rb +72 -0
  89. data/lib/axlsx/stylesheet/color.rb +76 -0
  90. data/lib/axlsx/stylesheet/dxf.rb +79 -0
  91. data/lib/axlsx/stylesheet/fill.rb +35 -0
  92. data/lib/axlsx/stylesheet/font.rb +148 -0
  93. data/lib/axlsx/stylesheet/gradient_fill.rb +103 -0
  94. data/lib/axlsx/stylesheet/gradient_stop.rb +37 -0
  95. data/lib/axlsx/stylesheet/num_fmt.rb +77 -0
  96. data/lib/axlsx/stylesheet/pattern_fill.rb +73 -0
  97. data/lib/axlsx/stylesheet/styles.rb +420 -0
  98. data/lib/axlsx/stylesheet/table_style.rb +54 -0
  99. data/lib/axlsx/stylesheet/table_style_element.rb +77 -0
  100. data/lib/axlsx/stylesheet/table_styles.rb +46 -0
  101. data/lib/axlsx/stylesheet/xf.rb +147 -0
  102. data/lib/axlsx/util/accessors.rb +64 -0
  103. data/lib/axlsx/util/constants.rb +397 -0
  104. data/lib/axlsx/util/mime_type_utils.rb +11 -0
  105. data/lib/axlsx/util/options_parser.rb +16 -0
  106. data/lib/axlsx/util/parser.rb +44 -0
  107. data/lib/axlsx/util/serialized_attributes.rb +89 -0
  108. data/lib/axlsx/util/simple_typed_list.rb +179 -0
  109. data/lib/axlsx/util/storage.rb +146 -0
  110. data/lib/axlsx/util/string.rb +7 -0
  111. data/lib/axlsx/util/validators.rb +311 -0
  112. data/lib/axlsx/version.rb +5 -0
  113. data/lib/axlsx/workbook/defined_name.rb +128 -0
  114. data/lib/axlsx/workbook/defined_names.rb +21 -0
  115. data/lib/axlsx/workbook/shared_strings_table.rb +77 -0
  116. data/lib/axlsx/workbook/workbook.rb +361 -0
  117. data/lib/axlsx/workbook/workbook_view.rb +78 -0
  118. data/lib/axlsx/workbook/workbook_views.rb +22 -0
  119. data/lib/axlsx/workbook/worksheet/auto_filter/auto_filter.rb +77 -0
  120. data/lib/axlsx/workbook/worksheet/auto_filter/filter_column.rb +94 -0
  121. data/lib/axlsx/workbook/worksheet/auto_filter/filters.rb +244 -0
  122. data/lib/axlsx/workbook/worksheet/break.rb +35 -0
  123. data/lib/axlsx/workbook/worksheet/cell.rb +475 -0
  124. data/lib/axlsx/workbook/worksheet/cell_serializer.rb +154 -0
  125. data/lib/axlsx/workbook/worksheet/cfvo.rb +60 -0
  126. data/lib/axlsx/workbook/worksheet/cfvos.rb +15 -0
  127. data/lib/axlsx/workbook/worksheet/col.rb +141 -0
  128. data/lib/axlsx/workbook/worksheet/col_breaks.rb +35 -0
  129. data/lib/axlsx/workbook/worksheet/color_scale.rb +110 -0
  130. data/lib/axlsx/workbook/worksheet/cols.rb +20 -0
  131. data/lib/axlsx/workbook/worksheet/comment.rb +91 -0
  132. data/lib/axlsx/workbook/worksheet/comments.rb +82 -0
  133. data/lib/axlsx/workbook/worksheet/conditional_formatting.rb +82 -0
  134. data/lib/axlsx/workbook/worksheet/conditional_formatting_rule.rb +220 -0
  135. data/lib/axlsx/workbook/worksheet/conditional_formattings.rb +25 -0
  136. data/lib/axlsx/workbook/worksheet/data_bar.rb +129 -0
  137. data/lib/axlsx/workbook/worksheet/data_validation.rb +246 -0
  138. data/lib/axlsx/workbook/worksheet/data_validations.rb +28 -0
  139. data/lib/axlsx/workbook/worksheet/date_time_converter.rb +30 -0
  140. data/lib/axlsx/workbook/worksheet/dimension.rb +64 -0
  141. data/lib/axlsx/workbook/worksheet/header_footer.rb +52 -0
  142. data/lib/axlsx/workbook/worksheet/icon_set.rb +81 -0
  143. data/lib/axlsx/workbook/worksheet/merged_cells.rb +35 -0
  144. data/lib/axlsx/workbook/worksheet/page_margins.rb +97 -0
  145. data/lib/axlsx/workbook/worksheet/page_set_up_pr.rb +44 -0
  146. data/lib/axlsx/workbook/worksheet/page_setup.rb +240 -0
  147. data/lib/axlsx/workbook/worksheet/pane.rb +139 -0
  148. data/lib/axlsx/workbook/worksheet/pivot_table.rb +266 -0
  149. data/lib/axlsx/workbook/worksheet/pivot_table_cache_definition.rb +66 -0
  150. data/lib/axlsx/workbook/worksheet/pivot_tables.rb +24 -0
  151. data/lib/axlsx/workbook/worksheet/print_options.rb +39 -0
  152. data/lib/axlsx/workbook/worksheet/protected_range.rb +47 -0
  153. data/lib/axlsx/workbook/worksheet/protected_ranges.rb +34 -0
  154. data/lib/axlsx/workbook/worksheet/rich_text.rb +35 -0
  155. data/lib/axlsx/workbook/worksheet/rich_text_run.rb +254 -0
  156. data/lib/axlsx/workbook/worksheet/row.rb +154 -0
  157. data/lib/axlsx/workbook/worksheet/row_breaks.rb +33 -0
  158. data/lib/axlsx/workbook/worksheet/selection.rb +101 -0
  159. data/lib/axlsx/workbook/worksheet/sheet_calc_pr.rb +29 -0
  160. data/lib/axlsx/workbook/worksheet/sheet_data.rb +27 -0
  161. data/lib/axlsx/workbook/worksheet/sheet_format_pr.rb +60 -0
  162. data/lib/axlsx/workbook/worksheet/sheet_pr.rb +79 -0
  163. data/lib/axlsx/workbook/worksheet/sheet_protection.rb +118 -0
  164. data/lib/axlsx/workbook/worksheet/sheet_view.rb +213 -0
  165. data/lib/axlsx/workbook/worksheet/table.rb +102 -0
  166. data/lib/axlsx/workbook/worksheet/table_style_info.rb +49 -0
  167. data/lib/axlsx/workbook/worksheet/tables.rb +31 -0
  168. data/lib/axlsx/workbook/worksheet/worksheet.rb +798 -0
  169. data/lib/axlsx/workbook/worksheet/worksheet_comments.rb +58 -0
  170. data/lib/axlsx/workbook/worksheet/worksheet_drawing.rb +58 -0
  171. data/lib/axlsx/workbook/worksheet/worksheet_hyperlink.rb +74 -0
  172. data/lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb +38 -0
  173. data/lib/dg-axlsx.rb +1 -0
  174. data/lib/schema/dc.xsd +118 -0
  175. data/lib/schema/dcmitype.xsd +52 -0
  176. data/lib/schema/dcterms.xsd +331 -0
  177. data/lib/schema/dml-chart.xsd +1499 -0
  178. data/lib/schema/dml-chartDrawing.xsd +146 -0
  179. data/lib/schema/dml-compatibility.xsd +14 -0
  180. data/lib/schema/dml-diagram.xsd +1091 -0
  181. data/lib/schema/dml-lockedCanvas.xsd +11 -0
  182. data/lib/schema/dml-main.xsd +3048 -0
  183. data/lib/schema/dml-picture.xsd +23 -0
  184. data/lib/schema/dml-spreadsheetDrawing.xsd +185 -0
  185. data/lib/schema/dml-wordprocessingDrawing.xsd +185 -0
  186. data/lib/schema/opc-contentTypes.xsd +42 -0
  187. data/lib/schema/opc-coreProperties.xsd +54 -0
  188. data/lib/schema/opc-digSig.xsd +49 -0
  189. data/lib/schema/opc-relationships.xsd +33 -0
  190. data/lib/schema/pml.xsd +1676 -0
  191. data/lib/schema/shared-additionalCharacteristics.xsd +28 -0
  192. data/lib/schema/shared-bibliography.xsd +144 -0
  193. data/lib/schema/shared-commonSimpleTypes.xsd +166 -0
  194. data/lib/schema/shared-customXmlDataProperties.xsd +25 -0
  195. data/lib/schema/shared-customXmlSchemaProperties.xsd +18 -0
  196. data/lib/schema/shared-documentPropertiesCustom.xsd +59 -0
  197. data/lib/schema/shared-documentPropertiesExtended.xsd +56 -0
  198. data/lib/schema/shared-documentPropertiesVariantTypes.xsd +195 -0
  199. data/lib/schema/shared-math.xsd +582 -0
  200. data/lib/schema/shared-relationshipReference.xsd +25 -0
  201. data/lib/schema/sml.xsd +4434 -0
  202. data/lib/schema/vml-main.xsd +569 -0
  203. data/lib/schema/vml-officeDrawing.xsd +509 -0
  204. data/lib/schema/vml-presentationDrawing.xsd +12 -0
  205. data/lib/schema/vml-spreadsheetDrawing.xsd +108 -0
  206. data/lib/schema/vml-wordprocessingDrawing.xsd +96 -0
  207. data/lib/schema/wml.xsd +3644 -0
  208. data/lib/schema/xml.xsd +116 -0
  209. data/test/benchmark.rb +72 -0
  210. data/test/content_type/tc_content_type.rb +76 -0
  211. data/test/content_type/tc_default.rb +16 -0
  212. data/test/content_type/tc_override.rb +14 -0
  213. data/test/doc_props/tc_app.rb +43 -0
  214. data/test/doc_props/tc_core.rb +42 -0
  215. data/test/drawing/tc_axes.rb +8 -0
  216. data/test/drawing/tc_axis.rb +112 -0
  217. data/test/drawing/tc_bar_3D_chart.rb +71 -0
  218. data/test/drawing/tc_bar_series.rb +37 -0
  219. data/test/drawing/tc_bubble_chart.rb +44 -0
  220. data/test/drawing/tc_bubble_series.rb +21 -0
  221. data/test/drawing/tc_cat_axis.rb +31 -0
  222. data/test/drawing/tc_cat_axis_data.rb +27 -0
  223. data/test/drawing/tc_chart.rb +110 -0
  224. data/test/drawing/tc_d_lbls.rb +57 -0
  225. data/test/drawing/tc_data_source.rb +23 -0
  226. data/test/drawing/tc_drawing.rb +80 -0
  227. data/test/drawing/tc_graphic_frame.rb +27 -0
  228. data/test/drawing/tc_hyperlink.rb +64 -0
  229. data/test/drawing/tc_line_3d_chart.rb +47 -0
  230. data/test/drawing/tc_line_chart.rb +39 -0
  231. data/test/drawing/tc_line_series.rb +71 -0
  232. data/test/drawing/tc_marker.rb +44 -0
  233. data/test/drawing/tc_named_axis_data.rb +27 -0
  234. data/test/drawing/tc_num_data.rb +31 -0
  235. data/test/drawing/tc_num_val.rb +29 -0
  236. data/test/drawing/tc_one_cell_anchor.rb +66 -0
  237. data/test/drawing/tc_pic.rb +106 -0
  238. data/test/drawing/tc_picture_locking.rb +72 -0
  239. data/test/drawing/tc_pie_3D_chart.rb +28 -0
  240. data/test/drawing/tc_pie_series.rb +32 -0
  241. data/test/drawing/tc_scaling.rb +36 -0
  242. data/test/drawing/tc_scatter_chart.rb +48 -0
  243. data/test/drawing/tc_scatter_series.rb +45 -0
  244. data/test/drawing/tc_ser_axis.rb +31 -0
  245. data/test/drawing/tc_series.rb +23 -0
  246. data/test/drawing/tc_series_title.rb +33 -0
  247. data/test/drawing/tc_str_data.rb +18 -0
  248. data/test/drawing/tc_str_val.rb +21 -0
  249. data/test/drawing/tc_title.rb +49 -0
  250. data/test/drawing/tc_two_cell_anchor.rb +36 -0
  251. data/test/drawing/tc_val_axis.rb +24 -0
  252. data/test/drawing/tc_view_3D.rb +54 -0
  253. data/test/drawing/tc_vml_drawing.rb +25 -0
  254. data/test/drawing/tc_vml_shape.rb +106 -0
  255. data/test/profile.rb +24 -0
  256. data/test/rels/tc_relationship.rb +44 -0
  257. data/test/rels/tc_relationships.rb +37 -0
  258. data/test/stylesheet/tc_border.rb +37 -0
  259. data/test/stylesheet/tc_border_pr.rb +32 -0
  260. data/test/stylesheet/tc_cell_alignment.rb +81 -0
  261. data/test/stylesheet/tc_cell_protection.rb +29 -0
  262. data/test/stylesheet/tc_cell_style.rb +57 -0
  263. data/test/stylesheet/tc_color.rb +43 -0
  264. data/test/stylesheet/tc_dxf.rb +81 -0
  265. data/test/stylesheet/tc_fill.rb +18 -0
  266. data/test/stylesheet/tc_font.rb +121 -0
  267. data/test/stylesheet/tc_gradient_fill.rb +72 -0
  268. data/test/stylesheet/tc_gradient_stop.rb +31 -0
  269. data/test/stylesheet/tc_num_fmt.rb +30 -0
  270. data/test/stylesheet/tc_pattern_fill.rb +43 -0
  271. data/test/stylesheet/tc_styles.rb +235 -0
  272. data/test/stylesheet/tc_table_style.rb +44 -0
  273. data/test/stylesheet/tc_table_style_element.rb +45 -0
  274. data/test/stylesheet/tc_table_styles.rb +29 -0
  275. data/test/stylesheet/tc_xf.rb +120 -0
  276. data/test/tc_axlsx.rb +72 -0
  277. data/test/tc_helper.rb +10 -0
  278. data/test/tc_package.rb +233 -0
  279. data/test/util/tc_mime_type_utils.rb +13 -0
  280. data/test/util/tc_serialized_attributes.rb +19 -0
  281. data/test/util/tc_simple_typed_list.rb +77 -0
  282. data/test/util/tc_validators.rb +210 -0
  283. data/test/workbook/tc_defined_name.rb +49 -0
  284. data/test/workbook/tc_shared_strings_table.rb +58 -0
  285. data/test/workbook/tc_workbook.rb +139 -0
  286. data/test/workbook/tc_workbook_view.rb +50 -0
  287. data/test/workbook/worksheet/auto_filter/tc_auto_filter.rb +38 -0
  288. data/test/workbook/worksheet/auto_filter/tc_filter_column.rb +76 -0
  289. data/test/workbook/worksheet/auto_filter/tc_filters.rb +50 -0
  290. data/test/workbook/worksheet/tc_break.rb +49 -0
  291. data/test/workbook/worksheet/tc_cell.rb +358 -0
  292. data/test/workbook/worksheet/tc_cfvo.rb +31 -0
  293. data/test/workbook/worksheet/tc_col.rb +78 -0
  294. data/test/workbook/worksheet/tc_color_scale.rb +58 -0
  295. data/test/workbook/worksheet/tc_comment.rb +72 -0
  296. data/test/workbook/worksheet/tc_comments.rb +57 -0
  297. data/test/workbook/worksheet/tc_conditional_formatting.rb +224 -0
  298. data/test/workbook/worksheet/tc_data_bar.rb +46 -0
  299. data/test/workbook/worksheet/tc_data_validation.rb +265 -0
  300. data/test/workbook/worksheet/tc_date_time_converter.rb +124 -0
  301. data/test/workbook/worksheet/tc_header_footer.rb +151 -0
  302. data/test/workbook/worksheet/tc_icon_set.rb +45 -0
  303. data/test/workbook/worksheet/tc_page_margins.rb +97 -0
  304. data/test/workbook/worksheet/tc_page_set_up_pr.rb +15 -0
  305. data/test/workbook/worksheet/tc_page_setup.rb +143 -0
  306. data/test/workbook/worksheet/tc_pane.rb +54 -0
  307. data/test/workbook/worksheet/tc_pivot_table.rb +120 -0
  308. data/test/workbook/worksheet/tc_pivot_table_cache_definition.rb +54 -0
  309. data/test/workbook/worksheet/tc_print_options.rb +72 -0
  310. data/test/workbook/worksheet/tc_protected_range.rb +17 -0
  311. data/test/workbook/worksheet/tc_rich_text.rb +44 -0
  312. data/test/workbook/worksheet/tc_rich_text_run.rb +172 -0
  313. data/test/workbook/worksheet/tc_row.rb +117 -0
  314. data/test/workbook/worksheet/tc_selection.rb +55 -0
  315. data/test/workbook/worksheet/tc_sheet_calc_pr.rb +18 -0
  316. data/test/workbook/worksheet/tc_sheet_format_pr.rb +88 -0
  317. data/test/workbook/worksheet/tc_sheet_pr.rb +49 -0
  318. data/test/workbook/worksheet/tc_sheet_protection.rb +117 -0
  319. data/test/workbook/worksheet/tc_sheet_view.rb +214 -0
  320. data/test/workbook/worksheet/tc_table.rb +68 -0
  321. data/test/workbook/worksheet/tc_table_style_info.rb +53 -0
  322. data/test/workbook/worksheet/tc_worksheet.rb +577 -0
  323. data/test/workbook/worksheet/tc_worksheet_hyperlink.rb +55 -0
  324. metadata +583 -0
@@ -0,0 +1,21 @@
1
+ module Axlsx
2
+ # a simple types list of DefinedName objects
3
+ class DefinedNames < SimpleTypedList
4
+
5
+ # creates the DefinedNames object
6
+ def initialize
7
+ super DefinedName
8
+ end
9
+
10
+ # Serialize to xml
11
+ # @param [String] str
12
+ # @return [String]
13
+ def to_xml_string(str = '')
14
+ return if empty?
15
+ str << '<definedNames>'
16
+ each { |defined_name| defined_name.to_xml_string(str) }
17
+ str << '</definedNames>'
18
+ end
19
+ end
20
+ end
21
+
@@ -0,0 +1,77 @@
1
+ # encoding: UTF-8
2
+ module Axlsx
3
+
4
+ # The Shared String Table class is responsible for managing and serializing common strings in a workbook.
5
+ # While the ECMA-376 spec allows for both inline and shared strings it seems that at least some applications like iWorks Numbers
6
+ # and Google Docs require that the shared string table is populated in order to interoperate properly.
7
+ # As a developer, you should never need to directly work against this class. Simply set 'use_shared_strings'
8
+ # on the package or workbook to generate a package that uses the shared strings table instead of inline strings.
9
+ # @note Serialization performance is affected by using this serialization method so if you do not need interoperability
10
+ # it is recomended that you use the default inline string method of serialization.
11
+ class SharedStringsTable
12
+
13
+ # The total number of strings in the workbook including duplicates
14
+ # Empty cells are treated as blank strings
15
+ # @return [Integer]
16
+ attr_reader :count
17
+
18
+ # The total number of unique strings in the workbook.
19
+ # @return [Integer]
20
+ def unique_count
21
+ @unique_cells.size
22
+ end
23
+
24
+ # An array of unique cells. Multiple attributes of the cell are used in comparison
25
+ # each of these unique cells is parsed into the shared string table.
26
+ # @see Cell#sharable
27
+ attr_reader :unique_cells
28
+
29
+ # The xml:space attribute
30
+ # @see Workbook#xml_space
31
+ attr_reader :xml_space
32
+
33
+ # Creates a new Shared Strings Table agains an array of cells
34
+ # @param [Array] cells This is an array of all of the cells in the workbook
35
+ # @param [Symbol] xml_space The xml:space behavior for the shared string table.
36
+ def initialize(cells, xml_space=:preserve)
37
+ @index = 0
38
+ @xml_space = xml_space
39
+ @unique_cells = {}
40
+ @shared_xml_string = ""
41
+ shareable_cells = cells.flatten.select{ |cell| cell.plain_string? || cell.contains_rich_text? }
42
+ @count = shareable_cells.size
43
+ resolve(shareable_cells)
44
+ end
45
+
46
+ # Serializes the object
47
+ # @param [String] str
48
+ # @return [String]
49
+ def to_xml_string(str='')
50
+ Axlsx::sanitize(@shared_xml_string)
51
+ str << ('<?xml version="1.0" encoding="UTF-8"?><sst xmlns="' << XML_NS << '"')
52
+ str << (' count="' << @count.to_s << '" uniqueCount="' << unique_count.to_s << '"')
53
+ str << (' xml:space="' << xml_space.to_s << '">' << @shared_xml_string << '</sst>')
54
+ end
55
+
56
+ private
57
+
58
+ # Interate over all of the cells in the array.
59
+ # if our unique cells array does not contain a sharable cell,
60
+ # add the cell to our unique cells array and set the ssti attribute on the index of this cell in the shared strings table
61
+ # if a sharable cell already exists in our unique_cells array, set the ssti attribute of the cell and move on.
62
+ # @return [Array] unique cells
63
+ def resolve(cells)
64
+ cells.each do |cell|
65
+ cell_hash = cell.value
66
+ if index = @unique_cells[cell_hash]
67
+ cell.send :ssti=, index
68
+ else
69
+ cell.send :ssti=, @index
70
+ @shared_xml_string << '<si>' << CellSerializer.run_xml_string(cell) << '</si>'
71
+ @unique_cells[cell_hash] = @index
72
+ @index += 1
73
+ end
74
+ end
75
+ end
76
+ end
77
+ end
@@ -0,0 +1,361 @@
1
+ # -*- coding: utf-8 -*-
2
+ module Axlsx
3
+ require 'axlsx/workbook/worksheet/sheet_calc_pr.rb'
4
+ require 'axlsx/workbook/worksheet/auto_filter/auto_filter.rb'
5
+ require 'axlsx/workbook/worksheet/date_time_converter.rb'
6
+ require 'axlsx/workbook/worksheet/protected_range.rb'
7
+ require 'axlsx/workbook/worksheet/protected_ranges.rb'
8
+ require 'axlsx/workbook/worksheet/rich_text_run'
9
+ require 'axlsx/workbook/worksheet/rich_text'
10
+ require 'axlsx/workbook/worksheet/cell_serializer.rb'
11
+ require 'axlsx/workbook/worksheet/cell.rb'
12
+ require 'axlsx/workbook/worksheet/page_margins.rb'
13
+ require 'axlsx/workbook/worksheet/page_set_up_pr.rb'
14
+ require 'axlsx/workbook/worksheet/page_setup.rb'
15
+ require 'axlsx/workbook/worksheet/header_footer.rb'
16
+ require 'axlsx/workbook/worksheet/print_options.rb'
17
+ require 'axlsx/workbook/worksheet/cfvo.rb'
18
+ require 'axlsx/workbook/worksheet/cfvos.rb'
19
+ require 'axlsx/workbook/worksheet/color_scale.rb'
20
+ require 'axlsx/workbook/worksheet/data_bar.rb'
21
+ require 'axlsx/workbook/worksheet/icon_set.rb'
22
+ require 'axlsx/workbook/worksheet/conditional_formatting.rb'
23
+ require 'axlsx/workbook/worksheet/conditional_formatting_rule.rb'
24
+ require 'axlsx/workbook/worksheet/conditional_formattings.rb'
25
+ require 'axlsx/workbook/worksheet/row.rb'
26
+ require 'axlsx/workbook/worksheet/col.rb'
27
+ require 'axlsx/workbook/worksheet/cols.rb'
28
+ require 'axlsx/workbook/worksheet/comments.rb'
29
+ require 'axlsx/workbook/worksheet/comment.rb'
30
+ require 'axlsx/workbook/worksheet/merged_cells.rb'
31
+ require 'axlsx/workbook/worksheet/sheet_protection.rb'
32
+ require 'axlsx/workbook/worksheet/sheet_pr.rb'
33
+ require 'axlsx/workbook/worksheet/dimension.rb'
34
+ require 'axlsx/workbook/worksheet/sheet_data.rb'
35
+ require 'axlsx/workbook/worksheet/worksheet_drawing.rb'
36
+ require 'axlsx/workbook/worksheet/worksheet_comments.rb'
37
+ require 'axlsx/workbook/worksheet/worksheet_hyperlink'
38
+ require 'axlsx/workbook/worksheet/worksheet_hyperlinks'
39
+ require 'axlsx/workbook/worksheet/break'
40
+ require 'axlsx/workbook/worksheet/row_breaks'
41
+ require 'axlsx/workbook/worksheet/col_breaks'
42
+ require 'axlsx/workbook/workbook_view'
43
+ require 'axlsx/workbook/workbook_views'
44
+
45
+
46
+ require 'axlsx/workbook/worksheet/worksheet.rb'
47
+ require 'axlsx/workbook/shared_strings_table.rb'
48
+ require 'axlsx/workbook/defined_name.rb'
49
+ require 'axlsx/workbook/defined_names.rb'
50
+ require 'axlsx/workbook/worksheet/table_style_info.rb'
51
+ require 'axlsx/workbook/worksheet/table.rb'
52
+ require 'axlsx/workbook/worksheet/tables.rb'
53
+ require 'axlsx/workbook/worksheet/pivot_table_cache_definition.rb'
54
+ require 'axlsx/workbook/worksheet/pivot_table.rb'
55
+ require 'axlsx/workbook/worksheet/pivot_tables.rb'
56
+ require 'axlsx/workbook/worksheet/data_validation.rb'
57
+ require 'axlsx/workbook/worksheet/data_validations.rb'
58
+ require 'axlsx/workbook/worksheet/sheet_view.rb'
59
+ require 'axlsx/workbook/worksheet/sheet_format_pr.rb'
60
+ require 'axlsx/workbook/worksheet/pane.rb'
61
+ require 'axlsx/workbook/worksheet/selection.rb'
62
+ # The Workbook class is an xlsx workbook that manages worksheets, charts, drawings and styles.
63
+ # The following parts of the Office Open XML spreadsheet specification are not implimented in this version.
64
+ #
65
+ # bookViews
66
+ # calcPr
67
+ # customWorkbookViews
68
+ # definedNames
69
+ # externalReferences
70
+ # extLst
71
+ # fileRecoveryPr
72
+ # fileSharing
73
+ # fileVersion
74
+ # functionGroups
75
+ # oleSize
76
+ # pivotCaches
77
+ # smartTagPr
78
+ # smartTagTypes
79
+ # webPublishing
80
+ # webPublishObjects
81
+ # workbookProtection
82
+ # workbookPr*
83
+ #
84
+ # *workbookPr is only supported to the extend of date1904
85
+ class Workbook
86
+
87
+ # When true, the Package will be generated with a shared string table. This may be required by some OOXML processors that do not
88
+ # adhere to the ECMA specification that dictates string may be inline in the sheet.
89
+ # Using this option will increase the time required to serialize the document as every string in every cell must be analzed and referenced.
90
+ # @return [Boolean]
91
+ attr_reader :use_shared_strings
92
+
93
+ # @see use_shared_strings
94
+ def use_shared_strings=(v)
95
+ Axlsx::validate_boolean(v)
96
+ @use_shared_strings = v
97
+ end
98
+
99
+
100
+ # A collection of worksheets associated with this workbook.
101
+ # @note The recommended way to manage worksheets is add_worksheet
102
+ # @see Workbook#add_worksheet
103
+ # @see Worksheet
104
+ # @return [SimpleTypedList]
105
+ attr_reader :worksheets
106
+
107
+ # A colllection of charts associated with this workbook
108
+ # @note The recommended way to manage charts is Worksheet#add_chart
109
+ # @see Worksheet#add_chart
110
+ # @see Chart
111
+ # @return [SimpleTypedList]
112
+ attr_reader :charts
113
+
114
+ # A colllection of images associated with this workbook
115
+ # @note The recommended way to manage images is Worksheet#add_image
116
+ # @see Worksheet#add_image
117
+ # @see Pic
118
+ # @return [SimpleTypedList]
119
+ attr_reader :images
120
+
121
+ # A colllection of drawings associated with this workbook
122
+ # @note The recommended way to manage drawings is Worksheet#add_chart
123
+ # @see Worksheet#add_chart
124
+ # @see Drawing
125
+ # @return [SimpleTypedList]
126
+ attr_reader :drawings
127
+
128
+ # pretty sure this two are always empty and can be removed.
129
+
130
+
131
+ # A colllection of tables associated with this workbook
132
+ # @note The recommended way to manage drawings is Worksheet#add_table
133
+ # @see Worksheet#add_table
134
+ # @see Table
135
+ # @return [SimpleTypedList]
136
+ attr_reader :tables
137
+
138
+ # A colllection of pivot tables associated with this workbook
139
+ # @note The recommended way to manage drawings is Worksheet#add_table
140
+ # @see Worksheet#add_table
141
+ # @see Table
142
+ # @return [SimpleTypedList]
143
+ attr_reader :pivot_tables
144
+
145
+ # A collection of views for this workbook
146
+ def views
147
+ @views ||= WorkbookViews.new
148
+ end
149
+
150
+ # A collection of defined names for this workbook
151
+ # @note The recommended way to manage defined names is Workbook#add_defined_name
152
+ # @see DefinedName
153
+ # @return [DefinedNames]
154
+ def defined_names
155
+ @defined_names ||= DefinedNames.new
156
+ end
157
+
158
+ # A collection of comments associated with this workbook
159
+ # @note The recommended way to manage comments is WOrksheet#add_comment
160
+ # @see Worksheet#add_comment
161
+ # @see Comment
162
+ # @return [Comments]
163
+ def comments
164
+ worksheets.map { |sheet| sheet.comments }.compact
165
+ end
166
+
167
+ # The styles associated with this workbook
168
+ # @note The recommended way to manage styles is Styles#add_style
169
+ # @see Style#add_style
170
+ # @see Style
171
+ # @return [Styles]
172
+ def styles
173
+ yield @styles if block_given?
174
+ @styles
175
+ end
176
+
177
+
178
+ # Indicates if the epoc date for serialization should be 1904. If false, 1900 is used.
179
+ @@date1904 = false
180
+
181
+
182
+ # A quick helper to retrive a worksheet by name
183
+ # @param [String] name The name of the sheet you are looking for
184
+ # @return [Worksheet] The sheet found, or nil
185
+ def sheet_by_name(name)
186
+ index = @worksheets.index { |sheet| sheet.name == name }
187
+ @worksheets[index] if index
188
+ end
189
+
190
+ # lets come back to this later when we are ready for parsing.
191
+ #def self.parse entry
192
+ # io = entry.get_input_stream
193
+ # w = self.new
194
+ # w.parser_xml = Nokogiri::XML(io.read)
195
+ # w.parse_string :date1904, "//xmlns:workbookPr/@date1904"
196
+ # w
197
+ #end
198
+
199
+ # Creates a new Workbook
200
+ # The recomended way to work with workbooks is via Package#workbook
201
+ # @option options [Boolean] date1904. If this is not specified, date1904 is set to false. Office 2011 for Mac defaults to false.
202
+ def initialize(options={})
203
+ @styles = Styles.new
204
+ @worksheets = SimpleTypedList.new Worksheet
205
+ @drawings = SimpleTypedList.new Drawing
206
+ @charts = SimpleTypedList.new Chart
207
+ @images = SimpleTypedList.new Pic
208
+ # Are these even used????? Check package serialization parts
209
+ @tables = SimpleTypedList.new Table
210
+ @pivot_tables = SimpleTypedList.new PivotTable
211
+ @comments = SimpleTypedList.new Comments
212
+
213
+
214
+ @use_autowidth = true
215
+
216
+ self.date1904= !options[:date1904].nil? && options[:date1904]
217
+ yield self if block_given?
218
+ end
219
+
220
+ # Instance level access to the class variable 1904
221
+ # @return [Boolean]
222
+ def date1904() @@date1904; end
223
+
224
+ # see @date1904
225
+ def date1904=(v) Axlsx::validate_boolean v; @@date1904 = v; end
226
+
227
+ # Sets the date1904 attribute to the provided boolean
228
+ # @return [Boolean]
229
+ def self.date1904=(v) Axlsx::validate_boolean v; @@date1904 = v; end
230
+
231
+ # retrieves the date1904 attribute
232
+ # @return [Boolean]
233
+ def self.date1904() @@date1904; end
234
+
235
+ # Indicates if the workbook should use autowidths or not.
236
+ # @note This gem no longer depends on RMagick for autowidth
237
+ # calculation. Thus the performance benefits of turning this off are
238
+ # marginal unless you are creating a very large sheet.
239
+ # @return [Boolean]
240
+ def use_autowidth() @use_autowidth; end
241
+
242
+ # see @use_autowidth
243
+ def use_autowidth=(v=true) Axlsx::validate_boolean v; @use_autowidth = v; end
244
+
245
+ # inserts a worksheet into this workbook at the position specified.
246
+ # It the index specified is out of range, the worksheet will be added to the end of the
247
+ # worksheets collection
248
+ # @return [Worksheet]
249
+ # @param index The zero based position to insert the newly created worksheet
250
+ # @param [Hash] options Options to pass into the worksheed during initialization.
251
+ # @option options [String] name The name of the worksheet
252
+ # @option options [Hash] page_margins The page margins for the worksheet
253
+ def insert_worksheet(index=0, options={})
254
+ worksheet = Worksheet.new(self, options)
255
+ @worksheets.delete_at(@worksheets.size - 1)
256
+ @worksheets.insert(index, worksheet)
257
+ yield worksheet if block_given?
258
+ worksheet
259
+ end
260
+
261
+ #
262
+ # Adds a worksheet to this workbook
263
+ # @return [Worksheet]
264
+ # @option options [String] name The name of the worksheet.
265
+ # @option options [Hash] page_margins The page margins for the worksheet.
266
+ # @see Worksheet#initialize
267
+ def add_worksheet(options={})
268
+ worksheet = Worksheet.new(self, options)
269
+ yield worksheet if block_given?
270
+ worksheet
271
+ end
272
+
273
+ def add_view(options={})
274
+ views << WorkbookView.new(options)
275
+ end
276
+
277
+ # Adds a defined name to this workbook
278
+ # @return [DefinedName]
279
+ # @param [String] formula @see DefinedName
280
+ # @param [Hash] options @see DefinedName
281
+ def add_defined_name(formula, options)
282
+ defined_names << DefinedName.new(formula, options)
283
+ end
284
+
285
+ # The workbook relationships. This is managed automatically by the workbook
286
+ # @return [Relationships]
287
+ def relationships
288
+ r = Relationships.new
289
+ @worksheets.each do |sheet|
290
+ r << Relationship.new(sheet, WORKSHEET_R, WORKSHEET_PN % (r.size+1))
291
+ end
292
+ pivot_tables.each_with_index do |pivot_table, index|
293
+ r << Relationship.new(pivot_table.cache_definition, PIVOT_TABLE_CACHE_DEFINITION_R, PIVOT_TABLE_CACHE_DEFINITION_PN % (index+1))
294
+ end
295
+ r << Relationship.new(self, STYLES_R, STYLES_PN)
296
+ if use_shared_strings
297
+ r << Relationship.new(self, SHARED_STRINGS_R, SHARED_STRINGS_PN)
298
+ end
299
+ r
300
+ end
301
+
302
+ # generates a shared string object against all cells in all worksheets.
303
+ # @return [SharedStringTable]
304
+ def shared_strings
305
+ SharedStringsTable.new(worksheets.collect { |ws| ws.cells }, xml_space)
306
+ end
307
+
308
+ # The xml:space attribute for the worksheet.
309
+ # This determines how whitespace is handled withing the document.
310
+ # The most relevant part being whitespace in the cell text.
311
+ # allowed values are :preserve and :default. Axlsx uses :preserve unless
312
+ # you explicily set this to :default.
313
+ # @return Symbol
314
+ def xml_space
315
+ @xml_space ||= :preserve
316
+ end
317
+
318
+ # Sets the xml:space attribute for the worksheet
319
+ # @see Worksheet#xml_space
320
+ # @param [Symbol] space must be one of :preserve or :default
321
+ def xml_space=(space)
322
+ Axlsx::RestrictionValidator.validate(:xml_space, [:preserve, :default], space)
323
+ @xml_space = space;
324
+ end
325
+
326
+ # returns a range of cells in a worksheet
327
+ # @param [String] cell_def The excel style reference defining the worksheet and cells. The range must specify the sheet to
328
+ # retrieve the cells from. e.g. range('Sheet1!A1:B2') will return an array of four cells [A1, A2, B1, B2] while range('Sheet1!A1') will return a single Cell.
329
+ # @return [Cell, Array]
330
+ def [](cell_def)
331
+ sheet_name = cell_def.split('!')[0] if cell_def.match('!')
332
+ worksheet = self.worksheets.select { |s| s.name == sheet_name }.first
333
+ raise ArgumentError, 'Unknown Sheet' unless sheet_name && worksheet.is_a?(Worksheet)
334
+ worksheet[cell_def.gsub(/.+!/,"")]
335
+ end
336
+
337
+ # Serialize the workbook
338
+ # @param [String] str
339
+ # @return [String]
340
+ def to_xml_string(str='')
341
+ add_worksheet(name: 'Sheet1') unless worksheets.size > 0
342
+ str << '<?xml version="1.0" encoding="UTF-8"?>'
343
+ str << ('<workbook xmlns="' << XML_NS << '" xmlns:r="' << XML_NS_R << '">')
344
+ str << ('<workbookPr date1904="' << @@date1904.to_s << '"/>')
345
+ views.to_xml_string(str)
346
+ str << '<sheets>'
347
+ worksheets.each { |sheet| sheet.to_sheet_node_xml_string(str) }
348
+ str << '</sheets>'
349
+ defined_names.to_xml_string(str)
350
+ unless pivot_tables.empty?
351
+ str << '<pivotCaches>'
352
+ pivot_tables.each do |pivot_table|
353
+ str << ('<pivotCache cacheId="' << pivot_table.cache_definition.cache_id.to_s << '" r:id="' << pivot_table.cache_definition.rId << '"/>')
354
+ end
355
+ str << '</pivotCaches>'
356
+ end
357
+ str << '</workbook>'
358
+ end
359
+
360
+ end
361
+ end