cuba 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33341fdef71be26c9506be1f85b0d223721baaf3
-  data.tar.gz: f78025b8496068b945a4095a51115dbb9d939c08
+  metadata.gz: 8dbfe63b93f0fad52b2a691726c05a656630bc59
+  data.tar.gz: 6d390f4273a38f8e2f88c927909a9eed36b6b29d
 SHA512:
-  metadata.gz: 933e16d3505eca916f1d86fbb36aaf2b58fc87256272b326d0ca52afcbd3dbc699e19bae18a4f5191d05194c53b12b882983e64240ab493691445613db2c327f
-  data.tar.gz: fa31afdad6c4f18337c88f5a4fd896f6585d972c53a92ca2e469bbe8eafcbe53927246e99fa46e09ce0d51a28d36628aa702cabb74d98215b3e6bec06e6157e9
+  metadata.gz: f85d1c11cd06092a300765ec9a86fd8572aa768505f788d4675f57ecaddf8e7d3b925e58ef316bd6abe10eda5b071b4e8836fc03ada14c165bbe70b9e0f6ce95
+  data.tar.gz: 1af18ce865a90bb8fba27d8d160d7cabb8f53e687c5d12d8a109b8518513a0bebdadff8f70474fa4095bfb02d37a865a3ba6c14fcbf4bbdddddb3ba102c1df53

data/CHANGELOG

@@ -1,3 +1,14 @@
+3.5.0
+
+* Add `not_found` hook for customizing the 404 error.
+
+* Remove undocumented `header` matcher.
+
+* Depend explicitly on Rack 1.6.x.
+
+* Experimental feature: `param` now accepts a second parameter
+  with a default value.
+
 3.4.0
 
 * Add `Cuba::Safe` plugin. This plugin contains security related

data/CONTRIBUTING

@@ -0,0 +1,19 @@
+This code tries to solve a particular problem with a very simple
+implementation. We try to keep the code to a minimum while making
+it as clear as possible. The design is very likely finished, and
+if some feature is missing it is possible that it was left out on
+purpose. That said, new usage patterns may arise, and when that
+happens we are ready to adapt if necessary.
+
+A good first step for contributing is to meet us on IRC and discuss
+ideas. We spend a lot of time on #lesscode at freenode, always ready
+to talk about code and simplicity. If connecting to IRC is not an
+option, you can create an issue explaining 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. Usually the result of a
+conversation is the creation of a different tool.
+
+Please don't start the conversation with a pull request. The code
+should come at last, and even though it may help to convey an idea,
+more often than not it draws the attention to a particular
+implementation.

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2008-2009 Christian Neukirchen
+Copyright (c) 2008-2009 Christian Neukirchen
 Copyright (c) 2010-2015 Michel Martens
 Copyright (c) 2010-2015 Damian Janowski
 Copyright (c) 2010-2015 Cyril David

data/README.md

@@ -24,7 +24,7 @@ It integrates many templates via [Tilt][tilt], and testing via
 [Cutest][cutest] and [Capybara][capybara].
 
 [rum]: http://github.com/chneukirchen/rum
-[rack]: http://github.com/chneukirchen/rack
+[rack]: http://github.com/rack/rack
 [tilt]: http://github.com/rtomayko/tilt
 [cutest]: http://github.com/djanowski/cutest
 [capybara]: http://github.com/jnicklas/capybara
@@ -55,10 +55,11 @@ Here's a simple application:
 ``` ruby
 # cat hello_world.rb
 require "cuba"
-require "rack/protection"
+require "cuba/safe"
 
 Cuba.use Rack::Session::Cookie, :secret => "__a_very_long_string__"
-Cuba.use Rack::Protection
+
+Cuba.plugin Cuba::Safe
 
 Cuba.define do
   on get do
@@ -109,10 +110,11 @@ Here's an example showcasing how different matchers work:
 
 ``` ruby
 require "cuba"
-require "rack/protection"
+require "cuba/safe"
 
 Cuba.use Rack::Session::Cookie, :secret => "__a_very_long_string__"
-Cuba.use Rack::Protection
+
+Cuba.plugin Cuba::Safe
 
 Cuba.define do
 
@@ -186,7 +188,9 @@ Status codes
 ------------
 
 If you don't assign a status code and you don't write to the `res`
-object, the status will be set as `404`.
+object, the status will be set as `404`. The method `not_found` is
+in charge of setting the proper status code, and you can redefine
+it if you want to render a template or configure custom headers.
 
 For example:
 
@@ -289,7 +293,9 @@ when designing an API).
 Here's how to include it:
 
 ```ruby
-Cuba.plugin(Cuba::Safe)
+require "cuba/safe"
+
+Cuba.plugin Cuba::Safe
 ```
 
 You should also always set a session secret to some undisclosed
@@ -304,6 +310,7 @@ In the end, your application should look like this:
 
 ```ruby
 require "cuba"
+require "cuba/safe"
 
 Cuba.use Rack::Session::Cookie, :secret => "__a_very_long_string__"
 
@@ -349,7 +356,12 @@ following methods:
 Here's an example of how to use it:
 
 ```ruby
-Cuba.plugin(Cuba::Safe)
+require "cuba"
+require "cuba/safe"
+
+Cuba.use Rack::Session::Cookie, :secret => "__a_very_long_string__"
+
+Cuba.plugin Cuba::Safe
 
 Cuba.define do
   on csrf.unsafe? do
@@ -374,13 +386,13 @@ among your meta tags. Here's an example that assumes you are using
 <!DOCTYPE html>
 <html>
   <head>
-    {{ this.csrf.meta_tag }}
+    {{ app.csrf.meta_tag }}
     ...
   </head>
   ...
   <body>
     <form action="/foo" method="POST">
-      {{ this.csrf.form_tag }}
+      {{ app.csrf.form_tag }}
       ...
     </form>
   ...
@@ -419,8 +431,8 @@ instances of [Rack::Request][request] and `Cuba::Response` respectively, and
 `Cuba::Response` is just an optimized version of
 [Rack::Response][response].
 
-[request]: http://rack.rubyforge.org/doc/classes/Rack/Request.html
-[response]: http://rack.rubyforge.org/doc/classes/Rack/Response.html
+[request]: http://www.rubydoc.info/github/rack/rack/Rack/Request
+[response]: http://www.rubydoc.info/github/rack/rack/Rack/Response
 
 Those objects are helpers for accessing the request and for building
 the response. Most of the time, you will just use `res.write`.
@@ -486,6 +498,29 @@ Cuba.define do
 end
 ```
 
+If you need to pass information to one sub-app, you can use the
+`with` method and access it with `vars`:
+
+```ruby
+class Platforms < Cuba
+  define do
+    platform = vars[:platform]
+
+    on default do
+      res.write(platform) # => "heroku" or "salesforce"
+    end
+  end
+end
+
+Cuba.define do
+  on "(heroku|salesforce)" do |platform|
+    with(platform: platform) do
+      run(Platforms)
+    end
+  end
+end
+```
+
 Testing
 -------
 
@@ -562,7 +597,7 @@ require "cuba"
 require "cuba/render"
 require "erb"
 
-Cuba.plugin(Cuba::Render)
+Cuba.plugin Cuba::Render
 ```
 
 This example uses ERB, a template engine that comes with Ruby. If you want to

data/cuba.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = "cuba"
-  s.version           = "3.4.0"
+  s.version           = "3.5.0"
   s.summary           = "Microframework for web applications."
   s.description       = "Cuba is a microframework for web applications."
   s.authors           = ["Michel Martens"]
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
 
   s.files = `git ls-files`.split("\n")
 
-  s.add_dependency "rack"
+  s.add_dependency "rack", "~> 1.6.0"
   s.add_development_dependency "cutest"
   s.add_development_dependency "rack-test"
   s.add_development_dependency "tilt"

data/lib/cuba.rb

@@ -2,7 +2,14 @@ require "rack"
 require "time"
 
 class Cuba
+  SLASH   = "/".freeze
+  EMPTY   = "".freeze
+  SEGMENT = "([^\\/]+)".freeze
+  DEFAULT = "text/html; charset=utf-8".freeze
+
   class Response
+    LOCATION = "Location".freeze
+
     attr_accessor :status
 
     attr :body
@@ -27,12 +34,12 @@ class Cuba
       s = str.to_s
 
       @length += s.bytesize
-      @headers["Content-Length"] = @length.to_s
+      @headers[Rack::CONTENT_LENGTH] = @length.to_s
       @body << s
     end
 
     def redirect(path, status = 302)
-      @headers["Location"] = path
+      @headers[LOCATION] = path
       @status  = status
     end
 
@@ -126,7 +133,7 @@ class Cuba
     catch(:halt) do
       instance_eval(&@blk)
 
-      res.status = 404
+      not_found
       res.finish
     end
   end
@@ -181,9 +188,9 @@ class Cuba
 
       if res.status.nil?
         if res.body.empty?
-          res.status = 404
+          not_found
         else
-          res.headers["Content-Type"] ||= "text/html; charset=utf-8"
+          res.headers[Rack::CONTENT_TYPE] ||= DEFAULT
           res.status = 200
         end
       end
@@ -195,30 +202,30 @@ class Cuba
   # @private Used internally by #on to ensure that SCRIPT_NAME and
   #          PATH_INFO are reset to their proper values.
   def try
-    script, path = env["SCRIPT_NAME"], env["PATH_INFO"]
+    script, path = env[Rack::SCRIPT_NAME], env[Rack::PATH_INFO]
 
     yield
 
   ensure
-    env["SCRIPT_NAME"], env["PATH_INFO"] = script, path
+    env[Rack::SCRIPT_NAME], env[Rack::PATH_INFO] = script, path
   end
   private :try
 
   def consume(pattern)
-    matchdata = env["PATH_INFO"].match(/\A\/(#{pattern})(\/|\z)/)
+    matchdata = env[Rack::PATH_INFO].match(/\A\/(#{pattern})(\/|\z)/)
 
     return false unless matchdata
 
     path, *vars = matchdata.captures
 
-    env["SCRIPT_NAME"] += "/#{path}"
-    env["PATH_INFO"] = "#{vars.pop}#{matchdata.post_match}"
+    env[Rack::SCRIPT_NAME] += "/#{path}"
+    env[Rack::PATH_INFO] = "#{vars.pop}#{matchdata.post_match}"
 
     captures.push(*vars)
   end
   private :consume
 
-  def match(matcher, segment = "([^\\/]+)")
+  def match(matcher, segment = SEGMENT)
     case matcher
     when String then consume(matcher.gsub(/:\w+/, segment))
     when Regexp then consume(matcher)
@@ -240,20 +247,24 @@ class Cuba
     lambda { consume("([^\\/]+?)\.#{ext}\\z") }
   end
 
-  # Used to ensure that certain request parameters are present. Acts like a
-  # precondition / assertion for your route.
+  # Ensures that certain request parameters are present. Acts like a
+  # precondition / assertion for your route. A default value can be
+  # provided as a second argument. In that case, it always matches
+  # and the result is either the parameter or the default value.
   #
   # @example
   #   # POST with data like user[fname]=John&user[lname]=Doe
   #   on "signup", param("user") do |atts|
   #     User.create(atts)
   #   end
-  def param(key)
-    lambda { captures << req[key] unless req[key].to_s.empty? }
-  end
+  #
+  #   on "login", param("username", "guest") do |username|
+  #     # If not provided, username == "guest"
+  #   end
+  def param(key, default = nil)
+    value = req[key] || default
 
-  def header(key)
-    lambda { env[key.upcase.tr("-","_")] }
+    lambda { captures << value unless value.to_s.empty? }
   end
 
   # Useful for matching against the request host (i.e. HTTP_HOST).
@@ -279,7 +290,7 @@ class Cuba
       accept = String(env["HTTP_ACCEPT"]).split(",")
 
       if accept.any? { |s| s.strip == mimetype }
-        res["Content-Type"] = mimetype
+        res[Rack::CONTENT_TYPE] = mimetype
       end
     end
   end
@@ -303,7 +314,7 @@ class Cuba
   #     res.write "Home"
   #   end
   def root
-    env["PATH_INFO"] == "/" || env["PATH_INFO"] == ""
+    env[Rack::PATH_INFO] == SLASH || env[Rack::PATH_INFO] == EMPTY
   end
 
   # Syntatic sugar for providing HTTP Verb matching.
@@ -382,6 +393,10 @@ class Cuba
   def vars
     env["cuba.vars"] ||= {}
   end
+
+  def not_found
+    res.status = 404
+  end
 end
 
 Cuba.settings[:req] = Rack::Request

data/test/composition.rb

@@ -19,3 +19,51 @@ test "composing on top of a PATH" do
 
    assert_response resp, ["View 101"]
 end
+
+test "redefining not_found" do
+  class Users < Cuba
+    def not_found
+      res.status = 404
+      res.write "Not found!"
+    end
+
+    define do
+      on root do
+        res.write "Users"
+      end
+    end
+  end
+
+  class Cuba
+    def not_found
+      res.status = 404
+      res.write "Error 404"
+    end
+  end
+
+  Cuba.define do
+    on "users" do
+      run Users
+    end
+  end
+
+  env = { "SCRIPT_NAME" => "/", "PATH_INFO" => "/users" }
+
+  _, _, resp = Cuba.call(env)
+
+  assert_response resp, ["Users"]
+
+  env = { "SCRIPT_NAME" => "/", "PATH_INFO" => "/users/42" }
+
+  status, _, resp = Cuba.call(env)
+
+  assert_response resp, ["Not found!"]
+  assert_equal status,  404
+
+  env = { "SCRIPT_NAME" => "/", "PATH_INFO" => "/guests" }
+
+  status, _, resp = Cuba.call(env)
+
+  assert_response resp, ["Error 404"]
+  assert_equal status,  404
+end

data/test/helper.rb

@@ -4,8 +4,7 @@ require "cuba"
 prepare { Cuba.reset! }
 
 def assert_response(body, expected)
-  arr = []
-  body.each { |line| arr << line }
+  arr = body.map { |line| line.strip }
 
   flunk "#{arr.inspect} != #{expected.inspect}" unless arr == expected
   print "."

data/test/param.rb

@@ -7,6 +7,10 @@ prepare do
       res.write email
     end
 
+    on get, "login", param("username", "guest") do |username|
+      res.write username
+    end
+
     on default do
       res.write "No email"
     end
@@ -42,3 +46,21 @@ test "doesn't yield an empty param" do
 
   assert_response resp, ["No email"]
 end
+
+test "yields a default param" do
+  env = { "REQUEST_METHOD" => "GET", "PATH_INFO" => "/login",
+          "SCRIPT_NAME" => "/", "rack.input" => StringIO.new,
+          "QUERY_STRING" => "username=john" }
+
+  _, _, resp = Cuba.call(env)
+
+  assert_response resp, ["john"]
+
+  env = { "REQUEST_METHOD" => "GET", "PATH_INFO" => "/login",
+          "SCRIPT_NAME" => "/", "rack.input" => StringIO.new,
+          "QUERY_STRING" => "" }
+
+  _, _, resp = Cuba.call(env)
+
+  assert_response resp, ["guest"]
+end

data/test/render.rb

@@ -38,19 +38,19 @@ scope do
   test "partial" do
     _, _, body = Cuba.call({ "PATH_INFO" => "/about", "SCRIPT_NAME" => "/" })
 
-    assert_response body, ["<h1>About Cuba</h1>\n"]
+    assert_response body, ["<h1>About Cuba</h1>"]
   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"]
+    assert_response body, ["<title>Cuba: Home</title>\n<h1>Home</h1>\n<p>Hello Agent Smith</p>"]
   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"]
+    assert_response body, ["<title>Cuba: About Cuba</title>\n<h1>About Cuba</h1>"]
   end
 
   test "partial with str as engine" do
@@ -58,7 +58,7 @@ scope do
 
     _, _, body = Cuba.call({ "PATH_INFO" => "/about", "SCRIPT_NAME" => "/" })
 
-    assert_response body, ["<h1>About Cuba</h1>\n"]
+    assert_response body, ["<h1>About Cuba</h1>"]
   end
 
   test "view with str as engine" do
@@ -66,7 +66,7 @@ scope 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\n"]
+    assert_response body, ["<title>Cuba: Home</title>\n<h1>Home</h1>\n<p>Hello Agent Smith</p>"]
   end
 
   test "custom default layout support" do
@@ -74,7 +74,7 @@ scope do
 
     _, _, 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"]
+    assert_response body, ["<title>Alternative Layout: Home</title>\n<h1>Home</h1>\n<p>Hello Agent Smith</p>"]
   end
 end
 
@@ -109,7 +109,7 @@ test "overrides layout" do
 
   _, _, body = Cuba.call({})
 
-  assert_response body, ["<title>Alternative Layout: Home</title>\n<h1>Home</h1>\n<p>Hello Agent Smith</p>\n"]
+  assert_response body, ["<title>Alternative Layout: Home</title>\n<h1>Home</h1>\n<p>Hello Agent Smith</p>"]
 end
 
 test "ensures content-type header is set" do

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: cuba
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Michel Martens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-11 00:00:00.000000000 Z
+date: 2016-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: cutest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Cuba is a microframework for web applications.
@@ -73,9 +73,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gems
-- .gitignore
+- ".gems"
+- ".gitignore"
 - CHANGELOG
+- CONTRIBUTING
 - LICENSE
 - README.md
 - cuba.gemspec
@@ -142,17 +143,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Microframework for web applications.