hanami-view 1.3.2 → 2.0.0.alpha5

data/README.md

@@ -1,871 +1,53 @@
 # Hanami::View
 
-A View layer for [Hanami](http://hanamirb.org).
+A view layer for [Hanami](http://hanamirb.org)
 
-It's based on a **separation between views and templates**.
+## Version
 
-A _view_ is an object that encapsulates the presentation logic of a page.
-A _template_ is a file that defines the semantic and visual elements of a page.
-In order to show a result to a user, a template must be _rendered_ by a view.
-
-Keeping things separated helps to declutter templates and models from presentation logic.
-Also, since views are objects, they are easily testable.
-If you ever used [Mustache](http://mustache.github.io/), you are already aware of the advantages.
-
-Like all the other Hanami components, it can be used as a standalone framework or within a full Hanami application.
+**This branch contains the code for `hanami-view` 2.x.**
 
 ## Status
 
 [![Gem Version](https://badge.fury.io/rb/hanami-view.svg)](https://badge.fury.io/rb/hanami-view)
-[![TravisCI](https://travis-ci.org/hanami/view.svg?branch=master)](https://travis-ci.org/hanami/view)
-[![CircleCI](https://circleci.com/gh/hanami/view/tree/master.svg?style=svg)](https://circleci.com/gh/hanami/view/tree/master)
-[![Test Coverage](https://codecov.io/gh/hanami/view/branch/master/graph/badge.svg)](https://codecov.io/gh/hanami/view)
-[![Depfu](https://badges.depfu.com/badges/4f5c8868d047d206f33893bc9194812d/overview.svg)](https://depfu.com/github/hanami/view?project=Bundler)
+[![CI](https://github.com/hanami/view/workflows/ci/badge.svg?branch=main)](https://github.com/hanami/view/actions?query=workflow%3Aci+branch%3Amain)
+[![Test Coverage](https://codecov.io/gh/hanami/view/branch/main/graph/badge.svg)](https://codecov.io/gh/hanami/view)
+[![Depfu](https://badges.depfu.com/badges/7cd17419fba78b726be1353118fb01de/overview.svg)](https://depfu.com/github/hanami/view?project=Bundler)
 [![Inline Docs](http://inch-ci.org/github/hanami/view.svg)](http://inch-ci.org/github/hanami/view)
 
 ## Contact
 
 * Home page: http://hanamirb.org
+* Community: http://hanamirb.org/community
+* Guides: https://guides.hanamirb.org
 * Mailing List: http://hanamirb.org/mailing-list
 * API Doc: http://rdoc.info/gems/hanami-view
 * Bugs/Issues: https://github.com/hanami/view/issues
-* Support: http://stackoverflow.com/questions/tagged/hanami
 * Chat: http://chat.hanamirb.org
 
 ## Rubies
 
-__Hanami::View__ supports Ruby (MRI) 2.3+ and JRuby 9.1.5.0+
+__Hanami::view__ supports Ruby (MRI) 2.6+
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'hanami-view'
+gem "hanami/view"
 ```
 
 And then execute:
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install hanami-view
-
-## Usage
-
-### Conventions
-
-  * Templates are searched under `Hanami::View.configuration.root`, set this value according to your app structure (eg. `"app/templates"`).
-  * A view will look for a template with a file name that is composed by its full class name (eg. `"articles/index"`).
-  * A template must have two concatenated extensions: one for the format and one for the engine (eg. `".html.erb"`).
-  * The framework must be loaded before rendering the first time: `Hanami::View.load!`.
-
-### Views
-
-A simple view looks like this:
-
-```ruby
-require 'hanami/view'
-
-module Articles
-  class Index
-    include Hanami::View
-  end
-end
-```
-
-Suppose that we want to render a list of `articles`:
-
-```ruby
-require 'hanami/view'
-
-module Articles
-  class Index
-    include Hanami::View
-  end
-end
-
-Hanami::View.configure do
-  root 'app/templates'
-end
-
-Hanami::View.load!
-
-path     = Hanami::View.configuration.root.join('articles/index.html.erb')
-template = Hanami::View::Template.new(path)
-articles = ArticleRepository.new.all
-
-Articles::Index.new(template, articles: articles).render
-```
-
-While this code is working fine, it's inefficient and verbose, because we are loading a template from the filesystem for each rendering attempt.
-Also, this is strictly related to the HTML format, what if we want to manage other formats?
-
-```ruby
-require 'hanami/view'
-
-module Articles
-  class Index
-    include Hanami::View
-  end
-
-  class AtomIndex < Index
-    format :atom
-  end
-end
-
-Hanami::View.configure do
-  root 'app/templates'
-end
-
-Hanami::View.load!
-
-articles = ArticleRepository.new.all
-
-Articles::Index.render(format: :html, articles: articles)
-  # => This will use Articles::Index
-  #    and "articles/index.html.erb"
-
-Articles::Index.render(format: :atom, articles: articles)
-  # => This will use Articles::AtomIndex
-  #    and "articles/index.atom.erb"
-
-Articles::Index.render(format: :xml, articles: articles)
-  # => This will raise a Hanami::View::MissingTemplateError
-```
-
-### Locals
-
-All the objects passed in the context are called _locals_, they are available both in the view and in the template:
-
-```ruby
-require 'hanami/view'
-
-module Articles
-  class Show
-    include Hanami::View
-
-    def authors
-      article.authors.map(&:full_name).join ', '
-    end
-  end
-end
-```
-
-```erb
-<h1><%= article.title %></h1>
-<article>
-  <%= article.content %>
-</article>
+```shell
+$ bundle
 ```
 
-All the methods defined in the view are accessible from the template:
-
-```erb
-<h2><%= authors %></h2>
-```
-
-For convenience, they are also available to the view as a Hash, accessed through the `locals` method.
-
-```ruby
-require 'hanami/view'
-
-module Articles
-  class Show
-    include Hanami::View
-
-    # This view already responds to `#article` because there is an element in
-    # the locals with the same key.
-    #
-    # In order to allow developers to override those methods, and decorate a
-    # single locals object, a view has a Hash with the same values.
-    #
-    # If we had implemented this method like this:
-    #
-    #   def article
-    #     ArticlePresenter.new(article)
-    #   end
-    #
-    # We would have generated a `SystemStackError` (stack level too deep).
-    def article
-      ArticlePresenter.new(locals[:article])
-    end
-  end
-end
-```
-
-### Custom rendering
-
-Since a view is an object, you can override `#render` and provide your own rendering policy:
-
-```ruby
-require 'hanami/view'
-
-module Articles
-  class Show
-    include Hanami::View
-    format :json
-
-    def render
-      ArticleSerializer.new(article).to_json
-    end
-  end
-end
-
-Articles::Show.render({format: :json, article: article})
-  # => This will render from ArticleSerializer,
-  #    without the need of a template
-```
-
-### Format
-
-The `.format` DSL is used to declare one or more mime types that a view is able to render.
-These values are **arbitrary**, just **be sure to create a corresponding template**.
-
-```ruby
-require 'hanami/view'
-
-module Articles
-  class Show
-    include Hanami::View
-    format :custom
-  end
-end
-
-Articles::Show.render({format: :custom, article: article})
-  # => This will render "articles/show.custom.erb"
-```
-
-### Engines
-
-The builtin rendering engine is [ERb](http://en.wikipedia.org/wiki/ERuby).
-However, Hanami::View supports countless rendering engines out of the box.
-Require your library of choice **before** requiring `'hanami/view'`, and it will just work.
-
-```ruby
-require 'haml'
-require 'hanami/view'
-
-module Articles
-  class Show
-    include Hanami::View
-  end
-end
-
-Articles::Show.render({format: :html, article: article})
-  # => This will render "articles/show.html.haml"
-```
-
-This is the list of the supported engines.
-They are listed in order of **higher precedence**, for a given extension.
-For instance, if [ERubis](http://www.kuwata-lab.com/erubis/) is loaded, it will be preferred over ERb to render `.erb` templates.
-
-<table>
-  <tr>
-    <th>Engine</th>
-    <th>Extensions</th>
-  </tr>
-  <tr>
-    <td>Erubis</td>
-    <td>erb, rhtml, erubis</td>
-  </tr>
-  <tr>
-    <td>ERb</td>
-    <td>erb, rhtml</td>
-  </tr>
-  <tr>
-    <td>Redcarpet</td>
-    <td>markdown, mkd, md</td>
-  </tr>
-  <tr>
-    <td>RDiscount</td>
-    <td>markdown, mkd, md</td>
-  </tr>
-  <tr>
-    <td>Kramdown</td>
-    <td>markdown, mkd, md</td>
-  </tr>
-  <tr>
-    <td>Maruku</td>
-    <td>markdown, mkd, md</td>
-  </tr>
-  <tr>
-    <td>BlueCloth</td>
-    <td>markdown, mkd, md</td>
-  </tr>
-  <tr>
-    <td>Asciidoctor</td>
-    <td>ad, adoc, asciidoc</td>
-  </tr>
-  <tr>
-    <td>Builder</td>
-    <td>builder</td>
-  </tr>
-  <tr>
-    <td>CSV</td>
-    <td>rcsv</td>
-  </tr>
-  <tr>
-    <td>CoffeeScript</td>
-    <td>coffee</td>
-  </tr>
-  <tr>
-    <td>WikiCloth</td>
-    <td>wiki, mediawiki, mw</td>
-  </tr>
-  <tr>
-    <td>Creole</td>
-    <td>wiki, creole</td>
-  </tr>
-  <tr>
-    <td>Etanni</td>
-    <td>etn, etanni</td>
-  </tr>
-  <tr>
-    <td>Haml</td>
-    <td>haml</td>
-  </tr>
-  <tr>
-    <td>Less</td>
-    <td>less</td>
-  </tr>
-  <tr>
-    <td>Liquid</td>
-    <td>liquid</td>
-  </tr>
-  <tr>
-    <td>Markaby</td>
-    <td>mab</td>
-  </tr>
-  <tr>
-    <td>Nokogiri</td>
-    <td>nokogiri</td>
-  </tr>
-  <tr>
-    <td>Plain</td>
-    <td>html</td>
-  </tr>
-  <tr>
-    <td>RDoc</td>
-    <td>rdoc</td>
-  </tr>
-  <tr>
-    <td>Radius</td>
-    <td>radius</td>
-  </tr>
-  <tr>
-    <td>RedCloth</td>
-    <td>textile</td>
-  </tr>
-  <tr>
-    <td>Sass</td>
-    <td>sass</td>
-  </tr>
-  <tr>
-    <td>Scss</td>
-    <td>scss</td>
-  </tr>
-  <tr>
-    <td>Slim</td>
-    <td>slim</td>
-  </tr>
-  <tr>
-    <td>String</td>
-    <td>str</td>
-  </tr>
-  <tr>
-    <td>Yajl</td>
-    <td>yajl</td>
-  </tr>
-</table>
-
-### Root
-
-Template lookup is performed under the `Hanami::View.configuration.root` directory. You can specify a different path on a per view basis:
-
-```ruby
-class ViewWithDifferentRoot
-  include Hanami::View
-
-  root 'path/to/root'
-end
-```
-
-### Template
-
-The template file must be located under the relevant `root` and must match the class name:
-
-```ruby
-puts Hanami::View.configuration.root # => #<Pathname:app/templates>
-Articles::Index.template            # => "articles/index"
-```
-
-Each view can specify a different template:
-
-```ruby
-module Articles
-  class Create
-    include Hanami::View
-
-    template 'articles/new'
-  end
-end
-
-Articles::Create.template  # => "articles/new"
-```
-
-### Partials
-
-Partials can be rendered within a template:
-
-```erb
-<%= render partial: 'articles/form', locals: { secret: 23 } %>
-```
-
-It will look for a template `articles/_form.html.erb` and make available both the view's and partial's locals (eg. `article` and `secret`).
-
-### Templates
-
-Templates can be rendered within another template:
-
-```erb
-<%= render template: 'articles/new', locals: { errors: {} } %>
-```
-
-It will render `articles/new.html.erb` and make available both the view's and templates's locals (eg. `article` and `errors`).
-
-### Layouts
-
-Layouts are wrappers for views. Layouts may serve to reuse common markup.
-
-```ruby
-class ApplicationLayout
-  include Hanami::Layout
-
-  def page_title
-    'Title:'
-  end
-end
-
-module Articles
-  class Index
-    include Hanami::View
-    layout :application
-
-    def page_title
-      "#{ layout.page_title } articles"
-    end
-  end
-
-  class RssIndex < Index
-    format :rss
-    layout false
-  end
-end
-
-Articles::Index.render(format: :html) # => Will use ApplicationLayout
-Articles::Index.render(format: :rss)  # => Will use nothing
-```
-
-As per convention, layout templates are located under `Hanami::View.root` or `ApplicationLayout.root` and use the underscored name (eg. `ApplicationLayout => application.html.erb`).
-
-### Optional Content
-
-#### Optional View Methods
-
-If we want to render optional contents such as sidebar links or page specific javascripts, we can use `#local`
-It accepts a key that represents a method that should be available within the rendering context.
-That context is made of the locals, and the methods that view and layout respond to.
-If the context can't dispatch that method, it returns a null object (`Hanami::View::Rendering::NullLocal`).
-
-Given the following layout template.
-
-```erb
-<!doctype HTML>
-<html>
-  <!-- ... -->
-  <body>
-    <!-- ... -->
-    <%= local :footer %>
-  </body>
-</html>
-```
-
-We have two views, one responds to `#footer` (`Products::Show`) and the other doesn't (`Products::Index`).
-When the first is rendered, `local` gives back the returning value of `#footer`.
-In the other case, `local` returns a null object (`Hanami::View::Rendering::NullLocal`).
-
-```ruby
-module Products
-  class Index
-    include Hanami::View
-  end
-
-  class Show
-    include Hanami::View
-
-    def footer
-      "contents for footer"
-    end
-  end
-end
-```
-
-#### Optional Locals
-
-If we want to show announcements to our customers, but we want only load them from the database if there is something to show.
-This is an optional local.
-
-```erb
-<% if local(:announcement).show? %>
-  <h2><%= announcement.message %></h2>
-<% end %>
-```
-
-The first line is safely evaluated in all the cases: if announcement is present or not.
-In case we enter the `if` statement, we're sure we can safely reference that object.
-
-### Presenters
-
-The goal of a presenter is to wrap and reuse presentational logic for an object.
-
-```ruby
-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 # => 2
-
-# 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"]>
-```
-
-### Configuration
-
-__Hanami::View__ can be configured with a DSL that determines its behavior.
-It supports a few options:
-
-```ruby
-require 'hanami/view'
-
-Hanami::View.configure do
-  # Set the root path where to search for templates
-  # Argument: String, Pathname, #to_pathname, defaults to the current directory
-  #
-  root '/path/to/root'
-
-  # Default encoding for templates
-  # Argument: String, defaults to utf-8
-  #
-  default_encoding 'koi-8'
-
-  # Set the Ruby namespace where to lookup for views
-  # Argument: Class, Module, String, defaults to Object
-  #
-  namespace 'MyApp::Views'
-
-  # Set the global layout
-  # Argument: Symbol, defaults to nil
-  #
-  layout :application
-
-  # Set modules that you want to include in all views
-  # Argument: Block
-  #
-  prepare do
-    include MyCustomModule
-    before { do_something }
-  end
-end
-```
-
-All those global configurations can be overwritten at a finer grained level:
-views. Each view and layout has its own copy of the global configuration, so
-that changes are inherited from the top to the bottom, but not bubbled up in the
-opposite direction.
-
-```ruby
-require 'hanami/view'
-
-Hanami::View.configure do
-  root '/path/to/root'
-end
-
-class Show
-  include Hanami::View
-  root '/another/root'
-end
-
-Hanami::View.configuration.root # => #<Pathname:/path/to/root>
-Show.root                      # => #<Pathname:/another/root>
-```
-
-### Reusability
-
-__Hanami::View__ can be used as a singleton framework as seen in this README.
-The application code includes `Hanami::View` or `Hanami::Layout` directly
-and the configuration is unique per Ruby process.
-
-While this is convenient for tiny applications, it doesn't fit well for more
-complex scenarios, where we want micro applications to coexist together.
-
-```ruby
-require 'hanami/view'
-
-Hanami::View.configure do
-  root '/path/to/root'
-end
-
-module WebApp
-  View = Hanami::View.duplicate(self)
-end
-
-module ApiApp
-  View = Hanami::View.duplicate(self) do
-    root '/another/root'
-  end
-end
-
-Hanami::View.configuration.root  # => #<Pathname:/path/to/root>
-WebApp::View.configuration.root # => #<Pathname:/path/to/root>, inherited from Hanami::View
-ApiApp::View.configuration.root # => #<Pathname:/another/root>
-```
-
-The code above defines `WebApp::View` and `WebApp::Layout`, to be used for
-the `WebApp` views, while `ApiApp::View` and `ApiApp::Layout` have a different
-configuration.
-
-### Thread safety
-
-__Hanami::View__ is thread safe during the runtime, but it isn't during the loading process.
-Please load the framework as the last thing before your application starts.
-Also, be sure that your app provides a thread safe context while it's loaded.
-
-
-```ruby
-Mutex.new.synchronize do
-  Hanami::View.load!
-end
-```
-
-After this operation, all the class variables are frozen, in order to prevent accidental modifications at the run time.
-
-**This is not necessary, when Hanami::View is used within a Hanami application.**
-
-### Security
-
-The output of views and presenters is always **autoescaped**.
-
-**ATTENTION:** In order to prevent XSS attacks, please read the instructions below.
-Because Hanami::View supports a lot of template engines, the escape happens at the level of the view.
-Most of the time everything happens automatically, but there are still some corner cases that need your manual intervention.
-
-#### View autoescape
-
-```ruby
-require 'hanami/view'
-
-User = Struct.new(:name)
-
-module Users
-  class Show
-    include Hanami::View
-
-    def user_name
-      user.name
-    end
-  end
-end
-
-# ERB template
-# <div id="user_name"><%= user_name %></div>
-
-user = User.new("<script>alert('xss')</script>")
-
-# THIS IS USEFUL FOR UNIT TESTING:
-template = Hanami::View::Template.new('users/show.html.erb')
-view     = Users::Show.new(template, user: user)
-view.user_name # => "&lt;script&gt;alert(&apos;xss&apos;)&lt;&#x2F;script&gt;"
-
-# THIS IS THE RENDERING OUTPUT:
-Users::Show.render(format: :html, user: user)
-# => <div id="user_name">&lt;script&gt;alert(&apos;xss&apos;)&lt;&#x2F;script&gt;</div>
-```
-
-#### Presenter autoescape
-
-```ruby
-require 'hanami/view'
-
-User = Struct.new(:name)
-
-class UserPresenter
-  include Hanami::Presenter
-end
-
-user      = User.new("<script>alert('xss')</script>")
-presenter = UserPresenter.new(user)
-
-presenter.name # => "&lt;script&gt;alert(&apos;xss&apos;)&lt;&#x2F;script&gt;"
-```
-
-#### Escape entire objects
-
-We have seen that concrete methods in views are automatically escaped.
-This is great, but tedious if you need to print a lot of information from a given object.
-
-Imagine you have `user` as part of the view locals.
-If you want to use `<%= user.name %>` directly, **you're still vulnerable to XSS attacks**.
-
-You have two alternatives:
-
-  * To use a concrete presenter (eg. `UserPresenter`)
-  * Escape the entire object (see the example below)
-
-Both those solutions allow you to keep the template syntax unchanged, but to have a safer output.
-
-```ruby
-require 'hanami/view'
-
-User = Struct.new(:first_name, :last_name)
-
-module Users
-  class Show
-    include Hanami::View
-
-    def user
-      _escape locals[:user]
-    end
-  end
-end
-
-# ERB template:
-#
-# <div id="first_name">
-#   <%= user.first_name %>
-# </div>
-# <div id="last_name">
-#   <%= user.last_name %>
-# </div>
-
-first_name = "<script>alert('first_name')</script>"
-last_name  = "<script>alert('last_name')</script>"
-
-user = User.new(first_name, last_name)
-html = Users::Show.render(format: :html, user: user)
-
-html
-  # =>
-  # <div id="first_name">
-  #   &lt;script&gt;alert(&apos;first_name&apos;)&lt;&#x2F;script&gt;
-  # </div>
-  # <div id="last_name">
-  #   &lt;script&gt;alert(&apos;last_name&apos;)&lt;&#x2F;script&gt;
-  # </div>
-```
-
-#### Raw contents
-
-You can use `_raw` to mark an output as safe.
-Please note that **this may open your application to XSS attacks.**
-
-#### Raw contents in views
-
-```ruby
-require 'hanami/view'
-
-User = Struct.new(:name)
-
-module Users
-  class Show
-    include Hanami::View
-
-    def user_name
-      _raw user.name
-    end
-  end
-end
-
-# ERB template
-# <div id="user_name"><%= user_name %></div>
-
-user = User.new("<script>alert('xss')</script>")
-html = Users::Show.render(format: :html, user: user)
-
-html
-# => <div id="user_name"><script>alert('xss')</script></div>
-```
-
-#### Raw contents in presenters
-
-```ruby
-require 'hanami/view'
-
-User = Struct.new(:name)
-
-class UserPresenter
-  include Hanami::Presenter
-
-  def first_name
-    _raw @object.first_name
-  end
-end
-
-user      = User.new("<script>alert('xss')</script>")
-presenter = UserPresenter.new(user)
+Or install it yourself as:
 
-presenter.name # => "<script>alert('xss')</script>"
+```shell
+$ gem install hanami-view
 ```
 
-## Versioning
-
-__Hanami::View__ uses [Semantic Versioning 2.0.0](http://semver.org)
-
-## Contributing
-
-1. Fork it
-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 new Pull Request
-
-## Copyright
-
-Copyright 2014-2017 Luca Guidi – Released under MIT License
+## License
 
-This project was formerly known as Lotus (`lotus-view`).
+See `LICENSE` file.