configatron 2.13.0 → 3.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 726b6ffdc130933ec1a38572f833537dd560c343
+  data.tar.gz: 2e905aedd57354e7bbda54a5e450d2288ac00493
+SHA512:
+  metadata.gz: 19ec11d3152a002763a48ce31ad2eaf63b1413c991d4e50116d60298ca042e870065f86118266c6def811cbe2554dda330ca269cf4637eaa39f938c93fe098fb
+  data.tar.gz: f4dddffa04bbad1beb942302ca9366e47b6db9f7fbe53e96b402aa01bdcd6b1e0dfe6e29574c7da3e15223d200fcbcec1e4ae99477db8fe36da216171a23fda2

data/.rvmrc

@@ -1,2 +1 @@
-# rvm use ruby-2.0.0-preview1
 rvm use 2.0.0

data/.travis.yml

@@ -1,6 +1,9 @@
 language: ruby
 rvm:
+  - 1.9.2
   - 1.9.3
-  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
 
-script: bundle exec rspec
+script: bundle exec rake

data/Gemfile

@@ -4,4 +4,8 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake'
-gem 'rspec'
+gem "minitest-colorize"
+gem "terminal-notifier-guard"
+gem 'rb-fsevent'
+gem "guard"
+gem 'guard-minitest'

data/Gemfile.lock

@@ -1,28 +1,45 @@
 PATH
   remote: .
   specs:
-    configatron (2.13.0)
-      yamler (>= 0.1.0)
+    configatron (3.0.0.rc1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.1.3)
+    coderay (1.0.8)
+    guard (1.6.2)
+      listen (>= 0.6.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      terminal-table (>= 1.4.3)
+      thor (>= 0.14.6)
+    guard-minitest (0.5.0)
+      guard (>= 0.4)
+    listen (0.7.2)
+    lumberjack (1.0.2)
+    method_source (0.8.1)
+    minitest (2.12.1)
+    minitest-colorize (0.0.4)
+      minitest (~> 2.0)
+    pry (0.9.11.4)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
     rake (0.9.2.2)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
-    yamler (0.1.0)
+    rb-fsevent (0.9.3)
+    slop (3.4.3)
+    terminal-notifier-guard (1.5.3)
+    terminal-table (1.4.5)
+    thor (0.17.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   configatron!
+  guard
+  guard-minitest
+  minitest-colorize
   rake
-  rspec
+  rb-fsevent
+  terminal-notifier-guard

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'minitest' do
+  # with Minitest::Unit
+  watch(%r|^test/(.*)\/?(.*)_test\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch(%r|^test/test_helper\.rb|)    { "test" }
+
+  # with Minitest::Spec
+  # watch(%r|^spec/(.*)_spec\.rb|)
+  # watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  # watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+
+  # Rails 3.2
+  # watch(%r|^app/controllers/(.*)\.rb|) { |m| "test/controllers/#{m[1]}_test.rb" }
+  # watch(%r|^app/helpers/(.*)\.rb|)     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r|^app/models/(.*)\.rb|)      { |m| "test/unit/#{m[1]}_test.rb" }  
+  
+  # Rails
+  # watch(%r|^app/controllers/(.*)\.rb|) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r|^app/helpers/(.*)\.rb|)     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r|^app/models/(.*)\.rb|)      { |m| "test/unit/#{m[1]}_test.rb" }  
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mark Bates
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,222 +1,232 @@
-# Configatron [![Build Status](https://travis-ci.org/markbates/configatron.png?branch=master)](https://travis-ci.org/markbates/configatron)
+# 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!
 
+## IMPORTANT NOTES ON V3
+
+V3 is still a work in progress. It is also a complete rewrite of the library. Because V3 is a rewrite there is a lot that has been thrown out, modified, etc... There is a good chance that some feature or method that you were using doesn't exist, or works differently now. Hopefully you'll find these changes for the best. If not, you know how to submit a Pull Request. :)
+
+One of the more important changes to V3 is that it now resembles more a `Hash` style interface. You can use `[]`, `fetch`, `each`, etc...
+
 ## Installation
 
-Installation of Configatron is easy, as it is just a RubyGem:
+Add this line to your application's Gemfile:
 
 ```ruby
-  $ sudo gem install configatron
+gem 'configatron', '3.0.0.rc1'
 ```
 
-If you'd like to live on the bleedin' edge you can install the development version from GitHub:
+And then execute:
 
+```bash
+$ bundle
 ```
-  $ sudo gem install markbates-configatron --source=http://gems.github.com
+
+Or install it yourself as:
+
+```bash
+$ gem install configatron --pre
 ```
 
+## Usage
+
 Once installed you just need to require it:
 
 ```ruby
-  require 'configatron'
+require 'configatron'
 ```
 
-## Examples
-
 ### Simple
 
 ```ruby
-  configatron.email = 'me@example.com'
-  configatron.database_url = "postgres://localhost/mack_framework_rocks"
+configatron.email = 'me@example.com'
+configatron.database.url = "postgres://localhost/foo"
 ```
 
 Now, anywhere in your code you can do the following:
 
 ```ruby
-  configatron.email # => "me@example.com"
-  configatron.database_url # => "postgres://localhost/mack_framework_rocks"
+configatron.email # => "me@example.com"
+configatron.database.url # => "postgres://localhost/foo"
 ```
 
 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 @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:
+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/foo@. 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:
 
 ```ruby
-  configatron.database_url = "postgres://localhost/mack_framework_rocks_development"
+configatron.database.url = "postgres://localhost/foo_development"
 ```
 
 becomes:
 
 ```ruby
-  configatron.email # => "me@example.com"
-  configatron.database_url # => "postgres://localhost/mack_framework_rocks_development"
+configatron.email # => "me@example.com"
+configatron.database.url # => "postgres://localhost/foo_development"
 ```
 
 Notice how our other configuration parameters haven't changed? Cool, eh?
 
 ### Hash/YAML
 
-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):
+You can configure Configatron from a hash as well (this is really only useful in testing or for data driven configuration, it's not recommended for actual configuration):
 
 ```ruby
-  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...
+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...
 ```
 
 #### YAML
 
-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?
+YAML is terrible and should be driven from the face of the Earth. Because of this Configatron V3 does not support it. Sorry.
 
 ### 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.
 
 ```ruby
-  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
+configatron.website_url = "http://www.example.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
+
+configatron.to_h # => {:website_url=>"http://www.example.com", :email=>{:pop=>{:address=>"pop.example.com", :port=>110}, :smtp=>{:address=>"smtp.example.com", :port=>25}}}
 ```
 
-becomes:
+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:
 
 ```ruby
-  configatron.email.pop.address # => "pop.example.com"
-  configatron.email.smtp.address # => "smtp.example.com"
-  configatron.website_url # => "http://www.mackframework.com"
+configatron.email.pop.address = "pop2.example.com"
+
+configatron.email.pop.address # => "pop2.example.com"
+configatron.email.smtp.address # => "smtp.example.com"
 ```
-####onfigatron 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:
+Configatron will also let you use a block to clean up your configuration. For example the following two ways of setting values are equivalent:
 
 ```ruby
-  configatron.email.pop.address = "pop2.example.com"
+configatron.email.pop.address = "pop.example.com"
+configatron.email.pop.port = 110
 
-  configatron.email.pop.address # => "pop2.example.com"
-  configatron.email.smtp.address # => "smtp.example.com"
+configatron.email.pop do |pop|
+  pop.address = "pop.example.com"
+  pop.port = 110
+end
 ```
 
 ### Temp Configurations
 
-Sometimes in testing, or other situations, you want to temporarily change some settings. You can do this with the @temp@ method:
+Sometimes in testing, or other situations, you want to temporarily change some settings. You can do this with the `temp` method:
 
 ```ruby
-  configatron.one = 1
-  configatron.letters.a = 'A'
-  configatron.letters.b = 'B'
-  configatron.temp do
-    configatron.letters.b = 'bb'
-    configatron.letters.c = 'c'
-    configatron.one # => 1
-    configatron.letters.a # => 'A'
-    configatron.letters.b # => 'bb'
-    configatron.letters.c # => 'c'
-  end
+configatron.one = 1
+configatron.letters.a = 'A'
+configatron.letters.b = 'B'
+configatron.temp do
+  configatron.letters.b = 'bb'
+  configatron.letters.c = 'c'
   configatron.one # => 1
   configatron.letters.a # => 'A'
-  configatron.letters.b # => 'B'
-  configatron.letters.c # => nil
+  configatron.letters.b # => 'bb'
+  configatron.letters.c # => 'c'
+end
+configatron.one # => 1
+configatron.letters.a # => 'A'
+configatron.letters.b # => 'B'
+configatron.letters.c # => {}
 ```
 
-You can also pass in an optional Hash to the @temp@:
+### nil
+
+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?` or `.blank?` if there are no parameters configured on it.
 
 ```ruby
-  configatron.one = 1
-  configatron.letters.a = 'A'
-  configatron.letters.b = 'B'
-  configatron.temp(:letters => {:b => 'bb', :c => 'c'}) do
- ####one == 1
-    configatron.letters.a # => 'A'
-    configatron.letters.b # => 'bb'
-    configatron.letters.c # => 'c'
-  end
-  configatron.one == 1
-  configatron.letters.a # => 'A'
-  configatron.letters.b # => 'B'
-  configatron.letters.c # => nil
+configatron.i.dont.exist.nil? # => true
+configatron.i.dont.exist.blank? # => true
+configatron.i.dont.exist # => Configatron::Store
 ```
 
-### 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:
+You can use `.has_key?` to determine if a key already exists.
 
 ```ruby
-  configatron.memcached.servers = ['127.0.0.1:11211']
-  configatron.page_caching.servers = configatron.memcached.servers
-  configatron.object_caching.servers = configatron.memcached.servers
-
-  if Rails.env == 'production'
-    configatron.memcached.servers = ['192.168.0.1:11211']
-    configatron.page_caching.servers = configatron.memcached.servers
-    configatron.object_caching.servers = configatron.memcached.servers
-  elsif Rails.env == 'staging'
-    configatron.memcached.servers = ['192.168.0.2:11211']
-    configatron.page_caching.servers = configatron.memcached.servers
-    configatron.object_caching.servers = configatron.memcached.servers
-  end
+configatron.i.dont.has_key?(:exist) # => false
 ```
 
-Now, we could've written that slightly differently, but it helps to illustrate the point. With Configatron you can create `Delayed` and `Dynamic` settings.
+### Kernel
 
-#### Delayed
+The `configatron` "helper" method is store in the `Kernel` module. Some people didn't like that in the V2 of Configatron, so in V3, while that hasn't changed, you don't have to use it.
 
-With `Delayed` settings execution of the setting doesn't happen until the first time it is executed.
+Instead of requiring `configatron` simply require `configatron/core`, but then you'll have to set up your own `Configatron::Store` object.
+
+Example:
 
 ```ruby
-  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}
+require 'configatron/core'
+
+store = Configatron::Store.new
+store.foo = 'FOO'
 
-  if Rails.env == 'production'
-    configatron.memcached.servers = ['192.168.0.1:11211']
-  elsif Rails.env == 'staging'
-    configatron.memcached.servers = ['192.168.0.2:11211']
-  end
+store.to_h #= {foo: 'FOO'}
 ```
 
-Execution occurs once and after that the result of that execution is returned. So in our case the first time someone calls the setting `configatron.page_caching.servers` it will find the `configatron.memcached.servers` setting and return that. After that point if the `configatron.memcached.servers` setting is changed, the original settings are returned by `configatron.page_caching.servers`.
+### Locking
 
-#### Dynamic
+Once you have setup all of your configurations you can call the `lock!` method to lock your settings and raise an error should anyone try to change settings or access an unset setting later.
 
-`Dynamic` settings are very similar to `Delayed` settings, but with one big difference. Every time you call a `Dynamic` setting is executed. Take this example:
+Example:
 
 ```ruby
-  configatron.current.time = Configatron::Dynamic.new {Time.now}
-```
+configatron.foo = 'FOO'
+configatron.lock!
 
-Each time you call `configatron.current.time` it will return a new value to you. While this seems a bit useless, it is pretty useful if you have ever changing configurations.
+configatron.foo # => 'FOO'
 
-### Misc.
+configatron.bar # => raises Configatron::UndefinedKeyError
+configatron.bar = 'BAR' # => raises Configatron::LockedError
+```
 
-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.
+## Rails
 
-```ruby
-  configatron.i.dont.exist.nil? # => true
-  configatron.i.dont.exist # => Configatron::Store
+Configatron works great with Rails. Use the built-in generate to generate an initializer file and a series of environment files for you to use to configure your applications.
+
+``` bash
+$ rails generate configatron:install
 ```
 
-If you want to get back an actual @nil@ then you can use the @retrieve@ method:
+Configatron will read in the `config/configatron/defaults.rb` file first and then the environment specific file, such as `config/configatron/development.rb`. Settings in the environment file will merge into and replace the settings in the `defaults.rb` file.
+
+### Example
 
 ```ruby
-  configatron.i.do.exist = [:some, :array]
-  configatron.i.dont.retrieve(:exist, nil) # => nil
-  configatron.i.do.retrieve(:exist, :foo) # => [:some, :array]
+# config/configatron/defaults.rb
+configatron.letters.a = 'A'
+configatron.letters.b = 'B'
 ```
 
-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.
+```ruby
+# config/configatron/development.rb
+configatron.letters.b = 'BB'
+configatron.letters.c = 'C'
+```
 
 ```ruby
-  configatron.set_default(:name, 'Mark Bates')
-  configatron.name # => 'Mark Bates'
-  configatron.set_default(:name, 'Me')
-  configatron.name # => 'Mark Bates'
+configatron.to_h # => {:letters=>{:a=>"A", :b=>"BB", :c=>"C"}}
 ```
 
-Enjoy!
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write Tests!
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
 
 ## Contributors
 

data/Rakefile

@@ -1,7 +1,9 @@
-require 'bundler'  
+require 'bundler'
+require 'rake/testtask'
+
 Bundler::GemHelper.install_tasks
 
-desc "Run tests"
-task :default do
-  system "bundle exec rspec"
+Rake::TestTask.new(:default) do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
 end