cuba 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b881a2c6bb3396ac4515bea4b2a9745933f071b2
-  data.tar.gz: dad770ec883f93c34cd0f0bb55a0fb5f8a782096
+  metadata.gz: 9fc1228862c8a441f9246f55475c5794761605b8
+  data.tar.gz: e5ddde6ab8c8e56c15910551eca0e49960b29c31
 SHA512:
-  metadata.gz: 16ff53505523c87084f283005ad9819e06d87676d08663ebe430c15924beb7265a55c88328a7b71dd04fb3c13af5035b590e620319c3752b8da7515aa054d9d4
-  data.tar.gz: 5e1ef15fa6595a48050e3fbdf1fbd71cba9615a509631a5724445bb20bd37e6f5b1b9eb40d8295c0474c8e533a22f3bf14387a7443e4440133fbe97a917beaf1
+  metadata.gz: 8eb9986361bbdbee4d60ed75167870d37bbd16b38aa676a73cc3c5e0f0831c3c4654464f192d015cfd1a0b796858e4389087206e4fb72fa81ef57c1d79f630e8
+  data.tar.gz: f7e6ab58e6517f5768e2773bafcc4a2d8f0d01462be4c443079085b3142813c21eaaebf65cad9c096eb2513e60ca091cc041d3f00c9697aea85ec05879265dc1

data/.gems

@@ -0,0 +1,4 @@
+cutest -v 1.2.1
+rack -v 1.5.2
+tilt -v 2.0.1
+rack-test -v 0.6.2

data/.gitignore

@@ -0,0 +1,2 @@
+/pkg
+webrat.log

data/CHANGELOG

@@ -1,3 +1,7 @@
+3.2.0
+
+* Return 404 when status is not explicitly set and body is empty.
+
 3.1.1
 
 * Add support for custom default layouts.

data/README.md

@@ -30,6 +30,16 @@ It integrates many templates via [Tilt][tilt], and testing via
 [capybara]: http://github.com/jnicklas/capybara
 [rack-test]: https://github.com/brynary/rack-test
 
+Guide
+-----
+
+There's a book called [The Guide to Cuba][guide] that explains how
+to build web applications by following a minimalistic approach. It
+is recommended reading for anyone trying to learn the basics of
+Cuba and other related tools.
+
+[guide]: http://theguidetocuba.io
+
 Installation
 ------------
 
@@ -162,8 +172,8 @@ Cuba.define do
         res.write "#{user}:#{pass}" #=> "foo:baz"
       end
 
-      # If the params `user` and `pass` are not provided, this block will
-      # get executed.
+      # If the params `user` and `pass` are not provided, this
+      # block will get executed.
       on true do
         res.write "You need to provide user and pass!"
       end
@@ -175,50 +185,10 @@ end
 Status codes
 ------------
 
-As soon as an `on` block is executed, the status code for the
-response is changed to 200. The default status code is 404, and it
-is returned if no `on` block succeeds inside a Cuba app.
-
-As this behavior can be tricky, let's look at some examples:
-
-``` ruby
-Cuba.define do
-  on get do
-    on "hello" do
-      res.write "hello world"
-    end
-  end
-end
-
-# Requests:
-#
-# GET /            # 200, ""
-# GET /hello       # 200, "hello world"
-# GET /hello/world # 200, "hello world"
-```
-
-As you can see, as soon as `on get` matched, the status code was
-changed to 200. If you expected some of those requests to return a
-404 status code, you may be surprised by this behavior.
-
-In the following example, as both arguments to `on` must match,
-the requests to `/` return 404.
-
-``` ruby
-Cuba.define do
-  on get, "hello" do
-    res.write "hello world"
-  end
-end
-
-# Requests:
-#
-# GET /            # 404, ""
-# GET /hello       # 200, "hello world"
-# GET /hello/world # 200, "hello world"
-```
+If you don't assign a status code and you don't write to the `res`
+object, the status will be set as `404`.
 
-Another way is to add a default block:
+For example:
 
 ``` ruby
 Cuba.define do
@@ -226,79 +196,46 @@ Cuba.define do
     on "hello" do
       res.write "hello world"
     end
-
-    on default do
-      res.status = 404
-    end
-  end
-end
-
-# Requests:
-#
-# GET /            # 404, ""
-# GET /hello       # 200, "hello world"
-# GET /hello/world # 200, "hello world"
-```
-
-Yet another way is to mount an application with routes that don't
-match the request:
-
-``` ruby
-SomeApp = Cuba.new do
-  on "bye" do
-    res.write "bye!"
-  end
-end
-
-Cuba.define do
-  on get do
-    run SomeApp
   end
 end
 
 # Requests:
 #
-# GET /            # 404, ""
-# GET /hello       # 404, ""
-# GET /hello/world # 404, ""
+# GET /            # 404
+# GET /hello       # 200
+# GET /hello/world # 200
 ```
 
-As Cuba encourages the composition of applications, this last
-example is a very common pattern.
+As you can see, as soon as something was written to the response,
+the status code was changed to 200.
 
-You can also change the status code at any point inside the define
-block. That way you can change the default status, as shown in the
-following example:
+If you want to match just "hello", but not "hello/world", you can do
+as follows:
 
 ``` ruby
 Cuba.define do
-  res.status = 404
-
   on get do
     on "hello" do
-      res.status = 200
-      res.write "hello world"
+      on root do
+      	res.write "hello world"
+      end
     end
   end
 end
 
 # Requests:
 #
-# GET /            # 404, ""
-# GET /hello       # 200, "hello world"
-# GET /hello/world # 200, "hello world"
+# GET /            # 404
+# GET /hello       # 200
+# GET /hello/world # 404
 ```
 
-If you really want to return 404 for everything under "hello", you
-can match the end of line:
+You can also use a regular expression to match the end of line:
 
 ``` ruby
 Cuba.define do
-  res.status = 404
-
   on get do
     on /hello\/?\z/ do
-      res.status = 200
       res.write "hello world"
     end
   end
@@ -306,9 +243,9 @@ end
 
 # Requests:
 #
-# GET /            # 404, ""
-# GET /hello       # 200, "hello world"
-# GET /hello/world # 404, ""
+# GET /            # 404
+# GET /hello       # 200
+# GET /hello/world # 404
 ```
 
 This last example is not a common usage pattern. It's here only to
@@ -326,11 +263,8 @@ end
 Cuba.plugin TerminalMatcher
 
 Cuba.define do
-  res.status = 404
-
   on get do
     on terminal("hello") do
-      res.status = 200
       res.write "hello world"
     end
   end
@@ -532,46 +466,69 @@ Feel free to store whatever you find convenient.
 Rendering
 ---------
 
-Cuba ships with a plugin that provides helpers for rendering templates. It uses
-[Tilt][tilt], a gem that interfaces with many template engines.
+Cuba includes a plugin called `Cuba::Render` that provides a couple of helper
+methods for rendering templates. This plugin uses [Tilt][tilt], which serves as
+an interface to a bunch of different Ruby template engines (ERB, Haml, Sass,
+CoffeeScript, etc.), so you can use the template engine of your choice.
 
-``` ruby
+To set up `Cuba::Render`, do:
+
+```ruby
+require "cuba"
 require "cuba/render"
+require "erb"
+
+Cuba.plugin(Cuba::Render)
+```
+
+This example use ERB, a template engine that comes with Ruby. If you want to
+use another template engine, one [supported by Tilt][templates], you need to
+install the required gem and change the `template_engine` setting as shown
+below.
 
-Cuba.plugin Cuba::Render
+```ruby
+Cuba.settings[:render][:template_engine] = "haml"
+```
 
+The plugin provides three helper methods for rendering templates: `partial`,
+`view` and `render`.
+
+```ruby
 Cuba.define do
-  on default do
+  on "about" do
+    # `partial` renders a template called `about.erb` without a layout.
+    res.write partial("about")
+  end
 
-    # 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")
+  on "home" do
+    # Opposed to `partial`, `view` renders the same template
+    # within a layout called `layout.erb`.
+    res.write view("about")
+  end
+
+  on "contact" do
+    # `render` is a shortcut to `res.write view(...)`
+    render("contact")
   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.
+By default, `Cuba::Render` assumes that all templates are placed in a folder
+named `views` and that they use the proper extension for the chosen template
+engine. Also for the `view` and `render` methods, it assumes that the layout
+template is called `layout`.
 
-You can also configure the template engine in the app's settings,
-and that will allow you to skip the file extension when rendering a
-file:
-
-``` ruby
-require "cuba/render"
+The defaults can be changed through the `Cuba.settings` method:
 
-Cuba.plugin Cuba::Render
-Cuba.settings[:render][:template_engine] = "slim"
+```ruby
+Cuba.settings[:render][:template_engine] = "haml"
+Cuba.settings[:render][:views] = "./views/admin/"
+Cuba.settings[:render][:layout] = "admin"
+```
 
-Cuba.define do
-  on default do
+NOTE: Cuba doesn't ship with Tilt. You need to install it (`gem install tilt`).
 
-    # Now we can use the `view` helper, which guesses the file
-    # extension based on the configured template_engine.
-    res.write view("home", content: "hello, world")
-  end
-end
-```
+[templates]: https://github.com/rtomayko/tilt/blob/master/docs/TEMPLATES.md
 
 Plugins
 -------
@@ -638,3 +595,26 @@ Cuba.set(:foo, "bar")
 assert_equal "bar", Cuba.get(:foo)
 assert_equal "bar", Cuba.settings[:foo]
 ```
+
+Contributing
+------------
+
+A good first step is to meet us on IRC and discuss ideas. If that's
+not possible, you can create an issue explaning the proposed change
+and a use case. We pay a lot of attention to use cases, because our
+goal is to keep the code base simple. In many cases, the result of
+a conversation will be the creation of another tool, instead of the
+modification of Cuba itself.
+
+If you want to test Cuba, you may want to use a gemset to isolate
+the requirements. We recommend the use of tools like [dep][dep] and
+[gs][gs], but you can use similar tools like [gst][gst] or [bs][bs].
+
+The required gems for testing and development are listed in the
+`.gems` file. If you are using [dep][dep], you can create a gemset
+and run `dep install`.
+
+[dep]: http://cyx.github.io/dep/
+[gs]: http://soveran.github.io/gs/
+[gst]: https://github.com/tonchis/gst
+[bs]: https://github.com/educabilia/bs

data/cuba.gemspec

@@ -1,21 +1,14 @@
 Gem::Specification.new do |s|
   s.name              = "cuba"
-  s.version           = "3.1.1"
+  s.version           = "3.2.0"
   s.summary           = "Microframework for web applications."
   s.description       = "Cuba is a microframework for web applications."
   s.authors           = ["Michel Martens"]
   s.email             = ["michel@soveran.com"]
-  s.homepage          = "http://github.com/soveran/cuba"
+  s.homepage          = "https://github.com/soveran/cuba"
+  s.license           = "MIT"
 
-  s.files = Dir[
-    "LICENSE",
-    "CHANGELOG",
-    "README.md",
-    "Rakefile",
-    "lib/**/*.rb",
-    "*.gemspec",
-    "test/*.*"
-  ]
+  s.files = `git ls-files`.split("\n")
 
   s.add_dependency "rack"
   s.add_development_dependency "cutest"

data/examples/config.ru

@@ -0,0 +1,18 @@
+require "../lib/cuba"
+require "cuba/contrib"
+
+Cuba.plugin Cuba::Mote
+
+ITEMS = ("A".."Z").to_a
+
+Cuba.define do
+  def mote_vars(content)
+    { content: content }
+  end
+
+  on default do
+    res.write view("home", list: ITEMS)
+  end
+end
+
+run Cuba

data/examples/measure.rb

@@ -0,0 +1,17 @@
+require "benchmark"
+require "rack"
+
+Benchmark.bmbm do |x|
+
+  x.report "Rack::HeaderHash" do
+    1000.times do
+      Rack::Utils::HeaderHash.new("Content-Type" => "text/html")
+    end
+  end
+
+  x.report "Hash" do
+    1000.times do
+      { "Content-Type" => "text/html" }
+    end
+  end
+end

data/examples/rack-response.ru

@@ -0,0 +1,21 @@
+require "../lib/cuba"
+require "cuba/contrib"
+
+Cuba.plugin Cuba::Mote
+
+ITEMS = ("A".."Z").to_a
+
+Cuba.send :remove_const, :Response
+Cuba::Response = Rack::Response
+
+Cuba.define do
+  def mote_vars(content)
+    { content: content }
+  end
+
+  on default do
+    res.write view("home", list: ITEMS)
+  end
+end
+
+run Cuba

data/examples/views/home.mote

@@ -0,0 +1,7 @@
+This is the body
+
+<ul>
+  % list.each do |e|
+    <li>{{ e }}</li>
+  % end
+</ul>

data/examples/views/layout.mote

@@ -0,0 +1,11 @@
+<html>
+  <head>
+    <meta charset="utf-8">
+  
+    <title>Home</title>
+  </head>
+
+  <body>
+    {{ content }}
+  </body>
+</html>

data/lib/cuba.rb

@@ -5,9 +5,10 @@ class Cuba
   class Response
     attr_accessor :status
 
+    attr :body
     attr :headers
 
-    def initialize(status = 200,
+    def initialize(status = nil,
                    headers = { "Content-Type" => "text/html; charset=utf-8" })
 
       @status  = status
@@ -180,7 +181,15 @@ class Cuba
       # are carried out by #consume.
       yield(*captures)
 
-      halt res.finish
+      if res.status.nil?
+        if res.body.empty?
+          res.status = 404
+        else
+          res.status = 200
+        end
+      end
+
+      halt(res.finish)
     end
   end
 

data/lib/cuba/render.rb

@@ -12,49 +12,51 @@ class Cuba
       }
     end
 
-    def view(template, locals = {}, layout = settings[:render][:layout])
-      partial(layout, { content: partial(template, locals) }.merge(locals))
+    def render(template, locals = {}, layout = settings[:render][:layout])
+      res.write(view(template, locals, layout))
     end
 
-    def template_path(template)
-      "%s/%s.%s" % [
-        settings[:render][:views],
-        template,
-        settings[:render][:template_engine]
-      ]
+    def view(template, locals = {}, layout = settings[:render][:layout])
+      partial(layout, locals.merge(content: partial(template, locals)))
     end
 
     def partial(template, locals = {})
-      render(template_path(template), locals, settings[:render][:options])
+      _render(template_path(template), locals, settings[:render][:options])
+    end
+
+    def template_path(template)
+      dir = settings[:render][:views]
+      ext = settings[:render][:template_engine]
+
+      return File.join(dir, "#{ template }.#{ ext }")
     end
 
-    # Render any type of template file supported by Tilt.
+    # @private Renders any type of template file supported by Tilt.
     #
     # @example
     #
     #   # Renders home, and is assumed to be HAML.
-    #   render("home.haml")
+    #   _render("home.haml")
     #
     #   # Renders with some local variables
-    #   render("home.haml", site_name: "My Site")
+    #   _render("home.haml", site_name: "My Site")
     #
     #   # Renders with HAML options
-    #   render("home.haml", {}, ugly: true, format: :html5)
+    #   _render("home.haml", {}, ugly: true, format: :html5)
     #
     #   # Renders in layout
-    #   render("layout.haml") { render("home.haml") }
+    #   _render("layout.haml") { _render("home.haml") }
     #
-    def render(template, locals = {}, options = {}, &block)
+    def _render(template, locals = {}, options = {}, &block)
       _cache.fetch(template) {
         Tilt.new(template, 1, options.merge(outvar: '@_output'))
       }.render(self, locals, &block)
     end
 
-    # @private Used internally by #render to cache the
+    # @private Used internally by #_render to cache the
     #          Tilt templates.
     def _cache
       Thread.current[:_cache] ||= Tilt::Cache.new
     end
-    private :_cache
   end
 end

data/makefile

@@ -0,0 +1,4 @@
+.PHONY: test
+
+test:
+	cutest ./test/*.rb

data/test/integration.rb

@@ -77,7 +77,7 @@ test "reset and use" do
 
   status, headers, resp = Cuba.call(env)
 
-  assert 200 == status
+  assert_equal 200, status
   assert "text/html; charset=utf-8" == headers["Content-Type"]
   assert_response resp, ["2nd Default"]
 

data/test/on.rb

@@ -95,3 +95,63 @@ test "reverts a half-met matcher" do
   assert_equal "/post", env["PATH_INFO"]
   assert_equal "/", env["SCRIPT_NAME"]
 end
+
+test "responds 404 if conditions are not met" do
+  Cuba.define do
+    on root do
+      res.write("Should be unmet")
+    end
+  end
+
+  env = { "PATH_INFO" => "/notexists", "SCRIPT_NAME" => "/" }
+  status, _, body = Cuba.call(env)
+
+  assert_equal 404, status
+  assert body.empty?
+end
+
+test "responds 404 if nested conditions are not met" do
+  Cuba.define do
+    on get do
+      on root do
+        res.write("Should be unmet")
+      end
+    end
+
+    on default do
+      res.write("Should be unmet")
+    end
+  end
+
+  env = {
+    "REQUEST_METHOD" => "GET",
+    "PATH_INFO" => "/notexists",
+    "SCRIPT_NAME" => "/"
+  }
+
+  status, _, body = Cuba.call(env)
+
+  assert_equal 404, status
+  assert body.empty?
+end
+
+test "responds 200 even with an empty body if status is set" do
+  Cuba.define do
+    on get do
+      on root do
+        res.status = 200
+      end
+    end
+  end
+
+  env = {
+    "REQUEST_METHOD" => "GET",
+    "PATH_INFO" => "/",
+    "SCRIPT_NAME" => "/"
+  }
+
+  status, _, body = Cuba.call(env)
+
+  assert_equal 200, status
+  assert body.empty?
+end

data/test/render.rb

@@ -28,6 +28,10 @@ scope do
       on "about" do
         res.write partial("about", title: "About Cuba")
       end
+
+      on "render" do
+        render("about", title: "About Cuba")
+      end
     end
   end
 
@@ -43,6 +47,12 @@ scope do
     assert_response body, ["<title>Cuba: Home</title>\n<h1>Home</h1>\n<p>Hello Agent Smith</p>\n"]
   end
 
+  test "render" do
+    _, _, body = Cuba.call({ "PATH_INFO" => "/render", "SCRIPT_NAME" => "/" })
+
+    assert_response body, ["<title>Cuba: About Cuba</title>\n<h1>About Cuba</h1>\n"]
+  end
+
   test "partial with str as engine" do
     Cuba.settings[:render][:template_engine] = "str"
 
@@ -87,22 +97,6 @@ test "caching behavior" do
   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_response resp, ["Header\nThis is the actual content.\nFooter\n"]
-end
-
 test "overrides layout" do
   Cuba.plugin Cuba::Render
   Cuba.settings[:render][:views] = "./test/views"

data/test/views/about.erb

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

data/test/views/about.str

@@ -0,0 +1 @@
+<h1>#{title}</h1>

data/test/views/content-yield.erb

@@ -0,0 +1 @@
+This is the actual content.

data/test/views/custom/abs_path.mote

@@ -0,0 +1 @@
+<h1>Abs Path</h1>

data/test/views/frag.mote

@@ -0,0 +1 @@
+<h1>{{ foo }}</h1>

data/test/views/home.erb

@@ -0,0 +1,2 @@
+<h1>Home</h1>
+<p>Hello <%= name %></p>

data/test/views/home.mote

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

data/test/views/home.str

@@ -0,0 +1,2 @@
+<h1>Home</h1>
+<p>Hello #{name}</p>

data/test/views/layout-alternative.erb

@@ -0,0 +1,2 @@
+<title>Alternative Layout: <%= title %></title>
+<%= content %>

data/test/views/layout-yield.erb

@@ -0,0 +1,3 @@
+Header
+<%= yield %>
+Footer

data/test/views/layout.erb

@@ -0,0 +1,2 @@
+<title>Cuba: <%= title %></title>
+<%= content %>

data/test/views/layout.mote

@@ -0,0 +1,2 @@
+<title>{{title}}</title>
+{{ content }}

data/test/views/layout.str

@@ -0,0 +1,2 @@
+<title>Cuba: #{ title }</title>
+#{ content }

data/test/views/test.erb

@@ -0,0 +1 @@
+Displaying {{ i }}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuba
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Michel Martens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-09 00:00:00.000000000 Z
+date: 2014-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -73,15 +73,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
+- .gems
+- .gitignore
 - CHANGELOG
+- LICENSE
 - README.md
-- Rakefile
+- cuba.gemspec
+- examples/config.ru
+- examples/measure.rb
+- examples/rack-response.ru
+- examples/views/home.mote
+- examples/views/layout.mote
+- lib/cuba.rb
 - lib/cuba/capybara.rb
 - lib/cuba/render.rb
 - lib/cuba/test.rb
-- lib/cuba.rb
-- cuba.gemspec
+- makefile
 - test/accept.rb
 - test/captures.rb
 - test/composition.rb
@@ -105,8 +112,23 @@ files:
 - test/segment.rb
 - test/session.rb
 - test/settings.rb
-homepage: http://github.com/soveran/cuba
-licenses: []
+- test/views/about.erb
+- test/views/about.str
+- test/views/content-yield.erb
+- test/views/custom/abs_path.mote
+- test/views/frag.mote
+- test/views/home.erb
+- test/views/home.mote
+- test/views/home.str
+- test/views/layout-alternative.erb
+- test/views/layout-yield.erb
+- test/views/layout.erb
+- test/views/layout.mote
+- test/views/layout.str
+- test/views/test.erb
+homepage: https://github.com/soveran/cuba
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []

data/Rakefile

@@ -1,7 +0,0 @@
-task :test do
-  require "cutest"
-
-  Cutest.run(Dir["test/*.rb"])
-end
-
-task :default => :test