html2rss 0.4.1 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (46) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +3 -0
  3. data/CHANGELOG.md +10 -1
  4. data/Gemfile.lock +3 -1
  5. data/README.md +35 -2
  6. data/html2rss.gemspec +1 -0
  7. data/lib/html2rss/attribute_post_processors/sanitize_html.rb +1 -3
  8. data/lib/html2rss/config.rb +4 -0
  9. data/lib/html2rss/item.rb +7 -4
  10. data/lib/html2rss/utils.rb +8 -0
  11. data/lib/html2rss/version.rb +1 -1
  12. metadata +15 -35
  13. data/docs/Html2rss.html +0 -353
  14. data/docs/Html2rss/AttributePostProcessors.html +0 -203
  15. data/docs/Html2rss/AttributePostProcessors/HtmlToMarkdown.html +0 -325
  16. data/docs/Html2rss/AttributePostProcessors/ParseTime.html +0 -326
  17. data/docs/Html2rss/AttributePostProcessors/ParseUri.html +0 -314
  18. data/docs/Html2rss/AttributePostProcessors/SanitizeHtml.html +0 -367
  19. data/docs/Html2rss/AttributePostProcessors/Substring.html +0 -321
  20. data/docs/Html2rss/AttributePostProcessors/Template.html +0 -336
  21. data/docs/Html2rss/Config.html +0 -847
  22. data/docs/Html2rss/FeedBuilder.html +0 -295
  23. data/docs/Html2rss/Item.html +0 -660
  24. data/docs/Html2rss/ItemExtractors.html +0 -297
  25. data/docs/Html2rss/ItemExtractors/Attribute.html +0 -317
  26. data/docs/Html2rss/ItemExtractors/CurrentTime.html +0 -297
  27. data/docs/Html2rss/ItemExtractors/Href.html +0 -319
  28. data/docs/Html2rss/ItemExtractors/Html.html +0 -314
  29. data/docs/Html2rss/ItemExtractors/Static.html +0 -301
  30. data/docs/Html2rss/ItemExtractors/Text.html +0 -312
  31. data/docs/Html2rss/Utils.html +0 -200
  32. data/docs/Html2rss/Utils/IndifferentAccessHash.html +0 -142
  33. data/docs/_index.html +0 -307
  34. data/docs/class_list.html +0 -51
  35. data/docs/css/common.css +0 -1
  36. data/docs/css/full_list.css +0 -58
  37. data/docs/css/style.css +0 -496
  38. data/docs/file.README.html +0 -135
  39. data/docs/file_list.html +0 -56
  40. data/docs/frames.html +0 -17
  41. data/docs/index.html +0 -135
  42. data/docs/js/app.js +0 -303
  43. data/docs/js/full_list.js +0 -216
  44. data/docs/js/jquery.js +0 -4
  45. data/docs/method_list.html +0 -467
  46. data/docs/top-level-namespace.html +0 -110
@@ -1,203 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <meta charset="utf-8">
5
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <title>
7
- Module: Html2rss::AttributePostProcessors
8
-
9
- &mdash; Documentation by YARD 0.9.20
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
- pathId = "Html2rss::AttributePostProcessors";
19
- relpath = '../';
20
- </script>
21
-
22
-
23
- <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
-
25
- <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
-
27
-
28
- </head>
29
- <body>
30
- <div class="nav_wrap">
31
- <iframe id="nav" src="../class_list.html?1"></iframe>
32
- <div id="resizer"></div>
33
- </div>
34
-
35
- <div id="main" tabindex="-1">
36
- <div id="header">
37
- <div id="menu">
38
-
39
- <a href="../_index.html">Index (A)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../Html2rss.html" title="Html2rss (module)">Html2rss</a></span></span>
41
- &raquo;
42
- <span class="title">AttributePostProcessors</span>
43
-
44
- </div>
45
-
46
- <div id="search">
47
-
48
- <a class="full_list_link" id="class_list_link"
49
- href="../class_list.html">
50
-
51
- <svg width="24" height="24">
52
- <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
- <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
- <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
- </svg>
56
- </a>
57
-
58
- </div>
59
- <div class="clear"></div>
60
- </div>
61
-
62
- <div id="content"><h1>Module: Html2rss::AttributePostProcessors
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
-
70
-
71
-
72
-
73
-
74
-
75
-
76
-
77
-
78
-
79
- <dl>
80
- <dt>Defined in:</dt>
81
- <dd>lib/html2rss/attribute_post_processors.rb<span class="defines">,<br />
82
- lib/html2rss/attribute_post_processors/template.rb,<br /> lib/html2rss/attribute_post_processors/parse_uri.rb,<br /> lib/html2rss/attribute_post_processors/substring.rb,<br /> lib/html2rss/attribute_post_processors/parse_time.rb,<br /> lib/html2rss/attribute_post_processors/sanitize_html.rb,<br /> lib/html2rss/attribute_post_processors/html_to_markdown.rb</span>
83
- </dd>
84
- </dl>
85
-
86
- </div>
87
-
88
- <h2>Overview</h2><div class="docstring">
89
- <div class="discussion">
90
-
91
- <p>Provides a namespace for attribute post processors.</p>
92
-
93
-
94
- </div>
95
- </div>
96
- <div class="tags">
97
-
98
-
99
- </div><h2>Defined Under Namespace</h2>
100
- <p class="children">
101
-
102
-
103
-
104
-
105
- <strong class="classes">Classes:</strong> <span class='object_link'><a href="AttributePostProcessors/HtmlToMarkdown.html" title="Html2rss::AttributePostProcessors::HtmlToMarkdown (class)">HtmlToMarkdown</a></span>, <span class='object_link'><a href="AttributePostProcessors/ParseTime.html" title="Html2rss::AttributePostProcessors::ParseTime (class)">ParseTime</a></span>, <span class='object_link'><a href="AttributePostProcessors/ParseUri.html" title="Html2rss::AttributePostProcessors::ParseUri (class)">ParseUri</a></span>, <span class='object_link'><a href="AttributePostProcessors/SanitizeHtml.html" title="Html2rss::AttributePostProcessors::SanitizeHtml (class)">SanitizeHtml</a></span>, <span class='object_link'><a href="AttributePostProcessors/Substring.html" title="Html2rss::AttributePostProcessors::Substring (class)">Substring</a></span>, <span class='object_link'><a href="AttributePostProcessors/Template.html" title="Html2rss::AttributePostProcessors::Template (class)">Template</a></span>
106
-
107
-
108
- </p>
109
-
110
-
111
-
112
-
113
-
114
-
115
-
116
-
117
- <h2>
118
- Class Method Summary
119
- <small><a href="#" class="summary_toggle">collapse</a></small>
120
- </h2>
121
-
122
- <ul class="summary">
123
-
124
- <li class="public ">
125
- <span class="summary_signature">
126
-
127
- <a href="#get_processor-class_method" title="get_processor (class method)">.<strong>get_processor</strong>(name) &#x21d2; Object </a>
128
-
129
-
130
-
131
- </span>
132
-
133
-
134
-
135
-
136
-
137
-
138
-
139
-
140
-
141
- <span class="summary_desc"><div class='inline'></div></span>
142
-
143
- </li>
144
-
145
-
146
- </ul>
147
-
148
-
149
-
150
-
151
- <div id="class_method_details" class="method_details_list">
152
- <h2>Class Method Details</h2>
153
-
154
-
155
- <div class="method_details first">
156
- <h3 class="signature first" id="get_processor-class_method">
157
-
158
- .<strong>get_processor</strong>(name) &#x21d2; <tt>Object</tt>
159
-
160
-
161
-
162
-
163
-
164
- </h3><table class="source_code">
165
- <tr>
166
- <td>
167
- <pre class="lines">
168
-
169
-
170
- 12
171
- 13
172
- 14
173
- 15
174
- 16
175
- 17</pre>
176
- </td>
177
- <td>
178
- <pre class="code"><span class="info file"># File 'lib/html2rss/attribute_post_processors.rb', line 12</span>
179
-
180
- <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_processor'>get_processor</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
181
- <span class='id identifier rubyid_camel_cased_name'>camel_cased_name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>_</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:capitalize</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span>
182
- <span class='id identifier rubyid_class_name'>class_name</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Html2rss</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>AttributePostProcessors</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_camel_cased_name'>camel_cased_name</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>::</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
183
-
184
- <span class='const'>Object</span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span><span class='lparen'>(</span><span class='id identifier rubyid_class_name'>class_name</span><span class='rparen'>)</span>
185
- <span class='kw'>end</span></pre>
186
- </td>
187
- </tr>
188
- </table>
189
- </div>
190
-
191
- </div>
192
-
193
- </div>
194
-
195
- <div id="footer">
196
- Generated on Wed Sep 18 12:52:16 2019 by
197
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
198
- 0.9.20 (ruby-2.6.3).
199
- </div>
200
-
201
- </div>
202
- </body>
203
- </html>
@@ -1,325 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <meta charset="utf-8">
5
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <title>
7
- Class: Html2rss::AttributePostProcessors::HtmlToMarkdown
8
-
9
- &mdash; Documentation by YARD 0.9.20
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
- pathId = "Html2rss::AttributePostProcessors::HtmlToMarkdown";
19
- relpath = '../../';
20
- </script>
21
-
22
-
23
- <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
-
25
- <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
-
27
-
28
- </head>
29
- <body>
30
- <div class="nav_wrap">
31
- <iframe id="nav" src="../../class_list.html?1"></iframe>
32
- <div id="resizer"></div>
33
- </div>
34
-
35
- <div id="main" tabindex="-1">
36
- <div id="header">
37
- <div id="menu">
38
-
39
- <a href="../../_index.html">Index (H)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../../Html2rss.html" title="Html2rss (module)">Html2rss</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../AttributePostProcessors.html" title="Html2rss::AttributePostProcessors (module)">AttributePostProcessors</a></span></span>
41
- &raquo;
42
- <span class="title">HtmlToMarkdown</span>
43
-
44
- </div>
45
-
46
- <div id="search">
47
-
48
- <a class="full_list_link" id="class_list_link"
49
- href="../../class_list.html">
50
-
51
- <svg width="24" height="24">
52
- <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
- <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
- <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
- </svg>
56
- </a>
57
-
58
- </div>
59
- <div class="clear"></div>
60
- </div>
61
-
62
- <div id="content"><h1>Class: Html2rss::AttributePostProcessors::HtmlToMarkdown
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
- <dl>
70
- <dt>Inherits:</dt>
71
- <dd>
72
- <span class="inheritName">Object</span>
73
-
74
- <ul class="fullTree">
75
- <li>Object</li>
76
-
77
- <li class="next">Html2rss::AttributePostProcessors::HtmlToMarkdown</li>
78
-
79
- </ul>
80
- <a href="#" class="inheritanceTree">show all</a>
81
-
82
- </dd>
83
- </dl>
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
-
94
-
95
- <dl>
96
- <dt>Defined in:</dt>
97
- <dd>lib/html2rss/attribute_post_processors/html_to_markdown.rb</dd>
98
- </dl>
99
-
100
- </div>
101
-
102
- <h2>Overview</h2><div class="docstring">
103
- <div class="discussion">
104
-
105
- <p>Returns HTML code as Markdown formatted String. Before converting to markdown, the HTML is sanitized with SanitizeHtml. Imagine this HTML structure:</p>
106
-
107
- <pre class="code ruby"><code class="ruby">&lt;section&gt;
108
- Lorem &lt;b&gt;ipsum&lt;/b&gt; dolor...
109
- &lt;iframe src=&quot;https://evil.corp/miner&quot;&gt;&lt;/iframe&gt;
110
- &lt;script&gt;alert();&lt;/script&gt;
111
- &lt;/section&gt;
112
- </code></pre>
113
-
114
- <p>YAML usage example:</p>
115
-
116
- <pre class="code ruby"><code class="ruby">selectors:
117
- description:
118
- selector: section
119
- extractor: html
120
- post_process:
121
- name: html_to_markdown
122
- </code></pre>
123
-
124
- <p>Would return:</p>
125
-
126
- <pre class="code ruby"><code class="ruby"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Lorem **ipsum** dolor</span><span class='tstring_end'>&#39;</span></span>
127
- </code></pre>
128
-
129
-
130
- </div>
131
- </div>
132
- <div class="tags">
133
-
134
-
135
- </div>
136
-
137
-
138
-
139
-
140
-
141
-
142
-
143
- <h2>
144
- Instance Method Summary
145
- <small><a href="#" class="summary_toggle">collapse</a></small>
146
- </h2>
147
-
148
- <ul class="summary">
149
-
150
- <li class="public ">
151
- <span class="summary_signature">
152
-
153
- <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong> &#x21d2; String </a>
154
-
155
-
156
-
157
- </span>
158
-
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
- <span class="summary_desc"><div class='inline'>
168
- <p>Formatted in Markdown.</p>
169
- </div></span>
170
-
171
- </li>
172
-
173
-
174
- <li class="public ">
175
- <span class="summary_signature">
176
-
177
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(value, env) &#x21d2; HtmlToMarkdown </a>
178
-
179
-
180
-
181
- </span>
182
-
183
-
184
- <span class="note title constructor">constructor</span>
185
-
186
-
187
-
188
-
189
-
190
-
191
-
192
-
193
- <span class="summary_desc"><div class='inline'>
194
- <p>A new instance of HtmlToMarkdown.</p>
195
- </div></span>
196
-
197
- </li>
198
-
199
-
200
- </ul>
201
-
202
-
203
- <div id="constructor_details" class="method_details_list">
204
- <h2>Constructor Details</h2>
205
-
206
- <div class="method_details first">
207
- <h3 class="signature first" id="initialize-instance_method">
208
-
209
- #<strong>initialize</strong>(value, env) &#x21d2; <tt><span class='object_link'><a href="" title="Html2rss::AttributePostProcessors::HtmlToMarkdown (class)">HtmlToMarkdown</a></span></tt>
210
-
211
-
212
-
213
-
214
-
215
- </h3><div class="docstring">
216
- <div class="discussion">
217
-
218
- <p>Returns a new instance of HtmlToMarkdown</p>
219
-
220
-
221
- </div>
222
- </div>
223
- <div class="tags">
224
-
225
-
226
- </div><table class="source_code">
227
- <tr>
228
- <td>
229
- <pre class="lines">
230
-
231
-
232
- 28
233
- 29
234
- 30</pre>
235
- </td>
236
- <td>
237
- <pre class="code"><span class="info file"># File 'lib/html2rss/attribute_post_processors/html_to_markdown.rb', line 28</span>
238
-
239
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_env'>env</span><span class='rparen'>)</span>
240
- <span class='ivar'>@value</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="SanitizeHtml.html" title="Html2rss::AttributePostProcessors::SanitizeHtml (class)">SanitizeHtml</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="SanitizeHtml.html#initialize-instance_method" title="Html2rss::AttributePostProcessors::SanitizeHtml#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_env'>env</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="SanitizeHtml.html#get-instance_method" title="Html2rss::AttributePostProcessors::SanitizeHtml#get (method)">get</a></span></span>
241
- <span class='kw'>end</span></pre>
242
- </td>
243
- </tr>
244
- </table>
245
- </div>
246
-
247
- </div>
248
-
249
-
250
- <div id="instance_method_details" class="method_details_list">
251
- <h2>Instance Method Details</h2>
252
-
253
-
254
- <div class="method_details first">
255
- <h3 class="signature first" id="get-instance_method">
256
-
257
- #<strong>get</strong> &#x21d2; <tt>String</tt>
258
-
259
-
260
-
261
-
262
-
263
- </h3><div class="docstring">
264
- <div class="discussion">
265
-
266
- <p>Returns formatted in Markdown</p>
267
-
268
-
269
- </div>
270
- </div>
271
- <div class="tags">
272
-
273
- <p class="tag_title">Returns:</p>
274
- <ul class="return">
275
-
276
- <li>
277
-
278
-
279
- <span class='type'>(<tt>String</tt>)</span>
280
-
281
-
282
-
283
- &mdash;
284
- <div class='inline'>
285
- <p>formatted in Markdown</p>
286
- </div>
287
-
288
- </li>
289
-
290
- </ul>
291
-
292
- </div><table class="source_code">
293
- <tr>
294
- <td>
295
- <pre class="lines">
296
-
297
-
298
- 34
299
- 35
300
- 36</pre>
301
- </td>
302
- <td>
303
- <pre class="code"><span class="info file"># File 'lib/html2rss/attribute_post_processors/html_to_markdown.rb', line 34</span>
304
-
305
- <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span>
306
- <span class='const'>ReverseMarkdown</span><span class='period'>.</span><span class='id identifier rubyid_convert'>convert</span> <span class='ivar'>@value</span>
307
- <span class='kw'>end</span></pre>
308
- </td>
309
- </tr>
310
- </table>
311
- </div>
312
-
313
- </div>
314
-
315
- </div>
316
-
317
- <div id="footer">
318
- Generated on Wed Sep 18 12:52:17 2019 by
319
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
320
- 0.9.20 (ruby-2.6.3).
321
- </div>
322
-
323
- </div>
324
- </body>
325
- </html>