configurability 3.3.0 → 3.4.1

data/History.md

@@ -1,3 +1,29 @@
+## 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>
+
+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:

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:
 
@@ -401,7 +437,7 @@ and generate the API documentation.
 
 ## License
 
-Copyright (c) 2010-2017 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/Rakefile

@@ -22,10 +22,10 @@ hoespec = Hoe.spec 'configurability' do |spec|
 	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',
+		home:   'https://configur.ability.guide/',
+		code:   'https://hg.sr.ht/ged/Configurability',
+		docs:   'https://deveiate.org/code/configurability',
+		github: 'https://github.com/ged/configurability',
 	}
 
 	spec.developer 'Michael Granger', 'ged@FaerieMUD.org'
@@ -35,9 +35,9 @@ hoespec = Hoe.spec 'configurability' do |spec|
 
 	spec.dependency 'hoe-deveiate', '~> 0.8', :developer
 	spec.dependency 'simplecov', '~> 0.12', :developer
-	spec.dependency 'rspec', '~> 3.5', :developer
+	spec.dependency 'rspec', '~> 3.8', :developer
 
-	spec.require_ruby_version( '>= 2.2.0' )
+	spec.require_ruby_version( '>= 2.5.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}"

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.3.0'
+	VERSION = '3.4.1'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: 29114ac9dc2b $
+	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
 
 

data/lib/configurability/setting_installer.rb

@@ -50,6 +50,11 @@ class Configurability::SettingInstaller
 
 		self.target.define_singleton_method( "#{name}", &reader )
 		self.target.define_singleton_method( "#{name}=", &writer )
+
+		if options[:predicate]
+			predicate = self.make_setting_predicate( name, options )
+			self.target.define_singleton_method( "#{name}?", &predicate )
+		end
 	end
 
 
@@ -87,6 +92,22 @@ class Configurability::SettingInstaller
 	end
 
 
+	### Create the body of the setting predicate method with the specified +name+ and +options+.
+	def make_setting_predicate( name, options )
+		if options[:use_class_vars]
+			return lambda do
+				Loggability[ Configurability ].debug "Using class variables for %s of %p" %
+					[ name, self ]
+				self.class_variable_get("@@#{name}") ? true : false
+			end
+		else
+			return lambda {
+				self.instance_variable_get("@#{name}") ? true : false
+			}
+		end
+	end
+
+
 	### Add a default for +name+ to the CONFIG_DEFAULTS constant of the target, creating
 	### it if necessary.
 	def add_default( name, options )

data/spec/configurability_spec.rb

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+require 'ipaddr'
+require 'socket'
 require 'ostruct'
 require 'helpers'
 
@@ -17,11 +19,13 @@ describe Configurability do
 
 	before( :each ) do
 		Configurability.configurable_objects.clear
+		Configurability.after_configure_hooks.clear
 		Configurability.reset
 	end
 
 	after( :all ) do
 		Configurability.configurable_objects.clear
+		Configurability.after_configure_hooks.clear
 		Configurability.reset
 	end
 
@@ -705,6 +709,82 @@ describe Configurability do
 				from( nil )
 		end
 
+
+		it "allows declaration of singleton helper methods" do
+			mod.configurability( :testconfig ) do
+				def self::parse_ip_blocks( *values )
+					values.flatten.map do |value|
+						IPAddr.new( value, Socket::AF_INET )
+					end
+				end
+				setting :whitelisted_ip_blocks do |*values|
+					parse_ip_blocks( values )
+				end
+				setting :blacklisted_ip_blocks do |*values|
+					parse_ip_blocks( values )
+				end
+			end
+
+			expect {
+				mod.whitelisted_ip_blocks = ['127.0.0.1/8', '203.0.113.0/24']
+			}.to change { mod.whitelisted_ip_blocks }.to([
+				IPAddr.new( '127.0.0.0/8' ), IPAddr.new( '203.0.113.0/24' )
+			])
+		end
+
+
+		it "can declare a predicate method for a setting" do
+			mod.configurability( :testconfig ) do
+				setting :use_whitelist, default: false, predicate: true
+			end
+
+			expect {
+				mod.use_whitelist = true
+			}.to change { mod.use_whitelist? }.from( false ).to( true )
+		end
+
+	end
+
+
+	describe "hooks" do
+
+		it "will call any registered callbacks after the config is installed" do
+			hook_was_called = false
+			Configurability.after_configure do
+				hook_was_called = true
+			end
+			Configurability.call_after_configure_hooks
+
+			expect( hook_was_called ).to be( true )
+		end
+
+
+		it "will immediately call after_config callbacks registered after the config is installed" do
+			hook_was_called = false
+			Configurability.call_after_configure_hooks
+
+			Configurability.after_configure do
+				hook_was_called = true
+			end
+
+			expect( hook_was_called ).to be( true )
+		end
+
+
+		it "can add new after_configure hooks even while the current ones are being run" do
+			hook_was_called = false
+			Configurability.after_configure do
+				Configurability.after_configure do
+					hook_was_called = true
+				end
+			end
+
+			Configurability.call_after_configure_hooks
+
+			expect( hook_was_called ).to be( true )
+		end
+
+
 	end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: configurability
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.1
 platform: ruby
 authors:
 - Michael Granger
@@ -11,32 +11,31 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIEbDCCAtSgAwIBAgIBATANBgkqhkiG9w0BAQUFADA+MQwwCgYDVQQDDANnZWQx
-  GTAXBgoJkiaJk/IsZAEZFglGYWVyaWVNVUQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
-  HhcNMTcwOTI3MDAzMDQ0WhcNMTgwOTI3MDAzMDQ0WjA+MQwwCgYDVQQDDANnZWQx
-  GTAXBgoJkiaJk/IsZAEZFglGYWVyaWVNVUQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
-  ggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQC/JWGRHO+USzR97vXjkFgt
-  83qeNf2KHkcvrRTSnR64i6um/ziin0I0oX23H7VYrDJC9A/uoUa5nGRJS5Zw/+wW
-  ENcvWVZS4iUzi4dsYJGY6yEOsXh2CcF46+QevV8iE+UmbkU75V7Dy1JCaUOyizEt
-  TH5UHsOtUU7k9TYARt/TgYZKuaoAMZZd5qyVqhF1vV+7/Qzmp89NGflXf2xYP26a
-  4MAX2qqKX/FKXqmFO+AGsbwYTEds1mksBF3fGsFgsQWxftG8GfZQ9+Cyu2+l1eOw
-  cZ+lPcg834G9DrqW2zhqUoLr1MTly4pqxYGb7XoDhoR7dd1kFE2a067+DzWC/ADt
-  +QkcqWUm5oh1fN0eqr7NsZlVJDulFgdiiYPQiIN7UNsii4Wc9aZqBoGcYfBeQNPZ
-  soo/6za/bWajOKUmDhpqvaiRv9EDpVLzuj53uDoukMMwxCMfgb04+ckQ0t2G7wqc
-  /D+K9JW9DDs3Yjgv9k4h7YMhW5gftosd+NkNC/+Y2CkCAwEAAaN1MHMwCQYDVR0T
-  BAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFHKN/nkRusdqCJEuq3lgB3fJvyTg
-  MBwGA1UdEQQVMBOBEWdlZEBGYWVyaWVNVUQub3JnMBwGA1UdEgQVMBOBEWdlZEBG
-  YWVyaWVNVUQub3JnMA0GCSqGSIb3DQEBBQUAA4IBgQB/qyi5pCjK8ceoKalfVAjS
-  vG64FEnLnD1bm39T5UaFIRmo+abZtfpg2QhwKvPbPjOicau2+m+MDQ2Cc3tgyaC3
-  dZxcP6w8APFg4AId09uWAZKf0xajvBMS2aOz8Bbmag6fwqRRkTMqsNYnmqcF7aRT
-  DuEzbEMfaOUYjU9RuB48vr4q8yRft0ww+3jq5iwNkrX1buL2pwBbyvgms6D/BV41
-  MaTVMjsHqJUwU2xVfhGtxGAWAer5S1HGYHkbio6mGVtiie0uWjmnzi7ppIlMr48a
-  7BNTsoZ+/JRk3iQWmmNsyFT7xfqBKye7cH11BX8V8P4MeGB5YWlMI+Myj5DZY3fQ
-  st2AGD4rb1l0ia7PfubcBThSIdz61eCb8gRi/RiZZwb3/7+eyEncLJzt2Ob9fGSF
-  X0qdrKi+2aZZ0NGuFj9AItBsVmAvkBGIpX4TEKQp5haEbPpmaqO5nIIhV26PXmyT
-  OMKv6pWsoS81vw5KAGBmfX8nht/Py90DQrbRvakATGI=
+  MIIENDCCApygAwIBAgIBATANBgkqhkiG9w0BAQsFADAiMSAwHgYDVQQDDBdnZWQv
+  REM9RmFlcmllTVVEL0RDPW9yZzAeFw0xODExMjAxODI5NTlaFw0xOTExMjAxODI5
+  NTlaMCIxIDAeBgNVBAMMF2dlZC9EQz1GYWVyaWVNVUQvREM9b3JnMIIBojANBgkq
+  hkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAvyVhkRzvlEs0fe7145BYLfN6njX9ih5H
+  L60U0p0euIurpv84op9CNKF9tx+1WKwyQvQP7qFGuZxkSUuWcP/sFhDXL1lWUuIl
+  M4uHbGCRmOshDrF4dgnBeOvkHr1fIhPlJm5FO+Vew8tSQmlDsosxLUx+VB7DrVFO
+  5PU2AEbf04GGSrmqADGWXeaslaoRdb1fu/0M5qfPTRn5V39sWD9umuDAF9qqil/x
+  Sl6phTvgBrG8GExHbNZpLARd3xrBYLEFsX7RvBn2UPfgsrtvpdXjsHGfpT3IPN+B
+  vQ66lts4alKC69TE5cuKasWBm+16A4aEe3XdZBRNmtOu/g81gvwA7fkJHKllJuaI
+  dXzdHqq+zbGZVSQ7pRYHYomD0IiDe1DbIouFnPWmagaBnGHwXkDT2bKKP+s2v21m
+  ozilJg4aar2okb/RA6VS87o+d7g6LpDDMMQjH4G9OPnJENLdhu8KnPw/ivSVvQw7
+  N2I4L/ZOIe2DIVuYH7aLHfjZDQv/mNgpAgMBAAGjdTBzMAkGA1UdEwQCMAAwCwYD
+  VR0PBAQDAgSwMB0GA1UdDgQWBBRyjf55EbrHagiRLqt5YAd3yb8k4DAcBgNVHREE
+  FTATgRFnZWRARmFlcmllTVVELm9yZzAcBgNVHRIEFTATgRFnZWRARmFlcmllTVVE
+  Lm9yZzANBgkqhkiG9w0BAQsFAAOCAYEAP9Ffkvg4e8CjIWi8SykQ8oJSS8jbmbgF
+  abke3vXWLG6V9kFiObuJd5wZRBluJANu7bEtjgc3fFaGVP2XxVdCpVjNbmMDg4Qp
+  ovvczP53X6pQP2RSZgxF6Lblvy8y11RziUTVRG/Z2aJHsElo6gI7vQznE/OSDrhC
+  gEhr8uaIUt7D+HZWRbU0+MkKPpL5uMqaFuJbqXEvSwPTuUuYkDfNfsjQO7ruWBac
+  bxHCrvpZ6Tijc0nrlyXi6gPOCLeaqhau2xFnlvKgELwsGYSoKBJyDwqtQ5kwrOlU
+  tkSyLrfZ+RZcH535Hyvif7ZxB0v5OxXXoec+N2vrUsEUMRDL9dg4/WFdN8hIOixF
+  3IPKpZ1ho0Ya5q7yhygtBK9/NBFHw+nbJjcltfPDBXleRe8u73gnQo8AZIhStYSP
+  v4qqqa27Bs468d6SoPxjSm8a2mM9HZ4OdWhq4tFsbTeXDVquCfi64OTEaTt2xQdR
+  JnC4lpJfCP6aCXa5h2XAQfPSH636cQap
   -----END CERTIFICATE-----
-date: 2018-09-12 00:00:00.000000000 Z
+date: 2019-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability
@@ -72,14 +71,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: hoe-highline
   requirement: !ruby/object:Gem::Requirement
@@ -114,42 +113,48 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.16'
+        version: '3.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.16'
+        version: '3.18'
 description: |-
   Configurability is a unified, non-intrusive, assume-nothing configuration system
   for Ruby. It lets you keep the configuration for multiple objects in a single
@@ -159,8 +164,7 @@ description: |-
 email:
 - ged@FaerieMUD.org
 - mahlon@martini.nu
-executables:
-- configurability
+executables: []
 extensions: []
 extra_rdoc_files:
 - History.md
@@ -173,7 +177,6 @@ files:
 - Manifest.txt
 - README.md
 - Rakefile
-- bin/configurability
 - examples/basicconfig.rb
 - examples/config.yml
 - examples/readme.rb
@@ -186,7 +189,7 @@ files:
 - spec/configurability/deferred_config_spec.rb
 - spec/configurability_spec.rb
 - spec/helpers.rb
-homepage: http://deveiate.org/projects/configurability
+homepage: https://configur.ability.guide/
 licenses:
 - BSD-3-Clause
 metadata: {}
@@ -200,15 +203,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Configurability is a unified, non-intrusive, assume-nothing configuration