Make rackup an optional dependency

sinatra · dentarg · Jan 5, 2024 · Dec 23, 2022 · Dec 24, 2022 · Dec 24, 2022
commit 8a78d8b337e77cffbfa34849a2c53ac380e64808
diff --git a/.gitignore b/.gitignore
@@ -4,7 +4,7 @@
 *.swp
 *.rbc
 /pkg
-/Gemfile.lock
+*.lock
 /coverage
 .yardoc
 /doc

diff --git a/Gemfile b/Gemfile
@@ -17,6 +17,7 @@ rack_version = ENV['rack'].to_s
 rack_version = nil if rack_version.empty? || (rack_version == 'stable')
 rack_version = { github: 'rack/rack' } if rack_version == 'head'
 gem 'rack', rack_version
+gem 'rackup'
 
 puma_version = ENV['puma'].to_s
 puma_version = nil if puma_version.empty? || (puma_version == 'stable')

diff --git a/lib/sinatra/base.rb b/lib/sinatra/base.rb
@@ -2,7 +2,10 @@
 
 # external dependencies
 require 'rack'
-require 'rackup'
+begin
+  require 'rackup'
+rescue LoadError
+end
 require 'tilt'
 require 'rack/protection'
 require 'mustermann'
@@ -1597,6 +1600,23 @@ def quit!
       # Puma, Falcon, or WEBrick (in that order). If given a block, will call
       # with the constructed handler once we have taken the stage.
       def run!(options = {}, &block)
+        unless defined?(Rackup::Handler)
+          rackup_warning = <<~MISSING_RACKUP
+            Sinatra could not start, the "rackup" gem was not found!
+
+            Add it to your bundle with:
+
+                bundle add rackup
+
+            or install it with:
+
+                gem install rackup
+
+          MISSING_RACKUP
+          warn rackup_warning
+          exit 1
+        end
+
         return if running?
 
         set options

diff --git a/sinatra.gemspec b/sinatra.gemspec
@@ -47,7 +47,6 @@ RubyGems 2.0 or newer is required to protect against public gem pushes. You can
 
   s.add_dependency 'mustermann', '~> 3.0'
   s.add_dependency 'rack', '>= 3.0.0', '< 4'
-  s.add_dependency 'rackup', '>= 2.0.0', '< 3'
   s.add_dependency 'rack-protection', version
   s.add_dependency 'tilt', '~> 2.0'
 end
diff --git a/test/integration/gemfile_without_rackup.rb b/test/integration/gemfile_without_rackup.rb
@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec path: File.join('..', '..')
diff --git a/test/integration_start_helper.rb b/test/integration_start_helper.rb
@@ -14,9 +14,10 @@ def command_for(app_file)
     ]
   end
 
-  def with_process(command)
+  def with_process(command:, env: {}, debug: false)
     process = ChildProcess.build(*command)
     process.leader = true # ensure entire process tree dies
+    process.environment.merge!(env)
     read_io, write_io = IO.pipe
     process.io.stdout = write_io
     process.io.stderr = write_io
@@ -27,6 +28,8 @@ def with_process(command)
     # will not detect EOF.
     write_io.close
 
+    echo_output(read_io) if debug || debug_all?
+
     yield process, read_io
   ensure
     read_io.close
@@ -42,7 +45,7 @@ def echo_output(read_io)
     end
   end
 
-  def debug?
+  def debug_all?
     ENV.key?("DEBUG_START_PROCESS")
   end
 

diff --git a/test/integration_start_test.rb b/test/integration_start_test.rb
@@ -3,20 +3,29 @@
 class IntegrationStartTest < Minitest::Test
   include IntegrationStartHelper
 
+  def test_app_start_without_rackup
+    app_file = File.join(__dir__, "integration", "simple_app.rb")
+    gem_file = File.join(__dir__, "integration", "gemfile_without_rackup.rb")
+    command = command_for(app_file)
+    env = { BUNDLE_GEMFILE: gem_file }
+
+    with_process(command: command, env: env) do |process, read_io|
+      assert wait_for_output(read_io, /Sinatra could not start, the "rackup" gem was not found/)
+    end
+  end
+
   def test_classic_app_start
     app_file = File.join(__dir__, "integration", "simple_app.rb")
     command = command_for(app_file)
-    with_process(command) do |process, read_io|
-      echo_output(read_io) if debug? # will block
+    with_process(command: command) do |process, read_io|
       assert wait_for_output(read_io, /Sinatra \(v.+\) has taken the stage/)
     end
   end
 
   def test_classic_app_with_zeitwerk
     app_file = File.join(__dir__, "integration", "zeitwerk_app.rb")
     command = command_for(app_file)
-    with_process(command) do |process, read_io|
-      echo_output(read_io) if debug? # will block
+    with_process(command: command) do |process, read_io|
       assert wait_for_output(read_io, /Sinatra \(v.+\) has taken the stage/)
     end
   end
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,7 +4,7 @@ @@
     *.swp
     *.rbc
     /pkg
-    /Gemfile.lock
+    *.lock
     /coverage
     .yardoc
     /doc
@@ Expand Down @@