configurability 3.0.0 → 3.1.0.pre20170103085451

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5b8b9694625491f3e546adeaccceb6c954d5ec3
-  data.tar.gz: b9d69f613e03aeb99cec8c0a4d38f7dc5ba85d15
+  metadata.gz: d81fc141d010af20dd5d7b78114d0c316f07b240
+  data.tar.gz: 6445f4fbbd81ef3b4fe3e8d4bac88cbad4e86602
 SHA512:
-  metadata.gz: e2cf44e75c61f75d701d72733a417e837d179b7c948cac985107ba212cf6df689f1fc62b6cb96d2e8c0e41f32a6c3324006970903254f1423a9cd7d1a7dc746e
-  data.tar.gz: 11fff4eb97457b4bd3ee7c0dfc4a38c95c09b403e5cefd4822692c03ef1ec99239061165eef28ff8aea8b5f3eb523420577a58fcc09e81bc468a1fdb52e67481
+  metadata.gz: b387ba4d2f378713a7a497d2db633395dc4dcb5d0a9d35dc9b1da5ed5d0ef45e2b3f9419d234e155f93bc33a222805cd589c438585ac74d19d12213f132ed76f
+  data.tar.gz: d3b1fdbed90c63b0e073a372f6ee67ad80f43bd8b97ef1a718c70204b05cbe694fbffece4531a1f014aa4be3e11a085e307dbf2b0548881479dcb12e286ff8e6

data/README.md

@@ -74,6 +74,9 @@ some settings:
             setting :url, default: 'sqlite:/'
             setting :user
             setting :password
+            setting :port do |value|
+                Integer( value )
+            end
         end
     end
 
@@ -82,6 +85,8 @@ three subkey settings under it (with getters and setters) to the class. It also
 adds a `configure` class method that will set whichever of the settings are
 passed to it, defaulting the `url` to the provided value if it's not given.
 
+The `setting` can include a block which is given the config value before it's set; from this block you can do validity-checking, cast it to something other than a String, etc. The new value will be set to the return value of the block.
+
 If your config file (e.g., `config.yml`) looks like this:
 
     --

data/Rakefile

@@ -31,7 +31,7 @@ hoespec = Hoe.spec 'configurability' do |spec|
 	spec.developer 'Michael Granger', 'ged@FaerieMUD.org'
 	spec.developer 'Mahlon E. Smith', 'mahlon@martini.nu'
 
-	spec.dependency 'loggability', '~> 0.11'
+	spec.dependency 'loggability', '~> 0.12'
 
 	spec.dependency 'hoe-deveiate', '~> 0.8', :developer
 	spec.dependency 'simplecov', '~> 0.12', :developer

data/lib/configurability/setting_installer.rb

@@ -26,9 +26,9 @@ class Configurability::SettingInstaller
 
 
 	### Declare a config setting with the specified +name+.
-	def setting( name, **options )
+	def setting( name, **options, &block )
 		self.log.debug "  adding %s setting to %p" % [ name, self.target ]
-		self.add_setting_accessors( name, options )
+		self.add_setting_accessors( name, options, &block )
 		self.add_default( name, options )
 	end
 
@@ -38,9 +38,12 @@ class Configurability::SettingInstaller
 	#########
 
 	### Add accessors with the specified +name+ to the target.
-	def add_setting_accessors( name, options )
+	def add_setting_accessors( name, options, &writer_hook )
 		reader = lambda { self.instance_variable_get("@#{name}") }
-		writer = lambda {|value| self.instance_variable_set("@#{name}", value) }
+		writer = lambda do |value|
+			value = writer_hook[ value ] if writer_hook
+			self.instance_variable_set( "@#{name}", value )
+		end
 
 		self.target.define_singleton_method( "#{name}", &reader )
 		self.target.define_singleton_method( "#{name}=", &writer )

data/spec/configurability_spec.rb

@@ -630,6 +630,26 @@ describe Configurability do
 			expect( mod.apikey ).to eq( 'jofRtkw&QzCoukGwAWDMjyTkQzWnCXhhgEs' )
 		end
 
+
+		it "can declare settings with a block to do writer pre-processing" do
+			mod.configurability( :testconfig ) do
+				setting :data_dir do |dir|
+					Pathname( dir )
+				end
+				setting :apikey do |key|
+					raise "Invalid API key!" unless key.to_s =~ /\A\p{Xdigit}{32}\z/
+					key
+				end
+			end
+
+			expect {
+				mod.data_dir = 'var/data'
+			}.to change { mod.data_dir }.to( Pathname('var/data') )
+			expect {
+				mod.apikey = 'something'
+			}.to raise_error( /Invalid API key/i )
+		end
+
 	end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: configurability
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0.pre20170103085451
 platform: ruby
 authors:
 - Michael Granger
@@ -36,7 +36,7 @@ cert_chain:
   w8aNA5re5+Rt/Vvjxj5AcEnZnZiz5x959NaddQocX32Z1unHw44pzRNUur1GInfW
   p4vpx2kUSFSAGjtCbDGTNV2AH8w9OU4xEmNz8c5lyoA=
   -----END CERTIFICATE-----
-date: 2016-12-28 00:00:00.000000000 Z
+date: 2017-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: hoe-mercurial
   requirement: !ruby/object:Gem::Requirement
@@ -169,7 +169,6 @@ extra_rdoc_files:
 files:
 - ChangeLog
 - History.md
-- LICENSE
 - Manifest.txt
 - README.md
 - Rakefile
@@ -203,9 +202,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.8

data/LICENSE

@@ -1,27 +0,0 @@
-Copyright (c) 2010-2016 Michael Granger and Mahlon E. Smith
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice,
-  this list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
-
-* Neither the name of the author/s, nor the names of the project's
-  contributors may be used to endorse or promote products derived from this
-  software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.