heel 0.6.0 → 1.0.0

data/lib/heel/version.rb

@@ -1,21 +1,26 @@
+#--
+# Copyright (c) 2007, 2008 Jeremy Hinegardner
+# All rights reserved. Licensed under the BSD license.  See LICENSE for details
+#++
+
 module Heel
-    module Version
-        MAJOR   = 0 
-        MINOR   = 6 
-        BUILD   = 0 
+  module Version
+    MAJOR   = 1 
+    MINOR   = 0 
+    BUILD   = 0 
+
+    def to_a
+      [MAJOR, MINOR, BUILD]
+    end
 
-        def to_a
-            [MAJOR, MINOR, BUILD]
-        end
+    def to_s
+      to_a.join(".")
+    end
+    module_function :to_a
+    module_function :to_s
 
-        def to_s
-            to_a.join(".")
-        end
-        module_function :to_a
-        module_function :to_s
-        
-        STRING = Version.to_s
-    end 
-    VERSION = Version.to_s
+    STRING = Version.to_s
+  end 
+  VERSION = Version.to_s
 end
 

data/spec/configuration_spec.rb

@@ -0,0 +1,20 @@
+require 'spec/spec_helper'
+
+describe Heel::Configuration do
+  it "finds files relative to root of gem" do
+    Heel::Configuration.root_dir.should == File.expand_path(File.join(File.dirname(__FILE__), "..")) + "/"
+  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"))
+  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"))
+  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"))
+  end
+
+end

data/spec/directory_indexer_spec.rb

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

data/spec/rackapp_spec.rb

@@ -0,0 +1,43 @@
+require 'spec/spec_helper'
+require 'rack/mock'
+require 'heel/rackapp'
+
+describe Heel::RackApp do
+  before(:each) do
+    @app = Heel::RackApp.new( { :highlighting => 'true' } )
+    @request = Rack::MockRequest.new(@app)
+  end
+
+  it "should return the a listing for the currrent directory" do
+    res = @request.get("/")
+    res.should be_ok
+    res['Content-Type'].should == "text/html"
+    res.body.should =~ /Rakefile/
+  end
+
+  it 'should highlight a ruby file' do
+    res = @request.get("/gemspec.rb")
+    res.should be_ok
+    res['Content-Type'].should == "text/html"
+    res.body.should =~ /class="CodeRay"/
+  end
+
+  it "should not highlight a ruby file if told not to" do
+    res = @request.get("/gemspec.rb?highlighting=off")
+    res.should be_ok
+    res.body.size.should == File.size("gemspec.rb")
+    res['Content-Type'].should == "text/plain"
+  end
+
+  it "should return a 405 if given a non-GET request" do
+    res = @request.post("/")
+    res.should_not be_ok
+    res.status.should == 405
+  end
+
+  it "should return a 403 if accessing an invalid location" do
+    res = @request.get("/../../../../etc/passwd")
+    res.should_not be_ok
+    res.status.should == 403
+  end
+end

data/spec/server_spec.rb

@@ -1,115 +1,114 @@
-require File.expand_path(File.join(File.dirname(__FILE__),"spec_helper.rb"))
+require "spec/spec_helper"
 describe Heel::Server do
-    before(:each) do 
-        @stdin = StringIO.new
-        @stdout = StringIO.new
-        @stderr = StringIO.new
-        ENV["HEEL_DEFAULT_DIRECTORY"] = "/tmp/heel"
+  before(:each) do 
+    @stdin = StringIO.new
+    @stdout = StringIO.new
+    @stderr = StringIO.new
+    ENV["HEEL_DEFAULT_DIRECTORY"] = "/tmp/heel"
+  end
+
+  after(:each) do
+    ENV.delete("HEEL_DEFAULT_DIRECTORY")
+    FileUtils.rm_rf "/tmp/heel"
+  end
+
+  it "should output the version when invoked with --version" do
+    server = Heel::Server.new(["--version"])
+    server.set_io(@stdin, @stdout)
+    begin
+      server.run
+    rescue SystemExit => se
+      se.status.should == 0
+      @stdout.string.should =~ /version #{Heel::VERSION}/
     end
-    
-    after(:each) do
-        ENV.delete("HEEL_DEFAULT_DIRECTORY")
-        FileUtils.rm_rf "/tmp/heel"
+  end
+
+  it "should output the Usage when invoked with --help" do
+    server = Heel::Server.new(["--help"])
+    server.set_io(@stdin, @stdout)
+    begin
+      server.run
+    rescue SystemExit => se
+      se.status.should == 0
+      @stdout.string.should =~ /Usage/m
     end
-    
-    it "should output the version when invoked with --version" do
-        server = Heel::Server.new(["--version"])
-        server.set_io(@stdin, @stdout)
-        begin
-            server.run
-        rescue SystemExit => se
-            se.status.should == 0
-            @stdout.string.should =~ /version #{Heel::VERSION}/
-        end
+  end
+
+  it "should have an error when invoked with invalid parameters" do
+    server = Heel::Server.new(["--junk"])
+    server.set_io(@stdin,@stdout)
+    begin
+      server.run
+    rescue SystemExit => se
+      se.status.should == 1
+      @stdout.string.should =~ /Try .*--help/m
     end
-    
-    it "should output the Usage when invoked with --help" do
-        server = Heel::Server.new(["--help"])
-        server.set_io(@stdin, @stdout)
-        begin
-            server.run
-        rescue SystemExit => se
-            se.status.should == 0
-            @stdout.string.should =~ /Usage/m
-        end
+  end
+
+  it "should raise print an error if the directory to serve does not exist" do
+    server = Heel::Server.new(%w[--root /not/valid])
+    server.set_io(@stdin,@stdout)
+    begin
+      server.run
+    rescue SystemExit => se
+      se.status.should == 1
+      @stdout.string.should =~ /Try .*--help/m
     end
-    
-    it "should have an error when invoked with invalid parameters" do
-        server = Heel::Server.new(["--junk"])
-        server.set_io(@stdin,@stdout)
-        begin
-            server.run
-        rescue SystemExit => se
-            se.status.should == 1
-            @stdout.string.should =~ /Try .*--help/m
-        end
+  end
+
+  it "should allow port and address to be set" do
+    server = Heel::Server.new(%w[--port 4242 --address 192.168.1.1])
+    server.merge_options
+    server.options.address.should == "192.168.1.1"
+    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
+    server.options.launch_browser.should == false
+  end
+
+  it "should attempt to kill the process" do
+    server = Heel::Server.new(%w[--kill])
+    server.set_io(@stdin,@stdout)
+
+    begin
+      server.run
+      violated("Should have thrown SystemExit")
+    rescue SystemExit => se
+      se.status.should == 0
+      @stdout.string.should =~ /Done/m
     end
-    
-    it "should raise print an error if the directory to serve does not exist" do
-        server = Heel::Server.new(%w[--root /not/valid])
-        server.set_io(@stdin,@stdout)
-        begin
-            server.run
-        rescue SystemExit => se
-            se.status.should == 1
-            @stdout.string.should =~ /Try .*--help/m
-        end
+  end
+
+  it "should setup a heel directory" do
+    server = Heel::Server.new(%w[--daemonize])
+    server.set_io(@stdin,@stdout)
+    File.directory?(server.default_directory).should == false
+    server.setup_heel_dir
+    File.directory?(server.default_directory).should == true
+    @stdout.string.should =~ /Created/m
+  end
+
+  it "should send a signal to a pid" do
+    server = Heel::Server.new(%w[--kil])
+    server.set_io(@stdin,@stdout)
+    server.setup_heel_dir
+
+    File.open(server.pid_file,"w+") { |f| f.write("-42") }
+    begin
+      server.run
+      violated("Should have exited")
+    rescue SystemExit => se
+      se.status.should == 0
+      @stdout.string.should =~ /Sending TERM to process -42/m
     end
-    
-    it "should allow port and address to be set" do
-        server = Heel::Server.new(%w[--port 4242 --address 192.168.1.1])
-        server.merge_options
-        server.options.address.should == "192.168.1.1"
-        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
-        server.options.launch_browser.should == false
-    end
-    
-    it "should attempt to kill the process" do
-        server = Heel::Server.new(%w[--kill])
-        server.set_io(@stdin,@stdout)
-        
-        begin
-            server.run
-            violated("Should have thrown SystemExit")
-        rescue SystemExit => se
-            se.status.should == 0
-            @stdout.string.should =~ /Done/m
-        end
-    end
-    
-    it "should setup a heel directory" do
-        server = Heel::Server.new(%w[--daemonize])
-        server.set_io(@stdin,@stdout)
-        File.directory?(server.default_directory).should == false
-        server.setup_heel_dir
-        File.directory?(server.default_directory).should == true
-        @stdout.string.should =~ /Created/m
-    end
-    
-    it "should send a signal to a pid" do
-        server = Heel::Server.new(%w[--kil])
-        server.set_io(@stdin,@stdout)
-        server.setup_heel_dir
-        
-        File.open(server.pid_file,"w+") { |f| f.write("-42") }
-        begin
-            server.run
-            violated("Should have exited")
-        rescue SystemExit => se
-            se.status.should == 0
-            @stdout.string.should =~ /Sending TERM to process -42/m
-        end
-    end
-    
-end
+  end
+end

data/tasks/announce.rake

@@ -0,0 +1,42 @@
+#--
+# Copyright (c) 2007, 2008 Jeremy Hinegardner
+# All rights reserved.  Licensed under the BSD license.  See LICENSE for details
+#++
+
+require 'tasks/config'
+#-------------------------------------------------------------------------------
+# announcement methods
+#-------------------------------------------------------------------------------
+
+proj_config = Configuration.for('project')
+namespace :announce do
+  desc "create email for ruby-talk"
+  task :email do
+    info = Utils.announcement
+
+    File.open("email.txt", "w") do |mail|
+      mail.puts "From: #{proj_config.author} <#{proj_config.email}>"
+      mail.puts "To: ruby-talk@ruby-lang.org"
+      mail.puts "Date: #{Time.now.rfc2822}"
+      mail.puts "Subject: [ANN] #{info[:subject]}"
+      mail.puts
+      mail.puts info[:title]
+      mail.puts
+      mail.puts info[:urls]
+      mail.puts 
+      mail.puts info[:description]
+      mail.puts 
+      mail.puts "{{ Release notes for Version #{Heel::VERSION} }}"
+      mail.puts 
+      mail.puts info[:release_notes]
+      mail.puts
+      mail.puts info[:urls]
+    end
+    puts "Created the following as email.txt:"
+    puts "-" * 72
+    puts File.read("email.txt")
+    puts "-" * 72
+  end
+
+  CLOBBER << "email.txt"
+end

data/tasks/config.rb

@@ -0,0 +1,103 @@
+require 'configuration'
+
+require 'rake'
+require 'heel'
+require 'heel/configuration'
+require 'heel/version'
+
+require 'tasks/utils'
+
+#-----------------------------------------------------------------------
+# General project configuration
+#-----------------------------------------------------------------------
+Configuration.for('project') {
+  name          Heel.to_s.downcase
+  version       Heel::VERSION
+  author        "Jeremy Hinegardner"
+  email         "jeremy at hinegardner dot org"
+  homepage      Heel::Configuration::HOMEPAGE
+  description   Utils.section_of("README", "description")
+  summary       description.split(".").first
+  history       "HISTORY"
+  license       "LICENSE"
+  readme        "README"
+}
+
+#-----------------------------------------------------------------------
+# Packaging 
+#-----------------------------------------------------------------------
+Configuration.for('packaging') {
+  # files in the project 
+  proj_conf = Configuration.for('project')
+  files {
+    bin       FileList["bin/*"]
+    lib       FileList["lib/**/*.rb"]
+    test      FileList["spec/**/*.rb"]
+    data      FileList["data/**/*"]
+    tasks     FileList["tasks/**/*.r{ake,b}"]
+    rdoc      FileList[proj_conf.readme, proj_conf.history,
+                       proj_conf.license] + lib
+    all       bin + lib + test + data + rdoc + tasks 
+  }
+
+  # ways to package the results
+  formats {
+    tgz true
+    zip true
+    gem Configuration::Table.has_key?('gem')
+  }
+}
+
+#-----------------------------------------------------------------------
+# Gem packaging
+#-----------------------------------------------------------------------
+Configuration.for("gem") {
+  spec "gemspec.rb"
+  Configuration.for('packaging').files.all << spec
+}
+
+#-----------------------------------------------------------------------
+# Testing
+#-----------------------------------------------------------------------
+Configuration.for('test') {
+  mode      "spec"
+  files     Configuration.for("packaging").files.test
+  options   %w[ --format specdoc --color ]
+  ruby_opts %w[ ]
+}
+
+#-----------------------------------------------------------------------
+# Rcov 
+#-----------------------------------------------------------------------
+Configuration.for('rcov') {
+  output_dir  "coverage"
+  libs        %w[ lib ]
+  rcov_opts   %w[ --html ]
+  ruby_opts   %w[ ]
+  test_files  Configuration.for('packaging').files.test
+
+  # hmm... how to configure remote publishing
+}
+
+#-----------------------------------------------------------------------
+# Rdoc 
+#-----------------------------------------------------------------------
+Configuration.for('rdoc') {
+  files       Configuration.for('packaging').files.rdoc
+  main        files.first
+  title       Configuration.for('project').name
+  options     %w[ --line-numbers --inline-source ]
+  output_dir  "doc"
+}
+
+#-----------------------------------------------------------------------
+# Rubyforge 
+#-----------------------------------------------------------------------
+Configuration.for('rubyforge') {
+  project       "copiousfreetime"
+  user          "jjh"
+  host          "rubyforge.org"
+  rdoc_location "#{user}@#{host}:/var/www/gforge-projects/copiousfreetime/heel"
+}
+
+