cuba 2.2.1 → 3.0.0.rc1

data/CHANGELOG

@@ -0,0 +1,10 @@
+3.0.0.rc1
+
+* Remove Cuba.build. Use subclassing instead.
+* Remove warnings.
+* Remove redefinition of Rack::Response#redirect.
+* Integrate Cuba.plugin and Cuba.settings.
+* Remove Cuba::VERSION.
+* Rename _call to call! (inspired from Sinatra).
+* Fix a memory leak with the caching used in Tilt.
+* Adding syntax highlighting to the README Code blocks

data/README.markdown

@@ -30,40 +30,43 @@ Usage
 
 Here's a simple application:
 
-    # cat hello_world.rb
-    require "cuba"
+``` ruby
+# cat hello_world.rb
+require "cuba"
 
-    Cuba.use Rack::Session::Cookie
+Cuba.use Rack::Session::Cookie
 
-    Cuba.define do
-      on get do
-        on "hello" do
-          res.write "Hello world!"
-        end
-
-        on true do
-          res.redirect "/hello"
-        end
-      end
+Cuba.define do
+  on get do
+    on "hello" do
+      res.write "Hello world!"
     end
 
-    # cat hello_world_test.rb
-    require "cuba/test"
+    on true do
+      res.redirect "/hello"
+    end
+  end
+end
 
-    scope do
-      test "Homepage" do
-        visit "/"
+# cat hello_world_test.rb
+require "cuba/test"
 
-        assert has_content?("Hello world!")
-      end
-    end
+scope do
+  test "Homepage" do
+    visit "/"
+    assert has_content?("Hello world!")
+  end
+end
+```
 
 To run it, you can create a `config.ru` file:
 
-    # cat config.ru
-    require "hello_world"
+``` ruby
+# cat config.ru
+require "./hello_world"
 
-    run Cuba
+run Cuba
+```
 
 You can now run `rackup` and enjoy what you have just created.
 
@@ -72,77 +75,80 @@ Matchers
 
 Here's an example showcasing how different matchers work:
 
-    require "cuba"
+``` ruby
+require "cuba"
 
-    Cuba.use Rack::Session::Cookie
+Cuba.use Rack::Session::Cookie
 
-    Cuba.define do
+Cuba.define do
 
-      # only GET requests
-      on get do
+  # only GET requests
+  on get do
 
-        # /
-        on "" do
-          res.write "Home"
-        end
+    # /
+    on "" do
+      res.write "Home"
+    end
 
-        # /about
-        on "about" do
-          res.write "About"
-        end
+    # /about
+    on "about" do
+      res.write "About"
+    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
 
-        # /styles/basic.css
-        on "styles", extension("css") do |file|
-          res.write "Filename: #{file}" #=> "Filename: basic"
-        end
+    # /username/foobar
+    on "username/:username" do |username|
 
-        # /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
+      user = User.find_by_username(username) # username == "foobar"
 
-        # /username/foobar
-        on "username/:username" do |username|
+      # /username/foobar/posts
+      on "posts" do
 
-          user = User.find_by_username(username) # username == "foobar"
+        # You can access `user` here, because the `on` blocks
+        # are closures.
+        res.write "Total Posts: #{user.posts.size}" #=> "Total Posts: 6"
+      end
 
-          # /username/foobar/posts
-          on "posts" do
+      # /username/foobar/following
+      on "following" do
+        res.write user.following.size #=> "1301"
+      end
+    end
 
-            # You can access `user` here, because the `on` blocks
-            # are closures.
-            res.write "Total Posts: #{user.posts.size}" #=> "Total Posts: 6"
-          end
+    # /search?q=barbaz
+    on "search", param("q") do |query|
+      res.write "Searched for #{query}" #=> "Searched for barbaz"
+    end
+  end
 
-          # /username/foobar/following
-          on "following" do
-            res.write user.following.size #=> "1301"
-          end
-        end
+  # only POST requests
+  on post do
+    on "login"
 
-        # /search?q=barbaz
-        on "search", param("q") do |query|
-          res.write "Searched for #{query}" #=> "Searched for barbaz"
-        end
+      # POST /login, user: foo, pass: baz
+      on param("user"), param("pass") do |user, pass|
+        res.write "#{user}:#{pass}" #=> "foo:baz"
       end
 
-      # only POST requests
-      on post do
-        on "login"
-
-          # POST /login, user: foo, pass: baz
-          on param("user"), param("pass") do |user, pass|
-            res.write "#{user}:#{pass}" #=> "foo:baz"
-          end
-
-          # 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
-        end
+      # 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
     end
+  end
+end
+```
+
 
 HTTP Verbs
 ----------
@@ -156,11 +162,13 @@ and inspect the environment via the `env` object, and check for example if
 
 What follows is an example of different ways of saying the same thing:
 
-    on env["REQUEST_METHOD"] == "GET", "api" do ... end
+``` ruby
+on env["REQUEST_METHOD"] == "GET", "api" do ... end
 
-    on req.get?, "api" do ... end
+on req.get?, "api" do ... end
 
-    on 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"`.
@@ -198,21 +206,23 @@ Composition
 
 You can mount a Cuba app, along with middlewares, inside another Cuba app:
 
-    API = Cuba.build
+``` ruby
+class API < Cuba; end
 
-    API.use SomeMiddleware
+API.use SomeMiddleware
 
-    API.define do
-      on param("url") do |url|
-        ...
-      end
-    end
+API.define do
+  on param("url") do |url|
+    ...
+  end
+end
 
-    Cuba.define do
-      on "api" do
-        run API
-      end
-    end
+Cuba.define do
+  on "api" do
+    run API
+  end
+end
+```
 
 Testing
 -------
@@ -222,16 +232,18 @@ Given that Cuba is essentially Rack, it is very easy to test with `Webrat` or
 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"
+``` ruby
+require "cuba/test"
+require "your/app"
 
-    scope do
-      test "Homepage" do
-        visit "/"
+scope do
+  test "Homepage" do
+    visit "/"
 
-        assert has_content?("Hello world!")
-      end
-    end
+    assert has_content?("Hello world!")
+  end
+end
+```
 
 To read more about testing, check the documentation for [Cutest][cutest] and
 [Capybara][capybara].
@@ -239,4 +251,6 @@ To read more about testing, check the documentation for [Cutest][cutest] and
 Installation
 ------------
 
-    $ gem install cuba
+``` ruby
+$ gem install cuba
+```

data/cuba.gemspec

@@ -1,8 +1,6 @@
-require "./lib/cuba/version"
-
 Gem::Specification.new do |s|
   s.name              = "cuba"
-  s.version           = Cuba::VERSION
+  s.version           = "3.0.0.rc1"
   s.summary           = "Microframework for web applications."
   s.description       = "Cuba is a microframework for web applications."
   s.authors           = ["Michel Martens"]
@@ -11,6 +9,7 @@ Gem::Specification.new do |s|
 
   s.files = Dir[
     "LICENSE",
+    "CHANGELOG",
     "README.markdown",
     "Rakefile",
     "lib/**/*.rb",

data/lib/cuba.rb

@@ -1,17 +1,4 @@
 require "rack"
-require "tilt"
-require "cuba/version"
-
-class Rack::Response
-  # 301 Moved Permanently
-  # 302 Found
-  # 303 See Other
-  # 307 Temporary Redirect
-  def redirect(target, status = 302)
-    self.status = status
-    self["Location"] = target
-  end
-end
 
 class Cuba
   class RedefinitionError < StandardError
@@ -19,6 +6,10 @@ class Cuba
 
   @@methods = []
 
+  class << self
+    undef method_added
+  end
+
   def self.method_added(meth)
     @@methods << meth
   end
@@ -40,10 +31,6 @@ class Cuba
     app.run new(&block)
   end
 
-  def self.build
-    Class.new(self)
-  end
-
   def self.prototype
     @prototype ||= app.to_app
   end
@@ -52,6 +39,21 @@ class Cuba
     prototype.call(env)
   end
 
+  def self.plugin(mixin)
+    include mixin
+    extend  mixin::ClassMethods if defined?(mixin::ClassMethods)
+
+    mixin.setup(self) if mixin.respond_to?(:setup)
+  end
+
+  def self.settings
+    @settings ||= {}
+  end
+
+  def self.inherited(child)
+    child.settings.replace(settings)
+  end
+
   attr :env
   attr :req
   attr :res
@@ -62,11 +64,15 @@ class Cuba
     @captures = []
   end
 
+  def settings
+    self.class.settings
+  end
+
   def call(env)
-    dup._call(env)
+    dup.call!(env)
   end
 
-  def _call(env)
+  def call!(env)
     @env = env
     @req = Rack::Request.new(env)
     @res = Rack::Response.new
@@ -86,33 +92,10 @@ class Cuba
     end
   end
 
-  # @private Used internally by #render to cache the
-  #          Tilt templates.
-  def _cache
-    Thread.current[:_cache] ||= Tilt::Cache.new
-  end
-  private :_cache
-
-  # Render any type of template file supported by Tilt.
-  #
-  # @example
-  #
-  #   # Renders home, and is assumed to be HAML.
-  #   render("home.haml")
-  #
-  #   # Renders with some local variables
-  #   render("home.haml", site_name: "My Site")
-  #
-  #   # Renders with HAML options
-  #   render("home.haml", {}, ugly: true, format: :html5)
-  #
-  #   # 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, &block)
+  def session
+    env["rack.session"] || raise(RuntimeError,
+      "You're missing a session handler. You can get started " +
+      "by adding Cuba.use Rack::Session::Cookie")
   end
 
   # The heart of the path / verb / any condition matching.
@@ -155,7 +138,7 @@ class Cuba
       # The captures we yield here were generated and assembled
       # by evaluating each of the `arg`s above. Most of these
       # are carried out by #consume.
-      yield *captures
+      yield(*captures)
 
       halt res.finish
     end
@@ -169,7 +152,7 @@ class Cuba
     yield
 
   ensure
-    env["SCRIPT_NAME"], env["PATH_INFO"] = script, path unless @matched
+    env["SCRIPT_NAME"], env["PATH_INFO"] = script, path
   end
   private :try
 
@@ -292,6 +275,10 @@ class Cuba
     throw :halt, response
   end
 
+  class << self
+    undef method_added
+  end
+
   # In order to prevent people from overriding the standard Cuba
   # methods like `get`, `put`, etc, we add this as a safety measure.
   def self.method_added(meth)

data/lib/cuba/settings.rb

@@ -0,0 +1,25 @@
+class Cuba
+  module Settings
+    def settings
+      self.class
+    end
+
+    module ClassMethods
+      def set(key, value)
+        metaclass.send :attr_writer, key
+        metaclass.module_eval %{
+          def #{key}
+            @#{key} ||= #{value.inspect}
+          end
+        }
+
+        send :"#{key}=", value
+      end
+
+    private
+      def metaclass
+        class << self; self; end
+      end
+    end
+  end
+end

data/test/accept.rb

@@ -26,8 +26,6 @@ test "tests don't fail when you don't specify an accept type" do
     end
   end
 
-  env = { "SCRIPT_NAME" => "/", "PATH_INFO" => "/post" }
-
   _, _, resp = Cuba.call({})
 
   assert_equal ["Default action"], resp.body

data/test/helper.rb

@@ -2,3 +2,10 @@ $:.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
 require "cuba"
 
 prepare { Cuba.reset! }
+
+def assert_response(body, expected)
+  arr = []
+  body.each { |line| arr << line }
+
+  assert_equal arr, expected
+end

data/test/match.rb

@@ -33,10 +33,10 @@ end
 
 test "regex nesting" do |env|
   Cuba.define do
-    on /u\/(\w+)/ do |uid|
+    on(/u\/(\w+)/) do |uid|
       res.write uid
 
-      on /posts\/(\d+)/ do |id|
+      on(/posts\/(\d+)/) do |id|
         res.write id
       end
     end
@@ -51,10 +51,10 @@ end
 
 test "regex nesting colon param style" do |env|
   Cuba.define do
-    on /u:(\w+)/ do |uid|
+    on(/u:(\w+)/) do |uid|
       res.write uid
 
-      on /posts:(\d+)/ do |id|
+      on(/posts:(\d+)/) do |id|
         res.write id
       end
     end
@@ -83,4 +83,4 @@ test "symbol matching" do |env|
   _, _, resp = Cuba.call(env)
 
   assert_equal ["jdoe", "123"], resp.body
-end
+end

data/test/middleware.rb

@@ -13,13 +13,15 @@ class Shrimp
 end
 
 test do
-  API = Cuba.build
-  API.use Shrimp
-  API.define do
-    on "v1/test" do
-      res.write "OK"
-      res.write "1"
-      res.write "2"
+  class API < Cuba
+    use Shrimp
+
+    define do
+      on "v1/test" do
+        res.write "OK"
+        res.write "1"
+        res.write "2"
+      end
     end
   end
 
@@ -38,4 +40,4 @@ test do
   end
 
   assert_equal ["2", "1", "OK"], arr
-end
+end

data/test/number.rb

@@ -22,7 +22,7 @@ end
 test "paths and decimals" do |env|
   Cuba.define do
     on "about" do
-      on /(\d+)/ do |one|
+      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/plugin.rb

@@ -0,0 +1,68 @@
+require_relative "helper"
+
+scope do
+  module Helper
+    def clean(str)
+      str.strip
+    end
+  end
+
+  test do
+    Cuba.plugin Helper
+
+    Cuba.define do
+      on default do
+        res.write clean " foo "
+      end
+    end
+
+    _, _, body = Cuba.call({})
+
+    assert_response body, ["foo"]
+  end
+end
+
+scope do
+  module Number
+    def num
+      1
+    end
+  end
+
+  module Plugin
+    def self.setup(app)
+      app.plugin Number
+    end
+
+    def bar
+      "baz"
+    end
+
+    module ClassMethods
+      def foo
+        "bar"
+      end
+    end
+  end
+
+  setup do
+    Cuba.plugin Plugin
+
+    Cuba.define do
+      on default do
+        res.write bar
+        res.write num
+      end
+    end
+  end
+
+  test do
+    assert_equal "bar", Cuba.foo
+  end
+
+  test do
+    _, _, body = Cuba.call({})
+
+    assert_response body, ["baz", "1"]
+  end
+end

data/test/session.rb

@@ -0,0 +1,21 @@
+require_relative "helper"
+
+test do
+  Cuba.define do
+    on default do
+      begin
+        session
+      rescue Exception => e
+        res.write e.message
+      end
+    end
+  end
+
+  _, _, body = Cuba.call({})
+
+  body.each do |e|
+    assert e =~ /Cuba.use Rack::Session::Cookie/
+  end
+end
+
+

data/test/settings.rb

@@ -0,0 +1,39 @@
+require File.expand_path("helper", File.dirname(__FILE__))
+
+test "settings is an empty hash by default" do
+  assert Cuba.settings.kind_of?(Hash)
+  assert Cuba.settings.empty?
+end
+
+test "is inheritable and allows overriding" do
+  Cuba.settings[:foo] = "bar"
+
+  class Admin < Cuba; end
+
+  assert_equal "bar", Admin.settings[:foo]
+
+  Admin.settings[:foo] = "baz"
+
+  assert_equal "bar", Cuba.settings[:foo]
+  assert_equal "baz", Admin.settings[:foo]
+end
+
+test do
+  Cuba.settings[:hello] = "Hello World"
+
+  Cuba.define do
+    on default do
+      res.write settings[:hello]
+    end
+  end
+
+  _, _, resp = Cuba.call({ "PATH_INFO" => "/", "SCRIPT_NAME" => ""})
+
+  body = []
+
+  resp.each do |line|
+    body << line
+  end
+
+  assert_equal ["Hello World"], body
+end

metadata

@@ -1,20 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: cuba
 version: !ruby/object:Gem::Version
-  version: 2.2.1
-  prerelease: 
+  version: 3.0.0.rc1
+  prerelease: 6
 platform: ruby
 authors:
 - Michel Martens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-24 00:00:00.000000000 -03:00
-default_executable: 
+date: 2012-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2157863520 !ruby/object:Gem::Requirement
+  requirement: &2160204820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157863520
+  version_requirements: *2160204820
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &2157863100 !ruby/object:Gem::Requirement
+  requirement: &2160203660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157863100
+  version_requirements: *2160203660
 - !ruby/object:Gem::Dependency
   name: cutest
-  requirement: &2157862680 !ruby/object:Gem::Requirement
+  requirement: &2160218800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157862680
+  version_requirements: *2160218800
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &2157862260 !ruby/object:Gem::Requirement
+  requirement: &2160218280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157862260
+  version_requirements: *2160218280
 description: Cuba is a microframework for web applications.
 email:
 - michel@soveran.com
@@ -64,10 +63,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- CHANGELOG
 - README.markdown
 - Rakefile
+- lib/cuba/settings.rb
 - lib/cuba/test.rb
-- lib/cuba/version.rb
 - lib/cuba.rb
 - cuba.gemspec
 - test/accept.rb
@@ -77,18 +77,19 @@ files:
 - test/helper.rb
 - test/host.rb
 - test/integration.rb
-- test/layout.rb
 - test/match.rb
 - test/middleware.rb
 - test/number.rb
 - test/on.rb
 - test/param.rb
 - test/path.rb
+- test/plugin.rb
 - test/redefinition.rb
 - test/root.rb
 - test/run.rb
 - test/segment.rb
-has_rdoc: true
+- test/session.rb
+- test/settings.rb
 homepage: http://github.com/soveran/cuba
 licenses: []
 post_install_message: 
@@ -104,12 +105,12 @@ 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: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Microframework for web applications.

data/lib/cuba/version.rb

@@ -1,3 +0,0 @@
-class Cuba
-  VERSION = "2.2.1"
-end

data/test/layout.rb

@@ -1,15 +0,0 @@
-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