hobbit-contrib 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7f3320b3437d3168749e5581b999a443a48e001
-  data.tar.gz: 4cc4a32c36aeb3068cfc17aca524be92ecbee78d
+  metadata.gz: 774186fdc100731a772b7134afc48cae8d824154
+  data.tar.gz: 96380c2994f125c6594170f75b52e16434e2cee3
 SHA512:
-  metadata.gz: a3464d83f2d94c32c9a32d29afa4a5a7548539d9fa00876ba20b9301b43b306aa4b56f219b4854006fb9f50b96963634a586eedcff26825eeb49e67c9c2b9c39
-  data.tar.gz: 0248e6223440165e6f2c0efe3ab91ea95c50c3af3c67496d4061edce43a866c7607a4b86da1008b45cffa9ab8ab76af3139da33ceeb60bf96b0136ba8d5223e1
+  metadata.gz: 8e969363d5fd33c76f57c147e498abf4efa1a284290420ff9f1b96136f2c8e9823793e9f7357dc30207337481e93fd17241944a03602f1eab926623aa34704ad
+  data.tar.gz: e9336cee1b8c292a8d6e82913b6a1f6c813105416c25b8a6b0353722ab915a9299002baf3a59e730f9a112a265472f4c5dae254fab30f23c0a2a4c124c25559b

data/README.md

@@ -118,41 +118,6 @@ above).
 an url, it returns the given url. If you pass an arbitrary string, it returns
 `/stylesheets/#{url}.css`.
 
-### Hobbit::EnhancedRender
-
-This module extends the functionality of `Hobbit::Render`. To use this extension
-just include the module:
-
-```ruby
-require 'hobbit'
-require 'hobbit/contrib'
-
-class App < Hobbit::Base
-  include Hobbit::EnhancedRender
-
-  get '/' do
-    # index will become views/index.erb
-    # use a layout (named 'layout'. It will become views/layouts/layout.erb)
-    render 'index', {}, layout: 'layout'
-  end
-end
-```
-
-#### Available methods
-
-* `template_engine`: Returns the default template engine being used for this
-application. By default is `erb`.
-* `layout_path`: Returns the layout path according to the given template. For
-instance, `layout_path('layout')` will become `views/layouts/layout.erb`
-* `view_path`: Returns the view path according to the given template. For
-instance, `view_path('index')` will become `views/index.erb`
-* `render`: It's the same as in `Hobbit::Render`, but you can render templates
-with a layout (See the example above).
-* `partial`: It's the same as `render`, but expands the template name to the
-views path, except that the template name will start with an underscore. For
-instance, if you call `partial 'partial'`, the path will become
-`views/_partial.erb`
-
 ### Hobbit::Environment
 
 This extension allows you to control the application environment by using the
@@ -265,20 +230,27 @@ class App < Hobbit::Base
   include Hobbit::Render
 
   get '/' do
-    render 'views/index.erb'
-  end
-
-  get '/with-layout' do
-    render 'views/layout.erb' do
-      render 'views/index.erb'
-    end
+    # will render views/index.erb using views/layouts/application.erb as layout
+    render 'index'
   end
 end
 ```
 
 #### Available methods
 
-* `render`: Renders the given template using tilt.
+* `default_layout`: Returns the name of the default layout (Override to use
+another layout).
+* `find_template`: Returns the path to a template (Override for multiple views
+paths lookup).
+* `layouts_path`: Returns the layouts path (Override to change the layouts
+directory).
+* `partial`: Renders the given template using tilt (without a layout).
+* `render`: Renders the given template using tilt. You can pass a `layout`
+option to change the layout (or set to `false` to not use one).
+* `template_engine`: Returns the template engine beign used (Override to use
+other template engine).
+* `views_path`: Returns the views path (Override to change the views
+directory).
 
 ### Hobbit::Session
 
@@ -291,6 +263,7 @@ require 'hobbit/contrib'
 
 class App < Hobbit::Base
   include Hobbit::Session
+  use Rack::Session::Cookie, secret: SecureRandom.hex(64)
 
   post '/' do
     session[:name] = 'hobbit'
@@ -316,4 +289,4 @@ end
 
 ## License
 
-See the [LICENSE](https://github.com/patriciomacadden/hobbit-contrib/blob/master/LICENSE).
+See the [LICENSE](https://github.com/patriciomacadden/hobbit-contrib/blob/master/LICENSE).

data/lib/hobbit/contrib.rb

@@ -1,6 +1,5 @@
 require 'hobbit/asset_tag'
 require 'hobbit/contrib/version'
-require 'hobbit/enhanced_render'
 require 'hobbit/environment'
 require 'hobbit/error_handling'
 require 'hobbit/filter'

data/lib/hobbit/contrib/version.rb

@@ -1,5 +1,5 @@
 module Hobbit
   module Contrib
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/hobbit/render.rb

@@ -2,16 +2,55 @@ require 'tilt'
 
 module Hobbit
   module Render
+    def default_layout
+      "#{layouts_path}/application.#{template_engine}"
+    end
+
+    def find_template(template)
+      "#{views_path}/#{template}.#{template_engine}"
+    end
+
+    def layouts_path
+      "#{views_path}/layouts"
+    end
+
+    def partial(template, locals = {}, options = {}, &block)
+      template = find_template "_#{template}"
+      _render template, locals, options, &block
+    end
+
     def render(template, locals = {}, options = {}, &block)
-      cache.fetch(template) do
-        Tilt.new(template, options)
-      end.render(self, locals, &block)
+      template = find_template template
+      layout = default_layout
+      if options.include? :layout
+        layout = options[:layout]
+        options.delete :layout
+      end
+      if layout
+        _render(layout) { _render(template) }
+      else
+        _render template
+      end
+    end
+
+    def template_engine
+      'erb'
+    end
+
+    def views_path
+      'views'
     end
 
     private
 
+    def _render(template, locals = {}, options = {}, &block)
+      cache.fetch template do
+        Tilt.new template, options
+      end.render self, locals, &block
+    end
+
     def cache
       Thread.current[:cache] ||= Tilt::Cache.new
     end
   end
-end
+end

data/spec/fixtures/render/views/_partial.erb

@@ -0,0 +1,5 @@
+<!DOCTYPE html>
+<html>
+  <head><title>Hello World!</title></head>
+  <body>Hello World!</body>
+</html>

data/spec/fixtures/render/views/index.erb

@@ -1,5 +1 @@
-<!DOCTYPE html>
-<html>
-  <head><title>Hello World!</title></head>
-  <body>Hello World!</body>
-</html>
+<h1>Hello World!</h1>

data/spec/fixtures/{enhanced_render/views/layouts/layout.erb → render/views/layouts/application.erb}

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
   <head>
-    <title>From layout.erb</title>
+    <title>From application.erb</title>
   </head>
   <body>
     <%= yield %>

data/spec/render_spec.rb

@@ -8,26 +8,80 @@ describe Hobbit::Render do
     mock_app do
       include Hobbit::Render
 
+      def views_path
+        File.expand_path '../fixtures/render/views/', __FILE__
+      end
+
       def name
         'Hobbit'
       end
 
-      get('/') { render File.expand_path('../fixtures/render/views/index.erb', __FILE__) }
-      get('/using-context') { render File.expand_path('../fixtures/render/views/hello.erb', __FILE__) }
+      get('/') { render 'index' }
+      get('/partial') { partial 'partial' }
+      get('/using-context') { render 'hello' }
+      get('/without-layout') { render '_partial', {}, layout: false }
+    end
+  end
+
+  describe '#default_layout' do
+    it 'defaults to application.erb' do
+      app.to_app.default_layout.must_equal "#{app.to_app.layouts_path}/application.erb"
+    end
+  end
+
+  describe '#find_template' do
+    it 'must return a template path' do
+      app.to_app.find_template('index').must_equal "#{app.to_app.views_path}/index.#{app.to_app.template_engine}"
+    end
+  end
+
+  describe '#layouts_path' do
+    it 'must return the path to the layouts directory' do
+      app.to_app.layouts_path.must_equal "#{app.to_app.views_path}/layouts"
+    end
+  end
+
+  describe '#partial' do
+    it 'must render a template without a layout' do
+      get '/partial'
+      last_response.must_be :ok?
+      last_response.body.wont_match /From application.erb/
+      last_response.body.must_match /Hello World!/
     end
   end
 
   describe '#render' do
-    it 'must render a template' do
+    it 'must render a template (using a layout)' do
       get '/'
       last_response.must_be :ok?
+      last_response.body.must_match /From application.erb/
+      last_response.body.must_match /Hello World!/
+    end
+
+    it 'must render a template (not using a layout)' do
+      get '/without-layout'
+      last_response.must_be :ok?
+      last_response.body.wont_match /From application.erb/
       last_response.body.must_match /Hello World!/
     end
 
-    it 'must use the app as context' do
+    it 'must render a template using the app as context' do
       get '/using-context'
       last_response.must_be :ok?
+      last_response.body.must_match /From application.erb/
       last_response.body.must_match /Hello Hobbit!/
     end
   end
+
+  describe '#template_engine' do
+    it 'defaults to erb' do
+      app.to_app.template_engine.must_equal 'erb'
+    end
+  end
+
+  describe '#views_path' do
+    it 'must return the path to the views directory' do
+      app.to_app.views_path.must_equal File.expand_path('../fixtures/render/views', __FILE__)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hobbit-contrib
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Patricio Mac Adden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-09 00:00:00.000000000 Z
+date: 2013-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -153,23 +153,20 @@ files:
 - lib/hobbit/asset_tag.rb
 - lib/hobbit/contrib.rb
 - lib/hobbit/contrib/version.rb
-- lib/hobbit/enhanced_render.rb
 - lib/hobbit/environment.rb
 - lib/hobbit/error_handling.rb
 - lib/hobbit/filter.rb
 - lib/hobbit/render.rb
 - lib/hobbit/session.rb
 - spec/asset_tag_spec.rb
-- spec/enhanced_render_spec.rb
 - spec/environment_spec.rb
 - spec/error_handling_and_filter_spec.rb
 - spec/error_handling_spec.rb
 - spec/filter_spec.rb
-- spec/fixtures/enhanced_render/views/_partial.erb
-- spec/fixtures/enhanced_render/views/index.erb
-- spec/fixtures/enhanced_render/views/layouts/layout.erb
+- spec/fixtures/render/views/_partial.erb
 - spec/fixtures/render/views/hello.erb
 - spec/fixtures/render/views/index.erb
+- spec/fixtures/render/views/layouts/application.erb
 - spec/minitest_helper.rb
 - spec/render_spec.rb
 - spec/session_spec.rb
@@ -199,16 +196,14 @@ specification_version: 4
 summary: Contributed Hobbit extensions
 test_files:
 - spec/asset_tag_spec.rb
-- spec/enhanced_render_spec.rb
 - spec/environment_spec.rb
 - spec/error_handling_and_filter_spec.rb
 - spec/error_handling_spec.rb
 - spec/filter_spec.rb
-- spec/fixtures/enhanced_render/views/_partial.erb
-- spec/fixtures/enhanced_render/views/index.erb
-- spec/fixtures/enhanced_render/views/layouts/layout.erb
+- spec/fixtures/render/views/_partial.erb
 - spec/fixtures/render/views/hello.erb
 - spec/fixtures/render/views/index.erb
+- spec/fixtures/render/views/layouts/application.erb
 - spec/minitest_helper.rb
 - spec/render_spec.rb
 - spec/session_spec.rb

data/lib/hobbit/enhanced_render.rb

@@ -1,33 +0,0 @@
-require 'hobbit/render'
-
-module Hobbit
-  module EnhancedRender
-    include Hobbit::Render
-
-    def layout_path(template)
-      "views/layouts/#{template}.#{template_engine}"
-    end
-
-    def partial(template, locals = {}, options = {}, &block)
-      render "_#{template}", locals, options, &block
-    end
-
-    def render(template, locals = {}, options = {}, &block)
-      template = view_path(template)
-      layout = options.delete(:layout)
-      if layout.nil?
-        super
-      else
-        super(layout_path layout) { super }
-      end
-    end
-
-    def template_engine
-      'erb'
-    end
-
-    def view_path(template)
-      "views/#{template}.#{template_engine}"
-    end
-  end
-end

data/spec/enhanced_render_spec.rb

@@ -1,82 +0,0 @@
-require 'minitest_helper'
-
-describe Hobbit::EnhancedRender do
-  include Hobbit::Contrib::Mock
-  include Rack::Test::Methods
-
-  def app
-    mock_app do
-      include Hobbit::EnhancedRender
-
-      # we do this because it the layout path is relative to file being run
-      def layout_path(template)
-        File.expand_path("../fixtures/enhanced_render/#{super}", __FILE__)
-      end
-
-      # we do this because it the view path is relative to file being run
-      def view_path(template)
-        File.expand_path("../fixtures/enhanced_render/#{super}", __FILE__)
-      end
-
-      get '/' do
-        render 'index', {}, layout: 'layout'
-      end
-
-      get '/without-layout' do
-        render 'index'
-      end
-
-      get '/partial' do
-        partial 'partial'
-      end
-    end
-  end
-
-  describe '#layout_path' do
-    it 'must return a path' do
-      path = File.expand_path('../fixtures/enhanced_render/views/layouts/layout.erb', __FILE__)
-      app.to_app.layout_path('layout').must_equal path
-    end
-  end
-
-  describe '#partial' do
-    it 'must render' do
-      get '/partial'
-      last_response.must_be :ok?
-      last_response.body.wont_match /From layout.erb/
-      last_response.body.wont_match /From index.erb/
-      last_response.body.must_match /From _partial.erb/
-    end
-  end
-
-  describe '#render' do
-    it 'must render with a layout' do
-      get '/'
-      last_response.must_be :ok?
-      last_response.body.must_match /From layout.erb/
-      last_response.body.must_match /From index.erb/
-      last_response.body.must_match /From _partial.erb/
-    end
-
-    it 'must render without a layout' do
-      get '/without-layout'
-      last_response.must_be :ok?
-      last_response.body.wont_match /From layout.erb/
-      last_response.body.must_match /From index.erb/
-      last_response.body.must_match /From _partial.erb/
-    end
-  end
-
-  describe '#template_engine' do
-    it 'must be erb by default' do
-      app.to_app.template_engine.must_equal 'erb'
-    end
-  end
-
-  describe '#view_path' do
-    it 'must return a path' do
-      path = File.expand_path('../fixtures/enhanced_render/views/index.erb', __FILE__)
-      app.to_app.view_path('index').must_equal path
-    end
-  end
-end

data/spec/fixtures/enhanced_render/views/_partial.erb

@@ -1 +0,0 @@
-<h2>From _partial.erb</h2>

data/spec/fixtures/enhanced_render/views/index.erb

@@ -1,2 +0,0 @@
-<h1>From index.erb</h1>
-<%= partial 'partial' %>