configr 0.8.0 → 0.9.0

data/Rakefile

@@ -5,7 +5,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "configr"
-    gem.summary = "A more elegant approach to creating and accessing configuration values."
+    gem.summary = "An elegant approach to creating and accessing configuration values."
     gem.description = "Configr aims to provide a clean interface to configuring and reading a set of configuration values. The idea evolved from using a standard hash as a configuration store into a more elegant way to declare and read values from within a hash. "
     gem.email = "josh@josh-nesbitt.net"
     gem.homepage = "http://github.com/joshnesbitt/configr"

data/VERSION

@@ -1 +1 @@
-0.8.0
+0.9.0

data/configr.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{configr}
-  s.version = "0.8.0"
+  s.version = "0.9.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Josh Nesbitt"]
-  s.date = %q{2010-02-26}
+  s.date = %q{2010-03-01}
   s.description = %q{Configr aims to provide a clean interface to configuring and reading a set of configuration values. The idea evolved from using a standard hash as a configuration store into a more elegant way to declare and read values from within a hash. }
   s.email = %q{josh@josh-nesbitt.net}
   s.extra_rdoc_files = [
@@ -40,7 +40,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.5}
-  s.summary = %q{A more elegant approach to creating and accessing configuration values.}
+  s.summary = %q{An elegant approach to creating and accessing configuration values.}
   s.test_files = [
     "spec/lib/configuration_block_spec.rb",
      "spec/lib/configuration_spec.rb",

data/lib/configr/configuration_block.rb

@@ -13,6 +13,9 @@ module Configr
       when name.include?('=')
         key = name.gsub('=','').to_sym
         self.attributes[key] = args.first
+      when name.include?("?")
+        key = name.gsub('?','').to_sym
+        !self.attributes[key].nil?
       when existing_block_attributes = self.attributes[method]
         existing_block = ConfigurationBlock.new(existing_block_attributes)
         self.attributes[method] = existing_block.attributes

data/lib/configr/hash.rb

@@ -39,7 +39,17 @@ module Configr
     end
     
     def method_missing(method, *args, &block)
-      self[method]
+      name = method.to_s
+      
+      case
+      when name.include?("=")
+        raise ConfigurationLocked, "Configuration is locked from configuring values after the configuration has been run."
+      when name.include?('?')
+        key = name.gsub('?','').to_sym
+        !self[key].nil?
+      else
+        self[method]
+      end
     end
   end
 end

data/readme.rdoc

@@ -11,7 +11,7 @@
 
 == Overview
 
-Configr aims to provide a more Ruby-like interface to configuring and reading a set of configuration values. The idea evolved from using a standard hash as a configuration store into a more elegant way to declare and read values from within a hash.
+Configr aims to provide a clean interface for configuring and reading a set of configuration values. The idea evolved from using a standard hash as a configuration store into a more elegant way to declare and read values from within a hash.
 
 
 
@@ -99,16 +99,24 @@ Conceptually you could continue to nest configuration blocks as far as you wish.
   puts configuration.example_three
   puts configuration.example_four
 
+=== Asserting key presence
+
+Sometimes when using configuration values you might want to assert whether the value exists before using it. Configr allows you to do this the #key_name? methods:
+  
+  puts configuration.example_one? # => true
+  puts configuration.doesnt_exist? # => false
+
 
 
 == Usage (within frameworks)
 
-Configr is intended to be framework agnostic, but it's easy to get it going inside of Rails/Sinatra/Hot New Framework.
+Configr is intended to be framework agnostic, but it's easy to get it going inside of Rails/Sinatra.
+
 
 
 === Rails
 
-You can use Configr within Rails quite easily. I don't plan to provide any "out of the box" way to hook Configr into Rails but it's quite easy to implement:
+You can use Configr within Rails quite easily. I don't plan to provide any "out of the box" way to hook Configr into Rails but it's easy to implement:
 
   # In config/configuration.rb
   yaml_file = Rails.root.join("config", "environments", "#{Rails.env}.yml")
@@ -142,7 +150,7 @@ Again, by requiring a different YAML file based on the environment it is easy to
 
 == A note about locking
 
-By design a configuration value is not meant to be edited or created after the configuration block has been run (if you do you will run into a Configr::ConfigurationLocked error when assigning a value on the top level). In my opinion configurations such as those created in Configr are meant to be read-only during the lifetime of the application. Configr could however be altered to allow this with a patch should it be required.
+By design a configuration value is not meant to be edited or created after the configuration block has been run (if you do you will run into a Configr::ConfigurationLocked error). In my opinion configurations such as those created by Configr are meant to be read-only during the lifetime of the application. Configr could however be altered to allow this with a simple patch should it be required.
 
 
 

data/spec/lib/configuration_block_spec.rb

@@ -50,5 +50,19 @@ module Configr
       @block.five.six.seven.class.should == ConfigurationBlock
     end
     
+    it "should return true when using the #method? for asserting a values presence" do
+      @block.variable = "value"
+      @block.another.variable.set = "something"
+      
+      @block.variable?.should             == true
+      @block.another.variable.set?.should == true
+      
+      @block.exists?.should == false
+      @block.exists = "value"
+      @block.exists?.should == true
+      
+      @block.another.variable.missing?.should == false
+    end
+    
   end
 end

data/spec/lib/configuration_spec.rb

@@ -30,6 +30,17 @@ module Configr
       configuration.other_value?.should == false
     end
     
+    it "should return true on a value being present when using the #method? within a nested block" do
+      configuration = Configuration.configure do |config|
+        config.one.two.three = "value"
+      end
+      
+      configuration.one?.should           == true
+      configuration.one.two?.should       == true
+      configuration.one.two.three?.should == true
+      configuration.one.two.five?.should  == false
+    end
+    
     it "should raise an error when an existing value attempts to be updated once configuration has been run" do
       configuration = Configuration.configure do |config|
         config.key = "value"

data/spec/lib/hash_spec.rb

@@ -77,5 +77,19 @@ module Configr
       hash.two.should == "two"
     end
     
+    it "should return true when using the #method? for asserting a values presence" do
+      hash = Hash.new({ :one => "one", :two => "two" })
+      
+      hash.one?.should   == true
+      hash.two?.should   == true
+      hash.three?.should == false
+    end
+    
+    it "should raise an error when a value is assigned" do
+      hash = Hash.new({ :one => "one", :two => "two" })
+      
+      lambda { hash.some_value = "this" }.should raise_error(Configr::ConfigurationLocked)
+    end
+    
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: configr
 version: !ruby/object:Gem::Version 
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Josh Nesbitt
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-26 00:00:00 +00:00
+date: 2010-03-01 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -77,7 +77,7 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: A more elegant approach to creating and accessing configuration values.
+summary: An elegant approach to creating and accessing configuration values.
 test_files: 
 - spec/lib/configuration_block_spec.rb
 - spec/lib/configuration_spec.rb