axlsx 1.0.11 → 1.0.12

Sign up to get free protection for your applications and to get access to all the features.
Files changed (145) hide show
  1. data/.yardopts +4 -0
  2. data/README.md +7 -4
  3. data/examples/example.rb +6 -4
  4. data/examples/example.rb~ +112 -0
  5. data/lib/schema/dc.xsd~ +118 -0
  6. data/lib/schema/dcterms.xsd~ +331 -0
  7. data/lib/schema/opc-coreProperties.xsd~ +50 -0
  8. metadata +43 -193
  9. data/Gemfile +0 -3
  10. data/Gemfile.lock +0 -29
  11. data/axlsx.gemspec +0 -42
  12. data/doc/Axlsx.html +0 -2718
  13. data/doc/Axlsx/App.html +0 -2640
  14. data/doc/Axlsx/Axis.html +0 -1075
  15. data/doc/Axlsx/Bar3DChart.html +0 -1182
  16. data/doc/Axlsx/BarSeries.html +0 -711
  17. data/doc/Axlsx/Border.html +0 -779
  18. data/doc/Axlsx/BorderPr.html +0 -709
  19. data/doc/Axlsx/CatAxis.html +0 -769
  20. data/doc/Axlsx/CatAxisData.html +0 -397
  21. data/doc/Axlsx/Cell.html +0 -3187
  22. data/doc/Axlsx/CellAlignment.html +0 -1247
  23. data/doc/Axlsx/CellProtection.html +0 -565
  24. data/doc/Axlsx/CellStyle.html +0 -949
  25. data/doc/Axlsx/Chart.html +0 -1692
  26. data/doc/Axlsx/Color.html +0 -670
  27. data/doc/Axlsx/ContentType.html +0 -335
  28. data/doc/Axlsx/Core.html +0 -465
  29. data/doc/Axlsx/DataTypeValidator.html +0 -324
  30. data/doc/Axlsx/Default.html +0 -565
  31. data/doc/Axlsx/Drawing.html +0 -1264
  32. data/doc/Axlsx/Fill.html +0 -460
  33. data/doc/Axlsx/Font.html +0 -1554
  34. data/doc/Axlsx/GradientFill.html +0 -1026
  35. data/doc/Axlsx/GradientStop.html +0 -526
  36. data/doc/Axlsx/GraphicFrame.html +0 -642
  37. data/doc/Axlsx/Line3DChart.html +0 -1004
  38. data/doc/Axlsx/LineSeries.html +0 -605
  39. data/doc/Axlsx/Marker.html +0 -857
  40. data/doc/Axlsx/NumFmt.html +0 -562
  41. data/doc/Axlsx/OneCellAnchor.html +0 -982
  42. data/doc/Axlsx/Override.html +0 -552
  43. data/doc/Axlsx/Package.html +0 -825
  44. data/doc/Axlsx/Parser.html +0 -549
  45. data/doc/Axlsx/PatternFill.html +0 -681
  46. data/doc/Axlsx/Pic.html +0 -1701
  47. data/doc/Axlsx/PictureLocking.html +0 -1159
  48. data/doc/Axlsx/Pie3DChart.html +0 -489
  49. data/doc/Axlsx/PieSeries.html +0 -710
  50. data/doc/Axlsx/RegexValidator.html +0 -268
  51. data/doc/Axlsx/Relationship.html +0 -554
  52. data/doc/Axlsx/Relationships.html +0 -338
  53. data/doc/Axlsx/RestrictionValidator.html +0 -300
  54. data/doc/Axlsx/Row.html +0 -916
  55. data/doc/Axlsx/Scaling.html +0 -742
  56. data/doc/Axlsx/SerAxis.html +0 -641
  57. data/doc/Axlsx/Series.html +0 -813
  58. data/doc/Axlsx/SeriesTitle.html +0 -290
  59. data/doc/Axlsx/Styles.html +0 -1754
  60. data/doc/Axlsx/TableStyle.html +0 -705
  61. data/doc/Axlsx/TableStyleElement.html +0 -677
  62. data/doc/Axlsx/TableStyles.html +0 -594
  63. data/doc/Axlsx/Title.html +0 -543
  64. data/doc/Axlsx/TwoCellAnchor.html +0 -973
  65. data/doc/Axlsx/ValAxis.html +0 -538
  66. data/doc/Axlsx/ValAxisData.html +0 -321
  67. data/doc/Axlsx/View3D.html +0 -973
  68. data/doc/Axlsx/Workbook.html +0 -1630
  69. data/doc/Axlsx/Worksheet.html +0 -2682
  70. data/doc/Axlsx/Xf.html +0 -1780
  71. data/doc/_index.html +0 -649
  72. data/doc/class_list.html +0 -47
  73. data/doc/css/common.css +0 -1
  74. data/doc/css/full_list.css +0 -55
  75. data/doc/css/style.css +0 -322
  76. data/doc/file.LICENSE.html +0 -91
  77. data/doc/file.README.html +0 -338
  78. data/doc/file_list.html +0 -52
  79. data/doc/frames.html +0 -13
  80. data/doc/index.html +0 -338
  81. data/doc/js/app.js +0 -205
  82. data/doc/js/full_list.js +0 -167
  83. data/doc/js/jquery.js +0 -16
  84. data/doc/method_list.html +0 -3502
  85. data/doc/top-level-namespace.html +0 -103
  86. data/lib/axlsx.rb +0 -54
  87. data/lib/axlsx/content_type/content_type.rb +0 -23
  88. data/lib/axlsx/content_type/default.rb +0 -37
  89. data/lib/axlsx/content_type/override.rb +0 -37
  90. data/lib/axlsx/doc_props/app.rb +0 -178
  91. data/lib/axlsx/doc_props/core.rb +0 -34
  92. data/lib/axlsx/drawing/axis.rb +0 -90
  93. data/lib/axlsx/drawing/bar_3D_chart.rb +0 -128
  94. data/lib/axlsx/drawing/bar_series.rb +0 -64
  95. data/lib/axlsx/drawing/cat_axis.rb +0 -63
  96. data/lib/axlsx/drawing/cat_axis_data.rb +0 -35
  97. data/lib/axlsx/drawing/chart.rb +0 -179
  98. data/lib/axlsx/drawing/drawing.rb +0 -137
  99. data/lib/axlsx/drawing/graphic_frame.rb +0 -52
  100. data/lib/axlsx/drawing/line_3D_chart.rb +0 -106
  101. data/lib/axlsx/drawing/line_series.rb +0 -46
  102. data/lib/axlsx/drawing/marker.rb +0 -61
  103. data/lib/axlsx/drawing/one_cell_anchor.rb +0 -89
  104. data/lib/axlsx/drawing/pic.rb +0 -153
  105. data/lib/axlsx/drawing/picture_locking.rb +0 -72
  106. data/lib/axlsx/drawing/pie_3D_chart.rb +0 -41
  107. data/lib/axlsx/drawing/pie_series.rb +0 -56
  108. data/lib/axlsx/drawing/scaling.rb +0 -59
  109. data/lib/axlsx/drawing/ser_axis.rb +0 -45
  110. data/lib/axlsx/drawing/series.rb +0 -71
  111. data/lib/axlsx/drawing/series_title.rb +0 -22
  112. data/lib/axlsx/drawing/title.rb +0 -61
  113. data/lib/axlsx/drawing/two_cell_anchor.rb +0 -76
  114. data/lib/axlsx/drawing/val_axis.rb +0 -34
  115. data/lib/axlsx/drawing/val_axis_data.rb +0 -28
  116. data/lib/axlsx/drawing/view_3D.rb +0 -85
  117. data/lib/axlsx/package.rb +0 -214
  118. data/lib/axlsx/rels/relationship.rb +0 -44
  119. data/lib/axlsx/rels/relationships.rb +0 -25
  120. data/lib/axlsx/stylesheet/border.rb +0 -57
  121. data/lib/axlsx/stylesheet/border_pr.rb +0 -68
  122. data/lib/axlsx/stylesheet/cell_alignment.rb +0 -105
  123. data/lib/axlsx/stylesheet/cell_protection.rb +0 -36
  124. data/lib/axlsx/stylesheet/cell_style.rb +0 -65
  125. data/lib/axlsx/stylesheet/color.rb +0 -69
  126. data/lib/axlsx/stylesheet/fill.rb +0 -32
  127. data/lib/axlsx/stylesheet/font.rb +0 -139
  128. data/lib/axlsx/stylesheet/gradient_fill.rb +0 -76
  129. data/lib/axlsx/stylesheet/gradient_stop.rb +0 -33
  130. data/lib/axlsx/stylesheet/num_fmt.rb +0 -63
  131. data/lib/axlsx/stylesheet/pattern_fill.rb +0 -66
  132. data/lib/axlsx/stylesheet/styles.rb +0 -298
  133. data/lib/axlsx/stylesheet/table_style.rb +0 -47
  134. data/lib/axlsx/stylesheet/table_style_element.rb +0 -71
  135. data/lib/axlsx/stylesheet/table_styles.rb +0 -39
  136. data/lib/axlsx/stylesheet/xf.rb +0 -138
  137. data/lib/axlsx/util/constants.rb +0 -216
  138. data/lib/axlsx/util/parser.rb +0 -43
  139. data/lib/axlsx/util/simple_typed_list.rb +0 -160
  140. data/lib/axlsx/util/validators.rb +0 -132
  141. data/lib/axlsx/version.rb +0 -4
  142. data/lib/axlsx/workbook/workbook.rb +0 -160
  143. data/lib/axlsx/workbook/worksheet/cell.rb +0 -340
  144. data/lib/axlsx/workbook/worksheet/row.rb +0 -107
  145. data/lib/axlsx/workbook/worksheet/worksheet.rb +0 -278
@@ -1,338 +0,0 @@
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: Axlsx::Relationships
8
-
9
- &mdash; AXLSX
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
- relpath = '..';
19
- if (relpath != '') relpath += '/';
20
- </script>
21
-
22
- <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
23
-
24
- <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
25
-
26
-
27
- </head>
28
- <body>
29
- <script type="text/javascript" charset="utf-8">
30
- if (window.top.frames.main) document.body.className = 'frames';
31
- </script>
32
-
33
- <div id="header">
34
- <div id="menu">
35
-
36
- <a href="../_index.html">Index (R)</a> &raquo;
37
- <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span>
38
- &raquo;
39
- <span class="title">Relationships</span>
40
-
41
-
42
- <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
- </div>
44
-
45
- <div id="search">
46
-
47
- <a id="class_list_link" href="#">Class List</a>
48
-
49
- <a id="method_list_link" href="#">Method List</a>
50
-
51
- <a id="file_list_link" href="#">File List</a>
52
-
53
- </div>
54
- <div class="clear"></div>
55
- </div>
56
-
57
- <iframe id="search_frame"></iframe>
58
-
59
- <div id="content"><h1>Class: Axlsx::Relationships
60
-
61
-
62
-
63
- </h1>
64
-
65
- <dl class="box">
66
-
67
- <dt class="r1">Inherits:</dt>
68
- <dd class="r1">
69
- <span class="inheritName"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></span>
70
-
71
- <ul class="fullTree">
72
- <li>Object</li>
73
-
74
- <li class="next"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></li>
75
-
76
- <li class="next">Axlsx::Relationships</li>
77
-
78
- </ul>
79
- <a href="#" class="inheritanceTree">show all</a>
80
-
81
- </dd>
82
-
83
-
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
- <dt class="r2 last">Defined in:</dt>
92
- <dd class="r2 last">lib/axlsx/rels/relationships.rb</dd>
93
-
94
- </dl>
95
- <div class="clear"></div>
96
-
97
- <h2>Overview</h2><div class="docstring">
98
- <div class="discussion">
99
-
100
- <div class="note notetag">
101
- <strong>Note:</strong>
102
- <div class='inline'><p>
103
- The package automatically manages releationships.
104
- </p>
105
- </div>
106
- </div>
107
-
108
- <p>
109
- Relationships are a collection of Relations that define how package parts
110
- are related.
111
- </p>
112
-
113
-
114
- </div>
115
- </div>
116
- <div class="tags">
117
-
118
-
119
- </div>
120
-
121
-
122
-
123
-
124
-
125
-
126
-
127
-
128
-
129
-
130
- <h2>Instance Attribute Summary</h2>
131
-
132
- <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></h3>
133
- <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#allowed_types-instance_method" title="Axlsx::SimpleTypedList#allowed_types (method)">allowed_types</a></span>, <span class='object_link'><a href="SimpleTypedList.html#locked_at-instance_method" title="Axlsx::SimpleTypedList#locked_at (method)">locked_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#serialize_as-instance_method" title="Axlsx::SimpleTypedList#serialize_as (method)">serialize_as</a></span></p>
134
-
135
-
136
-
137
- <h2>
138
- Instance Method Summary
139
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
140
- </h2>
141
-
142
- <ul class="summary">
143
-
144
- <li class="public ">
145
- <span class="summary_signature">
146
-
147
- <a href="#initialize-instance_method" title="#initialize (instance method)">- (Relationships) <strong>initialize</strong> </a>
148
-
149
-
150
-
151
- </span>
152
-
153
- <span class="note title constructor">constructor</span>
154
-
155
-
156
-
157
-
158
-
159
-
160
-
161
-
162
- <span class="summary_desc"><div class='inline'><p>
163
- Creates a new Relationships collection based on SimpleTypedList.
164
- </p>
165
- </div></span>
166
-
167
- </li>
168
-
169
-
170
- <li class="public ">
171
- <span class="summary_signature">
172
-
173
- <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong> </a>
174
-
175
-
176
-
177
- </span>
178
-
179
-
180
-
181
-
182
-
183
-
184
-
185
-
186
- <span class="summary_desc"><div class='inline'><p>
187
- Serializes the relationships document.
188
- </p>
189
- </div></span>
190
-
191
- </li>
192
-
193
-
194
- </ul>
195
-
196
-
197
-
198
-
199
-
200
-
201
-
202
- <div id="constructor_details" class="method_details_list">
203
- <h2>Constructor Details</h2>
204
-
205
- <div class="method_details first">
206
- <p class="signature first" id="initialize-instance_method">
207
-
208
- - (<tt><span class='object_link'><a href="" title="Axlsx::Relationships (class)">Relationships</a></span></tt>) <strong>initialize</strong>
209
-
210
-
211
-
212
- </p><div class="docstring">
213
- <div class="discussion">
214
- <p>
215
- Creates a new Relationships collection based on SimpleTypedList
216
- </p>
217
-
218
-
219
- </div>
220
- </div>
221
- <div class="tags">
222
-
223
-
224
- </div><table class="source_code">
225
- <tr>
226
- <td>
227
- <pre class="lines">
228
-
229
-
230
- 9
231
- 10
232
- 11</pre>
233
- </td>
234
- <td>
235
- <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationships.rb', line 9</span>
236
-
237
- <span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span>
238
- <span class='super super kw'>super</span> <span class='Relationship constant id'>Relationship</span>
239
- <span class='end end kw'>end</span>
240
- </pre>
241
- </td>
242
- </tr>
243
- </table>
244
- </div>
245
-
246
- </div>
247
- <div id="method_missing_details" class="method_details_list">
248
- <h2>Dynamic Method Handling</h2>
249
- <p class="notice super">
250
- This class handles dynamic methods through the <tt>method_missing</tt> method
251
-
252
- in the class <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">Axlsx::SimpleTypedList</a></span>
253
-
254
- </p>
255
-
256
- </div>
257
-
258
-
259
- <div id="instance_method_details" class="method_details_list">
260
- <h2>Instance Method Details</h2>
261
-
262
-
263
- <div class="method_details first">
264
- <p class="signature first" id="to_xml-instance_method">
265
-
266
- - (<tt>String</tt>) <strong>to_xml</strong>
267
-
268
-
269
-
270
- </p><div class="docstring">
271
- <div class="discussion">
272
- <p>
273
- Serializes the relationships document.
274
- </p>
275
-
276
-
277
- </div>
278
- </div>
279
- <div class="tags">
280
-
281
- <h3>Returns:</h3>
282
- <ul class="return">
283
-
284
- <li>
285
-
286
-
287
- <span class='type'>(<tt>String</tt>)</span>
288
-
289
-
290
-
291
- </li>
292
-
293
- </ul>
294
-
295
- </div><table class="source_code">
296
- <tr>
297
- <td>
298
- <pre class="lines">
299
-
300
-
301
- 15
302
- 16
303
- 17
304
- 18
305
- 19
306
- 20
307
- 21
308
- 22</pre>
309
- </td>
310
- <td>
311
- <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationships.rb', line 15</span>
312
-
313
- <span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='rparen token'>)</span>
314
- <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span>
315
- <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='Relationships constant id'>Relationships</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='RELS_R constant id'>RELS_R</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
316
- <span class='each_with_index identifier id'>each_with_index</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='rel identifier id'>rel</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> <span class='rel identifier id'>rel</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='comma token'>,</span> <span class='dstring node'>&quot;rId#{index+1}&quot;</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span>
317
- <span class='rbrace token'>}</span>
318
- <span class='end end kw'>end</span>
319
- <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span>
320
- <span class='end end kw'>end</span>
321
- </pre>
322
- </td>
323
- </tr>
324
- </table>
325
- </div>
326
-
327
- </div>
328
-
329
- </div>
330
-
331
- <div id="footer">
332
- Generated on Mon Dec 5 14:21:17 2011 by
333
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
334
- 0.7.3 (ruby-1.8.7).
335
- </div>
336
-
337
- </body>
338
- </html>
@@ -1,300 +0,0 @@
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: Axlsx::RestrictionValidator
8
-
9
- &mdash; AXLSX
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
- relpath = '..';
19
- if (relpath != '') relpath += '/';
20
- </script>
21
-
22
- <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
23
-
24
- <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
25
-
26
-
27
- </head>
28
- <body>
29
- <script type="text/javascript" charset="utf-8">
30
- if (window.top.frames.main) document.body.className = 'frames';
31
- </script>
32
-
33
- <div id="header">
34
- <div id="menu">
35
-
36
- <a href="../_index.html">Index (R)</a> &raquo;
37
- <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span>
38
- &raquo;
39
- <span class="title">RestrictionValidator</span>
40
-
41
-
42
- <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
- </div>
44
-
45
- <div id="search">
46
-
47
- <a id="class_list_link" href="#">Class List</a>
48
-
49
- <a id="method_list_link" href="#">Method List</a>
50
-
51
- <a id="file_list_link" href="#">File List</a>
52
-
53
- </div>
54
- <div class="clear"></div>
55
- </div>
56
-
57
- <iframe id="search_frame"></iframe>
58
-
59
- <div id="content"><h1>Class: Axlsx::RestrictionValidator
60
-
61
-
62
-
63
- </h1>
64
-
65
- <dl class="box">
66
-
67
- <dt class="r1">Inherits:</dt>
68
- <dd class="r1">
69
- <span class="inheritName">Object</span>
70
-
71
- <ul class="fullTree">
72
- <li>Object</li>
73
-
74
- <li class="next">Axlsx::RestrictionValidator</li>
75
-
76
- </ul>
77
- <a href="#" class="inheritanceTree">show all</a>
78
-
79
- </dd>
80
-
81
-
82
-
83
-
84
-
85
-
86
-
87
-
88
-
89
- <dt class="r2 last">Defined in:</dt>
90
- <dd class="r2 last">lib/axlsx/util/validators.rb</dd>
91
-
92
- </dl>
93
- <div class="clear"></div>
94
-
95
- <h2>Overview</h2><div class="docstring">
96
- <div class="discussion">
97
- <p>
98
- Validate a value against a specific list of allowed values.
99
- </p>
100
-
101
-
102
- </div>
103
- </div>
104
- <div class="tags">
105
-
106
-
107
- </div>
108
-
109
-
110
-
111
-
112
-
113
- <h2>
114
- Class Method Summary
115
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
116
- </h2>
117
-
118
- <ul class="summary">
119
-
120
- <li class="public ">
121
- <span class="summary_signature">
122
-
123
- <a href="#validate-class_method" title="validate (class method)">+ (Boolean) <strong>validate</strong>(name, choices, v) </a>
124
-
125
-
126
-
127
- </span>
128
-
129
-
130
-
131
-
132
-
133
-
134
-
135
-
136
- <span class="summary_desc"><div class='inline'><p>
137
- Perform validation.
138
- </p>
139
- </div></span>
140
-
141
- </li>
142
-
143
-
144
- </ul>
145
-
146
-
147
-
148
-
149
- <div id="class_method_details" class="method_details_list">
150
- <h2>Class Method Details</h2>
151
-
152
-
153
- <div class="method_details first">
154
- <p class="signature first" id="validate-class_method">
155
-
156
- + (<tt>Boolean</tt>) <strong>validate</strong>(name, choices, v)
157
-
158
-
159
-
160
- </p><div class="docstring">
161
- <div class="discussion">
162
- <p>
163
- Perform validation
164
- </p>
165
-
166
-
167
- </div>
168
- </div>
169
- <div class="tags">
170
- <h3>Parameters:</h3>
171
- <ul class="param">
172
-
173
- <li>
174
-
175
- <span class='name'>name</span>
176
-
177
-
178
- <span class='type'>(<tt>String</tt>)</span>
179
-
180
-
181
-
182
- &mdash;
183
- <div class='inline'><p>
184
- The name of what is being validatied. This is included in the error message
185
- </p>
186
- </div>
187
-
188
- </li>
189
-
190
- <li>
191
-
192
- <span class='name'>choices</span>
193
-
194
-
195
- <span class='type'>(<tt>Array</tt>)</span>
196
-
197
-
198
-
199
- &mdash;
200
- <div class='inline'><p>
201
- The list of choices to validate against
202
- </p>
203
- </div>
204
-
205
- </li>
206
-
207
- <li>
208
-
209
- <span class='name'>v</span>
210
-
211
-
212
- <span class='type'>(<tt>Any</tt>)</span>
213
-
214
-
215
-
216
- &mdash;
217
- <div class='inline'><p>
218
- The value to be validated
219
- </p>
220
- </div>
221
-
222
- </li>
223
-
224
- </ul>
225
-
226
- <h3>Returns:</h3>
227
- <ul class="return">
228
-
229
- <li>
230
-
231
-
232
- <span class='type'>(<tt>Boolean</tt>)</span>
233
-
234
-
235
-
236
- &mdash;
237
- <div class='inline'><p>
238
- true if validation succeeds.
239
- </p>
240
- </div>
241
-
242
- </li>
243
-
244
- </ul>
245
- <h3>Raises:</h3>
246
- <ul class="raise">
247
-
248
- <li>
249
-
250
-
251
- <span class='type'>(<tt>ArgumentError</tt>)</span>
252
-
253
-
254
-
255
- &mdash;
256
- <div class='inline'><p>
257
- Raised if the value provided is not in the list of choices.
258
- </p>
259
- </div>
260
-
261
- </li>
262
-
263
- </ul>
264
-
265
- </div><table class="source_code">
266
- <tr>
267
- <td>
268
- <pre class="lines">
269
-
270
-
271
- 10
272
- 11
273
- 12
274
- 13</pre>
275
- </td>
276
- <td>
277
- <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 10</span>
278
-
279
- <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='choices identifier id'>choices</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='rparen token'>)</span>
280
- <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='lparen token'>(</span><span class='ERR_RESTRICTION constant id'>ERR_RESTRICTION</span> <span class='mod op'>%</span> <span class='lbrack token'>[</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='comma token'>,</span> <span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='choices identifier id'>choices</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='choices identifier id'>choices</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span>
281
- <span class='true true kw'>true</span>
282
- <span class='end end kw'>end</span>
283
- </pre>
284
- </td>
285
- </tr>
286
- </table>
287
- </div>
288
-
289
- </div>
290
-
291
- </div>
292
-
293
- <div id="footer">
294
- Generated on Mon Dec 5 14:21:12 2011 by
295
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
296
- 0.7.3 (ruby-1.8.7).
297
- </div>
298
-
299
- </body>
300
- </html>