lotus-view 0.0.0 → 0.1.0

data/test/fixtures/templates/articles/index.html.erb

@@ -0,0 +1,3 @@
+<% articles.each do |article| %>
+  <h1><%= article.title %></h1>
+<% end %>

data/test/fixtures/templates/articles/index.json.erb

@@ -0,0 +1,9 @@
+{
+  "articles": [
+  <% articles.each do |article| %>
+    "article":{
+    "title":"<%= article.title %>"
+    }
+  <% end %>
+  ]
+}

data/test/fixtures/templates/articles/new.html.erb

@@ -0,0 +1,7 @@
+<h1>New Article</h1>
+
+<% if errors.any? %>
+  <h2>Errors</h2>
+<% end %>
+
+<%= render partial: 'articles/form', locals: { secret: 23 } %>

data/test/fixtures/templates/articles/show.html.erb

@@ -0,0 +1 @@
+<h1><%= title %></h1>

data/test/fixtures/templates/articles/show.json.erb

@@ -0,0 +1,5 @@
+{
+  article: {
+    "title":"<%= title %>"
+  }
+}

data/test/fixtures/templates/contacts/show.html.haml

@@ -0,0 +1 @@
+%h1= person.name

data/test/fixtures/templates/dashboard/index.html.erb

@@ -0,0 +1,2 @@
+<h1>Map</h1>
+<h2><%= map.count %> locations</h2>

data/test/fixtures/templates/hello_world_view.html.erb

@@ -0,0 +1 @@
+<h1>Hello, World!</h1>

data/test/fixtures/templates/index_view.html.erb

@@ -0,0 +1 @@
+<h1>Welcome</h1>

data/test/fixtures/templates/json_render_view.json.erb

@@ -0,0 +1,3 @@
+{
+"greet":"Hello, <%= planet %>!"
+}

data/test/fixtures/templates/render_view.html.erb

@@ -0,0 +1 @@
+<h1>Hello, <%= planet %>!</h1>

data/test/fixtures/templates/shared/_sidebar.html.erb

@@ -0,0 +1 @@
+<div id="sidebar"></div>

data/test/fixtures.rb

@@ -0,0 +1,187 @@
+class HelloWorldView
+  include Lotus::View
+end
+
+class RenderView
+  include Lotus::View
+end
+
+class JsonRenderView
+  include Lotus::View
+  format :json
+end
+
+class AppView
+  include Lotus::View
+  root __dir__ + '/fixtures/templates/app'
+  layout :application
+end
+
+class AppViewLayout < AppView
+  layout nil
+end
+
+class MissingTemplateView
+  include Lotus::View
+end
+
+module App
+  class View
+    include Lotus::View
+  end
+end
+
+class ApplicationLayout
+  include Lotus::Layout
+
+  def title
+    'Title:'
+  end
+end
+
+class GlobalLayout
+end
+
+module Articles
+  class Index
+    include Lotus::View
+    layout :application
+
+    def title
+      "#{ layout.title } articles"
+    end
+  end
+
+  class RssIndex < Index
+    format :rss
+    layout nil
+  end
+
+  class AtomIndex < RssIndex
+    format :atom
+    layout nil
+  end
+
+  class New
+    include Lotus::View
+
+    def errors
+      {}
+    end
+  end
+
+  class AlternativeNew
+    include Lotus::View
+  end
+
+  class Create
+    include Lotus::View
+    template 'articles/new'
+
+    def errors
+      {title: 'Title is required'}
+    end
+  end
+
+  class Show
+    include Lotus::View
+
+    def title
+      @title ||= article.title.upcase
+    end
+  end
+
+  class JsonShow < Show
+    format :json
+
+    def article
+      OpenStruct.new(title: locals[:article].title.reverse)
+    end
+
+    def title
+      super.downcase
+    end
+  end
+end
+
+class Map
+  attr_reader :locations
+
+  def initialize(locations)
+    @locations = locations
+  end
+
+  def location_names
+    @locations.join(', ')
+  end
+end
+
+class MapPresenter
+  include Lotus::Presenter
+
+  def count
+    locations.count
+  end
+
+  def location_names
+    super.upcase
+  end
+
+  def inspect_object
+    @object.inspect
+  end
+end
+
+module Dashboard
+  class Index
+    include Lotus::View
+
+    def map
+      MapPresenter.new(locals[:map])
+    end
+  end
+end
+
+class IndexView
+  include Lotus::View
+  layout :application
+end
+
+class SongWidget
+  attr_reader :song
+
+  def initialize(song)
+    @song = song
+  end
+
+  def render
+    %(<audio src="#{ song.url }">#{ song.title }</audio>)
+  end
+end
+
+module Songs
+  class Show
+    include Lotus::View
+    format :html
+
+    def render
+      SongWidget.new(song).render
+    end
+  end
+end
+
+module Metrics
+  class Index
+    include Lotus::View
+
+    def render
+      %(metrics)
+    end
+  end
+end
+
+module Contacts
+  class Show
+    include Lotus::View
+  end
+end

data/test/layout_test.rb

@@ -0,0 +1,10 @@
+require 'test_helper'
+
+describe Lotus::Layout do
+  describe 'rendering from layout' do
+    it 'renders partial' do
+      rendered = IndexView.render(format: :html)
+      rendered.must_match %(<div id="sidebar"></div>)
+    end
+  end
+end

data/test/load_test.rb

@@ -0,0 +1,79 @@
+require 'test_helper'
+
+describe Lotus::View do
+  describe '.load!' do
+    before do
+      # Lotus::View.load! is invoked as last statement of `test/test_helper.rb`.
+    end
+
+    it 'freezes .root' do
+      Lotus::View.root.frozen?.must_equal true
+    end
+
+    it 'freezes .root for all the views' do
+      AppView.root.frozen?.must_equal true
+    end
+
+    it 'freezes .layout for all the views' do
+      AppView.layout.frozen?.must_equal true
+    end
+
+    it 'freezes .layout for subclasses' do
+      AppViewLayout.layout.frozen?.must_equal true
+    end
+
+    it 'freezes .views' do
+      Lotus::View.views.frozen?.must_equal true
+    end
+
+    it 'freezes .format for all the views with that declaration' do
+      JsonRenderView.format.frozen?.must_equal true
+    end
+
+    it 'freezes .format for subclasses' do
+      Articles::RssIndex.format.frozen?.must_equal true
+    end
+
+    it 'freezes .template' do
+      Articles::Show.template.frozen?.must_equal true
+    end
+
+    it 'freezes .template for subclasses' do
+      Articles::JsonShow.template.frozen?.must_equal true
+    end
+
+    it 'freezes .subclasses' do
+      Articles::Index.subclasses.frozen?.must_equal true
+    end
+
+    it 'freezes .subclasses for subclasses' do
+      Articles::AtomIndex.subclasses.frozen?.must_equal true
+    end
+
+    it 'freezes view .views' do
+      Articles::Index.send(:views).frozen?.must_equal true
+    end
+
+    it 'freezes .views for subclasses' do
+      Articles::RssIndex.send(:views).frozen?.must_equal true
+    end
+
+    it 'freezes .registry' do
+      Articles::Index.send(:registry).frozen?.must_equal true
+    end
+
+    it 'freezes .registry for subclasses' do
+      Articles::AtomIndex.send(:registry).frozen?.must_equal true
+    end
+
+    describe 'layouts' do
+      it 'freezes .root' do
+        ApplicationLayout.root.frozen?.must_equal true
+      end
+
+      it 'freezes .registry' do
+        ApplicationLayout.send(:registry).frozen?.must_equal true
+      end
+    end
+  end
+end

data/test/presenter_test.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+
+describe Lotus::Presenter do
+  subject do
+    MapPresenter.new(map)
+  end
+
+  let(:map) { Map.new(['Rome']) }
+
+  it 'forwards methods to the wrapped object' do
+    subject.locations.must_equal map.locations
+  end
+
+  it 'uses concrete methods' do
+    subject.count.must_equal map.locations.count
+  end
+
+  it 'uses super to access object implementation' do
+    subject.location_names.must_equal map.locations.map {|l| l.upcase }.join(', ')
+  end
+
+  it 'has a direct access to the object' do
+    subject.inspect_object.must_match '#<Map'
+  end
+
+  it "raises error when the requested method can't be satisfied" do
+    -> {
+      subject.unknown_method
+    }.must_raise NoMethodError
+  end
+end

data/test/rendering_test.rb

@@ -0,0 +1,125 @@
+require 'test_helper'
+require 'ostruct'
+
+describe Lotus::View do
+  describe 'rendering' do
+    it 'renders a template' do
+      HelloWorldView.render(format: :html).must_include %(<h1>Hello, World!</h1>)
+    end
+
+    it 'renders a template with context binding' do
+      RenderView.render(format: :html, planet: 'Mars').must_include %(<h1>Hello, Mars!</h1>)
+    end
+
+    it 'renders a template according to the declared format' do
+      JsonRenderView.render(format: :json, planet: 'Moon').must_include %("greet":"Hello, Moon!")
+    end
+
+    it 'renders a template according to the requested format' do
+      articles = [ OpenStruct.new(title: 'Man on the Moon!') ]
+
+      rendered = Articles::Index.render(format: :json, articles: articles)
+      rendered.must_match %("title":"Man on the Moon!")
+
+      rendered = Articles::Index.render(format: :html, articles: articles)
+      rendered.must_match %(<h1>Man on the Moon!</h1>)
+    end
+
+    it 'binds given locals to the rendering context' do
+      article = OpenStruct.new(title: 'Hello')
+
+      rendered = Articles::Show.render(format: :html, article: article)
+      rendered.must_match %(<h1>HELLO</h1>)
+    end
+
+    it 'renders a template from a subclass, if it is able to handle the requested format' do
+      article = OpenStruct.new(title: 'Hello')
+
+      rendered = Articles::Show.render(format: :json, article: article)
+      rendered.must_match %("title":"olleh")
+    end
+
+    it 'raises an error when the template is missing' do
+      article = OpenStruct.new(title: 'Ciao')
+
+      -> {
+        Articles::Show.render(format: :png, article: article)
+      }.must_raise(Lotus::View::MissingTemplateError)
+    end
+
+    it 'raises an error when the format is missing' do
+      -> {
+        HelloWorldView.render({})
+      }.must_raise(Lotus::View::MissingFormatError)
+    end
+
+    it 'renders different template, as specified by DSL' do
+      article = OpenStruct.new(title: 'Bonjour')
+
+      rendered = Articles::Create.render(format: :html, article: article)
+      rendered.must_match %(<h1>New Article</h1>)
+      rendered.must_match %(<h2>Errors</h2>)
+    end
+
+    it 'decorates locals' do
+      map = Map.new(['Rome', 'Cambridge'])
+
+      rendered = Dashboard::Index.render(format: :html, map: map)
+      rendered.must_match %(<h1>Map</h1>)
+      rendered.must_match %(<h2>2 locations</h2>)
+    end
+
+    it 'renders a partial' do
+      article = OpenStruct.new(title: nil)
+
+      rendered = Articles::New.render(format: :html, article: article)
+
+      rendered.must_match %(<h1>New Article</h1>)
+      rendered.must_match %(<input type="hidden" name="secret" value="23" />)
+    end
+
+    it 'renders a template within another template' do
+      article = OpenStruct.new(title: nil)
+
+      rendered = Articles::AlternativeNew.render(format: :html, article: article)
+
+      rendered.must_match %(<h1>New Article</h1>)
+      rendered.must_match %(<input type="hidden" name="secret" value="23" />)
+    end
+
+    it 'uses HAML engine' do
+      person = OpenStruct.new(name: 'Luca')
+
+      rendered = Contacts::Show.render(format: :html, person: person)
+      rendered.must_match %(<h1>Luca</h1>)
+    end
+
+    describe 'when without a template' do
+      it 'renders from the custom rendering method' do
+        song = OpenStruct.new(title: 'Song Two', url: '/song2.mp3')
+
+        rendered = Songs::Show.render(format: :html, song: song)
+        rendered.must_equal %(<audio src="/song2.mp3">Song Two</audio>)
+      end
+
+      it 'respond to all the formats' do
+        rendered = Metrics::Index.render(format: :html)
+        rendered.must_equal %(metrics)
+
+        rendered = Metrics::Index.render(format: :json)
+        rendered.must_equal %(metrics)
+      end
+    end
+
+    describe 'layout' do
+      it 'renders contents from layout' do
+        articles = [ OpenStruct.new(title: 'A Wonderful Day!') ]
+
+        rendered = Articles::Index.render(format: :html, articles: articles)
+        rendered.must_match %(<h1>A Wonderful Day!</h1>)
+        rendered.must_match %(<html>)
+        rendered.must_match %(<title>Title: articles</title>)
+      end
+    end
+  end
+end

data/test/root_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+describe Lotus::View do
+  describe 'root' do
+    before do
+      Lotus::View.root = Pathname.new __dir__ + '/fixtures/templates'
+    end
+
+    it 'exposes the path where to lookup for templates' do
+      expected = Pathname.new __dir__ + '/fixtures/templates'
+      Lotus::View.root.must_equal expected
+    end
+
+    it 'is inherited' do
+      HelloWorldView.root.must_equal Lotus::View.root
+    end
+
+    it 'can be customized for each view' do
+      expected = Pathname.new __dir__ + '/fixtures/templates/app'
+      AppView.root.must_equal expected
+    end
+
+    describe 'when not set' do
+      before do
+        @root = Lotus::View.root
+        Lotus::View.root = nil
+      end
+
+      after do
+        Lotus::View.root = @root
+      end
+
+      it 'sets the current directory as root' do
+        Lotus::View.root.must_equal Pathname.new('.')
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'bundler/setup'
+
+if ENV['COVERAGE'] == 'true'
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    command_name 'test'
+    add_filter   'test'
+  end
+end
+
+require 'minitest/autorun'
+$:.unshift 'lib'
+require 'lotus/view'
+Lotus::View.root = Pathname.new __dir__ + '/fixtures/templates'
+require 'fixtures'
+Lotus::View.load!

data/test/version_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+describe Lotus::View::VERSION do
+  it 'returns current version' do
+    Lotus::View::VERSION.must_equal '0.1.0'
+  end
+end

data/test/view_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+describe Lotus::View do
+  describe '.layout=' do
+    before do
+      Lotus::View.unload!
+
+      class ViewWithInheritedLayout
+        include Lotus::View
+      end
+
+      Lotus::View.layout = :application
+      Lotus::View.load!
+    end
+
+    after do
+      Lotus::View.unload!
+      Object.send(:remove_const, :ViewWithInheritedLayout)
+      Lotus::View.layout = nil
+      Lotus::View.load!
+    end
+
+    it 'sets global layout' do
+      ViewWithInheritedLayout.layout.must_equal ApplicationLayout
+    end
+  end
+end