sinatra 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 315dee3d85d7778ffa48e041bd60370e9e89ecd3c01dbf0cf9450e41c62dc0d8
-  data.tar.gz: '083a914c0b520684471e2715ec091c67ca8121bfb8b5d4cf410307d6e14e4ac5'
+  metadata.gz: 6eddf8c0c677b8b8b7f15bb03834147034ead41bc6310bf773ac84712bb43a14
+  data.tar.gz: c35de3457f199d57a3c8a4419bd0ad113df38ba071cfffbcc79311db910bc1cb
 SHA512:
-  metadata.gz: 2790a4d58595f0f89667c5fd4530dde2de532ddaf02628f373162cc47d393732b1c9475ab59775c756750dfb52e60e7091118936ac8e70739fb266b46f82d3bd
-  data.tar.gz: eb74f34bf0b9a681557809c656754312eb266e66c3b68fcabbf95699c3273cf4d998e3969224b09df9127ff90f5d34fba5bc93b1ff0c321b4a7646ddfcc0b6b7
+  metadata.gz: 33e0785425af5a32c7e09d95e2d11e02d83cdda1d907b34197c63642bfec81cd04a40ffc2e25486fe45af66d9a681f57c41d083d7bc56f24b69f1cf4b3a478f6
+  data.tar.gz: 6aa65f3b65c819171bcadb61a3a43c3ff7af748d29a9177dbd02549229e3b9fa64b338d0404383b97615e74aa5381dd8a4c997edbf86ca0e8a2970e0213b2ece

data/AUTHORS.md

@@ -2,31 +2,37 @@ Sinatra was designed and developed by Blake Mizerany in California.
 
 ### Current Team
 
-* **Konstantin Haase** (maintainer)
+* **Eloy Perez**
+* **Jordan Owens**
+* **Olle Jonsson**
+* **Patrik Ragnarsson**
 * **Zachary Scott**
-* **Kashyap Kondamudi**
-* **Ashley Williams**
-* **Trevor Bramble**
-* **Kunpei Sakai**
 
 ### Alumni
 
 * **Blake Mizerany** (creator)
+* **Konstantin Haase** (maintainer)
 * **Ryan Tomayko**
 * **Simon Rozet**
 * **Katrina Owen**
+* **Kashyap Kondamudi**
+* **Ashley Williams**
+* **Trevor Bramble**
+* **Kunpei Sakai**
 
 ### Thanks
 
 Sinatra would not have been possible without strong company backing.
 In the past, financial and emotional support have been provided mainly by
-[Heroku](http://heroku.com), [GitHub](https://github.com) and
-[Engine Yard](http://www.engineyard.com/), and is now taken care of by
-[Travis CI](http://travis-ci.com/).
+[Heroku](https://heroku.com), [GitHub](https://github.com),
+[Engine Yard](http://www.engineyard.com/) and [Travis CI](https://travis-ci.com/),
+and is now taken care of by [84codes](https://www.84codes.com/).
 
 Special thanks to the following extraordinary individuals, without whom
 Sinatra would not be possible:
 
+* [Benoit Daloze](https://eregon.me/blog/) (eregon) for help around TruffleRuby
+  and keyword arguments use in mustermann.
 * [Ryan Tomayko](http://tomayko.com/) (rtomayko) for constantly fixing
   whitespace errors __60d5006__
 * [Ezra Zygmuntowicz](http://brainspl.at/) (ezmobius) for initial help and

data/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 * _Your new feature here._
 
+## 3.2.0 / 2023-12-29
+
+* New: Add `#except` method to `Sinatra::IndifferentHash` ([#1940])
+
+* New: Use `Exception#detailed_message` to show backtrace ([#1952])
+
+* New: Add `Sinatra::HamlHelpers` to sinatra-contrib ([#1960])
+
+* Fix: Add `base64` to rack-protection runtime dependencies ([#1946])
+
+* Fix: Avoid open-ended dependencies for sinatra-contrib and rack-protection ([#1949])
+
+* Fix: Helpful message when `Sinatra::Runner` times out ([#1975])
+
+* Fix: Ruby 3.3 + Bundler 2.5 compatibility ([#1975])
+
+[#1940]: https://github.com/sinatra/sinatra/pull/1940
+[#1946]: https://github.com/sinatra/sinatra/pull/1946
+[#1949]: https://github.com/sinatra/sinatra/pull/1949
+[#1952]: https://github.com/sinatra/sinatra/pull/1952
+[#1960]: https://github.com/sinatra/sinatra/pull/1960
+[#1975]: https://github.com/sinatra/sinatra/pull/1960
+
 ## 3.1.0 / 2023-08-07
 
 * New: Add sass support via sass-embedded [#1911] by なつき
@@ -16,6 +39,7 @@
 
 * Fix: rack-protection: specify rack version requirement [#1932] by Patrik Ragnarsson
 
+[#1911]: https://github.com/sinatra/sinatra/pull/1911
 [#1913]: https://github.com/sinatra/sinatra/pull/1913
 [#1900]: https://github.com/sinatra/sinatra/pull/1900
 [#1924]: https://github.com/sinatra/sinatra/pull/1924

data/Gemfile

@@ -24,9 +24,9 @@ puma_version = { github: 'puma/puma' } if puma_version == 'head'
 gem 'puma', puma_version
 
 gem 'minitest', '~> 5.0'
-gem 'rack-test', github: 'rack/rack-test'
+gem 'rack-test'
 gem 'rubocop', '~> 1.32.0', require: false
-gem 'yard'
+gem 'yard' # used by rake doc
 
 gem 'rack-protection', path: 'rack-protection'
 gem 'sinatra-contrib', path: 'sinatra-contrib'
@@ -37,10 +37,9 @@ gem 'sinatra-contrib', path: 'sinatra-contrib'
 # https://github.com/socketry/async-http/pull/124/files#r1237988899
 gem 'traces', '< 0.10.0' if RUBY_VERSION >= '2.6.0' && RUBY_VERSION < '2.7.0'
 
-gem 'activesupport', '~> 6.1'
-
 gem 'asciidoctor'
 gem 'builder'
+gem 'childprocess'
 gem 'commonmarker', '~> 0.23.4', platforms: [:ruby]
 gem 'erubi'
 gem 'eventmachine'
@@ -48,19 +47,25 @@ gem 'falcon', '~> 0.40', platforms: [:ruby]
 gem 'haml', '~> 6'
 gem 'kramdown'
 gem 'liquid'
-gem 'markaby'
+# markaby 0.9.1 introduced Ruby 2.7 syntax in https://github.com/markaby/markaby/pull/44
+# and does not specify required_ruby_version
+if RUBY_VERSION >= '2.6.0' && RUBY_VERSION < '2.7.0'
+  gem 'markaby', '< 0.9.1'
+else
+  gem 'markaby'
+end
 gem 'nokogiri', '> 1.5.0'
 gem 'pandoc-ruby', '~> 2.0.2'
 gem 'rabl'
-gem 'rainbows', platforms: [:mri] # uses #fork
-gem 'rdiscount', platforms: [:ruby]
+if RUBY_ENGINE == 'truffleruby'
+  gem 'rdiscount', '< 2.2.7.2' # https://github.com/oracle/truffleruby/issues/3362
+else
+  gem 'rdiscount', platforms: [:ruby]
+end
 gem 'rdoc'
 gem 'redcarpet', platforms: [:ruby]
 gem 'sass-embedded', '~> 1.54'
 gem 'simplecov', require: false
 gem 'slim', '~> 4'
 gem 'yajl-ruby', platforms: [:ruby]
-
-gem 'json', platforms: %i[jruby mri]
-
-gem 'jar-dependencies', '= 0.4.1', platforms: [:jruby] # Gem::LoadError with jar-dependencies 0.4.2
+gem 'zeitwerk'

data/README.md

@@ -846,7 +846,7 @@ It also takes a block for inline templates (see [example](#inline-templates)).
 <table>
   <tr>
     <td>Dependency</td>
-    <td><a href="http://slim-lang.com/" title="Slim Lang">Slim Lang</a></td>
+    <td><a href="https://slim-template.github.io/" title="Slim Lang">Slim Lang</a></td>
   </tr>
   <tr>
     <td>File Extension</td>
@@ -1199,22 +1199,6 @@ $ ruby -e "require 'securerandom'; puts SecureRandom.hex(64)"
 99ae8af...snip...ec0f262ac
 ```
 
-**Session Secret Generation (Bonus Points)**
-
-Use the [sysrandom gem](https://github.com/cryptosphere/sysrandom#readme) to
-use the system RNG facilities to generate random values instead of
-userspace `OpenSSL` which MRI Ruby currently defaults to:
-
-```text
-$ gem install sysrandom
-Building native extensions.  This could take a while...
-Successfully installed sysrandom-1.x
-1 gem installed
-
-$ ruby -e "require 'sysrandom/securerandom'; puts SecureRandom.hex(64)"
-99ae8af...snip...ec0f262ac
-```
-
 **Session Secret Environment Variable**
 
 Set a `SESSION_SECRET` environment variable for Sinatra to the value you
@@ -1229,14 +1213,10 @@ purposes only:
 **Session Secret App Config**
 
 Set up your app config to fail-safe to a secure random secret
-if the `SESSION_SECRET` environment variable is not available.
-
-For bonus points use the [sysrandom
-gem](https://github.com/cryptosphere/sysrandom#readme) here as well:
+if the `SESSION_SECRET` environment variable is not available:
 
 ```ruby
 require 'securerandom'
-# -or- require 'sysrandom/securerandom'
 set :session_secret, ENV.fetch('SESSION_SECRET') { SecureRandom.hex(64) }
 ```
 
@@ -1441,53 +1421,9 @@ to `stream` finishes executing. Streaming does not work at all with Shotgun.
 
 If the optional parameter is set to `keep_open`, it will not call `close` on
 the stream object, allowing you to close it at any later point in the
-execution flow. This only works on evented servers, like Rainbows.
-Other servers will still close the stream:
-
-```ruby
-# config.ru
-require 'sinatra/base'
-
-class App < Sinatra::Base
-  connections = []
+execution flow.
 
-  get '/subscribe', provides: 'text/event-stream'  do
-    # register a client's interest in server events
-    stream(:keep_open) do |out|
-      connections << out
-      # purge dead connections
-      connections.reject!(&:closed?)
-    end
-  end
-
-  post '/' do
-    connections.each do |out|
-      # notify client that a new message has arrived
-      out << "data: #{params[:msg]}\n\n"
-
-      # indicate client to connect again
-      out.close
-    end
-
-    204 # response without entity body
-  end
-end
-
-run App
-```
-
-```ruby
-# rainbows.conf
-Rainbows! do
-  use :EventMachine
-end
-````
-
-Run:
-
-```shell
-rainbows -c rainbows.conf
-```
+You can have a look at the [chat example](https://github.com/sinatra/sinatra/blob/main/examples/chat.rb)
 
 It's also possible for the client to close the connection when trying to
 write to the socket. Because of this, it's recommended to check
@@ -2878,39 +2814,7 @@ by Konstantin_
 Sinatra doesn't impose any concurrency model but leaves that to the
 underlying Rack handler (server) like Puma or WEBrick. Sinatra
 itself is thread-safe, so there won't be any problem if the Rack handler
-uses a threaded model of concurrency. This would mean that when starting
-the server, you'd have to specify the correct invocation method for the
-specific Rack handler. The following example is a demonstration of how
-to start a multi-threaded Rainbows server:
-
-```ruby
-# config.ru
-
-require 'sinatra/base'
-
-class App < Sinatra::Base
-  get '/' do
-    "Hello, World"
-  end
-end
-
-run App
-```
-
-```ruby
-# rainbows.conf
-
-# Rainbows configurator is based on Unicorn.
-Rainbows! do
-  use :ThreadSpawn
-end
-```
-
-To start the server, the command would be:
-
-```shell
-rainbows -c rainbows.conf
-```
+uses a threaded model of concurrency.
 
 ## Requirement
 

data/Rakefile

@@ -191,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
@@ -203,10 +203,22 @@ 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
 

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 @@
-3.1.0
+3.2.0

data/examples/stream.ru

@@ -6,7 +6,6 @@
 #
 #   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'
 

data/lib/sinatra/base.rb

@@ -209,7 +209,7 @@ module Sinatra
     end
   end
 
-  # Some Rack handlers (Rainbows!) implement an extended body object protocol, however,
+  # Some Rack handlers implement an extended body object protocol, however,
   # some middleware (namely Rack::Lint) will break it by not mirroring the methods in question.
   # This middleware will detect an extended body object and will make sure it reaches the
   # handler directly. We do this here, so our middleware and middleware set up by the app will
@@ -502,8 +502,7 @@ module Sinatra
     # the response body have not yet been generated.
     #
     # The close parameter specifies whether Stream#close should be called
-    # after the block has been executed. This is only relevant for evented
-    # servers like Rainbows.
+    # after the block has been executed.
     def stream(keep_open = false)
       scheduler = env['async.callback'] ? EventMachine : Stream
       current   = @params.dup
@@ -1261,7 +1260,19 @@ module Sinatra
     end
 
     def dump_errors!(boom)
-      msg = ["#{Time.now.strftime('%Y-%m-%d %H:%M:%S')} - #{boom.class} - #{boom.message}:", *boom.backtrace].join("\n\t")
+      if boom.respond_to?(:detailed_message)
+        msg = boom.detailed_message(highlight: false)
+        if msg =~ /\A(.*?)(?: \(#{ Regexp.quote(boom.class.to_s) }\))?\n/
+          msg = $1
+          additional_msg = $'.lines(chomp: true)
+        else
+          additional_msg = []
+        end
+      else
+        msg = boom.message
+        additional_msg = []
+      end
+      msg = ["#{Time.now.strftime('%Y-%m-%d %H:%M:%S')} - #{boom.class} - #{msg}:", *additional_msg, *boom.backtrace].join("\n\t")
       @env['rack.errors'].puts(msg)
     end
 
@@ -1270,6 +1281,7 @@ module Sinatra
         %r{/sinatra(/(base|main|show_exceptions))?\.rb$},   # all sinatra code
         %r{lib/tilt.*\.rb$},                                # all tilt code
         /^\(.*\)$/,                                         # generated code
+        /\/bundled_gems.rb$/,                               # ruby >= 3.3 with bundler >= 2.5
         %r{rubygems/(custom|core_ext/kernel)_require\.rb$}, # rubygems require hacks
         /active_support/,                                   # active_support require hacks
         %r{bundler(/(?:runtime|inline))?\.rb},              # bundler require hacks
@@ -1995,7 +2007,7 @@ module Sinatra
           </head>
           <body>
             <h2>Sinatra doesn’t know this ditty.</h2>
-            <img src='#{uri '/__sinatra__/404.png'}'>
+            <img src='#{request.script_name}/__sinatra__/404.png'>
             <div id="c">
               Try this:
               <pre>#{Rack::Utils.escape_html(code)}</pre>

data/lib/sinatra/indifferent_hash.rb

@@ -21,7 +21,8 @@ module Sinatra
   # writing interface (calling e.g. <tt>[]=</tt>, <tt>merge</tt>). This mapping
   # belongs to the public interface. For example, given:
   #
-  #   hash = Sinatra::IndifferentHash.new(:a=>1)
+  #   hash = Sinatra::IndifferentHash.new
+  #   hash[:a] = 1
   #
   # You are guaranteed that the key is returned as a string:
   #
@@ -29,7 +30,8 @@ module Sinatra
   #
   # Technically other types of keys are accepted:
   #
-  #   hash = Sinatra::IndifferentHash.new(:a=>1)
+  #   hash = Sinatra::IndifferentHash
+  #   hash[:a] = 1
   #   hash[0] = 0
   #   hash # => { "a"=>1, 0=>0 }
   #
@@ -186,6 +188,12 @@ module Sinatra
       dup.tap(&:compact!)
     end
 
+    def except(*keys)
+      keys.map!(&method(:convert_key))
+
+      super(*keys)
+    end if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.0")
+
     private
 
     def convert_key(key)

data/lib/sinatra/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sinatra
-  VERSION = '3.1.0'
+  VERSION = '3.2.0'
 end

data/sinatra.gemspec

@@ -49,6 +49,4 @@ RubyGems 2.0 or newer is required to protect against public gem pushes. You can
   s.add_dependency 'rack', '~> 2.2', '>= 2.2.4'
   s.add_dependency 'rack-protection', version
   s.add_dependency 'tilt', '~> 2.0'
-
-  s.add_development_dependency 'rack-test', '~> 2'
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: sinatra
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Blake Mizerany
 - Ryan Tomayko
 - Simon Rozet
 - Konstantin Haase
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-07 00:00:00.000000000 Z
+date: 2023-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustermann
@@ -53,14 +53,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -75,20 +75,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
 description: Sinatra is a DSL for quickly creating web applications in Ruby with minimal
   effort.
 email: sinatrarb@googlegroups.com
@@ -111,8 +97,6 @@ files:
 - VERSION
 - examples/chat.rb
 - examples/lifecycle_events.rb
-- examples/rainbows.conf
-- examples/rainbows.rb
 - examples/simple.rb
 - examples/stream.ru
 - lib/sinatra.rb
@@ -134,7 +118,7 @@ metadata:
   bug_tracker_uri: https://github.com/sinatra/sinatra/issues
   mailing_list_uri: http://groups.google.com/group/sinatrarb
   documentation_uri: https://www.rubydoc.info/gems/sinatra
-post_install_message:
+post_install_message: 
 rdoc_options:
 - "--line-numbers"
 - "--title"
@@ -155,8 +139,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.18
-signing_key:
+rubygems_version: 3.5.3
+signing_key: 
 specification_version: 4
 summary: Classy web-development dressed in a DSL
 test_files: []

data/examples/rainbows.conf

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

data/examples/rainbows.rb

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