configr 0.2.0 → 0.8.0

data/.gitignore

@@ -0,0 +1 @@
+pkg/*

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Josh Nesbitt <josh@josh-nesbitt.net>
+Copyright (c) 2010 Josh Nesbitt <josh@josh-nesbitt.net>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -5,8 +5,8 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "configr"
-    gem.summary = "A more Rubyish approach to creating and accessing configuration values."
-    gem.description = "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. "
+    gem.summary = "A more 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"
     gem.authors = ["Josh Nesbitt"]

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.8.0

data/configr.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{configr}
+  s.version = "0.8.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.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 = [
+    "LICENSE"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "Rakefile",
+     "VERSION",
+     "configr.gemspec",
+     "examples/all.rb",
+     "lib/configr.rb",
+     "lib/configr/configuration.rb",
+     "lib/configr/configuration_block.rb",
+     "lib/configr/errors.rb",
+     "lib/configr/hash.rb",
+     "readme.rdoc",
+     "spec/fixtures/configuration.yml",
+     "spec/lib/configuration_block_spec.rb",
+     "spec/lib/configuration_spec.rb",
+     "spec/lib/errors_spec.rb",
+     "spec/lib/hash_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/watch.rb"
+  ]
+  s.homepage = %q{http://github.com/joshnesbitt/configr}
+  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.test_files = [
+    "spec/lib/configuration_block_spec.rb",
+     "spec/lib/configuration_spec.rb",
+     "spec/lib/errors_spec.rb",
+     "spec/lib/hash_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/watch.rb",
+     "examples/all.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/examples/all.rb

@@ -1,5 +1,6 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'configr'))
 
+
 # Standalone (without YAML)
 
 configuration = Configr::Configuration.configure do |config|
@@ -54,20 +55,21 @@ puts configuration.example_two
 puts configuration.example_three
 puts configuration.example_four
 
-# Good for things like this
+# Example of real world usage
 
-Config = Configr::Configuration.configure do |config|
-  config.support_email    = "goaway@example.com"
-  config.google_analytics = "UA-x343x-SDS"
+Configuration = Configr::Configuration.configure do |config|
+  config.email.from_address = "goaway@example.com"
+  config.email.from_name    = "Someone"
   
   config.twitter.screen_name = "someone"
   config.twitter.password    = "somepass"
+  
+  config.wiki_url = "wiki.example.com"
 end
 
-puts Config.support_email
-puts Config.google_analytics
-puts Config.twitter[:screen_name]
-puts Config.twitter[:password]
+puts Configuration.wiki_url
+puts Configuration.twitter[:screen_name]
+puts Configuration.twitter[:password]
 
-puts Config.twitter.screen_name
-puts Config.twitter.password
+puts Configuration.email.from_address
+puts Configuration.email.from_name

data/lib/configr/configuration.rb

@@ -5,6 +5,21 @@ require 'configuration_block'
 
 module Configr
   class Configuration
+    
+    class << self
+      def configure(yaml=nil)
+        instance = self.new(yaml)
+        
+        yield instance.base if block_given?
+        
+        instance.attributes = instance.base.attributes
+        instance.merge_configurations!
+        instance.attributes.recursive_normalize!
+        
+        instance
+      end
+    end
+    
     attr_accessor :base, :attributes, :yaml
     
     def initialize(yaml=nil)
@@ -12,20 +27,6 @@ module Configr
       self.yaml = yaml
     end
     
-    def self.configure(yaml=nil)
-      instance = self.new(yaml)
-      
-      yield instance.base if block_given?
-      
-      instance.attributes = instance.base.attributes
-      
-      instance.merge_configurations!
-      
-      instance.attributes.recursive_normalize!
-      
-      instance
-    end
-    
     def [](value)
       self.attributes[value]
     end
@@ -35,7 +36,7 @@ module Configr
       
       case
       when name.include?("=")
-        raise ConfigurationLocked, "Blocked from configuring values after configuration has been run."
+        raise ConfigurationLocked, "Configuration is locked from configuring values after the configuration has been run."
       when name.include?("?")
         !self.attributes[name.gsub("?", "").to_sym].nil?
       else
@@ -46,12 +47,16 @@ module Configr
     def merge_configurations!
       return unless self.yaml
       
+      self.yaml = self.yaml.to_s
+      
       hash = if File.exists?(self.yaml)
         YAML.load_file(self.yaml)
       else
         YAML.load(self.yaml)
       end
       
+      return unless hash
+      
       hash = Hash.new(hash)
       hash.recursive_symbolize_keys!
       

data/lib/configr/configuration_block.rb

@@ -1,7 +1,7 @@
 module Configr
   class ConfigurationBlock
     attr_accessor :attributes
-
+    
     def initialize(attributes={})
       self.attributes = Hash.new(attributes)
     end

data/lib/configr/hash.rb

@@ -1,15 +1,16 @@
 module Configr
   module HashExtensions
     def symbolize_keys!
-      self.each { |k, v|
-        self.delete(k.to_s);
+      each do |k, v|
+        self.delete(k.to_s)
         self[k.to_sym] = v
-      }
+      end
     end
     
     def recursive_symbolize_keys!
-      self.symbolize_keys!
-      self.values.select{ |value|
+      symbolize_keys!
+      
+      values.select { |value|
         value.is_a?(::Hash) || value.is_a?(Hash)
       }.each{ |hash|
         hash.recursive_symbolize_keys!

data/readme.rdoc

@@ -4,17 +4,24 @@
 * Installation
 * Usage
 * Usage (within frameworks)
+* Locking
+* Bugs
 * Contributors
 
+
 == 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.
 
+
+
 == Installation
 
 The project is hosted on rubygems.org. Getting it is simple:
 
-  gem install <gem name>
+  gem install configr
+
+
 
 == Usage
 
@@ -23,10 +30,11 @@ There are a variety of ways in which you can use Configr:
 * Standalone block
 * From inline YAML
 * From a YAML file
-* A mixture of YAML and block configuration
+* A mixture of a YAML and block configuration
 
 The following examples can also be found and run in examples/all.rb.
 
+
 === Standalone Block
 
   configuration = Configr::Configuration.configure do |config|
@@ -37,7 +45,7 @@ The following examples can also be found and run in examples/all.rb.
   puts configuration.example_one
   puts configuration.example_two
 
-Conceptually you could continue to nest configuration blocks as far as you wish. They exist to enable you to seperate your configuration values into contexts. Take for example a set of email configuration values:
+Conceptually you could continue to nest configuration blocks as far as you wish. They exist to enable you to separate your configuration values into contexts. Take for example a set of email configuration values:
 
   Configr::Configuration.configure do |config|
     config.email.from_address  = "hello@example.com"
@@ -45,6 +53,10 @@ Conceptually you could continue to nest configuration blocks as far as you wish.
     config.email.reply_address = "reply@example.com"
   end
 
+  puts configuration.email.from_address
+  puts configuration.email.from_name
+  puts configuration.email.reply_address
+
 === From an inline YAML string
 
   yaml = <<YAML
@@ -59,6 +71,7 @@ Conceptually you could continue to nest configuration blocks as far as you wish.
   puts configuration.example_one
   puts configuration.example_two
 
+
 === From a YAML file
 
   configuration = Configr::Configuration.configure("/path/to/file.yml")
@@ -66,35 +79,41 @@ Conceptually you could continue to nest configuration blocks as far as you wish.
   puts configuration.value_one
   puts configuration.value_two
 
+
 === A mixture of any of the above
 
   yaml = <<YAML
 
-  example_three: "Oooooo"
-  example_four: "It loads from YAML too!"
-
+  example_three: "three"
+  example_four: "four"
+  
   YAML
   
   configuration = Configr::Configuration.configure(yaml) do |config|
-    config.example_one = "One"
-    config.example_two = "Two"
+    config.example_one = "one"
+    config.example_two = "two"
   end
-
+  
   puts configuration.example_one
   puts configuration.example_two
   puts configuration.example_three
   puts configuration.example_four
 
+
+
 == Usage (within frameworks)
 
-Configr is intended to be framework agnostic, but it's easy to get it going within Rails/Sinatra/Hot New Framework app.
+Configr is intended to be framework agnostic, but it's easy to get it going inside of Rails/Sinatra/Hot New Framework.
+
 
 === Rails
 
-You can use Configr within Rails quite easily. I don't really 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 quite easy to implement:
 
   # In config/configuration.rb
-  Config = Configr::Configuration.configure(Rails.root.join("config", "environments", "#{Rails.env}.yml")) do |config|
+  yaml_file = Rails.root.join("config", "environments", "#{Rails.env}.yml")
+  
+  Configuration = Configr::Configuration.configure(yaml_file) do |config|
     config.my.configuration.value = "value"
   end
   
@@ -102,26 +121,43 @@ You can use Configr within Rails quite easily. I don't really plan to provide an
   require Rails.root.join("config", "configuration.rb")
   
   # Anywhere in your Rails app
-  Config.my.configuration.value
+  Configuration.my.configuration.value
 
 By requiring a different YAML file based on the environment it is easy to override global values with environment specific values.
 
+
 === Sinatra
 
 A quick and dirty solution would be to pop it in a configure block:
 
   configure do
-    Config = Configr::Configuration.configure(File.join("#{environment}.yml")) do |config|
+    Configuration = Configr::Configuration.configure("config/file.yml") do |config|
       config.something = "value"
     end
   end
 
 Again, by requiring a different YAML file based on the environment it is easy to override global values with environment specific values.
 
+
+
+== 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.
+
+
+
+== Bugs
+
+If you have any problems with Configr, please file an issue at http://github.com/joshnesbitt/configr/issues.
+
+
+
 == Contributors
 
 * Thomas Williams for the concept of nested configuration blocks.
 
+
+
 == Note on Patches/Pull Requests
  
 * Fork the project.
@@ -132,6 +168,8 @@ Again, by requiring a different YAML file based on the environment it is easy to
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
+
+
 == Copyright
 
 Copyright (c) 2010 Josh Nesbitt <josh@josh-nesbitt.net>. See LICENSE for details.

data/spec/lib/configuration_block_spec.rb

@@ -1,5 +1,6 @@
 module Configr
   describe ConfigurationBlock do
+    
     before do
       @hash  = { :one => "one", :two => "two" }
       @block = ConfigurationBlock.new(@hash)
@@ -48,5 +49,6 @@ module Configr
       @block.five.six.class.should       == ConfigurationBlock
       @block.five.six.seven.class.should == ConfigurationBlock
     end
+    
   end
 end

data/spec/lib/configuration_spec.rb

@@ -1,110 +1,114 @@
 module Configr
   describe Configuration do
-
+    
     it "should have the #configure class method to instantiate the configuration" do
       Configuration.should respond_to(:configure)
     end
-
+    
     it "should return nil when a value is not set" do
       configuration = Configuration.configure do |config|
         config.key = "value"
       end
-
+      
       configuration.other_key.should be_nil
     end
-
-    it "should return a value for a key when one has been set" do
+    
+    it "should return a value for a key thats been set" do
       configuration = Configuration.configure do |config|
         config.key = "value"
       end
-
+      
       configuration.key.should == "value"
     end
-
-    it "should raise an error when an existing value attempts to be updated" do
+    
+    it "should return true on a value being present when using the #method?" do
       configuration = Configuration.configure do |config|
         config.key = "value"
       end
-
-      lambda { configuration.key = "othervalue" }.should raise_error(Configr::ConfigurationLocked)
+      
+      configuration.key?.should         == true
+      configuration.other_value?.should == false
     end
-
-    it "should report a value being present on #attribute?" do
+    
+    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"
       end
-
-      configuration.key?.should         == true
-      configuration.other_value?.should == false
+      
+      lambda { configuration.key = "othervalue" }.should raise_error(Configr::ConfigurationLocked)
     end
-
-    it "should load a configuration from a YAML string" do
+    
+    it "should load a configuration hash from a YAML string" do
       yaml = <<-YAML
       first_name: Josh
       location: Leeds
       YAML
-
+      
       configuration = Configuration.configure(yaml)
-
+      
       configuration.first_name.should == "Josh"
       configuration.location.should   == "Leeds"
     end
-
-    it "should load a configuration from a YAML string and a block" do
+    
+    it "should load a configuration hash from a YAML string and a block" do
       yaml = <<-YAML
       first_name: Josh
       location: Leeds
       YAML
-
+      
       configuration = Configuration.configure(yaml) do |config|
         config.from_block = "value"
       end
-
+      
       configuration.first_name.should   == "Josh"
       configuration.location.should     == "Leeds"
       configuration.from_block.should   == "value"
     end
-
-    it "should load a configation from a YAML file" do
+    
+    it "should load a configation hash from a YAML file" do
       file = File.expand_path(File.join('spec', 'fixtures', 'configuration.yml'))
-
+      
       configuration = Configuration.configure(file)
-
+      
       configuration.first_name.should == "Bob"
       configuration.location.should   == "Somewhere else"
     end
-
-    it "should load a configation from a YAML file and a block" do
+    
+    it "should load a configation hash from a YAML file and a block" do
       file = File.expand_path(File.join('spec', 'fixtures', 'configuration.yml'))
-
+      
       configuration = Configuration.configure(file) do |config|
         config.hello = "value"
       end
-
+      
       configuration.first_name.should == "Bob"
       configuration.location.should   == "Somewhere else"
       configuration.hello.should      == "value"
     end
-
-    it "should allow a value from YAML to have precedence over the block" do
+    
+    it "should allow a value from YAML to have precedence over the block value" do
       file = File.expand_path(File.join('spec', 'fixtures', 'configuration.yml'))
-
+      
       configuration = Configuration.configure(file) do |config|
         config.first_name = "Billy"
       end
-
+      
       configuration.first_name.should == "Bob"
     end
     
-    it "should allow a deeply nested hash to be accessed with hash notation" do
+    it "should allow more than one value to be assigned within the same namespace" do
       configuration = Configuration.configure do |config|
-        config.one.two.three.four = "value"
+        config.one.two.variable_one   = "value one"
+        config.one.two.variable_two   = "value two"
+        config.one.two.variable_three = "value three"
       end
       
-      configuration.one[:two][:three][:four].should == "value"
+      configuration.one[:two][:variable_one].should   == "value one"
+      configuration.one[:two][:variable_two].should   == "value two"
+      configuration.one[:two][:variable_three].should == "value three"
     end
     
-    it "should allow more than one value to be assigned within the same namespace" do
+    it "should allow standard hash based access to attributes" do
       configuration = Configuration.configure do |config|
         config.one.two.three.var1 = "value one"
         config.one.two.three.var2 = "value two"
@@ -116,12 +120,17 @@ module Configr
       configuration.one[:two][:three][:var3].should == "value three"
     end
     
-    it "should allow method like lookup of attributes" do
+    it "should allow method based access to attributes" do
       configuration = Configuration.configure do |config|
-        config.one.two.three.var1 = "value"
+        config.one.two.three.var1 = "value one"
+        config.one.two.three.var2 = "value two"
+        config.one.two.three.var3 = "value three"
       end
       
-      configuration.one.two.three.var1.should == "value"
+      configuration.one.two.three.var1.should == "value one"
+      configuration.one.two.three.var2.should == "value two"
+      configuration.one.two.three.var3.should == "value three"
     end
+    
   end
 end

data/spec/lib/errors_spec.rb

@@ -1,12 +1,11 @@
 module Configr
   describe Hash do
     
-    it "should have a base error class defined for Configr" do
-      Configr::ConfigrError.ancestors.should include(StandardError)
-      
+    it "should have a base error class" do
       error = Configr::ConfigrError.new("Error data")
       
       error.data.should == "Error data"
+      Configr::ConfigrError.ancestors.should include(StandardError)
     end
     
   end

data/spec/lib/hash_spec.rb

@@ -1,7 +1,7 @@
 module Configr
   describe Hash do
     
-    it "should create a ConfigurableHash from an existing hash" do
+    it "should create a Configr Hash from an existing hash" do
       hash = Hash.new({ :one => "one", :two => "two" })
       
       hash[:one].should == "one"
@@ -11,11 +11,17 @@ module Configr
     it "should symbolize a set of string keys" do
       hash = Hash.new({ "one" => "one", "two" => "two" })
       
+      hash["one"].should == "one"
+      hash["two"].should == "two"
+      
       hash[:one].should be_nil
       hash[:two].should be_nil
       
       hash.symbolize_keys!
       
+      hash["one"].should be_nil
+      hash["two"].should be_nil
+      
       hash[:one].should == "one"
       hash[:two].should == "two"
     end
@@ -23,12 +29,20 @@ module Configr
     it "should recursively symbolize a set of string keys" do
       hash = Hash.new({ "one" => "one", "two" => "two", "three" => { "four" => "four" } })
       
+      hash["one"].should   == "one"
+      hash["two"].should   == "two"
+      hash["three"]["four"].should == "four"
+      
       hash[:one].should be_nil
       hash[:two].should be_nil
       hash[:three].should be_nil
       
       hash.recursive_symbolize_keys!
       
+      hash["one"].should be_nil
+      hash["two"].should be_nil
+      hash["three"].should be_nil
+      
       hash[:one].should == "one"
       hash[:two].should == "two"
       hash[:three][:four].should == "four"
@@ -56,11 +70,12 @@ module Configr
       hash[:three][:five].class.should == Configr::Hash
     end
     
-    it "should utilise method missing to provide access to hash keys" do
+    it "should allow method based access to hash keys" do
       hash = Hash.new({ :one => "one", :two => "two" })
       
       hash.one.should == "one"
       hash.two.should == "two"
     end
+    
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: configr
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Josh Nesbitt
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.2.9
     version: 
-description: "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. "
+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. "
 email: josh@josh-nesbitt.net
 executables: []
 
@@ -31,9 +31,11 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE
 files: 
+- .gitignore
 - LICENSE
 - Rakefile
 - VERSION
+- configr.gemspec
 - examples/all.rb
 - lib/configr.rb
 - lib/configr/configuration.rb
@@ -75,7 +77,7 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: A more Rubyish approach to creating and accessing configuration values.
+summary: A more elegant approach to creating and accessing configuration values.
 test_files: 
 - spec/lib/configuration_block_spec.rb
 - spec/lib/configuration_spec.rb