Class: Ariane::Render::Base

Inherits:

Object

• Object
• Ariane::Render::Base

Defined in:

lib/ariane/render/base.rb

Overview

Internal: Base renderer from which every renderer inherits.

Direct Known Subclasses

HTML

Instance Attribute Summary

• #options ⇒ Object

  Internal: Gets/Sets the Hash options.

Instance Method Summary

• #divider ⇒ Object

  Public: Returns the divider used to separate crumbs.

• #initialize(options = {}) ⇒ Base constructor

  Public: Initialize a Base renderer.

• #render(crumbs) ⇒ Object

  Internal: Renders the breadcrumbs.

Constructor Details

#initialize(options = {}) ⇒ Base

Public: Initialize a Base renderer.

options - A Hash containing options for the renderer (default: {}):

:divider - The String divider used to separate crumbs
           (default: Base#divider).

# File 'lib/ariane/render/base.rb', line 14

def initialize(options={})
  @options = {
    divider: ' / '
  }.merge(options)
end

Instance Attribute Details

#options ⇒ Object

Internal: Gets/Sets the Hash options.

# File 'lib/ariane/render/base.rb', line 7

def options
  @options
end

Instance Method Details

#divider ⇒ Object

Public: Returns the divider used to separate crumbs.

Returns the String ‘ / ’.

# File 'lib/ariane/render/base.rb', line 36

def divider
  ' / '
end

#render(crumbs) ⇒ Object

Internal: Renders the breadcrumbs.

This method MUST be overridden by any renderer inheriting from Base.

crumbs - An Array containing a list of Crumb objects composing the

breadcrumb.

Returns nothing. Raises RuntimeError everytime.

# File 'lib/ariane/render/base.rb', line 29

def render(crumbs)
  raise 'the render method is not implemented in your Ariane renderer'
end