serenity 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jeff Coleman
+
+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.rdoc

@@ -0,0 +1,17 @@
+= serenity
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Jeff Coleman. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "serenity"
+    gem.summary = %Q{Gracefully handles multi-level configuration options from Yaml files}
+    gem.description = %Q{Handles configuration options from Yaml files, returning multi-level values with appropriate error messaging.}
+    gem.email = "progressions@gmail.com"
+    gem.homepage = "http://github.com/progressions/serenity"
+    gem.authors = ["Jeff Coleman"]
+    gem.add_development_dependency "rspec", ">= 1.2.6"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['-c']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "serenity #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/serenity.rb

@@ -0,0 +1,61 @@
+require 'yaml'
+# 
+# Returns values from multi-level YAML configuration files.
+# 
+# Gracefully handles error messages when an option is not found.
+#
+# Usage:
+#
+#    Given config.yml:
+#      name: Fred Flintstone
+#      wife:
+#        name: Wilma Flintstone
+#      friend:
+#        name: Barney Rubble
+#        wife: Betty Rubble
+#
+#    @config = Serenity::Configuration.new("config.yml")
+#
+#    @config.get("name")            #=> "Fred Flinstone"
+#    @config.get("wife", "name")    #=> "Wilma Flintstone"
+# 
+module Serenity
+  class Configuration
+    attr_accessor :filename, :options
+  
+    def initialize(filename)
+      @filename = filename
+      @options = YAML.load_file(filename)
+    end
+  
+    def to_hash
+      options
+    end
+  
+    def get(*args)
+      c = options
+    
+      missing_option_index = 0
+    
+      args.each_with_index do |arg, i|
+        if c.is_a?(Hash) && c.has_key?(arg)
+          c = c[arg]
+        else
+          missing_option_index = i
+          raise "Option not found."
+        end
+      end
+    
+      c
+    rescue 
+      $stdout.puts "The following option was not found in #{filename}:"
+      (0..missing_option_index).each do |i|
+        $stdout.puts args[i]
+      end
+      $stdout.puts
+      $stdout.puts "Are you sure #{filename} is up to date?"
+      $stdout.puts
+      raise "Option not found."
+    end
+  end
+end

data/serenity.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{serenity}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeff Coleman"]
+  s.date = %q{2010-01-13}
+  s.description = %q{Handles configuration options from Yaml files, returning multi-level values with appropriate error messaging.}
+  s.email = %q{progressions@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/serenity.rb",
+     "serenity.gemspec",
+     "spec/serenity_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/progressions/serenity}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Gracefully handles multi-level configuration options from Yaml files}
+  s.test_files = [
+    "spec/serenity_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.6"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.6"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.6"])
+  end
+end
+

data/spec/serenity_spec.rb

@@ -0,0 +1,88 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Configuration" do
+  before(:each) do
+    $stdout.stub!(:puts)
+    @options = {
+      "ship" => {
+        "name" => "Serenity",
+        "class" => "Firefly",
+        "crew" => {
+          "captain" => "Mal Reynolds"
+        }
+      }
+    }
+    @filename = "#config.yml"
+    YAML.stub!(:load_file).with(@filename).and_return(@options)
+  end
+  
+  describe "initialization" do
+    it "should make a new object" do
+      Serenity::Configuration.new(@filename).should_not be_nil
+    end
+    
+    it "should raise an error if file doesn't exist" do
+      YAML.stub!(:load_file).and_raise(Errno::ENOENT)
+      lambda {
+        Serenity::Configuration.new("config_doesnt_exist.yml")
+      }.should raise_error
+    end
+    
+    it "should raise an error if filename is blank" do
+      lambda {
+        Serenity::Configuration.new("")
+      }.should raise_error
+    end
+    
+    it "should raise an error if filename is nil" do
+      lambda {
+        Serenity::Configuration.new
+      }.should raise_error
+    end
+    
+    describe "accessors" do
+      before(:each) do 
+        @config = Serenity::Configuration.new(@filename)
+      end
+      
+      it "should set filename" do
+        @config.filename.should == @filename
+      end
+      
+      it "should return options" do
+        @config.to_hash.should == @options
+      end
+    end
+  end
+  
+  describe "get" do
+    before(:each) do 
+      @config = Serenity::Configuration.new(@filename)
+    end
+    
+    it "should return hash of complex values" do
+      @config.get("ship").should == @options["ship"]
+    end
+    
+    it "should go down several levels" do
+      @config.get("ship", "crew", "captain").should == @options["ship"]["crew"]["captain"]
+    end
+    
+    it "should return error if option doesn't exist" do
+      $stdout.should_receive(:puts).with("The following option was not found in #{@filename}:")
+      lambda {
+        @config.get("ship", "albatross")
+      }.should raise_error
+    end
+  end
+end
+
+
+
+
+
+
+
+
+
+

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'serenity'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: serenity
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jeff Coleman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-13 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.6
+    version: 
+description: Handles configuration options from Yaml files, returning multi-level values with appropriate error messaging.
+email: progressions@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/serenity.rb
+- serenity.gemspec
+- spec/serenity_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/progressions/serenity
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Gracefully handles multi-level configuration options from Yaml files
+test_files: 
+- spec/serenity_spec.rb
+- spec/spec_helper.rb