heel 0.6.0 → 1.0.0

data/{CHANGES → HISTORY}

@@ -1,4 +1,7 @@
 = Changelog
+== Version 1.0.0 - 2008-04-20
+
+* Convert Heel to a Rack and Thin application
 
 == Version 0.6.0 - 2007-11-21
 
@@ -6,9 +9,6 @@
 * Changed change 'resources' directory to 'data' 
 * Renamed internal constants
 * Changed operating URL's to avoid conflict with directories heel may be serving
-** /css -> /heel_css
-** /icons -> /heel_icons
-** /status -> /heel_status
 
 == Version 0.5.0 - 2007-11-19
 

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2007, Jeremy Hinegardner
+Copyright (c) 2007, 2008, Jeremy Hinegardner
 
 All rights reserved.
 

data/README

@@ -6,44 +6,45 @@
 
 == DESCRIPTION:
 
-Heel is a small static file web server based on {mongrel}[http://mongrel.rubyforge.org] 
-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
+Heel is a small static web server 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 is built using {Rack}[http://rack.rubyforge.org] and
+{Thin}[http://code.macournoyer.com/thin/]
+
+   % heel        
+   >> Thin web server (v0.8.1 codename Rebel Porpoise)
+   >> Threaded mode OFF
+   >> Maximum connections set to 1024
+   >> Listening on 0.0.0.0:4331, CTRL+C to stop
+   Launching your browser...
 
 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 --daemonize
+  Created /Users/jeremy/.heel
+  heel's PID (/Users/jeremy/.heel/heel.pid) and log file (/Users/jeremy/.heel/heel.log) are stored here
+  Launching your browser at http://0.0.0.0:4331/
 
-    % heel --kill
-    Sending TERM to process 1086
-    Done.
+  % heel --kill
+  Sending TERM to process 3304
+  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)
+* Bind to any address and port (default is 0.0.0.0:4331)
 
 == SYNOPSIS:
 
 	Usage: heel [options]
 
 	    -a, --address ADDRESS            Address to bind to
-	                                       (default: 127.0.0.1)
+	                                       (default: 0.0.0.0)
 	    -d, --daemonize                  Run daemonized in the background
 	    -h, --help                       Display this text
 	    -k, --kill                       Kill an existing daemonized heel process
@@ -65,13 +66,13 @@ Or run it in the background
 * {coderay}[http://coderay.rubychan.de/]
 * {launchy}[http://copiousfreetime.rubyforge.org/launchy/] >= 0.1.1
 * {mime-types}[http://mime-types.rubyforge.org/]
-* {mongrel}[http://mongrel.rubyforge.org/]
-* {rake}[http://rake.rubyforge.org/] >= 0.7.1
+* {thin}[http://thin.rubyforge.org/]
 
 === For development:
 
 * {rcov}[http://eigenclass.org/hiki.rb?rcov] >= 0.7.0.1
 * {rspec}[http://rspec.rubyforge.org/]  >= 0.7.3
+* {rake}[http://rake.rubyforge.org/] >= 0.7.1
 
 == INSTALL:
 
@@ -79,12 +80,13 @@ Or run it in the background
 
 == CREDITS:
 
-* Zed Shaw for {mongrel}[http://mongrel.rubyforge.org]
+* {Thin}[http://code.macournoyer.com/thin/]
+* {Rack}[http://rack.rubyforge.org/]
 * http://www.famfamfam.com/ for amazing icons
 
 == BSD LICENSE:
 
-Copyright (c) 2007, Jeremy Hinegardner
+Copyright (c) 2007, 2008, Jeremy Hinegardner
 
 All rights reserved.
 

data/bin/heel

@@ -1,9 +1,13 @@
 #!/usr/bin/env ruby
 
+#--
+# Copyright (c) 2007, 2008 Jeremy Hinegardner
+# All rights reserved. Licensed under the BSD license.  See LICENSE for details
+#++
+
 $: << File.expand_path(File.join(File.dirname(__FILE__),"..","lib"))
 
 require 'rubygems'
-require 'mongrel'
 require 'heel'
 
 Heel::Server.new(ARGV).run

data/data/error.rhtml

@@ -22,7 +22,7 @@
                 <b class="c4"></b><b class="c3"></b><b class="c2"></b><b class="c1"></b>
             </div>
             <div class="footer">
-                <a href="<%= Heel::SPEC::homepage %>">heel</a>/v<%= Heel::VERSION %>
+                <a href="<%= homepage %>">heel</a>/v<%= ::Heel::VERSION %>
             </div>
         </div>
     </body>

data/data/listing.rhtml

@@ -22,7 +22,7 @@
                             <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 %>
+						    <% if highlighting? and entry.content_type != 'Directory' then %>
 						     (<a href="<%= "#{base_uri.chomp('/')}/#{entry.link}?highlighting=false" %>">download</a>)
 						    <% end %>
                         </td>
@@ -35,7 +35,7 @@
             </table>
         </div>
         <div class="footer">
-            <a href="<%= Heel::SPEC::homepage %>">heel</a>/v<%= Heel::VERSION %>
+            <a href="http://copiousfreetime.rubyforge.org/heel/">heel</a>/v<%= Heel::VERSION %>
         </div>
     </body>
 </html>

data/gemspec.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'heel/version'
+require 'tasks/config'
+
+Heel::GEM_SPEC = Gem::Specification.new do |spec|
+  proj = Configuration.for('project')
+  spec.name         = proj.name
+  spec.version      = Heel::VERSION
+  
+  spec.author       = proj.author
+  spec.email        = proj.email
+  spec.homepage     = proj.homepage
+  spec.summary      = proj.summary
+  spec.description  = proj.description
+  spec.platform     = Gem::Platform::RUBY
+
+  
+  pkg = Configuration.for('packaging')
+  spec.files        = pkg.files.all
+  spec.executables  = pkg.files.bin.collect { |b| File.basename(b) }
+  spec.add_dependency("thin", ">= 0.7.0")
+  spec.add_dependency("mime-types", ">= 1.15")
+  spec.add_dependency("launchy", ">= 0.3.1")
+  spec.add_dependency("coderay", ">= 0.7.4.215")
+
+  if rdoc = Configuration.for_if_exist?('rdoc') then
+    spec.has_rdoc         = true
+    spec.extra_rdoc_files = pkg.files.rdoc
+    spec.rdoc_options     = rdoc.options + [ "--main" , rdoc.main ]
+  else
+    spec.has_rdoc         = false
+  end 
+
+  if test = Configuration.for_if_exist?('testing') then
+    spec.test_files       = test.files
+  end 
+
+  if rf = Configuration.for_if_exist?('rubyforge') then
+    spec.rubyforge_project  = rf.project
+  end 
+
+end

data/lib/heel.rb

@@ -1,16 +1,21 @@
-module Heel
-    APP_ROOT_DIR     = File.dirname(File.expand_path(File.join(__FILE__,".."))).freeze
-    APP_LIB_DIR      = File.join(APP_ROOT_DIR,"lib")
-    APP_DATA_DIR     = File.join(APP_ROOT_DIR,"data")
-end
+#--
+# Copyright (c) 2007, 2008 Jeremy Hinegardner
+# All rights reserved. Licensed under the BSD license.  See LICENSE for details
+#++
 
-require 'rubygems'
-require 'mongrel'
+module Heel
+  # recursively descend the directory with the same name as this file and do a
+  # require 'heel/path/to/file'
+  #
+  def self.require_all_libs_relative_to_me
+    remove_parent = File.dirname(File.expand_path(__FILE__)) + File::SEPARATOR
+    descend_dir   = File.join(remove_parent,File.basename(__FILE__, ".rb"))
 
-require 'heel/version'
-require 'heel/specification'
-require 'heel/gemspec'
-require 'heel/server'
-require 'heel/dir_handler'
-require 'heel/error_handler'
+    Dir.glob("#{descend_dir}/**/*.rb").each do |rb|
+      lib = rb.gsub(remove_parent,'')
+      require lib
+    end
+  end
+end
 
+Heel.require_all_libs_relative_to_me

data/lib/heel/configuration.rb

@@ -0,0 +1,64 @@
+#--
+# Copyright (c) 2007, 2008 Jeremy Hinegardner
+# All rights reserved.  Licensed under BSD license. See LICENSE for details.
+#++
+
+module Heel
+
+  # Configuration module used by all the other modules and classes for
+  # determining paths and default values.
+  #
+  module Configuration
+
+    # The root directory of the project is considered to be the parent directory
+    # of the 'lib' directory.
+    #
+    # returns:: [String] The full expanded path of the parent directory of 'lib'
+    #           going up the path from the current file.  Trailing
+    #           File::SEPARATOR is guaranteed.
+    #
+    def self.root_dir
+      unless @root_dir
+        path_parts = ::File.expand_path(__FILE__).split(::File::SEPARATOR)
+        lib_index  = path_parts.rindex("lib")
+        @root_dir = path_parts[0...lib_index].join(::File::SEPARATOR) + ::File::SEPARATOR
+      end
+      return @root_dir
+    end
+
+    # returns:: [String] The full expanded path of the +config+ directory
+    #           below _root_dir_.  All parameters passed in are joined onto the
+    #           result.  Trailing File::SEPARATOR is guaranteed if _args_ are
+    #           *not* present.
+    #
+    def self.config_path(*args)
+      self.sub_path("config", *args)
+    end
+
+    # returns:: [String] The full expanded path of the +data+ directory below
+    #           _root_dir_.  All parameters passed in are joined onto the 
+    #           result. Trailing File::SEPARATOR is guaranteed if 
+    #           _*args_ are *not* present.
+    #
+    def self.data_path(*args)
+      self.sub_path("data", *args)
+    end
+    
+    # returns:: [String] The full expanded path of the +lib+ directory below
+    #           _root_dir_.  All parameters passed in are joined onto the 
+    #           result. Trailing File::SEPARATOR is guaranteed if 
+    #           _*args_ are *not* present.
+    #
+    def self.lib_path(*args)
+      self.sub_path("lib", *args)
+    end
+
+    HOMEPAGE = "http://copiousfreetime.rubyforge.org/heel/"
+
+    private
+    def self.sub_path(sub,*args)
+      sp = ::File.join(root_dir, sub) + File::SEPARATOR
+      sp = ::File.join(sp, *args) if args
+    end
+  end
+end

data/lib/heel/directory_indexer.rb

@@ -0,0 +1,114 @@
+#--
+# Copyright (c) 2007, 2008 Jeremy Hinegardner
+# All rights reserved. Licensed under the BSD license.  See LICENSE for details
+#++
+
+require 'heel'
+require 'erb'
+
+module Heel
+  # generate html index pages of a directory
+  #
+  class DirectoryIndexer
+
+    attr_reader :options
+    attr_reader :template_file
+    attr_reader :template
+
+    def initialize( template_file, options )
+      @template_file    = template_file
+      @options          = options
+      reload_template
+    end
+    
+    def should_ignore?(fname)
+      options[:ignore_globs].each do |glob|
+        return true if ::File.fnmatch(glob,fname)
+      end
+      false 
+    end
+    
+    def mime_map
+      @mime_map ||= Heel::MimeMap.new
+    end
+
+    def highlighting?
+      @options[:highlighting]
+    end
+
+    def reload_on_template_change?
+      @options[:reload_template_on_change]
+    end
+
+    def using_icons?
+      @options[:using_icons]
+    end
+
+    def reload_template
+      fstat = File.stat(@template_file)
+      @template_mtime ||= fstat.mtime
+      if @template.nil? or fstat.mtime > @template_mtime then
+        @template = ::ERB.new(File.read(@template_file))
+      end
+    end
+
+    # generate the directory index html page of a directory
+    #
+    def index_page_for(req)
+      reload_template if reload_on_template_change?
+      dir      = req.request_path
+      base_uri = req.path_info
+      entries = []
+      Dir.entries(dir).each do |entry|
+        next if should_ignore?(entry)
+        next if dir == @options[:document_root] and entry == ".."
+
+        stat            = File.stat(File.join(dir,entry))
+        entry_data      = OpenStruct.new 
+
+        entry_data.name          = entry == ".." ? "Parent Directory" : entry
+        entry_data.link          = entry
+        entry_data.size          = num_to_bytes(stat.size)
+        entry_data.last_modified = stat.mtime.strftime("%Y-%m-%d %H:%M:%S")
+
+        if stat.directory? then
+          entry_data.content_type = "Directory"
+          entry_data.size         = "-"
+          entry_data.name        += "/"
+          if using_icons? then
+            entry_data.icon_url = File.join(options[:icon_url], MimeMap.icons_by_mime_type[:directory])
+          end
+        else
+          entry_data.mime_type = mime_map.mime_type_of(entry)
+          entry_data.content_type = entry_data.mime_type.content_type
+          if using_icons? then
+            entry_data.icon_url = File.join(options[:icon_url], mime_map.icon_for(entry_data.mime_type))
+          end
+        end
+        entries << entry_data
+      end
+
+      entries = entries.sort_by { |e| e.link }
+      return template.result(binding)
+    end
+ 
+    # essentially this is strfbytes from facets
+    #
+    def num_to_bytes(num,fmt="%.2f")
+      case
+      when num < 1024
+              "#{num} bytes"
+      when num < 1024**2
+              "#{fmt % (num.to_f / 1024)} KB"
+      when num < 1024**3
+              "#{fmt % (num.to_f / 1024**2)} MB"
+      when num < 1024**4
+              "#{fmt % (num.to_f / 1024**3)} GB"
+      when num < 1024**5
+              "#{fmt % (num.to_f / 1024**4)} TB"
+      else
+              "#{num} bytes"
+      end
+    end
+  end
+end

data/lib/heel/error_response.rb

@@ -0,0 +1,43 @@
+#--
+# Copyright (c) 2007, 2008 Jeremy Hinegardner
+# All rights reserved. Licensed under the BSD license.  See LICENSE for details
+#++
+
+require 'heel'
+require 'rack'
+require 'erb'
+
+module Heel
+
+  class ErrorResponse < ::Rack::Response
+
+    attr_reader :base_uri
+
+    class << self
+      def template_file
+        @template_file ||= Heel::Configuration.data_path("error.rhtml")
+      end
+
+      def template
+        @template ||= ::ERB.new(File.read(template_file))
+      end
+
+      def homepage
+        @homepage ||= Heel::Configuration::HOMEPAGE
+      end
+    end
+
+    def initialize(base_uri, body, status = 404, header = {})
+      super(body, status, header)
+      self['Content-type'] = 'text/html'
+      @base_uri = base_uri
+    end
+
+    def finish
+      message  = ::Rack::Utils::HTTP_STATUS_CODES[status]
+      homepage = ErrorResponse.homepage
+
+      return [ status, header.to_hash, ErrorResponse.template.result(binding) ]
+    end
+  end
+end