workbook 0.2.0 → 0.2.1
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.
- data/.yardoc/checksums +18 -0
- data/.yardoc/object_types +3 -0
- data/.yardoc/objects/root.dat +0 -0
- data/.yardoc/proxy_types +0 -0
- data/Gemfile.lock +1 -1
- data/{readme.markdown → README.md} +36 -10
- data/doc/RubyXL.html +128 -0
- data/doc/RubyXL/Cell.html +202 -0
- data/doc/RubyXL/Workbook.html +447 -0
- data/doc/Workbook.html +130 -0
- data/doc/Workbook/Book.html +1484 -0
- data/doc/Workbook/Cell.html +1402 -0
- data/doc/Workbook/Format.html +654 -0
- data/doc/Workbook/Modules.html +117 -0
- data/doc/Workbook/Modules/RawObjectsStorage.html +508 -0
- data/doc/Workbook/Modules/TableDiffSort.html +620 -0
- data/doc/Workbook/Modules/TypeParser.html +1012 -0
- data/doc/Workbook/Readers.html +117 -0
- data/doc/Workbook/Readers/CsvReader.html +262 -0
- data/doc/Workbook/Readers/TxtReader.html +238 -0
- data/doc/Workbook/Readers/XlsReader.html +362 -0
- data/doc/Workbook/Readers/XlsShared.html +189 -0
- data/doc/Workbook/Readers/XlsxReader.html +295 -0
- data/doc/Workbook/Row.html +1939 -0
- data/doc/Workbook/Sheet.html +528 -0
- data/doc/Workbook/Table.html +883 -0
- data/doc/Workbook/Template.html +639 -0
- data/doc/Workbook/Writers.html +117 -0
- data/doc/Workbook/Writers/CsvTableWriter.html +175 -0
- data/doc/Workbook/Writers/XlsWriter.html +865 -0
- data/doc/_index.html +336 -0
- data/doc/class_list.html +53 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +328 -0
- data/doc/file.README.html +236 -0
- data/doc/file_list.html +55 -0
- data/doc/frames.html +28 -0
- data/doc/index.html +236 -0
- data/doc/js/app.js +214 -0
- data/doc/js/full_list.js +173 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +972 -0
- data/doc/top-level-namespace.html +112 -0
- data/lib/workbook/book.rb +38 -29
- data/lib/workbook/cell.rb +25 -0
- data/lib/workbook/format.rb +9 -2
- data/lib/workbook/modules/raw_objects_storage.rb +5 -0
- data/lib/workbook/modules/table_diff_sort.rb +8 -6
- data/lib/workbook/modules/type_parser.rb +16 -3
- data/lib/workbook/readers/xls_reader.rb +1 -70
- data/lib/workbook/readers/xls_shared.rb +75 -0
- data/lib/workbook/row.rb +89 -17
- data/lib/workbook/sheet.rb +26 -0
- data/lib/workbook/table.rb +20 -1
- data/lib/workbook/template.rb +12 -11
- data/lib/workbook/writers/xls_writer.rb +19 -77
- data/test/test_modules_table_diff_sort.rb +19 -6
- data/test/test_row.rb +54 -0
- data/test/test_sheet.rb +8 -0
- data/test/test_table.rb +22 -3
- data/test/test_writers_xls_writer.rb +3 -0
- data/workbook.gemspec +1 -1
- metadata +46 -3
|
@@ -0,0 +1,639 @@
|
|
|
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
|
+
Class: Workbook::Template
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.3
|
|
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 (T)</a> »
|
|
35
|
+
<span class='title'><span class='object_link'><a href="../Workbook.html" title="Workbook (module)">Workbook</a></span></span>
|
|
36
|
+
»
|
|
37
|
+
<span class="title">Template</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>Class: Workbook::Template
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
</h1>
|
|
71
|
+
|
|
72
|
+
<dl class="box">
|
|
73
|
+
|
|
74
|
+
<dt class="r1">Inherits:</dt>
|
|
75
|
+
<dd class="r1">
|
|
76
|
+
<span class="inheritName">Object</span>
|
|
77
|
+
|
|
78
|
+
<ul class="fullTree">
|
|
79
|
+
<li>Object</li>
|
|
80
|
+
|
|
81
|
+
<li class="next">Workbook::Template</li>
|
|
82
|
+
|
|
83
|
+
</ul>
|
|
84
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
85
|
+
|
|
86
|
+
</dd>
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
<dt class="r2">Includes:</dt>
|
|
94
|
+
<dd class="r2"><span class='object_link'><a href="Modules/RawObjectsStorage.html" title="Workbook::Modules::RawObjectsStorage (module)">Modules::RawObjectsStorage</a></span></dd>
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
<dt class="r1 last">Defined in:</dt>
|
|
101
|
+
<dd class="r1 last">lib/workbook/template.rb</dd>
|
|
102
|
+
|
|
103
|
+
</dl>
|
|
104
|
+
<div class="clear"></div>
|
|
105
|
+
|
|
106
|
+
<h2>Overview</h2><div class="docstring">
|
|
107
|
+
<div class="discussion">
|
|
108
|
+
|
|
109
|
+
<p>Workbook::Template is a container for different Workbook::Format’s and
|
|
110
|
+
the storage of raw template data that isn’t really supported by Workbook,
|
|
111
|
+
but should survive a typical read/write cyclus.</p>
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
</div>
|
|
115
|
+
</div>
|
|
116
|
+
<div class="tags">
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
</div>
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
<h2>
|
|
128
|
+
Instance Method Summary
|
|
129
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
130
|
+
</h2>
|
|
131
|
+
|
|
132
|
+
<ul class="summary">
|
|
133
|
+
|
|
134
|
+
<li class="public ">
|
|
135
|
+
<span class="summary_signature">
|
|
136
|
+
|
|
137
|
+
<a href="#add_format-instance_method" title="#add_format (instance method)">- (Object) <strong>add_format</strong>(format) </a>
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
</span>
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
<span class="summary_desc"><div class='inline'>
|
|
152
|
+
<p>Add a Workbook::Format to the template.</p>
|
|
153
|
+
</div></span>
|
|
154
|
+
|
|
155
|
+
</li>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
<li class="public ">
|
|
159
|
+
<span class="summary_signature">
|
|
160
|
+
|
|
161
|
+
<a href="#create_or_find_format_by-instance_method" title="#create_or_find_format_by (instance method)">- (Workbook::Format) <strong>create_or_find_format_by</strong>(name, variant = :default) </a>
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
</span>
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
<span class="summary_desc"><div class='inline'>
|
|
176
|
+
<p>Create or find a format by name.</p>
|
|
177
|
+
</div></span>
|
|
178
|
+
|
|
179
|
+
</li>
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
<li class="public ">
|
|
183
|
+
<span class="summary_signature">
|
|
184
|
+
|
|
185
|
+
<a href="#formats-instance_method" title="#formats (instance method)">- (Hash) <strong>formats</strong> </a>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
</span>
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
<span class="summary_desc"><div class='inline'>
|
|
200
|
+
<p>Return the list of associated formats.</p>
|
|
201
|
+
</div></span>
|
|
202
|
+
|
|
203
|
+
</li>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
<li class="public ">
|
|
207
|
+
<span class="summary_signature">
|
|
208
|
+
|
|
209
|
+
<a href="#has_header%3F-instance_method" title="#has_header? (instance method)">- (Boolean) <strong>has_header?</strong> </a>
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
</span>
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
<span class="summary_desc"><div class='inline'>
|
|
224
|
+
<p>Whether the template has a predefined header (headers are used ).</p>
|
|
225
|
+
</div></span>
|
|
226
|
+
|
|
227
|
+
</li>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
<li class="public ">
|
|
231
|
+
<span class="summary_signature">
|
|
232
|
+
|
|
233
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Template) <strong>initialize</strong> </a>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
</span>
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
<span class="note title constructor">constructor</span>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
<span class="summary_desc"><div class='inline'>
|
|
250
|
+
<p>Initialize Workbook::Template.</p>
|
|
251
|
+
</div></span>
|
|
252
|
+
|
|
253
|
+
</li>
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
</ul>
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Modules/RawObjectsStorage.html" title="Workbook::Modules::RawObjectsStorage (module)">Modules::RawObjectsStorage</a></span></h3>
|
|
269
|
+
<p class="inherited"><span class='object_link'><a href="Modules/RawObjectsStorage.html#add_raw-instance_method" title="Workbook::Modules::RawObjectsStorage#add_raw (method)">#add_raw</a></span>, <span class='object_link'><a href="Modules/RawObjectsStorage.html#has_raw_for%3F-instance_method" title="Workbook::Modules::RawObjectsStorage#has_raw_for? (method)">#has_raw_for?</a></span>, <span class='object_link'><a href="Modules/RawObjectsStorage.html#raws-instance_method" title="Workbook::Modules::RawObjectsStorage#raws (method)">#raws</a></span>, <span class='object_link'><a href="Modules/RawObjectsStorage.html#remove_all_raws%21-instance_method" title="Workbook::Modules::RawObjectsStorage#remove_all_raws! (method)">#remove_all_raws!</a></span>, <span class='object_link'><a href="Modules/RawObjectsStorage.html#return_raw_for-instance_method" title="Workbook::Modules::RawObjectsStorage#return_raw_for (method)">#return_raw_for</a></span></p>
|
|
270
|
+
<div id="constructor_details" class="method_details_list">
|
|
271
|
+
<h2>Constructor Details</h2>
|
|
272
|
+
|
|
273
|
+
<div class="method_details first">
|
|
274
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
275
|
+
|
|
276
|
+
- (<tt><span class='object_link'><a href="" title="Workbook::Template (class)">Template</a></span></tt>) <strong>initialize</strong>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
</h3><div class="docstring">
|
|
283
|
+
<div class="discussion">
|
|
284
|
+
|
|
285
|
+
<p>Initialize Workbook::Template</p>
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
</div>
|
|
289
|
+
</div>
|
|
290
|
+
<div class="tags">
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
</div><table class="source_code">
|
|
294
|
+
<tr>
|
|
295
|
+
<td>
|
|
296
|
+
<pre class="lines">
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
9
|
|
300
|
+
10
|
|
301
|
+
11
|
|
302
|
+
12</pre>
|
|
303
|
+
</td>
|
|
304
|
+
<td>
|
|
305
|
+
<pre class="code"><span class="info file"># File 'lib/workbook/template.rb', line 9</span>
|
|
306
|
+
|
|
307
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span>
|
|
308
|
+
<span class='rubyid_@formats ivar id'>@formats</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span>
|
|
309
|
+
<span class='rubyid_@has_header ivar id'>@has_header</span> <span class='assign token'>=</span> <span class='rubyid_true true kw'>true</span>
|
|
310
|
+
<span class='rubyid_end end kw'>end</span>
|
|
311
|
+
</pre>
|
|
312
|
+
</td>
|
|
313
|
+
</tr>
|
|
314
|
+
</table>
|
|
315
|
+
</div>
|
|
316
|
+
|
|
317
|
+
</div>
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
<div id="instance_method_details" class="method_details_list">
|
|
321
|
+
<h2>Instance Method Details</h2>
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
<div class="method_details first">
|
|
325
|
+
<h3 class="signature first" id="add_format-instance_method">
|
|
326
|
+
|
|
327
|
+
- (<tt>Object</tt>) <strong>add_format</strong>(format)
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
</h3><div class="docstring">
|
|
334
|
+
<div class="discussion">
|
|
335
|
+
|
|
336
|
+
<p>Add a Workbook::Format to the template</p>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
</div>
|
|
340
|
+
</div>
|
|
341
|
+
<div class="tags">
|
|
342
|
+
<p class="tag_title">Parameters:</p>
|
|
343
|
+
<ul class="param">
|
|
344
|
+
|
|
345
|
+
<li>
|
|
346
|
+
|
|
347
|
+
<span class='name'>format</span>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
<span class='type'>(<tt><span class='object_link'><a href="Format.html" title="Workbook::Format (class)">Workbook::Format</a></span></tt>)</span>
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
—
|
|
355
|
+
<div class='inline'>
|
|
356
|
+
<p>(of a cell) to add to the template</p>
|
|
357
|
+
</div>
|
|
358
|
+
|
|
359
|
+
</li>
|
|
360
|
+
|
|
361
|
+
</ul>
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
</div><table class="source_code">
|
|
365
|
+
<tr>
|
|
366
|
+
<td>
|
|
367
|
+
<pre class="lines">
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
21
|
|
371
|
+
22
|
|
372
|
+
23
|
|
373
|
+
24
|
|
374
|
+
25
|
|
375
|
+
26
|
|
376
|
+
27</pre>
|
|
377
|
+
</td>
|
|
378
|
+
<td>
|
|
379
|
+
<pre class="code"><span class="info file"># File 'lib/workbook/template.rb', line 21</span>
|
|
380
|
+
|
|
381
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_add_format identifier id'>add_format</span> <span class='rubyid_format identifier id'>format</span>
|
|
382
|
+
<span class='rubyid_if if kw'>if</span> <span class='rubyid_format identifier id'>format</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span> <span class='rubyid_Workbook constant id'>Workbook</span><span class='colon2 op'>::</span><span class='rubyid_Format constant id'>Format</span>
|
|
383
|
+
<span class='rubyid_@formats ivar id'>@formats</span><span class='lbrack token'>[</span><span class='rubyid_format identifier id'>format</span><span class='dot token'>.</span><span class='rubyid_name identifier id'>name</span><span class='rbrack token'>]</span><span class='assign token'>=</span><span class='rubyid_format identifier id'>format</span>
|
|
384
|
+
<span class='rubyid_else else kw'>else</span>
|
|
385
|
+
<span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>"format should be a Workboot::Format"</span>
|
|
386
|
+
<span class='rubyid_end end kw'>end</span>
|
|
387
|
+
<span class='rubyid_end end kw'>end</span>
|
|
388
|
+
</pre>
|
|
389
|
+
</td>
|
|
390
|
+
</tr>
|
|
391
|
+
</table>
|
|
392
|
+
</div>
|
|
393
|
+
|
|
394
|
+
<div class="method_details ">
|
|
395
|
+
<h3 class="signature " id="create_or_find_format_by-instance_method">
|
|
396
|
+
|
|
397
|
+
- (<tt><span class='object_link'><a href="Format.html" title="Workbook::Format (class)">Workbook::Format</a></span></tt>) <strong>create_or_find_format_by</strong>(name, variant = :default)
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
</h3><div class="docstring">
|
|
404
|
+
<div class="discussion">
|
|
405
|
+
|
|
406
|
+
<p>Create or find a format by name</p>
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
</div>
|
|
410
|
+
</div>
|
|
411
|
+
<div class="tags">
|
|
412
|
+
<p class="tag_title">Parameters:</p>
|
|
413
|
+
<ul class="param">
|
|
414
|
+
|
|
415
|
+
<li>
|
|
416
|
+
|
|
417
|
+
<span class='name'>name</span>
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
—
|
|
425
|
+
<div class='inline'>
|
|
426
|
+
<p>of the format (e.g. whatever you want, in diff names such as
|
|
427
|
+
‘destroyed’, ‘updated’ and ‘created’ are being used)</p>
|
|
428
|
+
</div>
|
|
429
|
+
|
|
430
|
+
</li>
|
|
431
|
+
|
|
432
|
+
<li>
|
|
433
|
+
|
|
434
|
+
<span class='name'>variant</span>
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
<em class="default">(defaults to: <tt>:default</tt>)</em>
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
—
|
|
444
|
+
<div class='inline'>
|
|
445
|
+
<p>can also be a strftime formatting string (e.g. “%Y-%m-%d”)</p>
|
|
446
|
+
</div>
|
|
447
|
+
|
|
448
|
+
</li>
|
|
449
|
+
|
|
450
|
+
</ul>
|
|
451
|
+
|
|
452
|
+
<p class="tag_title">Returns:</p>
|
|
453
|
+
<ul class="return">
|
|
454
|
+
|
|
455
|
+
<li>
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
<span class='type'>(<tt><span class='object_link'><a href="Format.html" title="Workbook::Format (class)">Workbook::Format</a></span></tt>)</span>
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
—
|
|
463
|
+
<div class='inline'>
|
|
464
|
+
<p>The new or found format</p>
|
|
465
|
+
</div>
|
|
466
|
+
|
|
467
|
+
</li>
|
|
468
|
+
|
|
469
|
+
</ul>
|
|
470
|
+
|
|
471
|
+
</div><table class="source_code">
|
|
472
|
+
<tr>
|
|
473
|
+
<td>
|
|
474
|
+
<pre class="lines">
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
39
|
|
478
|
+
40
|
|
479
|
+
41
|
|
480
|
+
42
|
|
481
|
+
43
|
|
482
|
+
44
|
|
483
|
+
45
|
|
484
|
+
46
|
|
485
|
+
47
|
|
486
|
+
48
|
|
487
|
+
49
|
|
488
|
+
50
|
|
489
|
+
51</pre>
|
|
490
|
+
</td>
|
|
491
|
+
<td>
|
|
492
|
+
<pre class="code"><span class="info file"># File 'lib/workbook/template.rb', line 39</span>
|
|
493
|
+
|
|
494
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_create_or_find_format_by identifier id'>create_or_find_format_by</span> <span class='rubyid_name identifier id'>name</span><span class='comma token'>,</span> <span class='rubyid_variant identifier id'>variant</span><span class='assign token'>=</span><span class='symbol val'>:default</span>
|
|
495
|
+
<span class='rubyid_fs identifier id'>fs</span> <span class='assign token'>=</span> <span class='rubyid_@formats ivar id'>@formats</span><span class='lbrack token'>[</span><span class='rubyid_name identifier id'>name</span><span class='rbrack token'>]</span>
|
|
496
|
+
<span class='rubyid_fs identifier id'>fs</span> <span class='assign token'>=</span> <span class='rubyid_@formats ivar id'>@formats</span><span class='lbrack token'>[</span><span class='rubyid_name identifier id'>name</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_fs identifier id'>fs</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
|
|
497
|
+
<span class='rubyid_f identifier id'>f</span> <span class='assign token'>=</span> <span class='rubyid_fs identifier id'>fs</span><span class='lbrack token'>[</span><span class='rubyid_variant identifier id'>variant</span><span class='rbrack token'>]</span>
|
|
498
|
+
<span class='rubyid_if if kw'>if</span> <span class='rubyid_f identifier id'>f</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
|
|
499
|
+
<span class='rubyid_f identifier id'>f</span> <span class='assign token'>=</span> <span class='rubyid_Workbook constant id'>Workbook</span><span class='colon2 op'>::</span><span class='rubyid_Format constant id'>Format</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span>
|
|
500
|
+
<span class='rubyid_if if kw'>if</span> <span class='rubyid_variant identifier id'>variant</span> <span class='neq op'>!=</span> <span class='symbol val'>:default</span> <span class='rubyid_and and kw'>and</span> <span class='rubyid_fs identifier id'>fs</span><span class='lbrack token'>[</span><span class='symbol val'>:default</span><span class='rbrack token'>]</span>
|
|
501
|
+
<span class='rubyid_f identifier id'>f</span> <span class='assign token'>=</span> <span class='rubyid_fs identifier id'>fs</span><span class='lbrack token'>[</span><span class='symbol val'>:default</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_clone identifier id'>clone</span>
|
|
502
|
+
<span class='rubyid_end end kw'>end</span>
|
|
503
|
+
<span class='rubyid_@formats ivar id'>@formats</span><span class='lbrack token'>[</span><span class='rubyid_name identifier id'>name</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='rubyid_variant identifier id'>variant</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_f identifier id'>f</span>
|
|
504
|
+
<span class='rubyid_end end kw'>end</span>
|
|
505
|
+
<span class='rubyid_return return kw'>return</span> <span class='rubyid_@formats ivar id'>@formats</span><span class='lbrack token'>[</span><span class='rubyid_name identifier id'>name</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='rubyid_variant identifier id'>variant</span><span class='rbrack token'>]</span>
|
|
506
|
+
<span class='rubyid_end end kw'>end</span>
|
|
507
|
+
</pre>
|
|
508
|
+
</td>
|
|
509
|
+
</tr>
|
|
510
|
+
</table>
|
|
511
|
+
</div>
|
|
512
|
+
|
|
513
|
+
<div class="method_details ">
|
|
514
|
+
<h3 class="signature " id="formats-instance_method">
|
|
515
|
+
|
|
516
|
+
- (<tt>Hash</tt>) <strong>formats</strong>
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
</h3><div class="docstring">
|
|
523
|
+
<div class="discussion">
|
|
524
|
+
|
|
525
|
+
<p>Return the list of associated formats</p>
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
</div>
|
|
529
|
+
</div>
|
|
530
|
+
<div class="tags">
|
|
531
|
+
|
|
532
|
+
<p class="tag_title">Returns:</p>
|
|
533
|
+
<ul class="return">
|
|
534
|
+
|
|
535
|
+
<li>
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
—
|
|
543
|
+
<div class='inline'>
|
|
544
|
+
<p>A keyed-hash of named formats</p>
|
|
545
|
+
</div>
|
|
546
|
+
|
|
547
|
+
</li>
|
|
548
|
+
|
|
549
|
+
</ul>
|
|
550
|
+
|
|
551
|
+
</div><table class="source_code">
|
|
552
|
+
<tr>
|
|
553
|
+
<td>
|
|
554
|
+
<pre class="lines">
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
31
|
|
558
|
+
32
|
|
559
|
+
33</pre>
|
|
560
|
+
</td>
|
|
561
|
+
<td>
|
|
562
|
+
<pre class="code"><span class="info file"># File 'lib/workbook/template.rb', line 31</span>
|
|
563
|
+
|
|
564
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_formats identifier id'>formats</span>
|
|
565
|
+
<span class='rubyid_@formats ivar id'>@formats</span>
|
|
566
|
+
<span class='rubyid_end end kw'>end</span>
|
|
567
|
+
</pre>
|
|
568
|
+
</td>
|
|
569
|
+
</tr>
|
|
570
|
+
</table>
|
|
571
|
+
</div>
|
|
572
|
+
|
|
573
|
+
<div class="method_details ">
|
|
574
|
+
<h3 class="signature " id="has_header?-instance_method">
|
|
575
|
+
|
|
576
|
+
- (<tt>Boolean</tt>) <strong>has_header?</strong>
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
</h3><div class="docstring">
|
|
583
|
+
<div class="discussion">
|
|
584
|
+
|
|
585
|
+
<p>Whether the template has a predefined header (headers are used )</p>
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
</div>
|
|
589
|
+
</div>
|
|
590
|
+
<div class="tags">
|
|
591
|
+
|
|
592
|
+
<p class="tag_title">Returns:</p>
|
|
593
|
+
<ul class="return">
|
|
594
|
+
|
|
595
|
+
<li>
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
</li>
|
|
603
|
+
|
|
604
|
+
</ul>
|
|
605
|
+
|
|
606
|
+
</div><table class="source_code">
|
|
607
|
+
<tr>
|
|
608
|
+
<td>
|
|
609
|
+
<pre class="lines">
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
15
|
|
613
|
+
16
|
|
614
|
+
17</pre>
|
|
615
|
+
</td>
|
|
616
|
+
<td>
|
|
617
|
+
<pre class="code"><span class="info file"># File 'lib/workbook/template.rb', line 15</span>
|
|
618
|
+
|
|
619
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_has_header? fid id'>has_header?</span>
|
|
620
|
+
<span class='rubyid_@has_header ivar id'>@has_header</span>
|
|
621
|
+
<span class='rubyid_end end kw'>end</span>
|
|
622
|
+
</pre>
|
|
623
|
+
</td>
|
|
624
|
+
</tr>
|
|
625
|
+
</table>
|
|
626
|
+
</div>
|
|
627
|
+
|
|
628
|
+
</div>
|
|
629
|
+
|
|
630
|
+
</div>
|
|
631
|
+
|
|
632
|
+
<div id="footer">
|
|
633
|
+
Generated on Thu Jan 17 13:16:06 2013 by
|
|
634
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
635
|
+
0.8.3 (ruby-1.8.7).
|
|
636
|
+
</div>
|
|
637
|
+
|
|
638
|
+
</body>
|
|
639
|
+
</html>
|