RubyGems - configatron - Versions diffs - 1.2.2 → 2.0.0 - Mend

configatron 1.2.2 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (37) hide show

data/README +61 -34
data/doc/classes/Configatron.html +241 -0
data/doc/classes/Configatron/ProtectedParameter.html +146 -0
data/doc/classes/Configatron/Store.html +241 -121
data/doc/classes/Kernel.html +13 -20
data/doc/created.rid +1 -1
data/doc/files/README.html +85 -43
data/doc/files/lib/configatron/{configuration_rb.html → configatron_rb.html} +11 -4
data/doc/files/lib/configatron/{helpers_rb.html → errors_rb.html} +4 -4
data/doc/files/lib/configatron/kernel_rb.html +1 -1
data/doc/files/lib/configatron/store_rb.html +1 -1
data/doc/files/lib/configatron_rb.html +1 -2
data/doc/fr_class_index.html +2 -4
data/doc/fr_file_index.html +2 -3
data/doc/fr_method_index.html +15 -21
data/lib/configatron.rb +5 -44
data/lib/configatron/configatron.rb +44 -0
data/lib/configatron/errors.rb +7 -0
data/lib/configatron/kernel.rb +3 -9
data/lib/configatron/store.rb +148 -56
data/spec/lib/configatron_spec.rb +293 -0
data/spec/lib/futurama.yml +6 -0
data/spec/spec_helper.rb +3 -2
metadata +11 -18
data/doc/classes/Configatron/Configuration.html +0 -402
data/doc/classes/Configatron/Helpers.html +0 -174
data/doc/classes/Configatron/YamlStore.html +0 -203
data/doc/classes/Hash.html +0 -193
data/doc/files/lib/configatron/yaml_store_rb.html +0 -101
data/lib/configatron/configuration.rb +0 -112
data/lib/configatron/helpers.rb +0 -27
data/lib/configatron/yaml_store.rb +0 -33
data/spec/unit/configuration_spec.rb +0 -299
data/spec/unit/family_guy.yml +0 -2
data/spec/unit/helpers_spec.rb +0 -115
data/spec/unit/kernel_spec.rb +0 -48
data/spec/unit/store_spec.rb +0 -91

data/doc/files/lib/configatron/yaml_store_rb.html DELETED

@@ -1,101 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <title>File: yaml_store.rb</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-    elemStyle = elem.style;
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-    return true;
-  }
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  // ]]>
-  </script>
-</head>
-<body>
-  <div id="fileHeader">
-    <h1>yaml_store.rb</h1>
-    <table class="header-table">
-    <tr class="top-aligned-row">
-      <td><strong>Path:</strong></td>
-      <td>lib/configatron/yaml_store.rb
-      </td>
-    </tr>
-    <tr class="top-aligned-row">
-      <td><strong>Last Update:</strong></td>
-      <td>Fri Sep 05 16:22:37 -0400 2008</td>
-    </tr>
-    </table>
-  </div>
-  <!-- banner header -->
-  <div id="bodyContent">
-  <div id="contextContent">
-   </div>
-  </div>
-    <!-- if includes -->
-    <div id="section">
-    <!-- if method_list -->
-  </div>
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-</body>
-</html>

data/lib/configatron/configuration.rb DELETED

@@ -1,112 +0,0 @@
-module Configatron
-  # The central class for managing the configurations.
-  class Configuration
-    include Singleton
-    include Configatron::Helpers
-    # If nil_for_missing is set to true nil will be returned if the configuration
-    # parameter doesn't exist. If set to false, default, then a NoMethodError exception
-    # will be raised.
-    attr_accessor :nil_for_missing
-    def initialize # :nodoc:
-      @_storage_list = []
-      @_nil_for_missing = false
-    end
-    # Yields a new Configatron::Store class.
-    def configure
-      storage = Configatron::Store.new
-      yield storage
-      unless storage.parameters.empty?
-        @_storage_list << storage
-        load_methods(storage)
-      end
-    end
-    # Used to load configuration settings from a Hash.
-    def configure_from_hash(parameters)
-      parameters = self.to_hash.recursive_merge(parameters)
-      storage = Configatron::Store.new(parameters)
-      @_storage_list << storage
-      load_methods(storage)
-    end
-    # Used to load configuration settings from a YAML file.
-    def configure_from_yaml(path)
-      begin
-        storage = Configatron::YamlStore.new(path)
-        @_storage_list << storage
-        load_methods(storage)
-      rescue Errno::ENOENT => e
-        puts e.message
-        # file doesn't exist.
-      end
-    end
-    # Replays the history of configurations.
-    def reload
-      @_storage_list.each do |storage|
-        storage.reload
-        load_methods(storage)
-      end
-    end
-    # Does a hard reset of the Configatron::Configuration class.
-    # All methods are undefined, the list of configuration parameters
-    # is emptied, and the nil_for_missing method gets reset to false.
-    def reset!
-      reset
-      self.nil_for_missing = false
-      @_storage_list = []
-    end
-    # All methods are undefined.
-    def reset
-      @_storage_list.each do |storage|
-        storage.parameters.each do |k,v|
-          Configatron::Configuration.instance_eval do
-            begin
-              undef_method(k)
-            rescue NameError => e
-            end
-          end
-        end
-      end
-    end
-    # Peels back n number of configuration parameters.
-    def revert(step = 1)
-      reset
-      step.times {@_storage_list.pop}
-      reload
-    end
-    def method_missing(sym, *args) # :nodoc:
-      handle_missing_parameter(sym)
-    end
-    def to_hash
-      @_storage_list.inject({}) { |acc, storage| acc.merge(storage.to_hash) }
-    end
-    private
-    def load_methods(store)
-      store.parameters.each do |k,v|
-        if k.is_a?(Configatron::Store)
-          load_methods(k)
-        else
-          if v.is_a?(Hash)
-            v = (store.parameters[k] = Configatron::Store.new(v))
-          end
-          Configatron::Configuration.instance_eval do
-            define_method(k) do
-              v
-            end
-          end
-        end
-      end
-    end
-  end # Configuration
-end # Configatron

data/lib/configatron/helpers.rb DELETED

@@ -1,27 +0,0 @@
-module Configatron
-  module Helpers
-    # Checks whether or not configuration parameter exists.
-    def exists?(name)
-      self.respond_to?(name)
-    end
-    def handle_missing_parameter(param) # :nodoc:
-      if configatron.nil_for_missing
-        return nil
-      else
-        raise NoMethodError.new(param.to_s)
-      end
-    end
-    # Retrieves the specified config parameter. An optional second
-    # parameter can be passed that will be returned if the config
-    # parameter doesn't exist.
-    def retrieve(name, default_value = ArgumentError)
-      return self.send(name) if exists?(name)
-      return default_value unless default_value == ArgumentError
-      handle_missing_parameter(name)
-    end
-  end # Helpers
-end # Configatron

data/lib/configatron/yaml_store.rb DELETED

@@ -1,33 +0,0 @@
-require File.join(File.dirname(__FILE__), 'store')
-module Configatron
-  # Used to store each of the 'sets' of configuration parameters that came from a YAML file.
-  class YamlStore < Configatron::Store
-    attr_accessor :file_location
-    # Takes the full path to the YAML file.
-    def initialize(file_location)
-      super(params_from_yaml(file_location))
-      @file_location = file_location
-    end
-    # Re-reads the YAML file.
-    def reload
-      if self.file_location
-        params_from_yaml(self.file_location)
-      end
-    end
-    private
-    def params_from_yaml(file_location)
-      begin
-        @parameters = YAML.load(File.read(file_location))
-        return @parameters
-      rescue Errno::ENOENT => e
-        puts e
-      end
-      return {}
-    end
-  end
-end

data/spec/unit/configuration_spec.rb DELETED

@@ -1,299 +0,0 @@
-require 'fileutils'
-require 'pathname'
-require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
-describe Configatron::Configuration do
-  before :each do
-    configatron.reset!
-  end
-  it "should be a Singleton" do
-    lambda{Configatron::Configuration.new}.should raise_error(NoMethodError)
-    Configatron::Configuration.instance.should == Configatron::Configuration.instance
-  end
-  describe "configure_from_hash" do
-    it "should take a Hash with the same outcome as the configure method" do
-      configatron.should_not respond_to(:bart)
-      configatron.should_not respond_to(:homer)
-      configatron.configure_from_hash(:bart => "Bart Simpson", "homer" => "Homer Simpson")
-      configatron.should respond_to(:bart)
-      configatron.should respond_to(:homer)
-      configatron.bart.should == "Bart Simpson"
-      configatron.homer.should == "Homer Simpson"
-    end
-    it "doesn't wipe out existing configurations" do
-      configatron do |c|
-        c.namespace(:mack) do |mack|
-          mack.one = 1
-          mack.two = 2
-          mack.three = 3
-        end
-        c.a = 'a'
-        c.b = 'b'
-      end
-      configatron.to_hash.should == {:mack => {:one => 1, :two => 2, :three => 3}, :a => 'a', :b => 'b'}
-      configatron.configure_from_hash(:mack => {:one => 'one'}, :b => 'bee')
-      configatron.to_hash.should == {:mack => {:one => 'one', :two => 2, :three => 3}, :a => 'a', :b => 'bee'}
-      configatron.revert
-      configatron.to_hash.should == {:mack => {:one => 1, :two => 2, :three => 3}, :a => 'a', :b => 'b'}
-    end
-  end
-  describe "hashes to namespace" do
-    before :each do
-      configatron.reset!
-      @futurama = File.join(File.dirname(__FILE__), 'futurama.yml')
-      FileUtils.rm_f(@futurama)
-    end
-    after :each do
-      FileUtils.rm_f(@futurama)
-    end
-    it "should namespace hashes from yaml" do
-      configatron.should_not respond_to(:cartoon)
-      File.open(@futurama, 'w') do |f|
-        f.puts %{
-cartoon:
-  characters:
-    fry: human
-    leela: mutant
-    bender: robot
-  transportation: space ship
-  fans:
-    one: Mark Bates
-    two: Dylan Bates
-        }
-      end
-      configatron.configure_from_yaml(@futurama)
-      configatron.should respond_to(:cartoon)
-      configatron.cartoon.should be_an_instance_of(Configatron::Store)
-      configatron.cartoon.characters.fry.should == 'human'
-      configatron.cartoon.transportation.should == 'space ship'
-    end
-    it "should namespace hashes" do
-      configatron.should_not respond_to(:cartoon)
-      configatron.configure_from_hash({:cartoon => {:characters => {:fry => 'human', :leela => 'mutant', :bender => 'robot'}, :transportation => 'space ship'}, :fans => {:one => 'Mark Bates', :two => 'Dylan Bates'}})
-      configatron.should respond_to(:cartoon)
-      configatron.cartoon.should be_an_instance_of(Configatron::Store)
-      configatron.cartoon.characters.fry.should == 'human'
-      configatron.cartoon.transportation.should == 'space ship'
-    end
-  end
-  describe "configure_from_yaml" do
-    before :each do
-      configatron.reset!
-      @futurama = File.join(File.dirname(__FILE__), 'futurama.yml')
-      FileUtils.rm_f(@futurama)
-    end
-    after :each do
-      FileUtils.rm_f(@futurama)
-    end
-    it "should take a path to YAML file and use it configure configatron" do
-      configatron.should_not respond_to(:family_guy)
-      configatron.should_not respond_to(:lois)
-      configatron.configure_from_yaml(File.join(File.dirname(__FILE__), 'family_guy.yml'))
-      configatron.should respond_to(:family_guy)
-      configatron.should respond_to(:lois)
-      configatron.family_guy.should == "Peter Griffin"
-      configatron.lois.should == "Lois Griffin"
-    end
-    it "should silently fail if the file doesn't exist" do
-      lambda {configatron.configure_from_yaml(File.join(File.dirname(__FILE__), 'i_dont_exist.yml'))}.should_not raise_error(Errno::ENOENT)
-    end
-    it "should re-read the file during a reload" do
-      File.open(@futurama, 'w') do |f|
-        f.puts 'bender: robot'
-        f.puts 'fry: human'
-      end
-      configatron.should_not respond_to(:bender)
-      configatron.should_not respond_to(:fry)
-      configatron.configure_from_yaml(@futurama)
-      configatron.should respond_to(:bender)
-      configatron.should respond_to(:fry)
-      configatron.bender.should == 'robot'
-      configatron.fry.should == 'human'
-      File.open(@futurama, 'w') do |f|
-        f.puts 'bender: Bending Robot'
-        f.puts 'fry: Human Male'
-      end
-      configatron.reload
-      configatron.bender.should == 'Bending Robot'
-      configatron.fry.should == 'Human Male'
-    end
-  end
-  describe "revert" do
-    it "should roll back 1 level by default" do
-      configatron.should_not respond_to(:bart)
-      configatron.should_not respond_to(:homer)
-      configatron do |config|
-        config.bart = "Bart Simpson"
-      end
-      configatron do |config|
-        config.homer = "Homer Simpson"
-      end
-      configatron.should respond_to(:bart)
-      configatron.should respond_to(:homer)
-      configatron.bart.should == "Bart Simpson"
-      configatron.homer.should == "Homer Simpson"
-      configatron.revert
-      configatron.should respond_to(:bart)
-      configatron.should_not respond_to(:homer)
-      configatron.bart.should == "Bart Simpson"
-      lambda{configatron.homer}.should raise_error(NoMethodError)
-    end
-    it "should roll back n levels if specified" do
-      configatron.should_not respond_to(:bart)
-      configatron.should_not respond_to(:homer)
-      configatron do |config|
-        config.bart = "Bart Simpson"
-      end
-      configatron do |config|
-        config.homer = "Homer Simpson"
-      end
-      configatron.should respond_to(:bart)
-      configatron.should respond_to(:homer)
-      configatron.bart.should == "Bart Simpson"
-      configatron.homer.should == "Homer Simpson"
-      configatron.revert(2)
-      configatron.should_not respond_to(:bart)
-      configatron.should_not respond_to(:homer)
-      lambda{configatron.bart}.should raise_error(NoMethodError)
-      lambda{configatron.homer}.should raise_error(NoMethodError)
-    end
-  end
-  describe "reset" do
-    it "should remove all added methods" do
-      configatron.should_not respond_to(:rst1)
-      configatron.should_not respond_to(:rst2)
-      configatron.nil_for_missing.should == false
-      configatron do |config|
-        config.rst1 = "RST1"
-        config.rst2 = "RST2"
-      end
-      configatron.should respond_to(:rst1)
-      configatron.should respond_to(:rst2)
-      configatron.nil_for_missing = true
-      configatron.nil_for_missing.should == true
-      configatron.reset
-      configatron.nil_for_missing.should == true
-      configatron.should_not respond_to(:rst1)
-      configatron.should_not respond_to(:rst2)
-    end
-  end
-  describe "reset!" do
-    it "should remove all added methods and revert the nil_for_missing setting" do
-      configatron.should_not respond_to(:rst1)
-      configatron.should_not respond_to(:rst2)
-      configatron.nil_for_missing.should == false
-      configatron do |config|
-        config.rst1 = "RST1"
-        config.rst2 = "RST2"
-      end
-      configatron.should respond_to(:rst1)
-      configatron.should respond_to(:rst2)
-      configatron.nil_for_missing = true
-      configatron.nil_for_missing.should == true
-      configatron.reset!
-      configatron.nil_for_missing.should == false
-      configatron.should_not respond_to(:rst1)
-      configatron.should_not respond_to(:rst2)
-    end
-  end
-  describe 'to_hash' do
-    it "should convert entire configuration to a hash" do
-      hash = {:foo => 'bar', :baz => {:quux => 'foobar'}}
-      configatron.configure_from_hash(hash)
-      configatron.to_hash.should == hash
-    end
-    it 'should convert the configration with multiple calls to configure' do
-      hash1 = {:foo => 'bar', :baz => {:quux => 'foobar'}}
-      hash2 = {:foo => 'notbar', :beep => 'boop'}
-      configatron.configure_from_hash(hash1)
-      configatron.configure_from_hash(hash2)
-      configatron.to_hash.should == hash1.merge(hash2)
-    end
-  end
-end