sinatra 2.2.0 → 3.2.0

data/Rakefile

@@ -1,15 +1,14 @@
+# frozen_string_literal: true
+
 require 'rake/clean'
-require 'rake/testtask'
+require 'minitest/test_task'
 require 'fileutils'
 require 'date'
 
-task :default => :test
-task :spec => :test
-
-CLEAN.include "**/*.rbc"
+task default: :test
 
 def source_version
-  @source_version ||= File.read(File.expand_path("../VERSION", __FILE__)).strip
+  @source_version ||= File.read(File.expand_path('VERSION', __dir__)).strip
 end
 
 def prev_feature
@@ -17,69 +16,59 @@ def prev_feature
 end
 
 def prev_version
-  return prev_feature + '.0' if source_version.end_with? '.0'
-  source_version.gsub(/\d+$/) { |s| s.to_i - 1 }
-end
-
-# SPECS ===============================================================
+  return "#{prev_feature}.0" if source_version.end_with? '.0'
 
-task :test do
-  ENV['LANG'] = 'C'
-  ENV.delete 'LC_CTYPE'
+  source_version.gsub(/\d+$/) { |s| s.to_i - 1 }
 end
 
-Rake::TestTask.new(:test) do |t|
-  t.test_files = FileList['test/*_test.rb']
-  t.ruby_opts = ['-r rubygems'] if defined? Gem
-  t.ruby_opts << '-I.'
-  t.warning = true
-end
+# Tests ===============================================================
 
-Rake::TestTask.new(:"test:core") do |t|
-  core_tests = %w[base delegator encoding extensions filter
-     helpers mapped_error middleware radius rdoc
-     readme request response result route_added_hook
-     routing server settings sinatra static templates]
-  t.test_files = core_tests.map {|n| "test/#{n}_test.rb"}
-  t.ruby_opts = ["-r rubygems"] if defined? Gem
-  t.ruby_opts << "-I."
+Minitest::TestTask.create # Default `test` task
+Minitest::TestTask.create(:'test:core') do |t|
   t.warning = true
+  t.test_globs = %w[
+    base delegator encoding extensions filter
+    helpers mapped_error middleware rdoc
+    readme request response result route_added_hook
+    routing server settings sinatra static templates
+  ].map { |n| "test/#{n}_test.rb" }
 end
 
-# Rcov ================================================================
+# Test code coverage ==================================================
 
 namespace :test do
   desc 'Measures test coverage'
   task :coverage do
-    rm_f "coverage"
+    rm_f 'coverage'
     ENV['COVERAGE'] = '1'
     Rake::Task['test'].invoke
   end
 end
+CLEAN.include('coverage')
 
 # Website =============================================================
 
 desc 'Generate RDoc under doc/api'
-task 'doc'     => ['doc:api']
-task('doc:api') { sh "yardoc -o doc/api" }
+task 'doc' => ['doc:api']
+task('doc:api') { sh 'yardoc -o doc/api' }
 CLEAN.include 'doc/api'
 
 # README ===============================================================
 
-task :add_template, [:name] do |t, args|
+task :add_template, [:name] do |_t, args|
   Dir.glob('README.*') do |file|
     code = File.read(file)
     if code =~ /^===.*#{args.name.capitalize}/
       puts "Already covered in #{file}"
     else
-      template = code[/===[^\n]*Liquid.*index\.liquid<\/tt>[^\n]*/m]
-      if !template
-        puts "Liquid not found in #{file}"
-      else
+      template = code[%r{===[^\n]*Liquid.*index\.liquid</tt>[^\n]*}m]
+      if template
         puts "Adding section to #{file}"
         template = template.gsub(/Liquid/, args.name.capitalize).gsub(/liquid/, args.name.downcase)
         code.gsub! /^(\s*===.*CoffeeScript)/, "\n" << template << "\n\\1"
-        File.open(file, "w") { |f| f << code }
+        File.open(file, 'w') { |f| f << code }
+      else
+        puts "Liquid not found in #{file}"
       end
     end
   end
@@ -87,29 +76,31 @@ end
 
 # Thanks in announcement ===============================================
 
-team = ["Ryan Tomayko", "Blake Mizerany", "Simon Rozet", "Konstantin Haase", "Zachary Scott"]
-desc "list of contributors"
-task :thanks, ['release:all', :backports] do |t, a|
-  a.with_defaults :release => "#{prev_version}..HEAD",
-    :backports => "#{prev_feature}.0..#{prev_feature}.x"
+team = ['Ryan Tomayko', 'Blake Mizerany', 'Simon Rozet', 'Konstantin Haase', 'Zachary Scott']
+desc 'list of contributors'
+task :thanks, ['release:all', :backports] do |_t, a|
+  a.with_defaults release: "#{prev_version}..HEAD",
+                  backports: "#{prev_feature}.0..#{prev_feature}.x"
+
   included = `git log --format=format:"%aN\t%s" #{a.release}`.lines.map { |l| l.force_encoding('binary') }
   excluded = `git log --format=format:"%aN\t%s" #{a.backports}`.lines.map { |l| l.force_encoding('binary') }
   commits  = (included - excluded).group_by { |c| c[/^[^\t]+/] }
   authors  = commits.keys.sort_by { |n| - commits[n].size } - team
-  puts authors[0..-2].join(', ') << " and " << authors.last,
-    "(based on commits included in #{a.release}, but not in #{a.backports})"
+  puts authors[0..-2].join(', ') << ' and ' << authors.last,
+       "(based on commits included in #{a.release}, but not in #{a.backports})"
 end
 
-desc "list of authors"
-task :authors, [:commit_range, :format, :sep] do |t, a|
-  a.with_defaults :format => "%s (%d)", :sep => ", ", :commit_range => '--all'
+desc 'list of authors'
+task :authors, [:commit_range, :format, :sep] do |_t, a|
+  a.with_defaults format: '%s (%d)', sep: ', ', commit_range: '--all'
   authors = Hash.new(0)
-  blake   = "Blake Mizerany"
+  blake   = 'Blake Mizerany'
   overall = 0
   mapping = {
-    "blake.mizerany@gmail.com" => blake, "bmizerany" => blake,
-    "a_user@mac.com" => blake, "ichverstehe" => "Harry Vangberg",
-    "Wu Jiang (nouse)" => "Wu Jiang" }
+    'blake.mizerany@gmail.com' => blake, 'bmizerany' => blake,
+    'a_user@mac.com' => blake, 'ichverstehe' => 'Harry Vangberg',
+    'Wu Jiang (nouse)' => 'Wu Jiang'
+  }
   `git shortlog -s #{a.commit_range}`.lines.map do |line|
     line = line.force_encoding 'binary' if line.respond_to? :force_encoding
     num, name = line.split("\t", 2).map(&:strip)
@@ -117,18 +108,18 @@ task :authors, [:commit_range, :format, :sep] do |t, a|
     overall += num.to_i
   end
   puts "#{overall} commits by #{authors.count} authors:"
-  puts authors.sort_by { |n,c| -c }.map { |e| a.format % e }.join(a.sep)
+  puts authors.sort_by { |_n, c| -c }.map { |e| a.format % e }.join(a.sep)
 end
 
-desc "generates TOC"
-task :toc, [:readme] do |t, a|
-  a.with_defaults :readme => 'README.md'
+desc 'generates TOC'
+task :toc, [:readme] do |_t, a|
+  a.with_defaults readme: 'README.md'
 
   def self.link(title)
     title.downcase.gsub(/(?!-)\W /, '-').gsub(' ', '-').gsub(/(?!-)\W/, '')
   end
 
-  puts "* [Sinatra](#sinatra)"
+  puts '* [Sinatra](#sinatra)'
   title = Regexp.new('(?<=\* )(.*)') # so Ruby 1.8 doesn't complain
   File.binread(a.readme).scan(/^##.*/) do |line|
     puts line.gsub(/#(?=#)/, '    ').gsub('#', '*').gsub(title) { "[#{$1}](##{link($1)})" }
@@ -139,12 +130,12 @@ end
 
 if defined?(Gem)
   GEMS_AND_ROOT_DIRECTORIES = {
-    "sinatra" => ".",
-    "sinatra-contrib" => "./sinatra-contrib",
-    "rack-protection" => "./rack-protection"
-  }
+    'sinatra' => '.',
+    'sinatra-contrib' => './sinatra-contrib',
+    'rack-protection' => './rack-protection'
+  }.freeze
 
-  def package(gem, ext='')
+  def package(gem, ext = '')
     "pkg/#{gem}-#{source_version}" + ext
   end
 
@@ -152,12 +143,12 @@ if defined?(Gem)
   CLOBBER.include('pkg')
 
   GEMS_AND_ROOT_DIRECTORIES.each do |gem, directory|
-    file package(gem, '.gem') => ["pkg/", "#{directory + '/' + gem}.gemspec"] do |f|
+    file package(gem, '.gem') => ['pkg/', "#{"#{directory}/#{gem}"}.gemspec"] do |f|
       sh "cd #{directory} && gem build #{gem}.gemspec"
-      mv directory + "/" + File.basename(f.name), f.name
+      mv "#{directory}/#{File.basename(f.name)}", f.name
     end
 
-    file package(gem, '.tar.gz') => ["pkg/"] do |f|
+    file package(gem, '.tar.gz') => ['pkg/'] do |f|
       sh <<-SH
         git archive \
           --prefix=#{gem}-#{source_version}/ \
@@ -168,29 +159,29 @@ if defined?(Gem)
   end
 
   namespace :package do
-    GEMS_AND_ROOT_DIRECTORIES.each do |gem, directory|
+    GEMS_AND_ROOT_DIRECTORIES.each do |gem, _directory|
       desc "Build #{gem} packages"
       task gem => %w[.gem .tar.gz].map { |e| package(gem, e) }
     end
 
-    desc "Build all packages"
-    task :all => GEMS_AND_ROOT_DIRECTORIES.keys
+    desc 'Build all packages'
+    task all: GEMS_AND_ROOT_DIRECTORIES.keys
   end
 
   namespace :install do
-    GEMS_AND_ROOT_DIRECTORIES.each do |gem, directory|
+    GEMS_AND_ROOT_DIRECTORIES.each do |gem, _directory|
       desc "Build and install #{gem} as local gem"
       task gem => package(gem, '.gem') do
         sh "gem install #{package(gem, '.gem')}"
       end
     end
 
-    desc "Build and install all of the gems as local gems"
-    task :all => GEMS_AND_ROOT_DIRECTORIES.keys
+    desc 'Build and install all of the gems as local gems'
+    task all: GEMS_AND_ROOT_DIRECTORIES.keys
   end
 
   namespace :release do
-    GEMS_AND_ROOT_DIRECTORIES.each do |gem, directory|
+    GEMS_AND_ROOT_DIRECTORIES.each do |gem, _directory|
       desc "Release #{gem} as a package"
       task gem => "package:#{gem}" do
         sh <<-SH
@@ -200,7 +191,7 @@ if defined?(Gem)
       end
     end
 
-    desc "Commits the version to github repository"
+    desc 'Commits the version to git (no push)'
     task :commit_version do
       %w[
         lib/sinatra
@@ -212,14 +203,26 @@ if defined?(Gem)
       end
 
       sh <<-SH
-        git commit --allow-empty -a -m '#{source_version} release'  &&
-        git tag -s v#{source_version} -m '#{source_version} release'  &&
-        git push && (git push origin || true) &&
-        git push --tags && (git push origin --tags || true)
+        git commit --allow-empty --all --message '#{source_version} release'
+      SH
+    end
+
+    desc 'Tags the version in git (no push)'
+    task :tag_version do
+      sh <<-SH
+        git tag --sign v#{source_version} --message '#{source_version} release'
+      SH
+    end
+
+    desc 'Watch the release workflow run'
+    task :watch do
+      sh <<-SH
+        runId=$(gh run list --workflow=release.yml --limit 1 --json databaseId --jq '.[].databaseId')
+        gh run watch --interval 1 --exit-status $runId
       SH
     end
 
-    desc "Release all gems as packages"
-    task :all => [:test, :commit_version] + GEMS_AND_ROOT_DIRECTORIES.keys
+    desc 'Release all gems as packages'
+    task all: %i[test commit_version] + GEMS_AND_ROOT_DIRECTORIES.keys
   end
 end

data/SECURITY.md

@@ -6,7 +6,7 @@ After the initial reply to your report the security team will endeavor to keep y
 
 If you have not received a reply to your email within 48 hours, or have not heard from the security team for the past five days there are a few steps you can take:
 
-* Contact the current security coordinator [Zachary Scott](mailto:zzak@ruby-lang.org) directly
+* Reach out to us on [discord](https://discord.gg/ncjsfsNHh7)
 
 ## Disclosure Policy
 

data/VERSION

@@ -1 +1 @@
-2.2.0
+3.2.0

data/examples/chat.rb

@@ -1,24 +1,37 @@
 #!/usr/bin/env ruby -I ../lib -I lib
-# coding: utf-8
-require_relative 'rainbows'
+# frozen_string_literal: true
+
+# This example does *not* work properly with WEBrick or other
+# servers that buffer output. To shut down the server, close any
+# open browser tabs that are connected to the chat server.
+
 require 'sinatra'
-set :server, :rainbows
-connections = []
+set :server, :puma
+connections = Set.new
 
 get '/' do
   halt erb(:login) unless params[:user]
-  erb :chat, :locals => { :user => params[:user].gsub(/\W/, '') }
+  erb :chat, locals: { user: params[:user].gsub(/\W/, '') }
 end
 
-get '/stream', :provides => 'text/event-stream' do
+get '/stream', provides: 'text/event-stream' do
   stream :keep_open do |out|
-    connections << out
-    out.callback { connections.delete(out) }
+    if connections.add?(out)
+      out.callback { connections.delete(out) }
+    end
+    out << "heartbeat:\n"
+    sleep 1
+  rescue
+    out.close
   end
 end
 
 post '/' do
-  connections.each { |out| out << "data: #{params[:msg]}\n\n" }
+  connections.each do |out|
+    out << "data: #{params[:msg]}\n\n"
+  rescue
+    out.close
+  end
   204 # response without entity body
 end
 
@@ -35,10 +48,10 @@ __END__
 </html>
 
 @@ login
-<form action='/'>
+<form action="/">
   <label for='user'>User Name:</label>
-  <input name='user' value='' />
-  <input type='submit' value="GO!" />
+  <input name="user" value="" />
+  <input type="submit" value="GO!" />
 </form>
 
 @@ chat

data/examples/lifecycle_events.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby -I ../lib -I lib
+# frozen_string_literal: true
+
+require 'sinatra'
+
+get('/') do
+  'This shows how lifecycle events work'
+end
+
+on_start do
+  puts "=============="
+  puts "  Booting up"
+  puts "=============="
+end
+
+on_stop do
+  puts "================="
+  puts "  Shutting down"
+  puts "================="
+end

data/examples/simple.rb

@@ -1,3 +1,5 @@
 #!/usr/bin/env ruby -I ../lib -I lib
+# frozen_string_literal: true
+
 require 'sinatra'
 get('/') { 'this is a simple app' }

data/examples/stream.ru

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 # this example does *not* work properly with WEBrick
 #
 # run *one* of these:
 #
-#   rackup -s mongrel stream.ru         # gem install mongrel
 #   unicorn stream.ru                   # gem install unicorn
 #   puma stream.ru                      # gem install puma
-#   rainbows -c rainbows.conf stream.ru # gem install rainbows eventmachine
 
 require 'sinatra/base'