ballast 2.2.4 → 2.2.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (86) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +6 -1
  3. data/.travis-gemfile +2 -2
  4. data/.travis.yml +5 -3
  5. data/.yardopts +1 -1
  6. data/CHANGELOG.md +9 -0
  7. data/Gemfile +1 -1
  8. data/LICENSE.md +21 -0
  9. data/README.md +22 -17
  10. data/Rakefile +1 -1
  11. data/ballast.gemspec +1 -1
  12. data/{doc → docs}/Ballast.html +19 -21
  13. data/docs/Ballast/AjaxResponse.html +1470 -0
  14. data/{doc → docs}/Ballast/Concerns.html +3 -3
  15. data/{doc → docs}/Ballast/Concerns/AjaxHandling.html +33 -38
  16. data/{doc → docs}/Ballast/Concerns/Common.html +45 -52
  17. data/{doc → docs}/Ballast/Concerns/ErrorsHandling.html +13 -14
  18. data/docs/Ballast/Concerns/JSONApi.html +127 -0
  19. data/docs/Ballast/Concerns/JSONApi/PaginationHandling.html +617 -0
  20. data/docs/Ballast/Concerns/JSONApi/RequestHandling.html +775 -0
  21. data/docs/Ballast/Concerns/JSONApi/ResponseHandling.html +917 -0
  22. data/{doc → docs}/Ballast/Concerns/View.html +35 -42
  23. data/{doc → docs}/Ballast/Configuration.html +19 -22
  24. data/{doc → docs}/Ballast/Emoji.html +1 -1
  25. data/{doc → docs}/Ballast/Emoji/Character.html +15 -18
  26. data/docs/Ballast/Emoji/Utils.html +794 -0
  27. data/{doc → docs}/Ballast/Errors.html +1 -1
  28. data/{doc → docs}/Ballast/Errors/Base.html +16 -18
  29. data/{doc → docs}/Ballast/Errors/Failure.html +1 -1
  30. data/{doc → docs}/Ballast/Errors/InvalidDomain.html +1 -1
  31. data/{doc → docs}/Ballast/Errors/ValidationFailure.html +1 -1
  32. data/{doc → docs}/Ballast/Middlewares.html +1 -1
  33. data/{doc → docs}/Ballast/Middlewares/DefaultHost.html +16 -18
  34. data/docs/Ballast/RequestDomainMatcher.html +917 -0
  35. data/docs/Ballast/Service.html +1513 -0
  36. data/docs/Ballast/Service/Response.html +1270 -0
  37. data/{doc → docs}/Ballast/Version.html +5 -9
  38. data/{doc → docs}/_index.html +45 -1
  39. data/docs/class_list.html +58 -0
  40. data/{doc → docs}/css/common.css +0 -0
  41. data/{doc → docs}/css/full_list.css +0 -0
  42. data/{doc → docs}/css/style.css +0 -0
  43. data/{doc → docs}/file.README.html +7 -5
  44. data/{doc → docs}/file_list.html +0 -0
  45. data/{doc → docs}/frames.html +0 -0
  46. data/{doc → docs}/index.html +7 -5
  47. data/{doc → docs}/js/app.js +0 -0
  48. data/{doc → docs}/js/full_list.js +0 -0
  49. data/{doc → docs}/js/jquery.js +0 -0
  50. data/{doc → docs}/method_list.html +150 -36
  51. data/docs/top-level-namespace.html +149 -0
  52. data/lib/ballast.rb +1 -1
  53. data/lib/ballast/ajax_response.rb +1 -1
  54. data/lib/ballast/concerns/ajax_handling.rb +1 -1
  55. data/lib/ballast/concerns/common.rb +1 -1
  56. data/lib/ballast/concerns/errors_handling.rb +1 -1
  57. data/lib/ballast/concerns/json_api/pagination_handling.rb +83 -0
  58. data/lib/ballast/concerns/json_api/request_handling.rb +235 -0
  59. data/lib/ballast/concerns/json_api/response_handling.rb +70 -0
  60. data/lib/ballast/concerns/view.rb +1 -1
  61. data/lib/ballast/configuration.rb +1 -1
  62. data/lib/ballast/emoji.rb +1 -1
  63. data/lib/ballast/errors.rb +1 -1
  64. data/lib/ballast/middlewares/default_host.rb +1 -1
  65. data/lib/ballast/request_domain_matcher.rb +1 -1
  66. data/lib/ballast/service.rb +1 -1
  67. data/lib/ballast/version.rb +2 -2
  68. data/spec/ballast/ajax_response_spec.rb +1 -1
  69. data/spec/ballast/concerns/ajax_handling_spec.rb +1 -1
  70. data/spec/ballast/concerns/common_spec.rb +1 -1
  71. data/spec/ballast/concerns/errors_handling_spec.rb +1 -1
  72. data/spec/ballast/concerns/view_spec.rb +1 -1
  73. data/spec/ballast/configuration_spec.rb +1 -1
  74. data/spec/ballast/errors_spec.rb +1 -1
  75. data/spec/ballast/middlewares/default_host_spec.rb +1 -1
  76. data/spec/ballast/request_domain_matcher_spec.rb +1 -1
  77. data/spec/ballast_spec.rb +1 -1
  78. data/spec/spec_helper.rb +1 -1
  79. metadata +47 -39
  80. data/doc/Ballast/AjaxResponse.html +0 -1478
  81. data/doc/Ballast/Emoji/Utils.html +0 -799
  82. data/doc/Ballast/RequestDomainMatcher.html +0 -923
  83. data/doc/Ballast/Service.html +0 -1522
  84. data/doc/Ballast/Service/Response.html +0 -1278
  85. data/doc/class_list.html +0 -58
  86. data/doc/top-level-namespace.html +0 -112
data/doc/Ballast/Emoji/Utils.html DELETED
@@ -1,799 +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: Ballast::Emoji::Utils
8
-
9
- &mdash; Documentation by YARD 0.8.7.6
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
14
-
15
- <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
16
-
17
- <script type="text/javascript" charset="utf-8">
18
- hasFrames = window.top.frames.main ? true : false;
19
- relpath = '../../';
20
- framesUrl = "../../frames.html#!Ballast/Emoji/Utils.html";
21
- </script>
22
-
23
-
24
- <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
25
-
26
- <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
27
-
28
-
29
- </head>
30
- <body>
31
- <div id="header">
32
- <div id="menu">
33
-
34
- <a href="../../_index.html">Index (U)</a> &raquo;
35
- <span class='title'><span class='object_link'><a href="../../Ballast.html" title="Ballast (module)">Ballast</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Emoji.html" title="Ballast::Emoji (module)">Emoji</a></span></span>
36
- &raquo;
37
- <span class="title">Utils</span>
38
-
39
-
40
- <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
- </div>
42
-
43
- <div id="search">
44
-
45
- <a class="full_list_link" id="class_list_link"
46
- href="../../class_list.html">
47
- Class List
48
- </a>
49
-
50
- <a class="full_list_link" id="method_list_link"
51
- href="../../method_list.html">
52
- Method List
53
- </a>
54
-
55
- <a class="full_list_link" id="file_list_link"
56
- href="../../file_list.html">
57
- File List
58
- </a>
59
-
60
- </div>
61
- <div class="clear"></div>
62
- </div>
63
-
64
- <iframe id="search_frame"></iframe>
65
-
66
- <div id="content"><h1>Module: Ballast::Emoji::Utils
67
-
68
-
69
-
70
- </h1>
71
-
72
- <dl class="box">
73
-
74
-
75
-
76
-
77
-
78
-
79
-
80
-
81
- <dt class="r1 last">Defined in:</dt>
82
- <dd class="r1 last">lib/ballast/emoji.rb</dd>
83
-
84
- </dl>
85
- <div class="clear"></div>
86
-
87
- <h2>Overview</h2><div class="docstring">
88
- <div class="discussion">
89
- <p>General utility methods.</p>
90
-
91
-
92
- </div>
93
- </div>
94
- <div class="tags">
95
-
96
-
97
- </div>
98
-
99
-
100
-
101
- <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
102
- <ul class="summary">
103
-
104
- <li class="public ">
105
- <span class="summary_signature">
106
-
107
- <a href="#url_mapper-instance_method" title="#url_mapper (instance method)">- (Proc) <strong>url_mapper</strong> </a>
108
-
109
-
110
-
111
- </span>
112
-
113
-
114
-
115
-
116
-
117
-
118
-
119
-
120
-
121
-
122
-
123
-
124
- <span class="summary_desc"><div class='inline'><p>Returns the URL mapper for the emojis.</p>
125
- </div></span>
126
-
127
- </li>
128
-
129
-
130
- </ul>
131
-
132
-
133
-
134
-
135
-
136
- <h2>
137
- Instance Method Summary
138
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
139
- </h2>
140
-
141
- <ul class="summary">
142
-
143
- <li class="public ">
144
- <span class="summary_signature">
145
-
146
- <a href="#enumerate-instance_method" title="#enumerate (instance method)">- (Hash) <strong>enumerate</strong>(keys_method: :markup, values_method: :html, **options) </a>
147
-
148
-
149
-
150
- </span>
151
-
152
-
153
-
154
-
155
-
156
-
157
-
158
-
159
-
160
- <span class="summary_desc"><div class='inline'><p>Lists all the emoji known in a hash.</p>
161
- </div></span>
162
-
163
- </li>
164
-
165
-
166
- <li class="public ">
167
- <span class="summary_signature">
168
-
169
- <a href="#replace-instance_method" title="#replace (instance method)">- (String) <strong>replace</strong>(text, mode: :html, **options) </a>
170
-
171
-
172
-
173
- </span>
174
-
175
-
176
-
177
-
178
-
179
-
180
-
181
-
182
-
183
- <span class="summary_desc"><div class='inline'><p>Replaces all the emojis in the text using the requested mod.</p>
184
- </div></span>
185
-
186
- </li>
187
-
188
-
189
- <li class="public ">
190
- <span class="summary_signature">
191
-
192
- <a href="#replace_regex-instance_method" title="#replace_regex (instance method)">- (Regexp) <strong>replace_regex</strong> </a>
193
-
194
-
195
-
196
- </span>
197
-
198
-
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
- <span class="summary_desc"><div class='inline'><p>Returns the regular expression which matches all the known emojis.</p>
207
- </div></span>
208
-
209
- </li>
210
-
211
-
212
- <li class="public ">
213
- <span class="summary_signature">
214
-
215
- <a href="#url_for-instance_method" title="#url_for (instance method)">- (String) <strong>url_for</strong>(image) </a>
216
-
217
-
218
-
219
- </span>
220
-
221
-
222
-
223
-
224
-
225
-
226
-
227
-
228
-
229
- <span class="summary_desc"><div class='inline'><p>Returns a absolute URL for a emoji image.</p>
230
- </div></span>
231
-
232
- </li>
233
-
234
-
235
- </ul>
236
-
237
-
238
-
239
- <div id="instance_attr_details" class="attr_details">
240
- <h2>Instance Attribute Details</h2>
241
-
242
-
243
- <span id="url_mapper=-instance_method"></span>
244
- <div class="method_details first">
245
- <h3 class="signature first" id="url_mapper-instance_method">
246
-
247
- - (<tt>Proc</tt>) <strong>url_mapper</strong>
248
-
249
-
250
-
251
-
252
-
253
- </h3><div class="docstring">
254
- <div class="discussion">
255
- <p>Returns the URL mapper for the emojis.</p>
256
-
257
-
258
- </div>
259
- </div>
260
- <div class="tags">
261
-
262
- <p class="tag_title">Returns:</p>
263
- <ul class="return">
264
-
265
- <li>
266
-
267
-
268
- <span class='type'>(<tt>Proc</tt>)</span>
269
-
270
-
271
-
272
- &mdash;
273
- <div class='inline'><p>The current URL mapper or a default one (which will return the relative URL unmodified).</p>
274
- </div>
275
-
276
- </li>
277
-
278
- </ul>
279
-
280
- </div><table class="source_code">
281
- <tr>
282
- <td>
283
- <pre class="lines">
284
-
285
-
286
- 13
287
- 14
288
- 15
289
- 16
290
- 17
291
- 18
292
- 19
293
- 20
294
- 21
295
- 22
296
- 23
297
- 24
298
- 25
299
- 26
300
- 27
301
- 28
302
- 29
303
- 30
304
- 31
305
- 32
306
- 33
307
- 34
308
- 35
309
- 36
310
- 37
311
- 38
312
- 39
313
- 40
314
- 41
315
- 42
316
- 43
317
- 44
318
- 45
319
- 46
320
- 47
321
- 48
322
- 49
323
- 50
324
- 51
325
- 52
326
- 53
327
- 54
328
- 55
329
- 56
330
- 57
331
- 58
332
- 59
333
- 60
334
- 61
335
- 62
336
- 63
337
- 64
338
- 65
339
- 66
340
- 67
341
- 68
342
- 69
343
- 70
344
- 71
345
- 72</pre>
346
- </td>
347
- <td>
348
- <pre class="code"><span class="info file"># File 'lib/ballast/emoji.rb', line 13</span>
349
-
350
- <span class='rubyid_module module kw'>module</span> <span class='rubyid_Utils constant id'>Utils</span>
351
- <span class='rubyid_attr_accessor identifier id'>attr_accessor</span> <span class='symbol val'>:url_mapper</span>
352
-
353
- <span class='comment val'># Returns the regular expression which matches all the known emojis.</span>
354
- <span class='comment val'>#</span>
355
- <span class='comment val'># @return [Regexp] The regular expression which matches all the known emojis.</span>
356
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_replace_regex identifier id'>replace_regex</span>
357
- <span class='rubyid_@replace_regex ivar id'>@replace_regex</span> <span class='opasgn op'>||=</span> <span class='dregexp node'>/(#{::Emoji.send(:unicodes_index).keys.join(&quot;|&quot;)})/</span>
358
- <span class='rubyid_end end kw'>end</span>
359
-
360
- <span class='comment val'># Replaces all the emojis in the text using the requested mod.</span>
361
- <span class='comment val'>#</span>
362
- <span class='comment val'># @param text [String] The text to manipulate.</span>
363
- <span class='comment val'># @param mode [Symbol] The method to use when replacing icons.</span>
364
- <span class='comment val'># @param options [Hash] The options to pass to the replacing method.</span>
365
- <span class='comment val'># @return [String] The text with all emojis replaced.</span>
366
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_replace identifier id'>replace</span><span class='lparen token'>(</span><span class='rubyid_text identifier id'>text</span><span class='comma token'>,</span> <span class='label val'>mode:</span> <span class='symbol val'>:html</span><span class='comma token'>,</span> <span class='pow op'>**</span><span class='rubyid_options identifier id'>options</span><span class='rparen token'>)</span>
367
- <span class='rubyid_mode identifier id'>mode</span> <span class='assign token'>=</span> <span class='symbol val'>:markup</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_mode identifier id'>mode</span> <span class='andop op'>&amp;&amp;</span> <span class='colon3 op'>::</span><span class='rubyid_Emoji constant id'>Emoji</span><span class='colon2 op'>::</span><span class='rubyid_Character constant id'>Character</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='rubyid_mode identifier id'>mode</span><span class='rparen token'>)</span>
368
- <span class='rubyid_text identifier id'>text</span><span class='dot token'>.</span><span class='rubyid_ensure_string identifier id'>ensure_string</span><span class='dot token'>.</span><span class='rubyid_gsub identifier id'>gsub</span><span class='lparen token'>(</span><span class='rubyid_replace_regex identifier id'>replace_regex</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='rubyid_invoke identifier id'>invoke</span><span class='lparen token'>(</span><span class='colon3 op'>::</span><span class='rubyid_Emoji constant id'>Emoji</span><span class='dot token'>.</span><span class='rubyid_find_by_unicode identifier id'>find_by_unicode</span><span class='lparen token'>(</span><span class='rubyid_Regexp constant id'>Regexp</span><span class='dot token'>.</span><span class='rubyid_last_match identifier id'>last_match</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='rubyid_mode identifier id'>mode</span><span class='comma token'>,</span> <span class='rubyid_options identifier id'>options</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span>
369
- <span class='rubyid_end end kw'>end</span>
370
-
371
- <span class='comment val'># Lists all the emoji known in a hash.</span>
372
- <span class='comment val'>#</span>
373
- <span class='comment val'># @param keys_method [Symbol] The method to use for keys.</span>
374
- <span class='comment val'># @param values_method [Symbol] The method to use for values.</span>
375
- <span class='comment val'># @param options [Hash] The options to pass to all methods.</span>
376
- <span class='comment val'># @return [Hash] A hash of all known emojis.</span>
377
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_enumerate identifier id'>enumerate</span><span class='lparen token'>(</span><span class='label val'>keys_method:</span> <span class='symbol val'>:markup</span><span class='comma token'>,</span> <span class='label val'>values_method:</span> <span class='symbol val'>:html</span><span class='comma token'>,</span> <span class='pow op'>**</span><span class='rubyid_options identifier id'>options</span><span class='rparen token'>)</span>
378
- <span class='rubyid_tester identifier id'>tester</span> <span class='assign token'>=</span> <span class='colon3 op'>::</span><span class='rubyid_Emoji constant id'>Emoji</span><span class='colon2 op'>::</span><span class='rubyid_Character constant id'>Character</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
379
- <span class='rubyid_keys_method identifier id'>keys_method</span> <span class='assign token'>=</span> <span class='symbol val'>:markup</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_keys_method identifier id'>keys_method</span> <span class='andop op'>&amp;&amp;</span> <span class='rubyid_tester identifier id'>tester</span><span class='dot token'>.</span><span class='rubyid_respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='rubyid_keys_method identifier id'>keys_method</span><span class='rparen token'>)</span>
380
- <span class='rubyid_values_method identifier id'>values_method</span> <span class='assign token'>=</span> <span class='symbol val'>:html</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_values_method identifier id'>values_method</span> <span class='andop op'>&amp;&amp;</span> <span class='rubyid_tester identifier id'>tester</span><span class='dot token'>.</span><span class='rubyid_respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='rubyid_values_method identifier id'>values_method</span><span class='rparen token'>)</span>
381
-
382
- <span class='colon3 op'>::</span><span class='rubyid_Emoji constant id'>Emoji</span><span class='dot token'>.</span><span class='rubyid_all identifier id'>all</span><span class='dot token'>.</span><span class='rubyid_reduce identifier id'>reduce</span><span class='lparen token'>(</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> <span class='rubyid_do do kw'>do</span> <span class='bitor op'>|</span><span class='rubyid_accu identifier id'>accu</span><span class='comma token'>,</span> <span class='rubyid_icon identifier id'>icon</span><span class='bitor op'>|</span>
383
- <span class='rubyid_accu identifier id'>accu</span><span class='lbrack token'>[</span><span class='rubyid_invoke identifier id'>invoke</span><span class='lparen token'>(</span><span class='rubyid_icon identifier id'>icon</span><span class='comma token'>,</span> <span class='rubyid_keys_method identifier id'>keys_method</span><span class='comma token'>,</span> <span class='rubyid_options identifier id'>options</span><span class='rparen token'>)</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_invoke identifier id'>invoke</span><span class='lparen token'>(</span><span class='rubyid_icon identifier id'>icon</span><span class='comma token'>,</span> <span class='rubyid_values_method identifier id'>values_method</span><span class='comma token'>,</span> <span class='rubyid_options identifier id'>options</span><span class='rparen token'>)</span>
384
- <span class='rubyid_accu identifier id'>accu</span>
385
- <span class='rubyid_end end kw'>end</span>
386
- <span class='rubyid_end end kw'>end</span>
387
-
388
- <span class='comment val'># Returns the URL mapper for the emojis.</span>
389
- <span class='comment val'>#</span>
390
- <span class='comment val'># @return [Proc] The current URL mapper or a default one (which will return the relative URL unmodified).</span>
391
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_url_mapper identifier id'>url_mapper</span>
392
- <span class='rubyid_@url_mapper ivar id'>@url_mapper</span> <span class='orop op'>||</span> <span class='minus op'>-</span><span class='gt op'>&gt;</span><span class='lparen token'>(</span><span class='rubyid_url identifier id'>url</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='rubyid_url identifier id'>url</span> <span class='rbrace token'>}</span>
393
- <span class='rubyid_end end kw'>end</span>
394
-
395
- <span class='comment val'># Returns a absolute URL for a emoji image.</span>
396
- <span class='comment val'>#</span>
397
- <span class='comment val'># @param image [String] The relative URL of the emoji filename.</span>
398
- <span class='comment val'># @return [String] The absolute URL of the emoji filename.</span>
399
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_url_for identifier id'>url_for</span><span class='lparen token'>(</span><span class='rubyid_image identifier id'>image</span><span class='rparen token'>)</span>
400
- <span class='rubyid_url_mapper identifier id'>url_mapper</span><span class='dot token'>.</span><span class='rubyid_call identifier id'>call</span><span class='lparen token'>(</span><span class='rubyid_image identifier id'>image</span><span class='rparen token'>)</span>
401
- <span class='rubyid_end end kw'>end</span>
402
-
403
- <span class='rubyid_private identifier id'>private</span>
404
-
405
- <span class='comment val'># :nodoc:</span>
406
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_invoke identifier id'>invoke</span><span class='lparen token'>(</span><span class='rubyid_subject identifier id'>subject</span><span class='comma token'>,</span> <span class='rubyid_method identifier id'>method</span><span class='comma token'>,</span> <span class='rubyid_options identifier id'>options</span><span class='rparen token'>)</span>
407
- <span class='rubyid_subject identifier id'>subject</span><span class='dot token'>.</span><span class='rubyid_method identifier id'>method</span><span class='lparen token'>(</span><span class='rubyid_method identifier id'>method</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_arity identifier id'>arity</span> <span class='eq op'>==</span> <span class='integer val'>1</span> <span class='question op'>?</span> <span class='rubyid_subject identifier id'>subject</span><span class='dot token'>.</span><span class='rubyid_send identifier id'>send</span><span class='lparen token'>(</span><span class='rubyid_method identifier id'>method</span><span class='comma token'>,</span> <span class='rubyid_options identifier id'>options</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='rubyid_subject identifier id'>subject</span><span class='dot token'>.</span><span class='rubyid_send identifier id'>send</span><span class='lparen token'>(</span><span class='rubyid_method identifier id'>method</span><span class='rparen token'>)</span>
408
- <span class='rubyid_end end kw'>end</span>
409
- <span class='rubyid_end end kw'>end</span>
410
- </pre>
411
- </td>
412
- </tr>
413
- </table>
414
- </div>
415
-
416
- </div>
417
-
418
-
419
- <div id="instance_method_details" class="method_details_list">
420
- <h2>Instance Method Details</h2>
421
-
422
-
423
- <div class="method_details first">
424
- <h3 class="signature first" id="enumerate-instance_method">
425
-
426
- - (<tt>Hash</tt>) <strong>enumerate</strong>(keys_method: :markup, values_method: :html, **options)
427
-
428
-
429
-
430
-
431
-
432
- </h3><div class="docstring">
433
- <div class="discussion">
434
- <p>Lists all the emoji known in a hash.</p>
435
-
436
-
437
- </div>
438
- </div>
439
- <div class="tags">
440
- <p class="tag_title">Parameters:</p>
441
- <ul class="param">
442
-
443
- <li>
444
-
445
- <span class='name'>keys_method</span>
446
-
447
-
448
- <span class='type'>(<tt>Symbol</tt>)</span>
449
-
450
-
451
-
452
- &mdash;
453
- <div class='inline'><p>The method to use for keys.</p>
454
- </div>
455
-
456
- </li>
457
-
458
- <li>
459
-
460
- <span class='name'>values_method</span>
461
-
462
-
463
- <span class='type'>(<tt>Symbol</tt>)</span>
464
-
465
-
466
-
467
- &mdash;
468
- <div class='inline'><p>The method to use for values.</p>
469
- </div>
470
-
471
- </li>
472
-
473
- <li>
474
-
475
- <span class='name'>options</span>
476
-
477
-
478
- <span class='type'>(<tt>Hash</tt>)</span>
479
-
480
-
481
-
482
- &mdash;
483
- <div class='inline'><p>The options to pass to all methods.</p>
484
- </div>
485
-
486
- </li>
487
-
488
- </ul>
489
-
490
- <p class="tag_title">Returns:</p>
491
- <ul class="return">
492
-
493
- <li>
494
-
495
-
496
- <span class='type'>(<tt>Hash</tt>)</span>
497
-
498
-
499
-
500
- &mdash;
501
- <div class='inline'><p>A hash of all known emojis.</p>
502
- </div>
503
-
504
- </li>
505
-
506
- </ul>
507
-
508
- </div><table class="source_code">
509
- <tr>
510
- <td>
511
- <pre class="lines">
512
-
513
-
514
- 40
515
- 41
516
- 42
517
- 43
518
- 44
519
- 45
520
- 46
521
- 47
522
- 48
523
- 49</pre>
524
- </td>
525
- <td>
526
- <pre class="code"><span class="info file"># File 'lib/ballast/emoji.rb', line 40</span>
527
-
528
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_enumerate identifier id'>enumerate</span><span class='lparen token'>(</span><span class='label val'>keys_method:</span> <span class='symbol val'>:markup</span><span class='comma token'>,</span> <span class='label val'>values_method:</span> <span class='symbol val'>:html</span><span class='comma token'>,</span> <span class='pow op'>**</span><span class='rubyid_options identifier id'>options</span><span class='rparen token'>)</span>
529
- <span class='rubyid_tester identifier id'>tester</span> <span class='assign token'>=</span> <span class='colon3 op'>::</span><span class='rubyid_Emoji constant id'>Emoji</span><span class='colon2 op'>::</span><span class='rubyid_Character constant id'>Character</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
530
- <span class='rubyid_keys_method identifier id'>keys_method</span> <span class='assign token'>=</span> <span class='symbol val'>:markup</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_keys_method identifier id'>keys_method</span> <span class='andop op'>&amp;&amp;</span> <span class='rubyid_tester identifier id'>tester</span><span class='dot token'>.</span><span class='rubyid_respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='rubyid_keys_method identifier id'>keys_method</span><span class='rparen token'>)</span>
531
- <span class='rubyid_values_method identifier id'>values_method</span> <span class='assign token'>=</span> <span class='symbol val'>:html</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_values_method identifier id'>values_method</span> <span class='andop op'>&amp;&amp;</span> <span class='rubyid_tester identifier id'>tester</span><span class='dot token'>.</span><span class='rubyid_respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='rubyid_values_method identifier id'>values_method</span><span class='rparen token'>)</span>
532
-
533
- <span class='colon3 op'>::</span><span class='rubyid_Emoji constant id'>Emoji</span><span class='dot token'>.</span><span class='rubyid_all identifier id'>all</span><span class='dot token'>.</span><span class='rubyid_reduce identifier id'>reduce</span><span class='lparen token'>(</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> <span class='rubyid_do do kw'>do</span> <span class='bitor op'>|</span><span class='rubyid_accu identifier id'>accu</span><span class='comma token'>,</span> <span class='rubyid_icon identifier id'>icon</span><span class='bitor op'>|</span>
534
- <span class='rubyid_accu identifier id'>accu</span><span class='lbrack token'>[</span><span class='rubyid_invoke identifier id'>invoke</span><span class='lparen token'>(</span><span class='rubyid_icon identifier id'>icon</span><span class='comma token'>,</span> <span class='rubyid_keys_method identifier id'>keys_method</span><span class='comma token'>,</span> <span class='rubyid_options identifier id'>options</span><span class='rparen token'>)</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_invoke identifier id'>invoke</span><span class='lparen token'>(</span><span class='rubyid_icon identifier id'>icon</span><span class='comma token'>,</span> <span class='rubyid_values_method identifier id'>values_method</span><span class='comma token'>,</span> <span class='rubyid_options identifier id'>options</span><span class='rparen token'>)</span>
535
- <span class='rubyid_accu identifier id'>accu</span>
536
- <span class='rubyid_end end kw'>end</span>
537
- <span class='rubyid_end end kw'>end</span>
538
- </pre>
539
- </td>
540
- </tr>
541
- </table>
542
- </div>
543
-
544
- <div class="method_details ">
545
- <h3 class="signature " id="replace-instance_method">
546
-
547
- - (<tt>String</tt>) <strong>replace</strong>(text, mode: :html, **options)
548
-
549
-
550
-
551
-
552
-
553
- </h3><div class="docstring">
554
- <div class="discussion">
555
- <p>Replaces all the emojis in the text using the requested mod.</p>
556
-
557
-
558
- </div>
559
- </div>
560
- <div class="tags">
561
- <p class="tag_title">Parameters:</p>
562
- <ul class="param">
563
-
564
- <li>
565
-
566
- <span class='name'>text</span>
567
-
568
-
569
- <span class='type'>(<tt>String</tt>)</span>
570
-
571
-
572
-
573
- &mdash;
574
- <div class='inline'><p>The text to manipulate.</p>
575
- </div>
576
-
577
- </li>
578
-
579
- <li>
580
-
581
- <span class='name'>mode</span>
582
-
583
-
584
- <span class='type'>(<tt>Symbol</tt>)</span>
585
-
586
-
587
-
588
- &mdash;
589
- <div class='inline'><p>The method to use when replacing icons.</p>
590
- </div>
591
-
592
- </li>
593
-
594
- <li>
595
-
596
- <span class='name'>options</span>
597
-
598
-
599
- <span class='type'>(<tt>Hash</tt>)</span>
600
-
601
-
602
-
603
- &mdash;
604
- <div class='inline'><p>The options to pass to the replacing method.</p>
605
- </div>
606
-
607
- </li>
608
-
609
- </ul>
610
-
611
- <p class="tag_title">Returns:</p>
612
- <ul class="return">
613
-
614
- <li>
615
-
616
-
617
- <span class='type'>(<tt>String</tt>)</span>
618
-
619
-
620
-
621
- &mdash;
622
- <div class='inline'><p>The text with all emojis replaced.</p>
623
- </div>
624
-
625
- </li>
626
-
627
- </ul>
628
-
629
- </div><table class="source_code">
630
- <tr>
631
- <td>
632
- <pre class="lines">
633
-
634
-
635
- 29
636
- 30
637
- 31
638
- 32</pre>
639
- </td>
640
- <td>
641
- <pre class="code"><span class="info file"># File 'lib/ballast/emoji.rb', line 29</span>
642
-
643
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_replace identifier id'>replace</span><span class='lparen token'>(</span><span class='rubyid_text identifier id'>text</span><span class='comma token'>,</span> <span class='label val'>mode:</span> <span class='symbol val'>:html</span><span class='comma token'>,</span> <span class='pow op'>**</span><span class='rubyid_options identifier id'>options</span><span class='rparen token'>)</span>
644
- <span class='rubyid_mode identifier id'>mode</span> <span class='assign token'>=</span> <span class='symbol val'>:markup</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_mode identifier id'>mode</span> <span class='andop op'>&amp;&amp;</span> <span class='colon3 op'>::</span><span class='rubyid_Emoji constant id'>Emoji</span><span class='colon2 op'>::</span><span class='rubyid_Character constant id'>Character</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='rubyid_mode identifier id'>mode</span><span class='rparen token'>)</span>
645
- <span class='rubyid_text identifier id'>text</span><span class='dot token'>.</span><span class='rubyid_ensure_string identifier id'>ensure_string</span><span class='dot token'>.</span><span class='rubyid_gsub identifier id'>gsub</span><span class='lparen token'>(</span><span class='rubyid_replace_regex identifier id'>replace_regex</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='rubyid_invoke identifier id'>invoke</span><span class='lparen token'>(</span><span class='colon3 op'>::</span><span class='rubyid_Emoji constant id'>Emoji</span><span class='dot token'>.</span><span class='rubyid_find_by_unicode identifier id'>find_by_unicode</span><span class='lparen token'>(</span><span class='rubyid_Regexp constant id'>Regexp</span><span class='dot token'>.</span><span class='rubyid_last_match identifier id'>last_match</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='rubyid_mode identifier id'>mode</span><span class='comma token'>,</span> <span class='rubyid_options identifier id'>options</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span>
646
- <span class='rubyid_end end kw'>end</span>
647
- </pre>
648
- </td>
649
- </tr>
650
- </table>
651
- </div>
652
-
653
- <div class="method_details ">
654
- <h3 class="signature " id="replace_regex-instance_method">
655
-
656
- - (<tt>Regexp</tt>) <strong>replace_regex</strong>
657
-
658
-
659
-
660
-
661
-
662
- </h3><div class="docstring">
663
- <div class="discussion">
664
- <p>Returns the regular expression which matches all the known emojis.</p>
665
-
666
-
667
- </div>
668
- </div>
669
- <div class="tags">
670
-
671
- <p class="tag_title">Returns:</p>
672
- <ul class="return">
673
-
674
- <li>
675
-
676
-
677
- <span class='type'>(<tt>Regexp</tt>)</span>
678
-
679
-
680
-
681
- &mdash;
682
- <div class='inline'><p>The regular expression which matches all the known emojis.</p>
683
- </div>
684
-
685
- </li>
686
-
687
- </ul>
688
-
689
- </div><table class="source_code">
690
- <tr>
691
- <td>
692
- <pre class="lines">
693
-
694
-
695
- 19
696
- 20
697
- 21</pre>
698
- </td>
699
- <td>
700
- <pre class="code"><span class="info file"># File 'lib/ballast/emoji.rb', line 19</span>
701
-
702
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_replace_regex identifier id'>replace_regex</span>
703
- <span class='rubyid_@replace_regex ivar id'>@replace_regex</span> <span class='opasgn op'>||=</span> <span class='dregexp node'>/(#{::Emoji.send(:unicodes_index).keys.join(&quot;|&quot;)})/</span>
704
- <span class='rubyid_end end kw'>end</span>
705
- </pre>
706
- </td>
707
- </tr>
708
- </table>
709
- </div>
710
-
711
- <div class="method_details ">
712
- <h3 class="signature " id="url_for-instance_method">
713
-
714
- - (<tt>String</tt>) <strong>url_for</strong>(image)
715
-
716
-
717
-
718
-
719
-
720
- </h3><div class="docstring">
721
- <div class="discussion">
722
- <p>Returns a absolute URL for a emoji image.</p>
723
-
724
-
725
- </div>
726
- </div>
727
- <div class="tags">
728
- <p class="tag_title">Parameters:</p>
729
- <ul class="param">
730
-
731
- <li>
732
-
733
- <span class='name'>image</span>
734
-
735
-
736
- <span class='type'>(<tt>String</tt>)</span>
737
-
738
-
739
-
740
- &mdash;
741
- <div class='inline'><p>The relative URL of the emoji filename.</p>
742
- </div>
743
-
744
- </li>
745
-
746
- </ul>
747
-
748
- <p class="tag_title">Returns:</p>
749
- <ul class="return">
750
-
751
- <li>
752
-
753
-
754
- <span class='type'>(<tt>String</tt>)</span>
755
-
756
-
757
-
758
- &mdash;
759
- <div class='inline'><p>The absolute URL of the emoji filename.</p>
760
- </div>
761
-
762
- </li>
763
-
764
- </ul>
765
-
766
- </div><table class="source_code">
767
- <tr>
768
- <td>
769
- <pre class="lines">
770
-
771
-
772
- 62
773
- 63
774
- 64</pre>
775
- </td>
776
- <td>
777
- <pre class="code"><span class="info file"># File 'lib/ballast/emoji.rb', line 62</span>
778
-
779
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_url_for identifier id'>url_for</span><span class='lparen token'>(</span><span class='rubyid_image identifier id'>image</span><span class='rparen token'>)</span>
780
- <span class='rubyid_url_mapper identifier id'>url_mapper</span><span class='dot token'>.</span><span class='rubyid_call identifier id'>call</span><span class='lparen token'>(</span><span class='rubyid_image identifier id'>image</span><span class='rparen token'>)</span>
781
- <span class='rubyid_end end kw'>end</span>
782
- </pre>
783
- </td>
784
- </tr>
785
- </table>
786
- </div>
787
-
788
- </div>
789
-
790
- </div>
791
-
792
- <div id="footer">
793
- Generated on Tue Mar 29 10:52:51 2016 by
794
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
795
- 0.8.7.6 (ruby-2.3.0).
796
- </div>
797
-
798
- </body>
799
- </html>