RubyGems - html2rss - Versions diffs - 0.4.1 → 0.5.0 - Mend

html2rss 0.4.1 → 0.5.0

Files changed (46) hide show

checksums.yaml +4 -4
data/.rubocop.yml +3 -0
data/CHANGELOG.md +10 -1
data/Gemfile.lock +3 -1
data/README.md +35 -2
data/html2rss.gemspec +1 -0
data/lib/html2rss/attribute_post_processors/sanitize_html.rb +1 -3
data/lib/html2rss/config.rb +4 -0
data/lib/html2rss/item.rb +7 -4
data/lib/html2rss/utils.rb +8 -0
data/lib/html2rss/version.rb +1 -1
metadata +15 -35
data/docs/Html2rss.html +0 -353
data/docs/Html2rss/AttributePostProcessors.html +0 -203
data/docs/Html2rss/AttributePostProcessors/HtmlToMarkdown.html +0 -325
data/docs/Html2rss/AttributePostProcessors/ParseTime.html +0 -326
data/docs/Html2rss/AttributePostProcessors/ParseUri.html +0 -314
data/docs/Html2rss/AttributePostProcessors/SanitizeHtml.html +0 -367
data/docs/Html2rss/AttributePostProcessors/Substring.html +0 -321
data/docs/Html2rss/AttributePostProcessors/Template.html +0 -336
data/docs/Html2rss/Config.html +0 -847
data/docs/Html2rss/FeedBuilder.html +0 -295
data/docs/Html2rss/Item.html +0 -660
data/docs/Html2rss/ItemExtractors.html +0 -297
data/docs/Html2rss/ItemExtractors/Attribute.html +0 -317
data/docs/Html2rss/ItemExtractors/CurrentTime.html +0 -297
data/docs/Html2rss/ItemExtractors/Href.html +0 -319
data/docs/Html2rss/ItemExtractors/Html.html +0 -314
data/docs/Html2rss/ItemExtractors/Static.html +0 -301
data/docs/Html2rss/ItemExtractors/Text.html +0 -312
data/docs/Html2rss/Utils.html +0 -200
data/docs/Html2rss/Utils/IndifferentAccessHash.html +0 -142
data/docs/_index.html +0 -307
data/docs/class_list.html +0 -51
data/docs/css/common.css +0 -1
data/docs/css/full_list.css +0 -58
data/docs/css/style.css +0 -496
data/docs/file.README.html +0 -135
data/docs/file_list.html +0 -56
data/docs/frames.html +0 -17
data/docs/index.html +0 -135
data/docs/js/app.js +0 -303
data/docs/js/full_list.js +0 -216
data/docs/js/jquery.js +0 -4
data/docs/method_list.html +0 -467
data/docs/top-level-namespace.html +0 -110

data/docs/Html2rss/ItemExtractors.html DELETED

@@ -1,297 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Module: Html2rss::ItemExtractors
-    &mdash; Documentation by YARD 0.9.20
-</title>
-  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
-  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
-<script type="text/javascript" charset="utf-8">
-  pathId = "Html2rss::ItemExtractors";
-  relpath = '../';
-</script>
-  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
-  </head>
-  <body>
-    <div class="nav_wrap">
-      <iframe id="nav" src="../class_list.html?1"></iframe>
-      <div id="resizer"></div>
-    </div>
-    <div id="main" tabindex="-1">
-      <div id="header">
-        <div id="menu">
-    <a href="../_index.html">Index (I)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../Html2rss.html" title="Html2rss (module)">Html2rss</a></span></span>
-     &raquo;
-    <span class="title">ItemExtractors</span>
-</div>
-        <div id="search">
-    <a class="full_list_link" id="class_list_link"
-        href="../class_list.html">
-        <svg width="24" height="24">
-          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
-        </svg>
-    </a>
-</div>
-        <div class="clear"></div>
-      </div>
-      <div id="content"><h1>Module: Html2rss::ItemExtractors
-</h1>
-<div class="box_info">
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/html2rss/item_extractors.rb<span class="defines">,<br />
-  lib/html2rss/item_extractors/href.rb,<br /> lib/html2rss/item_extractors/html.rb,<br /> lib/html2rss/item_extractors/text.rb,<br /> lib/html2rss/item_extractors/static.rb,<br /> lib/html2rss/item_extractors/attribute.rb,<br /> lib/html2rss/item_extractors/current_time.rb</span>
-</dd>
-  </dl>
-</div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-<p>Provides a namespace for item extractors.</p>
-  </div>
-</div>
-<div class="tags">
-</div><h2>Defined Under Namespace</h2>
-<p class="children">
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="ItemExtractors/Attribute.html" title="Html2rss::ItemExtractors::Attribute (class)">Attribute</a></span>, <span class='object_link'><a href="ItemExtractors/CurrentTime.html" title="Html2rss::ItemExtractors::CurrentTime (class)">CurrentTime</a></span>, <span class='object_link'><a href="ItemExtractors/Href.html" title="Html2rss::ItemExtractors::Href (class)">Href</a></span>, <span class='object_link'><a href="ItemExtractors/Html.html" title="Html2rss::ItemExtractors::Html (class)">Html</a></span>, <span class='object_link'><a href="ItemExtractors/Static.html" title="Html2rss::ItemExtractors::Static (class)">Static</a></span>, <span class='object_link'><a href="ItemExtractors/Text.html" title="Html2rss::ItemExtractors::Text (class)">Text</a></span>
-</p>
-    <h2>
-      Constant Summary
-      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
-    </h2>
-    <dl class="constants">
-        <dt id="DEFAULT-constant" class="">DEFAULT =
-        </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>text</span><span class='tstring_end'>&#39;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
-    </dl>
-    <h2>
-      Class Method Summary
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#element-class_method" title="element (class method)">.<strong>element</strong>(xml, options)  &#x21d2; Nokogiri::XML::Element </a>
-  </span>
-    <span class="summary_desc"><div class='inline'></div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#get_extractor-class_method" title="get_extractor (class method)">.<strong>get_extractor</strong>(name)  &#x21d2; Object </a>
-  </span>
-    <span class="summary_desc"><div class='inline'></div></span>
-</li>
-    </ul>
-  <div id="class_method_details" class="method_details_list">
-    <h2>Class Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="element-class_method">
-    .<strong>element</strong>(xml, options)  &#x21d2; <tt>Nokogiri::XML::Element</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Nokogiri::XML::Element</tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-24
-25
-26
-27</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/html2rss/item_extractors.rb', line 24</span>
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_element'>element</span><span class='lparen'>(</span><span class='id identifier rubyid_xml'>xml</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_selector'>selector</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>selector</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
-  <span class='id identifier rubyid_selector'>selector</span> <span class='op'>?</span> <span class='id identifier rubyid_xml'>xml</span><span class='period'>.</span><span class='id identifier rubyid_css'>css</span><span class='lparen'>(</span><span class='id identifier rubyid_selector'>selector</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_xml'>xml</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="get_extractor-class_method">
-    .<strong>get_extractor</strong>(name)  &#x21d2; <tt>Object</tt>
-</h3><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-14
-15
-16
-17
-18
-19
-20</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/html2rss/item_extractors.rb', line 14</span>
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_extractor'>get_extractor</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_name'>name</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="#DEFAULT-constant" title="Html2rss::ItemExtractors::DEFAULT (constant)">DEFAULT</a></span></span>
-  <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>
-  <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'>ItemExtractors</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>
-  <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>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-      <div id="footer">
-  Generated on Wed Sep 18 12:52:16 2019 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.20 (ruby-2.6.3).
-</div>
-    </div>
-  </body>
-</html>

data/docs/Html2rss/ItemExtractors/Attribute.html DELETED

@@ -1,317 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Class: Html2rss::ItemExtractors::Attribute
-    &mdash; Documentation by YARD 0.9.20
-</title>
-  <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
-  <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
-<script type="text/javascript" charset="utf-8">
-  pathId = "Html2rss::ItemExtractors::Attribute";
-  relpath = '../../';
-</script>
-  <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
-  </head>
-  <body>
-    <div class="nav_wrap">
-      <iframe id="nav" src="../../class_list.html?1"></iframe>
-      <div id="resizer"></div>
-    </div>
-    <div id="main" tabindex="-1">
-      <div id="header">
-        <div id="menu">
-    <a href="../../_index.html">Index (A)</a> &raquo;
-    <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="../ItemExtractors.html" title="Html2rss::ItemExtractors (module)">ItemExtractors</a></span></span>
-     &raquo;
-    <span class="title">Attribute</span>
-</div>
-        <div id="search">
-    <a class="full_list_link" id="class_list_link"
-        href="../../class_list.html">
-        <svg width="24" height="24">
-          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
-        </svg>
-    </a>
-</div>
-        <div class="clear"></div>
-      </div>
-      <div id="content"><h1>Class: Html2rss::ItemExtractors::Attribute
-</h1>
-<div class="box_info">
-  <dl>
-    <dt>Inherits:</dt>
-    <dd>
-      <span class="inheritName">Object</span>
-        <ul class="fullTree">
-          <li>Object</li>
-            <li class="next">Html2rss::ItemExtractors::Attribute</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-    </dd>
-  </dl>
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/html2rss/item_extractors/attribute.rb</dd>
-  </dl>
-</div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-<p>Returns the value of the attribute.</p>
-<p>Imagine this <code>time</code> HTML element with a <code>datetime</code> attribute:</p>
-<pre class="code ruby"><code class="ruby">&lt;time datetime=&quot;2019-07-01&quot;&gt;...&lt;/time&gt;
-</code></pre>
-<p>YAML usage example:</p>
-<pre class="code ruby"><code class="ruby">selectors:
-  link:
-    selector: time
-    extractor: attribute
-    attribute: datetime
-</code></pre>
-<p>Would return:</p>
-<pre class="code ruby"><code class="ruby"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>2019-07-01</span><span class='tstring_end'>&#39;</span></span>
-</code></pre>
-<p>In case you&#39;re extracting a date or a time, do not forget to parse it during post processing with <a href="rdoc-ref:Html2rss::AttributePostProcessors::ParseTime">AttributePostProcessors::ParseTime</a>.</p>
-  </div>
-</div>
-<div class="tags">
-</div>
-    <h2>
-      Instance Method Summary
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>  &#x21d2; String </a>
-  </span>
-    <span class="summary_desc"><div class='inline'></div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(xml, options)  &#x21d2; Attribute </a>
-  </span>
-    <span class="note title constructor">constructor</span>
-    <span class="summary_desc"><div class='inline'>
-<p>A new instance of Attribute.</p>
-</div></span>
-</li>
-    </ul>
-<div id="constructor_details" class="method_details_list">
-  <h2>Constructor Details</h2>
-    <div class="method_details first">
-  <h3 class="signature first" id="initialize-instance_method">
-    #<strong>initialize</strong>(xml, options)  &#x21d2; <tt><span class='object_link'><a href="" title="Html2rss::ItemExtractors::Attribute (class)">Attribute</a></span></tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Returns a new instance of Attribute</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-25
-26
-27
-28</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/html2rss/item_extractors/attribute.rb', line 25</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_xml'>xml</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
-  <span class='ivar'>@options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span>
-  <span class='ivar'>@element</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../ItemExtractors.html" title="Html2rss::ItemExtractors (module)">ItemExtractors</a></span></span><span class='period'>.</span><span class='id identifier rubyid_element'><span class='object_link'><a href="../ItemExtractors.html#element-class_method" title="Html2rss::ItemExtractors.element (method)">element</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_xml'>xml</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-</div>
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="get-instance_method">
-    #<strong>get</strong>  &#x21d2; <tt>String</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>String</tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-32
-33
-34</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/html2rss/item_extractors/attribute.rb', line 32</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span>
-  <span class='ivar'>@element</span><span class='period'>.</span><span class='id identifier rubyid_attr'>attr</span><span class='lparen'>(</span><span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>attribute</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-      <div id="footer">
-  Generated on Wed Sep 18 12:52:16 2019 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.20 (ruby-2.6.3).
-</div>
-    </div>
-  </body>
-</html>