adsf 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 30bf98446c4011646d9a41618ee9cb1f4da0b6a0
-  data.tar.gz: 7630399b32f0ac05c1e4108608bc8112fca81287
+SHA256:
+  metadata.gz: 18fe44d3963307d81690a262c5fb57d06fed10e560499dac1fc9f8d1bacd9596
+  data.tar.gz: dc1fc182824d28cb9d6cf532fe52b2681ba95bd9e3f6508008d70165c4b9a9b7
 SHA512:
-  metadata.gz: 42e186eb4bdb29a97675ba72c53d71eed7d7742dfa1e155b4ecdd7969101f73b089f809f91bd041181e7703d1fa8460c6a59892b5130241c6925e8fcb527c2f8
-  data.tar.gz: 160446420d76dd484ff674c95d8be0ca828f2a75edc103683828ea28528c4bb161c5608f9c096d5a8ff110f9711e9f352be099e624893caa92a3d920e482ca45
+  metadata.gz: 06f8d4b5a752c387cc7b36a1edf4ed00fd934d3201bafcbbffb565da3f6707c75aebe47eb34c408e3ee8be6689a5cf9da424aa93f78b30932885458c433b7529
+  data.tar.gz: 3679850b8b89c0944ea9267396c3ea90e41e10ac7221aed043990e8e400730ce556b093009bc91afbfafd501e38347253cc6e713146d4eade053511cf7e05e2d

data/Gemfile

@@ -1,13 +1,12 @@
 source 'https://rubygems.org'
 
-gem 'rack'
+gemspec
 
 group :development do
-  gem 'rake'
-end
-
-group :testing do
-  gem 'mocha'
-  gem 'rack-test'
+  gem 'codecov', require: false
+  gem 'm'
   gem 'minitest'
+  gem 'rack-test'
+  gem 'rake'
+  gem 'rubocop'
 end

data/Gemfile.lock

@@ -1,24 +1,61 @@
+PATH
+  remote: .
+  specs:
+    adsf (1.3.0)
+      rack (>= 1.0.0, < 3.0.0)
+
 GEM
   remote: https://rubygems.org/
   specs:
-    metaclass (0.0.4)
-    minitest (5.8.4)
-    mocha (1.1.0)
-      metaclass (~> 0.0.1)
-    rack (1.6.4)
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rake (11.1.1)
+    ast (2.3.0)
+    codecov (0.1.10)
+      json
+      simplecov
+      url
+    docile (1.1.5)
+    json (2.1.0)
+    m (1.5.1)
+      method_source (>= 0.6.7)
+      rake (>= 0.9.2.2)
+    method_source (0.9.0)
+    minitest (5.10.3)
+    parallel (1.12.0)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    rack (2.0.3)
+    rack-test (0.7.0)
+      rack (>= 1.0, < 3)
+    rainbow (2.2.2)
+      rake
+    rake (12.3.0)
+    rubocop (0.51.0)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.3.0)
+    url (0.3.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  adsf!
+  codecov
+  m
   minitest
-  mocha
-  rack
   rack-test
   rake
+  rubocop
 
 BUNDLED WITH
-   1.11.2
+   1.16.0

data/NEWS.md

@@ -1,32 +1,31 @@
-adsf News
-=========
+# adsf News
 
-1.2.1
------
+## 1.3.0 (2017-11-19)
+
+Features:
+
+* Added `Adsf::Server`
+
+## 1.2.1
 
 * Fixed compatibility with Ruby 2.3.0 (#3) [Vipul Amler]
 
-1.2.0
------
+## 1.2.0
 
-* Add `--local-only` and `--listen-address` options (#1) [Ed Brannin]
+* Added `--local-only` and `--listen-address` options (#1) [Ed Brannin]
 
-1.1.1
------
+## 1.1.1
 
 * Made SIGINT/SIGTERM cause proper exit
 
-1.1.0
------
+## 1.1.0
 
 * Added support for custom index filenames [Mark Meves]
 
-1.0.1
------
+## 1.0.1
 
 * Added runtime dependency on Rack
 
-1.0
----
+## 1.0.0
 
 * Initial release

data/README.md

@@ -1,7 +1,13 @@
+[![Gem version](https://img.shields.io/gem/v/adsf.svg)](http://rubygems.org/gems/adsf)
+[![Gem downloads](https://img.shields.io/gem/dt/adsf.svg)](http://rubygems.org/gems/adsf)
+[![Build status](https://img.shields.io/travis/ddfreyne/adsf.svg)](https://travis-ci.org/ddfreyne/adsf)
+[![Code Climate](https://img.shields.io/codeclimate/github/ddfreyne/adsf.svg)](https://codeclimate.com/github/ddfreyne/adsf)
+[![Code Coverage](https://img.shields.io/codecov/c/github/ddfreyne/adsf.svg)](https://codecov.io/gh/ddfreyne/adsf)
+
 adsf
 ====
 
-adsf (A Dead Simple Fileserver) is a tiny static file server that you can launch instantly in any directory, like this:
+_adsf_ (**A** **D**ead **S**imple **F**ileserver) is a tiny static web server that you can launch instantly in any directory, like this:
 
 	▸ ls -l
 	total 0
@@ -11,34 +17,60 @@ adsf (A Dead Simple Fileserver) is a tiny static file server that you can launch
 	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
+	[2017-11-19 11:49:20] INFO  WEBrick 1.3.1
+	[2017-11-19 11:49:20] INFO  ruby 2.4.2 (2017-09-14) [x86_64-darwin17]
+	[2017-11-19 11:49:20] INFO  WEBrick::HTTPServer#start: pid=95218 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.
+See `adsf --help` for details.
 
 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.
+### IndexFileFinder
+
+The `Adsf::Rack::IndexFileFinder` middleware makes Rack load an index file (e.g. `index.html`) when requesting a directory. For example, the following runs a web server with the 'public' directory as its web root:
 
-Here’s an example middleware/application stack that runs a web server with the "public/" directory as its web root:
+```ruby
+use Adsf::Rack::IndexFileFinder, root: 'public'
+run Rack::File.new('public')
+```
 
-	use Adsf::Rack::IndexFileFinder, :root => "public/"
-	run Rack::File.new("public/")
+It takes the following options:
 
-The `:root` option is required; it should contain the path to the web root.
+* `root` (required): 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:
+* `index_filenames` (optional; defaults to `['index.html']`): contains 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 example), 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:
 
+	```ruby
 	use Adsf::Rack::IndexFileFinder,
-	  :root => "public/",
-	  :index_filenames => %w( index.html index.xhtml index.xml )
-	run Rack::File.new("public/")
+		root: 'public',
+		index_filenames: %w[index.html index.xhtml]
+	run Rack::File.new('public')
+	```
+
+### Server
+
+`Adsf::Server` runs a web server programmatically. For example:
+
+```ruby
+server = Adsf::Server.new(root: 'public')
+
+%w[INT TERM].each do |s|
+  Signal.trap(s) { server.stop }
+end
+
+server.run
+```
+
+It takes the following options:
+
+* `root` (required): the path to the web root
+* `index_filenames` (optional; defaults to `['index.html']`): (see above)
+* `host` (optional; defaults to `'127.0.0.1'`): the address of the network interface to listen on
+* `port` (optional; defaults to `3000`): the port ot listen on
+* `handler` (optional): the Rack handler to use
 
 Contributors
 ------------
@@ -46,8 +78,4 @@ Contributors
 * Ed Brannin
 * Larissa Reis
 * Mark Meves
-
-Contact
--------
-
-You can reach me at <denis.defreyne@stoneship.org>.
+* Vipul Amler

data/Rakefile

@@ -1,16 +1,12 @@
-# Load adsf
-$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/lib'))
-require 'adsf'
+require 'rubocop/rake_task'
+require 'rake/testtask'
 
-desc 'Run all tests'
-task :test do
-  $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
-
-  require 'minitest/autorun'
-  MiniTest.autorun
-
-  test_files = Dir["test/**/test_*.rb"]
-  test_files.each { |f| require f }
+Rake::TestTask.new(:test) do |t|
+  t.test_files = Dir['test/**/test_*.rb']
+  t.libs << 'test'
+  t.verbose = false
 end
 
-task :default => :test
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[test rubocop]

data/bin/adsf

@@ -1,83 +1,53 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
-
-require 'rack'
 require 'optparse'
 require 'adsf'
 
-# Parse options
 options = {
-  :handler            => nil,
-  :port               => 3000,
-  :index_filenames => %w( index.html ),
-  :root               => '.',
-  :host               => '0.0.0.0',
+  handler: nil,
+  port: 3000,
+  index_filenames: %w[index.html],
+  root: '.',
+  host: '0.0.0.0'
 }
-OptionParser.new do |opts|
-  opts.banner = "Usage: adsf [options]"
 
-  opts.separator ''
-  opts.separator 'Specific options:'
+OptionParser.new do |opts|
+  opts.banner = 'Usage: adsf [options]'
 
-  # handler
   opts.on('-H', '--handler [handler]', 'Specify the handler to use') do |o|
     options[:handler] = o
   end
 
-  # help
-  opts.on('-h', '--help', 'Display help') do |o|
+  opts.on('-h', '--help', 'Display help') do |_o|
     puts 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
   end
 
-  # root
   opts.on('-r', '--root [root]', 'Specify the web root to use') do |o|
     options[:root] = o
   end
 
-  # host
   opts.on('-l', '--local-only', 'Only listen to requests from localhost (short for "-a localhost")') do
     options[:host] = 'localhost'
   end
 
-  # host
   opts.on('-a', '--listen-address [host]', 'Specify the address to listen to') do |o|
     options[:host] = o
   end
 end.parse!
 
-# Find handler
-handler = Rack::Handler.get(options[:handler])
-if handler.nil?
-  handler = Rack::Handler::WEBrick
-end
-
-# Create app
-app = Rack::Builder.new do
-  use Rack::CommonLogger
-  use Rack::ShowExceptions
-  use Rack::Lint
-  use Adsf::Rack::IndexFileFinder,
-    :root            => options[:root],
-    :index_filenames => options[:index_filenames]
-  run Rack::File.new(options[:root])
-end.to_app
+server = Adsf::Server.new(options)
 
-# Be quittable
-%w( INT TERM ).each do |s|
-  Signal.trap(s) { handler.shutdown }
+%w[INT TERM].each do |s|
+  Signal.trap(s) { server.stop }
 end
 
-# Run
-handler.run(app, :Port => options[:port], :Host => options[:host])
+server.run

data/lib/adsf.rb

@@ -1,7 +1,8 @@
-module Adsf
-
-  VERSION = '1.2.1'
+require 'rack'
 
+module Adsf
 end
 
+require 'adsf/version'
 require 'adsf/rack'
+require 'adsf/server'

data/lib/adsf/rack.rb

@@ -1,8 +1,6 @@
 module Adsf
-
   module Rack
   end
-
 end
 
 require 'adsf/rack/index_file_finder'

data/lib/adsf/rack/index_file_finder.rb

@@ -1,11 +1,9 @@
 module Adsf::Rack
-
   class IndexFileFinder
-
-    def initialize(app, options)
+    def initialize(app, root:, index_filenames: ['index.html'])
       @app = app
-      @root = options[:root] or raise ArgumentError, ':root option is required but was not given'
-      @index_filenames = options[:index_filenames] || [ 'index.html' ]
+      @root = root
+      @index_filenames = index_filenames
     end
 
     def call(env)
@@ -14,19 +12,20 @@ module Adsf::Rack
       path = ::File.join(@root, path_info)
 
       # Redirect if necessary
-      if ::File.directory?(path) && path_info !~ /\/$/
+      if ::File.directory?(path) && path_info !~ %r{/$}
         new_path_info = env['PATH_INFO'] + '/'
         return [
           302,
           { 'Location' => new_path_info, 'Content-Type' => 'text/html' },
-          [ "Redirecting you to #{new_path_info}…" ]
+          ["Redirecting you to #{new_path_info}…"]
         ]
       end
 
       # Add index file if necessary
       new_env = env.dup
       if ::File.directory?(path)
-        if index_filename = index_file_in(path)
+        index_filename = index_file_in(path)
+        if index_filename
           new_env['PATH_INFO'] = ::File.join(path_info, index_filename)
         end
       end
@@ -35,14 +34,12 @@ module Adsf::Rack
       @app.call(new_env)
     end
 
-  private
+    private
 
     def index_file_in(dir)
       @index_filenames.find do |index_filename|
         ::File.file?(::File.join(dir, index_filename))
       end
     end
-
   end
-
 end

data/lib/adsf/server.rb

@@ -0,0 +1,68 @@
+module Adsf
+  class Server
+    DEFAULT_HANDLER_NAME = :thin
+
+    def initialize(root:, index_filenames: ['index.html'], host: '127.0.0.1', port: 3000, handler: nil)
+      @root = root
+      @index_filenames = index_filenames
+      @host = host
+      @port = port
+      @handler = handler
+
+      @q = SizedQueue.new(1)
+    end
+
+    def run
+      handler = build_handler
+      app = build_app(root: @root, index_filenames: @index_filenames)
+
+      url = "http://#{@host}:#{@port}/"
+      puts "View the site at #{url}"
+
+      handler.run(app, Host: @host, Port: @port) do |server|
+        wait_for_stop_async(server)
+      end
+    end
+
+    def stop
+      @q << true
+    end
+
+    private
+
+    def wait_for_stop_async(server)
+      Thread.new { wait_for_stop(server) }
+    end
+
+    def wait_for_stop(server)
+      @q.pop
+      server.stop
+    end
+
+    def build_app(root:, index_filenames:)
+      ::Rack::Builder.new do
+        use ::Rack::CommonLogger
+        use ::Rack::ShowExceptions
+        use ::Rack::Lint
+        use ::Rack::Head
+        use Adsf::Rack::IndexFileFinder,
+            root: root,
+            index_filenames: index_filenames
+
+        run ::Rack::File.new(root)
+      end.to_app
+    end
+
+    def build_handler
+      if @handler
+        ::Rack::Handler.get(@handler)
+      else
+        begin
+          ::Rack::Handler.get(DEFAULT_HANDLER_NAME)
+        rescue LoadError
+          ::Rack::Handler::WEBrick
+        end
+      end
+    end
+  end
+end

data/lib/adsf/version.rb

@@ -0,0 +1,3 @@
+module Adsf
+  VERSION = '1.3.0'.freeze
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adsf
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-14 00:00:00.000000000 Z
+date: 2017-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: A web server that can be spawned in any directory
 email: denis.defreyne@stoneship.org
 executables:
@@ -42,6 +48,8 @@ files:
 - lib/adsf.rb
 - lib/adsf/rack.rb
 - lib/adsf/rack/index_file_finder.rb
+- lib/adsf/server.rb
+- lib/adsf/version.rb
 homepage: http://github.com/ddfreyne/adsf/
 licenses:
 - MIT
@@ -54,7 +62,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.5
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -62,9 +70,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.2
 signing_key: 
 specification_version: 4
 summary: a tiny static file server
 test_files: []
-has_rdoc: false