configatron 2.8.1 → 2.8.2

data/{README → README.textile}

@@ -1,89 +1,112 @@
-=Configatron
+h1. Configatron
 
 Configatron makes configuring your applications and scripts incredibly easy. No longer is a there a need to use constants or global variables. Now you can use a simple and painless system to configure your life. And, because it's all Ruby, you can do any crazy thing you would like to!
 
-==Installation
+h2. Installation
 
 Installation of Configatron is easy, as it is just a RubyGem:
 
+<pre><code>
   $ sudo gem install configatron
+</code></pre>
 
 If you'd like to live on the bleedin' edge you can install the development version from GitHub:
 
+<pre><code>
   $ sudo gem install markbates-configatron --source=http://gems.github.com
+</code></pre>
 
 Once installed you just need to require it:
 
+<pre><code>
   require 'configatron'
+</code></pre>
 
-==Examples
+h2. Examples
 
-===Simple
+h3. Simple
 
+<pre><code>
   configatron.email = 'me@example.com'
   configatron.database_url = "postgres://localhost/mack_framework_rocks"
+</code></pre>
 
 Now, anywhere in your code you can do the following:
 
+<pre><code>
   configatron.email # => "me@example.com"
   configatron.database_url # => "postgres://localhost/mack_framework_rocks"
+</code></pre>
 
 Viola! Simple as can be.
 
-Now you're saying, what if I want to have a 'default' set of options, but then override them later, based on other information? Simple again. Let's use our above example. We've configured our <tt>database_url</tt> option to be <tt>postgres://localhost/mack_framework_rocks</tt>. The problem with that is that is our production database url, not our development url. Fair enough, all you have to do is redeclare it:
+Now you're saying, what if I want to have a 'default' set of options, but then override them later, based on other information? Simple again. Let's use our above example. We've configured our @database_url@ option to be @postgres://localhost/mack_framework_rocks@. The problem with that is that is our production database url, not our development url. Fair enough, all you have to do is redeclare it:
 
+<pre><code>
   configatron.database_url = "postgres://localhost/mack_framework_rocks_development"
+</code></pre>
 
 becomes:
 
+<pre><code>
   configatron.email # => "me@example.com"
   configatron.database_url # => "postgres://localhost/mack_framework_rocks_development"
+</code></pre>
 
 Notice how our other configuration parameters haven't changed? Cool, eh?
 
-===Hash/YAML
+h3. Hash/YAML
 
-You can configure configatron from a hash as well:
+You can configure configatron from a hash as well (this is really only useful in testing or for data driven configurat, it's not recommended for actual configuration):
 
+<pre><code>
   configatron.configure_from_hash({:email => {:pop => {:address => 'pop.example.com', :port => 110}}, :smtp => {:address => 'smtp.example.com'}})
   
   configatron.email.pop.address # => 'pop.example.com'
   configatron.email.pop.port # => 110
   # and so on...
+</code></pre>
 
-Notice how they're all namespaced for your as well. The same holds true for YAML files:
+h4. YAML
 
-  configatron.configure_from_yaml('/path/to/file.yml')
+Support for YAML has been deprecated and will be removed in version 2.9 of Configatron. Please switch to Ruby based configuration of Configatron. Trust me, it's a lot nicer and easier to use. Why would you _not_ want to?
 
-===Namespaces
+h3. Namespaces
 
 The question that should be on your lips is what I need to have namespaced configuration parameters. It's easy! Configatron allows you to create namespaces.
 
+<pre><code>
   configatron.website_url = "http://www.mackframework.com"
   configatron.email.pop.address = "pop.example.com"
   configatron.email.pop.port = 110
   configatron.email.smtp.address = "smtp.example.com"
   configatron.email.smtp.port = 25
+</code></pre>
 
 becomes:
 
+<pre><code>
   configatron.email.pop.address # => "pop.example.com"
   configatron.email.smtp.address # => "smtp.example.com"
   configatron.website_url # => "http://www.mackframework.com"
+</code></pre>
 
 Configatron allows you to nest namespaces to your hearts content! Just keep going, it's that easy.
 
 Of course you can update a single parameter n levels deep as well:
 
+<pre><code>
   configatron.email.pop.address = "pop2.example.com"
   
   configatron.email.pop.address # => "pop2.example.com"
   configatron.email.smtp.address # => "smtp.example.com"
+</code></pre>
 
-===Temp Configurations
+h3. Temp Configurations
 
-Sometimes in testing, or other situations, you want to temporarily change some settings. You can do this with the <tt>temp</tt> method:
+Sometimes in testing, or other situations, you want to temporarily change some settings. You can do this with the @temp@ method:
 
+<pre><code>
   configatron.one = 1
   configatron.letters.a = 'A'
   configatron.letters.b = 'B'
@@ -99,9 +122,11 @@ Sometimes in testing, or other situations, you want to temporarily change some s
   configatron.letters.a # => 'A'
   configatron.letters.b # => 'B'
   configatron.letters.c # => nil
+</code></pre>
 
-You can also pass in an optional Hash to the <tt>temp</tt>:
+You can also pass in an optional Hash to the @temp@:
 
+<pre><code>
   configatron.one = 1
   configatron.letters.a = 'A'
   configatron.letters.b = 'B'
@@ -115,11 +140,13 @@ You can also pass in an optional Hash to the <tt>temp</tt>:
   configatron.letters.a # => 'A'
   configatron.letters.b # => 'B'
   configatron.letters.c # => nil
+</code></pre>
 
-===Delayed and Dynamic Configurations
+h3. Delayed and Dynamic Configurations
 
 There are times when you want to refer to one configuration setting in another configuration setting. Let's look at a fairly contrived example:
 
+<pre><code>
   configatron.memcached.servers = ['127.0.0.1:11211']
   configatron.page_caching.servers = configatron.memcached.servers
   configatron.object_caching.servers = configatron.memcached.servers
@@ -133,13 +160,15 @@ There are times when you want to refer to one configuration setting in another c
     configatron.page_caching.servers = configatron.memcached.servers
     configatron.object_caching.servers = configatron.memcached.servers
   end
+</code></pre>
 
 Now, we could've written that slightly differently, but it helps to illustrate the point. With Configatron you can create <code>Delayed</code> and <code>Dynamic</code> settings. 
 
-====Delayed
+h4. Delayed
 
 With <code>Delayed</code> settings execution of the setting doesn't happen until the first time it is executed. 
 
+<pre><code>
   configatron.memcached.servers = ['127.0.0.1:11211']
   configatron.page_caching.servers = Configatron::Delayed.new {configatron.memcached.servers}
   configatron.object_caching.servers = Configatron::Delayed.new {configatron.memcached.servers}
@@ -149,40 +178,49 @@ With <code>Delayed</code> settings execution of the setting doesn't happen until
   elsif Rails.env == 'staging'
     configatron.memcached.servers = ['192.168.0.2:11211']
   end
+</code></pre>
 
 Execution occurs once and after that the result of that execution is returned. So in our case the first time someone calls the setting <code>configatron.page_caching.servers</code> it will find the <code>configatron.memcached.servers</code> setting and return that. After that point if the <code>configatron.memcached.servers</code> setting is changed, the original settings are returned by <code>configatron.page_caching.servers</code>.
 
-====Dynamic
+h4. Dynamic
 
 <code>Dynamic</code> settings are very similar to <code>Delayed</code> settings, but with one big difference. Every time you call a <code>Dynamic</code> setting is executed. Take this example:
 
+<pre><code>
   configatron.current.time = Configatron::Dynamic.new {Time.now}
+</code></pre>
 
 Each time you call <code>configatron.current.time</code> it will return a new value to you. While this seems a bit useless, it is pretty useful if you have ever changing configurations.
 
-===Misc.
+h3. Misc.
 
-Even if parameters haven't been set, you can still call them, but you'll get a <tt>Configatron::Store</tt> object back. The Configatron::Store class, however, will respond true to <tt>.nil?</tt> if there are no parameters configured on it.
+Even if parameters haven't been set, you can still call them, but you'll get a @Configatron::Store@ object back. The Configatron::Store class, however, will respond true to @.nil?@ if there are no parameters configured on it.
 
+<pre><code>
   configatron.i.dont.exist.nil? # => true
   configatron.i.dont.exist # => Configatron::Store
+</code></pre>
 
-If you want to get back an actual <tt>nil</tt> then you can use the <tt>retrieve</tt> method:
+If you want to get back an actual @nil@ then you can use the @retrieve@ method:
 
+<pre><code>
   configatron.i.do.exist = [:some, :array]
   configatron.i.dont.retrieve(:exist, nil) # => nil
   configatron.i.do.retrieve(:exist, :foo) # => [:some, :array]
+</code></pre>
 
 You can set 'default' values for parameters. If there is already a setting, it won't be replaced. This is useful if you've already done your 'configuration' and you call a library, that needs to have parameters set. The library can set its defaults, without worrying that it might have overridden your custom settings.
 
+<pre><code>
   configatron.set_default(:name, 'Mark Bates')
   configatron.name # => 'Mark Bates'
   configatron.set_default(:name, 'Me')
   configatron.name # => 'Mark Bates'
+</code></pre>
 
 Enjoy!
 
-==Contact
+h2. Contact
 
 Please mail bugs, suggestions and patches to "development@metabates.com":mailto:development@metabates.com
 

data/lib/configatron/configatron.rb

@@ -1,15 +1,30 @@
 require 'singleton'
+require 'logger'
 
 class Configatron
   include Singleton
 
   alias_method :send!, :send
+  
+  class << self
+    
+    def log
+      unless @logger
+        if defined?(::Rails)
+          @logger = ::Rails.logger
+        end
+        @logger = ::Logger.new(STDOUT) if @logger.nil?
+      end
+      return @logger
+    end
+    
+  end
 
   def initialize # :nodoc:
     @_namespace = [:default]
     reset!
   end
-
+  
   # Forwards the method call onto the 'namespaced' Configatron::Store
   def method_missing(sym, *args, &block)
     @_store[@_namespace.last].send(sym, *args, &block)

data/lib/configatron/store.rb

@@ -99,6 +99,7 @@ class Configatron
     # <tt>:hash</tt>, that indicates a specific hash that should be
     # loaded from the file.
     def configure_from_yaml(path, opts = {})
+      Configatron.log.warn "DEPRECATED! (configure_from_yaml) Please stop using YAML and use Ruby instead. This method will be removed in 2.9."
       begin
         yml = ::Yamler.load(path)
         yml = yml[opts[:hash]] unless opts[:hash].nil?
@@ -303,12 +304,12 @@ class Configatron
         options.each do |k,v|
           if v.is_a?(Hash)
             if v.keys.length == 1 && v.keys.first.is_a?(SYCK_CONSTANT)
-              self.method_missing("#{k.to_sym}=", v.values.first.flatten)
+              self.method_missing("#{k}=", v.values.first.flatten)
             else
               self.method_missing(k.to_sym).configure_from_hash(v)
             end
           else
-            self.method_missing("#{k.to_sym}=", v)
+            self.method_missing("#{k}=", v)
           end
         end
       else

metadata

@@ -2,7 +2,7 @@
 name: configatron
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.8.1
+  version: 2.8.2
 platform: ruby
 authors: 
 - markbates
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-17 00:00:00 -04:00
+date: 2011-06-28 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,7 +43,7 @@ files:
 - lib/configatron/rails.rb
 - lib/configatron/store.rb
 - lib/configatron.rb
-- README
+- README.textile
 - LICENSE
 - generators/configatron_generator.rb
 - generators/templates/configatron/cucumber.rb
@@ -66,7 +66,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -4517029793816815371
+      hash: 3677131604948269757
       segments: 
       - 0
       version: "0"