Module: Cms::Concerns::Addressable
- Defined in:
- lib/cms/concerns/can_be_addressable.rb
Defined Under Namespace
Modules: ClassMethods, DeprecatedPageAccessors, DynamicPath, MarkAsDirty, NodeAccessors
Class Method Summary collapse
-
.classes_that_require_custom_routes ⇒ Object
Returns all classes which need a custom route to show themselves.
-
.descendants ⇒ Array<Class>
List of all classes that can be in the sitemap.
Instance Method Summary collapse
-
#accessible_to_guests?(public_sections, parent) ⇒ Boolean
Resources are accessible to guests if their parent section is.
-
#ancestors(options = {}) ⇒ Array<Addressable>
Returns a list of all Addressable objects that are ancestors to this record.
- #cache_parent(section) ⇒ Object
-
#destroy_node ⇒ Object
Allows for manual destruction of node.
-
#landing_page? ⇒ Boolean
Whether or not this content is the 'landing' page for its section.
-
#page_title ⇒ String
Returns the value that will appear in the
element of the page when this content is rendered.</p></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/browsercms-artirix/Cms/Concerns/Addressable#parent-instance_method" title="#parent (instance method)">#<strong>parent</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/browsercms-artirix/Cms/Concerns/Addressable#parent=-instance_method" title="#parent= (instance method)">#<strong>parent=</strong>(sec) ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/browsercms-artirix/Cms/Concerns/Addressable#parent_id-instance_method" title="#parent_id (instance method)">#<strong>parent_id</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/browsercms-artirix/Cms/Concerns/Addressable#parent_id=-instance_method" title="#parent_id= (instance method)">#<strong>parent_id=</strong>(id) ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/browsercms-artirix/Cms/Concerns/Addressable#partial_for-instance_method" title="#partial_for (instance method)">#<strong>partial_for</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'><p>Computes the name of the partial used to render this object in the sitemap.</p></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="classes_that_require_custom_routes-class_method"> .<strong>classes_that_require_custom_routes</strong> ⇒ <tt>Object</tt> </h3><script> document.getElementById("classes_that_require_custom_routes-class_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FConcerns%2FAddressable%2Eclasses_that_require_custom_routes">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> <p>Returns all classes which need a custom route to show themselves.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 183 184 185</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/cms/concerns/can_be_addressable.rb', line 183</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_classes_that_require_custom_routes'>classes_that_require_custom_routes</span> <span class='id identifier rubyid_descendants'>descendants</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_klass'>klass</span><span class='op'>|</span> <span class='id identifier rubyid_klass'>klass</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span> <span class='op'>!=</span> <span class='kw'>nil</span> <span class='rbrace'>}</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="descendants-class_method"> .<strong>descendants</strong> ⇒ <tt>Array<Class></tt> </h3><script> document.getElementById("descendants-class_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FConcerns%2FAddressable%2Edescendants">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> <p>List of all classes that can be in the sitemap.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Array<Class></tt>)</span> — <div class='inline'><p>Returns all classes which inherit from Cms::Concerns::Addressable</p></div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 190 191 192</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/cms/concerns/can_be_addressable.rb', line 190</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_descendants'>descendants</span> <span class='const'>ObjectSpace</span><span class='period'>.</span><span class='id identifier rubyid_each_object'>each_object</span><span class='lparen'>(</span><span class='op'>::</span><span class='const'>Class</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_klass'>klass</span><span class='op'>|</span> <span class='id identifier rubyid_klass'>klass</span> <span class='op'><</span> <span class='const'><span class='object_link'><a href="/gems/browsercms-artirix/Cms" title="Cms (module)">Cms</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="/gems/browsercms-artirix/Cms/Concerns" title="Cms::Concerns (module)">Concerns</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="/gems/browsercms-artirix/Cms/Concerns/Addressable" title="Cms::Concerns::Addressable (module)">Addressable</a></span></span> <span class='rbrace'>}</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="accessible_to_guests?-instance_method"> #<strong>accessible_to_guests?</strong>(public_sections, parent) ⇒ <tt>Boolean</tt> </h3><script> document.getElementById("accessible_to_guests?-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FConcerns%2FAddressable:accessible_to_guests%3F">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> <p>Resources are accessible to guests if their parent section is. Variables are passed in for performance reasons since this gets called 'MANY' times on the sitemap.</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>public_sections</span> <span class='type'>(<tt>Array<<span class='object_link'><a href="/gems/browsercms-artirix/Cms/Section" title="Cms::Section (class)">Section</a></span>></tt>)</span> </li> <li> <span class='name'>parent</span> <span class='type'>(<tt><span class='object_link'><a href="/gems/browsercms-artirix/Cms/Section" title="Cms::Section (class)">Section</a></span></tt>)</span> </li> </ul> <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"> 178 179 180</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/cms/concerns/can_be_addressable.rb', line 178</span> <span class='kw'>def</span> <span class='id identifier rubyid_accessible_to_guests?'>accessible_to_guests?</span><span class='lparen'>(</span><span class='id identifier rubyid_public_sections'>public_sections</span><span class='comma'>,</span> <span class='id identifier rubyid_parent'>parent</span><span class='rparen'>)</span> <span class='id identifier rubyid_public_sections'>public_sections</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="ancestors-instance_method"> #<strong>ancestors</strong>(options = {}) ⇒ <tt>Array<<span class='object_link'><a href="/gems/browsercms-artirix/Cms/Concerns/Addressable" title="Cms::Concerns::Addressable (module)">Addressable</a></span>></tt> </h3><script> document.getElementById("ancestors-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FConcerns%2FAddressable:ancestors">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> <p>Returns a list of all Addressable objects that are ancestors to this record.</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>options</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> </li> <li> <span class='name'>[Symbol]</span> <span class='type'>(<tt>Hash</tt>)</span> — <div class='inline'><p>a customizable set of options</p></div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Array<<span class='object_link'><a href="/gems/browsercms-artirix/Cms/Concerns/Addressable" title="Cms::Concerns::Addressable (module)">Addressable</a></span>></tt>)</span> — <div class='inline'><p>Or [] if no ancestors and/or has no parent.</p></div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 225 226 227 228 229 230 231</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/cms/concerns/can_be_addressable.rb', line 225</span> <span class='kw'>def</span> <span class='id identifier rubyid_ancestors'>ancestors</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='kw'>return</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='kw'>unless</span> <span class='id identifier rubyid_node'>node</span> <span class='id identifier rubyid_ancestor_nodes'>ancestor_nodes</span> <span class='op'>=</span> <span class='id identifier rubyid_node'>node</span><span class='period'>.</span><span class='id identifier rubyid_ancestors'>ancestors</span> <span class='id identifier rubyid_ancestors'>ancestors</span> <span class='op'>=</span> <span class='id identifier rubyid_ancestor_nodes'>ancestor_nodes</span><span class='period'>.</span><span class='id identifier rubyid_collect'>collect</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_node'>node</span><span class='op'>|</span> <span class='id identifier rubyid_node'>node</span><span class='period'>.</span><span class='id identifier rubyid_node'>node</span> <span class='rbrace'>}</span> <span class='id identifier rubyid_ancestors'>ancestors</span> <span class='op'><<</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_self</span><span class='rbracket'>]</span> <span class='id identifier rubyid_ancestors'>ancestors</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="cache_parent-instance_method"> #<strong>cache_parent</strong>(section) ⇒ <tt>Object</tt> </h3><script> document.getElementById("cache_parent-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FConcerns%2FAddressable:cache_parent">permalink</a>' ); </script> <table class="source_code"> <tr> <td> <pre class="lines"> 238 239 240</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/cms/concerns/can_be_addressable.rb', line 238</span> <span class='kw'>def</span> <span class='id identifier rubyid_cache_parent'>cache_parent</span><span class='lparen'>(</span><span class='id identifier rubyid_section'>section</span><span class='rparen'>)</span> <span class='ivar'>@parent</span> <span class='op'>=</span> <span class='id identifier rubyid_section'>section</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="destroy_node-instance_method"> #<strong>destroy_node</strong> ⇒ <tt>Object</tt> </h3><script> document.getElementById("destroy_node-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FConcerns%2FAddressable:destroy_node">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> <p>Allows for manual destruction of node</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 195 196 197</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/cms/concerns/can_be_addressable.rb', line 195</span> <span class='kw'>def</span> <span class='id identifier rubyid_destroy_node'>destroy_node</span> <span class='id identifier rubyid_node'>node</span><span class='period'>.</span><span class='id identifier rubyid_destroy'>destroy</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="landing_page?-instance_method"> #<strong>landing_page?</strong> ⇒ <tt>Boolean</tt> </h3><script> document.getElementById("landing_page?-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FConcerns%2FAddressable:landing_page%3F">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> <p>Whether or not this content is the 'landing' page for its section.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Boolean</tt>)</span> — <div class='inline'><p>false always, since a content block won't ever be the landing page for the section</p></div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 202 203 204</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/cms/concerns/can_be_addressable.rb', line 202</span> <span class='kw'>def</span> <span class='id identifier rubyid_landing_page?'>landing_page?</span> <span class='kw'>false</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="page_title-instance_method"> #<strong>page_title</strong> ⇒ <tt>String</tt> </h3><script> document.getElementById("page_title-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FConcerns%2FAddressable:page_title">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> <p>Returns the value that will appear in the <title> element of the page when this content is rendered. Subclasses can override this.</p> </div> </div> <div class="tags"> <div class="examples"> <h4 class="tag_title">Examples:</h4> <h5 class="example_title"><div class='inline'><p>Override the page title</p></div></h5> <pre class="example code"><code><span class='kw'>class</span> <span class='const'>MyWidget</span> <span class='op'><</span> <span class='const'><span class='object_link'><a href="/gems/browsercms-artirix/ActiveRecord" title="ActiveRecord (module)">ActiveRecord</a></span></span><span class='op'>::</span><span class='const'>Base</span> <span class='kw'>def</span> <span class='id identifier rubyid_page_title'>page_title</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>My Widget | </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>end</span> <span class='kw'>end</span></code></pre> </div> <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"> 216 217 218</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/cms/concerns/can_be_addressable.rb', line 216</span> <span class='kw'>def</span> <span class='id identifier rubyid_page_title'>page_title</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="parent-instance_method"> #<strong>parent</strong> ⇒ <tt>Object</tt> </h3><script> document.getElementById("parent-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FConcerns%2FAddressable:parent">permalink</a>' ); </script> <table class="source_code"> <tr> <td> <pre class="lines"> 233 234 235 236</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/cms/concerns/can_be_addressable.rb', line 233</span> <span class='kw'>def</span> <span class='id identifier rubyid_parent'>parent</span> <span class='ivar'>@parent</span> <span class='kw'>if</span> <span class='ivar'>@parent</span> <span class='id identifier rubyid_node'>node</span> <span class='op'>?</span> <span class='id identifier rubyid_node'>node</span><span class='period'>.</span><span class='id identifier rubyid_section'>section</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="parent=-instance_method"> #<strong>parent=</strong>(sec) ⇒ <tt>Object</tt> </h3><script> document.getElementById("parent=-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FConcerns%2FAddressable:parent=">permalink</a>' ); </script> <table class="source_code"> <tr> <td> <pre class="lines"> 255 256 257 258 259 260 261</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/cms/concerns/can_be_addressable.rb', line 255</span> <span class='kw'>def</span> <span class='id identifier rubyid_parent='>parent=</span><span class='lparen'>(</span><span class='id identifier rubyid_sec'>sec</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_node'>node</span> <span class='id identifier rubyid_node'>node</span><span class='period'>.</span><span class='id identifier rubyid_move_to_end'>move_to_end</span><span class='lparen'>(</span><span class='id identifier rubyid_sec'>sec</span><span class='rparen'>)</span> <span class='kw'>else</span> <span class='id identifier rubyid_build_section_node'>build_section_node</span><span class='lparen'>(</span><span class='symbol'>:node_id</span> <span class='op'>=></span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='symbol'>:section</span> <span class='op'>=></span> <span class='id identifier rubyid_sec'>sec</span><span class='rparen'>)</span> <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="parent_id-instance_method"> #<strong>parent_id</strong> ⇒ <tt>Object</tt> </h3><script> document.getElementById("parent_id-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FConcerns%2FAddressable:parent_id">permalink</a>' ); </script> <table class="source_code"> <tr> <td> <pre class="lines"> 242 243 244</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/cms/concerns/can_be_addressable.rb', line 242</span> <span class='kw'>def</span> <span class='id identifier rubyid_parent_id'>parent_id</span> <span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_try'>try</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="parent_id=-instance_method"> #<strong>parent_id=</strong>(id) ⇒ <tt>Object</tt> </h3><script> document.getElementById("parent_id=-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FConcerns%2FAddressable:parent_id=">permalink</a>' ); </script> <table class="source_code"> <tr> <td> <pre class="lines"> 246 247 248 249 250 251 252 253</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/cms/concerns/can_be_addressable.rb', line 246</span> <span class='kw'>def</span> <span class='id identifier rubyid_parent_id='>parent_id=</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="/gems/browsercms-artirix/Cms" title="Cms (module)">Cms</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="/gems/browsercms-artirix/Cms/Section" title="Cms::Section (class)">Section</a></span></span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span> <span class='comment'># Handles slug being set before there is a parent </span> <span class='kw'>if</span> <span class='ivar'>@slug</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_slug'>slug</span> <span class='op'>=</span> <span class='ivar'>@slug</span> <span class='ivar'>@slug</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="partial_for-instance_method"> #<strong>partial_for</strong> ⇒ <tt>Object</tt> </h3><script> document.getElementById("partial_for-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FConcerns%2FAddressable:partial_for">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> <p>Computes the name of the partial used to render this object in the sitemap.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 264 265 266</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/cms/concerns/can_be_addressable.rb', line 264</span> <span class='kw'>def</span> <span class='id identifier rubyid_partial_for'>partial_for</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_demodulize'>demodulize</span><span class='period'>.</span><span class='id identifier rubyid_underscore'>underscore</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Thu Sep 17 01:29:56 2026 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.45 (ruby-4.0.7). </div> </div> </body> </html>