yaml_configuration 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in yaml_config.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.test_files = FileList['tests/**/*_tests.rb']
+  t.verbose = true
+end

data/lib/yaml_configuration.rb

@@ -0,0 +1,10 @@
+require "yaml_configuration/version"
+require 'bundler/setup'
+
+require_relative 'yaml_configuration/configuration'
+
+module YamlConfiguration
+  def self.load(*config_files)
+    Loader.new.load(config_files)
+  end
+end

data/lib/yaml_configuration/configuration.rb

@@ -0,0 +1,47 @@
+module YamlConfiguration
+  class Configuration
+    def initialize(hash_configuration, parent=nil, name=nil)
+      @config = hash_configuration
+      @name = name
+      @parent = parent
+    end
+
+    def full_name(setting_name)
+      (hierarchy + [setting_name]).join('.')
+    end
+
+    def hierarchy
+      return @parent.hierarchy + [@name] unless @parent.nil?
+      []
+    end
+
+    def method_missing(method, *args, &block)
+      method_name = method.to_s
+      if asking_if_setting_exist(method_name)
+        setting_exist?(method_name)
+      elsif setting_exist?(method_name)
+        return_value_of_setting(method_name)
+      else
+        raise "The setting '#{full_name(method_name)}' is not present in the configuration"
+      end
+    end
+
+    private
+    def asking_if_setting_exist(setting_name)
+      setting_name =~ /^(.*)+\?$/
+    end
+
+    def setting_exist?(setting_name)
+      @config.keys.include?(setting_name.gsub('?', ''))
+    end
+
+    def return_value_of_setting(setting_name)
+      value = @config[setting_name]
+      if value.respond_to?(:keys)
+        return Configuration.new(value, self, setting_name)
+      else
+        return value
+      end
+    end
+  end
+end

data/lib/yaml_configuration/loader.rb

@@ -0,0 +1,27 @@
+module YamlConfiguration
+  class Loader
+    def load(*config_files)
+      combined_configuration = {}
+      config_files.each do |config_file|
+        loaded_config = load_yaml_config(config_file)
+        combined_configuration.deep_merge(loaded_config)
+      end
+      Configuration.new(combined_configuration)
+    end
+
+    private
+    def load_yaml_config(*path)
+      full_path = File.expand_path(File.join(*path) + '.yml')
+      if File.file?(full_path)
+        config = YAML.load(File.read(full_path))
+        raise "The file '#{full_path}' is an invalid yaml config" unless config.respond_to?(:keys)
+        config
+      else 
+        puts "Warning: The yaml config file '#{full_path}' does not exist."
+        {}
+      end
+    rescue Psych::SyntaxError => exception
+      raise "Error parsing YAML file '#{full_path}'\n Original cause: \n #{exception.message}"
+    end
+  end
+end

data/lib/yaml_configuration/version.rb

@@ -0,0 +1,3 @@
+module YamlConfiguration
+  VERSION = "0.0.1"
+end

data/tests/tests_setup.rb

@@ -0,0 +1,15 @@
+require_relative '../lib/yaml_configuration.rb'
+require 'turn'
+
+def assert_exception(exception, message=nil)
+  begin
+    yield
+    assert false, "The block was expected to throw an exception but it didn't"
+  rescue Exception => ex
+    unless message.nil?
+      assert_equal message, ex.message, "The exception message is not the expected one."
+    end
+    assert_equal exception.to_s, ex.class.to_s, "The block was expected to throw a #{exception} but it did throw #{ex.class}"
+  end
+end
+

data/tests/yaml_configuration/configuration_tests.rb

@@ -0,0 +1,41 @@
+require_relative '../tests_setup.rb'
+
+module YamlConfiguration
+  class ConfigurationTests < MiniTest::Unit::TestCase
+    def test_that_configuration_responds_to_existing_configuration_value
+      configuration = Configuration.new({'site_name' => 'dancingonice', 'environment' => 'PRODUCTION'})
+      assert_equal 'dancingonice', configuration.site_name
+      assert_equal 'PRODUCTION', configuration.environment
+    end
+
+    def test_that_good_error_message_returned_for_missing_configuration
+      configuration = Configuration.new({'site_name' => 'dancingonice'})
+      
+      assert_exception(RuntimeError, "The setting 'method_that_does_not_exist' is not present in the configuration") do
+        configuration.method_that_does_not_exist
+      end
+    end
+
+    def test_that_nested_configuration_return_correct_values
+      configuration = Configuration.new({'database' => {'username' => 'david', 'password' => 'xxxx'}})
+
+      assert_equal 'david', configuration.database.username
+      assert_equal 'xxxx', configuration.database.password
+    end
+    
+    def test_that_when_nested_configuration_has_missing_key_exception_mention_parent
+      configuration = Configuration.new({'database' => {'user' => { 'name' => 'david'}, 'password' => 'xxxx'}})
+
+      assert_exception(RuntimeError, "The setting 'database.user.method_that_does_not_exist' is not present in the configuration") do
+        configuration.database.user.method_that_does_not_exist
+      end
+    end
+
+    def test_that_asking_for_the_existence_of_a_settings_returns_true_or_false
+      configuration = Configuration.new({'site' => {'name' => 'downtonabbey'}})
+
+      assert configuration.site.name?
+      refute configuration.site.database?
+    end
+  end
+end

data/yaml_configuration.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "yaml_configuration/version"
+
+Gem::Specification.new do |s|
+  s.name        = "yaml_configuration"
+  s.version     = YamlConfiguration::VERSION
+  s.authors     = ["David Santoro"]
+  s.email       = ["soulnafein@gmail.com"]
+  s.homepage    = "http://github.com/soulnafein/yaml_configuration"
+  s.summary     = %q{A simple wrapper for a yaml based configuration}
+  s.description = %q{Load, merge and provide sensible error messages when using yaml based configuration}
+
+  s.rubyforge_project = "yaml_configuration"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "turn"
+  s.add_development_dependency "ansi"
+  s.add_runtime_dependency "hash-deep-merge"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: yaml_configuration
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Santoro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-05 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &85835120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *85835120
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: &85834810 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *85834810
+- !ruby/object:Gem::Dependency
+  name: ansi
+  requirement: &85818520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *85818520
+- !ruby/object:Gem::Dependency
+  name: hash-deep-merge
+  requirement: &85818310 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *85818310
+description: Load, merge and provide sensible error messages when using yaml based
+  configuration
+email:
+- soulnafein@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/yaml_configuration.rb
+- lib/yaml_configuration/configuration.rb
+- lib/yaml_configuration/loader.rb
+- lib/yaml_configuration/version.rb
+- tests/tests_setup.rb
+- tests/yaml_configuration/configuration_tests.rb
+- yaml_configuration.gemspec
+homepage: http://github.com/soulnafein/yaml_configuration
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: yaml_configuration
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A simple wrapper for a yaml based configuration
+test_files: []