EndView

Build Status Gem Version

View model and template in same file.

Usage

Given a ruby file with a template written after __END__, the EndView mixin will provide a render method to execute it:

require 'end_view'

class Foo
  include EndView

  def my_method
    'Hello World'
  end
end

Foo.new.render # <h1>Hello World</h1>

__END__

EndView can also be use to extend an object:

module Baz
  extend EndView

  def self.my_method
    'Howdy World'
  end
end

Baz.render # <h3>Howdy World</h3>

__END__

Template Engine

By default Tilt's Haml template engine is used. To change the default engine:

EndView.default_engine = Tilt::ERBTemplate

Or to specify an engine for a particular class:

require 'tilt/erb'

class Ham
  include EndView.new(template_engine: Tilt::ERBTemplate)

  def my_method
    'Heya'
  end
end

Ham.new.render # <h1>Heya</h1>

__END__

Layouts

For template engines that support it, view models can be passed blocks:

module MyLayout
  extend EndView
end

MyLayout.render { "S'up" } # <html>S'up</html>

__END__

These can then be used as layouts:

class Fizz
  include EndView
  layout MyLayout
end

Fizz.new.render # <html><h1>Goodbye</h1></html>

__END__

For layouts that need to be dynamically initialized, layout can be passed a lambda:

class MyDynamicLayout
  include EndView

  def initialize(title)
    @title = title
  end
end

__END__

class Whizz
  include EndView
  layout -> { MyDynamicLayout.new('Hallo') }
end

Whizz.new.render # <html> <h1>Hallo</h1> <p>Bonjour</p> </html>

__END__

Inheritance

Templates are inherited from parent view models:

class Bar < Foo
  def my_method
    'Porridge'
  end
end

Bar.new.render # <h1>Porridge</h1>

To override an inherited template, call the compile_template class method:

class Pop < Foo
  compile_template
end

Pop.new.render # <p class="inherited">Hello World</p>

__END__

Locals

Locals can be passed into the render method that override the view models:

Foo.new.render(my_method: 'Stranger') # <h1>Stranger</h1>

Installation

Add your Gemfile:

gem 'end_view'

Contributing

  1. Fork it ( https://github.com/[my-github-username]/end_view/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request