adsf 1.0.1 → 1.1.1

data/NEWS.md

@@ -0,0 +1,22 @@
+adsf News
+=========
+
+1.1.1
+-----
+
+* Made SIGINT/SIGTERM cause proper exit
+
+1.1.0
+-----
+
+* Added support for custom index filenames [Mark Meves]
+
+1.0.1
+-----
+
+* Added runtime dependency on Rack
+
+1.0
+---
+
+* Initial release

data/README.md

@@ -0,0 +1,52 @@
+adsf
+====
+
+adsf (A Dead Simple Fileserver) is a tiny static file server that you can launch instantly in any directory, like this:
+
+	▸ ls -l
+	total 0
+	drwxr-xr-x  2 ddfreyne  staff  68 May 29 10:04 about
+	drwxr-xr-x  2 ddfreyne  staff  68 May 29 10:04 contact
+	-rw-r--r--  1 ddfreyne  staff   0 May 29 10:04 index.html
+	drwxr-xr-x  2 ddfreyne  staff  68 May 29 10:04 projects
+
+	▸ adsf
+	2009-05-29 10:04:44] INFO  WEBrick 1.3.1
+	[2009-05-29 10:04:44] INFO  ruby 1.8.7 (2008-08-11) [i686-darwin9.6.1]
+	[2009-05-29 10:04:44] INFO  WEBrick::HTTPServer#start: pid=2757 port=3000
+
+… and now you can go to http://localhost:3000/ and start browsing.
+
+You can specify a custom web root with `-r` or `--root`; the server will be started in that directory (e.g. `adsf -r public/`). If you want to specificy custom index filenames (other than the default `index.html`), you can use the `-i` or `--index-filename` option, which is a comma-separated list of filenames (e.g. `adsf -i index.html,index.xml`).
+
+adsf has one dependency, namely on Rack. It is licenced under the MIT license. Patches are always welcome; check my contact e-mail address at the bottom of this document.
+
+Using adsf programmatically
+---------------------------
+
+You can use adsf programmatically in your Rack applications. [nanoc](http://nanoc.stoneship.org/) uses adsf for its “view” command, for example. adsf consists of one middleware class that finds index filenames, and rewrites these requests so that Rack::File can be used to serve these files.
+
+Here’s an example middleware/application stack that runs a web server with the "public/" directory as its web root:
+
+	use Adsf::Rack::IndexFileFinder, :root => "public/"
+	run Rack::File.new("public/")
+
+The `:root` option is required; it should contain the path to the web root.
+
+You can also specify an `:index_filenames` option, containing the names of the index filenames that will be served when a directory containing an index file is requested. Usually, this will simply be `[ 'index.html' ]`, but under different circumstances (when using IIS, for exmaple), the array may have to be modified to include index filenames such as `default.html` or `index.xml`. Here’s an example middleware/application stack that uses custom index filenames:
+
+	use Adsf::Rack::IndexFileFinder,
+	  :root => "public/",
+	  :index_filenames => %w( index.html index.xhtml index.xml )
+	run Rack::File.new("public/")
+
+Authors
+-------
+
+* Denis Defreyne
+* Mark Meves
+
+Contact
+-------
+
+You can reach me at <denis.defreyne@stoneship.org>.

data/Rakefile

@@ -4,7 +4,7 @@ require 'adsf'
 
 desc 'Run all tests'
 task :test do
-  $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/..'))
+  $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
 
   require 'minitest/unit'
   MiniTest::Unit.autorun

data/bin/adsf

@@ -8,9 +8,10 @@ require 'adsf'
 
 # Parse options
 options = {
-  :handler => nil,
-  :port    => 3000,
-  :root    => '.'
+  :handler            => nil,
+  :port               => 3000,
+  :index_filenames => %w( index.html ),
+  :root               => '.'
 }
 OptionParser.new do |opts|
   opts.banner = "Usage: adsf [options]"
@@ -29,6 +30,11 @@ OptionParser.new do |opts|
     exit
   end
 
+  # index filenames
+  opts.on('-i', '--index-filenames [index-filenames]', 'Specify index filenames (comma-separated)') do |o|
+    options[:index_filenames] = o.split(',')
+  end
+
   # port
   opts.on('-p', '--port [port]', Integer, 'Specify the port number to use') do |o|
     options[:port] = o
@@ -55,9 +61,16 @@ app = Rack::Builder.new do
   use Rack::CommonLogger
   use Rack::ShowExceptions
   use Rack::Lint
-  use Adsf::Rack::IndexFileFinder, :root => options[:root]
+  use Adsf::Rack::IndexFileFinder,
+    :root            => options[:root],
+    :index_filenames => options[:index_filenames]
   run Rack::File.new(options[:root])
 end.to_app
 
+# Be quittable
+%w( INT TERM ).each do |s|
+  Signal.trap(s) { handler.shutdown }
+end
+
 # Run
 handler.run(app, :Port => options[:port])

data/lib/adsf.rb

@@ -1,6 +1,6 @@
 module Adsf
 
-  VERSION = '1.0.1'
+  VERSION = '1.1.1'
 
 end
 

data/lib/adsf/rack/index_file_finder.rb

@@ -3,8 +3,9 @@ module Adsf::Rack
   class IndexFileFinder
 
     def initialize(app, options)
-      @app  = app
+      @app = app
       @root = options[:root] or raise ArgumentError, ':root option is required but was not given'
+      @index_filenames = options[:index_filenames] || [ 'index.html' ]
     end
 
     def call(env)
@@ -25,9 +26,8 @@ module Adsf::Rack
       # Add index file if necessary
       new_env = env.dup
       if ::File.directory?(path)
-        path_to_index = ::File.join(path, 'index.html')
-        if ::File.file?(path_to_index)
-          new_env['PATH_INFO'] = ::File.join(path_info, 'index.html')
+        if index_filename = index_file_in(path)
+          new_env['PATH_INFO'] = ::File.join(path_info, index_filename)
         end
       end
 
@@ -35,6 +35,14 @@ module Adsf::Rack
       @app.call(new_env)
     end
 
+  private
+
+    def index_file_in(dir)
+      @index_filenames.find do |index_filename|
+        ::File.file?(::File.join(dir, index_filename))
+      end
+    end
+
   end
 
 end

metadata

@@ -1,85 +1,66 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: adsf
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 1
-  version: 1.0.1
+version: !ruby/object:Gem::Version
+  version: 1.1.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-04-05 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
+  requirement: &70157238354860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *70157238354860
 description: a tiny static file server
 email: denis.defreyne@stoneship.org
-executables: 
+executables:
 - adsf
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - ChangeLog
 - LICENSE
-- NEWS.rdoc
+- NEWS.md
 - Rakefile
-- README.rdoc
+- README.md
 - bin/adsf
 - lib/adsf/rack/index_file_finder.rb
 - lib/adsf/rack.rb
 - lib/adsf.rb
-has_rdoc: false
 homepage: http://stoneship.org/software/adsf/
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 8
-      - 5
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.5
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: adsf
-rubygems_version: 1.3.6
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: a tiny static file server
 test_files: []
-
+has_rdoc: false

data/NEWS.rdoc

@@ -1,9 +0,0 @@
-= adsf News
-
-== 1.0.1
-
-* Added runtime dependency on Rack
-
-== 1.0
-
-* Initial release

data/README.rdoc

@@ -1,27 +0,0 @@
-= adsf
-
-adsf (A Dead Simple Fileserver) is a tiny static file server that you can launch instantly in any directory, like this:
-
-  attignawantan ✓ ~/my_site ▸ ls -l
-  total 0
-  drwxr-xr-x  2 ddfreyne  staff  68 May 29 10:04 about
-  drwxr-xr-x  2 ddfreyne  staff  68 May 29 10:04 contact
-  -rw-r--r--  1 ddfreyne  staff   0 May 29 10:04 index.html
-  drwxr-xr-x  2 ddfreyne  staff  68 May 29 10:04 projects
-  attignawantan ✓ ~/my_site ▸ adsf
-  2009-05-29 10:04:44] INFO  WEBrick 1.3.1
-  [2009-05-29 10:04:44] INFO  ruby 1.8.7 (2008-08-11) [i686-darwin9.6.1]
-  [2009-05-29 10:04:44] INFO  WEBrick::HTTPServer#start: pid=2757 port=3000
-
-… and now you can go to http://localhost:3000/ and start browsing.
-
-Some more details about adsf:
-
-* adsf has only one feature and that is serving static files.
-* The only documentation you'll get is from the --help commandline option. :)
-* Rack is the only dependency.
-* It is licenced under the MIT licence.
-
-== Contact
-
-You can reach me at <denis.defreyne@stoneship.org>.