Module: Hanami::Presenter

Defined in:: lib/hanami/presenter.rb

Overview

Presenter pattern implementation

It delegates to the wrapped object the missing method invocations.

The output of concrete and delegated methods is escaped as XSS prevention.

Examples:

Basic usage

require 'hanami/view'

class Map
  attr_reader :locations

  def initialize(locations)
    @locations = locations
  end

  def location_names
    @locations.join(', ')
  end
end

class MapPresenter
  include Hanami::Presenter

  def count
    locations.count
  end

  def location_names
    super.upcase
  end

  def inspect_object
    @object.inspect
  end
end

map = Map.new(['Rome', 'Boston'])
presenter = MapPresenter.new(map)

# access a map method
puts presenter.locations # => ['Rome', 'Boston']

# access presenter concrete methods
puts presenter.count # => 1

# uses super to access original object implementation
puts presenter.location_names # => 'ROME, BOSTON'

# it has private access to the original object
puts presenter.inspect_object # => #<Map:0x007fdeada0b2f0 @locations=["Rome", "Boston"]>

Escape

require 'hanami/view'

User = Struct.new(:first_name, :last_name)

class UserPresenter
  include Hanami::Presenter

  def full_name
    [first_name, last_name].join(' ')
  end

  def raw_first_name
    _raw first_name
  end
end

first_name = '<script>alert('xss')</script>'

user = User.new(first_name, nil)
presenter = UserPresenter.new(user)

presenter.full_name
  # => "&lt;script&gt;alert(&apos;xss&apos;)&lt;&#x2F;script&gt;"

presenter.raw_full_name
   # => "<script>alert('xss')</script>"

Since:

0.1.0

Class Method Summary collapse

.included(base) ⇒ Object private

Inject escape logic into the given class.

Class Method Details

.included(base) ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Inject escape logic into the given class.