cuba 1.0.0 → 2.0.0.rc1

data/README.markdown

@@ -1,14 +1,19 @@
 Cuba
 ====
 
-Rum based microframework for web development.
+_n_. a microframework for web development.
 
 ![Cuba and Rum, by Jan Sochor](http://farm3.static.flickr.com/2619/4032103097_8324c6fecf.jpg)
 
+Community
+---------
+
+Meet us on IRC: [#cuba.rb](irc://chat.freenode.net/#cuba.rb) on [freenode.net](http://freenode.net/)
+
 Description
 -----------
 
-Cuba is a microframework for web development heavily inspired by [Rum][rum],
+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
@@ -32,7 +37,7 @@ Here's a simple application:
 
     Cuba.define do
       on get do
-        on path("hello") do
+        on "hello" do
           res.write "Hello world!"
         end
 
@@ -68,28 +73,33 @@ Here's an example showcasing how different matchers work:
 
     Cuba.define do
 
+      # /
+      on "" do
+        res.write "Home"
+      end
+
       # /about
-      on path("about") do
+      on "about" do
         res.write "About"
       end
 
       # /styles/basic.css
-      on path("styles"), extension("css") do |file|
+      on "styles", extname("css") do |file|
         res.write "Filename: #{file}" #=> "Filename: basic"
       end
 
       # /post/2011/02/16/hello
-      on path("post"), number, number, number, segment do |y, m, d, slug|
+      on "post/:y/:m/:d/:slug" do |y, m, d, slug|
         res.write "#{y}-#{m}-#{d} #{slug}" #=> "2011-02-16 hello"
       end
 
       # /username/foobar
-      on path("username"), segment do |username|
+      on "username/:username" do |username|
 
         user = User.find_by_username(username) # username == "foobar"
 
         # /username/foobar/posts
-        on path("posts") do
+        on "posts" do
 
           # You can access `user` here, because the `on` blocks
           # are closures.
@@ -97,18 +107,18 @@ Here's an example showcasing how different matchers work:
         end
 
         # /username/foobar/following
-        on path("following") do
+        on "following" do
           res.write user.following.size #=> "1301"
         end
       end
 
       # /search?q=barbaz
-      on path("search"), param("q") do |query|
+      on "search", param("q") do |query|
         res.write "Searched for #{query}" #=> "Searched for barbaz"
       end
 
-      on post
-        on path("login")
+      on post do
+        on "login"
 
           # POST /login, user: foo, pass: baz
           on param("user"), param("pass") do |user, pass|
@@ -124,7 +134,6 @@ Here's an example showcasing how different matchers work:
       end
     end
 
-
 That's it, you can now run `rackup` and enjoy what you have just created.
 
 To read more about testing, check the documentation for [Cutest][cutest] and
@@ -133,4 +142,4 @@ To read more about testing, check the documentation for [Cutest][cutest] and
 Installation
 ------------
 
-    $ gem install cuba
+    $ gem install cuba

data/cuba.gemspec

@@ -1,14 +1,14 @@
 Gem::Specification.new do |s|
   s.name              = "cuba"
-  s.version           = "1.0.0"
+  s.version           = "2.0.0.rc1"
   s.summary           = "Rum based microframework for web applications."
   s.description       = "Cuba is a light wrapper for Rum, a microframework for Rack applications."
   s.authors           = ["Michel Martens"]
   s.email             = ["michel@soveran.com"]
   s.homepage          = "http://github.com/soveran/cuba"
-  s.files = ["LICENSE", "README.markdown", "Rakefile", "lib/cuba/ron.rb", "lib/cuba/test.rb", "lib/cuba/version.rb", "lib/cuba.rb", "cuba.gemspec", "test/accept.rb", "test/captures.rb", "test/extension.rb", "test/helper.rb", "test/integration.rb", "test/number.rb", "test/on.rb", "test/path.rb", "test/run.rb", "test/segment.rb"]
+  s.files = ["LICENSE", "README.markdown", "Rakefile", "lib/cuba/ron.rb", "lib/cuba/test.rb", "lib/cuba/version.rb", "lib/cuba.rb", "cuba.gemspec", "test/accept.rb", "test/captures.rb", "test/extname.rb", "test/helper.rb", "test/host.rb", "test/integration.rb", "test/match.rb", "test/number.rb", "test/on.rb", "test/path.rb", "test/run.rb", "test/segment.rb"]
   s.add_dependency "rack", "~> 1.2"
-  s.add_dependency "tilt", "~> 1.1"
-  s.add_development_dependency "cutest", "~> 0.1"
-  s.add_development_dependency "capybara", "~> 0.1"
+  s.add_dependency "tilt", "~> 1.2"
+  s.add_development_dependency "cutest", "~> 1.0"
+  s.add_development_dependency "capybara", "~> 0.4"
 end

data/lib/cuba/ron.rb

@@ -12,14 +12,6 @@ class Rack::Response
   end
 end
 
-# Based on Rum: http://github.com/chneukirchen/rum
-#
-# Summary of changes
-#
-# 1. Only relevant captures are yielded.
-# 2. The #extension matcher is used more like #path.
-# 3. Miscellaneous coding style changes.
-#
 module Cuba
   class Ron
     attr :env
@@ -42,7 +34,7 @@ module Cuba
       @res = Rack::Response.new
       @matched = false
 
-      catch(:rum_run_next_app) do
+      catch(:ron_run_next_app) do
         instance_eval(&@blk)
 
         @res.status = 404 unless @matched || !@res.empty?
@@ -90,15 +82,15 @@ module Cuba
     #     res.write "GET"
     #   end
     #
-    #   on get, path("signup") do
+    #   on get, "signup" do
     #     res.write "Signup
     #   end
     #
-    #   on path("user"), segment do |uid|
+    #   on "user/:id" do |uid|
     #     res.write "User: #{uid}"
     #   end
     #
-    #   on path("styles"), extension("css") do |file|
+    #   on "styles", extname("css") do |file|
     #     res.write render("styles/#{file}.sass")
     #   end
     #
@@ -120,14 +112,12 @@ module Cuba
         #    on true, false do
         #
         #    # PATH_INFO=/user
-        #    on true, path("signup")
-        args.each do |arg|
-          return unless arg == true || arg != false && arg.call
-        end
+        #    on true, "signup"
+        return unless args.all? { |arg| match(arg) }
 
         # The captures we yield here were generated and assembled
         # by evaluating each of the `arg`s above. Most of these
-        # are carried out by #path.
+        # are carried out by #consume.
         yield *captures
 
         # At this point, we've successfully matched with some corresponding
@@ -152,35 +142,6 @@ module Cuba
     end
     private :try
 
-    # Probably the most useful helper for writing matchers.
-    #
-    # @example
-    #   # matches PATH_INFO=/signup
-    #   on path("signup") do
-    #
-    #   # matches PATH_INFO=/user123
-    #   on path("user(\\d+)") do |uid|
-    #
-    #   # matches PATH_INFO=/user/1
-    #   on path("user"), path("(\\d+)") do |uid|
-    #
-    # In fact, the other matchers (#segment, #number, #extension)
-    # ride on this method.
-    def path(pattern)
-      lambda { consume(pattern) }
-    end
-
-    # @private Used by #path to adjust the `PATH_INFO` and `SCRIPT_NAME`.
-    #          This is done so that nesting of matchers would work.
-    #
-    # @example
-    #   # PATH_INFO=/doctors/account
-    #   on path("doctors") do
-    #     # PATH_INFO = /account
-    #     on path("account") do
-    #       res.write "Settings page"
-    #     end
-    #   end
     def consume(pattern)
       return unless match = env["PATH_INFO"].match(/\A\/(#{pattern})(?:\/|\z)/)
 
@@ -193,36 +154,26 @@ module Cuba
     end
     private :consume
 
-    # A matcher for numeric ids.
-    #
-    # @example
-    #   on path("user"), number do |uid|
-    #     res.write "User: #{uid}"
-    #   end
-    def number
-      path("(\\d+)")
-    end
-
-    # A matcher for anything without slashes. Useful for mapping to slugs.
-    #
-    # @example
-    #   on path("article"), segment do |slug|
-    #     Article.find_by_slug(slug)
-    #
-    #   end
-    def segment
-      path("([^\\/]+)")
+    def match(matcher, segment = "([\\.a-zA-Z0-9\\-]+)")
+      case matcher
+      when String then consume(matcher.gsub(/:\w+/, segment))
+      when Regexp then consume(matcher)
+      when Symbol then consume(segment)
+      when Proc   then matcher.call
+      else
+        matcher
+      end
     end
 
-    # A matcher for files with a certain extension.
+    # A matcher for files with a certain extname.
     #
     # @example
     #   # PATH_INFO=/style/app.css
-    #   on path("style"), extension("css") do |file|
+    #   on "style", extname("css") do |file|
     #     res.write file # writes app
     #   end
-    def extension(ext = "\\w+")
-      path("([^\\/]+?)\.#{ext}\\z")
+    def extname(ext = "\\w+")
+      lambda { consume("([^\\/]+?)\.#{ext}\\z") }
     end
 
     # Used to ensure that certain request parameters are present. Acts like a
@@ -230,7 +181,7 @@ module Cuba
     #
     # @example
     #   # POST with data like user[fname]=John&user[lname]=Doe
-    #   on path("signup"), param("user") do |atts|
+    #   on "signup", param("user") do |atts|
     #     User.create(atts)
     #   end
     def param(key, default = nil)
@@ -244,11 +195,11 @@ module Cuba
     # Useful for matching against the request host (i.e. HTTP_HOST).
     #
     # @example
-    #   on host("account1.example.com"), path("api") do
+    #   on host("account1.example.com"), "api" do
     #     res.write "You have reached the API of account1."
     #   end
     def host(hostname)
-      req.host == hostname
+      hostname === req.host
     end
 
     # If you want to match against the HTTP_ACCEPT value.
@@ -279,10 +230,10 @@ module Cuba
     # Syntatic sugar for providing HTTP Verb matching.
     #
     # @example
-    #   on get, path("signup") do
+    #   on get, "signup" do
     #   end
     #
-    #   on post, path("signup") do
+    #   on post, "signup" do
     #   end
     def get    ; req.get?    end
     def post   ; req.post?   end
@@ -297,13 +248,13 @@ module Cuba
     #     run Cuba::Ron.new { on(default) { res.redirect(*args) }}
     #   end
     #
-    #   on path("account") do
+    #   on "account" do
     #     redirect "/login" unless session["uid"]
     #
     #     res.write "Super secure account info."
     #   end
     def run(app)
-      throw :rum_run_next_app, app
+      throw :ron_run_next_app, app
     end
   end
 end

data/lib/cuba/version.rb

@@ -1,3 +1,3 @@
 module Cuba
-  VERSION = "1.0.0"
+  VERSION = "2.0.0.rc1"
 end

data/test/captures.rb

@@ -31,7 +31,7 @@ end
 
 test "doesn't yield the path" do
   Cuba.define do
-    on get, path("home") do |*args|
+    on get, "home" do |*args|
       res.write args.size
     end
   end
@@ -46,7 +46,7 @@ end
 
 test "yields the segment" do
   Cuba.define do
-    on get, path("user"), segment do |id|
+    on get, "user", :id do |id|
       res.write id
     end
   end
@@ -61,7 +61,7 @@ end
 
 test "yields a number" do
   Cuba.define do
-    on get, path("user"), number do |id|
+    on get, "user", :id do |id|
       res.write id
     end
   end
@@ -74,9 +74,9 @@ test "yields a number" do
   assert_equal ["101"], resp.body
 end
 
-test "yields an extension" do
+test "yields an extname" do
   Cuba.define do
-    on get, path("css"), extension("css") do |file|
+    on get, "css", extname("css") do |file|
       res.write file
     end
   end
@@ -91,7 +91,7 @@ end
 
 test "yields a param" do
   Cuba.define do
-    on get, path("signup"), param("email") do |email|
+    on get, "signup", param("email") do |email|
       res.write email
     end
   end
@@ -107,9 +107,9 @@ end
 
 test "yields a segment per nested block" do
   Cuba.define do
-    on segment do |one|
-      on segment do |two|
-        on segment do |three|
+    on :one do |one|
+      on :two do |two|
+        on :three do |three|
           res.write one
           res.write two
           res.write three
@@ -124,4 +124,19 @@ test "yields a segment per nested block" do
   _, _, resp = Cuba.call(env)
 
   assert_equal ["one", "two", "three"], resp.body
+end
+
+test "consumes a slash if needed" do
+  Cuba.define do
+    on get, "(.+\\.css)" do |file|
+      res.write file
+    end
+  end
+
+  env = { "REQUEST_METHOD" => "GET", "PATH_INFO" => "/foo/bar.css",
+          "SCRIPT_NAME" => "/" }
+
+  _, _, resp = Cuba.call(env)
+
+  assert_equal ["foo/bar.css"], resp.body
 end

data/test/{extension.rb → extname.rb}

@@ -2,8 +2,8 @@ require File.expand_path("helper", File.dirname(__FILE__))
 
 setup do
   Cuba.define do
-    on path("styles") do
-      on extension("css") do |file|
+    on "styles" do
+      on extname("css") do |file|
         res.write file
       end
     end
@@ -18,4 +18,4 @@ test "/styles/reset.css" do |env|
   _, _, resp = Cuba.call(env)
 
   assert_equal ["reset"], resp.body
-end
+end

data/test/host.rb

@@ -0,0 +1,29 @@
+require File.expand_path("helper", File.dirname(__FILE__))
+
+test "matches a host" do
+  Cuba.define do
+    on host("example.com") do
+      res.write "worked"
+    end
+  end
+
+  env = { "HTTP_HOST" => "example.com" }
+
+  _, _, resp = Cuba.call(env)
+
+  assert_equal ["worked"], resp.body
+end
+
+test "matches a host with a regexp" do
+  Cuba.define do
+    on host(/example/) do
+      res.write "worked"
+    end
+  end
+
+  env = { "HTTP_HOST" => "example.com" }
+
+  _, _, resp = Cuba.call(env)
+
+  assert_equal ["worked"], resp.body
+end

data/test/integration.rb

@@ -29,7 +29,7 @@ test "use passes in the arguments and block" do
 
   Cuba.define do
     on get do
-      on path("hello") do
+      on "hello" do
         "Default"
       end
     end
@@ -52,7 +52,7 @@ test "reset and use" do
 
   Cuba.define do
     on get do
-      on path("hello") do
+      on "hello" do
         res.write "Default"
       end
     end
@@ -66,7 +66,7 @@ test "reset and use" do
 
   Cuba.define do
     on get do
-      on path("hello") do
+      on "hello" do
         res.write "2nd Default"
       end
     end

data/test/match.rb

@@ -0,0 +1,86 @@
+require File.expand_path("helper", File.dirname(__FILE__))
+
+setup do
+  { "SCRIPT_NAME" => "/", "PATH_INFO" => "/posts/123" }
+end
+
+test "text-book example" do |env|
+  Cuba.define do
+    on "posts/:id" do |id|
+      res.write id
+    end
+  end
+
+  _, _, resp = Cuba.call(env)
+
+  assert_equal ["123"], resp.body
+end
+
+test "multi-param" do |env|
+  Cuba.define do
+    on "u/:uid/posts/:id" do |uid, id|
+      res.write uid
+      res.write id
+    end
+  end
+
+  env["PATH_INFO"] = "/u/jdoe/posts/123"
+
+  _, _, resp = Cuba.call(env)
+
+  assert_equal ["jdoe", "123"], resp.body
+end
+
+test "regex nesting" do |env|
+  Cuba.define do
+    on /u\/(\w+)/ do |uid|
+      res.write uid
+
+      on /posts\/(\d+)/ do |id|
+        res.write id
+      end
+    end
+  end
+
+  env["PATH_INFO"] = "/u/jdoe/posts/123"
+
+  _, _, resp = Cuba.call(env)
+
+  assert_equal ["jdoe", "123"], resp.body
+end
+
+test "regex nesting colon param style" do |env|
+  Cuba.define do
+    on /u:(\w+)/ do |uid|
+      res.write uid
+
+      on /posts:(\d+)/ do |id|
+        res.write id
+      end
+    end
+  end
+
+  env["PATH_INFO"] = "/u:jdoe/posts:123"
+
+  _, _, resp = Cuba.call(env)
+
+  assert_equal ["jdoe", "123"], resp.body
+end
+
+test "symbol matching" do |env|
+  Cuba.define do
+    on "user", :id do |uid|
+      res.write uid
+
+      on "posts", :pid do |id|
+        res.write id
+      end
+    end
+  end
+
+  env["PATH_INFO"] = "/user/jdoe/posts/123"
+
+  _, _, resp = Cuba.call(env)
+
+  assert_equal ["jdoe", "123"], resp.body
+end

data/test/number.rb

@@ -6,8 +6,8 @@ end
 
 test "paths and numbers" do |env|
   Cuba.define do
-    on path("about") do
-      on number, number do |one, two|
+    on "about" do
+      on :one, :two do |one, two|
         res.write one
         res.write two
       end
@@ -21,8 +21,8 @@ end
 
 test "paths and decimals" do |env|
   Cuba.define do
-    on path("about") do
-      on number do |one|
+    on "about" do
+      on /(\d+)/ do |one|
         res.write one
       end
     end
@@ -33,4 +33,4 @@ test "paths and decimals" do |env|
   _, _, resp = Cuba.call(env)
 
   assert_equal [], resp.body
-end
+end

data/test/on.rb

@@ -12,6 +12,18 @@ test "executes on true" do
   assert_equal ["+1"], resp.body
 end
 
+test "executes on non-false" do
+  Cuba.define do
+    on "123" do
+      res.write "+1"
+    end
+  end
+
+  _, _, resp = Cuba.call({ "PATH_INFO" => "/123", "SCRIPT_NAME" => "/" })
+
+  assert_equal ["+1"], resp.body
+end
+
 test "restores SCRIPT_NAME and PATH_INFO" do
   Cuba.define do
     on true do

data/test/path.rb

@@ -6,7 +6,7 @@ end
 
 test "one level path" do |env|
   Cuba.define do
-    on path("about") do
+    on "about" do
       res.write "About"
     end
   end
@@ -19,12 +19,12 @@ end
 
 test "two level nested paths" do |env|
   Cuba.define do
-    on path("about") do
-      on path("1") do
+    on "about" do
+      on "1" do
         res.write "+1"
       end
 
-      on path("2") do
+      on "2" do
         res.write "+2"
       end
     end
@@ -45,7 +45,7 @@ end
 
 test "two level inlined paths" do |env|
   Cuba.define do
-    on path("a"), path("b") do
+    on "a/b" do
       res.write "a"
       res.write "b"
     end
@@ -60,7 +60,7 @@ end
 
 test "a path with some regex captures" do |env|
   Cuba.define do
-    on path("user(\\d+)") do |uid|
+    on "user(\\d+)" do |uid|
       res.write uid
     end
   end
@@ -71,3 +71,17 @@ test "a path with some regex captures" do |env|
 
   assert_equal ["123"], resp.body
 end
+
+test "matching the root" do |env|
+  Cuba.define do
+    on "" do
+      res.write "Home"
+    end
+  end
+
+  env["PATH_INFO"] = "/"
+
+  _, _, resp = Cuba.call(env)
+
+  assert_equal ["Home"], resp.body
+end

data/test/run.rb

@@ -6,7 +6,7 @@ test "redirect canonical example" do
       run Cuba::Ron.new { on(true) { res.redirect(*args) }}
     end
 
-    on path("account") do
+    on "account" do
       redirect "/login", 307
 
       res.write "Super secure content"
@@ -20,4 +20,4 @@ test "redirect canonical example" do
   assert_equal "/login", resp["Location"]
   assert_equal 307, resp.status
   assert_equal [], resp.body
-end
+end

data/test/segment.rb

@@ -2,8 +2,8 @@ require File.expand_path("helper", File.dirname(__FILE__))
 
 setup do
   Cuba.define do
-    on path("post") do
-      on segment do |id|
+    on "post" do
+      on :id do |id|
         res.write id
       end
     end
@@ -42,4 +42,4 @@ test "matches only the first segment available" do |env|
   _, _, resp = Cuba.call(env)
 
   assert_equal ["one"], resp.body
-end
+end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: cuba
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 1.0.0
+  prerelease: 6
+  version: 2.0.0.rc1
 platform: ruby
 authors: 
 - Michel Martens
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-16 00:00:00 -03:00
+date: 2011-02-25 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "1.1"
+        version: "1.2"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -43,7 +43,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "0.1"
+        version: "1.0"
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -54,7 +54,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "0.1"
+        version: "0.4"
   type: :development
   version_requirements: *id004
 description: Cuba is a light wrapper for Rum, a microframework for Rack applications.
@@ -77,9 +77,11 @@ files:
 - cuba.gemspec
 - test/accept.rb
 - test/captures.rb
-- test/extension.rb
+- test/extname.rb
 - test/helper.rb
+- test/host.rb
 - test/integration.rb
+- test/match.rb
 - test/number.rb
 - test/on.rb
 - test/path.rb
@@ -103,9 +105,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: