webmachine 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50f6f80075000018960c21cd0e313ee59278caba937809ce8f0d23e9f8b03e5c
-  data.tar.gz: 60bdc1f1592aa26ddee4dc2cfa6bd0f44aae05a031a6b16194a8efce4ea9ed72
+  metadata.gz: 34385e0209af616a39bbd85807eb5a1989e7c4119757de7de598404aca768e7a
+  data.tar.gz: f850905e898bd592b2c5ef61a15e67c005a16ee9dadae1fc6dc09371dd043473
 SHA512:
-  metadata.gz: 31b0c2810bc7c2030bfc5eae7f20d0e9d3a057d76b75fdaddda0cbf97a64306735597c6a435653adce799088a525ec01d373acf210fb98af55af78ae89fc09cc
-  data.tar.gz: '097062c4470c980ada7bab9b0a26af4620b4689661e81168be662967cd37ebea5d3aab2d730138ce221947d6e5a410532cfbcd3ce72a0fcf51bf47eeb0fc03ee'
+  metadata.gz: da0492a20458fea3a771532b6c144bd7e0b65bd517d9d951d7669f8772fb239fe9028717cf8778ed51de44cd600da7c14799db20035bf8f33673a15aa1618c55
+  data.tar.gz: 0febf4b1cc9425928352377bfc191bae02a27696e6c18cac1f0f1f5d865fefe0143fc9e92be3d1c36f17e54a4f4e1434b7b917f605bfb916607894aed524f5c9

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ### HEAD
 
+### 2.0.2
+
+* Support Rack version 3
+* Support Ruby 3.4 and 4.0
+* Apply RuboCop fixes
+* Clean up gemspec configuration
+* Organise development and test dependencies in the Gemfile
+
 ### 2.0.1 Feb 27, 2024
 
 * Don't include the `doc/`, `pkg/`, or `vendor/` directory in the gem package

data/examples/logging.rb

@@ -34,7 +34,7 @@ App = Webmachine::Application.new do |app|
 
   app.configure do |config|
     config.adapter = :WEBrick
-    config.adapter_options = {AccessLog: [], Logger: Logger.new('/dev/null')}
+    config.adapter_options = {AccessLog: [], Logger: Logger.new(File::NULL)}
   end
 end
 

data/lib/webmachine/adapters/rack.rb

@@ -41,7 +41,7 @@ module Webmachine
       DEFAULT_OPTIONS = {}
 
       REQUEST_URI = 'REQUEST_URI'.freeze
-      VERSION_STRING = "#{Webmachine::SERVER_STRING} Rack/#{::Rack.version}".freeze
+      VERSION_STRING = "#{Webmachine::SERVER_STRING} Rack/#{::Rack.release}".freeze
       NEWLINE = "\n".freeze
 
       # Start the Rack adapter
@@ -52,7 +52,12 @@ module Webmachine
           Host: application.configuration.ip
         }).merge(application.configuration.adapter_options)
 
-        @server = ::Rack::Server.new(options)
+        if rack_v3?
+          require 'rackup'
+          @server = ::Rackup::Server.new(options)
+        else
+          @server = ::Rack::Server.new(options)
+        end
         @server.start
       end
 
@@ -70,7 +75,7 @@ module Webmachine
         response.headers[SERVER] = VERSION_STRING
 
         rack_status = response.code
-        rack_headers = response.headers.flattened(NEWLINE)
+        rack_headers = build_rack_response_headers(response.headers)
         rack_body = case response.body
         when String # Strings are enumerable in ruby 1.8
           [response.body]
@@ -78,10 +83,25 @@ module Webmachine
           if (io_body = IO.try_convert(response.body))
             io_body
           elsif response.body.respond_to?(:call)
-            Webmachine::ChunkedBody.new(Array(response.body.call))
+            if rack_v3?
+              # In Rack 3 the server (e.g. WEBrick via Rackup) buffers the body
+              # and applies chunked encoding itself when Transfer-Encoding is set,
+              # so we must not pre-encode with ChunkedBody.
+              [response.body.call]
+            else
+              # Rack 2's WEBrick handler sends the body as-is; ChunkedBody is
+              # required to produce valid chunked-encoded wire data.
+              Webmachine::ChunkedBody.new(Array(response.body.call))
+            end
           elsif response.body.respond_to?(:each)
-            # This might be an IOEncoder with a Content-Length, which shouldn't be chunked.
-            if response.headers[TRANSFER_ENCODING] == 'chunked'
+            if rack_v3?
+              # Return the plain enumerable. Rackup buffers it into a String then
+              # WEBrick chunks that String when Transfer-Encoding: chunked is set.
+              response.body
+            elsif response.headers[TRANSFER_ENCODING] == 'chunked'
+              # Rack 2: only pre-encode bodies that are already marked chunked;
+              # IOEncoder bodies carry their own Content-Length and must not be
+              # wrapped.
               Webmachine::ChunkedBody.new(response.body)
             else
               response.body
@@ -97,6 +117,45 @@ module Webmachine
 
       protected
 
+      # Build a Rack-compatible response headers hash from Webmachine's response
+      # headers.
+      #
+      # Header names are always lowercased: this is required by Rack 3 and is
+      # harmless for Rack 2 (all Rack 2 handlers match header names
+      # case-insensitively).
+      #
+      # The +set-cookie+ value is formatted differently per Rack version:
+      #
+      # * Rack 3 / Rackup: the value must be an Array. Rackup's WEBrick handler
+      #   deletes the lowercase +set-cookie+ key and calls
+      #   +res.cookies.concat(Array(value))+, emitting one Set-Cookie line per
+      #   cookie. Joining with +\n+ instead would produce a header value
+      #   containing a newline, which WEBrick 1.9+ rejects as
+      #   +WEBrick::HTTPResponse::InvalidHeader+.
+      #
+      # * Rack 2 / Rack::Handler::WEBrick: the handler splits on +\n+ before
+      #   adding cookies (+vs.split("\n")+), so the value must be a newline-joined
+      #   String. Passing an Array causes a +NoMethodError+ because +Array+ does
+      #   not define +#split+.
+      def build_rack_response_headers(response_headers)
+        response_headers.each_with_object({}) do |(key, value), h|
+          rack_key = key.downcase
+          h[rack_key] = if rack_key == 'set-cookie'
+            if rack_v3?
+              # Array lets Rackup emit one Set-Cookie header per cookie.
+              Array(value)
+            else
+              # Rack 2's handler splits on \n; give it a newline-joined String.
+              Array(value).join(NEWLINE)
+            end
+          elsif value.is_a?(Array)
+            value.join(NEWLINE)
+          else
+            value
+          end
+        end
+      end
+
       def routing_tokens(rack_req)
         nil # no-op for default, un-mapped rack adapter
       end
@@ -107,6 +166,11 @@ module Webmachine
 
       private
 
+      # Returns true when running under Rack 3.x.
+      def rack_v3?
+        ::Rack.release.start_with?('3.')
+      end
+
       def build_webmachine_request(rack_req, headers)
         RackRequest.new(rack_req.request_method,
           rack_req.url,
@@ -128,6 +192,9 @@ module Webmachine
 
       class RackResponse
         ONE_FIVE = '1.5'.freeze
+        # Header names are normalised to lowercase by build_rack_response_headers,
+        # so use the lowercase form everywhere inside RackResponse too.
+        LOWERCASE_CONTENT_TYPE = 'content-type'.freeze
 
         def initialize(body, status, headers)
           @body = body
@@ -136,8 +203,8 @@ module Webmachine
         end
 
         def finish
-          @headers[CONTENT_TYPE] ||= TEXT_HTML if rack_release_enforcing_content_type
-          @headers.delete(CONTENT_TYPE) if response_without_body
+          @headers[LOWERCASE_CONTENT_TYPE] ||= TEXT_HTML if rack_release_enforcing_content_type
+          @headers.delete(LOWERCASE_CONTENT_TYPE) if response_without_body
           [@status, @headers, @body]
         end
 
@@ -177,8 +244,12 @@ module Webmachine
           if @value
             @value.join
           else
-            @request.body.rewind
-            @request.body.read
+            # Rack 3 removed the requirement for rack.input to implement #rewind
+            # (Rack::Lint::InputWrapper in Rack 3 does not define it), so guard
+            # the call to avoid a NoMethodError on every PUT/POST request.
+            body = @request.body
+            body.rewind if body.respond_to?(:rewind)
+            body.read
           end
         end
 

data/lib/webmachine/adapters/webrick.rb

@@ -29,7 +29,7 @@ module Webmachine
       class Server < ::WEBrick::HTTPServer
         def initialize(options)
           @application = options[:application]
-          super(options)
+          super
         end
 
         # Handles a request

data/lib/webmachine/etags.rb

@@ -5,6 +5,7 @@ module Webmachine
   # This class by itself represents a "strong" entity tag.
   class ETag
     include QuotedString
+
     # The pattern for a weak entity tag
     WEAK_ETAG = /^W\/#{QUOTED_STRING}$/.freeze
 

data/lib/webmachine/headers.rb

@@ -32,7 +32,7 @@ module Webmachine
     #   @param [Object]
     # @return [Webmachine::Headers]
     def self.[](*args)
-      super(super(*args).map { |k, v| [k.to_s.downcase, v] })
+      super(super.map { |k, v| [k.to_s.downcase, v] })
     end
 
     # Fetch a header

data/lib/webmachine/media_type.rb

@@ -6,6 +6,7 @@ module Webmachine
   # Encapsulates a MIME media type, with logic for matching types.
   class MediaType
     extend Translation
+
     # Matches valid media types
     MEDIA_TYPE_REGEX = /^\s*([^;\s]+)\s*((?:;\s*\S+\s*)*)\s*$/.freeze
 
@@ -112,11 +113,8 @@ module Webmachine
     #   ignoring params and taking into account wildcards
     def type_matches?(other)
       other = self.class.parse(other)
-      if [Dispatcher::Route::MATCH_ALL_STR, MATCHES_ALL, type].include?(other.type)
-        true
-      else
-        other.major == major && other.minor == Dispatcher::Route::MATCH_ALL_STR
-      end
+      [Dispatcher::Route::MATCH_ALL_STR, MATCHES_ALL, type].include?(other.type) ||
+        (other.major == major && other.minor == Dispatcher::Route::MATCH_ALL_STR)
     end
   end # class MediaType
 end # module Webmachine

data/lib/webmachine/streaming/io_encoder.rb

@@ -7,6 +7,7 @@ module Webmachine
     # @api private
     class IOEncoder < Encoder
       include Enumerable
+
       CHUNK_SIZE = 8192
       # Iterates over the IO, encoding and yielding individual chunks
       # of the response entity.

data/lib/webmachine/trace/pstore_trace_store.rb

@@ -1,16 +1,15 @@
-require 'pstore'
-
 module Webmachine
   module Trace
-    # Implements a trace storage using PStore from Ruby's standard
-    # library. To use this trace store, specify the :pstore engine
-    # and a path where it can store traces:
+    # Implements a trace storage using the pstore gem. To use this trace store,
+    # add `pstore` to your Gemfile and specify the :pstore engine and a path
+    # where it can store traces:
     # @example
     #   Webmachine::Trace.trace_store = :pstore, "/tmp/webmachine.trace"
     class PStoreTraceStore
       # @api private
       # @param [String] path where to store traces in a PStore
       def initialize(path)
+        require 'pstore' # JIT load of the pstore gem. Avoid requiring the dependency when this class is not used.
         @pstore = PStore.new(path)
       end
 

data/lib/webmachine/version.rb

@@ -1,6 +1,6 @@
 module Webmachine
   # Library version
-  VERSION = '2.0.1'.freeze
+  VERSION = '2.0.2'.freeze
 
   # String for use in "Server" HTTP response header, which includes
   # the {VERSION}.

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: webmachine
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Sean Cribbs
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-27 00:00:00.000000000 Z
+date: 2026-09-22 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: i18n
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: as-notifications
   requirement: !ruby/object:Gem::Requirement
@@ -73,33 +45,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webrick
+  name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
-  type: :development
+        version: 0.4.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
-  name: standard
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.21'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '0'
 description: " webmachine is a toolkit for building HTTP applications in a declarative
   fashion, that avoids the confusion of going through a CGI-style interface like Rack.
   It is strongly influenced by the original Erlang project of the same name and shares
@@ -191,13 +163,14 @@ homepage: https://github.com/webmachine/webmachine-ruby
 licenses:
 - Apache-2.0
 metadata:
+  allowed_push_host: https://rubygems.org
   bug_tracker_uri: https://github.com/webmachine/webmachine-ruby/issues
   changelog_uri: https://github.com/webmachine/webmachine-ruby/blob/HEAD/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/webmachine/2.0.1
+  documentation_uri: https://www.rubydoc.info/gems/webmachine/2.0.2
   homepage_uri: https://github.com/webmachine/webmachine-ruby
   source_code_uri: https://github.com/webmachine/webmachine-ruby
   wiki_uri: https://github.com/webmachine/webmachine-ruby/wiki
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -212,8 +185,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: webmachine is a toolkit for building HTTP applications,
 test_files: []