serve 0.11.7 → 1.0.0

data/CHANGELOG.rdoc

@@ -1,5 +1,17 @@
 = Change Log
 
+== 1.0.0 (November 3, 2010)
+
+* Various tweaks and fixes [jlong]
+* Added `serve convert` command for converting Compass projects. [revans]
+* Added `serve create` command for bootstrapping projects. See README for details. Yay! [revans]
+* Added option to use Thin if Mongrel isn't installed [benatkin] 
+
+== 0.11.7 (July 22, 2010)
+
+* Use latest version of Rack
+* Use Mongrel instead of Webrick by default
+
 == 0.11.6 (June 13, 2010)
 
 * Support for activesupport 3.x [railsjedi]

data/Gemfile

@@ -1,14 +1,19 @@
-source "http://gemcutter.org"
+source "http://rubygems.org"
 
-gem "jeweler"
-gem "rake"
-gem "rspec", "1.3.0"
-gem "rack", "1.1.0"
+gem 'rake',             '~> 0.8.7'
+gem 'rack',             '~> 1.2.1'
 
 # activesupport 2.x
-# gem "activesupport", "2.3.5"
+# gem 'activesupport', '2.3.5'
 
-# activesupport 3.x
-gem "activesupport", ">= 3.0.0.beta"
-gem "tzinfo"
-gem "i18n"
+# activesupport 3.0.x
+gem 'activesupport',    '~> 3.0.1'
+gem 'tzinfo',           '~> 0.3.23'
+gem 'i18n',             '~> 0.4.2'
+
+group :development do
+  gem 'jeweler',        '~> 1.4.0'
+  gem 'haml',           '~> 3.0.23'
+  gem 'compass',        '~> 0.10.6'
+  gem 'rspec',          '~> 2.0.1'
+end

data/Gemfile.lock

@@ -1,31 +1,45 @@
 GEM
-  remote: http://gemcutter.org/
+  remote: http://rubygems.org/
   specs:
-    activesupport (3.0.0.beta4)
-    gemcutter (0.5.0)
-      json_pure
+    activesupport (3.0.1)
+    compass (0.10.6)
+      haml (>= 3.0.4)
+    diff-lcs (1.1.2)
+    gemcutter (0.6.1)
     git (1.2.5)
-    i18n (0.4.1)
+    haml (3.0.23)
+    i18n (0.4.2)
     jeweler (1.4.0)
       gemcutter (>= 0.1.0)
       git (>= 1.2.5)
       rubyforge (>= 2.0.0)
-    json_pure (1.4.3)
-    rack (1.1.0)
+    json_pure (1.4.6)
+    rack (1.2.1)
     rake (0.8.7)
-    rspec (1.3.0)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
     rubyforge (2.0.4)
       json_pure (>= 1.1.7)
-    tzinfo (0.3.22)
+    tzinfo (0.3.23)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (>= 3.0.0.beta)
-  i18n
-  jeweler
-  rack (= 1.1.0)
-  rake
-  rspec (= 1.3.0)
-  tzinfo
+  activesupport (~> 3.0.1)
+  compass (~> 0.10.6)
+  haml (~> 3.0.23)
+  i18n (~> 0.4.2)
+  jeweler (~> 1.4.0)
+  rack (~> 1.2.1)
+  rake (~> 0.8.7)
+  rspec (~> 2.0.1)
+  tzinfo (~> 0.3.23)

data/LICENSE

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

data/README.rdoc

@@ -1,6 +1,7 @@
 = Serve - A Rapid Prototyping Framework for Web Applications
 
-Serve is a small Rack-based web server that makes it easy to serve HTML, ERB, or HAML from any directory.
+Serve is a small Rack-based web server that makes it easy to serve HTML, ERB,
+or HAML from any directory.
 
 But Serve is much more than a simple web server.
 
@@ -35,7 +36,8 @@ appropriate libraries are installed.
 
 == Installation
 
-Serve is distributed as a Ruby gem and can be installed from the command prompt. Just type:
+Serve is distributed as a Ruby gem and can be installed from the command
+prompt. Just type:
 
   gem install serve
 
@@ -53,7 +55,8 @@ You may also want to google "command prompt windows" if you are on a PC or
 
 == Usage
 
-Once the gem is installed the `serve` command will be available from the command prompt. To launch Serve, just type the command and press enter:
+Once the gem is installed the `serve` command will be available from the
+command prompt. To launch Serve, just type the command and press enter:
 
   serve
 
@@ -65,7 +68,8 @@ at the following address:
 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 or pass the directory as the final parameter to the command:
+behavior, `cd` to the appropriate directory before starting serve or pass the
+directory as the final parameter to the command:
 
   serve project_directory
 
@@ -80,57 +84,83 @@ computer) or port specify those options on the command line:
   serve 192.168.1.6:4000   # a custom IP and port
 
 For your convenience if the file "script/server" exists in the current
-directory the serve command will start that instead of launching a WEBrick
+directory the serve command will start that instead of launching a Ruby Web
 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
 
 
-== Rack and Passenger
+== Creating a New Serve Project
 
-Advanced users may also want to run Serve as a Rack application. To do this
-you will need to create a "config.ru" file in the root of your Serve project.
-Here is an example "config.ru" file:
+For simple projects, you don't need to structure your files in a specific
+way. All ERB, Haml, and Sass files will be processed wherever they are found
+in the project root. But for more complex projects you may want to use Serve
+with a `config.ru` file so that you can take advantage of other Rack
+middleware and structure the project in a Rack compatible way.
 
-  #\ -p 4000
-  
-  gem 'activesupport/all'
-  gem 'serve'
-  
-  require 'serve'
-  require 'serve/rack'
-  
-  # Middleware
-  use Rack::ShowStatus      # Nice looking 404s and other messages
-  use Rack::ShowExceptions  # Nice looking errors
-  
-  # The project root directory
-  root = File.dirname(__FILE__)  
-  
-  # Rack Application
-  run Rack::Cascade.new([
-    Serve::RackAdapter.new(root),  # Handle ERB, HAML, and other Serve files
-    Rack::Directory.new(root)      # Directory listings and everything else
-  ])
+To create a new Rack-based Serve project in the "mockups" directory, type the
+following on the command line:
+
+  serve create mockups   # create a new project in the mockups directory
+
+This will create a new project with the following directory structure:
+
+  mockups/
+    |
+    +-- config.ru              # Rack configuration file
+    |
+    +-- compass.config         # Compass configuration file
+    |
+    +-- public/                # Directories for static assets
+    |    |
+    |    +-- stylesheets/      # Compiled stylesheets
+    |    |
+    |    +-- images/
+    |    |
+    |    `-- javascripts/
+    |
+    +-- sass/                  # Store Sass source files here
+    |    |
+    |    `-- application.sass  # Example Sass file for application
+    |
+    +-- tmp/                   # Needed for Passenger (mod_passenger)
+    |    |
+    |    `-- restart.txt
+    |
+    `-- views/                 # Store your ERB, Haml, etc. here
+         |
+         +-- _layout.html.erb  # Example layout
+         |
+         +-- hello.html.erb    # Example view
+         |
+         `-- view_helpers.rb   # Example view helpers
+
+If you would like to generate the project with a specific JavaScript framework
+you can do so with the <tt>-j</tt> flag:
+
+  serve create mockups -j prototype
+
+Available frameworks are: <tt>jquery</tt>, <tt>jquery-ui</tt>,
+<tt>mootools</tt>, <tt>prototype</tt>, and <tt>scriptaculous</tt>.
+
+The `serve create` command can be executed multiple times or on an existing
+project without negative consequences.
+
+
+== Upgrading a Compass Project to a Serve Project
 
-Assuming that you have Rack installed, you will then be able to start your
-application with the `rackup` command. Type `rackup --help` for more
-information.
+If you are a Compass user you can convert an existing Compass project to a
+Serve project with the "convert" sub-command:
 
-If you would like to run Serve as a Rack application with Passenger you will
-need to create two additional directories: "tmp" and "public". In the temp
-directory put an empty "restart.txt" file. In the public directory put your
-static assets like images and javascripts (anything that does not require
-special processing by Serve). You may also want to replace the last four lines of "config.ru" with a single reference to the Serve::RackAdapter:
+  serve convert mockups
 
-  run Serve::RackAdapter.new(root)
+This will rename and move a number of files for you and will turn your Compass
+project into a Serve project.
 
-By default, Passenger applications serve static assets from the "public"
-directory so there is no need to use the Rack::Directory application to handle
-those. If you need directory listings your Web server probably provides
-something specifically for this purpose and there is no need to rely on Rack
-for this.
+Note that after upgrading a Compass project, you will no longer need to use
+the `compass watch` command to generate your stylesheets. Your stylesheets
+will be compiled on the fly with Serve.
 
 
 == File Types
@@ -149,7 +179,7 @@ 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
+If you drop a file called "view_helpers.rb" in your views directory, you can
 define custom helpers for your Haml and ERB views. Just create a ViewHelpers
 module and define your helper methods there:
 
@@ -159,7 +189,8 @@ module and define your helper methods there:
     end
   end
 
-Helpers have full access to the request and response objects so you can
+Helpers have full access to the request and response objects so you can easily
+read and manipulate headers.
 
 
 == More Information
@@ -177,5 +208,5 @@ http://github.com/jlong/serve
 == License
 
 Serve is released under the MIT license and is copyright (c) 2007-2010
-John W. Long and Adam I. Williams. A copy of the MIT license can be found in 
-the LICENSE file.
+John W. Long and Adam I. Williams. Portions have been contributed by Robert
+Evans and others. A copy of the MIT license can be found in the LICENSE file.

data/Rakefile

@@ -6,6 +6,4 @@ load 'tasks/rdoc.rake'
 load 'tasks/rspec.rake'
 load 'tasks/undefine.rake'
 
-#Dir['tasks/**/*.rake'].each { |rake| load rake }
-
-task :default => :spec
+task :default => :spec

data/VERSION

@@ -1 +1 @@
-0.11.7
+1.0.0

data/lib/serve/application.rb

@@ -18,6 +18,12 @@ module Serve
     def run(args = ARGV)
       @options = parse(args)
       case
+      when options[:create]
+        require 'serve/project'
+        Serve::Project.new(options[:create]).create
+      when options[:convert]
+        require 'serve/project'
+        Serve::Project.new(options[:convert]).convert
       when options[:version]
         puts version
       when options[:help]
@@ -43,6 +49,8 @@ module Serve
       args = normalize_args(args)
       options[:help]        = extract_boolean(args, '-h', '--help')
       options[:version]     = extract_boolean(args, '-v', '--version')
+      options[:create]      = extract_creation(args)
+      options[:convert]     = extract_conversion(args)
       options[:environment] = extract_environment(args)
       options[:root]        = extract_root(args)
       options[:address]     = extract_address(args)
@@ -58,23 +66,34 @@ module Serve
     def help
       program = File.basename($0)
       [
+        "Serve is a rapid prototyping framework for Web applications. This is a basic ",
+        "help message containing pointers to more information.",
+        "  ",
         "Usage:",
+        "  #{program} -h/--help",
+        "  #{program} -v/--version",
         "  #{program} [port] [environment] [directory]",
         "  #{program} [address:port] [environment] [directory]",
         "  #{program} [address] [port] [environment] [directory]",
-        "  #{program} [options]",
+        "  #{program} command [arguments] [options]",
+        "  ",
+        "Examples:",
+        "  #{program}                   # start server on port 4000",
+        "  #{program} 2100              # start server on port 2100",
+        "  #{program} create mockups    # create a Serve project in mockups directory",
+        "  #{program} convert mockups   # convert a Compass project in mockups",
         "  ",
         "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 ",
+        "  Starts a web 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:",
+        "  web browser at:",
         "  ",
         "    http://localhost:4000/",
         "  ",
-        "  If the haml, redcloth, or bluecloth gems are installed the command can serve ",
+        "  If the haml, redcloth, or bluecloth gems are installed the command can handle ",
         "  Haml, Sass, SCSS, Textile, and Markdown for documents with haml, sass, scss, ",
         "  textile, and markdown file extensions.",
         "  ",
@@ -82,15 +101,31 @@ module Serve
         "  script will start that instead.",
         "  ",
         "  If a Rack configuration file (config.ru) exists in the current directory the ",
-        "  script will start that using the rackup command.",
+        "  script will start that using the `rackup` command.",
         "  ",
         "  A Rails or Rack app will start with the environment specified or the ",
         "  development environment if none is specified. Rails and Rack apps are ",
         "  started by default on port 3000.",
         "  ",
+        "Additional Commands:",
+        "  In addition the functionality listed above the following commands are ",
+        "  supported by Serve.",
+        "  ",
+        "  create",
+        "    Creates a new Rack-based Serve project with support for Haml, Sass, and",
+        "    Compass with the appropriate directory structure and configuration files.",
+        "  ",
+        "  convert",
+        "    Converts an existing Compass project into a Rack-based Serve project.",
+        "   ",
         "Options:",
-        "  -h, --help      Show this message and quit.",
-        "  -v, --version   Show the program version number and quit."
+        "  -j, --javascript  The name of the JavaScript Framework you'd like to use.",
+        "                    (Only valid for create and convert commands.)",
+        "  -h, --help        Show this message and quit.",
+        "  -v, --version     Show the program version number and quit.",
+        "  ",
+        "Further information:",
+        "  http://github.com/jlong/serve/blob/master/README.rdoc"
       ].join("\n")
     end
     
@@ -130,6 +165,36 @@ module Serve
         Dir.pwd
       end
       
+      def extract_javascript_framework(args, *opts)
+        framework = nil
+        opts.each do |opt|
+          framework = args.pop if args.delete(opt)
+        end
+        framework
+      end
+      
+      def extract_creation(args)
+        if args.delete('create')
+          framework = extract_javascript_framework(args, '-j', '--javascript')
+          args.reverse!
+          {
+           :framework => framework,
+           :name      => (args.first ? args.pop : 'mockups'),
+           :directory => (args.first ? File.expand_path(args.pop) : Dir.pwd)
+          }
+        end
+      end
+      
+      def extract_conversion(args)
+        if args.delete('convert')
+          framework = extract_javascript_framework(args, '-j', '--javascript')
+          {
+           :directory => (args.first ? File.expand_path(args.pop) : Dir.pwd),
+           :framework => framework 
+          }
+        end
+      end
+      
       def rails_script_server
         @rails_server_script ||= options[:root] + '/script/server'
       end
@@ -165,10 +230,28 @@ module Serve
             Rack::Directory.new(root)
           ])
         end
-        mongrel = Rack::Handler.get('mongrel')
-        mongrel.run app, :Port => options[:port], :Host => options[:address] do |server|
-          puts "Mongrel #{Mongrel::Const::MONGREL_VERSION} available at #{options[:address]}:#{options[:port]}"
+        begin
+          # Try Thin
+          thin = Rack::Handler.get('thin')
+          thin.run app, :Port => options[:port], :Host => options[:address] do |server|
+            puts "Thin #{Thin::VERSION::STRING} available at http://#{options[:address]}:#{options[:port]}"
+          end
+        rescue LoadError
+          begin
+            # Then Mongrel
+            mongrel = Rack::Handler.get('mongrel')
+            mongrel.run app, :Port => options[:port], :Host => options[:address] do |server|
+              puts "Mongrel #{Mongrel::Const::MONGREL_VERSION} available at http://#{options[:address]}:#{options[:port]}"
+            end
+          rescue LoadError
+            # Then WEBrick
+            puts "Install Mongrel or Thin for better performance."
+            webrick = Rack::Handler.get('webrick')
+            webrick.run app, :Port => options[:port], :Host => options[:address] do |server|
+              trap("INT") { server.shutdown }
+            end
+          end
         end
       end
   end
-end
+end