cuba 3.0.0.rc1 → 3.0.0.rc2

data/README.markdown

@@ -107,7 +107,6 @@ Cuba.define do
 
     # /username/foobar
     on "username/:username" do |username|
-
       user = User.find_by_username(username) # username == "foobar"
 
       # /username/foobar/posts
@@ -149,7 +148,6 @@ Cuba.define do
 end
 ```
 
-
 HTTP Verbs
 ----------
 
@@ -248,6 +246,123 @@ end
 To read more about testing, check the documentation for [Cutest][cutest] and
 [Capybara][capybara].
 
+Settings
+--------
+
+_You need Cuba 3.0.0 release candidate (gem install cuba --pre)._
+
+Each Cuba app can store settings in the `Cuba.settings` hash. The settings are
+inherited if you happen to subclass `Cuba`
+
+``` ruby
+Cuba.settings[:layout] = "guest"
+
+class Users < Cuba; end
+class Admin < Cuba; end
+
+Admin.settings[:layout] = "admin"
+
+assert_equal "guest", Users.settings[:layout]
+assert_equal "admin", Admin.settings[:layout]
+
+```
+
+Feel free to store whatever you find convenient.
+
+Rendering
+---------
+
+_You need Cuba 3.0.0 release candidate (gem install cuba --pre)._
+
+Cuba ships with a plugin that provides helpers for rendering templates. It uses
+[Tilt][tilt], a gem that interfaces with many template engines.
+
+``` ruby
+require "cuba/render"
+
+Cuba.plugin Cuba::Render
+
+Cuba.define do
+  on default do
+
+    # Within the partial, you will have access to the local variable `content`,
+    # that will hold the value "hello, world".
+    res.write render("home.haml", content: "hello, world")
+  end
+end
+```
+
+Note that in order to use this plugin you need to have [Tilt][tilt] installed, along
+with the templating engines you want to use.
+
+Plugins
+-------
+
+_You need Cuba 3.0.0 release candidate (gem install cuba --pre)._
+
+Cuba provides a way to extend its functionality with plugins.
+
+### How to create plugins
+
+Authoring your own plugins is pretty straightforward.
+
+``` ruby
+module MyOwnHelper
+  def markdown(str)
+    BlueCloth.new(str).to_html
+  end
+end
+
+Cuba.plugin MyOwnHelper
+```
+
+That's the simplest kind of plugin you'll write. In fact, that's exactly how
+the `markdown` helper is written in `Cuba::TextHelpers`.
+
+A more complicated plugin can make use of `Cuba.settings` to provide default
+values. In the following example, note that if the module has a `setup` method it will
+be called as soon as it is included:
+
+``` ruby
+module Render
+  def self.setup(app)
+    app.settings[:template_engine] = "erb"
+  end
+
+  def partial(template, locals = {})
+    render("#{template}.#{settings[:template_engine]}", locals)
+  end
+end
+
+Cuba.plugin Render
+```
+
+This sample plugin actually resembles how `Cuba::Render` works.
+
+Finally, if a module called `ClassMethods` is present, `Cuba` will be extended
+with it.
+
+``` ruby
+module GetSetter
+  module ClassMethods
+    def set(key, value)
+      settings[key] = value
+    end
+
+    def get(key)
+      settings[key]
+    end
+  end
+end
+
+Cuba.plugin GetSetter
+
+Cuba.set(:foo, "bar")
+
+assert_equal "bar", Cuba.get(:foo)
+assert_equal "bar", Cuba.settings[:foo]
+```
+
 Installation
 ------------
 

data/cuba.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = "cuba"
-  s.version           = "3.0.0.rc1"
+  s.version           = "3.0.0.rc2"
   s.summary           = "Microframework for web applications."
   s.description       = "Cuba is a microframework for web applications."
   s.authors           = ["Michel Martens"]
@@ -18,7 +18,6 @@ Gem::Specification.new do |s|
   ]
 
   s.add_dependency "rack"
-  s.add_dependency "tilt"
   s.add_development_dependency "cutest"
   s.add_development_dependency "capybara"
 end

data/lib/cuba.rb

@@ -1,8 +1,7 @@
 require "rack"
 
 class Cuba
-  class RedefinitionError < StandardError
-  end
+  class RedefinitionError < StandardError; end
 
   @@methods = []
 

data/lib/cuba/render.rb

@@ -0,0 +1,48 @@
+require "tilt"
+
+class Cuba
+  module Render
+    def self.setup(app)
+      app.settings[:template_engine] ||= "erb"
+      app.settings[:views] ||= File.expand_path("views", Dir.pwd)
+    end
+
+    def view(template, locals = {}, layout = "layout")
+      partial(layout, { content: partial(template, locals) }.merge(locals))
+    end
+
+    def partial(template, locals = {})
+      render("#{settings[:views]}/#{template}.#{settings[:template_engine]}",
+        locals, default_encoding: Encoding.default_external)
+    end
+
+    # Render any type of template file supported by Tilt.
+    #
+    # @example
+    #
+    #   # Renders home, and is assumed to be HAML.
+    #   render("home.haml")
+    #
+    #   # Renders with some local variables
+    #   render("home.haml", site_name: "My Site")
+    #
+    #   # Renders with HAML options
+    #   render("home.haml", {}, ugly: true, format: :html5)
+    #
+    #   # Renders in layout
+    #   render("layout.haml") { render("home.haml") }
+    #
+    def render(template, locals = {}, options = {}, &block)
+      _cache.fetch(template) {
+        Tilt.new(template, 1, options)
+      }.render(self, locals, &block)
+    end
+
+    # @private Used internally by #render to cache the
+    #          Tilt templates.
+    def _cache
+      Thread.current[:_cache] ||= Tilt::Cache.new
+    end
+    private :_cache
+  end
+end

data/test/render.rb

@@ -0,0 +1,94 @@
+require_relative "helper"
+
+require "cuba/render"
+
+test "doesn't override the settings if they already exist" do
+  Cuba.settings[:views] = "./test/views"
+  Cuba.settings[:template_engine] = "haml"
+
+  Cuba.plugin Cuba::Render
+
+  assert_equal "./test/views", Cuba.settings[:views]
+  assert_equal "haml", Cuba.settings[:template_engine]
+end
+
+scope do
+  setup do
+    Cuba.plugin Cuba::Render
+    Cuba.settings[:views] = "./test/views"
+    Cuba.settings[:template_engine] = "erb"
+
+    Cuba.define do
+      on "home" do
+        res.write view("home", name: "Agent Smith", title: "Home")
+      end
+
+      on "about" do
+        res.write partial("about", title: "About Cuba")
+      end
+    end
+  end
+
+  test "partial" do
+    _, _, body = Cuba.call({ "PATH_INFO" => "/about", "SCRIPT_NAME" => "/" })
+
+    assert_response body, ["<h1>About Cuba</h1>\n"]
+  end
+
+  test "view" do
+    _, _, body = Cuba.call({ "PATH_INFO" => "/home", "SCRIPT_NAME" => "/" })
+
+    assert_response body, ["<title>Cuba: Home</title>\n<h1>Home</h1>\n<p>Hello Agent Smith</p>\n"]
+  end
+
+  test "partial with str as engine" do
+    Cuba.settings[:template_engine] = "str"
+
+    _, _, body = Cuba.call({ "PATH_INFO" => "/about", "SCRIPT_NAME" => "/" })
+
+    assert_response body, ["<h1>About Cuba</h1>\n"]
+  end
+
+  test "view with str as engine" do
+    Cuba.settings[:template_engine] = "str"
+
+    _, _, body = Cuba.call({ "PATH_INFO" => "/home", "SCRIPT_NAME" => "/" })
+
+    assert_response body, ["<title>Cuba: Home</title>\n<h1>Home</h1>\n<p>Hello Agent Smith</p>\n\n"]
+  end
+end
+
+test "caching behavior" do
+  Thread.current[:_cache] = nil
+
+  Cuba.plugin Cuba::Render
+  Cuba.settings[:views] = "./test/views"
+
+  Cuba.define do
+    on "foo/:i" do |i|
+      res.write partial("test", title: i)
+    end
+  end
+
+  10.times do |i|
+    _, _, resp = Cuba.call({ "PATH_INFO" => "/foo/#{i}", "SCRIPT_NAME" => "" })
+  end
+
+  assert_equal 1, Thread.current[:_cache].instance_variable_get(:@cache).size
+end
+
+test "simple layout support" do
+  Cuba.plugin Cuba::Render
+
+  Cuba.define do
+    on true do
+      res.write render("test/views/layout-yield.erb") {
+        render("test/views/content-yield.erb")
+      }
+    end
+  end
+
+  _, _, resp = Cuba.call({})
+
+  assert_equal ["Header\nThis is the actual content.\nFooter\n"], resp.body
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cuba
 version: !ruby/object:Gem::Version
-  version: 3.0.0.rc1
+  version: 3.0.0.rc2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-15 00:00:00.000000000 Z
+date: 2012-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2160204820 !ruby/object:Gem::Requirement
+  requirement: &2152217600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160204820
-- !ruby/object:Gem::Dependency
-  name: tilt
-  requirement: &2160203660 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *2160203660
+  version_requirements: *2152217600
 - !ruby/object:Gem::Dependency
   name: cutest
-  requirement: &2160218800 !ruby/object:Gem::Requirement
+  requirement: &2152216880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160218800
+  version_requirements: *2152216880
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &2160218280 !ruby/object:Gem::Requirement
+  requirement: &2152216340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160218280
+  version_requirements: *2152216340
 description: Cuba is a microframework for web applications.
 email:
 - michel@soveran.com
@@ -66,7 +55,7 @@ files:
 - CHANGELOG
 - README.markdown
 - Rakefile
-- lib/cuba/settings.rb
+- lib/cuba/render.rb
 - lib/cuba/test.rb
 - lib/cuba.rb
 - cuba.gemspec
@@ -85,6 +74,7 @@ files:
 - test/path.rb
 - test/plugin.rb
 - test/redefinition.rb
+- test/render.rb
 - test/root.rb
 - test/run.rb
 - test/segment.rb

data/lib/cuba/settings.rb

@@ -1,25 +0,0 @@
-class Cuba
-  module Settings
-    def settings
-      self.class
-    end
-
-    module ClassMethods
-      def set(key, value)
-        metaclass.send :attr_writer, key
-        metaclass.module_eval %{
-          def #{key}
-            @#{key} ||= #{value.inspect}
-          end
-        }
-
-        send :"#{key}=", value
-      end
-
-    private
-      def metaclass
-        class << self; self; end
-      end
-    end
-  end
-end