cuba 2.0.0 → 2.0.1

data/README.markdown

@@ -58,13 +58,18 @@ Here's a simple application:
       end
     end
 
-To run it, you can create a `config.ru`:
+To run it, you can create a `config.ru` file:
 
     # cat config.ru
     require "hello_world"
 
     run Cuba
 
+You can now run `rackup` and enjoy what you have just created.
+
+Matchers
+--------
+
 Here's an example showcasing how different matchers work:
 
     require "cuba"
@@ -73,50 +78,55 @@ Here's an example showcasing how different matchers work:
 
     Cuba.define do
 
-      # /
-      on "" do
-        res.write "Home"
-      end
+      # only GET requests
+      on get do
 
-      # /about
-      on "about" do
-        res.write "About"
-      end
+        # /
+        on "" do
+          res.write "Home"
+        end
 
-      # /styles/basic.css
-      on "styles", extension("css") do |file|
-        res.write "Filename: #{file}" #=> "Filename: basic"
-      end
+        # /about
+        on "about" do
+          res.write "About"
+        end
 
-      # /post/2011/02/16/hello
-      on "post/:y/:m/:d/:slug" do |y, m, d, slug|
-        res.write "#{y}-#{m}-#{d} #{slug}" #=> "2011-02-16 hello"
-      end
+        # /styles/basic.css
+        on "styles", extension("css") do |file|
+          res.write "Filename: #{file}" #=> "Filename: basic"
+        end
+
+        # /post/2011/02/16/hello
+        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 "username/:username" do |username|
+        # /username/foobar
+        on "username/:username" do |username|
 
-        user = User.find_by_username(username) # username == "foobar"
+          user = User.find_by_username(username) # username == "foobar"
 
-        # /username/foobar/posts
-        on "posts" do
+          # /username/foobar/posts
+          on "posts" do
 
-          # You can access `user` here, because the `on` blocks
-          # are closures.
-          res.write "Total Posts: #{user.posts.size}" #=> "Total Posts: 6"
-        end
+            # You can access `user` here, because the `on` blocks
+            # are closures.
+            res.write "Total Posts: #{user.posts.size}" #=> "Total Posts: 6"
+          end
 
-        # /username/foobar/following
-        on "following" do
-          res.write user.following.size #=> "1301"
+          # /username/foobar/following
+          on "following" do
+            res.write user.following.size #=> "1301"
+          end
         end
-      end
 
-      # /search?q=barbaz
-      on "search", param("q") do |query|
-        res.write "Searched for #{query}" #=> "Searched for barbaz"
+        # /search?q=barbaz
+        on "search", param("q") do |query|
+          res.write "Searched for #{query}" #=> "Searched for barbaz"
+        end
       end
 
+      # only POST requests
       on post do
         on "login"
 
@@ -134,7 +144,73 @@ 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.
+HTTP Verbs
+----------
+
+There are four matchers defined for HTTP Verbs: `get`, `post`, `put` and
+`delete`. But the world doesn't end there, does it? As you have the whole
+request available via the `req` object, you can query it with helper methods
+like `req.options?` or `req.head?`, or you can even go to a lower level
+and inspect the environment via the `env` object, and check for example if
+`env["REQUEST_METHOD"]` equals the obscure verb `PATCH`.
+
+What follows is an example of different ways of saying the same thing:
+
+    on env["REQUEST_METHOD"] == "GET", "api" do ... end
+
+    on req.get?, "api" do ... end
+
+    on get, "api" do ... end
+
+Actually, `get` is syntax sugar for `req.get?`, which in turn is syntax sugar
+for `env["REQUEST_METHOD"] == "GET"`.
+
+Captures
+--------
+
+You may have noticed that some matchers yield a value to the block. The rules
+for determining if a matcher will yield a value are simple:
+
+1. Regex captures: `"posts/(\d+)-(.*)"` will yield two values, corresponding to each capture.
+2. Placeholders: `"users/:id"` will yield the value in the position of :id.
+3. Symbols: `:foobar` will yield if a segment is available.
+4. File extensions: `extension("css")` will yield the basename of the matched file.
+5. Parameters: `param("user")` will yield the value of the parameter user, if present.
+
+The first case is important because it shows the underlying effect of regex
+captures.
+
+In the second case, the substring `:id` gets replaced by `([^\\/]+)` and the
+string becomes `"users/([^\\/]+)"` before performing the match, thus it reverts
+to the first form we saw.
+
+In the third case, the symbol ––no matter what it says––gets replaced
+by `"([^\\/]+)"`, and again we are in presence of case 1.
+
+The fourth case, again, reverts to the basic matcher: it generates the string
+`"([^\\/]+?)\.#{ext}\\z"` before performing the match.
+
+The fifth case is different: it checks if the the parameter supplied is present
+in the request (via POST or QUERY_STRING) and it pushes the value as a capture.
+
+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`:
+
+    require "cuba/test"
+    require "your/app"
+
+    scope do
+      test "Homepage" do
+        visit "/"
+
+        assert has_content?("Hello world!")
+      end
+    end
 
 To read more about testing, check the documentation for [Cutest][cutest] and
 [Capybara][capybara].

data/cuba.gemspec

@@ -1,14 +1,25 @@
+require "./lib/cuba/version"
+
 Gem::Specification.new do |s|
   s.name              = "cuba"
-  s.version           = "2.0.0"
+  s.version           = Cuba::VERSION
   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.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/composition.rb", "test/extension.rb", "test/helper.rb", "test/host.rb", "test/integration.rb", "test/match.rb", "test/number.rb", "test/on.rb", "test/param.rb", "test/path.rb", "test/run.rb", "test/segment.rb"]
-  s.add_dependency "rack", "~> 1.2"
-  s.add_dependency "tilt", "~> 1.2"
-  s.add_development_dependency "cutest", "~> 1.0"
-  s.add_development_dependency "capybara", "~> 0.4"
+
+  s.files = Dir[
+    "LICENSE",
+    "README.markdown",
+    "Rakefile",
+    "lib/**/*.rb",
+    "*.gemspec",
+    "test/*.*"
+  ]
+
+  s.add_dependency "rack"
+  s.add_dependency "tilt"
+  s.add_development_dependency "cutest"
+  s.add_development_dependency "capybara"
 end

data/lib/cuba/ron.rb

@@ -63,10 +63,13 @@ module Cuba
     #   # Renders with HAML options
     #   render("home.haml", {}, ugly: true, format: :html5)
     #
-    def render(template, locals = {}, options = {})
+    #   # Renders in layout
+    #   render("layout.haml") { render("home.haml") }
+    #
+    def render(template, locals = {}, options = {}, &block)
       _cache.fetch(template, locals) {
         Tilt.new(template, 1, options)
-      }.render(self, locals)
+      }.render(self, locals, &block)
     end
 
     # The heart of the path / verb / any condition matching.
@@ -140,12 +143,12 @@ module Cuba
     private :try
 
     def consume(pattern)
-      return unless match = env["PATH_INFO"].match(/\A\/(#{pattern})(?:\/|\z)/)
+      return unless match = env["PATH_INFO"].match(/\A\/(#{pattern})((?:\/|\z))/)
 
       path, *vars = match.captures
 
       env["SCRIPT_NAME"] += "/#{path}"
-      env["PATH_INFO"] = "/#{match.post_match}"
+      env["PATH_INFO"] = "#{vars.pop}#{match.post_match}"
 
       captures.push(*vars)
     end
@@ -254,4 +257,4 @@ module Cuba
       throw :ron_run_next_app, app
     end
   end
-end
+end

data/lib/cuba/test.rb

@@ -3,7 +3,11 @@ require "cutest"
 require "capybara/dsl"
 
 class Cutest::Scope
-  include Capybara
+  if defined? Capybara::DSL
+    include Capybara::DSL
+  else
+    include Capybara
+  end
 end
 
 Capybara.app = Cuba

data/lib/cuba/version.rb

@@ -1,3 +1,3 @@
 module Cuba
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/test/helper.rb

@@ -1,5 +1,4 @@
 $:.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
 require "cuba"
-require "cutest"
 
 prepare { Cuba.reset! }

data/test/layout.rb

@@ -0,0 +1,15 @@
+require File.expand_path("helper", File.dirname(__FILE__))
+
+test "simple layout support" do
+  Cuba.define do
+    on true do
+      res.write render("test/fixtures/layout.erb") {
+        render("test/fixtures/content.erb")
+      }
+    end
+  end
+
+  _, _, resp = Cuba.call({})
+
+  assert_equal ["alfa beta\n\n"], resp.body
+end

data/test/root.rb

@@ -0,0 +1,40 @@
+require File.expand_path("helper", File.dirname(__FILE__))
+
+test "matching an empty segment" do
+  Cuba.define do
+    on "" do
+      res.write req.path
+    end
+  end
+
+  env = {
+    "SCRIPT_NAME" => "",
+    "PATH_INFO" => "/"
+  }
+
+  _, _, resp = Cuba.call(env)
+
+  assert_equal ["/"], resp.body
+end
+
+test "nested empty segments" do
+  Cuba.define do
+    on "" do
+      on "" do
+        on "1" do
+          res.write "IT WORKS!"
+          res.write req.path
+        end
+      end
+    end
+  end
+
+  env = {
+    "SCRIPT_NAME" => "",
+    "PATH_INFO" => "///1"
+  }
+
+  _, _, resp = Cuba.call(env)
+
+  assert_equal ["IT WORKS!", "///1"], resp.body
+end

metadata

@@ -1,72 +1,68 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: cuba
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 2.0.1
   prerelease: 
-  version: 2.0.0
 platform: ruby
-authors: 
+authors:
 - Michel Martens
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-03-18 00:00:00 -03:00
+date: 2011-07-19 00:00:00.000000000 -03:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2157267480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.2"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: tilt
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2157267480
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: &2157267060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.2"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: cutest
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2157267060
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: &2157266640 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: capybara
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2157266640
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &2157266220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.4"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: *2157266220
 description: Cuba is a microframework for web applications.
-email: 
+email:
 - michel@soveran.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - LICENSE
 - README.markdown
 - Rakefile
@@ -82,40 +78,38 @@ files:
 - test/helper.rb
 - test/host.rb
 - test/integration.rb
+- test/layout.rb
 - test/match.rb
 - test/number.rb
 - test/on.rb
 - test/param.rb
 - test/path.rb
+- test/root.rb
 - test/run.rb
 - test/segment.rb
 has_rdoc: true
 homepage: http://github.com/soveran/cuba
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.0
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Microframework for web applications.
 test_files: []
-