rackup 1.0.1 → 2.3.1

data/license.md

@@ -1,7 +1,65 @@
 # MIT License
 
-Copyright, 2022, by Samuel Williams.  
-Copyright, 2022, by Jeremy Evans.  
+Copyright, 2007-2009, by Leah Neukirchen.  
+Copyright, 2008, by Marc-André Cournoyer.  
+Copyright, 2009, by Aaron Pfeifer.  
+Copyright, 2009-2010, by Megan Batty.  
+Copyright, 2009-2010, by Michael Fellinger.  
+Copyright, 2009, by Genki Takiuchi.  
+Copyright, 2009, by Joshua Peek.  
+Copyright, 2009, by Yehuda Katz.  
+Copyright, 2009, by Carl Lerche.  
+Copyright, 2010, by Julik Tarkhanov.  
+Copyright, 2010-2016, by James Tucker.  
+Copyright, 2010, by Timur Batyrshin.  
+Copyright, 2010, by Loren Segal.  
+Copyright, 2010, by Andrew Bortz.  
+Copyright, 2010, by John Barnette.  
+Copyright, 2010, by John Sumsion.  
+Copyright, 2011-2018, by Aaron Patterson.  
+Copyright, 2011, by Konstantin Haase.  
+Copyright, 2011, by Blake Mizerany.  
+Copyright, 2011, by Tsutomu Kuroda.  
+Copyright, 2012, by Jean Boussier.  
+Copyright, 2012, by Trevor Wennblom.  
+Copyright, 2012, by Anurag Priyam.  
+Copyright, 2012, by Hrvoje Šimić.  
+Copyright, 2013, by Uchio Kondo.  
+Copyright, 2013, by Tim Moore.  
+Copyright, 2013, by Hal Brodigan.  
+Copyright, 2013, by Bas Vodde.  
+Copyright, 2013, by Joe Fiorini.  
+Copyright, 2014, by Wyatt Pan.  
+Copyright, 2014, by Lenny Marks.  
+Copyright, 2014, by Igor Bochkariov.  
+Copyright, 2014, by Max Cantor.  
+Copyright, 2014, by David Celis.  
+Copyright, 2014-2019, by Rafael França.  
+Copyright, 2014, by Jeremy Kemper.  
+Copyright, 2014, by Richard Schneeman.  
+Copyright, 2015, by Peter Wilmott.  
+Copyright, 2015, by Sean McGivern.  
+Copyright, 2015, by Tadashi Saito.  
+Copyright, 2015, by Martin Hrdlicka.  
+Copyright, 2015, by Zachary Scott.  
+Copyright, 2016, by Sophie Deziel.  
+Copyright, 2016, by Kazuya Hotta.  
+Copyright, 2017, by Ryunosuke Sato.  
+Copyright, 2017-2024, by Samuel Williams.  
+Copyright, 2018, by Dillon Welch.  
+Copyright, 2018, by Yoshiyuki Hirano.  
+Copyright, 2018, by Nick LaMuro.  
+Copyright, 2019, by Krzysztof Rybka.  
+Copyright, 2019, by Misaki Shioi.  
+Copyright, 2020-2022, by Jeremy Evans.  
+Copyright, 2021, by Katsuhiko Yoshida.  
+Copyright, 2021, by Kang Sheng.  
+Copyright, 2021, by Stephen Paul Weber.  
+Copyright, 2022, by Akira Matsuda.  
+Copyright, 2022, by Andrew Hoglund.  
+Copyright, 2024, by Olle Jonsson.  
+Copyright, 2024, by Geremia Taglialatela.  
+Copyright, 2024, by Petrik de Heus.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -1,13 +1,17 @@
 # Rackup
 
-`rackup` provides a command line interface for running a Rack-compatible application.
+`rackup` provides a command line interface for running a Rack-compatible application. It also provides a generic interface for starting a `rack`-compatible server: `Rackup::Handler`. It is not designed for production use.
 
 [![Development Status](https://github.com/rack/rackup/workflows/Test/badge.svg)](https://github.com/rack/rackup/actions?workflow=Test)
 
 ## Installation
 
 ``` bash
-$ gem install rackup
+-- For Puma
+$ gem install rackup puma
+
+-- For Falcon
+$ gem install rackup falcon
 ```
 
 ## Usage
@@ -20,6 +24,53 @@ $ rackup
 
 Your application should now be available locally, typically `http://localhost:9292`.
 
+### Server Handler
+
+You can also use `Rackup::Handler` to start a server programmatically:
+
+``` ruby
+require 'rackup'
+
+# Use the default server:
+handler = Rackup::Handler.default
+handler.run(app, **options)
+
+# Use a specific server:
+handler = Rackup::Handler.get('puma')
+handler.run(app, **options)
+```
+
+Do not require specific handlers or assume they will exist/work. Instead, use the `default` method to get the best available handler.
+
+## (Soft) Deprecation
+
+For a long time, `rackup` (the executable and implementation) was part of `rack`, and `webrick` was the default server, included with Ruby. It made it easy to run a Rack application without having to worry about the details of the server - great for documentation and demos.
+
+When `webrick` was removed from the Ruby standard library, `rack` started depending on `webrick` as a default server. Every web application and server would pull in `webrick` as a dependency, even if it was not used. To avoid this, the `rackup` component of `rack` was moved to this gem, which depended on `webrick`.
+
+However, many libraries (e.g. `rails`) still depend on `rackup` and end up pulling in `webrick` as a dependency. To avoid this, the decision was made to cut `webrick` as a dependency of `rackup`. This means that `rackup` no longer depends on `webrick`, and you need to install it separately if you want to use it.
+
+As a consequence of this, the value of the `rackup` gem is further diminished. In other words, why would you do this:
+
+``` bash
+$ gem install rackup puma
+$ rackup ...
+```
+
+when you can do this:
+
+``` bash
+$ gem install puma
+$ puma ...
+```
+
+In summary, the maintainers of `rack` recommend the following:
+
+  - Libraries should not depend on `rackup` if possible. `rackup` as an executable made sense when webrick shipped with Ruby, so there was always a fallback. But that hasn't been true since Ruby 3.0.
+  - Frameworks and applications should focus on providing `config.ru` files, so that users can use the webserver program of their choice directly (e.g. puma, falcon).
+  - There is still some value in the generic `rackup` and `Rackup::Handler` interfaces, but we encourage users to invoke the server command directly if possible.
+  - Webrick should be avoided if possible.
+
 ## Contributing
 
 We welcome contributions to this project.

data/releases.md

@@ -0,0 +1,28 @@
+# Releases
+
+All notable changes to this project will be documented in this file. For info on how to format all future additions to this file please reference [Keep A Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## v2.2.1
+
+  - Try to require `webrick` and `rackup/handler/webrick` by default, for compatibility with code that expects them to be available.
+
+## v2.2.0
+
+  - Remove old rack shims.
+  - Remove `webrick` dependency.
+
+## v2.1.0
+
+  - Correctly support streaming responses with `webrick`.
+
+## v2.0.0
+
+  - Initial release and migration of code from `rack`.
+
+## v1.0.1
+
+  - Fix `rackup.rb` invalid requires.
+
+## v1.0.0
+
+  - Initial release of empty shim for Rack v2.

metadata

@@ -1,130 +1,112 @@
 --- !ruby/object:Gem::Specification
 name: rackup
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.3.1
 platform: ruby
 authors:
 - Samuel Williams
+- James Tucker
+- Leah Neukirchen
 - Jeremy Evans
-autorequire:
+- Joshua Peek
+- Megan Batty
+- Rafael França
+- Anurag Priyam
+- Max Cantor
+- Michael Fellinger
+- Sophie Deziel
+- Yoshiyuki Hirano
+- Aaron Patterson
+- Jean Boussier
+- Katsuhiko Yoshida
+- Konstantin Haase
+- Krzysztof Rybka
+- Martin Hrdlicka
+- Nick LaMuro
+- Aaron Pfeifer
+- Akira Matsuda
+- Andrew Bortz
+- Andrew Hoglund
+- Bas Vodde
+- Blake Mizerany
+- Carl Lerche
+- David Celis
+- Dillon Welch
+- Genki Takiuchi
+- Geremia Taglialatela
+- Hal Brodigan
+- Hrvoje Šimić
+- Igor Bochkariov
+- Jeremy Kemper
+- Joe Fiorini
+- John Barnette
+- John Sumsion
+- Julik Tarkhanov
+- Kang Sheng
+- Kazuya Hotta
+- Lenny Marks
+- Loren Segal
+- Marc-André Cournoyer
+- Misaki Shioi
+- Olle Jonsson
+- Peter Wilmott
+- Petrik de Heus
+- Richard Schneeman
+- Ryunosuke Sato
+- Sean McGivern
+- Stephen Paul Weber
+- Tadashi Saito
+- Tim Moore
+- Timur Batyrshin
+- Trevor Wennblom
+- Tsutomu Kuroda
+- Uchio Kondo
+- Wyatt Pan
+- Yehuda Katz
+- Zachary Scott
 bindir: bin
 cert_chain: []
-date: 2024-10-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: webrick
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: minitest-global_expectations
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest-sprint
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description:
-email:
-executables: []
+        version: '3'
+executables:
+- rackup
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/rackup
 - lib/rackup.rb
+- lib/rackup/handler.rb
+- lib/rackup/handler/cgi.rb
+- lib/rackup/handler/webrick.rb
+- lib/rackup/lobster.rb
+- lib/rackup/server.rb
+- lib/rackup/stream.rb
 - lib/rackup/version.rb
 - license.md
 - readme.md
+- releases.md
 - security.md
 homepage: https://github.com/rack/rackup
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  changelog_uri: https://github.com/rack/rackup/blob/main/releases.md
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/rack/rackup.git
 rdoc_options: []
 require_paths:
 - lib
@@ -132,15 +114,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A general server command for Rack applications.
 test_files: []