scharfie-rails-footnotes 3.4.2 → 3.5.0
Sign up to get free protection for your applications and to get access to all the features.
- data/VERSION +1 -0
- data/pkg/scharfie-rails-footnotes-3.4.2.gem +0 -0
- data/rdoc/classes/ActionController.html +107 -0
- data/rdoc/classes/ActionController/Base.html +119 -0
- data/rdoc/classes/Footnotes.html +186 -0
- data/rdoc/classes/Footnotes/Components.html +211 -0
- data/rdoc/classes/Footnotes/Extensions.html +128 -0
- data/rdoc/classes/Footnotes/Extensions/AbstractAdapter.html +148 -0
- data/rdoc/classes/Footnotes/Extensions/Exception.html +205 -0
- data/rdoc/classes/Footnotes/Extensions/MockController.html +111 -0
- data/rdoc/classes/Footnotes/Extensions/QueryAnalyzer.html +183 -0
- data/rdoc/classes/Footnotes/Extensions/Routes.html +148 -0
- data/rdoc/classes/Footnotes/Extensions/Sql.html +191 -0
- data/rdoc/classes/Footnotes/Filter.html +928 -0
- data/rdoc/classes/Footnotes/Notes.html +194 -0
- data/rdoc/classes/Footnotes/Notes/AbstractNote.html +698 -0
- data/rdoc/classes/Footnotes/Notes/ComponentsNote.html +221 -0
- data/rdoc/classes/Footnotes/Notes/ComponentsNote/ClassMethods.html +164 -0
- data/rdoc/classes/Footnotes/Notes/ControllerComponentNote.html +120 -0
- data/rdoc/classes/Footnotes/Notes/ControllerNote.html +361 -0
- data/rdoc/classes/Footnotes/Notes/CookiesNote.html +198 -0
- data/rdoc/classes/Footnotes/Notes/EnvNote.html +178 -0
- data/rdoc/classes/Footnotes/Notes/FilesNote.html +284 -0
- data/rdoc/classes/Footnotes/Notes/FiltersNote.html +291 -0
- data/rdoc/classes/Footnotes/Notes/GeneralNote.html +196 -0
- data/rdoc/classes/Footnotes/Notes/JavascriptsNote.html +174 -0
- data/rdoc/classes/Footnotes/Notes/LayoutNote.html +248 -0
- data/rdoc/classes/Footnotes/Notes/LogNote.html +216 -0
- data/rdoc/classes/Footnotes/Notes/ParamsComponentNote.html +120 -0
- data/rdoc/classes/Footnotes/Notes/ParamsNote.html +198 -0
- data/rdoc/classes/Footnotes/Notes/QueriesNote.html +384 -0
- data/rdoc/classes/Footnotes/Notes/RoutesNote.html +240 -0
- data/rdoc/classes/Footnotes/Notes/SessionNote.html +174 -0
- data/rdoc/classes/Footnotes/Notes/StylesheetsNote.html +174 -0
- data/rdoc/classes/Footnotes/Notes/ViewComponentNote.html +120 -0
- data/rdoc/classes/Footnotes/Notes/ViewNote.html +273 -0
- data/rdoc/created.rid +1 -0
- data/rdoc/files/README.html +118 -0
- data/rdoc/files/lib/rails-footnotes/backtracer_rb.html +101 -0
- data/rdoc/files/lib/rails-footnotes/footnotes_rb.html +101 -0
- data/rdoc/files/lib/rails-footnotes/notes/abstract_note_rb.html +101 -0
- data/rdoc/files/lib/rails-footnotes/notes/components_note_rb.html +101 -0
- data/rdoc/files/lib/rails-footnotes/notes/controller_note_rb.html +101 -0
- data/rdoc/files/lib/rails-footnotes/notes/cookies_note_rb.html +101 -0
- data/rdoc/files/lib/rails-footnotes/notes/env_note_rb.html +101 -0
- data/rdoc/files/lib/rails-footnotes/notes/files_note_rb.html +101 -0
- data/rdoc/files/lib/rails-footnotes/notes/filters_note_rb.html +101 -0
- data/rdoc/files/lib/rails-footnotes/notes/general_note_rb.html +101 -0
- data/rdoc/files/lib/rails-footnotes/notes/javascripts_note_rb.html +101 -0
- data/rdoc/files/lib/rails-footnotes/notes/layout_note_rb.html +101 -0
- data/rdoc/files/lib/rails-footnotes/notes/log_note_rb.html +101 -0
- data/rdoc/files/lib/rails-footnotes/notes/params_note_rb.html +101 -0
- data/rdoc/files/lib/rails-footnotes/notes/queries_note_rb.html +101 -0
- data/rdoc/files/lib/rails-footnotes/notes/routes_note_rb.html +101 -0
- data/rdoc/files/lib/rails-footnotes/notes/session_note_rb.html +101 -0
- data/rdoc/files/lib/rails-footnotes/notes/stylesheets_note_rb.html +101 -0
- data/rdoc/files/lib/rails-footnotes/notes/view_note_rb.html +101 -0
- data/rdoc/files/lib/rails-footnotes_rb.html +101 -0
- data/rdoc/fr_class_index.html +60 -0
- data/rdoc/fr_file_index.html +47 -0
- data/rdoc/fr_method_index.html +156 -0
- data/rdoc/index.html +24 -0
- data/rdoc/rdoc-style.css +208 -0
- data/scharfie-rails-footnotes.gemspec +142 -0
- metadata +66 -3
- data/rails-footnotes.gemspec +0 -46
@@ -0,0 +1,928 @@
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
2
|
+
<!DOCTYPE html
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
5
|
+
|
6
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
7
|
+
<head>
|
8
|
+
<title>Class: Footnotes::Filter</title>
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
10
|
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
11
|
+
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
|
12
|
+
<script type="text/javascript">
|
13
|
+
// <![CDATA[
|
14
|
+
|
15
|
+
function popupCode( url ) {
|
16
|
+
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
|
17
|
+
}
|
18
|
+
|
19
|
+
function toggleCode( id ) {
|
20
|
+
if ( document.getElementById )
|
21
|
+
elem = document.getElementById( id );
|
22
|
+
else if ( document.all )
|
23
|
+
elem = eval( "document.all." + id );
|
24
|
+
else
|
25
|
+
return false;
|
26
|
+
|
27
|
+
elemStyle = elem.style;
|
28
|
+
|
29
|
+
if ( elemStyle.display != "block" ) {
|
30
|
+
elemStyle.display = "block"
|
31
|
+
} else {
|
32
|
+
elemStyle.display = "none"
|
33
|
+
}
|
34
|
+
|
35
|
+
return true;
|
36
|
+
}
|
37
|
+
|
38
|
+
// Make codeblocks hidden by default
|
39
|
+
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
|
40
|
+
|
41
|
+
// ]]>
|
42
|
+
</script>
|
43
|
+
|
44
|
+
</head>
|
45
|
+
<body>
|
46
|
+
|
47
|
+
|
48
|
+
|
49
|
+
<div id="classHeader">
|
50
|
+
<table class="header-table">
|
51
|
+
<tr class="top-aligned-row">
|
52
|
+
<td><strong>Class</strong></td>
|
53
|
+
<td class="class-name-in-header">Footnotes::Filter</td>
|
54
|
+
</tr>
|
55
|
+
<tr class="top-aligned-row">
|
56
|
+
<td><strong>In:</strong></td>
|
57
|
+
<td>
|
58
|
+
<a href="../../files/lib/rails-footnotes/footnotes_rb.html">
|
59
|
+
lib/rails-footnotes/footnotes.rb
|
60
|
+
</a>
|
61
|
+
<br />
|
62
|
+
</td>
|
63
|
+
</tr>
|
64
|
+
|
65
|
+
<tr class="top-aligned-row">
|
66
|
+
<td><strong>Parent:</strong></td>
|
67
|
+
<td>
|
68
|
+
Object
|
69
|
+
</td>
|
70
|
+
</tr>
|
71
|
+
</table>
|
72
|
+
</div>
|
73
|
+
<!-- banner header -->
|
74
|
+
|
75
|
+
<div id="bodyContent">
|
76
|
+
|
77
|
+
|
78
|
+
|
79
|
+
<div id="contextContent">
|
80
|
+
|
81
|
+
|
82
|
+
|
83
|
+
</div>
|
84
|
+
|
85
|
+
<div id="method-list">
|
86
|
+
<h3 class="section-bar">Methods</h3>
|
87
|
+
|
88
|
+
<div class="name-list">
|
89
|
+
<a href="#M000111">add_footnotes!</a>
|
90
|
+
<a href="#M000114">add_footnotes_without_validation!</a>
|
91
|
+
<a href="#M000105">after</a>
|
92
|
+
<a href="#M000104">before</a>
|
93
|
+
<a href="#M000126">close</a>
|
94
|
+
<a href="#M000112">close!</a>
|
95
|
+
<a href="#M000127">close_helper</a>
|
96
|
+
<a href="#M000119">component_request?</a>
|
97
|
+
<a href="#M000107">each_with_rescue</a>
|
98
|
+
<a href="#M000130">each_with_rescue</a>
|
99
|
+
<a href="#M000125">fieldsets</a>
|
100
|
+
<a href="#M000115">initialize_notes!</a>
|
101
|
+
<a href="#M000123">insert_footnotes</a>
|
102
|
+
<a href="#M000122">insert_styles</a>
|
103
|
+
<a href="#M000129">insert_text</a>
|
104
|
+
<a href="#M000128">link_helper</a>
|
105
|
+
<a href="#M000124">links</a>
|
106
|
+
<a href="#M000108">log_error</a>
|
107
|
+
<a href="#M000110">new</a>
|
108
|
+
<a href="#M000116">performed_render?</a>
|
109
|
+
<a href="#M000109">prefix</a>
|
110
|
+
<a href="#M000121">read_asset</a>
|
111
|
+
<a href="#M000106">start!</a>
|
112
|
+
<a href="#M000113">valid?</a>
|
113
|
+
<a href="#M000118">valid_content_type?</a>
|
114
|
+
<a href="#M000117">valid_format?</a>
|
115
|
+
<a href="#M000120">xhr?</a>
|
116
|
+
</div>
|
117
|
+
</div>
|
118
|
+
|
119
|
+
</div>
|
120
|
+
|
121
|
+
|
122
|
+
<!-- if includes -->
|
123
|
+
|
124
|
+
<div id="section">
|
125
|
+
|
126
|
+
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
<!-- if method_list -->
|
134
|
+
<div id="methods">
|
135
|
+
<h3 class="section-bar">Public Class methods</h3>
|
136
|
+
|
137
|
+
<div id="method-M000105" class="method-detail">
|
138
|
+
<a name="M000105"></a>
|
139
|
+
|
140
|
+
<div class="method-heading">
|
141
|
+
<a href="#M000105" class="method-signature">
|
142
|
+
<span class="method-name">after</span><span class="method-args">(controller)</span>
|
143
|
+
</a>
|
144
|
+
</div>
|
145
|
+
|
146
|
+
<div class="method-description">
|
147
|
+
<p>
|
148
|
+
Method that calls <a href="../Footnotes.html">Footnotes</a> to attach its
|
149
|
+
contents
|
150
|
+
</p>
|
151
|
+
<p><a class="source-toggle" href="#"
|
152
|
+
onclick="toggleCode('M000105-source');return false;">[Source]</a></p>
|
153
|
+
<div class="method-source-code" id="M000105-source">
|
154
|
+
<pre>
|
155
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 31</span>
|
156
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">after</span>(<span class="ruby-identifier">controller</span>)
|
157
|
+
<span class="ruby-identifier">filter</span> = <span class="ruby-constant">Footnotes</span><span class="ruby-operator">::</span><span class="ruby-constant">Filter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">controller</span>)
|
158
|
+
<span class="ruby-identifier">filter</span>.<span class="ruby-identifier">add_footnotes!</span>
|
159
|
+
<span class="ruby-identifier">filter</span>.<span class="ruby-identifier">close!</span>(<span class="ruby-identifier">controller</span>)
|
160
|
+
<span class="ruby-keyword kw">end</span>
|
161
|
+
</pre>
|
162
|
+
</div>
|
163
|
+
</div>
|
164
|
+
</div>
|
165
|
+
|
166
|
+
<div id="method-M000104" class="method-detail">
|
167
|
+
<a name="M000104"></a>
|
168
|
+
|
169
|
+
<div class="method-heading">
|
170
|
+
<a href="#M000104" class="method-signature">
|
171
|
+
<span class="method-name">before</span><span class="method-args">(controller)</span>
|
172
|
+
</a>
|
173
|
+
</div>
|
174
|
+
|
175
|
+
<div class="method-description">
|
176
|
+
<p>
|
177
|
+
Method called to start the notes It‘s a <a
|
178
|
+
href="Filter.html#M000104">before</a> filter prepend in the controller
|
179
|
+
</p>
|
180
|
+
<p><a class="source-toggle" href="#"
|
181
|
+
onclick="toggleCode('M000104-source');return false;">[Source]</a></p>
|
182
|
+
<div class="method-source-code" id="M000104-source">
|
183
|
+
<pre>
|
184
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 25</span>
|
185
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">before</span>(<span class="ruby-identifier">controller</span>)
|
186
|
+
<span class="ruby-constant">Footnotes</span><span class="ruby-operator">::</span><span class="ruby-constant">Filter</span>.<span class="ruby-identifier">start!</span>(<span class="ruby-identifier">controller</span>)
|
187
|
+
<span class="ruby-keyword kw">end</span>
|
188
|
+
</pre>
|
189
|
+
</div>
|
190
|
+
</div>
|
191
|
+
</div>
|
192
|
+
|
193
|
+
<div id="method-M000107" class="method-detail">
|
194
|
+
<a name="M000107"></a>
|
195
|
+
|
196
|
+
<div class="method-heading">
|
197
|
+
<a href="#M000107" class="method-signature">
|
198
|
+
<span class="method-name">each_with_rescue</span><span class="method-args">(notes) {|note| ...}</span>
|
199
|
+
</a>
|
200
|
+
</div>
|
201
|
+
|
202
|
+
<div class="method-description">
|
203
|
+
<p>
|
204
|
+
Process notes, discarding only the note if any problem occurs
|
205
|
+
</p>
|
206
|
+
<p><a class="source-toggle" href="#"
|
207
|
+
onclick="toggleCode('M000107-source');return false;">[Source]</a></p>
|
208
|
+
<div class="method-source-code" id="M000107-source">
|
209
|
+
<pre>
|
210
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 53</span>
|
211
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">each_with_rescue</span>(<span class="ruby-identifier">notes</span>)
|
212
|
+
<span class="ruby-identifier">delete_me</span> = []
|
213
|
+
|
214
|
+
<span class="ruby-identifier">notes</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">note</span><span class="ruby-operator">|</span>
|
215
|
+
<span class="ruby-keyword kw">begin</span>
|
216
|
+
<span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">note</span>
|
217
|
+
<span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
|
218
|
+
<span class="ruby-comment cmt"># Discard note if it has a problem</span>
|
219
|
+
<span class="ruby-identifier">log_error</span>(<span class="ruby-node">"Footnotes #{note.to_s.camelize}Note Exception"</span>, <span class="ruby-identifier">e</span>)
|
220
|
+
<span class="ruby-identifier">delete_me</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">note</span>
|
221
|
+
<span class="ruby-keyword kw">next</span>
|
222
|
+
<span class="ruby-keyword kw">end</span>
|
223
|
+
<span class="ruby-keyword kw">end</span>
|
224
|
+
|
225
|
+
<span class="ruby-identifier">delete_me</span>.<span class="ruby-identifier">each</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">note</span><span class="ruby-operator">|</span> <span class="ruby-identifier">notes</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">note</span>) }
|
226
|
+
<span class="ruby-keyword kw">return</span> <span class="ruby-identifier">notes</span>
|
227
|
+
<span class="ruby-keyword kw">end</span>
|
228
|
+
</pre>
|
229
|
+
</div>
|
230
|
+
</div>
|
231
|
+
</div>
|
232
|
+
|
233
|
+
<div id="method-M000108" class="method-detail">
|
234
|
+
<a name="M000108"></a>
|
235
|
+
|
236
|
+
<div class="method-heading">
|
237
|
+
<a href="#M000108" class="method-signature">
|
238
|
+
<span class="method-name">log_error</span><span class="method-args">(title, exception)</span>
|
239
|
+
</a>
|
240
|
+
</div>
|
241
|
+
|
242
|
+
<div class="method-description">
|
243
|
+
<p>
|
244
|
+
Logs the error using specified title and format
|
245
|
+
</p>
|
246
|
+
<p><a class="source-toggle" href="#"
|
247
|
+
onclick="toggleCode('M000108-source');return false;">[Source]</a></p>
|
248
|
+
<div class="method-source-code" id="M000108-source">
|
249
|
+
<pre>
|
250
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 73</span>
|
251
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log_error</span>(<span class="ruby-identifier">title</span>, <span class="ruby-identifier">exception</span>)
|
252
|
+
<span class="ruby-constant">RAILS_DEFAULT_LOGGER</span>.<span class="ruby-identifier">error</span> <span class="ruby-node">"#{title}: #{exception}\n#{exception.backtrace.join("\n")}"</span>
|
253
|
+
<span class="ruby-keyword kw">end</span>
|
254
|
+
</pre>
|
255
|
+
</div>
|
256
|
+
</div>
|
257
|
+
</div>
|
258
|
+
|
259
|
+
<div id="method-M000110" class="method-detail">
|
260
|
+
<a name="M000110"></a>
|
261
|
+
|
262
|
+
<div class="method-heading">
|
263
|
+
<a href="#M000110" class="method-signature">
|
264
|
+
<span class="method-name">new</span><span class="method-args">(controller)</span>
|
265
|
+
</a>
|
266
|
+
</div>
|
267
|
+
|
268
|
+
<div class="method-description">
|
269
|
+
<p><a class="source-toggle" href="#"
|
270
|
+
onclick="toggleCode('M000110-source');return false;">[Source]</a></p>
|
271
|
+
<div class="method-source-code" id="M000110-source">
|
272
|
+
<pre>
|
273
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 90</span>
|
274
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">controller</span>)
|
275
|
+
<span class="ruby-ivar">@controller</span> = <span class="ruby-identifier">controller</span>
|
276
|
+
<span class="ruby-ivar">@template</span> = <span class="ruby-identifier">controller</span>.<span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-identifier">:@template</span>)
|
277
|
+
<span class="ruby-ivar">@body</span> = <span class="ruby-identifier">controller</span>.<span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>
|
278
|
+
<span class="ruby-ivar">@notes</span> = []
|
279
|
+
<span class="ruby-keyword kw">end</span>
|
280
|
+
</pre>
|
281
|
+
</div>
|
282
|
+
</div>
|
283
|
+
</div>
|
284
|
+
|
285
|
+
<div id="method-M000109" class="method-detail">
|
286
|
+
<a name="M000109"></a>
|
287
|
+
|
288
|
+
<div class="method-heading">
|
289
|
+
<a href="#M000109" class="method-signature">
|
290
|
+
<span class="method-name">prefix</span><span class="method-args">(*args)</span>
|
291
|
+
</a>
|
292
|
+
</div>
|
293
|
+
|
294
|
+
<div class="method-description">
|
295
|
+
<p>
|
296
|
+
If none argument is sent, simply return the <a
|
297
|
+
href="Filter.html#M000109">prefix</a>. Otherwise, replace the args in the
|
298
|
+
<a href="Filter.html#M000109">prefix</a>.
|
299
|
+
</p>
|
300
|
+
<p><a class="source-toggle" href="#"
|
301
|
+
onclick="toggleCode('M000109-source');return false;">[Source]</a></p>
|
302
|
+
<div class="method-source-code" id="M000109-source">
|
303
|
+
<pre>
|
304
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 80</span>
|
305
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">prefix</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
306
|
+
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">empty?</span>
|
307
|
+
<span class="ruby-ivar">@@prefix</span>
|
308
|
+
<span class="ruby-keyword kw">else</span>
|
309
|
+
<span class="ruby-identifier">format</span>(<span class="ruby-ivar">@@prefix</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
310
|
+
<span class="ruby-keyword kw">end</span>
|
311
|
+
<span class="ruby-keyword kw">end</span>
|
312
|
+
</pre>
|
313
|
+
</div>
|
314
|
+
</div>
|
315
|
+
</div>
|
316
|
+
|
317
|
+
<div id="method-M000106" class="method-detail">
|
318
|
+
<a name="M000106"></a>
|
319
|
+
|
320
|
+
<div class="method-heading">
|
321
|
+
<a href="#M000106" class="method-signature">
|
322
|
+
<span class="method-name">start!</span><span class="method-args">(controller)</span>
|
323
|
+
</a>
|
324
|
+
</div>
|
325
|
+
|
326
|
+
<div class="method-description">
|
327
|
+
<p>
|
328
|
+
Calls the class method <a href="Filter.html#M000106">start!</a> in each
|
329
|
+
note Sometimes notes need to set variables or clean the environment to work
|
330
|
+
properly This method allows this kind of setup
|
331
|
+
</p>
|
332
|
+
<p><a class="source-toggle" href="#"
|
333
|
+
onclick="toggleCode('M000106-source');return false;">[Source]</a></p>
|
334
|
+
<div class="method-source-code" id="M000106-source">
|
335
|
+
<pre>
|
336
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 41</span>
|
337
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start!</span>(<span class="ruby-identifier">controller</span>)
|
338
|
+
<span class="ruby-ivar">@@klasses</span> = []
|
339
|
+
|
340
|
+
<span class="ruby-identifier">each_with_rescue</span>(<span class="ruby-ivar">@@notes</span>.<span class="ruby-identifier">flatten</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">note</span><span class="ruby-operator">|</span>
|
341
|
+
<span class="ruby-identifier">klass</span> = <span class="ruby-node">"Footnotes::Notes::#{note.to_s.camelize}Note"</span>.<span class="ruby-identifier">constantize</span>
|
342
|
+
<span class="ruby-identifier">klass</span>.<span class="ruby-identifier">start!</span>(<span class="ruby-identifier">controller</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">:start!</span>)
|
343
|
+
<span class="ruby-ivar">@@klasses</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">klass</span>
|
344
|
+
<span class="ruby-keyword kw">end</span>
|
345
|
+
<span class="ruby-keyword kw">end</span>
|
346
|
+
</pre>
|
347
|
+
</div>
|
348
|
+
</div>
|
349
|
+
</div>
|
350
|
+
|
351
|
+
<h3 class="section-bar">Public Instance methods</h3>
|
352
|
+
|
353
|
+
<div id="method-M000111" class="method-detail">
|
354
|
+
<a name="M000111"></a>
|
355
|
+
|
356
|
+
<div class="method-heading">
|
357
|
+
<a href="#M000111" class="method-signature">
|
358
|
+
<span class="method-name">add_footnotes!</span><span class="method-args">()</span>
|
359
|
+
</a>
|
360
|
+
</div>
|
361
|
+
|
362
|
+
<div class="method-description">
|
363
|
+
<p><a class="source-toggle" href="#"
|
364
|
+
onclick="toggleCode('M000111-source');return false;">[Source]</a></p>
|
365
|
+
<div class="method-source-code" id="M000111-source">
|
366
|
+
<pre>
|
367
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 97</span>
|
368
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_footnotes!</span>
|
369
|
+
<span class="ruby-identifier">add_footnotes_without_validation!</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">valid?</span>
|
370
|
+
<span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
|
371
|
+
<span class="ruby-comment cmt"># Discard footnotes if there are any problems</span>
|
372
|
+
<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">log_error</span>(<span class="ruby-value str">"Footnotes Exception"</span>, <span class="ruby-identifier">e</span>)
|
373
|
+
<span class="ruby-keyword kw">end</span>
|
374
|
+
</pre>
|
375
|
+
</div>
|
376
|
+
</div>
|
377
|
+
</div>
|
378
|
+
|
379
|
+
<div id="method-M000112" class="method-detail">
|
380
|
+
<a name="M000112"></a>
|
381
|
+
|
382
|
+
<div class="method-heading">
|
383
|
+
<a href="#M000112" class="method-signature">
|
384
|
+
<span class="method-name">close!</span><span class="method-args">(controller)</span>
|
385
|
+
</a>
|
386
|
+
</div>
|
387
|
+
|
388
|
+
<div class="method-description">
|
389
|
+
<p>
|
390
|
+
Calls the class method <a href="Filter.html#M000112">close!</a> in each
|
391
|
+
note Sometimes notes need to finish their work even <a
|
392
|
+
href="Filter.html#M000105">after</a> being read This method allows this
|
393
|
+
kind of work
|
394
|
+
</p>
|
395
|
+
<p><a class="source-toggle" href="#"
|
396
|
+
onclick="toggleCode('M000112-source');return false;">[Source]</a></p>
|
397
|
+
<div class="method-source-code" id="M000112-source">
|
398
|
+
<pre>
|
399
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 108</span>
|
400
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">close!</span>(<span class="ruby-identifier">controller</span>)
|
401
|
+
<span class="ruby-identifier">each_with_rescue</span>(<span class="ruby-ivar">@@klasses</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">klass</span><span class="ruby-operator">|</span>
|
402
|
+
<span class="ruby-identifier">klass</span>.<span class="ruby-identifier">close!</span>(<span class="ruby-identifier">controller</span>)
|
403
|
+
<span class="ruby-keyword kw">end</span>
|
404
|
+
<span class="ruby-keyword kw">end</span>
|
405
|
+
</pre>
|
406
|
+
</div>
|
407
|
+
</div>
|
408
|
+
</div>
|
409
|
+
|
410
|
+
<h3 class="section-bar">Protected Instance methods</h3>
|
411
|
+
|
412
|
+
<div id="method-M000114" class="method-detail">
|
413
|
+
<a name="M000114"></a>
|
414
|
+
|
415
|
+
<div class="method-heading">
|
416
|
+
<a href="#M000114" class="method-signature">
|
417
|
+
<span class="method-name">add_footnotes_without_validation!</span><span class="method-args">()</span>
|
418
|
+
</a>
|
419
|
+
</div>
|
420
|
+
|
421
|
+
<div class="method-description">
|
422
|
+
<p><a class="source-toggle" href="#"
|
423
|
+
onclick="toggleCode('M000114-source');return false;">[Source]</a></p>
|
424
|
+
<div class="method-source-code" id="M000114-source">
|
425
|
+
<pre>
|
426
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 119</span>
|
427
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_footnotes_without_validation!</span>
|
428
|
+
<span class="ruby-identifier">initialize_notes!</span>
|
429
|
+
<span class="ruby-identifier">insert_styles</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@@no_style</span>
|
430
|
+
<span class="ruby-identifier">insert_footnotes</span>
|
431
|
+
<span class="ruby-keyword kw">end</span>
|
432
|
+
</pre>
|
433
|
+
</div>
|
434
|
+
</div>
|
435
|
+
</div>
|
436
|
+
|
437
|
+
<div id="method-M000126" class="method-detail">
|
438
|
+
<a name="M000126"></a>
|
439
|
+
|
440
|
+
<div class="method-heading">
|
441
|
+
<a href="#M000126" class="method-signature">
|
442
|
+
<span class="method-name">close</span><span class="method-args">()</span>
|
443
|
+
</a>
|
444
|
+
</div>
|
445
|
+
|
446
|
+
<div class="method-description">
|
447
|
+
<p>
|
448
|
+
Process notes to get javascript code to <a
|
449
|
+
href="Filter.html#M000126">close</a> them. This method is only used when
|
450
|
+
multiple_notes is false.
|
451
|
+
</p>
|
452
|
+
<p><a class="source-toggle" href="#"
|
453
|
+
onclick="toggleCode('M000126-source');return false;">[Source]</a></p>
|
454
|
+
<div class="method-source-code" id="M000126-source">
|
455
|
+
<pre>
|
456
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 243</span>
|
457
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">close</span>
|
458
|
+
<span class="ruby-identifier">javascript</span> = <span class="ruby-value str">''</span>
|
459
|
+
<span class="ruby-identifier">each_with_rescue</span>(<span class="ruby-ivar">@notes</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">note</span><span class="ruby-operator">|</span>
|
460
|
+
<span class="ruby-keyword kw">next</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">note</span>.<span class="ruby-identifier">has_fieldset?</span>
|
461
|
+
<span class="ruby-identifier">javascript</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">close_helper</span>(<span class="ruby-identifier">note</span>)
|
462
|
+
<span class="ruby-keyword kw">end</span>
|
463
|
+
<span class="ruby-identifier">javascript</span>
|
464
|
+
<span class="ruby-keyword kw">end</span>
|
465
|
+
</pre>
|
466
|
+
</div>
|
467
|
+
</div>
|
468
|
+
</div>
|
469
|
+
|
470
|
+
<div id="method-M000127" class="method-detail">
|
471
|
+
<a name="M000127"></a>
|
472
|
+
|
473
|
+
<div class="method-heading">
|
474
|
+
<a href="#M000127" class="method-signature">
|
475
|
+
<span class="method-name">close_helper</span><span class="method-args">(note)</span>
|
476
|
+
</a>
|
477
|
+
</div>
|
478
|
+
|
479
|
+
<div class="method-description">
|
480
|
+
<p>
|
481
|
+
Helper that creates the javascript code to <a
|
482
|
+
href="Filter.html#M000126">close</a> the note
|
483
|
+
</p>
|
484
|
+
<p><a class="source-toggle" href="#"
|
485
|
+
onclick="toggleCode('M000127-source');return false;">[Source]</a></p>
|
486
|
+
<div class="method-source-code" id="M000127-source">
|
487
|
+
<pre>
|
488
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 258</span>
|
489
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">close_helper</span>(<span class="ruby-identifier">note</span>)
|
490
|
+
<span class="ruby-node">"Footnotes.hide(document.getElementById('#{note.to_sym}_debug_info'));\n"</span>
|
491
|
+
<span class="ruby-keyword kw">end</span>
|
492
|
+
</pre>
|
493
|
+
</div>
|
494
|
+
</div>
|
495
|
+
</div>
|
496
|
+
|
497
|
+
<div id="method-M000119" class="method-detail">
|
498
|
+
<a name="M000119"></a>
|
499
|
+
|
500
|
+
<div class="method-heading">
|
501
|
+
<a href="#M000119" class="method-signature">
|
502
|
+
<span class="method-name">component_request?</span><span class="method-args">()</span>
|
503
|
+
</a>
|
504
|
+
</div>
|
505
|
+
|
506
|
+
<div class="method-description">
|
507
|
+
<p><a class="source-toggle" href="#"
|
508
|
+
onclick="toggleCode('M000119-source');return false;">[Source]</a></p>
|
509
|
+
<div class="method-source-code" id="M000119-source">
|
510
|
+
<pre>
|
511
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 145</span>
|
512
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">component_request?</span>
|
513
|
+
<span class="ruby-ivar">@controller</span>.<span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-identifier">:@parent_controller</span>)
|
514
|
+
<span class="ruby-keyword kw">end</span>
|
515
|
+
</pre>
|
516
|
+
</div>
|
517
|
+
</div>
|
518
|
+
</div>
|
519
|
+
|
520
|
+
<div id="method-M000130" class="method-detail">
|
521
|
+
<a name="M000130"></a>
|
522
|
+
|
523
|
+
<div class="method-heading">
|
524
|
+
<a href="#M000130" class="method-signature">
|
525
|
+
<span class="method-name">each_with_rescue</span><span class="method-args">(*args, &block)</span>
|
526
|
+
</a>
|
527
|
+
</div>
|
528
|
+
|
529
|
+
<div class="method-description">
|
530
|
+
<p>
|
531
|
+
Instance <a href="Filter.html#M000107">each_with_rescue</a> method
|
532
|
+
</p>
|
533
|
+
<p><a class="source-toggle" href="#"
|
534
|
+
onclick="toggleCode('M000130-source');return false;">[Source]</a></p>
|
535
|
+
<div class="method-source-code" id="M000130-source">
|
536
|
+
<pre>
|
537
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 295</span>
|
538
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">each_with_rescue</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
539
|
+
<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">each_with_rescue</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
540
|
+
<span class="ruby-keyword kw">end</span>
|
541
|
+
</pre>
|
542
|
+
</div>
|
543
|
+
</div>
|
544
|
+
</div>
|
545
|
+
|
546
|
+
<div id="method-M000125" class="method-detail">
|
547
|
+
<a name="M000125"></a>
|
548
|
+
|
549
|
+
<div class="method-heading">
|
550
|
+
<a href="#M000125" class="method-signature">
|
551
|
+
<span class="method-name">fieldsets</span><span class="method-args">()</span>
|
552
|
+
</a>
|
553
|
+
</div>
|
554
|
+
|
555
|
+
<div class="method-description">
|
556
|
+
<p>
|
557
|
+
Process notes to get their content
|
558
|
+
</p>
|
559
|
+
<p><a class="source-toggle" href="#"
|
560
|
+
onclick="toggleCode('M000125-source');return false;">[Source]</a></p>
|
561
|
+
<div class="method-source-code" id="M000125-source">
|
562
|
+
<pre>
|
563
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 225</span>
|
564
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fieldsets</span>
|
565
|
+
<span class="ruby-identifier">content</span> = <span class="ruby-value str">''</span>
|
566
|
+
<span class="ruby-identifier">each_with_rescue</span>(<span class="ruby-ivar">@notes</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">note</span><span class="ruby-operator">|</span>
|
567
|
+
<span class="ruby-keyword kw">next</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">note</span>.<span class="ruby-identifier">has_fieldset?</span>
|
568
|
+
<span class="ruby-identifier">content</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"<fieldset id=\"\#{note.to_sym}_debug_info\" style=\"display: none\">\n<legend>\#{note.legend}</legend>\n<div>\#{note.content}</div>\n</fieldset>\n"</span>
|
569
|
+
<span class="ruby-keyword kw">end</span>
|
570
|
+
<span class="ruby-identifier">content</span>
|
571
|
+
<span class="ruby-keyword kw">end</span>
|
572
|
+
</pre>
|
573
|
+
</div>
|
574
|
+
</div>
|
575
|
+
</div>
|
576
|
+
|
577
|
+
<div id="method-M000115" class="method-detail">
|
578
|
+
<a name="M000115"></a>
|
579
|
+
|
580
|
+
<div class="method-heading">
|
581
|
+
<a href="#M000115" class="method-signature">
|
582
|
+
<span class="method-name">initialize_notes!</span><span class="method-args">()</span>
|
583
|
+
</a>
|
584
|
+
</div>
|
585
|
+
|
586
|
+
<div class="method-description">
|
587
|
+
<p><a class="source-toggle" href="#"
|
588
|
+
onclick="toggleCode('M000115-source');return false;">[Source]</a></p>
|
589
|
+
<div class="method-source-code" id="M000115-source">
|
590
|
+
<pre>
|
591
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 125</span>
|
592
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize_notes!</span>
|
593
|
+
<span class="ruby-identifier">each_with_rescue</span>(<span class="ruby-ivar">@@klasses</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">klass</span><span class="ruby-operator">|</span>
|
594
|
+
<span class="ruby-identifier">note</span> = <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@controller</span>)
|
595
|
+
<span class="ruby-ivar">@notes</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">note</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">note</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">:valid?</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">note</span>.<span class="ruby-identifier">valid?</span>
|
596
|
+
<span class="ruby-keyword kw">end</span>
|
597
|
+
<span class="ruby-keyword kw">end</span>
|
598
|
+
</pre>
|
599
|
+
</div>
|
600
|
+
</div>
|
601
|
+
</div>
|
602
|
+
|
603
|
+
<div id="method-M000123" class="method-detail">
|
604
|
+
<a name="M000123"></a>
|
605
|
+
|
606
|
+
<div class="method-heading">
|
607
|
+
<a href="#M000123" class="method-signature">
|
608
|
+
<span class="method-name">insert_footnotes</span><span class="method-args">()</span>
|
609
|
+
</a>
|
610
|
+
</div>
|
611
|
+
|
612
|
+
<div class="method-description">
|
613
|
+
<p><a class="source-toggle" href="#"
|
614
|
+
onclick="toggleCode('M000123-source');return false;">[Source]</a></p>
|
615
|
+
<div class="method-source-code" id="M000123-source">
|
616
|
+
<pre>
|
617
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 174</span>
|
618
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">insert_footnotes</span>
|
619
|
+
<span class="ruby-comment cmt"># Fieldsets method should be called first</span>
|
620
|
+
<span class="ruby-identifier">content</span> = <span class="ruby-identifier">fieldsets</span>
|
621
|
+
<span class="ruby-identifier">hideAll</span> = <span class="ruby-ivar">@@multiple_notes</span> <span class="ruby-operator">?</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-operator">:</span> <span class="ruby-node">%[Footnotes.hideAll = function() { #{close} }]</span>
|
622
|
+
|
623
|
+
<span class="ruby-identifier">footnotes_html</span> = <span class="ruby-value str">"<!-- Footnotes -->\n<div style=\"clear:both\"></div>\n<div id=\"footnotes_debug\">\n\#{links}\n\#{content}\n<script type=\"text/javascript\">\n\#{read_asset('footnotes.js')}\n\#{hideAll}\n/* Additional Javascript */\n\#{@notes.map(&:javascript).compact.join(\"\\n\")}\n</script>\n</div>\n<!-- End Footnotes -->\n"</span>
|
624
|
+
|
625
|
+
<span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@body</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">%r{<div[^>]+id=['"]footnotes_holder['"][^>]*>}</span>
|
626
|
+
<span class="ruby-comment cmt"># Insert inside the "footnotes_holder" div if it exists</span>
|
627
|
+
<span class="ruby-identifier">insert_text</span> <span class="ruby-identifier">:after</span>, <span class="ruby-regexp re">%r{<div[^>]+id=['"]footnotes_holder['"][^>]*>}</span>, <span class="ruby-identifier">footnotes_html</span>
|
628
|
+
<span class="ruby-keyword kw">else</span>
|
629
|
+
<span class="ruby-comment cmt"># Otherwise, try to insert as the last part of the html body</span>
|
630
|
+
<span class="ruby-identifier">insert_text</span> <span class="ruby-identifier">:before</span>, <span class="ruby-regexp re">/<\/body>/i</span>, <span class="ruby-identifier">footnotes_html</span>
|
631
|
+
<span class="ruby-keyword kw">end</span>
|
632
|
+
<span class="ruby-keyword kw">end</span>
|
633
|
+
</pre>
|
634
|
+
</div>
|
635
|
+
</div>
|
636
|
+
</div>
|
637
|
+
|
638
|
+
<div id="method-M000122" class="method-detail">
|
639
|
+
<a name="M000122"></a>
|
640
|
+
|
641
|
+
<div class="method-heading">
|
642
|
+
<a href="#M000122" class="method-signature">
|
643
|
+
<span class="method-name">insert_styles</span><span class="method-args">()</span>
|
644
|
+
</a>
|
645
|
+
</div>
|
646
|
+
|
647
|
+
<div class="method-description">
|
648
|
+
<p>
|
649
|
+
Insertion methods
|
650
|
+
</p>
|
651
|
+
<p><a class="source-toggle" href="#"
|
652
|
+
onclick="toggleCode('M000122-source');return false;">[Source]</a></p>
|
653
|
+
<div class="method-source-code" id="M000122-source">
|
654
|
+
<pre>
|
655
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 161</span>
|
656
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">insert_styles</span>
|
657
|
+
<span class="ruby-identifier">insert_text</span> <span class="ruby-identifier">:before</span>, <span class="ruby-regexp re">/<\/head>/i</span>, <span class="ruby-value str">"<!-- Footnotes Style -->\n<style type=\"text/css\">\n\#{read_asset('footnotes.css')}\n/* Aditional Stylesheets */\n\#{@notes.map(&:stylesheet).compact.join(\"\\n\")}\n</style>\n<!-- End Footnotes Style -->\n"</span>
|
658
|
+
<span class="ruby-keyword kw">end</span>
|
659
|
+
</pre>
|
660
|
+
</div>
|
661
|
+
</div>
|
662
|
+
</div>
|
663
|
+
|
664
|
+
<div id="method-M000129" class="method-detail">
|
665
|
+
<a name="M000129"></a>
|
666
|
+
|
667
|
+
<div class="method-heading">
|
668
|
+
<a href="#M000129" class="method-signature">
|
669
|
+
<span class="method-name">insert_text</span><span class="method-args">(position, pattern, new_text)</span>
|
670
|
+
</a>
|
671
|
+
</div>
|
672
|
+
|
673
|
+
<div class="method-description">
|
674
|
+
<p>
|
675
|
+
Inserts text in to the body of the document <tt>pattern</tt> is a Regular
|
676
|
+
expression which, when matched, will cause <tt>new_text</tt> to be inserted
|
677
|
+
<a href="Filter.html#M000104">before</a> or <a
|
678
|
+
href="Filter.html#M000105">after</a> the match. If no match is found,
|
679
|
+
<tt>new_text</tt> is appended to the body instead. <tt>position</tt> may be
|
680
|
+
either :<a href="Filter.html#M000104">before</a> or :<a
|
681
|
+
href="Filter.html#M000105">after</a>
|
682
|
+
</p>
|
683
|
+
<p><a class="source-toggle" href="#"
|
684
|
+
onclick="toggleCode('M000129-source');return false;">[Source]</a></p>
|
685
|
+
<div class="method-source-code" id="M000129-source">
|
686
|
+
<pre>
|
687
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 279</span>
|
688
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">insert_text</span>(<span class="ruby-identifier">position</span>, <span class="ruby-identifier">pattern</span>, <span class="ruby-identifier">new_text</span>)
|
689
|
+
<span class="ruby-identifier">index</span> = <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">pattern</span>
|
690
|
+
<span class="ruby-keyword kw">when</span> <span class="ruby-constant">Regexp</span>
|
691
|
+
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">match</span> = <span class="ruby-ivar">@body</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">pattern</span>)
|
692
|
+
<span class="ruby-identifier">match</span>.<span class="ruby-identifier">offset</span>(<span class="ruby-value">0</span>)[<span class="ruby-identifier">position</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:before</span> <span class="ruby-operator">?</span> <span class="ruby-value">0</span> <span class="ruby-operator">:</span> <span class="ruby-value">1</span>]
|
693
|
+
<span class="ruby-keyword kw">else</span>
|
694
|
+
<span class="ruby-ivar">@body</span>.<span class="ruby-identifier">size</span>
|
695
|
+
<span class="ruby-keyword kw">end</span>
|
696
|
+
<span class="ruby-keyword kw">else</span>
|
697
|
+
<span class="ruby-identifier">pattern</span>
|
698
|
+
<span class="ruby-keyword kw">end</span>
|
699
|
+
<span class="ruby-ivar">@body</span>.<span class="ruby-identifier">insert</span> <span class="ruby-identifier">index</span>, <span class="ruby-identifier">new_text</span>
|
700
|
+
<span class="ruby-keyword kw">end</span>
|
701
|
+
</pre>
|
702
|
+
</div>
|
703
|
+
</div>
|
704
|
+
</div>
|
705
|
+
|
706
|
+
<div id="method-M000128" class="method-detail">
|
707
|
+
<a name="M000128"></a>
|
708
|
+
|
709
|
+
<div class="method-heading">
|
710
|
+
<a href="#M000128" class="method-signature">
|
711
|
+
<span class="method-name">link_helper</span><span class="method-args">(note)</span>
|
712
|
+
</a>
|
713
|
+
</div>
|
714
|
+
|
715
|
+
<div class="method-description">
|
716
|
+
<p>
|
717
|
+
Helper that creates the link and javascript code when note is clicked
|
718
|
+
</p>
|
719
|
+
<p><a class="source-toggle" href="#"
|
720
|
+
onclick="toggleCode('M000128-source');return false;">[Source]</a></p>
|
721
|
+
<div class="method-source-code" id="M000128-source">
|
722
|
+
<pre>
|
723
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 264</span>
|
724
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">link_helper</span>(<span class="ruby-identifier">note</span>)
|
725
|
+
<span class="ruby-identifier">onclick</span> = <span class="ruby-identifier">note</span>.<span class="ruby-identifier">onclick</span>
|
726
|
+
<span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">href</span> = <span class="ruby-identifier">note</span>.<span class="ruby-identifier">link</span>
|
727
|
+
<span class="ruby-identifier">href</span> = <span class="ruby-value str">'#'</span>
|
728
|
+
<span class="ruby-identifier">onclick</span> <span class="ruby-operator">||=</span> <span class="ruby-node">"Footnotes.hideAllAndToggle('#{note.to_sym}_debug_info');return false;"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">note</span>.<span class="ruby-identifier">has_fieldset?</span>
|
729
|
+
<span class="ruby-keyword kw">end</span>
|
730
|
+
|
731
|
+
<span class="ruby-node">"<a href=\"#{href}\" onclick=\"#{onclick}\">#{note.title}</a>"</span>
|
732
|
+
<span class="ruby-keyword kw">end</span>
|
733
|
+
</pre>
|
734
|
+
</div>
|
735
|
+
</div>
|
736
|
+
</div>
|
737
|
+
|
738
|
+
<div id="method-M000124" class="method-detail">
|
739
|
+
<a name="M000124"></a>
|
740
|
+
|
741
|
+
<div class="method-heading">
|
742
|
+
<a href="#M000124" class="method-signature">
|
743
|
+
<span class="method-name">links</span><span class="method-args">()</span>
|
744
|
+
</a>
|
745
|
+
</div>
|
746
|
+
|
747
|
+
<div class="method-description">
|
748
|
+
<p>
|
749
|
+
Process notes to gets their <a href="Filter.html#M000124">links</a> in
|
750
|
+
their equivalent row
|
751
|
+
</p>
|
752
|
+
<p><a class="source-toggle" href="#"
|
753
|
+
onclick="toggleCode('M000124-source');return false;">[Source]</a></p>
|
754
|
+
<div class="method-source-code" id="M000124-source">
|
755
|
+
<pre>
|
756
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 207</span>
|
757
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">links</span>
|
758
|
+
<span class="ruby-identifier">links</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>([])
|
759
|
+
<span class="ruby-identifier">order</span> = []
|
760
|
+
<span class="ruby-identifier">each_with_rescue</span>(<span class="ruby-ivar">@notes</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">note</span><span class="ruby-operator">|</span>
|
761
|
+
<span class="ruby-identifier">order</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">note</span>.<span class="ruby-identifier">row</span>
|
762
|
+
<span class="ruby-identifier">links</span>[<span class="ruby-identifier">note</span>.<span class="ruby-identifier">row</span>] <span class="ruby-operator">+=</span> [<span class="ruby-identifier">link_helper</span>(<span class="ruby-identifier">note</span>)]
|
763
|
+
<span class="ruby-keyword kw">end</span>
|
764
|
+
|
765
|
+
<span class="ruby-identifier">html</span> = <span class="ruby-value str">''</span>
|
766
|
+
<span class="ruby-identifier">order</span>.<span class="ruby-identifier">uniq!</span>
|
767
|
+
<span class="ruby-identifier">order</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">row</span><span class="ruby-operator">|</span>
|
768
|
+
<span class="ruby-identifier">html</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"#{row.is_a?(String) ? row : row.to_s.camelize}: #{links[row].join(" | \n")}<br />"</span>
|
769
|
+
<span class="ruby-keyword kw">end</span>
|
770
|
+
<span class="ruby-identifier">html</span>
|
771
|
+
<span class="ruby-keyword kw">end</span>
|
772
|
+
</pre>
|
773
|
+
</div>
|
774
|
+
</div>
|
775
|
+
</div>
|
776
|
+
|
777
|
+
<div id="method-M000116" class="method-detail">
|
778
|
+
<a name="M000116"></a>
|
779
|
+
|
780
|
+
<div class="method-heading">
|
781
|
+
<a href="#M000116" class="method-signature">
|
782
|
+
<span class="method-name">performed_render?</span><span class="method-args">()</span>
|
783
|
+
</a>
|
784
|
+
</div>
|
785
|
+
|
786
|
+
<div class="method-description">
|
787
|
+
<p><a class="source-toggle" href="#"
|
788
|
+
onclick="toggleCode('M000116-source');return false;">[Source]</a></p>
|
789
|
+
<div class="method-source-code" id="M000116-source">
|
790
|
+
<pre>
|
791
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 132</span>
|
792
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">performed_render?</span>
|
793
|
+
<span class="ruby-ivar">@controller</span>.<span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-identifier">:@performed_render</span>)
|
794
|
+
<span class="ruby-keyword kw">end</span>
|
795
|
+
</pre>
|
796
|
+
</div>
|
797
|
+
</div>
|
798
|
+
</div>
|
799
|
+
|
800
|
+
<div id="method-M000121" class="method-detail">
|
801
|
+
<a name="M000121"></a>
|
802
|
+
|
803
|
+
<div class="method-heading">
|
804
|
+
<a href="#M000121" class="method-signature">
|
805
|
+
<span class="method-name">read_asset</span><span class="method-args">(filename)</span>
|
806
|
+
</a>
|
807
|
+
</div>
|
808
|
+
|
809
|
+
<div class="method-description">
|
810
|
+
<p><a class="source-toggle" href="#"
|
811
|
+
onclick="toggleCode('M000121-source');return false;">[Source]</a></p>
|
812
|
+
<div class="method-source-code" id="M000121-source">
|
813
|
+
<pre>
|
814
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 153</span>
|
815
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read_asset</span>(<span class="ruby-identifier">filename</span>)
|
816
|
+
<span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-keyword kw">__FILE__</span>), <span class="ruby-value str">'assets'</span>, <span class="ruby-identifier">filename</span>))
|
817
|
+
<span class="ruby-keyword kw">end</span>
|
818
|
+
</pre>
|
819
|
+
</div>
|
820
|
+
</div>
|
821
|
+
</div>
|
822
|
+
|
823
|
+
<div id="method-M000113" class="method-detail">
|
824
|
+
<a name="M000113"></a>
|
825
|
+
|
826
|
+
<div class="method-heading">
|
827
|
+
<a href="#M000113" class="method-signature">
|
828
|
+
<span class="method-name">valid?</span><span class="method-args">()</span>
|
829
|
+
</a>
|
830
|
+
</div>
|
831
|
+
|
832
|
+
<div class="method-description">
|
833
|
+
<p><a class="source-toggle" href="#"
|
834
|
+
onclick="toggleCode('M000113-source');return false;">[Source]</a></p>
|
835
|
+
<div class="method-source-code" id="M000113-source">
|
836
|
+
<pre>
|
837
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 115</span>
|
838
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid?</span>
|
839
|
+
<span class="ruby-identifier">performed_render?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">valid_format?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">valid_content_type?</span> <span class="ruby-operator">&&</span> <span class="ruby-ivar">@body</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>) <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">component_request?</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">xhr?</span>
|
840
|
+
<span class="ruby-keyword kw">end</span>
|
841
|
+
</pre>
|
842
|
+
</div>
|
843
|
+
</div>
|
844
|
+
</div>
|
845
|
+
|
846
|
+
<div id="method-M000118" class="method-detail">
|
847
|
+
<a name="M000118"></a>
|
848
|
+
|
849
|
+
<div class="method-heading">
|
850
|
+
<a href="#M000118" class="method-signature">
|
851
|
+
<span class="method-name">valid_content_type?</span><span class="method-args">()</span>
|
852
|
+
</a>
|
853
|
+
</div>
|
854
|
+
|
855
|
+
<div class="method-description">
|
856
|
+
<p><a class="source-toggle" href="#"
|
857
|
+
onclick="toggleCode('M000118-source');return false;">[Source]</a></p>
|
858
|
+
<div class="method-source-code" id="M000118-source">
|
859
|
+
<pre>
|
860
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 140</span>
|
861
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid_content_type?</span>
|
862
|
+
<span class="ruby-identifier">c</span> = <span class="ruby-ivar">@controller</span>.<span class="ruby-identifier">response</span>.<span class="ruby-identifier">headers</span>[<span class="ruby-value str">'Content-Type'</span>].<span class="ruby-identifier">to_s</span>
|
863
|
+
(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">c</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/html/</span>)
|
864
|
+
<span class="ruby-keyword kw">end</span>
|
865
|
+
</pre>
|
866
|
+
</div>
|
867
|
+
</div>
|
868
|
+
</div>
|
869
|
+
|
870
|
+
<div id="method-M000117" class="method-detail">
|
871
|
+
<a name="M000117"></a>
|
872
|
+
|
873
|
+
<div class="method-heading">
|
874
|
+
<a href="#M000117" class="method-signature">
|
875
|
+
<span class="method-name">valid_format?</span><span class="method-args">()</span>
|
876
|
+
</a>
|
877
|
+
</div>
|
878
|
+
|
879
|
+
<div class="method-description">
|
880
|
+
<p><a class="source-toggle" href="#"
|
881
|
+
onclick="toggleCode('M000117-source');return false;">[Source]</a></p>
|
882
|
+
<div class="method-source-code" id="M000117-source">
|
883
|
+
<pre>
|
884
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 136</span>
|
885
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid_format?</span>
|
886
|
+
[<span class="ruby-identifier">:html</span>,<span class="ruby-identifier">:rhtml</span>,<span class="ruby-identifier">:xhtml</span>,<span class="ruby-identifier">:rxhtml</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-ivar">@template</span>.<span class="ruby-identifier">template_format</span>.<span class="ruby-identifier">to_sym</span>)
|
887
|
+
<span class="ruby-keyword kw">end</span>
|
888
|
+
</pre>
|
889
|
+
</div>
|
890
|
+
</div>
|
891
|
+
</div>
|
892
|
+
|
893
|
+
<div id="method-M000120" class="method-detail">
|
894
|
+
<a name="M000120"></a>
|
895
|
+
|
896
|
+
<div class="method-heading">
|
897
|
+
<a href="#M000120" class="method-signature">
|
898
|
+
<span class="method-name">xhr?</span><span class="method-args">()</span>
|
899
|
+
</a>
|
900
|
+
</div>
|
901
|
+
|
902
|
+
<div class="method-description">
|
903
|
+
<p><a class="source-toggle" href="#"
|
904
|
+
onclick="toggleCode('M000120-source');return false;">[Source]</a></p>
|
905
|
+
<div class="method-source-code" id="M000120-source">
|
906
|
+
<pre>
|
907
|
+
<span class="ruby-comment cmt"># File lib/rails-footnotes/footnotes.rb, line 149</span>
|
908
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">xhr?</span>
|
909
|
+
<span class="ruby-ivar">@controller</span>.<span class="ruby-identifier">request</span>.<span class="ruby-identifier">xhr?</span>
|
910
|
+
<span class="ruby-keyword kw">end</span>
|
911
|
+
</pre>
|
912
|
+
</div>
|
913
|
+
</div>
|
914
|
+
</div>
|
915
|
+
|
916
|
+
|
917
|
+
</div>
|
918
|
+
|
919
|
+
|
920
|
+
</div>
|
921
|
+
|
922
|
+
|
923
|
+
<div id="validator-badges">
|
924
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
925
|
+
</div>
|
926
|
+
|
927
|
+
</body>
|
928
|
+
</html>
|