RubyGems - heel - Versions diffs - 2.0.0 → 3.0.0 - Mend

heel 2.0.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (34) hide show

data/CONTRIBUTING.md +46 -0
data/{HISTORY → HISTORY.rdoc} +13 -0
data/Manifest.txt +45 -0
data/{README → README.rdoc} +2 -3
data/Rakefile +20 -0
data/TODO +2 -0
data/bin/heel +1 -3
data/data/css/coderay-alpha.css +120 -0
data/lib/heel.rb +10 -15
data/lib/heel/configuration.rb +6 -8
data/lib/heel/directory_indexer.rb +9 -9
data/lib/heel/error_response.rb +11 -10
data/lib/heel/mime_map.rb +3 -3
data/lib/heel/rackapp.rb +13 -26
data/lib/heel/request.rb +3 -3
data/lib/heel/server.rb +88 -75
data/spec/configuration_spec.rb +9 -5
data/spec/directory_indexer_spec.rb +8 -8
data/spec/rackapp_spec.rb +16 -16
data/spec/server_spec.rb +23 -22
data/spec/spec_helper.rb +10 -9
data/tasks/default.rake +212 -0
data/tasks/this.rb +202 -0
metadata +178 -110
data/gemspec.rb +0 -42
data/lib/heel/logger.rb +0 -42
data/lib/heel/version.rb +0 -26
data/tasks/announce.rake +0 -42
data/tasks/config.rb +0 -103
data/tasks/distribution.rake +0 -47
data/tasks/documentation.rake +0 -36
data/tasks/rspec.rb +0 -34
data/tasks/rubyforge.rb +0 -67
data/tasks/utils.rb +0 -85

data/lib/heel/mime_map.rb CHANGED Viewed

@@ -1,8 +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 'mime/types'
 module Heel

data/lib/heel/rackapp.rb CHANGED Viewed

@@ -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 'rack'
 require 'rack/utils'
 require 'coderay'
@@ -20,7 +19,7 @@ module Heel
     attr_reader   :ignore_globs
-    def initialize(options = {})
+    def initialize(options = {})
       @ignore_globs               = options[:ignore_globs] ||= %w( *~ .htaccess . )
       @document_root              = options[:document_root] ||= Dir.pwd
       @directory_listing_allowed  = options[:directory_listing_allowed] ||= true
@@ -48,7 +47,6 @@ module Heel
     end
     def directory_indexer
-      indexer_ignore = ( ignore_globs + [ document_root] ).flatten
       @directory_indexer ||= DirectoryIndexer.new( directory_index_template_file, @options )
     end
@@ -67,13 +65,11 @@ module Heel
       dir_index = File.join(req.request_path, directory_index_html)
       if File.file?(dir_index) and File.readable?(dir_index) then
         response['Content-Type']   = mime_map.mime_type_of(dir_index).to_s
-        response['Content-Length'] = File.size(dir_index).to_s
-        response.body              = File.open(dir_index)
+        response.write( File.read( dir_index ) )
       elsif directory_listing_allowed? then
         body                       = directory_indexer.index_page_for(req)
         response['Content-Type']   = 'text/html'
-        response['Content-Length'] = body.length.to_s
-        response.body             << body
+        response.write( body )
       else
         return ::Heel::ErrorResponse.new(req.path_info,"Directory index is forbidden", 403).finish
       end
@@ -100,39 +96,30 @@ module Heel
             <head>
             <title>#{req.path_info}</title>
             <!-- CodeRay syntax highlighting CSS -->
-            <link rel="stylesheet" href="/heel_css/coderay-cycnus.css" type="text/css" />
+            <link rel="stylesheet" href="/heel_css/coderay-alpha.css" type="text/css" />
             </head>
             <body>
-              <div class="CodeRay">
-                <pre>
-  #{CodeRay.scan_file(req.request_path,:auto).html({:line_numbers => :inline})}
-                </pre>
-              </div>
+  #{CodeRay.scan_file(req.request_path,:auto).html({ :wrap => :div, :line_numbers => :inline })}
             </body>
           </html>
           EOM
           response['Content-Type']    = 'text/html'
           response['Content-Length']  = body.length.to_s
-          response.body << body
+          response.write( body )
           return response.finish
         end
       end
       # fall through to a default file return
-      #
       file_type                   = mime_map.mime_type_of(req.request_path)
       response['Content-Type']    = file_type.to_s
-      response['Content-Length']  = req.stat.size.to_s
-      return response.finish do
-        File.open(req.request_path) do |f|
-          while p = f.read(8192)
-            response.write p
-          end
+      File.open( req.request_path ) do |f|
+        while p = f.read( 8192 ) do
+          response.write( p )
         end
       end
+      return response.finish
     end
     # interface to rack, env is a hash
@@ -145,7 +132,7 @@ module Heel
         if req.forbidden? or should_ignore?(req.request_path) then
           return ErrorResponse.new(req.path_info,"You do not have permissionto view #{req.path_info}",403).finish
         end
-        return ErrorResponse.new(req.path_info, "File not found: #{req.path_info}",403).finish unless req.found?
+        return ErrorResponse.new(req.path_info, "File not found: #{req.path_info}",404).finish unless req.found?
         return directory_index_response(req)                           if req.for_directory?
         return file_response(req)                                      if req.for_file?
       else

data/lib/heel/request.rb CHANGED Viewed

@@ -1,8 +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 'rack'
 module Heel
   # nothing more than a rack request with some additional methods and overriding

data/lib/heel/server.rb CHANGED Viewed

@@ -1,14 +1,13 @@
 #--
-# 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 'thin'
 require 'ostruct'
 require 'launchy'
 require 'fileutils'
 require 'heel/rackapp'
+require 'puma'
 module Heel
   class Server
@@ -39,34 +38,32 @@ module Heel
       set_io
-      @options        = default_options
-      @parsed_options = ::OpenStruct.new
-      @parser         = option_parser
-      @error_message  = nil
+      @options         = default_options
+      @parsed_options  = ::OpenStruct.new
+      @parser          = option_parser
+      @error_message   = nil
       begin
         @parser.parse!(argv)
       rescue ::OptionParser::ParseError => pe
         msg = ["#{@parser.program_name}: #{pe}",
-                        "Try `#{@parser.program_name} --help` for more information"]
-                        @error_message = msg.join("\n")
+               "Try `#{@parser.program_name} --help` for more information"]
+        @error_message = msg.join("\n")
       end
     end
     def default_options
-      if @default_options.nil? then
-        @default_options                 = ::OpenStruct.new
-        @default_options.show_version    = false
-        @default_options.show_help       = false
-        @default_options.address         = "0.0.0.0"
-        @default_options.port            = 4331
-        @default_options.document_root   = Dir.pwd
-        @default_options.daemonize       = false
-        @default_options.highlighting    = false
-        @default_options.kill            = false
-        @default_options.launch_browser  = true
-      end
-      return @default_options
+      defaults                 = ::OpenStruct.new
+      defaults.show_version    = false
+      defaults.show_help       = false
+      defaults.address         = "0.0.0.0"
+      defaults.port            = 4331
+      defaults.document_root   = Dir.pwd
+      defaults.daemonize       = false
+      defaults.highlighting    = false
+      defaults.kill            = false
+      defaults.launch_browser  = true
+      return defaults
     end
     def default_directory
@@ -81,6 +78,14 @@ module Heel
       File.join(default_directory,"heel.log")
     end
+    def win?
+      RUBY_PLATFORM =~ /mswin|mingw/
+    end
+    def java?
+      RUBY_PLATFORM =~ /java/
+    end
     def option_parser
       OptionParser.new do |op|
         op.separator ""
@@ -88,10 +93,11 @@ module Heel
         op.on("-a", "--address ADDRESS", "Address to bind to",
                                         "  (default: #{default_options.address})") do |add|
           @parsed_options.address = add
-                                        end
+        end
         op.on("-d", "--daemonize", "Run daemonized in the background") do
-          raise ::OptionParser::ParseError, "Daemonizing is not supported on windows" if Thin.win?
+          raise ::OptionParser::ParseError, "Daemonizing is not supported on windows" if win?
+          raise ::OptionParser::ParseError, "Daemonizing is not supported on java" if java?
           @parsed_options.daemonize = true
         end
@@ -106,23 +112,23 @@ module Heel
         op.on("--[no-]highlighting", "Turn on or off syntax highlighting",
                                              "  (default: off)") do |highlighting|
           @parsed_options.highlighting = highlighting
-                                             end
+        end
         op.on("--[no-]launch-browser", "Turn on or off automatic browser launch",
                                                "  (default: on)") do |l|
           @parsed_options.launch_browser = l
-                                               end
+        end
         op.on("-p", "--port PORT", Integer, "Port to bind to",
                                         "  (default: #{default_options.port})") do |port|
           @parsed_options.port = port
-                                        end
+        end
         op.on("-r","--root ROOT",
                       "Set the document root"," (default: #{default_options.document_root})") do |document_root|
           @parsed_options.document_root = File.expand_path(document_root)
           raise ::OptionParser::ParseError, "#{@parsed_options.document_root} is not a valid directory" if not File.directory?(@parsed_options.document_root)
-                      end
+        end
         op.on("-v", "--version", "Show version") do
           @parsed_options.show_version = true
@@ -132,9 +138,7 @@ module Heel
     def merge_options
       options = default_options.marshal_dump
-      @parsed_options.marshal_dump.each_pair do |key,value|
-        options[key] = value
-      end
+      options.merge!( @parsed_options.marshal_dump )
       @options = OpenStruct.new(options)
     end
@@ -174,7 +178,7 @@ module Heel
         rescue Errno::ESRCH
           @stdout.puts "Unable to kill process with pid #{pid}.  Process does not exist.  Removing stale pid file."
           File.unlink(pid_file)
-        rescue Errno::EPERM
+        rescue Errno::EPERM
           @stdout.puts "Unable to kill process with pid #{pid}.  No permissions to kill process."
         end
       else
@@ -197,7 +201,7 @@ module Heel
     # make sure that if we are daemonizing the process is not running
     def ensure_not_running
       if options.daemonize and File.exist?(pid_file) then
-        @stdout.puts "ERROR: PID File #{pid_file} already exists.  Heel may already be running."
+        @stdout.puts "ERROR: PID File #{pid_file} already exists. Heel may already be running."
         @stdout.puts "ERROR: Check the Log file #{log_file}"
         @stdout.puts "ERROR: Heel will not start until the .pid file is cleared (`heel --kill' to clean it up)."
         exit 1
@@ -205,7 +209,7 @@ module Heel
     end
     def launch_browser
-      Thread.new do
+      Thread.new do
         print "Launching your browser"
         if options.daemonize then
           puts " at http://#{options.address}:#{options.port}/"
@@ -216,24 +220,11 @@ module Heel
       end
     end
-    def thin_server
-      server = Thin::Server.new(options.address, options.port)
-      # overload the name of the process so it shows up as heel not thin
-      def server.name
-        "heel (v#{Heel::VERSION})"
-      end
-      server.pid_file = pid_file
-      server.log_file = log_file
+    def heel_app
       app = Heel::RackApp.new({ :document_root => options.document_root,
                                 :highlighting  => options.highlighting})
-      Heel::Logger.log_file = log_file
-      server.app = Rack::Builder.new {
-        use Heel::Logger
-        map "/" do
+      stack = Rack::Builder.new {
+        map "/" do
           run app
         end
         map "/heel_css" do
@@ -242,40 +233,62 @@ module Heel
         map "/heel_icons" do
           run Rack::File.new(Heel::Configuration.data_path("famfamfam", "icons"))
         end
       }
-      server.app = Thin::Stats::Adapter.new(server.app, "/heel_stats")
-      return server
+      return stack.to_app
     end
-    def start_thin_server
-      server = thin_server
+    def start_server
+      server_thread = Thread.new do
+        if options.daemonize then
+          if cpid = fork then
+            Process.waitpid( cpid )
+          else
+            server = Rack::Server.new( server_options )
+            server.start
+          end
+        else
+          server = Rack::Server.new( server_options )
+          server.start
+        end
+      end
+      return server_thread
+    end
+    def start_server_old
+      server = Rack::Server.new( server_options )
       server_thread = Thread.new do
-        begin
-          if options.daemonize then
-            if cpid = fork then
-              # wait for the top child of the server double fork to exit
-              Process.waitpid(cpid)
-            else
-              server.daemonize
-              server.start
-            end
+        if options.daemonize then
+          if cpid = fork then
+            # wait for the server to span and then move on to launching the
+            # browser
+            Process.waitpid( cpid )
           else
-            begin
-              server.start
-            rescue RuntimeError
-              $stderr.puts "ERROR: Unable to start server.  Heel may already be running.  Please check running processes or run `heel --kill'"
-              exit 1
-            end
+            server.start
+          end
+        else
+          begin
+            server.start
+          rescue RuntimeError
+            $stderr.puts "ERROR: Unable to start server. Heel may already be running. Please check running processes or run `heel --kill'"
+            exit 1
           end
         end
       end
+      return server_thread
+    end
+    def server_options
+      {
+        :app  => heel_app,
+        :pid  => pid_file,
+        :Port => options.port,
+        :Host => options.address,
+        :environment => 'deployment',
+        :server => 'puma',
+        :daemonize => options.daemonize
+      }
     end
     # run the heel server with the current options.
     def run
@@ -284,7 +297,7 @@ module Heel
       setup_heel_dir
       ensure_not_running
-      server_thread = start_thin_server
+      server_thread = start_server
       if options.launch_browser then
         launch_browser.join

data/spec/configuration_spec.rb CHANGED Viewed

@@ -1,20 +1,24 @@
-require 'spec/spec_helper'
+require 'spec_helper'
+require 'pathname'
 describe Heel::Configuration do
+  before do
+    @proj_root = Pathname.new( __FILE__ ).parent.parent
+  end
   it "finds files relative to root of gem" do
-    Heel::Configuration.root_dir.should == File.expand_path(File.join(File.dirname(__FILE__), "..")) + "/"
+    Heel::Configuration.root_dir.must_equal @proj_root.expand_path.to_s + File::SEPARATOR
   end
   it "finds files in the config dir of the project" do
-    Heel::Configuration.config_path('config.rb').should == File.expand_path(File.join(File.dirname(__FILE__), "..", "config", "config.rb"))
+    Heel::Configuration.config_path('config.rb').must_equal @proj_root.join("config", "config.rb").to_s
   end
   it "finds files in the data dir of the project" do
-    Heel::Configuration.data_path('famfamfam', 'icons').should == File.expand_path(File.join(File.dirname(__FILE__), "..", "data", "famfamfam", "icons"))
+    Heel::Configuration.data_path('famfamfam', 'icons').must_equal @proj_root.join( "data", "famfamfam", "icons" ).to_s
   end
   it "finds files in the lib dir of the project" do
-    Heel::Configuration.lib_path('heel.rb').should == File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "heel.rb"))
+    Heel::Configuration.lib_path('heel.rb').must_equal @proj_root.join("lib", "heel.rb").to_s
   end
 end

data/spec/directory_indexer_spec.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-require 'spec/spec_helper'
+require 'spec_helper'
 describe Heel::DirectoryIndexer do
   before(:each) do
@@ -7,28 +7,28 @@ describe Heel::DirectoryIndexer do
   it "should ignore .htaccess files" do
     @indexer.options[:ignore_globs] = %w( *~ .htaccess . )
-    @indexer.should_ignore?(".htaccess").should == true
+    @indexer.should_ignore?(".htaccess").must_equal true
   end
   it "should not ignore .html files " do
     @indexer.options[:ignore_globs] = %w( *~ .htaccess . )
-    @indexer.should_ignore?("something.html").should == false
+    @indexer.should_ignore?("something.html").must_equal false
   end
   it "can tell if highlighting is to be performed" do
-    @indexer.should be_highlighting
+    @indexer.must_be :highlighting?
   end
   it "knows if the template should be reloaded on changes" do
-    @indexer.should_not be_reload_on_template_change
+    @indexer.reload_on_template_change?.must_equal false
   end
-  it "may or maynot use icons" do
-    @indexer.should_not be_using_icons
+  it "uses icons" do
+    @indexer.using_icons?.must_equal false
   end
   it "uses a mime map" do
-    @indexer.mime_map.should be_instance_of(Heel::MimeMap)
+    @indexer.mime_map.must_be_instance_of(Heel::MimeMap)
   end
 end