Class: Helios::Seo::ResourcePresenter

Inherits:

Object

Object
Helios::Seo::ResourcePresenter

show all

Defined in:: app/services/helios/seo/resource_presenter.rb

Overview

Wraps a content resource + configuration and exposes the resolved, render-ready SEO values. Shared by TagsHelper and SchemaBuilder so the two never disagree. Targets the resource contract:

name, slug, description, keywords, created_at, updated_at, published?

and degrades gracefully when optional methods are absent.

Instance Attribute Summary collapse

#config ⇒ Object readonly
Returns the value of attribute config.
#resource ⇒ Object readonly
Returns the value of attribute resource.

Instance Method Summary collapse

#canonical_url ⇒ Object
#description ⇒ Object
SERP-friendly plain-text description, falling back to the default.
#document_title ⇒ Object
The tag: a resolver override, else the configured template.</p></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#faqs-instance_method" title="#faqs (instance method)">#<strong>faqs</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'><p>Normalized FAQ pairs; empty unless the host's resolver returns items.</p></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#image_url-instance_method" title="#image_url (instance method)">#<strong>image_url</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'><p>Social-share image: resolver first, then the configured default.</p></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(resource, config = Helios::Seo.configuration, view: nil) ⇒ ResourcePresenter </a> </span> <span class="note title constructor">constructor</span> <span class="summary_desc"><div class='inline'><p><code>view</code> is the ActionView context (passed by TagsHelper).</p></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#keywords-instance_method" title="#keywords (instance method)">#<strong>keywords</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#modified_time-instance_method" title="#modified_time (instance method)">#<strong>modified_time</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> ⇒ Object </a> (also: #headline) </span> <span class="summary_desc"><div class='inline'><p>The content title (used for og:title, twitter:title, schema headline).</p></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#published%3F-instance_method" title="#published? (instance method)">#<strong>published?</strong> ⇒ Boolean </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#published_time-instance_method" title="#published_time (instance method)">#<strong>published_time</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'><p>ISO-8601 timestamps, emitted only for published resources.</p></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#robots-instance_method" title="#robots (instance method)">#<strong>robots</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></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>(resource, config = Helios::Seo.configuration, view: nil) ⇒ <tt><span class='object_link'><a href="" title="Helios::Seo::ResourcePresenter (class)">ResourcePresenter</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p><code>view</code> is the ActionView context (passed by TagsHelper). Resolvers that need it to build URLs — e.g. an image_resolver generating an ActiveStorage proxy URL — can declare a second argument and receive it.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 14 15 16 17 18</pre> </td> <td> <pre class="code"><span class="info file"># File 'app/services/helios/seo/resource_presenter.rb', line 14</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='id identifier rubyid_config'>config</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../Helios.html" title="Helios (module)">Helios</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Seo.html" title="Helios::Seo (module)">Seo</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configuration'><span class='object_link'><a href="../Seo.html#configuration-class_method" title="Helios::Seo.configuration (method)">configuration</a></span></span><span class='comma'>,</span> <span class='label'>view:</span> <span class='kw'>nil</span><span class='rparen'>)</span> <span class='ivar'>@resource</span> <span class='op'>=</span> <span class='id identifier rubyid_resource'>resource</span> <span class='ivar'>@config</span> <span class='op'>=</span> <span class='id identifier rubyid_config'>config</span> <span class='ivar'>@view</span> <span class='op'>=</span> <span class='id identifier rubyid_view'>view</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> <div id="instance_attr_details" class="attr_details"> <h2>Instance Attribute Details</h2> <span id=""></span> <div class="method_details first"> <h3 class="signature first" id="config-instance_method"> #<strong>config</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns the value of attribute config.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 9 10 11</pre> </td> <td> <pre class="code"><span class="info file"># File 'app/services/helios/seo/resource_presenter.rb', line 9</span> <span class='kw'>def</span> <span class='id identifier rubyid_config'>config</span> <span class='ivar'>@config</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="resource-instance_method"> #<strong>resource</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns the value of attribute resource.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 9 10 11</pre> </td> <td> <pre class="code"><span class="info file"># File 'app/services/helios/seo/resource_presenter.rb', line 9</span> <span class='kw'>def</span> <span class='id identifier rubyid_resource'>resource</span> <span class='ivar'>@resource</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="canonical_url-instance_method"> #<strong>canonical_url</strong> ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 49 50 51</pre> </td> <td> <pre class="code"><span class="info file"># File 'app/services/helios/seo/resource_presenter.rb', line 49</span> <span class='kw'>def</span> <span class='id identifier rubyid_canonical_url'>canonical_url</span> <span class='id identifier rubyid_resolve'>resolve</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_canonical_url'>canonical_url</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_presence'>presence</span> <span class='op'>||</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_default_canonical_url'>default_canonical_url</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="description-instance_method"> #<strong>description</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>SERP-friendly plain-text description, falling back to the default.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 37 38 39 40 41 42 43</pre> </td> <td> <pre class="code"><span class="info file"># File 'app/services/helios/seo/resource_presenter.rb', line 37</span> <span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span> <span class='id identifier rubyid_text'>text</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span><span class='lparen'>(</span><span class='symbol'>:description</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_squish'>squish</span> <span class='id identifier rubyid_text'>text</span> <span class='op'>=</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_default_description'>default_description</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='kw'>if</span> <span class='id identifier rubyid_text'>text</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span> <span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='id identifier rubyid_text'>text</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span> <span class='id identifier rubyid_text'>text</span><span class='period'>.</span><span class='id identifier rubyid_truncate'>truncate</span><span class='lparen'>(</span><span class='int'>160</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="document_title-instance_method"> #<strong>document_title</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>The <title> tag: a resolver override, else the configured template.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 27 28 29 30 31 32 33 34</pre> </td> <td> <pre class="code"><span class="info file"># File 'app/services/helios/seo/resource_presenter.rb', line 27</span> <span class='kw'>def</span> <span class='id identifier rubyid_document_title'>document_title</span> <span class='id identifier rubyid_override'>override</span> <span class='op'>=</span> <span class='id identifier rubyid_resolve'>resolve</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_title_resolver'>title_resolver</span><span class='rparen'>)</span> <span class='kw'>return</span> <span class='id identifier rubyid_override'>override</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='kw'>if</span> <span class='id identifier rubyid_override'>override</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span> <span class='id identifier rubyid_format'>format</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_title_template'>title_template</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span> <span class='label'>title:</span> <span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span> <span class='label'>site_name:</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_site_name'>site_name</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="faqs-instance_method"> #<strong>faqs</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>Normalized FAQ pairs; empty unless the host's resolver returns items.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 76 77 78 79 80 81 82 83 84 85 86</pre> </td> <td> <pre class="code"><span class="info file"># File 'app/services/helios/seo/resource_presenter.rb', line 76</span> <span class='kw'>def</span> <span class='id identifier rubyid_faqs'>faqs</span> <span class='const'>Array</span><span class='lparen'>(</span><span class='id identifier rubyid_resolve'>resolve</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_faq_resolver'>faq_resolver</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_filter_map'>filter_map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_item'>item</span><span class='op'>|</span> <span class='kw'>next</span> <span class='kw'>unless</span> <span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:[]</span><span class='rparen'>)</span> <span class='id identifier rubyid_question'>question</span> <span class='op'>=</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='symbol'>:question</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>question</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='id identifier rubyid_answer'>answer</span> <span class='op'>=</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='symbol'>:answer</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>answer</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='kw'>next</span> <span class='kw'>if</span> <span class='id identifier rubyid_question'>question</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span> <span class='op'>||</span> <span class='id identifier rubyid_answer'>answer</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span> <span class='lbrace'>{</span> <span class='label'>question:</span> <span class='id identifier rubyid_question'>question</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span> <span class='label'>answer:</span> <span class='id identifier rubyid_answer'>answer</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span> <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="image_url-instance_method"> #<strong>image_url</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>Social-share image: resolver first, then the configured default.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 58 59 60</pre> </td> <td> <pre class="code"><span class="info file"># File 'app/services/helios/seo/resource_presenter.rb', line 58</span> <span class='kw'>def</span> <span class='id identifier rubyid_image_url'>image_url</span> <span class='id identifier rubyid_resolve'>resolve</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_image_resolver'>image_resolver</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_presence'>presence</span> <span class='op'>||</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_default_og_image'>default_og_image</span><span class='period'>.</span><span class='id identifier rubyid_presence'>presence</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="keywords-instance_method"> #<strong>keywords</strong> ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 45 46 47</pre> </td> <td> <pre class="code"><span class="info file"># File 'app/services/helios/seo/resource_presenter.rb', line 45</span> <span class='kw'>def</span> <span class='id identifier rubyid_keywords'>keywords</span> <span class='id identifier rubyid_value'>value</span><span class='lparen'>(</span><span class='symbol'>:keywords</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_presence'>presence</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="modified_time-instance_method"> #<strong>modified_time</strong> ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 71 72 73</pre> </td> <td> <pre class="code"><span class="info file"># File 'app/services/helios/seo/resource_presenter.rb', line 71</span> <span class='kw'>def</span> <span class='id identifier rubyid_modified_time'>modified_time</span> <span class='id identifier rubyid_published?'>published?</span> <span class='op'>?</span> <span class='id identifier rubyid_iso8601'>iso8601</span><span class='lparen'>(</span><span class='symbol'>:updated_at</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='kw'>nil</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="name-instance_method"> #<strong>name</strong> ⇒ <tt>Object</tt> <span class="aliases">Also known as: <span class="names"><span id='headline-instance_method'>headline</span></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>The content title (used for og:title, twitter:title, schema headline).</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 21 22 23</pre> </td> <td> <pre class="code"><span class="info file"># File 'app/services/helios/seo/resource_presenter.rb', line 21</span> <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span> <span class='id identifier rubyid_value'>value</span><span class='lparen'>(</span><span class='symbol'>:name</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="published?-instance_method"> #<strong>published?</strong> ⇒ <tt>Boolean</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>Boolean</tt>)</span> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 62 63 64</pre> </td> <td> <pre class="code"><span class="info file"># File 'app/services/helios/seo/resource_presenter.rb', line 62</span> <span class='kw'>def</span> <span class='id identifier rubyid_published?'>published?</span> <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:published?</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='op'>!</span><span class='op'>!</span><span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_published?'>published?</span> <span class='op'>:</span> <span class='kw'>true</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="published_time-instance_method"> #<strong>published_time</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>ISO-8601 timestamps, emitted only for published resources.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 67 68 69</pre> </td> <td> <pre class="code"><span class="info file"># File 'app/services/helios/seo/resource_presenter.rb', line 67</span> <span class='kw'>def</span> <span class='id identifier rubyid_published_time'>published_time</span> <span class='id identifier rubyid_published?'>published?</span> <span class='op'>?</span> <span class='id identifier rubyid_iso8601'>iso8601</span><span class='lparen'>(</span><span class='symbol'>:created_at</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='kw'>nil</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="robots-instance_method"> #<strong>robots</strong> ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 53 54 55</pre> </td> <td> <pre class="code"><span class="info file"># File 'app/services/helios/seo/resource_presenter.rb', line 53</span> <span class='kw'>def</span> <span class='id identifier rubyid_robots'>robots</span> <span class='id identifier rubyid_resolve'>resolve</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_robots_resolver'>robots_resolver</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_presence'>presence</span> <span class='op'>||</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_default_robots'>default_robots</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Thu Jul 30 14:00:32 2026 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.45 (ruby-4.0.2). </div> </div> </body> </html>