serve 1.0.0 → 1.1.0

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/bin/serve

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

data/lib/serve.rb

@@ -8,14 +8,11 @@ module Kernel
 end
 
 require 'serve/version'
-require 'serve/file_resolver'
+require 'serve/router'
 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/less_handler'
 require 'serve/handlers/email_handler'
 require 'serve/handlers/redirect_handler'
-require 'serve/handlers/static_handler'
-require 'serve/response_cache'
 require 'serve/rack'

data/lib/serve/application.rb

@@ -78,8 +78,9 @@ module Serve
         "  #{program} command [arguments] [options]",
         "  ",
         "Examples:",
-        "  #{program}                   # start server on port 4000",
-        "  #{program} 2100              # start server on port 2100",
+        "  #{program}                   # start Serve in current directory",
+        "  #{program} 2100              # start Serve on port 2100",
+        "  #{program} /path/to/project  # start Serve for a specific directory",
         "  #{program} create mockups    # create a Serve project in mockups directory",
         "  #{program} convert mockups   # convert a Compass project in mockups",
         "  ",
@@ -93,9 +94,9 @@ module Serve
         "  ",
         "    http://localhost:4000/",
         "  ",
-        "  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.",
+        "  If the haml, slim, redcloth, or bluecloth gems are installed the command can ",
+        "  handle Haml, Slim, Sass, SCSS, Textile, and Markdown for documents with haml, ",
+        "  slim, sass, scss, textile, and markdown file extensions.",
         "  ",
         "  If the Rails command script/server exists in the current directory the ",
         "  script will start that instead.",
@@ -216,7 +217,7 @@ module Serve
       end
       
       def run_rack_app
-        system "rackup -p #{options[:port]} -o #{options[:address]} -E #{options[:environment]} #{rack_config}"
+        system "rackup -p #{options[:port]} -o #{options[:address]} -E #{options[:environment]} '#{rack_config}'"
       end
       
       def run_server

data/lib/serve/handlers/dynamic_handler.rb

@@ -1,8 +1,19 @@
 require 'serve/view_helpers'
+require 'tilt'
 
 module Serve #:nodoc:
   class DynamicHandler < FileTypeHandler #:nodoc:
-    extension 'erb', 'html.erb', 'rhtml', 'haml', 'html.haml'
+    
+    def self.extensions
+      # Get extensions from Tilt, ugly but it works
+      @extensions ||= (Tilt.mappings.map { |k,v| ["#{k}", "html.#{k}"] } << ["slim", "html.slim"]).flatten
+    end
+    
+    def extensions
+      self.class.extensions
+    end
+    
+    extension *extensions
     
     def process(request, response)
       response.headers['content-type'] = content_type
@@ -28,7 +39,8 @@ module Serve #:nodoc:
       layout = nil
       until layout or path == "/"
         path = File.dirname(path)
-        possible_layouts = ['_layout.haml', '_layout.html.haml', '_layout.erb', '_layout.html.erb'].map do |l|
+        possible_layouts = extensions.map do |ext|
+          l = "_layout.#{ext}"
           possible_layout = File.join(root, path, l)
           File.file?(possible_layout) ? possible_layout : false
         end
@@ -44,54 +56,44 @@ module Serve #:nodoc:
       end
     end
     
-    module ERB #:nodoc:
-      class Engine #:nodoc:
-        def initialize(string, options = {})
-          @erb = ::ERB.new(string, nil, '-', '@erbout')
-          @erb.filename = options[:filename]
-        end
-        
-        def render(context, &block)
-          # we have to keep track of the old erbout variable for nested renders
-          # because ERB#result will set it to an empty string before it renders
-          old_erbout = context.instance_variable_get('@erbout')
-          result = @erb.result(context.instance_eval { binding })
-          context.instance_variable_set('@erbout', old_erbout)
-          result
-        end
-      end
-    end
-    
     class Parser #:nodoc:
-      attr_accessor :context, :script_filename
+      attr_accessor :context, :script_filename, :script_extension, :engine
       
       def initialize(context)
         @context = context
         @context.parser = self
       end
       
-      def parse_file(filename)
-        old_script_filename = @script_filename
+      def parse_file(filename, locals={})
+        old_script_filename, old_script_extension, old_engine = @script_filename, @script_extension, @engine
+        
         @script_filename = filename
-        lines = IO.read(filename)
-        engine = case File.extname(filename).sub(/^./, '').downcase
-          when 'haml'
-            require 'haml'
-            require 'sass'
-            require 'sass/plugin'
-            Haml::Engine.new(lines, :attr_wrapper => '"', :filename => filename)
-          when 'erb'
-            require 'erb'
-            ERB::Engine.new(lines, :filename => filename)
-          else
-            raise 'extension not supported'
+        
+        ext = File.extname(filename).sub(/^\.html\.|^\./, '').downcase
+        
+        if ext == 'slim' # Ugly, but works
+          if Thread.list.size > 1
+            warn "WARN: serve autoloading 'slim' in a non thread-safe way; " +
+                 "explicit require 'slim' suggested."
+          end
+          require 'slim'  
         end
-        result = engine.render(context) do |*args|
+        
+        @script_extension = ext
+        
+        @engine = Tilt[ext].new(filename, nil, :outvar => '@_out_buf')
+        
+        raise "#{ext} extension not supported" if @engine.nil?
+        
+        @engine.render(context, locals) do |*args|
           context.get_content_for(*args)
         end
+      ensure
         @script_filename = old_script_filename
-        result
+        @script_extension = old_script_extension
+        @engine = old_engine
       end
+      
     end
     
     class Context #:nodoc:
@@ -103,11 +105,7 @@ module Serve #:nodoc:
         @content = ''
       end
       
-      def _erbout
-        @erbout
-      end
-      
       include Serve::ViewHelpers
     end
   end
-end
+end

data/lib/serve/handlers/less_handler.rb

@@ -0,0 +1,19 @@
+module Serve #:nodoc:
+  
+  # TODO: Figure out how to remove the Less Handler in favor of Tilt
+  # The Less handler seems to be necessary to keep Tilt from applying a layout
+  # to Less files. Any one know how to turn this Tilt feature off?
+  
+  class LessHandler < FileTypeHandler #:nodoc:
+    extension 'less'
+    
+    def parse(string)
+      require 'less'
+      Less.parse(string)
+    end
+    
+    def content_type
+      'text/css'
+    end
+  end
+end

data/lib/serve/handlers/sass_handler.rb

@@ -1,4 +1,9 @@
 module Serve #:nodoc:
+  
+  # TODO: Figure out how to remove the Sass Handler in favor of Tilt
+  # The Sass handler seems to be necessary to keep Tilt from applying a layout
+  # to Sass files. Any one know how to turn this Tilt feature off?
+  
   class SassHandler < FileTypeHandler #:nodoc:
     extension 'sass', 'scss'
     

data/lib/serve/out.rb

@@ -3,6 +3,13 @@ module Serve #:nodoc:
   # Utility methods for handling output to the terminal
   module Out #:nodoc:
     
+    COLORS = {
+      :clear  => 0,
+      :red    => 31,
+      :green  => 32,
+      :yellow => 33
+    }
+    
     def stdout
       @stdout ||= $stdout
     end
@@ -24,7 +31,7 @@ module Serve #:nodoc:
     end
     
     def print(*args)
-      stderr.print(*args)
+      stderr.print(color_msg(:green, *args))
     end
     
     def log_action(name, message)
@@ -34,5 +41,16 @@ module Serve #:nodoc:
       puts message
     end
     
+    def color_msg(pigment, *args)
+      msg =  ''
+      msg << color(pigment)
+      msg << "#{args.join(' ')}"
+      msg << color(:clear)
+      msg
+    end
+    
+    def color(pigment)
+      "\e[#{COLORS[pigment.to_sym]}m"
+    end
   end
 end

data/lib/serve/project.rb

@@ -64,7 +64,7 @@ module Serve #:nodoc:
           views
         ).each { |path| make_path path }
         create_file 'config.ru',       read_template('config.ru')
-        create_file 'LICENSE',         read_template('LICENSE')
+        create_file 'LICENSE',         read_template('license')
         create_file '.gitignore',      read_template('gitignore')
         create_file 'compass.config',  read_template('compass.config')
         create_file 'README.markdown', read_template('README.markdown')
@@ -173,4 +173,4 @@ module Serve #:nodoc:
       end
       
   end
-end
+end

data/lib/serve/rack.rb

@@ -3,20 +3,35 @@ require 'rack'
 
 module Serve
   class Request < Rack::Request
+    # Returns a Hash of the query params for a request's URL.
     def query
       @query ||= Rack::Utils.parse_nested_query(query_string)
     end
     
+    # Returns the protocol part of the URL for a request: "http://", "https://", etc.
     def protocol
       @scheme ||= scheme + "://"
     end
     
+    # Returns a specialized hash of the headers on the request.
     def headers
       @headers ||= Headers.new(@env)
     end
+    
+    # Returns the value of the "REQUEST_URI" environment variable.
+    def request_uri
+      @env["REQUEST_URI"].to_s
+    end
+    
+    # Set the value of the "REQUEST_URI" environment variable.
+    def request_uri=(s)
+      @env["REQUEST_URI"] = s.to_s
+    end
   end
   
   class Response < Rack::Response
+    
+    # Set the body of a response.
     def body=(value)
       # needed for Ruby 1.9
       if value.respond_to? :each
@@ -25,9 +40,11 @@ module Serve
         super([value])
       end
     end
+    
   end
   
-  # Borrowed from ActionDispatch in Rails
+  # A specialized hash for the environment variables on a request.
+  # Borrowed from ActionDispatch in Rails.
   class Headers < Hash
     extend ActiveSupport::Memoizable
     
@@ -57,36 +74,59 @@ module Serve
   end
   
   class RackAdapter
+    
+    # Initialize a Rack endpoint for Serve with the root path to
+    # the views directory.
     def initialize(root)
       @root = root
     end
     
+    # Called by Rack to process a request.
     def call(env)
       request = Request.new(env)
       response = Response.new()
       process(request, response).to_a
     end
     
-    def process(request, response)
-      path = Serve.resolve_file(@root, request.path)
-      if path
-        ext = File.extname(path)[1..-1]
-        handler = Serve::FileTypeHandler.handlers[ext]
-        if handler
-          handler.new(@root, path).process(request, response)
-          response
+    protected
+      
+      # Process the request and response. Paths are transformed so that
+      # URLs without extensions and directory indexes work.
+      def process(request, response)
+        path = Serve::Router.resolve(@root, request.path_info)
+        if path
+          # Fetch the file handler for a file with a given extension/
+          ext = File.extname(path)[1..-1]
+          handler = Serve::FileTypeHandler.handlers[ext]
+          if handler
+            # Handler exists? Process the request and response.
+            handler.new(@root, path).process(request, response)
+            response
+          else
+            # Handler doesn't exist? Rewrite the request to use the new path.
+            # This allows Rack::Cascade or Passenger to deliver a file that is
+            # not handled by one of the Serve handlers.
+            rewrite(request, response, path)
+          end
         else
-          default(request, response)
+          # Return a 404 response.
+          not_found(request, response)
         end
-      else
-        default(request, response)
       end
-    end
+      
+      # Returns a 404 response.
+      def not_found(request, response)
+        response.status = 404
+        response.body = "Not found!"
+        response
+      end
+      
+      # Rewrite the request to use a new path. Return a 404 response so that Rack::Cascade works.
+      def rewrite(request, response, path)
+        request.request_uri = path + request.query_string
+        request.path_info = path
+        not_found(request, response)
+      end
     
-    def default(request, response)
-      response.status = 404
-      response.body = "Not found!"
-      response
-    end
   end
 end

data/lib/serve/router.rb

@@ -0,0 +1,43 @@
+module Serve
+  module Router
+    
+    # Resolve a path to a valid file name in root path. Return nil if no
+    # file exists for that path.
+    def self.resolve(root, path)
+      path = normalize_path(path)
+      
+      return if path.nil? # If it's not a valid path, return nothing.
+      
+      full_path = File.join(root, path)
+      
+      case
+      when File.file?(full_path)
+        # A file exists! Return the matching path.
+        path
+      when File.directory?(full_path) 
+        # It's a directory? Try a directory index.
+        resolve(root, File.join(path, 'index'))
+      when path.ends_with?('.css')
+        # CSS not found? Try SCSS or Sass.
+        alternates = %w{.scss .sass}.map { |ext| path.sub(/\.css\Z/, ext) }
+        sass_path = alternates.find do |p|
+          File.file?(File.join(root, p))
+        end      
+      else
+        # Still no luck? Check to see if a file with an extension exists by that name.
+        # TODO: Return a path with an extension based on priority, not just the first found.
+        result = Dir.glob(full_path + ".*", File::FNM_CASEFOLD).first
+        result.sub(/^#{root}/, '').sub(/^\//, '') if result && File.file?(result)
+      end
+    end
+    
+    private
+      
+      def self.normalize_path(path)
+        path = File.join(path)       # path may be array
+        path = path.sub(%r{/\Z}, '') # remove trailing slash
+        path unless path =~ /\.\./   # guard against evil paths
+      end
+      
+  end
+end