helpful_configuration 0.1.0

data/lib/helpful_configuration.rb

@@ -0,0 +1,66 @@
+class HelpfulConfiguration
+  attr_accessor :file
+
+  class ConfigurationMissingError < StandardError
+  end
+
+  def self.from_file(file, keys)
+    config = new
+    config.file = File.expand_path(file)
+    if File.exists?(file)
+      JSON.parse(File.read(file)).each do |key, value|
+        config[key] = value
+      end
+    end
+    config
+  end
+
+  def initialize(configuration = {}, file=nil)
+    @configuration = configuration
+    @explanation = {}
+    self.file = file
+  end
+
+  def [](key)
+    key = key.to_s
+    assert_explanation(key)
+    if @configuration.has_key?(key)
+      @configuration[key]
+    else
+      raise ConfigurationMissingError,
+        "configuration key '#{key}' is missing. "\
+        "it should be in the file '#{file}'. "\
+        "Explanation: #{@explanation[key]}"
+    end
+  end
+
+  def []=(key, value)
+    key = key.to_s
+    @configuration[key] = value
+  end
+
+  def explain(key, explanation)
+    key = key.to_s
+    @explanation[key] = explanation
+  end
+
+  def configured?(key)
+    assert_explanation(key)
+    @configuration.has_key?(key)
+  end
+
+  def with_default(default, key)
+    assert_explanation(key)
+    configured?(key) ? self[key] : default
+  end
+
+  private
+
+  def assert_explanation(key)
+    unless @explanation.has_key?(key)
+      raise "no explanation found for key #{key}. "\
+        "each configuration key must have an explanation. "\
+        "typo in the key name?"
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: helpful_configuration
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kristian Hanekamp
+- Infopark AG
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-22 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Configuration documenation library
+email: kristian.hanekamp@infopark.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/helpful_configuration.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: HelpfulConfiguration offers an easy way to provide helpful explanations for ruby applications that need to be configured.
+test_files: []
+