adsf 1.4.7 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd19b64a645ae62ffcc22dcf97cf5cb98d4ce756583755631646e03e369740a4
-  data.tar.gz: aa88b49a59830d4298cf5b634258010d6b1d0757a4192de2a1fae156c81bf0af
+  metadata.gz: ed9bf6e0feaf4c359961448ad08440e789abdd038f0ec6df25ca94ce95692968
+  data.tar.gz: 6e32f017cf662136d6473ec9dafbefc83499cacaf0ead96b16a6dd4d12af3374
 SHA512:
-  metadata.gz: c82f31a29d08c8d30e349e2e37188343516ae8dfe924aa96f027f55bb22553a6c521d40335bc20668e1190abcc8e662aeb0f920e0eca247e6d9cf2b6f3ee8f45
-  data.tar.gz: 4ad549207aecfff4ac26468c63e5ec58a8971f8fd7b3db6179cf4c1783f266e16cfaaa4f2cc491bbe5b03e2f79c91befa251f07a224715aef8b2db3c2071e3a5
+  metadata.gz: 1126dbb61b6a3e326faa194afc2d2a314ffbacdcccb9ff77f01e1e8fcc28aa3af5f381476fbed1235fcc40bc2c53e8145d96be2f1cb837ae52cdc7dfeb493fb8
+  data.tar.gz: 2383433bbb5d8b86851ae3d4d2143a18a88e3e5ef38bd6afdbf30462e9c8210f5cfa972281b127bf3e257e05d44f3d6ea7a75f5a40daf72aa3706474daddb395

data/NEWS.md

@@ -1,5 +1,21 @@
 # Release notes for adsf
 
+## 1.5.0 (2024-01-08)
+
+Features:
+
+* Add `-x`/`--auto-extensions` option (#33) [Paul Cantrell]
+
+Enhancements:
+
+* Add `-V`/`--version` CLI option (#35)
+
+## 1.4.8 (2023-10-14)
+
+Fixes:
+
+* Fixed deprecation warning for `Rack::File` (#30, #32)
+
 ## 1.4.7 (2023-03-18)
 
 Fixes:

data/README.md

@@ -29,13 +29,36 @@ To use `adsf --live-reload`, please install the separate `adsf-live` gem. (The l
 
 ## Using adsf programmatically
 
+### 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 below)
+- `auto_extensions` (optional; defaults to `[]`; can be a string or an array of strings): If present, the server will automatically append the given extensions when searching for files. For example, `auto_extensions: ".html"` would cause a request for `/foo` to serve `/foo.html` if there is no file or directory named `/foo`.
+- `host` (optional; defaults to `'127.0.0.1'`): the address of the network interface to listen on
+- `port` (optional; defaults to `3000`): the port to listen on
+- `handler` (optional): the Rack handler to use
+
 ### 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:
+If you are assembling your own Rack configuration, you can use adsf’s `Adsf::Rack::IndexFileFinder` middleware to make 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:
 
 ```ruby
 use Adsf::Rack::IndexFileFinder, root: 'public'
-run Rack::File.new('public')
+run Rack::Files.new('public')
 ```
 
 It takes the following options:
@@ -48,12 +71,12 @@ It takes the following options:
   use Adsf::Rack::IndexFileFinder,
   	root: 'public',
   	index_filenames: %w[index.html index.xhtml]
-  run Rack::File.new('public')
+  run Rack::Files.new('public')
   ```
 
 **Why not use `Rack::Static`?** Rack comes with `Rack::Static`, whose purpose is similar to, but not the same as, `Adsf::Rack::IndexFileFinder`. In particular:
 
-- `Adsf::Rack::IndexFileFinder` does not serve files, unlike `Rack::Static`. `IndexFileFinder` only rewrites the incoming request and passes it on (usually to `Rack::File`).
+- `Adsf::Rack::IndexFileFinder` does not serve files, unlike `Rack::Static`. `IndexFileFinder` only rewrites the incoming request and passes it on (usually to `Rack::Files`).
 
 - `Adsf::Rack::IndexFileFinder` supports multiple index files, while `Rack::Static` only supports one (you could have multiple `Rack::Static` middlewares, one for each index filenames, though).
 
@@ -61,31 +84,10 @@ It takes the following options:
 
 - When requesting a directory without specifying the trailing slash, `Adsf::Rack::IndexFileFinder` will redirect to the URL with a trailing slash, unlike `Rack::Static`. This mimics the behavior of typical HTTP servers. For example, when requesting `/foo`, when a `foo` directory exists and it contains `index.html`, `IndexFileFinder` will redirect to `/foo/`.
 
-### 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
 
 - Ed Brannin
 - Larissa Reis
 - Mark Meves
 - Vipul Amler
+- Paul Cantrell

data/bin/adsf

@@ -25,10 +25,19 @@ OptionParser.new do |opts|
     exit
   end
 
+  opts.on('-V', '--version', 'Show version') do |_o|
+    puts "adsf version #{Adsf::VERSION} © 2009–… Denis Defreyne."
+    exit
+  end
+
   opts.on('-i', '--index-filenames [index-filenames]', 'Specify index filenames (comma-separated)') do |o|
     options[:index_filenames] = o.split(',')
   end
 
+  opts.on('-x', '--auto-extensions [extensions]', 'Specify suffixes to automatically apply to requests (comma-separated, including dot)') do |o|
+    options[:auto_extensions] = o.split(',')
+  end
+
   opts.on('-p', '--port [port]', Integer, 'Specify the port number to use') do |o|
     options[:port] = o
   end

data/lib/adsf/rack/auto_file_extensions.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Adsf::Rack
+  class AutoFileExtensions
+    def initialize(app, root:, extensions:)
+      @app = app
+      @root = root
+      # Search list starts with '' so that we first look for file as requested
+      @search_suffixes = [''] + Array(extensions).map { |ext| ".#{ext}" }
+    end
+
+    def call(env)
+      path_info = ::Rack::Utils.unescape(env['PATH_INFO'])
+      path = ::File.join(@root, path_info)
+
+      new_env = env
+      @search_suffixes.each do |suffix|
+        new_path = path + suffix
+        next unless ::File.exist?(new_path)
+
+        new_env = env.dup # only dup if needed
+        new_env['PATH_INFO'] += suffix
+        break
+      end
+
+      @app.call(new_env)
+    end
+  end
+end

data/lib/adsf/rack.rb

@@ -8,3 +8,4 @@ end
 require 'adsf/rack/index_file_finder'
 require 'adsf/rack/caching'
 require 'adsf/rack/cors'
+require 'adsf/rack/auto_file_extensions'

data/lib/adsf/server.rb

@@ -2,10 +2,19 @@
 
 module Adsf
   class Server
-    def initialize(root:, live: false, index_filenames: ['index.html'], host: '127.0.0.1', port: 3000, handler: nil)
+    def initialize(
+      root:,
+      live: false,
+      host: '127.0.0.1',
+      port: 3000,
+      index_filenames: ['index.html'],
+      auto_extensions: [],
+      handler: nil
+    )
       @root = root
       @live = live
       @index_filenames = index_filenames
+      @auto_extensions = auto_extensions
       @host = host
       @port = port
       @handler = handler
@@ -15,7 +24,11 @@ module Adsf
 
     def run
       handler = build_handler
-      app = build_app(root: @root, index_filenames: @index_filenames)
+      app = build_app(
+        root: @root,
+        index_filenames: @index_filenames,
+        auto_extensions: @auto_extensions,
+      )
       start_watcher if @live
 
       url = "http://#{@host}:#{@port}/"
@@ -47,7 +60,7 @@ module Adsf
       server.stop
     end
 
-    def build_app(root:, index_filenames:)
+    def build_app(root:, index_filenames:, auto_extensions:)
       is_live = @live
 
       ::Rack::Builder.new do
@@ -60,13 +73,16 @@ module Adsf
         use Adsf::Rack::IndexFileFinder,
             root: root,
             index_filenames: index_filenames
+        use Adsf::Rack::AutoFileExtensions,
+            root: root,
+            extensions: auto_extensions
 
         if is_live
           require 'adsf/live'
           use ::Rack::LiveReload, no_swf: true, source: :vendored
         end
 
-        run ::Rack::File.new(root)
+        run ::Rack::Files.new(root)
       end.to_app
     end
 

data/lib/adsf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Adsf
-  VERSION = '1.4.7'
+  VERSION = '1.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adsf
 version: !ruby/object:Gem::Version
-  version: 1.4.7
+  version: 1.5.0
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-18 00:00:00.000000000 Z
+date: 2024-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -56,6 +56,7 @@ files:
 - bin/adsf
 - lib/adsf.rb
 - lib/adsf/rack.rb
+- lib/adsf/rack/auto_file_extensions.rb
 - lib/adsf/rack/caching.rb
 - lib/adsf/rack/cors.rb
 - lib/adsf/rack/index_file_finder.rb
@@ -81,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: a tiny static file server