heel 2.0.0 → 3.0.0

data/CONTRIBUTING.md

@@ -0,0 +1,46 @@
+# Hi there!
+
+I see you are interested in contributing. That is wonderful. I love
+contributions.
+
+I guarantee that there are bugs in this software. And I guarantee that there is
+a feature you want that is not in here yet. As such, any and all bugs reports
+are gratefully accepted, bugfixes even more so. Helping out with bugs is the
+easiest way to contribute.
+
+
+## The Quick Version
+
+* Have a [GitHub Account][].
+* Search the [GitHub Issues][] and see if your issue already present. If so
+  add your comments, :thumbsup:, etc.
+* Issue not there? Not a problem, open up a [new issue][].
+    * **Bug reports** please be as detailed as possible. Include:
+        * full ruby engine and version: `ruby -e 'puts RUBY_DESCRIPTION'`
+        * operating system and version
+        * version of heel `ruby -rubygems -e "require 'heel'; puts Heel::VERSION"`
+        * as much detail about the bug as possible so I can replicate it. Feel free
+          to link in a [gist][]
+    * **New Feature**
+        * What the new feature should do.
+        * What benefit the new feature brings to the project.
+* Fork the [repo][].
+* Create a new branch for your issue: `git checkout -b issue/my-issue`
+* Lovingly craft your contribution:
+    * `rake develop` to get started, or if you prefer bundler `rake develop:using_bundler && bundle`.
+    * `rake test` to run tests
+* Make sure that `rake test` passes. It's important, I said it twice.
+* Add yourself to the contributors section below.
+* Submit your [pull request][].
+
+# Contributors
+
+* [Jeremy Hinegardner][https://github.com/copiousfreetime]
+* [Kevin Barnes][https://github.com/vinbarnes]
+
+[GitHub Account]: https://github.com/signup/free "GitHub Signup"
+[GitHub Issues]:  https://github.com/copiousfreetime/heel/issues "Heel Issues"
+[new issue]:      https://github.com/copiousfreetime/heel/issues/new "New Heel Issue"
+[gist]:           https://gist.github.com/ "New Gist"
+[repo]:           https://github.com/copiousfreetime/heel "Heel Repo"
+[pull request]:   https://help.github.com/articles/using-pull-requests "Using Pull Requests"

data/{HISTORY → HISTORY.rdoc}

@@ -1,4 +1,17 @@
 = Changelog
+== Version 3.0.0 - 2013-02-06
+
+* Switch to using puma for the webserver
+* Switch to using simplecov for coverage testing
+* Update all gem dependencies
+* Update to fixme project template
+* Convert to minitest
+
+== Version 2.1.0 - 2011-03-17
+
+* Update to Launchy 1.0.0
+* Update to Thin 1.2.8
+
 == Version 2.0.0 - 2009-06-24
 
 * Change highlighting mode default to 'off' instead of 'on'

data/Manifest.txt

@@ -0,0 +1,45 @@
+CONTRIBUTING.md
+HISTORY.rdoc
+LICENSE
+Manifest.txt
+README.rdoc
+Rakefile
+TODO
+bin/heel
+data/css/coderay-alpha.css
+data/css/coderay-cycnus.css
+data/css/coderay-murphy.css
+data/css/error.css
+data/css/listing.css
+data/error.rhtml
+data/famfamfam/icons/application.png
+data/famfamfam/icons/compress.png
+data/famfamfam/icons/error.png
+data/famfamfam/icons/folder.png
+data/famfamfam/icons/html.png
+data/famfamfam/icons/page_excel.png
+data/famfamfam/icons/page_white.png
+data/famfamfam/icons/page_white_acrobat.png
+data/famfamfam/icons/page_white_code.png
+data/famfamfam/icons/page_white_powerpoint.png
+data/famfamfam/icons/page_white_text.png
+data/famfamfam/icons/picture.png
+data/famfamfam/icons/xhtml.png
+data/famfamfam/readme.html
+data/famfamfam/readme.txt
+data/listing.rhtml
+lib/heel.rb
+lib/heel/configuration.rb
+lib/heel/directory_indexer.rb
+lib/heel/error_response.rb
+lib/heel/mime_map.rb
+lib/heel/rackapp.rb
+lib/heel/request.rb
+lib/heel/server.rb
+spec/configuration_spec.rb
+spec/directory_indexer_spec.rb
+spec/rackapp_spec.rb
+spec/server_spec.rb
+spec/spec_helper.rb
+tasks/default.rake
+tasks/this.rb

data/{README → README.rdoc}

@@ -16,8 +16,7 @@ Heel is built using {Rack}[http://rack.rubyforge.org] and
 {Thin}[http://code.macournoyer.com/thin/]
 
    % heel        
-   >> Thin web server (v1.0.0 codename That's What She Said)
-   >> Threaded mode OFF
+   >> Thin web server (v1.2.8 codename Black Keys)
    >> Maximum connections set to 1024
    >> Listening on 0.0.0.0:4331, CTRL+C to stop
    Launching your browser...
@@ -87,7 +86,7 @@ Or run it in the background
 
 == BSD LICENSE:
 
-Copyright (c) 2007-2009, Jeremy Hinegardner
+Copyright (c) 2007 - 2013, Jeremy Hinegardner
 
 All rights reserved.
 

data/Rakefile

@@ -0,0 +1,20 @@
+# vim: syntax=ruby
+load 'tasks/this.rb'
+
+This.name     = "heel"
+This.author   = "Jeremy Hinegardner"
+This.email    = "jeremy@copiousfreetime.org"
+This.homepage = "http://github.com/copiousfreetime/#{ This.name }"
+
+This.ruby_gemspec do |spec|
+  spec.add_runtime_dependency( 'puma'      , '~> 1.0'   )
+  spec.add_runtime_dependency( 'mime-types', '~> 1.19'  )
+  spec.add_runtime_dependency( 'launchy'   , '~> 2.2'   )
+  spec.add_runtime_dependency( 'coderay'   , '~> 1.0.7' )
+
+  spec.add_development_dependency( 'rake'     , '~> 10.0.3')
+  spec.add_development_dependency( 'minitest' , '~> 4.5.0' )
+  spec.add_development_dependency( 'rdoc'     , '~> 3.12'  )
+end
+
+load 'tasks/default.rake'

data/TODO

@@ -0,0 +1,2 @@
+- See why jruby is not working correctly
+- Add HEAD support

data/bin/heel

@@ -1,12 +1,10 @@
 #!/usr/bin/env ruby
 
 #--
-# Copyright (c) 2007, 2008 Jeremy Hinegardner
+# Copyright (c) 2007 - 2013 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 'heel'
 

data/data/css/coderay-alpha.css

@@ -0,0 +1,120 @@
+.CodeRay {
+  background-color: hsl(0,0%,95%);
+  border: 1px solid silver;
+  color: black;
+}
+.CodeRay pre {
+  margin: 0px;
+}
+
+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 {
+  background-color: hsl(180,65%,90%);
+  color: gray;
+  text-align: right;
+  -webkit-user-select: none;
+  -moz-user-select: none;
+  user-select: none;
+}
+.CodeRay .line-numbers a {
+  background-color: hsl(180,65%,90%) !important;
+  color: gray !important;
+  text-decoration: none !important;
+}
+.CodeRay .line-numbers a:target { color: blue !important; }
+.CodeRay .line-numbers .highlighted { color: red !important; }
+.CodeRay .line-numbers .highlighted a { color: red !important; }
+.CodeRay span.line-numbers { padding: 0px 4px; }
+.CodeRay .line { display: block; float: left; width: 100%; }
+.CodeRay .code { width: 100%; }
+
+.CodeRay .debug { color: white !important; background: blue !important; }
+
+.CodeRay .annotation { color:#007 }
+.CodeRay .attribute-name { color:#b48 }
+.CodeRay .attribute-value { color:#700 }
+.CodeRay .binary { color:#509 }
+.CodeRay .char .content { color:#D20 }
+.CodeRay .char .delimiter { color:#710 }
+.CodeRay .char { color:#D20 }
+.CodeRay .class { color:#B06; font-weight:bold }
+.CodeRay .class-variable { color:#369 }
+.CodeRay .color { color:#0A0 }
+.CodeRay .comment { color:#777 }
+.CodeRay .comment .char { color:#444 }
+.CodeRay .comment .delimiter { color:#444 }
+.CodeRay .complex { color:#A08 }
+.CodeRay .constant { color:#036; font-weight:bold }
+.CodeRay .decorator { color:#B0B }
+.CodeRay .definition { color:#099; font-weight:bold }
+.CodeRay .delimiter { color:black }
+.CodeRay .directive { color:#088; font-weight:bold }
+.CodeRay .doc { color:#970 }
+.CodeRay .doc-string { color:#D42; font-weight:bold }
+.CodeRay .doctype { color:#34b }
+.CodeRay .entity { color:#800; font-weight:bold }
+.CodeRay .error { color:#F00; background-color:#FAA }
+.CodeRay .escape  { color:#666 }
+.CodeRay .exception { color:#C00; font-weight:bold }
+.CodeRay .float { color:#60E }
+.CodeRay .function { color:#06B; font-weight:bold }
+.CodeRay .global-variable { color:#d70 }
+.CodeRay .hex { color:#02b }
+.CodeRay .imaginary { color:#f00 }
+.CodeRay .include { color:#B44; font-weight:bold }
+.CodeRay .inline { background-color: hsla(0,0%,0%,0.07); color: black }
+.CodeRay .inline-delimiter { font-weight: bold; color: #666 }
+.CodeRay .instance-variable { color:#33B }
+.CodeRay .integer  { color:#00D }
+.CodeRay .key .char { color: #60f }
+.CodeRay .key .delimiter { color: #404 }
+.CodeRay .key { color: #606 }
+.CodeRay .keyword { color:#080; font-weight:bold }
+.CodeRay .label { color:#970; font-weight:bold }
+.CodeRay .local-variable { color:#963 }
+.CodeRay .namespace { color:#707; font-weight:bold }
+.CodeRay .octal { color:#40E }
+.CodeRay .operator { }
+.CodeRay .predefined { color:#369; font-weight:bold }
+.CodeRay .predefined-constant { color:#069 }
+.CodeRay .predefined-type { color:#0a5; font-weight:bold }
+.CodeRay .preprocessor { color:#579 }
+.CodeRay .pseudo-class { color:#00C; font-weight:bold }
+.CodeRay .regexp .content { color:#808 }
+.CodeRay .regexp .delimiter { color:#404 }
+.CodeRay .regexp .modifier { color:#C2C }
+.CodeRay .regexp { background-color:hsla(300,100%,50%,0.06); }
+.CodeRay .reserved { color:#080; font-weight:bold }
+.CodeRay .shell .content { color:#2B2 }
+.CodeRay .shell .delimiter { color:#161 }
+.CodeRay .shell { background-color:hsla(120,100%,50%,0.06); }
+.CodeRay .string .char { color: #b0b }
+.CodeRay .string .content { color: #D20 }
+.CodeRay .string .delimiter { color: #710 }
+.CodeRay .string .modifier { color: #E40 }
+.CodeRay .string { background-color:hsla(0,100%,50%,0.05); }
+.CodeRay .symbol .content { color:#A60 }
+.CodeRay .symbol .delimiter { color:#630 }
+.CodeRay .symbol { color:#A60 }
+.CodeRay .tag { color:#070 }
+.CodeRay .type { color:#339; font-weight:bold }
+.CodeRay .value { color: #088; }
+.CodeRay .variable  { color:#037 }
+
+.CodeRay .insert { background: hsla(120,100%,50%,0.12) }
+.CodeRay .delete { background: hsla(0,100%,50%,0.12) }
+.CodeRay .change { color: #bbf; background: #007; }
+.CodeRay .head { color: #f8f; background: #505 }
+.CodeRay .head .filename { color: white; }
+
+.CodeRay .delete .eyecatcher { background-color: hsla(0,100%,50%,0.2); border: 1px solid hsla(0,100%,45%,0.5); margin: -1px; border-bottom: none; border-top-left-radius: 5px; border-top-right-radius: 5px; }
+.CodeRay .insert .eyecatcher { background-color: hsla(120,100%,50%,0.2); border: 1px solid hsla(120,100%,25%,0.5); margin: -1px; border-top: none; border-bottom-left-radius: 5px; border-bottom-right-radius: 5px; }
+
+.CodeRay .insert .insert { color: #0c0; background:transparent; font-weight:bold }
+.CodeRay .delete .delete { color: #c00; background:transparent; font-weight:bold }
+.CodeRay .change .change { color: #88f }
+.CodeRay .head .head { color: #f4f }

data/lib/heel.rb

@@ -1,21 +1,16 @@
 #--
-# Copyright (c) 2007, 2008 Jeremy Hinegardner
-# All rights reserved. Licensed under the BSD license.  See LICENSE for details
+# Copyright (c) 2007 - 2013 Jeremy Hinegardner
+# All rights reserved. Licensed under the BSD license. See LICENSE for details
 #++
 
 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"))
-
-    Dir.glob("#{descend_dir}/**/*.rb").each do |rb|
-      lib = rb.gsub(remove_parent,'')
-      require lib
-    end
-  end
+  VERSION = '3.0.0'
 end
 
-Heel.require_all_libs_relative_to_me
+require 'heel/configuration'
+require 'heel/directory_indexer'
+require 'heel/error_response'
+require 'heel/mime_map'
+require 'heel/rackapp'
+require 'heel/request'
+require 'heel/server'

data/lib/heel/configuration.rb

@@ -1,6 +1,6 @@
 #--
-# Copyright (c) 2007, 2008 Jeremy Hinegardner
-# All rights reserved.  Licensed under BSD license. See LICENSE for details.
+# Copyright (c) 2007 - 2013 Jeremy Hinegardner
+# All rights reserved. Licensed under the BSD license. See LICENSE for details
 #++
 
 module Heel
@@ -18,12 +18,10 @@ module Heel
     #           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
+      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
+      return root_dir
     end
 
     # returns:: [String] The full expanded path of the +config+ directory

data/lib/heel/directory_indexer.rb

@@ -1,9 +1,8 @@
 #--
-# Copyright (c) 2007, 2008 Jeremy Hinegardner
-# All rights reserved. Licensed under the BSD license.  See LICENSE for details
+# Copyright (c) 2007 - 2013 Jeremy Hinegardner
+# All rights reserved. Licensed under the BSD license. See LICENSE for details
 #++
 
-require 'heel'
 require 'erb'
 
 module Heel
@@ -16,32 +15,33 @@ module Heel
     attr_reader :template
 
     def initialize( template_file, options )
+      @template         = nil
       @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 
+      false
     end
-    
+
     def mime_map
       @mime_map ||= Heel::MimeMap.new
     end
 
     def highlighting?
-      @options[:highlighting]
+      @options.fetch( :highlighting, false)
     end
 
     def reload_on_template_change?
-      @options[:reload_template_on_change]
+      @options.fetch( :reload_template_on_change, false )
     end
 
     def using_icons?
-      @options[:using_icons]
+      @options.fetch( :using_icons, false )
     end
 
     def reload_template

data/lib/heel/error_response.rb

@@ -1,15 +1,14 @@
 #--
-# Copyright (c) 2007, 2008 Jeremy Hinegardner
-# All rights reserved. Licensed under the BSD license.  See LICENSE for details
+# Copyright (c) 2007 - 2013 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
+  class ErrorResponse
 
     attr_reader :base_uri
 
@@ -28,16 +27,18 @@ module Heel
     end
 
     def initialize(base_uri, body, status = 404, header = {})
-      super(body, status, header)
-      self['Content-type'] = 'text/html'
+      header    = header.merge( "Content-Type" => 'text/html' )
+      @response = Rack::Response.new( body, status, header )
       @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) ]
+      status   = @response.status                         # for the template
+      message  = ::Rack::Utils::HTTP_STATUS_CODES[status] # for the template
+      homepage = ErrorResponse.homepage                   # for the template
+      content  = ErrorResponse.template.result( binding )
+      @response.write( content )
+      return @response.finish
     end
   end
 end