cuba 3.1.0 → 3.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b881a2c6bb3396ac4515bea4b2a9745933f071b2
+  data.tar.gz: dad770ec883f93c34cd0f0bb55a0fb5f8a782096
+SHA512:
+  metadata.gz: 16ff53505523c87084f283005ad9819e06d87676d08663ebe430c15924beb7265a55c88328a7b71dd04fb3c13af5035b590e620319c3752b8da7515aa054d9d4
+  data.tar.gz: 5e1ef15fa6595a48050e3fbdf1fbd71cba9615a509631a5724445bb20bd37e6f5b1b9eb40d8295c0474c8e533a22f3bf14387a7443e4440133fbe97a917beaf1

data/CHANGELOG

@@ -1,3 +1,7 @@
+3.1.1
+
+* Add support for custom default layouts.
+
 3.1.0
 
 * Do a deep clone of the settings object during inheritance.

data/README.md

@@ -8,13 +8,17 @@ _n_. a microframework for web development.
 Community
 ---------
 
-Meet us on IRC: [#cuba.rb](irc://chat.freenode.net/#cuba.rb) on [freenode.net](http://freenode.net/)
+Meet us on IRC: [#cuba.rb][irc] on [freenode.net][freenode].
+
+[irc]: irc://chat.freenode.net/#cuba.rb
+[freenode]: http://freenode.net/
 
 Description
 -----------
 
-Cuba is a microframework for web development originally inspired by [Rum][rum],
-a tiny but powerful mapper for [Rack][rack] applications.
+Cuba is a microframework for web development originally inspired
+by [Rum][rum], a tiny but powerful mapper for [Rack][rack]
+applications.
 
 It integrates many templates via [Tilt][tilt], and testing via
 [Cutest][cutest] and [Capybara][capybara].
@@ -24,6 +28,14 @@ It integrates many templates via [Tilt][tilt], and testing via
 [tilt]: http://github.com/rtomayko/tilt
 [cutest]: http://github.com/djanowski/cutest
 [capybara]: http://github.com/jnicklas/capybara
+[rack-test]: https://github.com/brynary/rack-test
+
+Installation
+------------
+
+``` console
+$ gem install cuba
+```
 
 Usage
 -----
@@ -33,8 +45,10 @@ Here's a simple application:
 ``` ruby
 # cat hello_world.rb
 require "cuba"
+require "rack/protection"
 
-Cuba.use Rack::Session::Cookie
+Cuba.use Rack::Session::Cookie, :secret => "__a_very_long_string__"
+Cuba.use Rack::Protection
 
 Cuba.define do
   on get do
@@ -47,14 +61,22 @@ Cuba.define do
     end
   end
 end
+```
+
+And the test file:
 
+``` ruby
 # cat hello_world_test.rb
 require "cuba/test"
+require "./hello_world"
 
 scope do
   test "Homepage" do
-    visit "/"
-    assert has_content?("Hello world!")
+    get "/"
+
+    follow_redirect!
+
+    assert_equal "Hello world!", last_response.body
   end
 end
 ```
@@ -77,8 +99,10 @@ Here's an example showcasing how different matchers work:
 
 ``` ruby
 require "cuba"
+require "rack/protection"
 
-Cuba.use Rack::Session::Cookie
+Cuba.use Rack::Session::Cookie, :secret => "__a_very_long_string__"
+Cuba.use Rack::Protection
 
 Cuba.define do
 
@@ -148,23 +172,194 @@ Cuba.define do
 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"
+```
+
+Another way is to add a default block:
+
+``` ruby
+Cuba.define do
+  on get 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, ""
+```
+
+As Cuba encourages the composition of applications, this last
+example is a very common pattern.
+
+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:
+
+``` ruby
+Cuba.define do
+  res.status = 404
+
+  on get do
+    on "hello" do
+      res.status = 200
+      res.write "hello world"
+    end
+  end
+end
+
+# Requests:
+#
+# GET /            # 404, ""
+# GET /hello       # 200, "hello world"
+# GET /hello/world # 200, "hello world"
+```
+
+If you really want to return 404 for everything under "hello", you
+can 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
+end
+
+# Requests:
+#
+# GET /            # 404, ""
+# GET /hello       # 200, "hello world"
+# GET /hello/world # 404, ""
+```
+
+This last example is not a common usage pattern. It's here only to
+illustrate how Cuba can be adapted for different use cases.
+
+If you need this behavior, you can create a helper:
+
+``` ruby
+module TerminalMatcher
+  def terminal(path)
+    /#{path}\/?\z/
+  end
+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
+end
+```
+
 Security
 --------
 
 The favorite security layer for Cuba is
-[Rack::Protection](https://github.com/rkh/rack-protection). It is not
-included by default because there are legitimate uses for plain Cuba
-(for instance, when designing an API).
+[Rack::Protection][rack-protection]. It is not included by default
+because there are legitimate uses for plain Cuba (for instance,
+when designing an API).
 
-If you are building a web application, by all means make sure to
-include a security layer. As it is the convention for unsafe
+If you are building a web application, by all means make sure
+to include a security layer. As it is the convention for unsafe
 operations, only POST, PUT and DELETE requests are monitored.
 
+You should also always set a session secret to some undisclosed
+value. Keep in mind that the content in the session cookie is
+*not* encrypted.
+
+[rack-protection]: https://github.com/rkh/rack-protection
+
 ``` ruby
 require "cuba"
 require "rack/protection"
 
-Cuba.use Rack::Session::Cookie
+Cuba.use Rack::Session::Cookie, :secret => "__a_very_long_string__"
 Cuba.use Rack::Protection
 Cuba.use Rack::Protection::RemoteReferrer
 
@@ -210,7 +405,7 @@ instances of [Rack::Request][request] and `Cuba::Response` respectively, and
 [response]: http://rack.rubyforge.org/doc/classes/Rack/Response.html
 
 Those objects are helpers for accessing the request and for building
-the response. Most of the time, you will just use `req.write`.
+the response. Most of the time, you will just use `res.write`.
 
 If you want to use custom `Request` or `Response` objects, you can
 set the new values as follows:
@@ -276,15 +471,32 @@ end
 Testing
 -------
 
-Given that Cuba is essentially Rack, it is very easy to test with `Webrat` or
-`Capybara`. Cuba's own tests are written with a combination of [Cutest][cutest]
-and [Capybara][capybara], and if you want to use the same for your tests it is
-as easy as requiring `cuba/test`:
+Given that Cuba is essentially Rack, it is very easy to test with
+`Rack::Test`, `Webrat` or `Capybara`. Cuba's own tests are written
+with a combination of [Cutest][cutest] and [Rack::Test][rack-test],
+and if you want to use the same for your tests it is as easy as
+requiring `cuba/test`:
 
 ``` ruby
 require "cuba/test"
 require "your/app"
 
+scope do
+  test "Homepage" do
+    get "/"
+
+    assert_equal "Hello world!", last_response.body
+  end
+end
+```
+
+If you prefer to use [Capybara][capybara], instead of requiring
+`cuba/test` you can require `cuba/capybara`:
+
+``` ruby
+require "cuba/capybara"
+require "your/app"
+
 scope do
   test "Homepage" do
     visit "/"
@@ -294,8 +506,8 @@ scope do
 end
 ```
 
-To read more about testing, check the documentation for [Cutest][cutest] and
-[Capybara][capybara].
+To read more about testing, check the documentation for
+[Cutest][cutest], [Rack::Test][rack-test] and [Capybara][capybara].
 
 Settings
 --------
@@ -341,6 +553,26 @@ 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.
 
+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"
+
+Cuba.plugin Cuba::Render
+Cuba.settings[:render][:template_engine] = "slim"
+
+Cuba.define do
+  on default do
+
+    # 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
+```
+
 Plugins
 -------
 
@@ -364,7 +596,7 @@ 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
+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
@@ -406,10 +638,3 @@ Cuba.set(:foo, "bar")
 assert_equal "bar", Cuba.get(:foo)
 assert_equal "bar", Cuba.settings[:foo]
 ```
-
-Installation
-------------
-
-``` ruby
-$ gem install cuba
-```

data/cuba.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = "cuba"
-  s.version           = "3.1.0"
+  s.version           = "3.1.1"
   s.summary           = "Microframework for web applications."
   s.description       = "Cuba is a microframework for web applications."
   s.authors           = ["Michel Martens"]

data/lib/cuba.rb

@@ -147,7 +147,7 @@ class Cuba
   #   end
   #
   #   on get, "signup" do
-  #     res.write "Signup
+  #     res.write "Signup"
   #   end
   #
   #   on "user/:id" do |uid|
@@ -197,7 +197,7 @@ class Cuba
   private :try
 
   def consume(pattern)
-    matchdata = env["PATH_INFO"].match(/\A\/(#{pattern})((?:\/|\z))/)
+    matchdata = env["PATH_INFO"].match(/\A\/(#{pattern})(\/|\z)/)
 
     return false unless matchdata
 

data/lib/cuba/render.rb

@@ -5,13 +5,14 @@ class Cuba
     def self.setup(app)
       app.settings[:render] ||= {}
       app.settings[:render][:template_engine] ||= "erb"
+      app.settings[:render][:layout] ||= "layout"
       app.settings[:render][:views] ||= File.expand_path("views", Dir.pwd)
       app.settings[:render][:options] ||= {
         default_encoding: Encoding.default_external
       }
     end
 
-    def view(template, locals = {}, layout = "layout")
+    def view(template, locals = {}, layout = settings[:render][:layout])
       partial(layout, { content: partial(template, locals) }.merge(locals))
     end
 

data/test/cookie.rb

@@ -29,6 +29,6 @@ test "delete cookie" do
 
    _, headers, body = Cuba.call(env)
 
-   assert_equal "foo=; expires=Thu, 01-Jan-1970 00:00:00 GMT",
+   assert_equal "foo=; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 -0000",
      headers["Set-Cookie"]
 end

data/test/render.rb

@@ -58,6 +58,14 @@ scope do
 
     assert_response body, ["<title>Cuba: Home</title>\n<h1>Home</h1>\n<p>Hello Agent Smith</p>\n\n"]
   end
+
+  test "custom default layout support" do
+    Cuba.settings[:render][:layout] = "layout-alternative"
+
+    _, _, body = Cuba.call({ "PATH_INFO" => "/home", "SCRIPT_NAME" => "/" })
+
+    assert_response body, ["<title>Alternative Layout: Home</title>\n<h1>Home</h1>\n<p>Hello Agent Smith</p>\n"]
+  end
 end
 
 test "caching behavior" do
@@ -94,3 +102,18 @@ test "simple layout support" do
 
   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"
+
+  Cuba.define do
+    on true do
+      res.write view("home", { name: "Agent Smith", title: "Home" }, "layout-alternative")
+    end
+  end
+
+  _, _, body = Cuba.call({})
+
+  assert_response body, ["<title>Alternative Layout: Home</title>\n<h1>Home</h1>\n<p>Hello Agent Smith</p>\n"]
+end

metadata

@@ -1,60 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: cuba
 version: !ruby/object:Gem::Version
-  version: 3.1.0
-  prerelease: 
+  version: 3.1.1
 platform: ruby
 authors:
 - Michel Martens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-24 00:00:00.000000000 Z
+date: 2014-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2152188260 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152188260
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cutest
-  requirement: &2152187440 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152187440
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &2152186360 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152186360
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &2152185380 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152185380
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Cuba is a microframework for web applications.
 email:
 - michel@soveran.com
@@ -96,26 +107,25 @@ files:
 - test/settings.rb
 homepage: http://github.com/soveran/cuba
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Microframework for web applications.
 test_files: []