dacs 0.2.0 → 0.3.0

data/History.txt

@@ -1,3 +1,10 @@
+== 0.3.0 2010-01-14
+   * Minor enhancements
+     * When an explicit schema is defined (using DSL):
+       * Will warn and exit when required keys are not configured
+       * Will raise an error when an undefined key is referenced
+     * New #report method added to dump a full configuration report
+
 == 0.2.0 2010-01-13
    * Major enhancements
      * Added new mini-DSL for defining known configuration keys

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/example/example.rb

@@ -17,9 +17,10 @@ puts "foo: #{Dacs::AppConfig['foo']}"
 puts "bar: #{Dacs::AppConfig['bar']}"
 puts "baz: #{Dacs::AppConfig['baz']}"
 puts Dacs::AppConfig.dump             # => nil
+puts Dacs::AppConfig.report           # => nil
 
-# >> I, [2010-02-13T02:34:46.344705 #25573]  INFO -- : Found config file /devver-repos/dacs/example/example.yml.
-# >> W, [2010-02-13T02:34:46.345300 #25573]  WARN -- : Unknown configuration key 'fuz' in file example.yml
+# >> I, [2010-02-14T09:45:52.703585 #17437]  INFO -- : Found config file /devver-repos/dacs/example/example.yml.
+# >> W, [2010-02-14T09:45:52.704092 #17437]  WARN -- : Unknown configuration key 'fuz' in file example.yml
 # >> Running in development mode
 # >> foo: file_foo
 # >> bar: env_bar
@@ -31,3 +32,15 @@ puts Dacs::AppConfig.dump             # => nil
 # >> | foo | file_foo    | file example.yml |
 # >> | bar | env_bar     | environment      |
 # >> +--------------------------------------+
+# >> App name:             example
+# >> Environment:          development
+# >> Configuration file:   /devver-repos/dacs/example/example.yml
+# >> Configuration setup:  -:5
+# >> Env var prefix:       EXAMPLE_
+# >> +--------------------------------------+
+# >> | Key |    Value    |      Source      |
+# >> +--------------------------------------+
+# >> | baz | default_baz | defaults         |
+# >> | foo | file_foo    | file example.yml |
+# >> | bar | env_bar     | environment      |
+# >> +--------------------------------------+

data/lib/dacs/app_config.rb

@@ -41,7 +41,7 @@ module Dacs
 
       # Delegate a subset of Hash methods to the singleton instance
       def_delegators :instance, :[], :fetch, :key?, :merge, :merge!, :app_name,
-                                :source, :dump
+                                :source, :dump, :report
 
       def_delegators :schema, :required?, :optional?, :keys, :default_value
     end
@@ -64,6 +64,7 @@ module Dacs
       @@options[:logger]       ||= ::Logger.new($stderr)
       @@options[:environment]  ||= :development
       @@options[:defaults]     ||= {}
+      @@definition_location    = caller[0]
       if block_given?
         schema = Schema.new
         yield(schema)
@@ -85,6 +86,10 @@ module Dacs
     def self.environment
       @@options[:environment]
     end
+
+    def self.definition_location
+      @@definition_location
+    end
     
     attr_reader :app_name
     attr_reader :logger
@@ -98,27 +103,37 @@ module Dacs
       @logger       = @@options[:logger]
       @environment  = @@options[:environment]
       @defaults     = self.class.schema.defaults 
+      @system       = @@options.fetch(:system){Kernel}
       find_or_create_config_file!
 
       defaults_source = DefaultSource.new(@defaults)
       file_source     = FileSource.new(config_path, @environment)
-      env_source      = EnvironmentSource.new(@app_name)
+      env_source      = EnvironmentSource.new(env_var_prefix)
 
       load_values!(self.class.schema, env_source, file_source, defaults_source)
+      verify_no_missing_required_values!
+    end
+
+    def definition_location
+      self.class.definition_location
+    end
+
+    def env_var_prefix
+      app_name.to_s.upcase + "_"
     end
 
     def source(key)
-      configured_value = Hash.instance_method(:fetch).bind(self).call(key.to_s) do
-        raise ConfigurationError, "No such key '#{key}'"
-      end
+      assert_key_defined!(key)
       configured_value.source.to_s
     end
 
     def [](key)
+      assert_key_defined!(key)
       super(key).value
     end
 
     def fetch(key, &block)
+      assert_key_defined!(key)
       case result = super(key, &block)
       when ConfiguredValue then result.value
       else result
@@ -133,8 +148,45 @@ module Dacs
       table.as(:text)
     end
 
+    def report
+      text = ""
+      text << "%-22s%s\n" % ["App name:",           app_name]
+      text << "%-22s%s\n" % ["Environment:",        environment]
+      text << "%-22s%s\n" % ["Configuration file:", config_path]
+      text << "%-22s%s\n" % ["Configuration setup:", definition_location]
+      text << "%-22s%s\n" % ["Env var prefix:", env_var_prefix]
+      text << dump
+      text
+    end
+
+    def verify_no_missing_required_values!
+      missing_keys = schema.keys - keys
+      missing_required_keys = missing_keys.select{|k| schema.required?(k)}
+      unless missing_required_keys.empty?
+        logger.fatal "Application not configured; exiting"
+        @system.warn "These required configuration keys were missing:"
+        missing_required_keys.each do |key|
+          @system.warn "    #{key}"
+        end
+        @system.warn ""
+        @system.warn "Please set the required keys in #{config_path} or "\
+          "environment and try again."
+        @system.exit(1)
+      end
+    end
+
     private
 
+    def assert_key_defined!(key)
+      unless schema.defined?(key.to_s)
+        raise UndefinedKeyError, key, caller(3)
+      end
+    end
+
+    def schema
+      self.class.schema
+    end
+
     def find_or_create_config_file!
       if Pathname(config_path).exist?
         logger.info "Found config file #{config_path}."
@@ -174,8 +226,8 @@ END
     def load_values!(schema, *sources)
       sources.reverse_each do |source|
         source.each do |configured_value|
-          if schema.defined?(configured_value.key)
-            self[configured_value.key] = configured_value
+          if schema.defined?(configured_value.key.to_s)
+            self[configured_value.key.to_s] = configured_value
           else
             key = configured_value.key
             logger.warn "Unknown configuration key '#{key}' in #{source}"

data/lib/dacs/environment_source.rb

@@ -1,7 +1,7 @@
 module Dacs
   class EnvironmentSource
-    def initialize(app_name, environment=ENV)
-      @app_name    = app_name.to_s.downcase
+    def initialize(prefix, environment=ENV)
+      @prefix      = prefix
       @environment = environment
     end
     
@@ -11,7 +11,7 @@ module Dacs
 
     def each
       @environment.each_pair do |key, value|
-        if match = /^#{@app_name}_(.*)$/.match(key.downcase)
+        if match = /^#{@prefix.downcase}(.*)$/.match(key.downcase)
           yield ConfiguredValue.new(self, match[1], value)
         end
       end

data/lib/dacs/errors.rb

@@ -1,3 +1,8 @@
 module Dacs
   ConfigurationError = Class.new(Exception)
+  class UndefinedKeyError < ConfigurationError
+    def initialize(key)
+      super("Unknown configuration key '#{key}'")
+    end
+  end
 end

data/lib/dacs/schema.rb

@@ -31,7 +31,7 @@ module Dacs
 
     def defaults
       key_defs.inject({}) { |h, key_def|
-        h[key_def[:name]] = key_def[:default]
+        h[key_def[:name]] = key_def[:default] if key_def.key?(:default)
         h
       }
     end
@@ -39,7 +39,7 @@ module Dacs
     private
 
     def assert_key_defined!(key)
-      !!key_def(key) or raise ConfigurationError, "No configuration key '#{key}' is defined"
+      !!key_def(key) or raise UndefinedKeyError, key
     end
 
     def key_defs

data/spec/dacs/app_config_spec.rb

@@ -59,6 +59,31 @@ module Dacs
       end
     end
 
+    context "given strict definitions and a missing required key" do
+      before :each do
+        @system = stub("system").as_null_object
+      end
+
+      def do_init
+        AppConfig.init!(@app_name, :logger => @logger, :system => @system) do |config|
+          config.key "foo"
+          config.key "bar"
+        end
+      end
+      
+      it "should exit the program with an error status" do
+        @system.should_receive(:exit).with(1)
+        do_init
+      end
+
+      it "should warn the user about the missing config keys" do
+        @system.should_receive(:warn).with(/foo/)
+        @system.should_receive(:warn).with(/bar/)
+        @system.should_receive(:warn).any_number_of_times
+        do_init
+      end
+    end
+
     context "without explicit key definitions" do
       before :each do
         AppConfig.init!(@app_name, 
@@ -91,12 +116,18 @@ module Dacs
 
     context "with explicit key definitions" do
       before :each do
+        ENV['FOO_APP_BAR'] = 'env_bar'
+        @def_line = __LINE__ + 1
         AppConfig.init!(@app_name, :logger => @logger) do |config|
           config.key :foo, :default => 42
           config.key 'bar'
         end
       end
 
+      after :each do
+        ENV.delete('FOO_APP_BAR')
+      end
+
       it "should be able to list known keys" do
         AppConfig.keys.should == ['foo', 'bar']
       end
@@ -115,6 +146,25 @@ module Dacs
         AppConfig.optional?(:foo).should be_true
       end
 
+      it "should raise an exception when an undefined key is referenced" do
+        lambda do
+          AppConfig['faz']
+        end.should raise_error(ConfigurationError)
+      end
+
+      it "should reference the offending line when an undefined key is referenced" do
+        @error_line = __LINE__ + 2
+        error = begin
+                  AppConfig['faz']
+                rescue ConfigurationError => error
+                  error
+                end
+        error.backtrace[0].should match(/#{__FILE__}:#{@error_line}/)
+      end
+
+      it "should remember where the keys were defined" do
+        AppConfig.definition_location.should match(/#{__FILE__}:#{@def_line}/)
+      end
     end
 
     context "with a mix of default, file, and environment settings" do
@@ -136,6 +186,10 @@ module Dacs
         end
       end
 
+      after :each do
+        ENV.delete('FOO_APP_BUZ')
+      end
+
       it "should have the correct values for each" do
         AppConfig['foo'].should be == 42
         AppConfig['bar'].should be == 'file_bar'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dacs
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Devver, Inc.
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-13 00:00:00 -05:00
+date: 2010-02-14 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency