serve 0.9.10 → 0.10.0

data/{History.txt → CHANGELOG.rdoc}

@@ -1,7 +1,16 @@
+== 0.10.0
+
+* Added additional view helper methods and harmonized the API a bit [aiwilliams]
+* Added support for using Serve as a Rails plugin [aiwilliams]
+* Added support for rack [ntalbott]
+* Dropped Hoe and Newgem in favor of Jeweler
+
 == 0.9.10 (October 25, 2008)
+
 * Updated to work with Haml 2.0.3. [jlong]
 
 == 0.9.9 (September 19, 2008)
+
 * Fixed ERB partial support. [jlong]
 * Added support for content_for blocks in ERB. [jlong]
 

data/{License.txt → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2007 John W. Long
+Copyright (c) 2007-2009 John W. Long and Adam I. Williams
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/{Quickstart.textile → QUICKSTART.rdoc}

@@ -1,104 +1,91 @@
-h1. Getting Started with Serve
+= Getting Started with Serve
 
 
+<b>This is tutorial is incomplete. Help us finish it!</b>
+
 Serve is a rapid prototyping framework for Rails applications. It is designed to compliment Rails development and enforce a strict separation of concerns between designer and developer. Using Serve with Rails allows the designer to happily work in his own space creating an HTML prototype of the application, while the developer works on the Rails application and copies over HTML from the prototype as needed. This allows the designer to focus on presentation and flow while the developer can focus on the implementation.
 
 Let's have a look at how it all works.
 
 
-h3. Installation
+== Installation
 
 To get started we need to download and install the Ruby gem for Serve:
 
-<pre>
-% sudo gem install serve
-</pre>
+ $ sudo gem install serve
 
 After we've done that it's probably a good idea to install a couple of additional gems so that Serve will play nicely with HAML, Markdown, and Textile:
 
-<pre>
-% sudo gem install haml Bluecloth Redcloth
-</pre>
+ $ sudo gem install haml Bluecloth Redcloth
 
 
-h3. Project Directory Structure
+== Project Directory Structure
 
 Once we have everything installed the next thing to do is setup the project directory. I like to setup my projects with the following directory structure:
 
-<pre>
-artwork      # Logos and other identity design files go here
-mockups      # Fireworks or Photoshop web app mockups go here
-prototype    # The HTML prototype for the web app goes here
-application  # The actual Rails application is here
-</pre>
+artwork      :: Logos and other identity design files go here
+mockups      :: Fireworks or Photoshop web app mockups go here
+prototype    :: The HTML prototype for the web app goes here
+application  :: The actual Rails application is here
 
 Let's go ahead and create the directory for the prototype:
 
-  % mkdir prototype
+ $ mkdir prototype
 
 Rails apps generally store images, javascripts, and stylesheets in the top level directories by the same name. Let's go ahead and mirror those directories for our prototype:
 
-<pre>
-% cd prototype
-% mkdir images
-% mkdir javascripts
-% mkdir stylesheets
-</pre>
-
+ $ cd prototype
+ $ mkdir images
+ $ mkdir javascripts
+ $ mkdir stylesheets
 
-h3. Creating Our First Screen
+== Creating Our First Screen
 
 Now that we have the prototype directory set up, let's create our first page so that you can get a feel for how Serve works. This will be a simple HTML login page for our application.
 
 Insert the following HTML into an file named "login.html.erb":
 
-<pre><code>
-<form action="/dashboard/" method="put">
-  <p>
-    <label for="username">Username</label>
-    <input type="text" name="username" id="username" />
-  </p>
-  <p>
-    <label for="password">Password</label>
-    <input type="password" name="password" id="password" />
-  </p>
-  <p>
-    <input type="submit" value="Login" />
-  </p>
-</form>
-</code></pre>
-
-
-h3. Starting Serve
+ <form action="/dashboard/" method="put">
+   <p>
+     <label for="username">Username</label>
+     <input type="text" name="username" id="username" />
+   </p>
+   <p>
+     <label for="password">Password</label>
+     <input type="password" name="password" id="password" />
+   </p>
+   <p>
+     <input type="submit" value="Login" />
+   </p>
+ </form>
+
+
+== Starting Serve
 
 To view our login page in a Web browser, we need to start up Serve in the directory where we are building the prototype:
 
-<pre>
-% cd prototype
-% serve
-[2008-02-23 15:19:05] INFO  WEBrick 1.3.1
-[2008-02-23 15:19:05] INFO  ruby 1.8.6 (2007-09-24) [universal-darwin9.0]
-[2008-02-23 15:19:05] INFO  Serve::Server#start: pid=5087 port=4000
-...
-</pre>
+ % cd prototype
+ % serve
+ [2008-02-23 15:19:05] INFO  WEBrick 1.3.1
+ [2008-02-23 15:19:05] INFO  ruby 1.8.6 (2007-09-24) [universal-darwin9.0]
+ [2008-02-23 15:19:05] INFO  Serve::Server#start: pid=5087 port=4000
+ ...
 
 Once you execute the `serve` command it will launch a mini Web server for the prototype and will output a noisy log of any activity. (To stop the command at any point simply switch back to the command line and press Ctrl+C.)
 
 By default the `serve` command automatically serves files from the directory that it is started in over port 4000 on your local machine. To access the the prototype in your Web browser go to:
 
-  http://localhost:4000
+ http://localhost:4000
 
 You should see a simple directory listing. It will look similar to this:
 
-<pre>
-Name                          Last modified         Size
-----------------------------------------------------------
-Parent Directory              2008/02/23 15:35      -
-images/                       2008/02/23 15:35      -
-javascripts/                  2008/02/23 15:35      -
-login.html.erb                2008/02/23 15:36      346
-stylesheets/                  2008/02/23 15:35      -
-</pre>
+ Name                          Last modified         Size
+ ----------------------------------------------------------
+ Parent Directory              2008/02/23 15:35      -
+ images/                       2008/02/23 15:35      -
+ javascripts/                  2008/02/23 15:35      -
+ login.html.erb                2008/02/23 15:36      346
+ stylesheets/                  2008/02/23 15:35      -
 
 Now navigate to the following URL:
 
@@ -107,23 +94,21 @@ Now navigate to the following URL:
 You should see the contents of the login page. Note that Serve allows you to refer to pages without their extension. This allows you to use URLs in your documents that correspond well to the URLs that Rails uses by default.
 
 
-h3. Layouts
+== Layouts
 
 One thing to note about the source that I gave you for the login page. I intentionally left out the <html>, <head>, and <body> tags because they belong a layout---not the source file. Let's go ahead and create that layout now.
 
 Insert the following HTML into a file named "_layout.html.erb" in the root directory of your prototype:
 
-<pre><code>
-<html>
-  <head>
-    <title><%= @title %></title>
-  </head>
-  <body>
-    <h1><%= @title %>/h1>
-    <%= yield %>
-  </body>
-</html>
-</code></pre>
+ <html>
+   <head>
+     <title><%= @title %></title>
+   </head>
+   <body>
+     <h1><%= @title %>/h1>
+     <%= yield %>
+   </body>
+ </html>
 
 This layout includes a small amount of ERB(Embedded Ruby) to indicate the title of the web page and to insert the content of the page at the appropriate point.
 
@@ -131,18 +116,14 @@ Embedded Ruby is delineated with the opening and closing sequence <% and %> resp
 
 We need to make one small change to our login page before continuing. Insert the following line at the top of login.html.erb file:
 
-<pre>
-<% @title = "Login" %>
-</pre>
+ <% @title = "Login" %>
 
 This will set the @title variable for the login page. Now, switch back to your Web browser and navigate to:
 
-<pre>
-http://localhost:4000/login/
-</pre>
+ http://localhost:4000/login/
 
 The page should now have a title and heading that both read "Login".
 
-h3. Content For
+== Content For
 
-h3. Partials
+== Partials

data/{README.txt → README.rdoc}

@@ -1,9 +1,9 @@
 == Serve
 
-Serve is a small Ruby script that makes it easy to start up a WEBrick server
-in any directory. Serve is ideal for HTML prototyping and simple file sharing.
-If the haml, redcloth, and bluecloth gems are installed serve can handle Haml,
-Sass, Textile, and Markdown (in addition to HTML and ERB).
+Serve is a small web server (based on WEBrick) that makes it easy to serve ERB
+or HAML from any directory. Serve is an ideal tool for building HTML
+prototypes of Rails applications. Serve can also handle SASS, Textile, and
+Markdown if the appropriate gems are installed.
 
 
 === Usage
@@ -61,7 +61,9 @@ redirect :: Redirects to the URL contained in the document
 
 == View Helpers
 
-If you drop a file called view_helpers.rb in the root of a project, you can define custom helpers for your Haml and ERB views. Just declare the ViewHelpers module and begin declaring your helpers:
+If you drop a file called view_helpers.rb in the root of a project, you can
+define custom helpers for your Haml and ERB views. Just declare the
+ViewHelpers module and begin declaring your helpers:
 
   module ViewHelpers
     def custom_method
@@ -95,11 +97,6 @@ All development now takes place on GitHub:
 
 === License
 
-Serve is released under the MIT license and is copyright (c) 2006-2008
-John W. Long. A copy of the MIT license can be found in the License.txt file.
-
-
-Enjoy!
-
---
-John Long :: http://wiseheartdesign.com
+Serve is released under the MIT license and is copyright (c) 2007-2009
+John W. Long and Adam I. Williams. A copy of the MIT license can be found in
+the LICENSE file.

data/Rakefile

@@ -1,13 +1,11 @@
-require 'config/requirements'
-require 'config/hoe' # setup Hoe + all gem configuration
-
-Dir['tasks/**/*.rake'].each { |rake| load rake }
-
-undefine_task %w(
-  default
-  test
-  test_deps
-  config_hoe
-)
-
-task :default => :spec
+require 'rubygems'
+require 'rake'
+
+load 'tasks/jeweler.rake'
+load 'tasks/rdoc.rake'
+load 'tasks/rspec.rake'
+load 'tasks/undefine.rake'
+
+#Dir['tasks/**/*.rake'].each { |rake| load rake }
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.10.0

data/bin/serve

@@ -1,10 +1,16 @@
 #!/usr/bin/env ruby
 lib = File.dirname(__FILE__) + '/../lib'
 require 'rubygems'
+
+gem 'activesupport'
+require 'active_support'
+
 if File.file?(lib + '/serve/version.rb')
   $LOAD_PATH << lib
 else
   gem 'serve'
 end
 require 'serve'
+require 'serve/application'
+
 Serve::Application.run

data/lib/serve.rb

@@ -1,7 +1,5 @@
-require 'webrick'
 require 'serve/version'
-require 'serve/application'
-require 'serve/webrick/extensions'
+require 'serve/file_resolver'
 require 'serve/handlers/file_type_handler'
 require 'serve/handlers/textile_handler'
 require 'serve/handlers/markdown_handler'
@@ -9,8 +7,4 @@ require 'serve/handlers/dynamic_handler'
 require 'serve/handlers/sass_handler'
 require 'serve/handlers/email_handler'
 require 'serve/handlers/redirect_handler'
-
-module Serve #:nodoc:
-  class Server < ::WEBrick::HTTPServer #:nodoc:
-  end
-end
+require 'serve/response_cache'

data/lib/serve/application.rb

@@ -1,3 +1,9 @@
+require 'webrick'
+require 'active_support'
+require 'serve/webrick/extensions'
+require 'serve/webrick/servlet'
+require 'serve/webrick/server'
+
 module Serve
   class Application
     class InvalidArgumentsError < StandardError; end
@@ -53,8 +59,9 @@ module Serve
       program = File.basename($0)
       [
         "Usage:",
-        "  #{program} [port] [environment] [port]",
-        "  #{program} [address:port] [environment] [port]",
+        "  #{program} [port] [environment] [directory]",
+        "  #{program} [address:port] [environment] [directory]",
+        "  #{program} [address] [port] [environment] [directory]",
         "  #{program} [options]",
         "  ",
         "Description:",
@@ -101,7 +108,7 @@ module Serve
       end
       
       def extract_port(args)
-        args.delete(args.find {|a| /^\d\d\d+$/.match(a) }) || (rails_app? ? 3000 : 4000)
+        (args.delete(args.find {|a| /^\d\d\d*$/.match(a) }) || (rails_app? ? 3000 : 4000)).to_i
       end
       
       def extract_address(args)
@@ -131,12 +138,12 @@ module Serve
       end
       
       def run_server
-        server = Serve::Server.new(
+        extensions = Serve::WEBrick::Server.register_handlers
+        server = Serve::WEBrick::Server.new(
           :Port => options[:port],
           :BindAddress => options[:address],
           :DocumentRoot => options[:root],
-          :DirectoryIndex => %w(index.html index.erb index.html.erb index.rhtml index.haml index.html.haml index.txt index.text index.textile index.markdown index.email index.redirect),
-          :AppendExtensions => %w(html txt text haml erb rhtml html.erb html.haml textile markdown email redirect)
+          :DirectoryIndex => %w(index.html index.rhtml index.txt index.text) + extensions.collect {|ext| "index.#{ext}"}
         )
         trap("INT") { server.shutdown }
         server.start

data/lib/serve/file_resolver.rb

@@ -0,0 +1,48 @@
+require 'active_support'
+
+module Serve
+  mattr_accessor :file_resolver
+  
+  class FileResolver
+    cattr_accessor :alternate_extensions
+    self.alternate_extensions = %w(html txt text haml erb rhtml html.erb html.haml textile markdown email redirect)
+    
+    def resolve(root, path)
+      return nil if path.nil?
+      path = File.join(path) # path may be array
+      return nil if path =~ /\.\./
+      path = path.sub(%r{/\Z}, '')
+      if path =~ /\.css\Z/ && !File.file?(File.join(root, path))
+        sass_path = path.sub(/\.css\Z/, '.sass')
+        sass_path if File.file?(File.join(root, sass_path))
+      elsif File.directory?(File.join(root, path))
+        resolve(root, File.join(path, 'index'))
+      else
+        resolve_with_extension(root, path)
+      end
+    end
+    
+    def resolve_with_extension(root, path)
+      full_path = File.join(root, path)
+      if File.file?(full_path)
+        path
+      else
+        if extension = find_extension(alternate_extensions, full_path)
+          "#{path}.#{extension}"
+        end
+      end
+    end
+    
+    def find_extension(extensions_to_try, full_path)
+      extensions_to_try.find do |ext|
+        File.file?("#{full_path}.#{ext}")
+      end
+    end
+  end
+  
+  self.file_resolver = FileResolver.new
+  
+  def self.resolve_file(root, path)
+    file_resolver.resolve(root, path)
+  end
+end

data/lib/serve/handlers/dynamic_handler.rb

@@ -1,24 +1,15 @@
 module Serve #:nodoc:
-  class Handler < FileTypeHandler #:nodoc:
+  class DynamicHandler < FileTypeHandler #:nodoc:
     extension 'erb', 'html.erb', 'rhtml', 'haml', 'html.haml'
     
-    def process(req, res)
-      class << req
-        alias headers header
-      end
-      res['content-type'] = content_type
-      res.body = parse(req, res)
+    def process(request, response)
+      response.headers['content-type'] = content_type
+      response.body = parse(request, response)
     end
     
-    def parse(req, res)
-      context = Context.new(req, res)
-      view_helpers_file_path = Dir.pwd + '/view_helpers.rb'
-      if File.file?(view_helpers_file_path)
-        (class << context; self end).module_eval(File.read(view_helpers_file_path))
-        class << context
-          include ViewHelpers
-        end
-      end
+    def parse(request, response)
+      context = Context.new(@root_path, request, response)
+      install_view_helpers(context)
       parser = Parser.new(context)
       context.content << parser.parse_file(@script_filename)
       layout = find_layout_for(@script_filename)
@@ -30,7 +21,7 @@ module Serve #:nodoc:
     end
     
     def find_layout_for(filename)
-      root = Dir.pwd
+      root = @root_path
       path = filename[root.size..-1]
       layout = nil
       until layout or path == "/"
@@ -44,6 +35,13 @@ module Serve #:nodoc:
       layout
     end
     
+    def install_view_helpers(context)
+      view_helpers_file_path = @root_path + '/view_helpers.rb'
+      if File.file?(view_helpers_file_path)
+        context.metaclass.module_eval(File.read(view_helpers_file_path) + "\ninclude ViewHelpers", view_helpers_file_path)
+      end
+    end
+    
     module ERB #:nodoc:
       class Engine #:nodoc:
         def initialize(string, options = {})
@@ -98,8 +96,8 @@ module Serve #:nodoc:
       attr_accessor :content, :parser
       attr_reader :request, :response
       
-      def initialize(req, res)
-        @request, @response = req, res
+      def initialize(root_path, request, response)
+        @root_path, @request, @response = root_path, request, response
         @content = ''
       end
       
@@ -143,11 +141,23 @@ module Serve #:nodoc:
           instance_variable_get("@content_for_#{symbol}")
         end
       end
-    
+      
+      # View helper methods
+      
+      HTML_ESCAPE = { '&' => '&amp;',  '>' => '&gt;',   '<' => '&lt;', '"' => '&quot;' }
+      def html_escape(s)
+        s.to_s.gsub(/[&"><]/) { |special| HTML_ESCAPE[special] }
+      end
+      alias h html_escape
+      
       def set_content_for(symbol, value)
         instance_variable_set("@content_for_#{symbol}", value)
       end
       
+      def params
+        request.params
+      end
+      
       # Render methods
       
       def render(options)
@@ -171,7 +181,7 @@ module Serve #:nodoc:
         path = File.dirname(parser.script_filename)
         if template =~ %r{^/}
           template = template[1..-1]
-          path = Dir.pwd
+          path = @root_path
         end
         filename = template_filename(File.join(path, template), :partial => options.delete(:partial))
         if File.file?(filename)