Class: Occams::Content::Tag

Inherits:

Object

• Object
• Occams::Content::Tag

Defined in:

lib/occams/content/tag.rb

Direct Known Subclasses

Block, Occams::Content::Tags::Asset, Occams::Content::Tags::Audio, Occams::Content::Tags::Breadcrumbs, Occams::Content::Tags::Children, Occams::Content::Tags::FileLink, Occams::Content::Tags::Fragment, Occams::Content::Tags::Helper, Occams::Content::Tags::Image, Occams::Content::Tags::PageFileLink, Occams::Content::Tags::Partial, Occams::Content::Tags::Siblings, Occams::Content::Tags::Snippet, Occams::Content::Tags::Template

Defined Under Namespace

Classes: Error

Instance Attribute Summary

• #context ⇒ Object readonly

  Returns the value of attribute context.

• #params ⇒ Object readonly

  Returns the value of attribute params.

• #source ⇒ Object readonly

  Returns the value of attribute source.

Instance Method Summary

• #allow_erb? ⇒ Boolean

  Making sure we don’t leak erb from tags by accident.

• #content ⇒ String
• #initialize(context:, params: [], source: nil) ⇒ Tag constructor

  A new instance of Tag.

• #nodes ⇒ Array<String, Occams::Content::Tag>

  Normally it’s a (String).

• #render ⇒ String

Constructor Details

#initialize(context:, params: [], source: nil) ⇒ Tag

Returns a new instance of Tag.

Parameters:

• context (Occams::Cms::WithFragments)
• params (Array<String, {String => String}>) (defaults to: [])
• source (String, nil) (defaults to: nil)

# File 'lib/occams/content/tag.rb', line 18

def initialize(context:, params: [], source: nil)
  @context  = context
  @params   = params
  @source   = source
end

Instance Attribute Details

#context ⇒ Object (readonly)

Returns the value of attribute context.

# File 'lib/occams/content/tag.rb', line 7

def context
  @context
end

#params ⇒ Object (readonly)

Returns the value of attribute params.

# File 'lib/occams/content/tag.rb', line 10

def params
  @params
end

#source ⇒ Object (readonly)

Returns the value of attribute source.

# File 'lib/occams/content/tag.rb', line 13

def source
  @source
end

Instance Method Details

#allow_erb? ⇒ Boolean

Making sure we don’t leak erb from tags by accident. Tag classes can override this, like partials/helpers tags.

Returns:

• (Boolean)

# File 'lib/occams/content/tag.rb', line 26

def allow_erb?
  Occams.config.allow_erb
end

#content ⇒ String

Returns:

• (String)

Raises:

• (Error)

# File 'lib/occams/content/tag.rb', line 40

def content
  raise Error, 'This is a base class. It holds no content'
end

#nodes ⇒ Array<String, Occams::Content::Tag>

Normally it’s a (String). However, if tag content has tags, we need to expand them and that produces potentially more stuff.

Returns:

• (Array<String, Occams::Content::Tag>)

# File 'lib/occams/content/tag.rb', line 33

def nodes
  template  = Occams::Content::Renderer.new(@context)
  tokens    = template.tokenize(content)
  template.nodes(tokens)
end

#render ⇒ String

Returns:

• (String)

# File 'lib/occams/content/tag.rb', line 45

def render
  content
end