workbook 0.3.1 → 0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. data/.yardoc/checksums +21 -18
  2. data/.yardoc/object_types +0 -0
  3. data/.yardoc/objects/root.dat +0 -0
  4. data/Gemfile.lock +4 -4
  5. data/README.md +8 -5
  6. data/doc/RubyXL/Cell.html +18 -19
  7. data/doc/RubyXL/Workbook.html +116 -114
  8. data/doc/RubyXL.html +3 -3
  9. data/doc/Workbook/Book.html +513 -145
  10. data/doc/Workbook/Cell.html +181 -170
  11. data/doc/Workbook/Format.html +591 -77
  12. data/doc/Workbook/Modules/RawObjectsStorage.html +39 -45
  13. data/doc/Workbook/Modules/TableDiffSort.html +225 -87
  14. data/doc/Workbook/Modules/TypeParser.html +182 -131
  15. data/doc/Workbook/Modules.html +3 -3
  16. data/doc/Workbook/Readers/CsvReader.html +101 -39
  17. data/doc/Workbook/Readers/OdsReader.html +564 -0
  18. data/doc/Workbook/Readers/TxtReader.html +12 -14
  19. data/doc/Workbook/Readers/XlsReader.html +154 -138
  20. data/doc/Workbook/Readers/XlsShared.html +71 -72
  21. data/doc/Workbook/Readers/XlsxReader.html +89 -82
  22. data/doc/Workbook/Readers.html +6 -6
  23. data/doc/Workbook/Row.html +421 -206
  24. data/doc/Workbook/Sheet.html +379 -32
  25. data/doc/Workbook/Table.html +328 -90
  26. data/doc/Workbook/Template.html +55 -60
  27. data/doc/Workbook/Writers/CsvTableWriter.html +33 -8
  28. data/doc/Workbook/Writers/HtmlWriter.html +393 -0
  29. data/doc/Workbook/Writers/XlsWriter.html +132 -92
  30. data/doc/Workbook/Writers.html +5 -5
  31. data/doc/Workbook.html +16 -4
  32. data/doc/_index.html +45 -15
  33. data/doc/class_list.html +1 -1
  34. data/doc/css/style.css +10 -0
  35. data/doc/file.README.html +53 -48
  36. data/doc/frames.html +1 -1
  37. data/doc/index.html +53 -48
  38. data/doc/method_list.html +232 -56
  39. data/doc/top-level-namespace.html +3 -3
  40. data/lib/workbook/book.rb +27 -1
  41. data/lib/workbook/format.rb +46 -7
  42. data/lib/workbook/modules/type_parser.rb +8 -1
  43. data/lib/workbook/readers/ods_reader.rb +93 -0
  44. data/lib/workbook/row.rb +7 -0
  45. data/lib/workbook/sheet.rb +10 -0
  46. data/lib/workbook/version.rb +1 -1
  47. data/lib/workbook/writers/html_writer.rb +56 -0
  48. data/test/artifacts/book_with_tabs_and_colours.ods +0 -0
  49. data/test/artifacts/complex_types.ods +0 -0
  50. data/test/artifacts/excel_different_types.ods +0 -0
  51. data/test/artifacts/simple_sheet.ods +0 -0
  52. data/test/test_book.rb +6 -0
  53. data/test/test_format.rb +39 -0
  54. data/test/test_modules_type_parser.rb +2 -0
  55. data/test/test_readers_csv_reader.rb +44 -0
  56. data/test/test_readers_ods_reader.rb +51 -0
  57. data/test/test_readers_txt_reader.rb +53 -0
  58. data/test/test_row.rb +12 -0
  59. data/test/test_sheet.rb +12 -0
  60. data/test/test_writers_html_writer.rb +37 -0
  61. data/workbook.gemspec +2 -2
  62. metadata +21 -4
data/doc/Workbook/Writers/HtmlWriter.html ADDED
@@ -0,0 +1,393 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Module: Workbook::Writers::HtmlWriter
8
+
9
+ &mdash; Documentation by YARD 0.8.5.2
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../../';
20
+ framesUrl = "../../frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../../_index.html">Index (H)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../../Workbook.html" title="Workbook (module)">Workbook</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Writers.html" title="Workbook::Writers (module)">Writers</a></span></span>
36
+ &raquo;
37
+ <span class="title">HtmlWriter</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Module: Workbook::Writers::HtmlWriter
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+ <dt class="r1">Included in:</dt>
81
+ <dd class="r1"><span class='object_link'><a href="../Book.html" title="Workbook::Book (class)">Book</a></span></dd>
82
+
83
+
84
+
85
+ <dt class="r2 last">Defined in:</dt>
86
+ <dd class="r2 last">lib/workbook/writers/html_writer.rb</dd>
87
+
88
+ </dl>
89
+ <div class="clear"></div>
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+ <h2>
100
+ Instance Method Summary
101
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
102
+ </h2>
103
+
104
+ <ul class="summary">
105
+
106
+ <li class="public ">
107
+ <span class="summary_signature">
108
+
109
+ <a href="#to_html-instance_method" title="#to_html (instance method)">- (Spreadsheet) <strong>to_html</strong>(options = {}) </a>
110
+
111
+
112
+
113
+ </span>
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+ <span class="summary_desc"><div class='inline'>
124
+ <p>Generates an Spreadsheet (from the spreadsheet gem) in order to build an
125
+ XlS.</p>
126
+ </div></span>
127
+
128
+ </li>
129
+
130
+
131
+ <li class="public ">
132
+ <span class="summary_signature">
133
+
134
+ <a href="#write_to_html-instance_method" title="#write_to_html (instance method)">- (Object) <strong>write_to_html</strong>(filename = &quot;#{title}.html&quot;, options = {}) </a>
135
+
136
+
137
+
138
+ </span>
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+ <span class="summary_desc"><div class='inline'>
149
+ <p>Write the current workbook to Microsoft Excel format (using the spreadsheet
150
+ gem).</p>
151
+ </div></span>
152
+
153
+ </li>
154
+
155
+
156
+ </ul>
157
+
158
+
159
+
160
+
161
+ <div id="instance_method_details" class="method_details_list">
162
+ <h2>Instance Method Details</h2>
163
+
164
+
165
+ <div class="method_details first">
166
+ <h3 class="signature first" id="to_html-instance_method">
167
+
168
+ - (<tt>Spreadsheet</tt>) <strong>to_html</strong>(options = {})
169
+
170
+
171
+
172
+
173
+
174
+ </h3><div class="docstring">
175
+ <div class="discussion">
176
+
177
+ <p>Generates an Spreadsheet (from the spreadsheet gem) in order to build an
178
+ XlS</p>
179
+
180
+
181
+ </div>
182
+ </div>
183
+ <div class="tags">
184
+ <p class="tag_title">Parameters:</p>
185
+ <ul class="param">
186
+
187
+ <li>
188
+
189
+ <span class='name'>options</span>
190
+
191
+
192
+ <span class='type'>(<tt>Hash</tt>)</span>
193
+
194
+
195
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
196
+
197
+
198
+ &mdash;
199
+ <div class='inline'>
200
+ <p>A hash with options</p>
201
+ </div>
202
+
203
+ </li>
204
+
205
+ </ul>
206
+
207
+ <p class="tag_title">Returns:</p>
208
+ <ul class="return">
209
+
210
+ <li>
211
+
212
+
213
+ <span class='type'>(<tt>Spreadsheet</tt>)</span>
214
+
215
+
216
+
217
+ &mdash;
218
+ <div class='inline'>
219
+ <p>A Spreadsheet object, ready for writing or more lower level operations</p>
220
+ </div>
221
+
222
+ </li>
223
+
224
+ </ul>
225
+
226
+ </div><table class="source_code">
227
+ <tr>
228
+ <td>
229
+ <pre class="lines">
230
+
231
+
232
+ 12
233
+ 13
234
+ 14
235
+ 15
236
+ 16
237
+ 17
238
+ 18
239
+ 19
240
+ 20
241
+ 21
242
+ 22
243
+ 23
244
+ 24
245
+ 25
246
+ 26
247
+ 27
248
+ 28
249
+ 29
250
+ 30
251
+ 31
252
+ 32
253
+ 33
254
+ 34
255
+ 35
256
+ 36
257
+ 37
258
+ 38
259
+ 39
260
+ 40
261
+ 41
262
+ 42</pre>
263
+ </td>
264
+ <td>
265
+ <pre class="code"><span class="info file"># File 'lib/workbook/writers/html_writer.rb', line 12</span>
266
+
267
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_html'>to_html</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span>
268
+ <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='symbol'>:style_with_inline_css</span><span class='op'>=&gt;</span><span class='kw'>false</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
269
+ <span class='id identifier rubyid_builder'>builder</span> <span class='op'>=</span> <span class='const'>Nokogiri</span><span class='op'>::</span><span class='const'>HTML</span><span class='op'>::</span><span class='const'>Builder</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_doc'>doc</span><span class='op'>|</span>
270
+ <span class='id identifier rubyid_doc'>doc</span><span class='period'>.</span><span class='id identifier rubyid_html'>html</span> <span class='lbrace'>{</span>
271
+ <span class='id identifier rubyid_doc'>doc</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span> <span class='lbrace'>{</span>
272
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_sheet'>sheet</span><span class='op'>|</span>
273
+ <span class='id identifier rubyid_doc'>doc</span><span class='period'>.</span><span class='id identifier rubyid_h1'>h1</span> <span class='lbrace'>{</span>
274
+ <span class='id identifier rubyid_doc'>doc</span><span class='period'>.</span><span class='id identifier rubyid_text'>text</span> <span class='id identifier rubyid_sheet'>sheet</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
275
+ <span class='rbrace'>}</span>
276
+ <span class='id identifier rubyid_sheet'>sheet</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_table'>table</span><span class='op'>|</span>
277
+ <span class='id identifier rubyid_doc'>doc</span><span class='period'>.</span><span class='id identifier rubyid_table'>table</span> <span class='lbrace'>{</span>
278
+ <span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_row'>row</span><span class='op'>|</span>
279
+ <span class='id identifier rubyid_doc'>doc</span><span class='period'>.</span><span class='id identifier rubyid_tr'>tr</span> <span class='lbrace'>{</span>
280
+ <span class='id identifier rubyid_row'>row</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_cell'>cell</span><span class='op'>|</span>
281
+ <span class='id identifier rubyid_classnames'>classnames</span> <span class='op'>=</span> <span class='id identifier rubyid_cell'>cell</span><span class='period'>.</span><span class='id identifier rubyid_format'>format</span><span class='period'>.</span><span class='id identifier rubyid_all_names'>all_names</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span>
282
+ <span class='id identifier rubyid_td_options'>td_options</span> <span class='op'>=</span> <span class='id identifier rubyid_classnames'>classnames</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span> <span class='op'>?</span> <span class='lbrace'>{</span><span class='symbol'>:class</span><span class='op'>=&gt;</span><span class='id identifier rubyid_classnames'>classnames</span><span class='rbrace'>}</span> <span class='op'>:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
283
+ <span class='id identifier rubyid_td_options'>td_options</span> <span class='op'>=</span> <span class='id identifier rubyid_td_options'>td_options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='symbol'>:style</span><span class='op'>=&gt;</span><span class='id identifier rubyid_cell'>cell</span><span class='period'>.</span><span class='id identifier rubyid_format'>format</span><span class='period'>.</span><span class='id identifier rubyid_to_css'>to_css</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:style_with_inline_css</span><span class='rbracket'>]</span> <span class='kw'>and</span> <span class='id identifier rubyid_cell'>cell</span><span class='period'>.</span><span class='id identifier rubyid_format'>format</span><span class='period'>.</span><span class='id identifier rubyid_to_css'>to_css</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
284
+ <span class='id identifier rubyid_doc'>doc</span><span class='period'>.</span><span class='id identifier rubyid_td'>td</span><span class='lparen'>(</span><span class='id identifier rubyid_td_options'>td_options</span><span class='rparen'>)</span> <span class='lbrace'>{</span>
285
+ <span class='id identifier rubyid_doc'>doc</span><span class='period'>.</span><span class='id identifier rubyid_text'>text</span> <span class='id identifier rubyid_cell'>cell</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span>
286
+ <span class='rbrace'>}</span>
287
+ <span class='rbrace'>}</span>
288
+ <span class='rbrace'>}</span>
289
+ <span class='rbrace'>}</span>
290
+ <span class='rbrace'>}</span>
291
+ <span class='rbrace'>}</span>
292
+ <span class='rbrace'>}</span>
293
+ <span class='rbrace'>}</span>
294
+ <span class='rbrace'>}</span>
295
+ <span class='kw'>end</span>
296
+ <span class='kw'>return</span> <span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_to_html'>to_html</span>
297
+ <span class='kw'>end</span></pre>
298
+ </td>
299
+ </tr>
300
+ </table>
301
+ </div>
302
+
303
+ <div class="method_details ">
304
+ <h3 class="signature " id="write_to_html-instance_method">
305
+
306
+ - (<tt>Object</tt>) <strong>write_to_html</strong>(filename = &quot;#{title}.html&quot;, options = {})
307
+
308
+
309
+
310
+
311
+
312
+ </h3><div class="docstring">
313
+ <div class="discussion">
314
+
315
+ <p>Write the current workbook to Microsoft Excel format (using the spreadsheet
316
+ gem)</p>
317
+
318
+
319
+ </div>
320
+ </div>
321
+ <div class="tags">
322
+ <p class="tag_title">Parameters:</p>
323
+ <ul class="param">
324
+
325
+ <li>
326
+
327
+ <span class='name'>filename</span>
328
+
329
+
330
+ <span class='type'>(<tt>String</tt>)</span>
331
+
332
+
333
+ <em class="default">(defaults to: <tt>&quot;#{title}.html&quot;</tt>)</em>
334
+
335
+
336
+ </li>
337
+
338
+ <li>
339
+
340
+ <span class='name'>options</span>
341
+
342
+
343
+ <span class='type'>(<tt>Hash</tt>)</span>
344
+
345
+
346
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
347
+
348
+
349
+ &mdash;
350
+ <div class='inline'>
351
+ <p>see #to_xls</p>
352
+ </div>
353
+
354
+ </li>
355
+
356
+ </ul>
357
+
358
+
359
+ </div><table class="source_code">
360
+ <tr>
361
+ <td>
362
+ <pre class="lines">
363
+
364
+
365
+ 50
366
+ 51
367
+ 52
368
+ 53</pre>
369
+ </td>
370
+ <td>
371
+ <pre class="code"><span class="info file"># File 'lib/workbook/writers/html_writer.rb', line 50</span>
372
+
373
+ <span class='kw'>def</span> <span class='id identifier rubyid_write_to_html'>write_to_html</span> <span class='id identifier rubyid_filename'>filename</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_title'>title</span><span class='rbrace'>}</span><span class='tstring_content'>.html</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span>
374
+ <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_filename'>filename</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>w</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_f'>f</span><span class='op'>|</span> <span class='id identifier rubyid_f'>f</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_to_html'>to_html</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
375
+ <span class='kw'>return</span> <span class='id identifier rubyid_filename'>filename</span>
376
+ <span class='kw'>end</span></pre>
377
+ </td>
378
+ </tr>
379
+ </table>
380
+ </div>
381
+
382
+ </div>
383
+
384
+ </div>
385
+
386
+ <div id="footer">
387
+ Generated on Sun May 5 14:58:05 2013 by
388
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
389
+ 0.8.5.2 (ruby-1.9.3).
390
+ </div>
391
+
392
+ </body>
393
+ </html>