manveru-innate 2009.02.06 → 2009.02.21

data/MANIFEST

@@ -68,6 +68,8 @@ lib/rack/reloader.rb
 spec/example/hello.rb
 spec/example/link.rb
 spec/helper.rb
+spec/innate/action/layout.rb
+spec/innate/action/layout/file_layout.erb
 spec/innate/cache/common.rb
 spec/innate/cache/marshal.rb
 spec/innate/cache/memory.rb
@@ -89,6 +91,7 @@ spec/innate/helper/view/partial.erb
 spec/innate/helper/view/recursive.erb
 spec/innate/mock.rb
 spec/innate/node.rb
+spec/innate/node/another_layout/another_layout.erb
 spec/innate/node/bar.html
 spec/innate/node/foo.html.erb
 spec/innate/node/with_layout.erb

data/Rakefile

@@ -7,6 +7,7 @@ require 'pp'
 INNATE_VERSION = Date.today.strftime("%Y.%m.%d")
 
 task :default => [:spec]
+task :publish => [:ydoc]
 
 CLEAN.include('*coverage*')
 
@@ -106,17 +107,21 @@ task :rcov => :clean do
 end
 
 desc 'Run all specs'
-task :spec do
+task :spec => :setup do
   require 'open3'
+  require 'scanf'
 
   specs = Dir['spec/{innate,example}/**/*.rb']
   specs.delete_if{|f| f =~ /cache\/common\.rb/ }
 
+  some_failed = false
   total = specs.size
-  len = specs.sort.last.size
-  left_format = "%4d/%d: %-#{len + 11}s"
+  len = specs.map{|s| s.size }.sort.last
+  tt = ta = tf = te = 0
 
   red, green = "\e[31m%s\e[0m", "\e[32m%s\e[0m"
+  left_format = "%4d/%d: %-#{len + 11}s"
+  spec_format = "%d specifications (%d requirements), %d failures, %d errors"
 
   specs.each_with_index do |spec, idx|
     print(left_format % [idx + 1, total, spec])
@@ -125,15 +130,120 @@ task :spec do
       out = sout.read
       err = serr.read
 
-      md = out.match(/(\d+) tests, (\d+) assertions, (\d+) failures, (\d+) errors/)
-      tests, assertions, failures, errors = all = md.captures.map{|c| c.to_i }
+      out.each_line do |line|
+        tests, assertions, failures, errors = all = line.scanf(spec_format)
+        next unless all.any?
+        tt += tests; ta += assertions; tf += failures; te += errors
+
+        if tests == 0 || failures + errors > 0
+          puts((red % spec_format) % all)
+          puts out
+          puts err
+        else
+          puts((green % "%6d passed") % tests)
+        end
 
-      if failures + errors > 0
-        puts((red % "%5d tests, %d assertions, %d failures, %d errors") % all)
-        puts "", out, err, ""
-      else
-        puts((green % "%5d passed") % tests)
+        break
       end
     end
   end
+
+  puts(spec_format % [tt, ta, tf, te])
+  exit 1 if some_failed
+end
+
+desc 'Generate YARD documentation'
+task :ydoc do
+  sh('yardoc -o ydoc -r README.md')
+end
+
+begin
+  require 'grancher/task'
+
+  Grancher::Task.new do |g|
+    g.branch = 'gh-pages'
+    g.push_to = 'origin'
+    g.message = 'Updated website'
+    g.directory 'ydoc', 'doc'
+  end
+rescue LoadError
+  # oh well :)
+end
+
+desc 'install dependencies'
+task :setup do
+  GemSetup.new do
+    github = 'http://gems.github.com'
+    Gem.sources << github
+
+    gem('rack', '>=0.9.1')
+    gem('bacon', '>=1.1.0')
+
+    setup
+  end
+end
+
+class GemSetup
+  def initialize(options = {}, &block)
+    @gems = []
+    @options = options
+
+    run(&block)
+  end
+
+  def run(&block)
+    instance_eval(&block) if block_given?
+  end
+
+  def gem(name, version = nil, options = {})
+    if version.respond_to?(:merge!)
+      options = version
+    else
+      options[:version] = version
+    end
+
+    @gems << [name, options]
+  end
+
+  def setup
+    require 'rubygems'
+    require 'rubygems/dependency_installer'
+
+    @gems.each do |name, options|
+      setup_gem(name, options)
+    end
+  end
+
+  def setup_gem(name, options, try_install = true)
+    print "activating #{name} ... "
+    Gem.activate(name, *[options[:version]].compact)
+    require(options[:lib] || name)
+    puts "success."
+  rescue LoadError => error
+    puts error
+    install_gem(name, options) if try_install
+    setup_gem(name, options, try_install = false)
+  end
+
+  def install_gem(name, options)
+    installer = Gem::DependencyInstaller.new(options)
+
+    temp_argv(options[:extconf]) do
+      print "Installing #{name} ... "
+      installer.install(name, options[:version])
+      puts "done."
+    end
+  end
+
+  def temp_argv(extconf)
+    if extconf ||= @options[:extconf]
+      old_argv = ARGV.clone
+      ARGV.replace(extconf.split(' '))
+    end
+
+    yield
+
+  ensure
+    ARGV.replace(old_argv) if extconf
+  end
 end

data/example/app/retro_games.rb

@@ -3,53 +3,56 @@ require 'yaml/store'
 
 STORE = YAML::Store.new('games.yaml')
 
-def STORE.[](key) transaction{|s| s[key] } end
-def STORE.[]=(key, value) transaction{|s| s[key] = value } end
+def STORE.[](key) transaction{|s| super } end
+def STORE.[]=(key, value) transaction{|s| super } end
 def STORE.each
   YAML.load_file('games.yaml').sort_by{|k,v| -v }.each{|(k,v)| yield(k, v) }
 end
 
+STORE['Pacman'] = 1
+
 class Games
-  include Innate::Node
-  map '/'
-  provide :html => :haml
+  Innate.node('/')
 
   def index
     TEMPLATE
   end
 
   def create
-    if request.post?
-      name = request.params['name']
-      STORE[name] ||= 0
-    end
+    STORE[request[:name]] ||= 0 if request.post?
 
     redirect_referrer
   end
 
   def vote(name)
-    STORE[url_decode name] += 1
+    STORE[url_decode(name)] += 1
 
     redirect_referrer
   end
 
   TEMPLATE = <<-'T'.strip
-!!! XML
-!!!
-
-%html
-  %head
-    %title Top Retro Games
-  %body
-    %h1 Vote on your favorite Retro Game
-    %form{:action => r(:create), :method => 'POST'}
-      %input{:type => 'text', :name => 'name'}
-      %input{:type => 'submit', :value => 'Add'}
-    %ol
-      - STORE.each do |name, votes|
-        %li
-          = Games.a("Vote", "/vote/#{u name}")
-          = h("%5d => %s" % [votes, name])
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+    <title>Top Retro Games</title>
+  </head>
+  <body>
+    <h1>Vote on your favorite Retro Game</h1>
+    <form action="<%= r :create %>" method="post">
+      <input type="text" name="name" />
+      <input type="submit" value="Add" />
+    </form>
+    <ol>
+      <% STORE.each do |name, votes| %>
+        <li>
+          <%= Games.a("Vote", "/vote/#{u name}") %>
+          <%= "%5d => %s" % [votes, name] %>
+        </li>
+      <% end %>
+    </ol>
+  </body>
+</html>
   T
 
 end

data/innate.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "innate"
-  s.version = "2009.02.06"
+  s.version = "2009.02.21"
 
   s.summary = "Powerful web-framework wrapper for Rack."
   s.description = "Simple, straight-forward, base for web-frameworks."
@@ -84,6 +84,8 @@ Gem::Specification.new do |s|
     "spec/example/hello.rb",
     "spec/example/link.rb",
     "spec/helper.rb",
+    "spec/innate/action/layout.rb",
+    "spec/innate/action/layout/file_layout.erb",
     "spec/innate/cache/common.rb",
     "spec/innate/cache/marshal.rb",
     "spec/innate/cache/memory.rb",
@@ -105,6 +107,7 @@ Gem::Specification.new do |s|
     "spec/innate/helper/view/recursive.erb",
     "spec/innate/mock.rb",
     "spec/innate/node.rb",
+    "spec/innate/node/another_layout/another_layout.erb",
     "spec/innate/node/bar.html",
     "spec/innate/node/foo.html.erb",
     "spec/innate/node/with_layout.erb",

data/lib/innate.rb

@@ -15,177 +15,229 @@ module Innate
   unless $LOAD_PATH.any?{|lp| File.expand_path(lp) == ROOT }
     $LOAD_PATH.unshift(ROOT)
   end
-end
 
-# stdlib
-require 'pp'
-require 'set'
-require 'pathname'
-require 'digest/sha1'
-require 'ipaddr'
-require 'socket'
-require 'logger'
-require 'uri'
-
-# 3rd party
-require 'rack'
-
-# innate core patches
-require 'innate/core_compatibility/string'
-require 'innate/core_compatibility/basic_object'
-
-# innate core
-require 'innate/version'
-require 'innate/traited'
-require 'innate/cache'
-require 'innate/node'
-require 'innate/options'
-require 'innate/log'
-require 'innate/state'
-require 'innate/trinity'
-require 'innate/current'
-require 'innate/mock'
-require 'innate/adapter'
-require 'innate/action'
-require 'innate/helper'
-require 'innate/view'
-require 'innate/session'
-require 'innate/session/flash'
-require 'innate/dynamap'
-require 'innate/route'
-
-require 'rack/reloader'
-require 'rack/middleware_compiler'
+  # stdlib
+  require 'pp'
+  require 'set'
+  require 'pathname'
+  require 'digest/sha1'
+  require 'ipaddr'
+  require 'socket'
+  require 'logger'
+  require 'uri'
+
+  # 3rd party
+  require 'rack'
+
+  # innate core patches
+  require 'innate/core_compatibility/string'
+  require 'innate/core_compatibility/basic_object'
+
+  # innate core
+  require 'innate/version'
+  require 'innate/traited'
+  require 'innate/cache'
+  require 'innate/node'
+  require 'innate/options'
+  require 'innate/log'
+  require 'innate/state'
+  require 'innate/trinity'
+  require 'innate/current'
+  require 'innate/mock'
+  require 'innate/adapter'
+  require 'innate/action'
+  require 'innate/helper'
+  require 'innate/view'
+  require 'innate/session'
+  require 'innate/session/flash'
+  require 'innate/dynamap'
+  require 'innate/route'
+
+  # innate lib/rack
+  require 'rack/reloader'
+  require 'rack/middleware_compiler'
 
-module Innate
   extend Trinity
 
+  # This constant holds a couple of common middlewares and allows for easy
+  # addition of new ones.
+  # The Proc to use is determined by the value of options.mode.
+  # The Proc value is passed to setup_middleware if no block is given to
+  # Innate::start.
+  #
+  # A quick overview over the middleware used here:
+  #
+  #   * Rack::CommonLogger
+  #     Logs a line in Apache common log format or <tt>rack.errors</tt>.
+  #
+  #   * Rack::ShowExceptions
+  #     Catches all exceptions raised from the app it wraps. It shows a useful
+  #     backtrace with the sourcefile and clickable context, the whole Rack
+  #     environment and the request data.
+  #     Be careful when you use this on public-facing sites as it could reveal
+  #     information helpful to attackers.
+  #
+  #   * Rack::ShowStatus
+  #     Catches all empty responses the app it wraps and replaces them with a
+  #     site explaining the error.
+  #     Additional details can be put into <tt>rack.showstatus.detail</tt> and
+  #     will be shown as HTML. If such details exist, the error page is always
+  #     rendered, even if the reply was not empty.
+  #
+  #   * Rack::ConditionalGet
+  #     Middleware that enables conditional GET using If-None-Match and
+  #     If-Modified-Since. The application should set either or both of the
+  #     Last-Modified or Etag response headers according to RFC 2616. When
+  #     either of the conditions is met, the response body is set to be zero
+  #     length and the response status is set to 304 Not Modified.
+  #
+  #   * Rack::Head
+  #     Removes the body of the response for HEAD requests.
+  #
+  #   * Rack::Reloader
+  #     Pure ruby source reloader, runs on every request with a configurable
+  #     cooldown period.
+  #
+  #   * Rack::Lint
+  #     Rack::Lint validates your application and the requests and responses
+  #     according to the Rack spec.
+  #
   # Note that `m.innate` takes away most of the boring part and leaves it up to
   # you to select your middleware in your application.
   #
-  # This expands to:
+  # `m.innate` expands to:
   #
-  #   use Rack::ShowExceptions
-  #   use Rack::RouteExceptions
-  #   use Rack::ShowStatus
-  #   use Rack::Reloader
   #   use Rack::Cascade.new([
   #     Rack::File.new('public'),
   #     Innate::Current.new(
   #       Rack::Cascade.new([
   #         Innate::Rewrite.new(Innate::DynaMap),
   #         Innate::Route.new(Innate::DynaMap)])))
-  DEFAULT_MIDDLEWARE = lambda{|m|
-    m.use Rack::CommonLogger  # usually fast, depending on the output
-    m.use Rack::ShowExceptions  # fast
-    # m.use Rack::RouteExceptions # fast, use when you have custom error pages.
-    m.use Rack::ShowStatus      # fast
-    m.use Rack::Reloader        # reasonably fast depending on settings
-    # m.use Rack::Lint          # slow, use only while developing
-
-    m.innate
+  #
+  # @see Rack::MiddlewareCompiler
+  MIDDLEWARE = {
+    :dev => lambda{|m|
+      m.use(Rack::Lint, Rack::CommonLogger, Rack::ShowExceptions,
+            Rack::ShowStatus, Rack::ConditionalGet, Rack::Head, Rack::Reloader)
+      m.innate },
+    :live => lambda{|m|
+      m.use(Rack::CommonLogger, Rack::ShowStatus, Rack::ConditionalGet,
+            Rack::Head)
+      m.innate }
   }
 
-  module_function
+  module SingletonMethods
+    def start(parameter = {}, &block)
+      options[:app][:root] = go_figure_root(parameter, caller)
+      parameter.reject!{|k, v| [:root, :file].include?(k) }
+      options.merge!(parameter)
 
-  def start(parameter = {}, &block)
-    setup_dependencies
-    setup_middleware(&block)
+      setup_dependencies
+      setup_middleware(&block)
 
-    options[:app][:root] = go_figure_root(parameter, caller)
-    parameter.reject!{|k, v| [:root, :file].include?(k) }
-    options.merge!(parameter)
+      return if options.started
+      options.started = true
 
-    return if options.started
-    options.started = true
+      trap(options[:trap]){ stop(10) } if options[:trap]
 
-    trap(options[:trap]){ stop(10) } if options[:trap]
+      start!(options)
+    end
 
-    start!(options)
-  end
+    def start!(options = Innate.options)
+      Adapter.start(middleware(:innate), options)
+    end
 
-  def start!(options = Innate.options)
-    Adapter.start(middleware(:innate), options)
-  end
+    def stop(wait = 3)
+      Log.info("Shutdown Innate within #{wait} seconds")
+      Timeout.timeout(wait){ exit }
+    ensure
+      exit!
+    end
 
-  def stop(wait = 3)
-    Log.info("Shutdown Innate within #{wait} seconds")
-    Timeout.timeout(wait){ exit }
-  ensure
-    exit!
-  end
+    def middleware(name, &block)
+      Rack::MiddlewareCompiler.build(name, &block)
+    end
 
-  def middleware(name, &block)
-    Rack::MiddlewareCompiler.build(name, &block)
-  end
+    def middleware!(name, &block)
+      Rack::MiddlewareCompiler.build!(name, &block)
+    end
 
-  def middleware!(name, &block)
-    Rack::MiddlewareCompiler.build!(name, &block)
-  end
+    def middleware_recompile(name = :innate)
+      Rack::MiddlewareCompiler::COMPILED[name].compile!
+    end
 
-  def setup_dependencies
-    options[:setup].each{|obj| obj.setup }
-  end
+    def setup_dependencies
+      options[:setup].each{|obj| obj.setup }
+    end
 
-  # Set the default middleware for applications.
-  def setup_middleware(&block)
-    middleware(:innate, &(block || DEFAULT_MIDDLEWARE))
-  end
+    # Set the default middleware for applications.
+    def setup_middleware(force = false, &block)
+      mode = options.mode
+      block ||= MIDDLEWARE[mode]
+      raise("No Middleware for mode: %p found" % mode) unless block
 
-  # Pass the +env+ to this method and it will be sent to the appropriate
-  # middleware called +mw+.
-  # Tries to avoid recursion.
+      force ? middleware!(:innate, &block) : middleware(:innate, &block)
+    end
 
-  def call(env, mw = :innate)
-    this_file = File.expand_path(__FILE__)
-    count = 0
-    caller_lines(caller){|f, l, m| count += 1 if f == this_file }
+    # Pass the +env+ to this method and it will be sent to the appropriate
+    # middleware called +mw+.
+    # Tries to avoid recursion.
 
-    raise RuntimeError, "Recursive loop in Innate::call" if count > 10
+    def call(env, mw = :innate)
+      this_file = File.expand_path(__FILE__)
+      count = 0
+      caller_lines(caller){|f, l, m| count += 1 if f == this_file }
 
-    middleware(mw).call(env)
-  end
+      raise("Recursive loop in Innate::call") if count > 10
 
-  # Innate can be started by:
-  #
-  #   Innate.start :file => __FILE__
-  #   Innate.start :root => '/path/to/here'
-  #
-  # In case these options are not passed we will try to figure out a file named
-  # `start.rb` in the backtrace and use the directory it resides in.
-  #
-  # TODO: better documentation and nice defaults, don't want to rely on a
-  #       filename, bad mojo.
-
-  def go_figure_root(options, backtrace)
-    if o_file = options[:file]
-      return File.dirname(o_file)
-    elsif root = options[:root]
-      return root
+      middleware(mw).call(env)
     end
 
-    pwd = Dir.pwd
+    # Innate can be started by:
+    #
+    #   Innate.start :file => __FILE__
+    #   Innate.start :root => '/path/to/here'
+    #
+    # In case these options are not passed we will try to figure out a file named
+    # `start.rb` in the backtrace and use the directory it resides in.
+    #
+    # TODO: better documentation and nice defaults, don't want to rely on a
+    #       filename, bad mojo.
+
+    def go_figure_root(options, backtrace)
+      if o_file = options[:file]
+        return File.dirname(o_file)
+      elsif root = options[:root]
+        return root
+      end
+
+      pwd = Dir.pwd
 
-    return pwd if File.file?(File.join(pwd, 'start.rb'))
+      return pwd if File.file?(File.join(pwd, 'start.rb'))
+
+      caller_lines(backtrace) do |file, line, method|
+        dir, file = File.split(File.expand_path(file))
+        return dir if file == "start.rb"
+      end
 
-    caller_lines(backtrace) do |file, line, method|
-      dir, file = File.split(File.expand_path(file))
-      return dir if file == "start.rb"
+      Log.warn("Couldn't find your application root, see Innate#go_figure_root")
+
+      return nil
     end
 
-    return nil
-  end
+    # yields +file+, +line+, +method+
+    def caller_lines(backtrace)
+      backtrace.each do |line|
+        if line =~ /^(.*?):(\d+):in `(.*)'$/
+          file, line, method = $1, $2.to_i, $3
+        elsif line =~ /^(.*?):(\d+)$/
+          file, line, method = $1, $2.to_i, nil
+        end
 
-  # yields +file+, +line+, +method+
-  def caller_lines(backtrace)
-    backtrace.each do |line|
-      if line =~ /^(.*?):(\d+):in `(.*)'$/
-        file, line, method = $1, $2.to_i, $3
-      elsif line =~ /^(.*?):(\d+)$/
-        file, line, method = $1, $2.to_i, nil
+        yield(File.expand_path(file), line, method) if file and File.file?(file)
       end
-
-      yield(File.expand_path(file), line, method) if file and File.file?(file)
     end
   end
+
+  extend SingletonMethods
 end