acts_as_xlsx 1.0.3 → 1.0.4

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,229 +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
- Module: Axlsx::Ar
8
-
9
- &mdash; acts_as_xlsx: a rails plug in for 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 (A)</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">Ar</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>Module: Axlsx::Ar
60
-
61
-
62
-
63
- </h1>
64
-
65
- <dl class="box">
66
-
67
-
68
-
69
-
70
-
71
-
72
-
73
-
74
- <dt class="r1 last">Defined in:</dt>
75
- <dd class="r1 last">lib/acts_as_xlsx/ar.rb<span class="defines">,<br />
76
- lib/acts_as_xlsx/version.rb</span>
77
- </dd>
78
-
79
- </dl>
80
- <div class="clear"></div>
81
-
82
- <h2>Overview</h2><div class="docstring">
83
- <div class="discussion">
84
- <h3>Overview</h3>
85
- <p>
86
- This module defines the acts_as_xlsx class method and provides to_xlsx
87
- support to both AR classes and instances
88
- </p>
89
-
90
-
91
- </div>
92
- </div>
93
- <div class="tags">
94
-
95
-
96
- </div><h2>Defined Under Namespace</h2>
97
- <p class="children">
98
-
99
-
100
- <strong class="modules">Modules:</strong> <span class='object_link'><a href="Ar/ClassMethods.html" title="Axlsx::Ar::ClassMethods (module)">ClassMethods</a></span>, <span class='object_link'><a href="Ar/SingletonMethods.html" title="Axlsx::Ar::SingletonMethods (module)">SingletonMethods</a></span>
101
-
102
-
103
-
104
-
105
- </p>
106
-
107
- <h2>Constant Summary</h2>
108
-
109
- <dl class="constants">
110
-
111
- <dt id="VERSION-constant" class="">VERSION =
112
- <div class="docstring">
113
- <div class="discussion">
114
- <p>
115
- The current version of the gem
116
- </p>
117
-
118
-
119
- </div>
120
- </div>
121
- <div class="tags">
122
-
123
-
124
- </div>
125
- </dt>
126
- <dd><pre class="code"><span class='string val'>&quot;1.0.3&quot;</span>
127
- </pre></dd>
128
-
129
- </dl>
130
-
131
-
132
-
133
-
134
-
135
-
136
-
137
- <h2>
138
- Class 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="#included-class_method" title="included (class method)">+ (Object) <strong>included</strong>(base) </a>
148
-
149
-
150
-
151
- </span>
152
-
153
-
154
-
155
-
156
-
157
-
158
-
159
-
160
- <span class="summary_desc"><div class='inline'><p>
161
- :nodoc:.
162
- </p>
163
- </div></span>
164
-
165
- </li>
166
-
167
-
168
- </ul>
169
-
170
-
171
-
172
-
173
- <div id="class_method_details" class="method_details_list">
174
- <h2>Class Method Details</h2>
175
-
176
-
177
- <div class="method_details first">
178
- <p class="signature first" id="included-class_method">
179
-
180
- + (<tt>Object</tt>) <strong>included</strong>(base)
181
-
182
-
183
-
184
- </p><div class="docstring">
185
- <div class="discussion">
186
- <p>
187
- :nodoc:
188
- </p>
189
-
190
-
191
- </div>
192
- </div>
193
- <div class="tags">
194
-
195
-
196
- </div><table class="source_code">
197
- <tr>
198
- <td>
199
- <pre class="lines">
200
-
201
-
202
- 15
203
- 16
204
- 17</pre>
205
- </td>
206
- <td>
207
- <pre class="code"><span class="info file"># File 'lib/acts_as_xlsx/ar.rb', line 15</span>
208
-
209
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_included identifier id'>included</span><span class='lparen token'>(</span><span class='rubyid_base identifier id'>base</span><span class='rparen token'>)</span> <span class='comment val'># :nodoc:</span>
210
- <span class='rubyid_base identifier id'>base</span><span class='dot token'>.</span><span class='rubyid_send identifier id'>send</span> <span class='symbol val'>:extend</span><span class='comma token'>,</span> <span class='rubyid_ClassMethods constant id'>ClassMethods</span>
211
- <span class='rubyid_end end kw'>end</span>
212
- </pre>
213
- </td>
214
- </tr>
215
- </table>
216
- </div>
217
-
218
- </div>
219
-
220
- </div>
221
-
222
- <div id="footer">
223
- Generated on Tue Dec 6 18:49:19 2011 by
224
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
225
- 0.7.4 (ruby-1.8.7).
226
- </div>
227
-
228
- </body>
229
- </html>
@@ -1,267 +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
- Module: Axlsx::Ar::ClassMethods
8
-
9
- &mdash; acts_as_xlsx: a rails plug in for 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 (C)</a> &raquo;
37
- <span class='title'><span class='object_link'><a href="../../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Ar.html" title="Axlsx::Ar (module)">Ar</a></span></span>
38
- &raquo;
39
- <span class="title">ClassMethods</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>Module: Axlsx::Ar::ClassMethods
60
-
61
-
62
-
63
- </h1>
64
-
65
- <dl class="box">
66
-
67
-
68
-
69
-
70
-
71
-
72
-
73
-
74
- <dt class="r1 last">Defined in:</dt>
75
- <dd class="r1 last">lib/acts_as_xlsx/ar.rb</dd>
76
-
77
- </dl>
78
- <div class="clear"></div>
79
-
80
- <h2>Overview</h2><div class="docstring">
81
- <div class="discussion">
82
- <p>
83
- Class methods for the mixin
84
- </p>
85
-
86
-
87
- </div>
88
- </div>
89
- <div class="tags">
90
-
91
-
92
- </div>
93
-
94
-
95
-
96
-
97
-
98
- <h2>
99
- Instance Method Summary
100
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
101
- </h2>
102
-
103
- <ul class="summary">
104
-
105
- <li class="public ">
106
- <span class="summary_signature">
107
-
108
- <a href="#acts_as_xlsx-instance_method" title="#acts_as_xlsx (instance method)">- (Object) <strong>acts_as_xlsx</strong>(options = {}) </a>
109
-
110
-
111
-
112
- </span>
113
-
114
-
115
-
116
-
117
-
118
-
119
-
120
-
121
- <span class="summary_desc"><div class='inline'><p>
122
- defines the class method to inject to_xlsx.
123
- </p>
124
- </div></span>
125
-
126
- </li>
127
-
128
-
129
- </ul>
130
-
131
-
132
-
133
-
134
- <div id="instance_method_details" class="method_details_list">
135
- <h2>Instance Method Details</h2>
136
-
137
-
138
- <div class="method_details first">
139
- <p class="signature first" id="acts_as_xlsx-instance_method">
140
-
141
- - (<tt>Object</tt>) <strong>acts_as_xlsx</strong>(options = {})
142
-
143
-
144
-
145
- </p><div class="docstring">
146
- <div class="discussion">
147
- <p>
148
- defines the class method to inject to_xlsx
149
- </p>
150
-
151
-
152
- </div>
153
- </div>
154
- <div class="tags">
155
-
156
- <div class="examples">
157
- <h3>Examples:</h3>
158
-
159
- <h4><div class='inline'></div></h4>
160
- <pre class="example code"><span class='rubyid_class class kw'>class</span> <span class='rubyid_MyModel constant id'>MyModel</span> <span class='lt op'>&lt;</span> <span class='rubyid_ActiveRecord constant id'>ActiveRecord</span><span class='colon2 op'>::</span><span class='rubyid_Base constant id'>Base</span>
161
- <span class='rubyid_acts_as_xlsx identifier id'>acts_as_xlsx</span> <span class='symbol val'>:columns=</span><span class='gt op'>&gt;</span> <span class='lbrack token'>[</span><span class='symbol val'>:id</span><span class='comma token'>,</span> <span class='symbol val'>:created_at</span><span class='comma token'>,</span> <span class='symbol val'>:updated_at</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:i18n</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'activerecord.attributes'</span>
162
- </pre>
163
-
164
- </div>
165
- <h3>Parameters:</h3>
166
- <ul class="param">
167
-
168
- <li>
169
-
170
- <span class='name'>options</span>
171
-
172
-
173
- <span class='type'>(<tt>Hash</tt>)</span>
174
-
175
-
176
- <em class="default">(defaults to: <tt>{}</tt>)</em>
177
-
178
-
179
- &mdash;
180
- <div class='inline'><p>
181
- a customizable set of options
182
- </p>
183
- </div>
184
-
185
- </li>
186
-
187
- </ul>
188
-
189
-
190
-
191
-
192
- <h3>Options Hash (<tt>options</tt>):</h3>
193
- <ul class="option">
194
-
195
- <li>
196
- <span class="name">columns</span>
197
- <span class="type">(<tt>Array</tt>, <tt>Symbol</tt>)</span>
198
- <span class="default">
199
-
200
- </span>
201
- &mdash; <div class='inline'><p>
202
- an array of symbols defining the columns and methods to call in generating
203
- sheet data for each row.
204
- </p>
205
- </div>
206
- </li>
207
-
208
- <li>
209
- <span class="name">i18n</span>
210
- <span class="type">(<tt>String</tt>)</span>
211
- <span class="default">
212
-
213
- &mdash; default:
214
- <tt>default nil</tt>
215
-
216
- </span>
217
- &mdash; <div class='inline'><p>
218
- The path to search for localization. When this is specified your i18n.t
219
- will be used to determine the labels for columns.
220
- </p>
221
- </div>
222
- </li>
223
-
224
- </ul>
225
-
226
-
227
-
228
- </div><table class="source_code">
229
- <tr>
230
- <td>
231
- <pre class="lines">
232
-
233
-
234
- 28
235
- 29
236
- 30
237
- 31
238
- 32
239
- 33</pre>
240
- </td>
241
- <td>
242
- <pre class="code"><span class="info file"># File 'lib/acts_as_xlsx/ar.rb', line 28</span>
243
-
244
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_acts_as_xlsx identifier id'>acts_as_xlsx</span><span class='lparen token'>(</span><span class='rubyid_options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
245
- <span class='rubyid_cattr_accessor identifier id'>cattr_accessor</span> <span class='symbol val'>:xlsx_i18n</span><span class='comma token'>,</span> <span class='symbol val'>:xlsx_columns</span>
246
- <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_xlsx_i18n identifier id'>xlsx_i18n</span> <span class='assign token'>=</span> <span class='rubyid_options identifier id'>options</span><span class='dot token'>.</span><span class='rubyid_delete identifier id'>delete</span><span class='lparen token'>(</span><span class='symbol val'>:i18n</span><span class='rparen token'>)</span> <span class='orop op'>||</span> <span class='rubyid_false false kw'>false</span>
247
- <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_xlsx_columns identifier id'>xlsx_columns</span> <span class='assign token'>=</span> <span class='rubyid_options identifier id'>options</span><span class='dot token'>.</span><span class='rubyid_delete identifier id'>delete</span><span class='lparen token'>(</span><span class='symbol val'>:columns</span><span class='rparen token'>)</span> <span class='orop op'>||</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_column_names identifier id'>column_names</span><span class='dot token'>.</span><span class='rubyid_map identifier id'>map</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='rubyid_c identifier id'>c</span><span class='bitor op'>|</span> <span class='rubyid_c identifier id'>c</span> <span class='assign token'>=</span> <span class='rubyid_c identifier id'>c</span><span class='dot token'>.</span><span class='rubyid_to_sym identifier id'>to_sym</span> <span class='rbrace token'>}</span>
248
- <span class='rubyid_extend identifier id'>extend</span> <span class='rubyid_Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='rubyid_Ar constant id'>Ar</span><span class='colon2 op'>::</span><span class='rubyid_SingletonMethods constant id'>SingletonMethods</span>
249
- <span class='rubyid_end end kw'>end</span>
250
- </pre>
251
- </td>
252
- </tr>
253
- </table>
254
- </div>
255
-
256
- </div>
257
-
258
- </div>
259
-
260
- <div id="footer">
261
- Generated on Tue Dec 6 18:49:19 2011 by
262
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
263
- 0.7.4 (ruby-1.8.7).
264
- </div>
265
-
266
- </body>
267
- </html>