configurability 3.2.0 → 4.2.0

data/History.md

@@ -1,3 +1,68 @@
+# Release History for configurability
+
+---
+
+## v4.2.0 [2020-12-28] Michael Granger <ged@faeriemud.org>
+
+Improvements:
+
+- Updates for Ruby 3
+
+
+## v4.1.0 [2020-02-19] Michael Granger <ged@faeriemud.org>
+
+Improvements:
+
+- Add support for two-argument #respond_to? to Configurability::Config
+
+
+## v4.0.0 [2020-01-08] Michael Granger <ged@faeriemud.org>
+
+Breaking changes:
+
+- Remove tainting, which is deprecated in 2.7 and beyond.
+
+Enhancements:
+
+- Enable SafeYAML if it's loaded
+
+
+## v3.4.1 [2019-09-03] Michael Granger <ged@FaerieMUD.org>
+
+Bugfixes:
+
+- Bump minimal Ruby version to 2.5.
+
+Documentation:
+
+- Change URLs to Sourcehut/ability.guide
+- Fix license years, README title
+
+
+## v3.4.0 [2019-09-01] Michael Granger <ged@FaerieMUD.org>
+
+(Yanked due to inaccurate minimum Ruby version)
+
+Bugfixes:
+
+- Remove old command that depended on Trollop
+
+Enhancements:
+
+- Add a predicate setting option
+- Add a test for declaring helper methods inside a settings block
+- Add after-configure hooks to execute a block after the configuration
+  has been loaded
+
+
+## v3.3.0 [2018-09-12] Michael Granger <ged@FaerieMUD.org>
+
+Enhancements:
+
+- Declare the class/class-instance variable when declaring a setting
+- Add a 'defaults' subcommand to the configurability executable
+
+
 ## v3.2.0 [2017-04-17] Michael Granger <ged@FaerieMUD.org>
 
 Enhancements:

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2016 Michael Granger and Mahlon E. Smith
+Copyright (c) 2010-2019 Michael Granger and Mahlon E. Smith
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/Manifest.txt

@@ -4,7 +4,6 @@ LICENSE
 Manifest.txt
 README.md
 Rakefile
-bin/configurability
 examples/basicconfig.rb
 examples/config.yml
 examples/readme.rb

data/README.md

@@ -1,10 +1,10 @@
 # Configurability
 
 home
-: https://bitbucket.org/ged/configurability
+: https://configur.ability.guide/
 
 code
-: https://bitbucket.org/ged/configurability
+: https://hg.sr.ht/~ged/Configurability
 
 docs
 : http://deveiate.org/code/configurability
@@ -117,6 +117,42 @@ After this happens you can access the configuration values like this:
     Database.password
     # => "pXVvVY,YjWNRRi[yPWx4"
 
+You can add helper methods inside the `configurability` block to eliminate
+repeated code in your setting blocks:
+
+    configurability( :server ) do
+      def self::make_path( value )
+        return nil unless value
+        pn = Pathname( value )
+        raise "Can't read from %s!" % [ pn ] unless pn.readable?
+        return pn
+      end
+
+    	setting :template_path do |value|
+    		make_path( value )
+    	end
+
+    	setting :plugin_path do |*values|
+    		make_path( value )
+    	end
+    end
+
+If a setting is a boolean, you can also have a predicate method created for it
+alongside its getter and setter:
+
+    class Mailer
+      extend Configurability
+      configurability( :db ) do
+        setting :use_whitelist, default: false, predicate: true
+      end
+    end
+
+    Mailer.use_whitelist?
+    # => false
+    Mailer.use_whitelist = true
+    Mailer.use_whitelist?
+    # => true
+
 
 ### More Details
 
@@ -387,9 +423,9 @@ default_config
 
 You can submit bug reports, suggestions, clone it with Mercurial, and
 read more about future plans at
-{the project page}[http://bitbucket.org/ged/configurability]. If you
+[the project page](http://hg.sr.ht/ged/configurability). If you
 prefer Git, there is also a
-{Github mirror}[https://github.com/ged/configurability].
+[Github mirror](https://github.com/ged/configurability).
 
 After checking out the source, run:
 
@@ -399,9 +435,15 @@ This task will install any missing dependencies, run the tests/specs,
 and generate the API documentation.
 
 
+## Authors
+
+- Michael Granger <ged@faeriemud.org>
+- Mahlon E. Smith <mahlon@martini.nu>
+
+
 ## License
 
-Copyright (c) 2010-2017 Michael Granger and Mahlon E. Smith
+Copyright (c) 2010-2020 Michael Granger and Mahlon E. Smith
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/Rakefile

@@ -1,89 +1,9 @@
-#!/usr/bin/env rake
+#!/usr/bin/env ruby -S rake
 
-begin
-	require 'hoe'
-rescue LoadError
-	abort "This Rakefile requires 'hoe' (gem install hoe)"
-end
-
-GEMSPEC = 'configurability.gemspec'
-
-Hoe.plugin :mercurial
-Hoe.plugin :signing
-Hoe.plugin :deveiate
-
-Hoe.plugins.delete :rubyforge
-
-Encoding.default_internal = Encoding::UTF_8
-
-hoespec = Hoe.spec 'configurability' do |spec|
-	spec.readme_file = 'README.md'
-	spec.history_file = 'History.md'
-	spec.extra_rdoc_files = FileList[ '*.rdoc', '*.md' ]
-	spec.license 'BSD-3-Clause'
-	spec.urls = {
-		home:   'http://deveiate.org/projects/configurability',
-		code:   'http://bitbucket.org/ged/configurability',
-		docs:   'http://deveiate.org/code/configurability',
-		github: 'http://github.com/ged/configurability',
-	}
+require 'rake/deveiate'
 
-	spec.developer 'Michael Granger', 'ged@FaerieMUD.org'
-	spec.developer 'Mahlon E. Smith', 'mahlon@martini.nu'
-
-	spec.dependency 'loggability', '~> 0.12'
-
-	spec.dependency 'hoe-deveiate', '~> 0.8', :developer
-	spec.dependency 'simplecov', '~> 0.12', :developer
-	spec.dependency 'rspec', '~> 3.5', :developer
-
-	spec.require_ruby_version( '>= 2.2.0' )
-
-	spec.hg_sign_tags = true if spec.respond_to?( :hg_sign_tags= )
-	spec.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"
+Rake::DevEiate.setup( 'configurability' ) do |project|
+	project.required_ruby_version = '>= 2.5'
+	project.publish_to = 'deveiate:/usr/local/www/public/code'
 end
 
-ENV['VERSION'] ||= hoespec.spec.version.to_s
-
-# Ensure the specs pass before checking in
-task 'hg:precheckin' => [ :check_history, :check_manifest, :gemspec, :spec ]
-
-
-desc "Build a coverage report"
-task :coverage do
-	ENV["COVERAGE"] = 'yes'
-	Rake::Task[:spec].invoke
-end
-
-
-# Use the fivefish formatter for docs generated from development checkout
-if File.directory?( '.hg' )
-	require 'rdoc/task'
-
-	Rake::Task[ 'docs' ].clear
-	RDoc::Task.new( 'docs' ) do |rdoc|
-	    rdoc.main = "README.md"
-	    rdoc.rdoc_files.include( "*.rdoc", "*.md", "ChangeLog", "lib/**/*.rb" )
-	    rdoc.generator = :fivefish
-		rdoc.title = 'Configurability'
-	    rdoc.rdoc_dir = 'doc'
-	end
-end
-
-
-task :gemspec => [ 'ChangeLog', GEMSPEC ]
-file GEMSPEC => __FILE__ do |task|
-	spec = $hoespec.spec
-	spec.files.delete( '.gemtest' )
-	spec.files.delete( 'LICENSE' )
-	spec.signing_key = nil
-	spec.version = "#{spec.version.bump}.0.pre#{Time.now.strftime("%Y%m%d%H%M%S")}"
-	spec.cert_chain = [ 'certs/ged.pem' ]
-	File.open( task.name, 'w' ) do |fh|
-		fh.write( spec.to_ruby )
-	end
-end
-CLOBBER.include( GEMSPEC )
-
-task :default => :gemspec
-

data/lib/configurability.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
+require 'set'
 require 'loggability'
 require 'yaml'
 
@@ -13,10 +14,10 @@ module Configurability
 
 
 	# Library version constant
-	VERSION = '3.2.0'
+	VERSION = '4.2.0'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: c1a8ffc3266f $
+	REVISION = %q$Revision$
 
 	require 'configurability/deferred_config'
 
@@ -25,20 +26,58 @@ module Configurability
 
 
 	### The objects that have had Configurability added to them
+	##
+	# the Array of objects that have had Configurability added to them
+	singleton_class.attr_accessor :configurable_objects
 	@configurable_objects = []
 
-	### The loaded config (if there is one)
+	##
+	# the loaded configuration (after ::configure_objects has been called at least once)
+	singleton_class.attr_accessor :loaded_config
 	@loaded_config = nil
 
+	##
+	# An Array of callbacks to be run after the config is loaded
+	@after_configure_hooks = Set.new
+	singleton_class.attr_reader :after_configure_hooks
 
-	class << self
 
-		# the Array of objects that have had Configurability added to them
-		attr_accessor :configurable_objects
+	@after_configure_hooks_run = false
 
-		# the loaded configuration (after ::configure_objects has been called at least once)
-		attr_accessor :loaded_config
+	### Returns +true+ if the after-configuration hooks have run at least once.
+	def self::after_configure_hooks_run?
+		return @after_configure_hooks_run ? true : false
+	end
+
+
+	### Set the flag that indicates that the after-configure hooks have run at least
+	### once.
+	def self::after_configure_hooks_run=( new_value )
+		@after_configure_hooks_run = new_value ? 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_class.alias_method :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
 
 
@@ -103,12 +142,15 @@ module Configurability
 		self.configurable_objects.each do |obj|
 			self.install_config( config, obj )
 		end
+
+		self.call_after_configure_hooks
 	end
 
 
 	### If a configuration has been loaded (via {#configure_objects}), clear it.
 	def self::reset
 		self.loaded_config = nil
+		self.after_configure_hooks_run = false
 	end
 
 
@@ -259,8 +301,7 @@ module Configurability
 			@config.each_pair do |key, value|
 				Configurability.log.debug "Looking for %p config attribute" % [ key ]
 				next unless self.respond_to?( "#{key}=" )
-				Configurability.log.debug "  setting %p to %p via attr_writer" %
-					[ key, value ]
+				Configurability.log.debug "  setting %p to %p" % [ key, value ]
 				self.public_send( "#{key}=", value )
 			end
 		else

data/lib/configurability/config.rb

@@ -43,6 +43,10 @@ class Configurability::Config
 	log_to :configurability
 
 
+	# Make safe loading the default if SafeYAML is loaded
+	SafeYAML::OPTIONS[:default_mode] = :safe if defined?( SafeYAML )
+
+
 	#############################################################
 	###	C L A S S   M E T H O D S
 	#############################################################
@@ -84,7 +88,7 @@ class Configurability::Config
 
 		# Make a deep copy of the defaults before loading so we don't modify
 		# the argument
-		@defaults     = Marshal.load( Marshal.dump(defaults) ) if defaults
+		@defaults     = defaults ? Marshal.load( Marshal.dump(defaults) ) : nil
 		@time_created = Time.now
 		@path         = path
 
@@ -162,7 +166,7 @@ class Configurability::Config
 
 
 	### Returns +true+ for methods which can be autoloaded
-	def respond_to?( sym )
+	def respond_to?( sym, include_all=false )
 		return true if @struct.member?( sym.to_s.sub(/(=|\?)$/, '').to_sym )
 		super
 	end
@@ -256,7 +260,7 @@ class Configurability::Config
 			   end
 		end
 
-		ihash = symbolify_keys( untaint_hash(hash) )
+		ihash = symbolify_keys( hash )
 		idefaults = symbolify_keys( defaults )
 		mergedhash = idefaults.merge( ihash, &mergefunc )
 
@@ -285,41 +289,9 @@ class Configurability::Config
 
 
 	# A collection of data-structure-manipulation functions.
+	# :TODO: Replace with #transform_keys after 2.4's EOL
 	module DataUtilities
 
-		### Return a copy of the specified +hash+ with all of its values
-		### untainted.
-		def untaint_hash( hash )
-			newhash = {}
-			hash.each_key do |key|
-				newhash[ key ] = untaint_value( hash[key] )
-			end
-			return newhash
-		end
-
-
-		### Return an untainted copy of the specified +val+.
-		def untaint_value( val )
-			case val
-			when Hash
-				return untaint_hash( val )
-
-			when Array
-				return val.collect {|v| untaint_value(v) }
-
-			when NilClass, TrueClass, FalseClass, Numeric, Symbol, Encoding
-				return val
-
-			else
-				if val.respond_to?( :dup ) && val.respond_to?( :untaint )
-					return val.dup.untaint
-				else
-					return val
-				end
-			end
-		end
-
-
 		### Return a duplicate of the given +hash+ with its identifier-like keys
 		### transformed into symbols from whatever they were before.
 		def symbolify_keys( hash )
@@ -400,7 +372,7 @@ class Configurability::Config
 		# Return the value associated with the specified +key+, or another
 		# Configurability::Config::ConfigStruct if +key+ is a section name.
 		def []( key )
-			key = key.untaint.to_sym if key.respond_to?( :to_sym )
+			key = key.to_sym if key.respond_to?( :to_sym )
 
 			# Convert Hashes to Struct on the fly for subsections
 			@hash[ key ] = self.class.new( @hash[key] ) if @hash[ key ].is_a?( Hash )
@@ -411,7 +383,7 @@ class Configurability::Config
 
 		### Set the value associated with the specified +key+ to +value+.
 		def []=( key, value )
-			key = key.untaint.to_sym
+			key = key.to_sym
 			self.mark_dirty if @hash[ key ] != value
 			@hash[ key ] = value
 		end