sinatra-rack-3-commonlit 3.1.0

data/Rakefile

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+require 'rake/clean'
+require 'minitest/test_task'
+require 'fileutils'
+require 'date'
+
+task default: :test
+
+def source_version
+  @source_version ||= File.read(File.expand_path('VERSION', __dir__)).strip
+end
+
+def prev_feature
+  source_version.gsub(/^(\d\.)(\d+)\..*$/) { $1 + ($2.to_i - 1).to_s }
+end
+
+def prev_version
+  return "#{prev_feature}.0" if source_version.end_with? '.0'
+
+  source_version.gsub(/\d+$/) { |s| s.to_i - 1 }
+end
+
+# Tests ===============================================================
+
+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
+
+# Test code coverage ==================================================
+
+namespace :test do
+  desc 'Measures test coverage'
+  task :coverage do
+    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' }
+CLEAN.include 'doc/api'
+
+# README ===============================================================
+
+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[%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 }
+      else
+        puts "Liquid not found in #{file}"
+      end
+    end
+  end
+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"
+
+  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})"
+end
+
+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'
+  overall = 0
+  mapping = {
+    '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)
+    authors[mapping[name] || name] += num.to_i
+    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)
+end
+
+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)'
+  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)})" }
+  end
+end
+
+# PACKAGING ============================================================
+
+if defined?(Gem)
+  GEMS_AND_ROOT_DIRECTORIES = {
+    'sinatra' => '.',
+    'sinatra-contrib' => './sinatra-contrib',
+    'rack-protection' => './rack-protection'
+  }.freeze
+
+  def package(gem, ext = '')
+    "pkg/#{gem}-#{source_version}" + ext
+  end
+
+  directory 'pkg/'
+  CLOBBER.include('pkg')
+
+  GEMS_AND_ROOT_DIRECTORIES.each do |gem, directory|
+    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
+    end
+
+    file package(gem, '.tar.gz') => ['pkg/'] do |f|
+      sh <<-SH
+        git archive \
+          --prefix=#{gem}-#{source_version}/ \
+          --format=tar \
+          HEAD -- #{directory} | gzip > #{f.name}
+      SH
+    end
+  end
+
+  namespace :package do
+    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
+  end
+
+  namespace :install do
+    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
+  end
+
+  namespace :release do
+    GEMS_AND_ROOT_DIRECTORIES.each do |gem, _directory|
+      desc "Release #{gem} as a package"
+      task gem => "package:#{gem}" do
+        sh <<-SH
+          gem install #{package(gem, '.gem')} --local &&
+          gem push #{package(gem, '.gem')}
+        SH
+      end
+    end
+
+    desc 'Commits the version to github repository'
+    task :commit_version do
+      %w[
+        lib/sinatra
+        sinatra-contrib/lib/sinatra/contrib
+        rack-protection/lib/rack/protection
+      ].each do |path|
+        path = File.join(path, 'version.rb')
+        File.write(path, File.read(path).sub(/VERSION = '(.+?)'/, "VERSION = '#{source_version}'"))
+      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)
+      SH
+    end
+
+    desc 'Release all gems as packages'
+    task all: %i[test commit_version] + GEMS_AND_ROOT_DIRECTORIES.keys
+  end
+end

data/SECURITY.md

@@ -0,0 +1,35 @@
+# Reporting a security bug
+
+All security bugs in Sinatra should be reported to the core team through our private mailing list [sinatra-security@googlegroups.com](https://groups.google.com/group/sinatra-security). Your report will be acknowledged within 24 hours, and you’ll receive a more detailed response to your email within 48 hours indicating the next steps in handling your report.
+
+After the initial reply to your report the security team will endeavor to keep you informed of the progress being made towards a fix and full announcement. These updates will be sent at least every five days, in reality this is more likely to be every 24-48 hours.
+
+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
+
+## Disclosure Policy
+
+Sinatra has a 5 step disclosure policy, that is upheld to the best of our ability.
+
+1. Security report received and is assigned a primary handler. This person will coordinate the fix and release process.
+2. Problem is confirmed and, a list of all affected versions is determined. Code is audited to find any potential similar problems.
+3. Fixes are prepared for all releases which are still supported. These fixes are not committed to the public repository but rather held locally pending the announcement.
+4. A suggested embargo date for this vulnerability is chosen and distros@openwall is notified. This notification will include patches for all versions still under support and a contact address for packagers who need advice back-porting patches to older versions.
+5. On the embargo date, the [mailing list][mailing-list] and [security list][security-list] are sent a copy of the announcement. The changes are pushed to the public repository and new gems released to rubygems.
+
+Typically the embargo date will be set 72 hours from the time vendor-sec is first notified, however this may vary depending on the severity of the bug or difficulty in applying a fix.
+
+This process can take some time, especially when coordination is required with maintainers of other projects. Every effort will be made to handle the bug in as timely a manner as possible, however it’s important that we follow the release process above to ensure that the disclosure is handled in a consistent manner.
+
+## Security Updates
+
+Security updates will be posted on the [mailing list][mailing-list] and [security list][security-list].
+
+## Comments on this Policy
+
+If you have any suggestions to improve this policy, please send an email the core team at [sinatrarb@googlegroups.com](https://groups.google.com/group/sinatrarb).
+
+
+[mailing-list]: http://groups.google.com/group/sinatrarb/topics
+[security-list]: http://groups.google.com/group/sinatra-security/topics

data/VERSION

@@ -0,0 +1 @@
+3.1.0

data/examples/chat.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby -I ../lib -I lib
+# 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, :puma
+connections = Set.new
+
+get '/' do
+  halt erb(:login) unless params[:user]
+  erb :chat, locals: { user: params[:user].gsub(/\W/, '') }
+end
+
+get '/stream', provides: 'text/event-stream' do
+  stream :keep_open do |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 do |out|
+    out << "data: #{params[:msg]}\n\n"
+  rescue
+    out.close
+  end
+  204 # response without entity body
+end
+
+__END__
+
+@@ layout
+<html>
+  <head>
+    <title>Super Simple Chat with Sinatra</title>
+    <meta charset="utf-8" />
+    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.min.js"></script>
+  </head>
+  <body><%= yield %></body>
+</html>
+
+@@ login
+<form action="/">
+  <label for='user'>User Name:</label>
+  <input name="user" value="" />
+  <input type="submit" value="GO!" />
+</form>
+
+@@ chat
+<pre id='chat'></pre>
+<form>
+  <input id='msg' placeholder='type message here...' />
+</form>
+
+<script>
+  // reading
+  var es = new EventSource('/stream');
+  es.onmessage = function(e) { $('#chat').append(e.data + "\n") };
+
+  // writing
+  $("form").on('submit',function(e) {
+    $.post('/', {msg: "<%= user %>: " + $('#msg').val()});
+    $('#msg').val(''); $('#msg').focus();
+    e.preventDefault();
+  });
+</script>
+

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/rainbows.conf

@@ -0,0 +1,3 @@
+Rainbows! do
+  use :EventMachine
+end

data/examples/rainbows.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'rainbows'
+
+module Rack
+  module Handler
+    class Rainbows
+      def self.run(app, **options)
+        rainbows_options = {
+          listeners: ["#{options[:Host]}:#{options[:Port]}"],
+          worker_processes: 1,
+          timeout: 30,
+          config_file: ::File.expand_path('rainbows.conf', __dir__)
+        }
+
+        ::Rainbows::HttpServer.new(app, rainbows_options).start.join
+      end
+    end
+
+    register :rainbows, ::Rack::Handler::Rainbows
+  end
+end

data/examples/simple.rb

@@ -0,0 +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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# this example does *not* work properly with WEBrick
+#
+# run *one* of these:
+#
+#   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'
+
+class Stream < Sinatra::Base
+  get '/' do
+    content_type :txt
+
+    stream do |out|
+      out << "It's gonna be legen -\n"
+      sleep 0.5
+      out << " (wait for it) \n"
+      sleep 1
+      out << "- dary!\n"
+    end
+  end
+end
+
+run Stream