fivepointssolutions-serve 0.9.11

data/History.txt

@@ -0,0 +1,52 @@
+== 0.9.11 (??)
+* Made to work as a Rails GemPlugin [aiwilliams]
+* Caches responses using the Radiant ResponseCache when used as a Rails plugin [aiwilliams]
+* Managing gem using jeweler [aiwilliams]
+
+== 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]
+
+== 0.9.8 (July 18, 2008)
+
+* Added experimental support for ERB layouts. [Lawjoskar]
+
+== 0.9.7 (July 17, 2008)
+
+* Added experimental support for view helpers. [aiwilliams]
+* Added limited support for ERB. Layouts are not yet supported. [jlong]
+
+== 0.9.6 (February 20, 2008)
+
+* Changed default port to 4000 so that serve plays nicely with Rails apps.
+* Rearranged source.
+
+== 0.9.5 (February 19, 2008)
+
+* Added support for rendering other files with the following syntax:
+
+  render :template => "template_name"
+
+== 0.9.4 (January 31, 2008)
+
+* Small fix for calculating the partial name in render_partial.
+
+== 0.9.3 (January 23, 2008)
+
+* Added support for layouts and partials for HAML documents.
+
+== 0.9.2 (January 17, 2008)
+
+* Added support for redirects.
+
+== 0.9.1 (October 19, 2007)
+
+* Added basic support for email mockups.
+* Updated description and help text.
+
+== 0.9.0 (September 25, 2007)
+
+* Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 John W. Long
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Quickstart.textile

@@ -0,0 +1,148 @@
+h1. Getting Started with Serve
+
+
+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
+
+To get started we need to download and install the Ruby gem for Serve:
+
+<pre>
+% sudo gem install serve
+</pre>
+
+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>
+
+
+h3. 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>
+
+Let's go ahead and create the directory for the 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>
+
+
+h3. 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
+
+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>
+
+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
+
+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>
+
+Now navigate to the following URL:
+
+  http://localhost:4000/login/
+
+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
+
+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>
+
+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.
+
+Embedded Ruby is delineated with the opening and closing sequence <% and %> respectively. Sequences that begin with an addition equals sign insert their output directly into the HTML. In this case we want to render the @title variable as the title in the head and as the first heading in the document body. The yield keyword is used to insert the content of the page at that point.
+
+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>
+
+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>
+
+The page should now have a title and heading that both read "Login".
+
+h3. Content For
+
+h3. Partials

data/README.txt

@@ -0,0 +1,105 @@
+== 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).
+
+
+=== Usage
+
+At a command prompt all you need to type to start serve is:
+
+  $ serve
+
+This will launch a WEBrick server which you can access from any Web browser at
+the following address:
+
+  http://localhost:4000
+
+Once the server is going it will output a running log of its activity. To
+stop the server at any time, type CTRL+C at the command prompt. By default the
+serve command serves up files from the current directory. To change this
+behavior, `cd` to the appropriate directory before starting serve.
+
+
+=== Advanced Options
+
+The serve command automatically binds to 0.0.0.0 (localhost) and uses port
+4000 by default. To serve files over a different IP (that is bound to your
+computer) or port specify those options on the command line:
+
+  $ serve 4000               # a custom port
+
+  $ serve 192.168.1.6        # a custom IP
+
+  $ serve 192.168.1.6:4000   # a custom IP and port
+
+
+=== Rails Applications
+
+For your convenience if the file "script/server" exists in the current
+directory the serve command will start that instead of launching a WEBrick
+server. You can specify the environment that you want to start the server
+with as an option on the command line:
+
+  $ serve production         # start script/server in production mode
+
+
+=== File Types
+
+Serve presently does special processing for files with following extensions:
+
+textile :: Evaluates the document as Textile (requires the Redcloth gem) 
+markdown :: Evaluates the document as Markdown (requires the Bluecloth gem)
+erb :: Experimental support for ERB
+haml :: Evaluates the document as Haml (requires the Haml gem)
+sass :: Evaluates the document as Sass (requires the Haml gem)
+email :: Evaluates the document as if it is an e-mail message; the format is identical to a plain/text e-mail message's source
+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:
+
+  module ViewHelpers
+    def custom_method
+      "Request object: #{request.headers['user-agent']}"
+    end
+  end
+
+
+=== Installation and Setup
+
+It is recommended that you install serve via RubyGems:
+
+  $ sudo gem install serve
+
+
+=== More Information
+
+For more information, be sure to look through the documentation over at
+RubyForge:
+
+* http://serve.rubyforge.org
+
+Or visit the project page here:
+
+* http://rubyforge.org/projects/serve
+
+All development now takes place on GitHub:
+
+* http://github.com/jlong/serve
+
+
+=== 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

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 9
+:patch: 11
+:major: 0

data/bin/serve

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

data/lib/serve.rb

@@ -0,0 +1,10 @@
+require 'serve/version'
+require 'serve/file_resolver'
+require 'serve/handlers/file_type_handler'
+require 'serve/handlers/textile_handler'
+require 'serve/handlers/markdown_handler'
+require 'serve/handlers/dynamic_handler'
+require 'serve/handlers/sass_handler'
+require 'serve/handlers/email_handler'
+require 'serve/handlers/redirect_handler'
+require 'serve/response_cache'

data/lib/serve/application.rb

@@ -0,0 +1,150 @@
+require 'webrick'
+require 'serve/webrick/extensions'
+require 'serve/webrick/servlet'
+require 'serve/webrick/server'
+
+module Serve
+  class Application
+    class InvalidArgumentsError < StandardError; end
+    
+    attr_accessor :options
+    
+    def self.run(args = ARGV)
+      new.run(args)
+    end
+    
+    def initialize
+      self.options = {}
+    end
+    
+    def run(args = ARGV)
+      @options = parse(args)
+      case
+      when options[:version]
+        puts version
+      when options[:help]
+        puts help
+      else
+        Dir.chdir(options[:root])
+        if rails_app?
+          run_rails_app
+        else
+          run_server
+        end
+      end
+    rescue InvalidArgumentsError
+      puts "invalid arguments"
+      puts
+      puts help
+    end
+    
+    def parse(args)
+      args = normalize_args(args)
+      options[:help]        = extract_boolean(args, '-h', '--help')
+      options[:version]     = extract_boolean(args, '-v', '--version')
+      options[:environment] = extract_environment(args)
+      options[:root]        = extract_root(args)
+      options[:address]     = extract_address(args)
+      options[:port]        = extract_port(args)
+      raise InvalidArgumentsError if args.size > 0
+      options
+    end
+    
+    def version
+      "Serve #{Serve.version}"
+    end
+    
+    def help
+      program = File.basename($0)
+      [
+        "Usage:",
+        "  #{program} [port] [environment] [port]",
+        "  #{program} [address:port] [environment] [port]",
+        "  #{program} [options]",
+        "  ",
+        "Description:",
+        "  Starts a WEBrick server on the specified address and port with its document ",
+        "  root set to the current working directory. (Optionally, you can specify the ",
+        "  directory as the last parameter.) By default the command uses 0.0.0.0 for ",
+        "  the address and 4000 for the port. This means that once the command has ",
+        "  been started you can access the documents in the current directory with any ",
+        "  Web browser at:",
+        "  ",
+        "    http://localhost:4000/",
+        "  ",
+        "  If the haml, redcloth, or bluecloth gems are installed the command can serve ",
+        "  Haml, Sass, Textile, and Markdown for documents with haml, sass, textile, ",
+        "  and markdown file extensions.",
+        "  ",
+        "  If the Rails command script/server exists in the current directory the ",
+        "  script will start that instead with the specified environment or the ",
+        "  development environment if none is specified. Rails apps are started by ",
+        "  default on port 3000.",
+        "  ",
+        "Options:",
+        "  -h, --help      Show this message and quit.",
+        "  -v, --version   Show the program version number and quit."
+      ].join("\n")
+    end
+    
+    private
+      def normalize_args(args)
+        args = args.join(' ')
+        args.gsub!(%r{http://}, '')
+        args.split(/[ :]/).compact
+      end
+      
+      def extract_boolean(args, *opts)
+        opts.each do |opt|
+          return true if args.delete(opt)
+        end
+        false
+      end
+      
+      def extract_environment(args)
+        args.delete('production') || args.delete('test') || args.delete('development') || 'development'
+      end
+      
+      def extract_port(args)
+        args.delete(args.find {|a| /^\d\d\d+$/.match(a) }) || (rails_app? ? 3000 : 4000)
+      end
+      
+      def extract_address(args)
+        args.delete(args.find {|a| /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/.match(a) }) || '0.0.0.0'
+      end
+      
+      def extract_root(args)
+        args.reverse.each do |dir|
+          if File.directory?(dir)
+            args.delete(dir)
+            return File.expand_path(dir)
+          end
+        end
+        Dir.pwd
+      end
+      
+      def rails_script_server
+        @rails_server_script ||= options[:root] + '/script/server'
+      end
+      
+      def rails_app?
+        File.file?(rails_script_server) and File.executable?(rails_script_server)
+      end
+      
+      def run_rails_app
+        system "#{rails_script_server} -p #{options[:port]} -b #{options[:address]} -e #{options[:environment]}"
+      end
+      
+      def run_server
+        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.rhtml index.txt index.text) + extensions.collect {|ext| "index.#{ext}"}
+        )
+        trap("INT") { server.shutdown }
+        server.start
+      end
+  end
+end