strelka 0.15.0 → 0.16.0

data/History.rdoc

@@ -1,3 +1,20 @@
+== v0.16.0 [2019-08-10] Michael Granger <ged@FaerieMUD.org>
+
+Enhancements:
+
+- Add spec matchers for matching JSON entity bodies
+- Allow a block to be passed when loading a plugin
+- Fix up to work under frozen-string-literals mode
+- Add setup subcommand to bin/strelka
+- Rewrite the WebSocketServer to be easier to use and offer some common facilities
+  for managing connections, broadcasting to them, etc.
+- Update the restresources plugin for Sequel 5.0
+
+Bugfixes:
+
+- Fix some unintended argument mutation
+
+
 ==  v0.15.0 [2017-06-14] Michael Granger <ged@FaerieMUD.org>
 
 Enhancements:

data/Manifest.txt

@@ -83,6 +83,7 @@ lib/strelka/session/db.rb
 lib/strelka/session/default.rb
 lib/strelka/testing.rb
 lib/strelka/websocketserver.rb
+lib/strelka/websocketserver/heartbeat.rb
 lib/strelka/websocketserver/routing.rb
 spec/constants.rb
 spec/data/error.tmpl
@@ -134,6 +135,8 @@ spec/strelka/router_spec.rb
 spec/strelka/session/db_spec.rb
 spec/strelka/session/default_spec.rb
 spec/strelka/session_spec.rb
+spec/strelka/testing_spec.rb
+spec/strelka/websocketserver/heartbeat_spec.rb
 spec/strelka/websocketserver/routing_spec.rb
 spec/strelka/websocketserver_spec.rb
 spec/strelka_spec.rb

data/Rakefile

@@ -16,7 +16,7 @@ Hoe.plugin :deveiate
 
 Hoe.plugins.delete :rubyforge
 
-hoespec = Hoe.spec 'strelka' do
+hoespec = Hoe.spec( 'strelka' ) do
 	self.readme_file = 'README.rdoc'
 	self.history_file = 'History.rdoc'
 	self.extra_rdoc_files = FileList[ '*.rdoc' ]
@@ -30,7 +30,7 @@ hoespec = Hoe.spec 'strelka' do
 	self.dependency 'highline',        '~> 1.6'
 	self.dependency 'inversion',       '~> 1.0'
 	self.dependency 'loggability',     '~> 0.9'
-	self.dependency 'mongrel2',        '~> 0.44'
+	self.dependency 'mongrel2',        '~> 0.53'
 	self.dependency 'pluggability',    '~> 0.4'
 	self.dependency 'sysexits',        '~> 1.1'
 	self.dependency 'uuidtools',       '~> 2.1'

data/contrib/hoetemplate/lib/file_name.rb.erb

@@ -1,5 +1,6 @@
 # -*- ruby -*-
-#encoding: utf-8
+# vim: set nosta noet ts=4 sw=4:
+# frozen-string-literal: true
 
 # <%= XIF %> (top-level documentation)
 module <%= klass %>
@@ -8,7 +9,7 @@ module <%= klass %>
 	VERS<%# this is just here so Hoe doesn't see this constant %>ION = '0.0.1'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: ffc16e8412df $
+	REVISION = %q$Revision$
 
 end # module <%= klass %>
 

data/contrib/hoetemplate/spec/file_name_spec.rb.erb

@@ -11,7 +11,7 @@ BEGIN {
 require 'rspec'
 require '<%= file_name %>'
 
-describe <%= klass %> do
+RSpec.describe <%= klass %> do
 
 	it "is well-tested" do
 		fail "it isn't"

data/examples/apps/auth-demo

@@ -1,7 +1,6 @@
 # -*- ruby -*-
 # vim: set nosta noet ts=4 sw=4:
-#encoding: utf-8
-
+# frozen-string-literal: true
 require 'strelka'
 
 class AuthDemo < Strelka::App

data/examples/apps/auth-demo2

@@ -1,7 +1,6 @@
 # -*- ruby -*-
 # vim: set nosta noet ts=4 sw=4:
-#encoding: utf-8
-
+# frozen-string-literal: true
 require 'strelka'
 
 # Another demo of the :auth plugin, this time implemented as form-based session

data/examples/apps/sessions-demo

@@ -1,7 +1,6 @@
 # -*- ruby -*-
 # vim: set nosta noet ts=4 sw=4:
-#encoding: utf-8
-
+# frozen-string-literal: true
 require 'strelka'
 
 class SessionsDemo < Strelka::App

data/examples/gen-config.rb

@@ -1,7 +1,6 @@
 # -*- ruby -*-
 # vim: set nosta noet ts=4 sw=4:
-#encoding: utf-8
-
+# frozen-string-literal: true
 # The Mongrel config used by the examples. Load it with:
 #
 #   m2sh.rb -c examples/mongrel2.sqlite load examples/gen-config.rb

data/lib/strelka.rb

@@ -1,6 +1,6 @@
 # -*- ruby -*-
 # vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
+# frozen-string-literal: true
 
 require 'mongrel2'
 require 'loggability'
@@ -21,19 +21,32 @@ require 'configurability/config'
 module Strelka
 	extend Loggability
 
-	# Loggability API -- Set up this module as a log host.
-	log_as :strelka
-
 	# Library version constant
-	VERSION = '0.15.0'
+	VERSION = '0.16.0'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: 670190273d27 $
+	REVISION = %q$Revision$
+
+	# The name of the environment variable that can be used to specify a configfile
+	# to load.
+	CONFIG_ENV = 'STRELKA_CONFIG'
+
+	# The name of the config file for local overrides.
+	LOCAL_CONFIG_FILE = Pathname( '~/.strelka.yml' ).expand_path
+
+	# The name of the config file that's loaded if none is specified.
+	DEFAULT_CONFIG_FILE = Pathname( 'config.yml' ).expand_path
+
+
+	# Loggability API -- set up a logger for this namespace.
+	log_as :strelka
+
 
 	require 'strelka/mixins'
 	require 'strelka/constants'
 	require 'strelka/exceptions'
 	include Strelka::Constants
+	extend Strelka::MethodUtilities
 
 	require 'strelka/app'
 	require 'strelka/httprequest'
@@ -50,19 +63,81 @@ module Strelka
 	end
 
 
-	# The installed Configurability::Config object
-	@config = nil
-	class << self; attr_accessor :config; end
+	### Get the library version. If +include_buildnum+ is true, the version string will
+	### include the VCS rev ID.
+	def self::version_string( include_buildnum=false )
+		vstring = "%s %s" % [ self.name, VERSION ]
+		vstring << " (build %s)" % [ REVISION[/: ([[:xdigit:]]+)/, 1] || '0' ] if include_buildnum
+		return vstring
+	end
+
+
+	##
+	# An Array of callbacks to be run after the config is loaded
+	singleton_attr_reader :after_configure_hooks
+	@after_configure_hooks = Set.new
+
+	##
+	# True if the after_configure hooks have already (started to) run.
+	singleton_predicate_reader :after_configure_hooks_run
+	@after_configure_hooks_run = false
+
+
+	#
+	# :section: Configuration API
+	#
+
+	### Get the loaded config (a Configurability::Config object)
+	def self::config
+		Configurability.loaded_config
+	end
+
+
+	### Returns +true+ if the configuration has been loaded at least once.
+	def self::config_loaded?
+		return self.config ? true : false
+	end
+
+
+	### Register a callback to be run after the config is loaded.
+	def self::after_configure( &block )
+		raise LocalJumpError, "no block given" unless block
+		self.after_configure_hooks << block
+
+		# Call the block immediately if the hooks have already been called or are in
+		# the process of being called.
+		block.call if self.after_configure_hooks_run?
+	end
+	singleton_method_alias :after_configuration, :after_configure
+
+
+	### Call the post-configuration callbacks.
+	def self::call_after_configure_hooks
+		self.log.debug "  calling %d post-config hooks" % [ self.after_configure_hooks.length ]
+		@after_configure_hooks_run = true
+
+		self.after_configure_hooks.to_a.each do |hook|
+			self.log.debug "    %s line %s..." % hook.source_location
+			hook.call
+		end
+	end
+
+
+	### Load the specified +config_file+, install the config in all objects with
+	### Configurability, and call any callbacks registered via #after_configure.
+	def self::load_config( config_file=nil, defaults=nil )
+		config_file ||= ENV[ CONFIG_ENV ]
+		config_file ||= LOCAL_CONFIG_FILE if LOCAL_CONFIG_FILE.exist?
+		config_file ||= DEFAULT_CONFIG_FILE
+
+		defaults    ||= Configurability.gather_defaults
 
+		self.log.warn "Loading config from %p with defaults for sections: %p." %
+			[ config_file, defaults.keys ]
+		config = Configurability::Config.load( config_file, defaults )
+		config.install
 
-	### Convenience method -- Load the Configurability::Config from +configfile+
-	### and install it.
-	def self::load_config( configfile, defaults=nil )
-		defaults ||= Configurability.gather_defaults
-		self.log.info "Loading universal config from %p with defaults for sections: %p." %
-			[ configfile, defaults.keys ]
-		self.config = Configurability::Config.load( configfile, defaults )
-		self.config.install
+		self.call_after_configure_hooks
 	end
 
 

data/lib/strelka/app.rb

@@ -1,6 +1,6 @@
 # -*- ruby -*-
 # vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
+# frozen-string-literal: true
 
 require 'rubygems' # For the Rubygems API
 
@@ -175,13 +175,14 @@ class Strelka::App < Mongrel2::Handler
 		response.headers.connection = 'close'
 		self.conn.reply( response )
 
-		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_OF_MESSAGE
+		If you wish to handle requests like this, either set your server's
+		'limits.content_length' setting to a higher value than %{content_length}, or override
+		#handle_async_upload_start.
+		END_OF_MESSAGE
 
 		self.log.warn "Async upload from %s dropped." % [ request.remote_ip ]
-		self.log.info( explanation )
+		self.log.info( explanation % {content_length: request.content_length} )
 
 		self.conn.reply_close( request )
 

data/lib/strelka/app/auth.rb

@@ -1,6 +1,6 @@
 # -*- ruby -*-
 # vim: set nosta noet ts=4 sw=4:
-#encoding: utf-8
+# frozen-string-literal: true
 
 require 'loggability'
 
@@ -370,7 +370,7 @@ module Strelka::App::Auth
 			block ||= Proc.new { true }
 
 			criteria.each do |pattern|
-				pattern.gsub!( %r{^/+|/+$}, '' ) if pattern.respond_to?( :gsub! )
+				pattern = pattern.gsub( %r{^/+|/+$}, '' ) if pattern.respond_to?( :gsub )
 				self.log.debug "  adding require_auth for %p" % [ pattern ]
 				self.positive_auth_criteria[ pattern ] = block
 			end
@@ -398,7 +398,7 @@ module Strelka::App::Auth
 			block ||= Proc.new { true }
 
 			criteria.each do |pattern|
-				pattern.gsub!( %r{^/+|/+$}, '' ) if pattern.respond_to?( :gsub! )
+				pattern = pattern.gsub( %r{^/+|/+$}, '' ) if pattern.respond_to?( :gsub )
 				self.log.debug "  adding no_auth for %p" % [ pattern ]
 				self.negative_auth_criteria[ pattern ] = block
 			end
@@ -419,7 +419,7 @@ module Strelka::App::Auth
 				true
 			}
 
-			pattern.gsub!( %r{^/+|/+$}, '' ) if pattern.respond_to?( :gsub! )
+			pattern = pattern.gsub( %r{^/+|/+$}, '' ) if pattern.respond_to?( :gsub )
 			self.log.debug "  adding require_perms (%p) for %p" % [ perms, pattern ]
 			self.positive_perms_criteria << [ pattern, block, perms.freeze ]
 		end
@@ -435,7 +435,7 @@ module Strelka::App::Auth
 			block   ||= Proc.new { true }
 			pattern ||= /(?##{block.object_id})/
 
-			pattern.gsub!( %r{^/+|/+$}, '' ) if pattern.respond_to?( :gsub! )
+			pattern = pattern.gsub( %r{^/+|/+$}, '' ) if pattern.respond_to?( :gsub )
 			self.log.debug "  adding no_auth for %p" % [ pattern ]
 			self.negative_perms_criteria << [ pattern, block ]
 		end

data/lib/strelka/app/errors.rb

@@ -1,6 +1,6 @@
 # -*- ruby -*-
 # vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
+# frozen-string-literal: true
 
 require 'strelka' unless defined?( Strelka )
 require 'strelka/app' unless defined?( Strelka::App )

data/lib/strelka/app/filters.rb

@@ -1,6 +1,6 @@
 # -*- ruby -*-
 # vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
+# frozen-string-literal: true
 
 require 'strelka' unless defined?( Strelka )
 require 'strelka/app' unless defined?( Strelka::App )

data/lib/strelka/app/negotiation.rb

@@ -1,6 +1,6 @@
 # -*- ruby -*-
 # vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
+# frozen-string-literal: true
 
 require 'strelka' unless defined?( Strelka )
 require 'strelka/app' unless defined?( Strelka::App )

data/lib/strelka/app/parameters.rb

@@ -1,6 +1,6 @@
 # -*- ruby -*-
 # vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
+# frozen-string-literal: true
 
 require 'strelka' unless defined?( Strelka )
 require 'strelka/app' unless defined?( Strelka::App )

data/lib/strelka/app/restresources.rb

@@ -1,6 +1,6 @@
 # -*- ruby -*-
 # vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
+# frozen-string-literal: true
 
 require 'set'
 require 'sequel'
@@ -55,19 +55,6 @@ require 'strelka/app' unless defined?( Strelka::App )
 #     isn't clearly specified in the RFC (DELETE /resource)
 # [ ] Sequel plugin for adding links to serialized representations
 #
-# == Caveats / Known Problems
-#
-# * Dataset methods declared using the 'subset' declaration don't allow the
-#   introspection necessary for automatically building routes, so you have
-#   to declare them as normal methods in a dataset module:
-#
-#       dataset_module do
-#           def by_name( string )
-#               filter(:name => string)
-#           end
-#       end
-#
-#
 # == Supported/Planned Options
 #
 # The 'resource' directive accepts options that control which methods it
@@ -76,18 +63,20 @@ require 'strelka/app' unless defined?( Strelka::App )
 # [√] :readonly     => false
 # [ ] :include      => <array of verbs>
 # [ ] :exclude      => <array of verbs>
-# [ ] :subsets      => <boolean or array>
+# [ ] :filters      => <boolean or array>
 # [ ] :associations => <boolean or array>
+# [ ] :composite    =< <boolean or array>
 #
 module Strelka::App::RestResources
 	extend Strelka::Plugin
 
 	# Resource route option defaults
 	DEFAULTS = {
-		prefix:           '',
+		prefix:           nil,
 		name:             nil,
 		readonly:         false,
 		use_transactions: true,
+		composite:        true
 	}.freeze
 
 
@@ -148,6 +137,7 @@ module Strelka::App::RestResources
 		def resource( rsrcobj, options={} )
 			self.log.debug "Adding REST resource for %p" % [ rsrcobj ]
 			options = self.service_options.merge( options )
+			self.log.warn "Options = %p" % [ options ]
 
 			# Add a parameter for the primary key
 			pkey = rsrcobj.primary_key
@@ -160,6 +150,7 @@ module Strelka::App::RestResources
 			# Figure out what the resource name is, and make the route from it
 			name = options[:name] || rsrcobj.implicit_table_name
 			route = [ options[:prefix], name ].compact.join( '/' )
+			self.log.warn "Route is: %p" % [[ options[:prefix], name ]]
 
 			# Ensure validated parameters are untainted
 			self.untaint_all_constraints
@@ -184,7 +175,7 @@ module Strelka::App::RestResources
 			end
 
 			# Add any composite resources based on the +rsrcobj+'s associations
-			self.add_composite_resource_handlers( route, rsrcobj, options )
+			self.add_composite_resource_handlers( route, rsrcobj, options ) if options[:composite]
 		end
 
 
@@ -199,7 +190,7 @@ module Strelka::App::RestResources
 
 				# Gather up metadata describing the resource
 				verbs = self.class.resource_verbs[ route ].sort
-				columns = rsrcobj.allowed_columns || rsrcobj.columns
+				columns = rsrcobj.columns
 				attributes = columns.each_with_object({}) do |col, hash|
 					hash[ col ] = rsrcobj.db_schema[ col ][:type]
 				end
@@ -259,7 +250,7 @@ module Strelka::App::RestResources
 				[ rsrcobj, route ]
 
 			# Make a column regexp for validating the order field
-			colunion = Regexp.union( (rsrcobj.allowed_columns || rsrcobj.columns).map(&:to_s) )
+			colunion = Regexp.union( rsrcobj.columns.map(&:to_s) )
 			colre = /^(?<column>#{colunion})$/
 
 			self.add_route( :GET, route, options ) do |req|
@@ -522,6 +513,8 @@ module Strelka::App::RestResources
 
 		### Add routes for any associations +rsrcobj+ has as composite resources.
 		def add_composite_resource_handlers( route_prefix, rsrcobj, options )
+			self.log.debug "Adding composite resource handlers for %p to %s (%p)" %
+				[ rsrcobj, route_prefix, options ]
 
 			# Add methods declared by (user-declared) dataset modules.
 			ds_mods = rsrcobj.dataset_method_modules.select do |mod|
@@ -621,7 +614,7 @@ module Strelka::App::RestResources
 			self.log.debug "Adding composite read handler for association: %s" % [ association ]
 
 			pkey = rsrcobj.primary_key
-			colunion = Regexp.union( (rsrcobj.allowed_columns || rsrcobj.columns).map(&:to_s) )
+			colunion = Regexp.union( rsrcobj.columns.map(&:to_s) )
 			colre = /^(?<column>#{colunion})$/
 
 			self.add_route( :GET, path, options ) do |req|
@@ -686,7 +679,7 @@ module Strelka::App::RestResources
 	### Add parameter validations for the given +columns+ of the specified resource object +rsrcobj+
 	### to the specified parameter +validator+.
 	def add_resource_params( validator, rsrcobj, *columns )
-		columns = rsrcobj.allowed_columns || rsrcobj.columns if columns.empty?
+		columns = rsrcobj.columns if columns.empty?
 
 		columns.each do |col|
 			config = rsrcobj.db_schema[ col ] or