heel 0.4.0 → 0.5.0

data/CHANGES

@@ -1,4 +1,14 @@
 = Changelog
+== Version 0.5.0 - 2007-11-19
+
+* Add in code highlighting support via coderay
+* extract CSS files to a resource
+* increase test coverage
+
+== Version 0.4.1 - 2007-11-15
+
+* Fix bug [#15645] - not starting up on windows
+
 == Version 0.4.0 - 2007-11-04
 
 * Added common log format output to terminal or logfile as appropriate.

data/README

@@ -10,19 +10,51 @@ Heel is a small static file web server based on {mongrel}[http://mongrel.rubyfor
 for use when you need a quick web server for a directory.  Once the server is running heel will use
 {launchy}[http://copiousfreetime.rubyforge.org/launchy/] to open your browser at the URL of your document root.
 
+    % heel 
+    ** Signals ready.  TERM => stop.  USR2 => restart.  INT => stop (no restart).
+    ** heel running at http://127.0.0.1:4331 with document root /Users/jeremy/Projects/heel
+    ** Use Ctrl-C to stop.
+    ** Launching your browser...
+    127.0.0.1 - - [19/Nov/2007:23:23:33 MST] "GET / HTTP/1.1" 200 8374
+    127.0.0.1 - - [19/Nov/2007:23:23:33 MST] "GET /css/listing.css HTTP/1.1" 200 984
+    127.0.0.1 - - [19/Nov/2007:23:23:33 MST] "GET /icons/application.png HTTP/1.1" 200 464
+    127.0.0.1 - - [19/Nov/2007:23:23:33 MST] "GET /icons/folder.png HTTP/1.1" 200 537
+    127.0.0.1 - - [19/Nov/2007:23:23:33 MST] "GET /favicon.ico HTTP/1.1" 404 0
+
+Or run it in the background
+
+    % heel --daemonize
+    Created /Users/jeremy/.heel
+    heel's PID (/Users/jeremy/.heel/heel.pid) and log file (/Users/jeremy/.heel/heel.log) are stored here
+
+    % heel --kill
+    Sending TERM to process 1086
+    Done.
+
+== FEATURES
+
+* Automatic launching of your browser to the URL it is serving with {launchy}[http://copiousfreetime.rubyforge.org/launchy/]
+* Automatic syntax highlighting of source code files with {coderay}[http://coderay.rubychan.de/]
+* Run in the foreground or daemonized
+* Bind to any address and port (default is 127.0.0.1:4331)
+
 == SYNOPSIS:
 
 	Usage: heel [options]
 
 	    -a, --address ADDRESS            Address to bind to
-	                                     (default: 0.0.0.0)
+	                                       (default: 127.0.0.1)
 	    -d, --daemonize                  Run daemonized in the background
 	    -h, --help                       Display this text
 	    -k, --kill                       Kill an existing daemonized heel process
+	        --[no-]highlighting          Turn on or off syntax highlighting
+	                                       (default: on)
+	        --[no-]launch-browser        Turn on or off automatic browser launch
+	                                       (default: on)
 	    -p, --port PORT                  Port to bind to
-	                                     (default: 4331)
+	                                       (default: 4331)
 	    -r, --root ROOT                  Set the document root
-	                                      (default: current working directory)
+	                                       (default: current working directory)
 	    -v, --version                    Show version
 
 
@@ -30,15 +62,16 @@ for use when you need a quick web server for a directory.  Once the server is ru
 
 === For running: 
 
-* mongrel
+* {coderay}[http://coderay.rubychan.de/]
 * {launchy}[http://copiousfreetime.rubyforge.org/launchy/] >= 0.1.1
-* mime-types
+* {mime-types}[http://mime-types.rubyforge.org/]
+* {mongrel}[http://mongrel.rubyforge.org/]
+* {rake}[http://rake.rubyforge.org/] >= 0.7.1
 
 === For development:
 
-* rake >= 0.7.1
-* rcov >= 0.7.0.1
-* rspec  >= 0.7.3
+* {rcov}[http://eigenclass.org/hiki.rb?rcov] >= 0.7.0.1
+* {rspec}[http://rspec.rubyforge.org/]  >= 0.7.3
 
 == INSTALL:
 
@@ -49,7 +82,7 @@ for use when you need a quick web server for a directory.  Once the server is ru
 * Zed Shaw for {mongrel}[http://mongrel.rubyforge.org]
 * http://www.famfamfam.com/ for amazing icons
 
-== LICENSE:
+== BSD LICENSE:
 
 Copyright (c) 2007, Jeremy Hinegardner
 

data/lib/heel/dir_handler.rb

@@ -1,20 +1,25 @@
 require 'heel'
 require 'mime/types'
 require 'erb'
+require 'coderay'
+require 'coderay/helpers/file_type'
 
 module Heel
 
     # A refactored version of Mongrel::DirHandler using the mime-types
     # gem and a prettier directory listing.
     class DirHandler < ::Mongrel::HttpHandler
-        attr_reader :document_root
-        attr_reader :directory_index_html
-        attr_reader :icon_url
-        attr_reader :default_mime_type
-        attr_reader :ignore_globs
-        attr_reader :reload_template_changes
-        attr_reader :template
-        attr_reader :template_mtime
+        attr_reader   :document_root
+        attr_reader   :directory_index_html
+        attr_reader   :icon_url
+        attr_reader   :default_mime_type
+        attr_reader   :highlighting
+        attr_reader   :ignore_globs
+        attr_reader   :reload_template_changes
+        attr_reader   :template
+        attr_reader   :template_mtime
+        attr_accessor :listener
+        attr_reader   :request_notify
 
         # if any other mime types are needed, add them directly via the
         # mime-types calls.
@@ -53,6 +58,7 @@ module Heel
             @using_icons                = options[:using_icons] || true
             @icon_url                   = options[:icon_url] || "/icons"
             @reload_template_changes    = options[:reload_template_changes] || false
+            @highlighting               = options[:highlighting] || false
             reload_template
 
             ADDITIONAL_MIME_TYPES.each do |mt|
@@ -99,48 +105,48 @@ module Heel
             @template_mtime ||= fstat.mtime
             if @template.nil? or fstat.mtime > @template_mtime then
                 @template = ::ERB.new(File.read(fname))
-                # log "Reloaded #{fname}"
             end
         end
 
         # determine how to respond to the request, it will either be a
         # directory listing, a file return, or an error return.
-        def how_to_respond(req_path)
-            if req_path.index(document_root) == 0 then
-                begin
-                    stat = File.stat(req_path)
+        def how_to_respond(req_path,query_params = {})
+            return 403 unless req_path.index(document_root) == 0
+            begin
+                stat = File.stat(req_path)
 
-                    # if it is a directory, we either return the
-                    # directory index file, or a directory listing
-                    if stat.directory? then
-                       dir_index = File.join(req_path,directory_index_html)
-                       if File.exists?(dir_index) then
-                           return dir_index
-                       elsif directory_listing_allowed?
-                           return :directory_listing
-                       end
-
-                    # if it is a file and readable, make sure that the
-                    # path is a legal path
-                    elsif stat.file? and stat.readable? then
-                        if should_ignore?(File.basename(req_path)) then
-                            return 403
-                        end
-                        return req_path
-                    else
-                        # TODO: debug log
+                # if it is a directory, we either return the
+                # directory index file, or a directory listing
+                if stat.directory? then
+                   dir_index = File.join(req_path,directory_index_html)
+                   if File.exists?(dir_index) then
+                       return dir_index
+                   elsif directory_listing_allowed?
+                       return :directory_listing
+                   end
+
+                # if it is a file and readable, make sure that the
+                # path is a legal path
+                elsif stat.file? and stat.readable? then
+                    if should_ignore?(File.basename(req_path)) then
                         return 403
+                    elsif highlighting and not %w(false off).include? query_params['highlighting'].to_s.downcase
+                        ft = ::FileType[req_path,true]
+                        return :highlighted_file if ft and ft != :html
                     end
+                    return req_path
+                else
+                    log "ERROR: #{req_path} is not a directory or a readable file"
+                    return 403
+                end
 
-                rescue => error
-                    if error.kind_of?(Errno::ENOENT) then
-                        return 404
-                    end
-                    # TODO: debug log
-                    return 500
+            rescue => error
+                if error.kind_of?(Errno::ENOENT) then
+                    return 404
                 end
-            else
-               return 403
+                log "ERROR: Unknown, check out the stacktrace"
+                log error
+                return 500
             end
         end
 
@@ -193,45 +199,52 @@ module Heel
             return res_bytes
         end
 
-        # this method is essentially the send_file method from
-        # Mongrel::DirHandler
+        
+        # send the file back with the appropriate mimetype
         def respond_with_send_file(path,method,request,response)
             stat    = File.stat(path)
-            mtime   = stat.mtime
-            etag    = ::Mongrel::Const::ETAG_FORMAT % [mtime.to_i, stat.size, stat.ino]
-
-            modified_since  = request.params[::Mongrel::Const::HTTP_IF_MODIFIED_SINCE]
-            none_match      = request.params[::Mongrel::Const::HTTP_IF_NONE_MATCH]
-
-            last_response_time = Time.httpddate(modified_since) rescue nil
-
-            same_response = case
-                            when modified_since && !last_response_time                               : false
-                            when modified_since && last_response_time > Time.now                     : false
-                            when modified_since && mtime > last_response_time                        : false
-                            when none_match     && none_match == "*"                                 : false
-                            when none_match     && !none_match.strip.split(/\s*,\s*/).include?(etag) : false
-                            else modified_since || none_match
-                            end
-            header = response.header
-            header[::Mongrel::Const::ETAG] = etag
-
-            if same_response then
-                response.start(304) {}
-            else
-                response.status = 200
-                header[::Mongrel::Const::LAST_MODIFIED] = mtime.httpdate
-                header[::Mongrel::Const::CONTENT_TYPE] = (MIME::Types.of(path).first || default_mime_type).to_s
-            end
-
+            header  = response.header
+            
+            header[::Mongrel::Const::LAST_MODIFIED] = stat.mtime
+            header[::Mongrel::Const::CONTENT_TYPE]  = (MIME::Types.of(path).first || default_mime_type).to_s
+            
+            response.status = 200
             response.send_status(stat.size)
             response.send_header
-
+            
             if method == ::Mongrel::Const::GET then
                 response.send_file(path,stat.size < ::Mongrel::Const::CHUNK_SIZE * 2)
             end
+            
             return stat.size
         end
+        
+        #
+        # send back the file marked up by code ray
+        def respond_with_highlighted_file(path,request,response)
+            res_bytes = 0
+            response.start(200) do |head,out|
+                head[::Mongrel::Const::CONTENT_TYPE] = 'text/html'
+                bytes = CodeRay.scan_file(path,:auto).html
+                res_bytes = out.write(<<-EOM)
+                <html>
+                  <head>
+                    <title>#{path}</title>
+                    <!-- CodeRay syntax highlighting CSS -->
+                    <link rel="stylesheet" href="/css/coderay-cycnus.css" type="text/css" />
+                  </head>
+                  <body>
+                    <div class="CodeRay">
+                    <pre>
+#{CodeRay.scan_file(path,:auto).html({:line_numbers => :inline})}
+                     </pre>
+                    </div>
+                  </body>
+                </html>
+                EOM
+            end
+            return res_bytes
+        end
 
         # process the request, returning either the file, a directory
         # listing (if allowed) or an appropriate error
@@ -244,12 +257,13 @@ module Heel
                 req_path = File.expand_path(File.join(@document_root,
                                                       ::Mongrel::HttpRequest.unescape(request.params[Mongrel::Const::PATH_INFO])),
                                             @document_root)
-                res_type = how_to_respond(req_path)
+                res_type = how_to_respond(req_path,::Mongrel::HttpRequest.query_parse(request.params['QUERY_STRING']))
                 res_size = 0
-                
                 case res_type 
                 when :directory_listing
                     res_size = respond_with_directory_listing(req_path,request,response)
+                when :highlighted_file
+                    res_size = respond_with_highlighted_file(req_path,request,response)
                 when String
                     res_size = respond_with_send_file(res_type,method,request,response)
                 when Integer

data/lib/heel/error_handler.rb

@@ -5,7 +5,10 @@ module Heel
 
     class ErrorHandler < ::Mongrel::HttpHandler
 
-        attr_reader :template
+        attr_reader     :template
+        attr_accessor   :listener
+        attr_reader     :request_notify
+        
 
         def initialize(options = {})
             @template = ::ERB.new File.read(File.join(APP_RESOURCE_DIR,"error.rhtml"))

data/lib/heel/gemspec.rb

@@ -36,6 +36,8 @@ module Heel
                 spec.add_dependency("mongrel", ">= 1.0.1")
                 spec.add_dependency("launchy", ">= 0.3.0")
                 spec.add_dependency("mime-types", ">= 1.15")
+                spec.add_dependency("coderay", ">= 0.7.4.215")
+                spec.add_dependency("rake", ">= 0.7.3")
                 
                 spec.required_ruby_version  = ">= 1.8.5"
 

data/lib/heel/server.rb

@@ -1,6 +1,5 @@
 require 'heel'
 require 'ostruct'
-require 'daemons/daemonize'
 require 'launchy'
 require 'tmpdir'
 require 'fileutils'
@@ -53,6 +52,7 @@ module Heel
                 @default_options.port            = 4331
                 @default_options.document_root   = Dir.pwd
                 @default_options.daemonize       = false
+                @default_options.highlighting    = true
                 @default_options.kill            = false
                 @default_options.launch_browser  = true
             end
@@ -76,7 +76,7 @@ module Heel
                 op.separator ""
 
                 op.on("-a", "--address ADDRESS", "Address to bind to",
-                                        "(default: #{default_options.address})") do |add|
+                                        "  (default: #{default_options.address})") do |add|
                     @parsed_options.address = add
                 end
 
@@ -92,12 +92,18 @@ module Heel
                     @parsed_options.kill = true
                 end
                 
-                op.on("-l", "--[no-]launch-browser", "Control automatically launching a browser") do |l|
+                op.on("--[no-]highlighting", "Turn on or off syntax highlighting",
+                                             "  (default: on)") do |highlighting|
+                    @parsed_options.highlighting = highlighting
+                end
+                
+                op.on("--[no-]launch-browser", "Turn on or off automatic browser launch",
+                                               "  (default: on)") do |l|
                     @parsed_options.launch_browser = l
                 end
 
                 op.on("-p", "--port PORT", Integer, "Port to bind to",
-                                        "(default: #{default_options.port})") do |port|
+                                        "  (default: #{default_options.port})") do |port|
                     @parsed_options.port = port
                 end
 
@@ -171,8 +177,7 @@ module Heel
             if not File.exists?(default_directory) then
                 FileUtils.mkdir_p(default_directory)
                 @stdout.puts "Created #{default_directory}"
-                @stdout.puts "PID file #{pid_file} is stored here"
-                @stdout.puts "along with the log #{log_file}"
+                @stdout.puts "heel's PID (#{pid_file}) and log file (#{log_file}) are stored here"
             end
         end
 
@@ -184,9 +189,12 @@ module Heel
             setup_heel_dir
             
             # capture method/variables into a local context so they can be used inside the Configurator block
+            c_address       = options.address
+            c_port          = options.port
             c_document_root = options.document_root
             c_background_me = options.daemonize
             c_default_dir   = default_directory
+            c_highlighting  = options.highlighting
             c_pid_file      = pid_file
             c_log_file      = log_file
 
@@ -202,15 +210,23 @@ module Heel
                     daemonize({:cwd => c_default_dir, :log_file => c_log_file})
                 end
                 
-                listener do
-                    uri "/", :handler => stats
-                    uri "/", :handler => Heel::DirHandler.new({:document_root => c_document_root})
-                    uri "/", :handler => Heel::ErrorHandler.new
-                    uri "/icons", :handler => Heel::DirHandler.new({ :document_root => 
-                                                                          File.join(APP_RESOURCE_DIR, "famfamfam", "icons")})
-                    uri "/status", :handler => ::Mongrel::StatusHandler.new(:stats_filter => stats)
+                begin
+                    
+                    listener do
+                        uri "/", :handler => stats
+                        uri "/", :handler => Heel::DirHandler.new({:document_root => c_document_root, 
+                                                                   :highlighting => c_highlighting })
+                        uri "/", :handler => Heel::ErrorHandler.new
+                        uri "/css", :handler => Heel::DirHandler.new({:document_root =>
+                                                                              File.join(APP_RESOURCE_DIR, "css")})
+                        uri "/icons", :handler => Heel::DirHandler.new({ :document_root => 
+                                                                              File.join(APP_RESOURCE_DIR, "famfamfam", "icons")})
+                        uri "/status", :handler => ::Mongrel::StatusHandler.new(:stats_filter => stats)
+                    end
+                rescue Errno::EADDRINUSE
+                    log "ERROR: Address (#{c_address}:#{c_port}) is already in use, please check running processes or run `heel --kill'"
+                    exit 1
                 end
-
                 setup_signals
             end
             
@@ -225,6 +241,9 @@ module Heel
             
             if options.launch_browser then
                 config.log "Launching your browser..."
+                if c_background_me then
+                    puts "Launching your browser to http://#{options.address}:#{options.port}/"
+                end
                 ::Launchy.open("http://#{options.address}:#{options.port}/")
             end
             

data/lib/heel/version.rb

@@ -3,7 +3,7 @@ require 'heel'
 module Heel
     class Version
         MAJOR   = 0 
-        MINOR   = 4 
+        MINOR   = 5 
         BUILD   = 0 
 
         class << self

data/resources/css/coderay-cycnus.css

@@ -0,0 +1,104 @@
+.CodeRay {
+  background-color: #f8f8f8;
+/*  border: 1px solid silver;
+*/  font-family: 'Courier New', 'Terminal', monospace;
+  color: #100;
+}
+.CodeRay pre { margin: 0px }
+
+div.CodeRay { }
+
+span.CodeRay { white-space: pre; border: 0px; padding: 2px }
+
+table.CodeRay { border-collapse: collapse; width: 100%; padding: 2px }
+table.CodeRay td { padding: 2px 4px; vertical-align: top }
+
+.CodeRay .line_numbers, .CodeRay .no {
+  background-color: #def;
+  color: gray;
+  text-align: right;
+}
+.CodeRay .line_numbers tt { font-weight: bold }
+.CodeRay .no { padding: 0px 4px }
+.CodeRay .code { width: 100% }
+
+ol.CodeRay { font-size: 10pt }
+ol.CodeRay li { white-space: pre }
+
+.CodeRay .code pre { overflow: auto }
+
+.CodeRay .af { color:#00C }
+.CodeRay .an { color:#007 }
+.CodeRay .av { color:#700 }
+.CodeRay .aw { color:#C00 }
+.CodeRay .bi { color:#509; font-weight:bold }
+.CodeRay .c  { color:#888 }
+
+.CodeRay .ch { color:#04D }
+.CodeRay .ch .k { color:#04D }
+.CodeRay .ch .dl { color:#039 }
+
+.CodeRay .cl { color:#B06; font-weight:bold }
+.CodeRay .co { color:#036; font-weight:bold }
+.CodeRay .cr { color:#0A0 }
+.CodeRay .cv { color:#369 }
+.CodeRay .df { color:#099; font-weight:bold }
+.CodeRay .di { color:#088; font-weight:bold }
+.CodeRay .dl { color:black }
+.CodeRay .do { color:#970 }
+.CodeRay .ds { color:#D42; font-weight:bold }
+.CodeRay .e  { color:#666; font-weight:bold }
+.CodeRay .en { color:#800; font-weight:bold }
+.CodeRay .er { color:#F00; background-color:#FAA }
+.CodeRay .ex { color:#F00; font-weight:bold }
+.CodeRay .fl { color:#60E; font-weight:bold }
+.CodeRay .fu { color:#06B; font-weight:bold }
+.CodeRay .gv { color:#d70; font-weight:bold }
+.CodeRay .hx { color:#058; font-weight:bold }
+.CodeRay .i  { color:#00D; font-weight:bold }
+.CodeRay .ic { color:#B44; font-weight:bold }
+
+.CodeRay .il { background: #eee }
+.CodeRay .il .il { background: #ddd }
+.CodeRay .il .il .il { background: #ccc }
+.CodeRay .il .idl { font-weight: bold; color: #888 }
+
+.CodeRay .in { color:#B2B; font-weight:bold }
+.CodeRay .iv { color:#33B }
+.CodeRay .la { color:#970; font-weight:bold }
+.CodeRay .lv { color:#963 }
+.CodeRay .oc { color:#40E; font-weight:bold }
+.CodeRay .on { color:#000; font-weight:bold }
+.CodeRay .op { }
+.CodeRay .pc { color:#038; font-weight:bold }
+.CodeRay .pd { color:#369; font-weight:bold }
+.CodeRay .pp { color:#579 }
+.CodeRay .pt { color:#339; font-weight:bold }
+.CodeRay .r  { color:#080; font-weight:bold }
+
+.CodeRay .rx { background-color:#fff0ff }
+.CodeRay .rx .k { color:#808 }
+.CodeRay .rx .dl { color:#404 }
+.CodeRay .rx .mod { color:#C2C }
+.CodeRay .rx .fu  { color:#404; font-weight: bold }
+
+.CodeRay .s  { background-color:#fff0f0 }
+.CodeRay .s  .s { background-color:#ffe0e0 }
+.CodeRay .s  .s  .s { background-color:#ffd0d0 }
+.CodeRay .s  .k { color:#D20 }
+.CodeRay .s  .dl { color:#710 }
+
+.CodeRay .sh { background-color:#f0fff0 }
+.CodeRay .sh .k { color:#2B2 }
+.CodeRay .sh .dl { color:#161 }
+
+.CodeRay .sy { color:#A60 }
+.CodeRay .sy .k { color:#A60 }
+.CodeRay .sy .dl { color:#630 }
+
+.CodeRay .ta { color:#070 }
+.CodeRay .tf { color:#070; font-weight:bold }
+.CodeRay .ts { color:#D70; font-weight:bold }
+.CodeRay .ty { color:#339; font-weight:bold }
+.CodeRay .v  { color:#036 }
+.CodeRay .xt { color:#444 }

data/resources/css/coderay-murphy.css

@@ -0,0 +1,98 @@
+.CodeRay {
+  background-color: #001129;
+  border: 1px solid silver;
+  font-family: 'Courier New', 'Terminal', monospace;
+  color: #C0C0C0;
+}
+.CodeRay pre { margin: 0px; }
+
+div.CodeRay { }
+
+span.CodeRay { white-space: pre; border: 0px; padding: 2px; }
+
+table.CodeRay { border-collapse: collapse; width: 100%; padding: 2px; }
+table.CodeRay td { padding: 2px 4px; vertical-align: top; }
+
+.CodeRay .line_numbers, .CodeRay .no {
+  background-color: #001129;
+  color: gray;
+  text-align: right;
+}
+.CodeRay .line_numbers tt { font-weight: bold; }
+.CodeRay .no { padding: 0px 4px; }
+.CodeRay .code { width: 100%; }
+
+ol.CodeRay { font-size: 10pt; }
+ol.CodeRay li { white-space: pre; }
+
+.CodeRay .code pre { overflow: auto; }
+
+.CodeRay .af { color:#00C; }
+.CodeRay .an { color:#007; }
+.CodeRay .av { color:#700; }
+.CodeRay .aw { color:#C00; }
+.CodeRay .bi { color:#509; font-weight:bold; }
+.CodeRay .c  { color:#666; }
+
+.CodeRay .ch { color:#88F; }
+.CodeRay .ch .k { color:#04D; }
+.CodeRay .ch .dl { color:#039; }
+
+.CodeRay .cl { color:#e9e; font-weight:bold; }
+.CodeRay .co { color:#5ED; font-weight:bold; }
+.CodeRay .cr { color:#0A0; }
+.CodeRay .cv { color:#ccf; }
+.CodeRay .df { color:#099; font-weight:bold; }
+.CodeRay .di { color:#088; font-weight:bold; }
+.CodeRay .dl { color:black; }
+.CodeRay .do { color:#970; }
+.CodeRay .ds { color:#D42; font-weight:bold; }
+.CodeRay .e  { color:#666; font-weight:bold; }
+.CodeRay .er { color:#F00; background-color:#FAA; }
+.CodeRay .ex { color:#F00; font-weight:bold; }
+.CodeRay .fl { color:#60E; font-weight:bold; }
+.CodeRay .fu { color:#5ed; font-weight:bold; }
+.CodeRay .gv { color:#f84; }
+.CodeRay .hx { color:#058; font-weight:bold; }
+.CodeRay .i  { color:#66f; font-weight:bold; }
+.CodeRay .ic { color:#B44; font-weight:bold; }
+.CodeRay .il { }
+.CodeRay .in { color:#B2B; font-weight:bold; }
+.CodeRay .iv { color:#aaf; }
+.CodeRay .la { color:#970; font-weight:bold; }
+.CodeRay .lv { color:#963; }
+.CodeRay .oc { color:#40E; font-weight:bold; }
+.CodeRay .on { color:#000; font-weight:bold; }
+.CodeRay .op { }
+.CodeRay .pc { color:#08f; font-weight:bold; }
+.CodeRay .pd { color:#369; font-weight:bold; }
+.CodeRay .pp { color:#579; }
+.CodeRay .pt { color:#66f; font-weight:bold; }
+.CodeRay .r  { color:#5de; font-weight:bold; }
+
+.CodeRay .rx { background-color:#221133; }
+.CodeRay .rx .k { color:#f8f; }
+.CodeRay .rx .dl { color:#f0f; }
+.CodeRay .rx .mod { color:#f0b; }
+.CodeRay .rx .fu  { color:#404; font-weight: bold; }
+
+.CodeRay .s  { background-color:#331122; }
+.CodeRay .s  .s { background-color:#ffe0e0; }
+.CodeRay .s  .s  .s { background-color:#ffd0d0; }
+.CodeRay .s  .k { color:#F88; }
+.CodeRay .s  .dl { color:#f55; }
+
+.CodeRay .sh { background-color:#f0fff0; }
+.CodeRay .sh .k { color:#2B2; }
+.CodeRay .sh .dl { color:#161; }
+
+.CodeRay .sy { color:#Fc8; }
+.CodeRay .sy .k { color:#Fc8; }
+.CodeRay .sy .dl { color:#F84; }
+
+.CodeRay .ta { color:#070; }
+.CodeRay .tf { color:#070; font-weight:bold; }
+.CodeRay .ts { color:#D70; font-weight:bold; }
+.CodeRay .ty { color:#339; font-weight:bold; }
+.CodeRay .v  { color:#036; }
+.CodeRay .xt { color:#444; }

data/resources/css/error.css

@@ -0,0 +1,38 @@
+body { font-family: Verdana, Arial, Helvetica, sans-serif; background-color: #e0e0e0;}
+div.wrap { 
+    background: transparent;
+    text-align: left;
+    width: 400px;
+    margin-top: 100px;
+    margin-left: auto;
+    margin-right: auto;
+}
+div.box {
+    border-left: 1px solid #333;
+    border-right: 1px solid #333;
+    background: #FFF;
+    display: block;
+}
+img { padding-right: 20px;} 
+h1 { display: inline; font-weight: bold; }
+h2 { display: inline; font-weight: bold; padding-left: 25px;text-align: center;}
+div.header { font-size: x-large; }
+div.content { font-size: x-large; border: 0; padding: 10px 25px 10px 25px;}
+div.footer { text-align: right; width: 400px; }
+
+.curved { background: transparent;}
+.curved .c1, .curved .c2, .curved .c3, .curved .c4 {
+    display: block;
+    overflow: hidden;
+    height: 1px;
+    font-size: 1px;
+}
+.curved .c2, .curved .c3, .curved .c4 {
+    background: #fff;
+    border-left: 1px solid #000;
+    border-right: 1px solid #000;
+}
+.c1 { margin: 0 5px 0 5px; background: #000; }
+.c2 { margin: 0 3px 0 3px; border-left: 2px solid #000; border-right: 2px solid #000; }
+.c3 { margin: 0 2px 0 2px; }
+.c4 { margin: 0 1px 0 1px; }

data/resources/css/listing.css

@@ -0,0 +1,29 @@
+a, a:active { text-decoration: none; color: blue;}
+a:visited { color: purple;}
+a:hover, a:focus { text-decoration: underline; color: red;}
+body { font-family: Verdana, Arial, Helvetica, sans-serif; background-color: #eee; }
+.c { text-align: center; }
+table { border-collapse: collapse; border-spacing: 0px; width: 100%;}
+tr { background-color: #ccf;}
+tr:hover { background-color: #faa;}
+td, th { 
+    border-bottom: 1px solid #ccc; 
+    padding: 0em .3em 0em .3em ; 
+    color: #666; 
+    text-align: left;
+    vertical-align: middle;
+}
+thead th { 
+    border-top: 2px solid #666; 
+    border-bottom: 2px solid #666; 
+    font-weight: bold; 
+    background: #aaa; 
+    color: #fff;
+    text-transform: uppercase;
+}
+tr.odd { background-color: #cfc; color: #333;}
+tr.odd:hover { background-color: #faa; color: #333;}
+td.n { text-align: right; padding-right: 2em;}
+div.header { }
+div.content { background: #FFF; width: 100%;}
+div.footer { border-top: 2px solid #333; text-align: right;}

data/resources/error.rhtml

@@ -3,46 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
     <head>
         <title>Error <%= status %> </title>
-        <style type="text/css">
-            body { font-family: Verdana, Arial, Helvetica, sans-serif; background-color: #e0e0e0;}
-            div.wrap { 
-                background: transparent;
-                text-align: left;
-                width: 400px;
-                margin-top: 100px;
-                margin-left: auto;
-                margin-right: auto;
-            }
-            div.box {
-                border-left: 1px solid #333;
-                border-right: 1px solid #333;
-                background: #FFF;
-                display: block;
-            }
-            img { padding-right: 20px;} 
-            h1 { display: inline; font-weight: bold; }
-            h2 { display: inline; font-weight: bold; padding-left: 25px;text-align: center;}
-            div.header { font-size: x-large; }
-            div.content { font-size: x-large; border: 0; padding: 10px 25px 10px 25px;}
-            div.footer { text-align: right; width: 400px; }
-
-            .curved { background: transparent;}
-            .curved .c1, .curved .c2, .curved .c3, .curved .c4 {
-                display: block;
-                overflow: hidden;
-                height: 1px;
-                font-size: 1px;
-            }
-            .curved .c2, .curved .c3, .curved .c4 {
-                background: #fff;
-                border-left: 1px solid #000;
-                border-right: 1px solid #000;
-            }
-            .c1 { margin: 0 5px 0 5px; background: #000; }
-            .c2 { margin: 0 3px 0 3px; border-left: 2px solid #000; border-right: 2px solid #000; }
-            .c3 { margin: 0 2px 0 2px; }
-            .c4 { margin: 0 1px 0 1px; }
-        </style>
+		<link rel="stylesheet" href="/css/error.css" type="text/css" />
     </head>
     <body>
         <div class="wrap">

data/resources/listing.rhtml

@@ -3,37 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
     <head>
         <title>Index of <%= base_uri %></title>
-        <style type="text/css">
-            a, a:active { text-decoration: none; color: blue;}
-            a:visited { color: purple;}
-            a:hover, a:focus { text-decoration: underline; color: red;}
-            body { font-family: Verdana, Arial, Helvetica, sans-serif; background-color: #eee; }
-            .c { text-align: center; }
-            table { border-collapse: collapse; border-spacing: 0px; width: 100%;}
-            tr { background-color: #ccf;}
-            tr:hover { background-color: #faa;}
-            td, th { 
-                border-bottom: 1px solid #ccc; 
-                padding: 0em .3em 0em .3em ; 
-                color: #666; 
-                text-align: left;
-                vertical-align: middle;
-            }
-            thead th { 
-                border-top: 2px solid #666; 
-                border-bottom: 2px solid #666; 
-                font-weight: bold; 
-                background: #aaa; 
-                color: #fff;
-                text-transform: uppercase;
-            }
-            tr.odd { background-color: #cfc; color: #333;}
-            tr.odd:hover { background-color: #faa; color: #333;}
-            td.n { text-align: right; padding-right: 2em;}
-            div.header { }
-            div.content { background: #FFF; width: 100%;}
-            div.footer { border-top: 2px solid #333; text-align: right;}
-        </style>
+		<link rel="stylesheet" href="/css/listing.css" type="text/css" />
     </head>
     <body>
         <div class="header">
@@ -52,6 +22,9 @@
                             <img src="<%= entry.icon_url %>" width="16" height="16" alt="icon for type <%= entry.content_type %>" />
                             <% end %>
                             <a href="<%= "#{base_uri.chomp('/')}/#{entry.link}" %>"><%= entry.name %></a>
+						    <% if highlighting and entry.content_type != 'Directory' then %>
+						     (<a href="<%= "#{base_uri.chomp('/')}/#{entry.link}?highlighting=false" %>">download</a>)
+						    <% end %>
                         </td>
                         <td><%= entry.last_modified %></td>
                         <td class="<%= entry.content_type == "Directory" ? 'c' : 'n' %>" ><%= entry.size %></td>

data/spec/dir_handler_spec.rb

@@ -4,7 +4,7 @@ require 'stringio'
 
 describe Heel::DirHandler do 
     before(:each) do 
-        @handler = Heel::DirHandler.new
+        @handler = Heel::DirHandler.new({:highlighting => true})
         @classifier = Mongrel::URIClassifier.new
         @classifier.register("/",1)
         @socket = StringIO.new
@@ -26,7 +26,80 @@ describe Heel::DirHandler do
         @response.finished
         
         @response.status.should == 200
-        @response.body.string.should =~ /Index of/m
+        @socket.string.should =~ /Index of/m
+    end
+    
+    it "should return an existing directory index page if it exists" do
+        File.open("index.html", "w") { |f| f.write('delete me') }
+        @params[Mongrel::Const::REQUEST_URI] = "/"
+        junk1,path_info,junk2 = @classifier.resolve(@params[Mongrel::Const::REQUEST_URI])
+        
+        @params[Mongrel::Const::PATH_INFO] = path_info
+        @request = Mongrel::HttpRequest.new(@params,@socket,nil)
+        
+        @handler.process(@request,@response)
+        @response.finished
+        File.unlink("index.html")
+        
+        @response.status.should == 200
+        @socket.string.should =~ /delete me/m
+    end
+    
+    it "should return a 403 if a request for an ignorable file is made" do
+        File.open(".htaccess", "w") { |f| f.write('delete me') }
+        @params[Mongrel::Const::REQUEST_URI] = "/.htaccess"
+        junk1,path_info,junk2 = @classifier.resolve(@params[Mongrel::Const::REQUEST_URI])
+        
+        @params[Mongrel::Const::PATH_INFO] = path_info
+        @request = Mongrel::HttpRequest.new(@params,@socket,nil)
+        
+        @handler.process(@request,@response)
+        @response.finished
+
+        File.unlink(".htaccess")
+        @response.status.should == 403
+        
+    end
+    
+    it "should return a 403 if an invalid request method is used" do
+        @params[Mongrel::Const::REQUEST_METHOD] = "PUT"
+        @params[Mongrel::Const::REQUEST_URI] = "/"
+        junk1,path_info,junk2 = @classifier.resolve(@params[Mongrel::Const::REQUEST_URI])
+        
+        @params[Mongrel::Const::PATH_INFO] = path_info
+        @request = Mongrel::HttpRequest.new(@params,@socket,nil)
+        
+        @handler.process(@request,@response)
+        @response.finished
+
+        @response.status.should == 403
+        @socket.string.should =~ /Only HEAD and GET requests are honored./m
+    end
+    
+    it "should format a ruby file and return it as a content-type text/html" do
+        @params[Mongrel::Const::REQUEST_URI] = "/spec/" +  File.basename(__FILE__)
+        junk1,path_info,junk2 = @classifier.resolve(@params[Mongrel::Const::REQUEST_URI])
+        
+        @params[Mongrel::Const::PATH_INFO] = path_info
+        @request = Mongrel::HttpRequest.new(@params,@socket,nil)
+        @handler.process(@request,@response)
+        @response.finished
+        @response.status.should == 200
+        @socket.string.should =~ /Content-Type: text\/html/m
+        
+    end
+    
+    it "should parse the highlighting cgi parameter and return non-highlighted text if highlighting=off" do
+        @params[Mongrel::Const::REQUEST_URI] = "/spec/" +  File.basename(__FILE__)
+        @params['QUERY_STRING'] = "highlighting=off"
+        junk1,path_info,junk2 = @classifier.resolve(@params[Mongrel::Const::REQUEST_URI])
+        
+        @params[Mongrel::Const::PATH_INFO] = path_info
+        @request = Mongrel::HttpRequest.new(@params,@socket,nil)
+        @handler.process(@request,@response)
+        @response.finished
+        @response.status.should == 200
+        @socket.string.should =~ /Content-Type: text\/plain/m
     end
     
     it "should return icons appropriately for unknown mime_type" do
@@ -36,4 +109,20 @@ describe Heel::DirHandler do
     it "should test if templates need to be reloaded" do
         @handler.reload_template_changes?.should == false
     end
+    
+    it "should return 403 if we access something that exists but is not a readable file" do
+        File.open("deleteme.html", "w") { |f| f.write('delete me') }
+        File.chmod(0111, "deleteme.html")
+        @params[Mongrel::Const::REQUEST_URI] = "/deleteme.html"
+        junk1,path_info,junk2 = @classifier.resolve(@params[Mongrel::Const::REQUEST_URI])
+        
+        @params[Mongrel::Const::PATH_INFO] = path_info
+        @request = Mongrel::HttpRequest.new(@params,@socket,nil)
+        
+        @handler.process(@request,@response)
+        @response.finished
+        File.unlink("deleteme.html")
+
+        @response.status.should == 403
+    end       
 end

data/spec/error_handler_spec.rb

@@ -21,6 +21,7 @@ describe Heel::ErrorHandler do
         
         @handler.process(@request,@response)
         @response.finished
+        
         @response.status.should == 404
         @socket.string.should =~ /Not Found/m
         

data/spec/server_spec.rb

@@ -63,6 +63,12 @@ describe Heel::Server do
         server.options.port.should == 4242        
     end
     
+    it "should allow the highlighting option to be unset" do
+        server = Heel::Server.new(%w[--no-highlighting])
+        server.merge_options
+        server.options.highlighting.should == false
+    end
+    
     it "should set no-launch-browser option and kill option" do
         server = Heel::Server.new(%w[--no-launch-browser])
         server.merge_options

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: heel
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
-date: 2007-11-04 00:00:00 -04:00
+  version: 0.5.0
+date: 2007-11-19 00:00:00 -07:00
 summary: A mongrel based static file webserver.
 require_paths: 
 - lib
@@ -43,11 +43,17 @@ files:
 - lib/heel/specification.rb
 - lib/heel/version.rb
 - lib/heel.rb
+- resources/css
+- resources/css/coderay-cycnus.css
+- resources/css/coderay-murphy.css
+- resources/css/error.css
+- resources/css/listing.css
 - resources/error.rhtml
 - resources/famfamfam
 - resources/famfamfam/icons
 - resources/famfamfam/icons/application.png
 - resources/famfamfam/icons/compress.png
+- resources/famfamfam/icons/error.png
 - resources/famfamfam/icons/folder.png
 - resources/famfamfam/icons/html.png
 - resources/famfamfam/icons/page_excel.png
@@ -112,3 +118,21 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "1.15"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: coderay
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.7.4.215
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.7.3
+    version: