mongrel2 0.52.2 → 0.53.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24e113d1bcf54c6f4bcf65da394d77aef9450d0f71d71030f6329e39333df791
-  data.tar.gz: 3a76c67fbafe6d20e9097297a3a83ebe4592af07200ec16de6b8c9f32c7590d6
+  metadata.gz: d437852dd09b80cd9925ec41dbc8b29d9d2d0d758e30cd5acab9d378167fd1bd
+  data.tar.gz: 1de4e99640b27b825d1540e28d99ec0d9338f1cf6907ed34217cb10c87f6163d
 SHA512:
-  metadata.gz: e144a8ad58b73d5bbb0f20f040a5ac7b88c7368bff07ab93da5e23598b840c42d385eddd511cc115e9b1262d70bc7561257d3ae90f33859bf463a14b3d5dbe93
-  data.tar.gz: 91d6395e90a33131c7af833b2f67d3b25848accda8048daf797760b364e745350fd1c53e617265f460b88c0bd2d5bbbb69abed76fe74a8d896eebc31a689e4ee
+  metadata.gz: 398bf47544d029215eb81829999ea3fd3438e03576cb1be8abbc9e5a842bb95044e29faf000d5e863e9b2f3ef5f69d1d15b33a647d1c13d9e1f3ad191f5f902a
+  data.tar.gz: 39d7771ea0811fccb299d61cf960ee6d50e708012e099b7eec10dcf20290ecdb7b7bd01cb5db6eefc4bbe787d14a5eee7ad810963d13f43a5757d6b332f77d6f

data/ChangeLog

@@ -1,8 +1,134 @@
+2019-06-26  Michael Granger  <ged@FaerieMUD.org>
+
+@  	* History.rdoc, Rakefile, lib/mongrel2.rb:
+|  	Bump the minor version, update history, bump minimum Ruby version to
+|  	2.4.x
+|  	[cfedd3805c13] [tip]
+|
+o  	* Manifest.txt, lib/mongrel2/table.rb, lib/mongrel2/testing.rb,
+|  	spec/mongrel2/testing_spec.rb:
+|  	Fix a few bugs in the testing facilities
+|  	[c7c8575f9d60]
+|
+2019-05-07  Michael Granger  <ged@FaerieMUD.org>
+
+o  	* lib/mongrel2.rb, lib/mongrel2/config.rb,
+|  	lib/mongrel2/config/directory.rb, lib/mongrel2/config/dsl.rb,
+|  	lib/mongrel2/config/filter.rb, lib/mongrel2/config/handler.rb,
+|  	lib/mongrel2/config/host.rb, lib/mongrel2/config/log.rb,
+|  	lib/mongrel2/config/mimetype.rb, lib/mongrel2/config/proxy.rb,
+|  	lib/mongrel2/config/route.rb, lib/mongrel2/config/server.rb,
+|  	lib/mongrel2/config/setting.rb, lib/mongrel2/config/statistic.rb,
+|  	lib/mongrel2/config/xrequest.rb, lib/mongrel2/connection.rb,
+|  	lib/mongrel2/constants.rb, lib/mongrel2/control.rb,
+|  	lib/mongrel2/exceptions.rb, lib/mongrel2/handler.rb,
+|  	lib/mongrel2/httprequest.rb, lib/mongrel2/httpresponse.rb,
+|  	lib/mongrel2/jsonrequest.rb, lib/mongrel2/request.rb,
+|  	lib/mongrel2/response.rb, lib/mongrel2/table.rb,
+|  	lib/mongrel2/testing.rb, lib/mongrel2/websocket.rb,
+|  	lib/mongrel2/xmlrequest.rb, spec/constants.rb, spec/helpers.rb,
+|  	spec/matchers.rb, spec/mongrel2/config/directory_spec.rb,
+|  	spec/mongrel2/config/dsl_spec.rb,
+|  	spec/mongrel2/config/filter_spec.rb,
+|  	spec/mongrel2/config/handler_spec.rb,
+|  	spec/mongrel2/config/host_spec.rb, spec/mongrel2/config/log_spec.rb,
+|  	spec/mongrel2/config/proxy_spec.rb,
+|  	spec/mongrel2/config/route_spec.rb,
+|  	spec/mongrel2/config/server_spec.rb,
+|  	spec/mongrel2/config/setting_spec.rb,
+|  	spec/mongrel2/config/statistic_spec.rb,
+|  	spec/mongrel2/config/xrequest_spec.rb, spec/mongrel2/config_spec.rb,
+|  	spec/mongrel2/connection_spec.rb, spec/mongrel2/constants_spec.rb,
+|  	spec/mongrel2/control_spec.rb, spec/mongrel2/handler_spec.rb,
+|  	spec/mongrel2/httprequest_spec.rb,
+|  	spec/mongrel2/httpresponse_spec.rb, spec/mongrel2/request_spec.rb,
+|  	spec/mongrel2/response_spec.rb, spec/mongrel2/table_spec.rb,
+|  	spec/mongrel2/websocket_spec.rb, spec/mongrel2/xmlrequest_spec.rb,
+|  	spec/mongrel2_spec.rb:
+|  	Modify to run with frozen string literals
+|  	[71e4f3d21a77]
+|
+2019-05-06  Michael Granger  <ged@FaerieMUD.org>
+
+o  	* lib/mongrel2/websocket.rb:
+|  	Remove FrameMethod from WebSocket::ServerHandshake
+|  	[e51f83280d48]
+|
+2019-05-03  Michael Granger  <ged@FaerieMUD.org>
+
+o  	* lib/mongrel2/testing.rb, lib/mongrel2/websocket.rb:
+|  	Make WebSocket::Request#response more consistent with other kinds of
+|  	requests.
+|  	[ec5b4a929376]
+|
+o  	* lib/mongrel2/request.rb, lib/mongrel2/response.rb,
+|  	lib/mongrel2/websocket.rb, spec/mongrel2/request_spec.rb,
+|  	spec/mongrel2/response_spec.rb:
+|  	Add a #socket_id method to Mongrel2::Request and ::Response.
+|  	[68b1868529c1]
+|
+o  	* examples/ws-echo.rb, experiments/ws-chunks.rb,
+|  	lib/mongrel2/handler.rb, lib/mongrel2/testing.rb,
+|  	lib/mongrel2/websocket.rb, spec/constants.rb,
+|  	spec/mongrel2/handler_spec.rb, spec/mongrel2/websocket_spec.rb:
+|  	Rewrite websocket functionality
+|
+|  	This is a rewrite meant to make it easier to use websockets from
+|  	within handlers. To that end, this:
+|
+|  	- Makes request/response and the frame different classes to make it
+|  	easier to build frames manually.
+|  	- Make use of iterators for composability
+|  	- Add a convenience method for building a fragmented stream of frames
+|  	from an IO-like object.
+|  	[643069fd2f50]
+|
+2019-05-01  Michael Granger  <ged@FaerieMUD.org>
+
+o  	* lib/mongrel2/request.rb:
+|  	Fix a typo in method docs
+|  	[0aca6acfe8d0]
+|
+2019-04-24  Michael Granger  <ged@FaerieMUD.org>
+
+o  	* .hgtags:
+|  	Added tag v0.52.2 for changeset 6ca17e3a8916
+|  	[ed7b89588792]
+|
+o  	* .hgsigs:
+|  	Added signature for changeset 1e1a3c278751
+|  	[6ca17e3a8916] [v0.52.2]
+|
+o  	* History.rdoc, lib/mongrel2.rb:
+|  	Bump the patch version, update history.
+|  	[1e1a3c278751]
+|
+o  	* spec/mongrel2/config/directory_spec.rb,
+|  	spec/mongrel2/config/dsl_spec.rb,
+|  	spec/mongrel2/config/handler_spec.rb,
+|  	spec/mongrel2/config/log_spec.rb,
+|  	spec/mongrel2/config/route_spec.rb,
+|  	spec/mongrel2/config/server_spec.rb, spec/mongrel2/config_spec.rb,
+|  	spec/mongrel2/control_spec.rb, spec/mongrel2/handler_spec.rb,
+|  	spec/mongrel2/httprequest_spec.rb,
+|  	spec/mongrel2/httpresponse_spec.rb, spec/mongrel2/request_spec.rb,
+|  	spec/mongrel2/response_spec.rb, spec/mongrel2/table_spec.rb,
+|  	spec/mongrel2/websocket_spec.rb, spec/mongrel2_spec.rb:
+|  	Make whitespace consistent in specs.
+|  	[4632293da126]
+|
+2019-02-20  Michael Granger  <ged@FaerieMUD.org>
+
+o  	* .ruby-version, lib/mongrel2/handler.rb,
+|  	spec/mongrel2/connection_spec.rb, spec/mongrel2/handler_spec.rb:
+|  	Bump Ruby to 2.6, fix a few specs
+|  	[3ff8014ca87c]
+|
 2018-07-31  Michael Granger  <ged@FaerieMUD.org>
 
-@  	* lib/mongrel2/connection.rb:
+o  	* lib/mongrel2/connection.rb:
 |  	Don't set linger on the Connection sockets until they're closing
-|  	[3da3c8480391] [tip]
+|  	[3da3c8480391]
 |
 o  	* lib/mongrel2/handler.rb:
 |  	Defer creation of the reactor in the handler until it's #run

data/History.rdoc

@@ -1,3 +1,13 @@
+== v0.53.0 [2019-05-07] Michael Granger <ged@FaerieMUD.org>
+
+Enhancements:
+
+- Modify to run with frozen string literals (Ruby >= 2.6).
+- Add a #socket_id method to Mongrel2::Request and ::Response.
+- Rewrite websocket functionality to make it easier to write servers
+  that use it.
+
+
 == v0.52.2 [2019-04-24] Michael Granger <ged@FaerieMUD.org>
 
 Bugfixes:

data/Manifest.txt

@@ -65,6 +65,7 @@ spec/mongrel2/httpresponse_spec.rb
 spec/mongrel2/request_spec.rb
 spec/mongrel2/response_spec.rb
 spec/mongrel2/table_spec.rb
+spec/mongrel2/testing_spec.rb
 spec/mongrel2/websocket_spec.rb
 spec/mongrel2/xmlrequest_spec.rb
 spec/mongrel2_spec.rb

data/Rakefile

@@ -42,7 +42,7 @@ hoespec = Hoe.spec 'mongrel2' do
 	self.dependency 'hoe-deveiate',    '~> 0.8', :developer
 	self.dependency 'rdoc-generator-fivefish', '~> 0', :development
 
-	self.require_ruby_version( '>=2.2.0' )
+	self.require_ruby_version( '>=2.4.0' )
 	self.hg_sign_tags = true if self.respond_to?( :hg_sign_tags= )
 	self.check_history_on_release = true if self.respond_to?( :check_history_on_release= )
 	self.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"

data/lib/mongrel2.rb

@@ -1,5 +1,5 @@
 # -*- ruby -*-
-#encoding: utf-8
+# frozen_string_literal: true
 
 require 'loggability'
 require 'cztop'
@@ -19,10 +19,10 @@ module Mongrel2
 	log_as :mongrel2
 
 
-	abort "\n\n>>> Mongrel2 requires Ruby 2.2 or later. <<<\n\n" if RUBY_VERSION < '2.2.0'
+	abort "\n\n>>> Mongrel2 requires Ruby 2.4 or later. <<<\n\n" if RUBY_VERSION < '2.4.0'
 
 	# Library version constant
-	VERSION = '0.52.2'
+	VERSION = '0.53.0'
 
 	# Version-control revision constant
 	REVISION = %q$Revision$

data/lib/mongrel2/config.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'yajl'
 require 'yaml'

data/lib/mongrel2/config/directory.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'mongrel2' unless defined?( Mongrel2 )
 require 'mongrel2/config' unless defined?( Mongrel2::Config )

data/lib/mongrel2/config/dsl.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'loggability'
 

data/lib/mongrel2/config/filter.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'tnetstring'
 

data/lib/mongrel2/config/handler.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'mongrel2' unless defined?( Mongrel2 )
 require 'mongrel2/config' unless defined?( Mongrel2::Config )

data/lib/mongrel2/config/host.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'mongrel2' unless defined?( Mongrel2 )
 require 'mongrel2/config' unless defined?( Mongrel2::Config )

data/lib/mongrel2/config/log.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'etc'
 require 'socket'

data/lib/mongrel2/config/mimetype.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'mongrel2' unless defined?( Mongrel2 )
 require 'mongrel2/config' unless defined?( Mongrel2::Config )

data/lib/mongrel2/config/proxy.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'mongrel2' unless defined?( Mongrel2 )
 require 'mongrel2/config' unless defined?( Mongrel2::Config )

data/lib/mongrel2/config/route.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'mongrel2' unless defined?( Mongrel2 )
 require 'mongrel2/config' unless defined?( Mongrel2::Config )

data/lib/mongrel2/config/server.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'uri'
 require 'pathname'

data/lib/mongrel2/config/setting.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'mongrel2' unless defined?( Mongrel2 )
 require 'mongrel2/config' unless defined?( Mongrel2::Config )

data/lib/mongrel2/config/statistic.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'mongrel2' unless defined?( Mongrel2 )
 require 'mongrel2/config' unless defined?( Mongrel2::Config )

data/lib/mongrel2/config/xrequest.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'tnetstring'
 

data/lib/mongrel2/connection.rb

@@ -1,5 +1,5 @@
 # -*- ruby -*-
-#encoding: utf-8
+# frozen_string_literal: true
 
 require 'socket'
 require 'cztop'

data/lib/mongrel2/constants.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 #encoding: utf-8
 
 require 'pathname'

data/lib/mongrel2/control.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'cztop'
 require 'yajl'

data/lib/mongrel2/exceptions.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 #--
 module Mongrel2

data/lib/mongrel2/handler.rb

@@ -1,5 +1,5 @@
-#-*- ruby -*-
-#encoding: utf-8
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'cztop'
 require 'cztop/reactor'
@@ -24,7 +24,7 @@ require 'mongrel2/websocket'
 # A dumb, dead-simple example that just returns a plaintext 'Hello'
 # document with a timestamp.
 #
-#     #!/usr/bin/env ruby
+#     # -*- ruby -*-
 #
 #     require 'mongrel2/handler'
 #
@@ -305,7 +305,7 @@ class Mongrel2::Handler
 			case request
 			when Mongrel2::WebSocket::ClientHandshake
 				return self.handle_websocket_handshake( request )
-			when Mongrel2::WebSocket::Frame
+			when Mongrel2::WebSocket::Request
 				return self.handle_websocket( request )
 			when Mongrel2::HTTPRequest
 				return self.handle( request )
@@ -409,10 +409,11 @@ class Mongrel2::Handler
 	### a new request via the regular callback when the upload completes whose entity body
 	### is open to the spooled file.
 	def handle_async_upload_start( request )
-		explanation = "If you wish to handle requests like this, either set your server's "
-		explanation << "'limits.content_length' setting to a higher value than %d, or override " %
-			 [ request.content_length ]
-		explanation << "#handle_async_upload_start."
+		explanation = <<~END_MESSAGE % [ request.content_length ]
+		If you wish to handle requests like this, either set your server's
+		'limits.content_length' setting to a higher value than %d, or override
+		#handle_async_upload_start.
+		END_MESSAGE
 
 		self.log.warn "Async upload from %s dropped." % [ request.remote_ip ]
 		self.log.info( explanation )

data/lib/mongrel2/httprequest.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'loggability'
 

data/lib/mongrel2/httpresponse.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 #encoding: utf-8
 
 require 'time'

data/lib/mongrel2/jsonrequest.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'yajl'
 require 'loggability'

data/lib/mongrel2/request.rb

@@ -1,5 +1,5 @@
-#-*- ruby -*-
-#encoding: utf-8
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'ipaddr'
 require 'stringio'
@@ -109,7 +109,7 @@ class Mongrel2::Request
 	#################################################################
 
 	### Create a new Request object with the given +sender_id+, +conn_id+, +path+, +headers+,
-	### and +body+. The optional +nil+ is for the raw request content, which can be useful
+	### and +body+. The optional +raw+ is for the raw request content, which can be useful
 	### later for debugging.
 	def initialize( sender_id, conn_id, path, headers, body='', raw=nil )
 
@@ -152,7 +152,7 @@ class Mongrel2::Request
 	### Set the request's entity body to +newbody+. If +newbody+ is a String-ish object
 	### (i.e., it responds to #to_str), it will be wrapped in a StringIO in 'r+' mode).
 	def body=( newbody )
-		newbody = StringIO.new( newbody, 'a+' ) if newbody.respond_to?( :to_str )
+		newbody = StringIO.new( newbody.dup, 'a+' ) if newbody.respond_to?( :to_str )
 		@body = newbody
 	end
 
@@ -258,15 +258,22 @@ class Mongrel2::Request
 	# :section: Introspection Methods
 	#
 
+	### Returns a string containing the request's sender and connection IDs
+	### separated by a colon.
+	def socket_id
+		return "%s:%d" % [ self.sender_id, self.conn_id ]
+	end
+
+
+
 	### Returns a string containing a human-readable representation of the Request,
 	### suitable for debugging.
 	def inspect
-		return "#<%p:0x%016x %s (%s/%d)>" % [
+		return "#<%p:0x%016x %s (%s)>" % [
 			self.class,
 			self.object_id * 2,
 			self.inspect_details,
-			self.sender_id,
-			self.conn_id
+			self.socket_id
 		]
 	end
 
@@ -295,8 +302,8 @@ class Mongrel2::Request
 				body.is_a?( String )
 
 			# Get the object as a String, set the encoding
-			str = body.to_s
-			str.force_encoding( enc ) if enc && str.encoding == Encoding::ASCII_8BIT
+			str = String.new( body, encoding: enc )
+			# str.force_encoding( enc ) if enc && str.encoding == Encoding::ASCII_8BIT
 
 			return StringIO.new( str, 'r+' )
 		else