bonio-axlsx 2.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (325) 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 +258 -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 +274 -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 +34 -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 +98 -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 +34 -0
  75. data/lib/axlsx/drawing/title.rb +96 -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 +86 -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 +375 -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 +166 -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 +37 -0
  144. data/lib/axlsx/workbook/worksheet/outline_pr.rb +33 -0
  145. data/lib/axlsx/workbook/worksheet/page_margins.rb +97 -0
  146. data/lib/axlsx/workbook/worksheet/page_set_up_pr.rb +44 -0
  147. data/lib/axlsx/workbook/worksheet/page_setup.rb +240 -0
  148. data/lib/axlsx/workbook/worksheet/pane.rb +139 -0
  149. data/lib/axlsx/workbook/worksheet/pivot_table.rb +289 -0
  150. data/lib/axlsx/workbook/worksheet/pivot_table_cache_definition.rb +66 -0
  151. data/lib/axlsx/workbook/worksheet/pivot_tables.rb +24 -0
  152. data/lib/axlsx/workbook/worksheet/print_options.rb +39 -0
  153. data/lib/axlsx/workbook/worksheet/protected_range.rb +47 -0
  154. data/lib/axlsx/workbook/worksheet/protected_ranges.rb +34 -0
  155. data/lib/axlsx/workbook/worksheet/rich_text.rb +35 -0
  156. data/lib/axlsx/workbook/worksheet/rich_text_run.rb +254 -0
  157. data/lib/axlsx/workbook/worksheet/row.rb +161 -0
  158. data/lib/axlsx/workbook/worksheet/row_breaks.rb +33 -0
  159. data/lib/axlsx/workbook/worksheet/selection.rb +101 -0
  160. data/lib/axlsx/workbook/worksheet/sheet_calc_pr.rb +29 -0
  161. data/lib/axlsx/workbook/worksheet/sheet_data.rb +27 -0
  162. data/lib/axlsx/workbook/worksheet/sheet_format_pr.rb +60 -0
  163. data/lib/axlsx/workbook/worksheet/sheet_pr.rb +87 -0
  164. data/lib/axlsx/workbook/worksheet/sheet_protection.rb +118 -0
  165. data/lib/axlsx/workbook/worksheet/sheet_view.rb +213 -0
  166. data/lib/axlsx/workbook/worksheet/table.rb +102 -0
  167. data/lib/axlsx/workbook/worksheet/table_style_info.rb +49 -0
  168. data/lib/axlsx/workbook/worksheet/tables.rb +31 -0
  169. data/lib/axlsx/workbook/worksheet/worksheet.rb +799 -0
  170. data/lib/axlsx/workbook/worksheet/worksheet_comments.rb +58 -0
  171. data/lib/axlsx/workbook/worksheet/worksheet_drawing.rb +58 -0
  172. data/lib/axlsx/workbook/worksheet/worksheet_hyperlink.rb +74 -0
  173. data/lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb +38 -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 +30 -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 +82 -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 +145 -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 +373 -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_outline_pr.rb +19 -0
  304. data/test/workbook/worksheet/tc_page_margins.rb +97 -0
  305. data/test/workbook/worksheet/tc_page_set_up_pr.rb +15 -0
  306. data/test/workbook/worksheet/tc_page_setup.rb +143 -0
  307. data/test/workbook/worksheet/tc_pane.rb +54 -0
  308. data/test/workbook/worksheet/tc_pivot_table.rb +140 -0
  309. data/test/workbook/worksheet/tc_pivot_table_cache_definition.rb +54 -0
  310. data/test/workbook/worksheet/tc_print_options.rb +72 -0
  311. data/test/workbook/worksheet/tc_protected_range.rb +17 -0
  312. data/test/workbook/worksheet/tc_rich_text.rb +44 -0
  313. data/test/workbook/worksheet/tc_rich_text_run.rb +172 -0
  314. data/test/workbook/worksheet/tc_row.rb +122 -0
  315. data/test/workbook/worksheet/tc_selection.rb +55 -0
  316. data/test/workbook/worksheet/tc_sheet_calc_pr.rb +18 -0
  317. data/test/workbook/worksheet/tc_sheet_format_pr.rb +88 -0
  318. data/test/workbook/worksheet/tc_sheet_pr.rb +49 -0
  319. data/test/workbook/worksheet/tc_sheet_protection.rb +117 -0
  320. data/test/workbook/worksheet/tc_sheet_view.rb +214 -0
  321. data/test/workbook/worksheet/tc_table.rb +68 -0
  322. data/test/workbook/worksheet/tc_table_style_info.rb +53 -0
  323. data/test/workbook/worksheet/tc_worksheet.rb +594 -0
  324. data/test/workbook/worksheet/tc_worksheet_hyperlink.rb +55 -0
  325. metadata +582 -0
@@ -0,0 +1,11 @@
1
+ module Axlsx
2
+ # This module defines some utils related with mime type detection
3
+ module MimeTypeUtils
4
+ # Detect a file mime type
5
+ # @param [String] v File path
6
+ # @return [String] File mime type
7
+ def self.get_mime_type(v)
8
+ MimeMagic.by_magic(File.open(v)).to_s
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,16 @@
1
+ module Axlsx
2
+ # This module defines a single method for parsing options in class
3
+ # initializers.
4
+ module OptionsParser
5
+
6
+ # Parses an options hash by calling any defined method by the same
7
+ # name of the key postfixed with an '='
8
+ # @param [Hash] options Options to parse.
9
+ def parse_options(options={})
10
+ options.each do |key, value|
11
+ key = :"#{key}="
12
+ self.send(key, value) if !value.nil? && self.respond_to?(key)
13
+ end
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,44 @@
1
+ # encoding: UTF-8
2
+ module Axlsx
3
+ # The Parser module mixes in a number of methods to help in generating a model from xml
4
+ # This module is not included in the axlsx library at this time. It is for future development only,
5
+ module Parser
6
+
7
+ # The xml to be parsed
8
+ attr_accessor :parser_xml
9
+
10
+ # parse and assign string attribute
11
+ def parse_string attr_name, xpath
12
+ send("#{attr_name}=", parse_value(xpath))
13
+ end
14
+
15
+ # parse convert and assign node text to symbol
16
+ def parse_symbol attr_name, xpath
17
+ v = parse_value xpath
18
+ v = v.to_sym unless v.nil?
19
+ send("#{attr_name}=", v)
20
+ end
21
+
22
+ # parse, convert and assign note text to integer
23
+ def parse_integer attr_name, xpath
24
+ v = parse_value xpath
25
+ v = v.to_i if v.respond_to?(:to_i)
26
+ send("#{attr_name}=", v)
27
+ end
28
+
29
+ # parse, convert and assign node text to float
30
+ def parse_float attr_name, xpath
31
+ v = parse_value xpath
32
+ v = v.to_f if v.respond_to?(:to_f)
33
+ send("#{attr_name}=", v)
34
+ end
35
+
36
+ # return node text based on xpath
37
+ def parse_value xpath
38
+ node = parser_xml.xpath(xpath)
39
+ return nil if node.empty?
40
+ node.text.strip
41
+ end
42
+
43
+ end
44
+ end
@@ -0,0 +1,89 @@
1
+ module Axlsx
2
+ # This module allows us to define a list of symbols defining which
3
+ # attributes will be serialized for a class.
4
+ module SerializedAttributes
5
+
6
+ # Extend with class methods
7
+ def self.included(base)
8
+ base.send :extend, ClassMethods
9
+ end
10
+
11
+ # class methods applied to all includers
12
+ module ClassMethods
13
+
14
+ # This is the method to be used in inheriting classes to specify
15
+ # which of the instance values are serializable
16
+ def serializable_attributes(*symbols)
17
+ @xml_attributes = symbols
18
+ end
19
+
20
+ # a reader for those attributes
21
+ attr_reader :xml_attributes
22
+
23
+ # This helper registers the attributes that will be formatted as elements.
24
+ def serializable_element_attributes(*symbols)
25
+ @xml_element_attributes = symbols
26
+ end
27
+
28
+ # attr reader for element attributes
29
+ attr_reader :xml_element_attributes
30
+ end
31
+
32
+ # creates a XML tag with serialized attributes
33
+ # @see SerializedAttributes#serialized_attributes
34
+ def serialized_tag(tagname, str, additional_attributes = {}, &block)
35
+ str << "<#{tagname} "
36
+ serialized_attributes(str, additional_attributes)
37
+ if block_given?
38
+ str << '>'
39
+ yield
40
+ str << "</#{tagname}>"
41
+ else
42
+ str << '/>'
43
+ end
44
+ end
45
+
46
+ # serializes the instance values of the defining object based on the
47
+ # list of serializable attributes.
48
+ # @param [String] str The string instance to append this
49
+ # serialization to.
50
+ # @param [Hash] additional_attributes An option key value hash for
51
+ # defining values that are not serializable attributes list.
52
+ def serialized_attributes(str = '', additional_attributes = {})
53
+ attributes = declared_attributes.merge! additional_attributes
54
+ attributes.each do |key, value|
55
+ str << "#{Axlsx.camel(key, false)}=\"#{Axlsx.camel(Axlsx.booleanize(value), false)}\" "
56
+ end
57
+ str
58
+ end
59
+
60
+ # A hash of instance variables that have been declared with
61
+ # seraialized_attributes and are not nil.
62
+ # This requires ruby 1.9.3 or higher
63
+ def declared_attributes
64
+ instance_values.select do |key, value|
65
+ value != nil && self.class.xml_attributes.include?(key.to_sym)
66
+ end
67
+ end
68
+
69
+ # serialized instance values at text nodes on a camelized element of the
70
+ # attribute name. You may pass in a block for evaluation against non nil
71
+ # values. We use an array for element attributes becuase misordering will
72
+ # break the xml and 1.8.7 does not support ordered hashes.
73
+ # @param [String] str The string instance to which serialized data is appended
74
+ # @param [Array] additional_attributes An array of additional attribute names.
75
+ # @return [String] The serialized output.
76
+ def serialized_element_attributes(str='', additional_attributes=[], &block)
77
+ attrs = self.class.xml_element_attributes + additional_attributes
78
+ values = instance_values
79
+ attrs.each do |attribute_name|
80
+ value = values[attribute_name.to_s]
81
+ next if value.nil?
82
+ value = yield value if block_given?
83
+ element_name = Axlsx.camel(attribute_name, false)
84
+ str << "<#{element_name}>#{value}</#{element_name}>"
85
+ end
86
+ str
87
+ end
88
+ end
89
+ end
@@ -0,0 +1,179 @@
1
+ # encoding: UTF-8
2
+ module Axlsx
3
+
4
+ # A SimpleTypedList is a type restrictive collection that allows some of the methods from Array and supports basic xml serialization.
5
+ # @private
6
+ class SimpleTypedList
7
+ # Creats a new typed list
8
+ # @param [Array, Class] type An array of Class objects or a single Class object
9
+ # @param [String] serialize_as The tag name to use in serialization
10
+ # @raise [ArgumentError] if all members of type are not Class objects
11
+ def initialize type, serialize_as=nil, start_size = 0
12
+ if type.is_a? Array
13
+ type.each { |item| raise ArgumentError, "All members of type must be Class objects" unless item.is_a? Class }
14
+ @allowed_types = type
15
+ else
16
+ raise ArgumentError, "Type must be a Class object or array of Class objects" unless type.is_a? Class
17
+ @allowed_types = [type]
18
+ end
19
+ @serialize_as = serialize_as unless serialize_as.nil?
20
+ @list = Array.new(start_size)
21
+ end
22
+
23
+ # The class constants of allowed types
24
+ # @return [Array]
25
+ attr_reader :allowed_types
26
+
27
+ # The index below which items cannot be removed
28
+ # @return [Integer]
29
+ def locked_at
30
+ defined?(@locked_at) ? @locked_at : nil
31
+ end
32
+
33
+ # The tag name to use when serializing this object
34
+ # by default the parent node for all items in the list is the classname of the first allowed type with the first letter in lowercase.
35
+ # @return [String]
36
+ attr_reader :serialize_as
37
+
38
+ # Transposes the list (without blowing up like ruby does)
39
+ # any non populated cell in the matrix will be a nil value
40
+ def transpose
41
+ return @list.clone if @list.size == 0
42
+ row_count = @list.size
43
+ max_column_count = @list.map{|row| row.cells.size}.max
44
+ result = Array.new(max_column_count) { Array.new(row_count) }
45
+ # yes, I know it is silly, but that warning is really annoying
46
+ row_count.times do |row_index|
47
+ max_column_count.times do |column_index|
48
+ datum = if @list[row_index].cells.size >= max_column_count
49
+ @list[row_index].cells[column_index]
50
+ elsif block_given?
51
+ yield(column_index, row_index)
52
+ end
53
+ result[column_index][row_index] = datum
54
+ end
55
+ end
56
+ result
57
+ end
58
+
59
+ # Lock this list at the current size
60
+ # @return [self]
61
+ def lock
62
+ @locked_at = @list.size
63
+ self
64
+ end
65
+
66
+ # Unlock the list
67
+ # @return [self]
68
+ def unlock
69
+ @locked_at = nil
70
+ self
71
+ end
72
+
73
+ def to_ary
74
+ @list
75
+ end
76
+
77
+ alias :to_a :to_ary
78
+
79
+ # join operator
80
+ # @param [Array] v the array to join
81
+ # @raise [ArgumentError] if any of the values being joined are not
82
+ # one of the allowed types
83
+ # @return [SimpleTypedList]
84
+ def +(v)
85
+ v.each do |item|
86
+ DataTypeValidator.validate :SimpleTypedList_plus, @allowed_types, item
87
+ @list << item
88
+ end
89
+ end
90
+
91
+ # Concat operator
92
+ # @param [Any] v the data to be added
93
+ # @raise [ArgumentError] if the value being added is not one fo the allowed types
94
+ # @return [Integer] returns the index of the item added.
95
+ def <<(v)
96
+ DataTypeValidator.validate :SimpleTypedList_push, @allowed_types, v
97
+ @list << v
98
+ @list.size - 1
99
+ end
100
+
101
+ alias :push :<<
102
+
103
+
104
+ # delete the item from the list
105
+ # @param [Any] v The item to be deleted.
106
+ # @raise [ArgumentError] if the item's index is protected by locking
107
+ # @return [Any] The item deleted
108
+ def delete(v)
109
+ return unless include? v
110
+ raise ArgumentError, "Item is protected and cannot be deleted" if protected? index(v)
111
+ @list.delete v
112
+ end
113
+
114
+ # delete the item from the list at the index position provided
115
+ # @raise [ArgumentError] if the index is protected by locking
116
+ # @return [Any] The item deleted
117
+ def delete_at(index)
118
+ @list[index]
119
+ raise ArgumentError, "Item is protected and cannot be deleted" if protected? index
120
+ @list.delete_at index
121
+ end
122
+
123
+ # positional assignment. Adds the item at the index specified
124
+ # @param [Integer] index
125
+ # @param [Any] v
126
+ # @raise [ArgumentError] if the index is protected by locking
127
+ # @raise [ArgumentError] if the item is not one of the allowed types
128
+ def []=(index, v)
129
+ DataTypeValidator.validate :SimpleTypedList_insert, @allowed_types, v
130
+ raise ArgumentError, "Item is protected and cannot be changed" if protected? index
131
+ @list[index] = v
132
+ v
133
+ end
134
+
135
+ # inserts an item at the index specfied
136
+ # @param [Integer] index
137
+ # @param [Any] v
138
+ # @raise [ArgumentError] if the index is protected by locking
139
+ # @raise [ArgumentError] if the index is not one of the allowed types
140
+ def insert(index, v)
141
+ DataTypeValidator.validate :SimpleTypedList_insert, @allowed_types, v
142
+ raise ArgumentError, "Item is protected and cannot be changed" if protected? index
143
+ @list.insert(index, v)
144
+ v
145
+ end
146
+
147
+ # determines if the index is protected
148
+ # @param [Integer] index
149
+ def protected? index
150
+ return false unless locked_at.is_a? Integer
151
+ index < locked_at
152
+ end
153
+
154
+ DESTRUCTIVE = ['replace', 'insert', 'collect!', 'map!', 'pop', 'delete_if',
155
+ 'reverse!', 'shift', 'shuffle!', 'slice!', 'sort!', 'uniq!',
156
+ 'unshift', 'zip', 'flatten!', 'fill', 'drop', 'drop_while',
157
+ 'delete_if', 'clear']
158
+ DELEGATES = Array.instance_methods - self.instance_methods - DESTRUCTIVE
159
+
160
+ DELEGATES.each do |method|
161
+ class_eval %{
162
+ def #{method}(*args, &block)
163
+ @list.send(:#{method}, *args, &block)
164
+ end
165
+ }
166
+ end
167
+
168
+ def to_xml_string(str = '')
169
+ classname = @allowed_types[0].name.split('::').last
170
+ el_name = serialize_as.to_s || (classname[0,1].downcase + classname[1..-1])
171
+ str << ('<' << el_name << ' count="' << size.to_s << '">')
172
+ each { |item| item.to_xml_string(str) }
173
+ str << ('</' << el_name << '>')
174
+ end
175
+
176
+ end
177
+
178
+
179
+ end
@@ -0,0 +1,146 @@
1
+ # encoding: UTF-8
2
+ module Axlsx
3
+
4
+ # The Storage class represents a storage object or stream in a compound file.
5
+ class Storage
6
+
7
+ # Packing for the Storage when pushing an array of items into a byte stream
8
+ # Name, name length, type, color, left sibling, right sibling, child, classid, state, created, modified, sector, size
9
+ PACKING = "s32 s1 c2 l3 x16 x4 q2 l q".freeze
10
+
11
+ # storage types
12
+ TYPES = {
13
+ :root=>5,
14
+ :stream=>2,
15
+ :storage=>1
16
+ }.freeze
17
+
18
+ # Creates a byte string for this storage
19
+ # @return [String]
20
+ def to_s
21
+ data = [@name.concat(Array.new(32-@name.size, 0)),
22
+ @name_size,
23
+ @type,
24
+ @color,
25
+ @left,
26
+ @right,
27
+ @child,
28
+ @created,
29
+ @modified,
30
+ @sector,
31
+ @size].flatten
32
+ data.pack(PACKING)
33
+ end
34
+
35
+ # storage colors
36
+ COLORS = {
37
+ :red=>0,
38
+ :black=>1
39
+ }
40
+
41
+ # The color of this node in the directory tree. Defaults to black if not specified
42
+ # @return [Integer] color
43
+ attr_reader :color
44
+
45
+ # Sets the color for this storage
46
+ # @param [Integer] v Must be one of the COLORS constant hash values
47
+ def color=(v)
48
+ RestrictionValidator.validate :storage_color, COLORS.values, v
49
+ @color = v
50
+ end
51
+
52
+ # The size of the name for this node.
53
+ # interesting to see that office actually uses 'R' for the root directory and lists the size as 2 bytes - thus is it *NOT* null
54
+ # terminated. I am making this r/w so that I can override the size
55
+ # @return [Integer] color
56
+ attr_reader :name_size
57
+
58
+ # the name of the stream
59
+ attr_reader :name
60
+
61
+ # sets the name of the stream.
62
+ # This will automatically set the name_size attribute
63
+ # @return [String] name
64
+ def name=(v)
65
+ @name = v.bytes.to_a << 0
66
+ @name_size = @name.size * 2
67
+ @name
68
+ end
69
+
70
+ # The size of the stream
71
+ attr_reader :size
72
+
73
+ # The stream associated with this storage
74
+ attr_reader :data
75
+
76
+ # Set the data associated with the stream. If the stream type is undefined, we automatically specify the storage as a stream type. # with the exception of storages that are type root, all storages with data should be type stream.
77
+ # @param [String] v The data for this storages stream
78
+ # @return [Array]
79
+ def data=(v)
80
+ Axlsx::validate_string(v)
81
+ self.type = TYPES[:stream] unless @type
82
+ @size = v.size
83
+ @data = v.bytes.to_a
84
+ end
85
+
86
+ # The starting sector for the stream. If this storage is not a stream, or the root node this is nil
87
+ # @return [Integer] sector
88
+ attr_accessor :sector
89
+
90
+ # The 0 based index in the directoies chain for this the left sibling of this storage.
91
+
92
+ # @return [Integer] left
93
+ attr_accessor :left
94
+
95
+ # The 0 based index in the directoies chain for this the right sibling of this storage.
96
+ # @return [Integer] right
97
+ attr_accessor :right
98
+
99
+ # The 0 based index in the directoies chain for the child of this storage.
100
+ # @return [Integer] child
101
+ attr_accessor :child
102
+
103
+ # The created attribute for the storage
104
+ # @return [Integer] created
105
+ attr_accessor :created
106
+
107
+ # The modified attribute for the storage
108
+ # @return [Integer] modified
109
+ attr_accessor :modified
110
+
111
+ # The type of storage
112
+ # see TYPES
113
+ # @return [Integer] type
114
+ attr_reader :type
115
+
116
+ # Sets the type for this storage.
117
+ # @param [Integer] v the type to specify must be one of the TYPES constant hash values.
118
+ def type=(v)
119
+ RestrictionValidator.validate :storage_type, TYPES.values, v
120
+ @type = v
121
+ end
122
+
123
+ # Creates a new storage object.
124
+ # @param [String] name the name of the storage
125
+ # @option options [Integer] color @default black
126
+ # @option options [Integer] type @default storage
127
+ # @option options [String] data
128
+ # @option options [Integer] left @default -1
129
+ # @option options [Integer] right @default -1
130
+ # @option options [Integer] child @default -1
131
+ # @option options [Integer] created @default 0
132
+ # @option options [Integer] modified @default 0
133
+ # @option options [Integer] sector @default 0
134
+ def initialize(name, options= {})
135
+ @left = @right = @child = -1
136
+ @sector = @size = @created = @modified = 0
137
+ options.each do |o|
138
+ self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
139
+ end
140
+ @color ||= COLORS[:black]
141
+ @type ||= (data.nil? ? TYPES[:storage] : TYPES[:stream])
142
+ self.name = name
143
+ end
144
+
145
+ end
146
+ end