configurability 3.2.0 → 4.2.0

data/lib/configurability/setting_installer.rb

@@ -39,11 +39,22 @@ class Configurability::SettingInstaller
 
 	### Add accessors with the specified +name+ to the target.
 	def add_setting_accessors( name, options, &writer_hook )
+		if options[:use_class_vars]
+			self.target.class_variable_set( "@@#{name}", nil )
+		else
+			self.target.instance_variable_set( "@#{name}", nil )
+		end
+
 		reader = self.make_setting_reader( name, options )
 		writer = self.make_setting_writer( name, options, &writer_hook )
 
 		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
 
 
@@ -56,7 +67,9 @@ class Configurability::SettingInstaller
 				self.class_variable_get("@@#{name}")
 			end
 		else
-			return lambda { self.instance_variable_get("@#{name}") }
+			return lambda {
+				self.instance_variable_get("@#{name}")
+			}
 		end
 	end
 
@@ -79,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/config_spec.rb

@@ -119,13 +119,6 @@ describe Configurability::Config do
 	end
 
 
-	it "untaints values loaded from a config" do
-		yaml = TEST_CONFIG.dup.taint
-		config = described_class.new( yaml )
-		expect( config.listsection.first ).to_not be_tainted
-		expect( config.textsection ).to_not be_tainted
-	end
-
 
 	context "a config with nil keys" do
 
@@ -167,6 +160,11 @@ describe Configurability::Config do
 		end
 
 
+		it "supports two-argument respond_to?" do
+			expect( config.respond_to?(:section, true) ).to be_truthy
+		end
+
+
 		it "contains values specified in the source" do
 			# section:
 			#   subsection:
@@ -255,7 +253,7 @@ describe Configurability::Config do
 	# loading from a file
 	context " loaded from a file" do
 		before( :all ) do
-			filename = Dir::Tmpname.make_tmpname( './test', '.conf' )
+			filename = Dir::Tmpname.create( ['./test', '.conf'] ) {}
 			@tmpfile = Pathname( filename )
 			@tmpfile.open( 'w', 0644 ) {|io| io.print(TEST_CONFIG) }
 		end
@@ -284,7 +282,7 @@ describe Configurability::Config do
 
 		it "can be written to a different file" do
 			begin
-			path = Dir::Tmpname.make_tmpname( './another-', '.config' )
+			path = Dir::Tmpname.create( ['./another-', '.config'] ) {}
 
 				config.write( path )
 				expect( File.read(path) ).to match( /section: ?\n  subsection/ )
@@ -333,7 +331,7 @@ describe Configurability::Config do
 	context " whose file changes after loading" do
 
 		before( :all ) do
-			filename = Dir::Tmpname.make_tmpname( './test', '.conf' )
+			filename = Dir::Tmpname.create( ['./test', '.conf'] ) {}
 			@tmpfile = Pathname( filename )
 			@tmpfile.open( 'w', 0644 ) {|io| io.print(TEST_CONFIG) }
 		end

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
 
@@ -404,21 +408,22 @@ describe Configurability do
 			defaults = Configurability.gather_defaults
 
 			expect( defaults ).to eq({ testconfig: { sect1: {sect2: { one: 1, two: 2 }} } })
+			expect( klass.config_key ).to eq( :testconfig__sect1__sect2 )
 		end
 
 
 		it "can return a Configurability::Config object with defaults, too" do
-			klass1 = Class.new do
+			_klass1 = Class.new do
 				extend Configurability
 				config_key :testconfig
 				self::CONFIG_DEFAULTS = { :one => 1, :types => {:one => true} }
 			end
-			klass2 = Class.new do
+			_klass2 = Class.new do
 				extend Configurability
 				config_key :testconfig
 				self::DEFAULT_CONFIG = { :two => 2, :types => {:two => true} }
 			end
-			klass3 = Class.new do
+			_klass3 = Class.new do
 				extend Configurability
 				config_key :otherconfig
 				def self::defaults; { :other => true }; end
@@ -442,7 +447,7 @@ describe Configurability do
 				self::CONFIG_DEFAULTS = { :one => 1, :types => {:one => true} }
 				Configurability.log.debug "Defaults: %p" % [ self.defaults ]
 			end
-			subclass = Class.new( klass ) do
+			_subclass = Class.new( klass ) do
 				config_key :spanishconfig
 				self::CONFIG_DEFAULTS = { :uno => 1 }
 			end
@@ -670,7 +675,6 @@ describe Configurability do
 			end
 
 			child_class = Class.new( parent_class )
-			child_class..extend( Configurability )
 			child_class.configurability( :testconfig ) do
 				setting :environment, default: :staging
 				setting :apikey, default: 'foom'
@@ -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

data/spec/helpers.rb

@@ -35,6 +35,8 @@ RSpec.configure do |config|
 	config.mock_with( :rspec ) do |mock|
 		mock.syntax = :expect
 	end
+	config.warnings = true
+	config.profile_examples = 5
 
 	config.include( Loggability::SpecHelpers )
 end

metadata

@@ -1,42 +1,40 @@
 --- !ruby/object:Gem::Specification
 name: configurability
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Michael Granger
 - Mahlon E. Smith
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIEbDCCAtSgAwIBAgIBATANBgkqhkiG9w0BAQsFADA+MQwwCgYDVQQDDANnZWQx
-  GTAXBgoJkiaJk/IsZAEZFglGYWVyaWVNVUQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
-  HhcNMTYwODIwMTgxNzQyWhcNMTcwODIwMTgxNzQyWjA+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
-  YWVyaWVNVUQub3JnMA0GCSqGSIb3DQEBCwUAA4IBgQAPJzKiT0zBU7kpqe0aS2qb
-  FI0PJ4y5I8buU4IZGUD5NEt/N7pZNfOyBxkrZkXhS44Fp+xwBH5ebLbq/WY78Bqd
-  db0z6ZgW4LMYMpWFfbXsRbd9TU2f52L8oMAhxOvF7Of5qJMVWuFQ8FPagk2iHrdH
-  inYLQagqAF6goWTXgAJCdPd6SNeeSNqA6vlY7CV1Jh5kfNJJ6xu/CVij1GzCLu/5
-  DMOr26DBv+qLJRRC/2h34uX71q5QgeOyxvMg+7V3u/Q06DXyQ2VgeeqiwDFFpEH0
-  PFkdPO6ZqbTRcLfNH7mFgCBJjsfSjJrn0sPBlYyOXgCoByfZnZyrIMH/UY+lgQqS
-  6Von1VDsfQm0eJh5zYZD64ZF86phSR7mUX3mXItwH04HrZwkWpvgd871DZVR3i1n
-  w8aNA5re5+Rt/Vvjxj5AcEnZnZiz5x959NaddQocX32Z1unHw44pzRNUur1GInfW
-  p4vpx2kUSFSAGjtCbDGTNV2AH8w9OU4xEmNz8c5lyoA=
+  MIID+DCCAmCgAwIBAgIBAzANBgkqhkiG9w0BAQsFADAiMSAwHgYDVQQDDBdnZWQv
+  REM9RmFlcmllTVVEL0RDPW9yZzAeFw0yMDEyMjQyMDU1MjlaFw0yMTEyMjQyMDU1
+  MjlaMCIxIDAeBgNVBAMMF2dlZC9EQz1GYWVyaWVNVUQvREM9b3JnMIIBojANBgkq
+  hkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAvyVhkRzvlEs0fe7145BYLfN6njX9ih5H
+  L60U0p0euIurpv84op9CNKF9tx+1WKwyQvQP7qFGuZxkSUuWcP/sFhDXL1lWUuIl
+  M4uHbGCRmOshDrF4dgnBeOvkHr1fIhPlJm5FO+Vew8tSQmlDsosxLUx+VB7DrVFO
+  5PU2AEbf04GGSrmqADGWXeaslaoRdb1fu/0M5qfPTRn5V39sWD9umuDAF9qqil/x
+  Sl6phTvgBrG8GExHbNZpLARd3xrBYLEFsX7RvBn2UPfgsrtvpdXjsHGfpT3IPN+B
+  vQ66lts4alKC69TE5cuKasWBm+16A4aEe3XdZBRNmtOu/g81gvwA7fkJHKllJuaI
+  dXzdHqq+zbGZVSQ7pRYHYomD0IiDe1DbIouFnPWmagaBnGHwXkDT2bKKP+s2v21m
+  ozilJg4aar2okb/RA6VS87o+d7g6LpDDMMQjH4G9OPnJENLdhu8KnPw/ivSVvQw7
+  N2I4L/ZOIe2DIVuYH7aLHfjZDQv/mNgpAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYD
+  VR0PBAQDAgSwMB0GA1UdDgQWBBRyjf55EbrHagiRLqt5YAd3yb8k4DANBgkqhkiG
+  9w0BAQsFAAOCAYEAMYegZanJi8zq7QKPT7wqXefX4C88I5JWeBHR3PvvWK0CwyMV
+  peyiu5I13w/lYX+HUZjE4qsSpJMJFXWl4WZCOo+AMprOcf0PxfuJpxCej5D4tavf
+  vRfhahSw7XJrcZih/3J+/UgoH7R05MJ+8LTcy3HGrB3a0vTafjm8OY7Xpa0LJDoN
+  JDqxK321VIHyTibbKeA1hWSE6ljlQDvFbTqiCj3Ulp1jTv3TOlvRl8fqcfhxUJI0
+  +5Q82jJODjEN+GaWs0V+NlrbU94cXwS2PH5dXogftB5YYA5Ex8A0ikZ73xns4Hdo
+  XxdLdd92F5ovxA23j/rKe/IDwqr6FpDkU3nPXH/Qp0TVGv9zZnVJc/Z6ChkuWj8z
+  pW7JAyyiiHZgKKDReDrA2LA7Zs3o/7KA6UtUH0FHf8LYhcK+pfHk6RtjRe65ffw+
+  MCh97sQ/Z/MOusb5+QddBmB+k8EicXyGNl4b5L4XpL7fIQu+Y96TB3JEJlShxFD9
+  k9FjI4d9EP54gS/4
   -----END CERTIFICATE-----
-date: 2017-04-18 00:00:00.000000000 Z
+date: 2020-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability
@@ -44,56 +42,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
-- !ruby/object:Gem::Dependency
-  name: hoe-mercurial
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0.15'
 - !ruby/object:Gem::Dependency
-  name: hoe-deveiate
+  name: rake-deveiate
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: hoe-highline
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -114,58 +84,25 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: hoe
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.15'
-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
-  config file, load the file when it's convenient for you, and distribute the
-  configuration when you're ready, sending it everywhere it needs to go with a
+        version: '3.9'
+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
+  config file, load the file when it's convenient for you, and distribute the
+  configuration when you're ready, sending it everywhere it needs to go with a
   single action.
 email:
-- ged@FaerieMUD.org
+- ged@faeriemud.org
 - mahlon@martini.nu
-executables:
-- configurability
+executables: []
 extensions: []
-extra_rdoc_files:
-- History.md
-- Manifest.txt
-- README.md
+extra_rdoc_files: []
 files:
 - ChangeLog
 - History.md
@@ -173,7 +110,6 @@ files:
 - Manifest.txt
 - README.md
 - Rakefile
-- bin/configurability
 - examples/basicconfig.rb
 - examples/config.yml
 - examples/readme.rb
@@ -186,31 +122,33 @@ 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: {}
-post_install_message: 
-rdoc_options:
-- "--main"
-- README.md
+metadata:
+  homepage_uri: https://configur.ability.guide/
+  documentation_uri: http://deveiate.org/code/configurability
+  changelog_uri: http://deveiate.org/code/configurability/History_md.html
+  source_uri: https://hg.sr.ht/~ged/Configurability
+  bug_tracker_uri: https://todo.sr.ht/~ged/Configurability
+post_install_message:
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Configurability is a unified, non-intrusive, assume-nothing configuration
-  system for Ruby
+  system for Ruby.
 test_files: []