serenity 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,5 @@
1
+ README.rdoc
2
+ lib/**/*.rb
3
+ bin/*
4
+ features/**/*.feature
5
+ LICENSE
@@ -0,0 +1,21 @@
1
+ ## MAC OS
2
+ .DS_Store
3
+
4
+ ## TEXTMATE
5
+ *.tmproj
6
+ tmtags
7
+
8
+ ## EMACS
9
+ *~
10
+ \#*
11
+ .\#*
12
+
13
+ ## VIM
14
+ *.swp
15
+
16
+ ## PROJECT::GENERAL
17
+ coverage
18
+ rdoc
19
+ pkg
20
+
21
+ ## PROJECT::SPECIFIC
data/LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2009 Jeff Coleman
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,17 @@
1
+ = serenity
2
+
3
+ Description goes here.
4
+
5
+ == Note on Patches/Pull Requests
6
+
7
+ * Fork the project.
8
+ * Make your feature addition or bug fix.
9
+ * Add tests for it. This is important so I don't break it in a
10
+ future version unintentionally.
11
+ * Commit, do not mess with rakefile, version, or history.
12
+ (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)
13
+ * Send me a pull request. Bonus points for topic branches.
14
+
15
+ == Copyright
16
+
17
+ Copyright (c) 2010 Jeff Coleman. See LICENSE for details.
@@ -0,0 +1,46 @@
1
+ require 'rubygems'
2
+ require 'rake'
3
+
4
+ begin
5
+ require 'jeweler'
6
+ Jeweler::Tasks.new do |gem|
7
+ gem.name = "serenity"
8
+ gem.summary = %Q{Gracefully handles multi-level configuration options from Yaml files}
9
+ gem.description = %Q{Handles configuration options from Yaml files, returning multi-level values with appropriate error messaging.}
10
+ gem.email = "progressions@gmail.com"
11
+ gem.homepage = "http://github.com/progressions/serenity"
12
+ gem.authors = ["Jeff Coleman"]
13
+ gem.add_development_dependency "rspec", ">= 1.2.6"
14
+ # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
15
+ end
16
+ Jeweler::GemcutterTasks.new
17
+ rescue LoadError
18
+ puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
19
+ end
20
+
21
+ require 'spec/rake/spectask'
22
+ Spec::Rake::SpecTask.new(:spec) do |spec|
23
+ spec.libs << 'lib' << 'spec'
24
+ spec.spec_files = FileList['spec/**/*_spec.rb']
25
+ spec.spec_opts = ['-c']
26
+ end
27
+
28
+ Spec::Rake::SpecTask.new(:rcov) do |spec|
29
+ spec.libs << 'lib' << 'spec'
30
+ spec.pattern = 'spec/**/*_spec.rb'
31
+ spec.rcov = true
32
+ end
33
+
34
+ task :spec => :check_dependencies
35
+
36
+ task :default => :spec
37
+
38
+ require 'rake/rdoctask'
39
+ Rake::RDocTask.new do |rdoc|
40
+ version = File.exist?('VERSION') ? File.read('VERSION') : ""
41
+
42
+ rdoc.rdoc_dir = 'rdoc'
43
+ rdoc.title = "serenity #{version}"
44
+ rdoc.rdoc_files.include('README*')
45
+ rdoc.rdoc_files.include('lib/**/*.rb')
46
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.0.1
@@ -0,0 +1,61 @@
1
+ require 'yaml'
2
+ #
3
+ # Returns values from multi-level YAML configuration files.
4
+ #
5
+ # Gracefully handles error messages when an option is not found.
6
+ #
7
+ # Usage:
8
+ #
9
+ # Given config.yml:
10
+ # name: Fred Flintstone
11
+ # wife:
12
+ # name: Wilma Flintstone
13
+ # friend:
14
+ # name: Barney Rubble
15
+ # wife: Betty Rubble
16
+ #
17
+ # @config = Serenity::Configuration.new("config.yml")
18
+ #
19
+ # @config.get("name") #=> "Fred Flinstone"
20
+ # @config.get("wife", "name") #=> "Wilma Flintstone"
21
+ #
22
+ module Serenity
23
+ class Configuration
24
+ attr_accessor :filename, :options
25
+
26
+ def initialize(filename)
27
+ @filename = filename
28
+ @options = YAML.load_file(filename)
29
+ end
30
+
31
+ def to_hash
32
+ options
33
+ end
34
+
35
+ def get(*args)
36
+ c = options
37
+
38
+ missing_option_index = 0
39
+
40
+ args.each_with_index do |arg, i|
41
+ if c.is_a?(Hash) && c.has_key?(arg)
42
+ c = c[arg]
43
+ else
44
+ missing_option_index = i
45
+ raise "Option not found."
46
+ end
47
+ end
48
+
49
+ c
50
+ rescue
51
+ $stdout.puts "The following option was not found in #{filename}:"
52
+ (0..missing_option_index).each do |i|
53
+ $stdout.puts args[i]
54
+ end
55
+ $stdout.puts
56
+ $stdout.puts "Are you sure #{filename} is up to date?"
57
+ $stdout.puts
58
+ raise "Option not found."
59
+ end
60
+ end
61
+ end
@@ -0,0 +1,55 @@
1
+ # Generated by jeweler
2
+ # DO NOT EDIT THIS FILE DIRECTLY
3
+ # Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
4
+ # -*- encoding: utf-8 -*-
5
+
6
+ Gem::Specification.new do |s|
7
+ s.name = %q{serenity}
8
+ s.version = "0.0.1"
9
+
10
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
+ s.authors = ["Jeff Coleman"]
12
+ s.date = %q{2010-01-13}
13
+ s.description = %q{Handles configuration options from Yaml files, returning multi-level values with appropriate error messaging.}
14
+ s.email = %q{progressions@gmail.com}
15
+ s.extra_rdoc_files = [
16
+ "LICENSE",
17
+ "README.rdoc"
18
+ ]
19
+ s.files = [
20
+ ".document",
21
+ ".gitignore",
22
+ "LICENSE",
23
+ "README.rdoc",
24
+ "Rakefile",
25
+ "VERSION",
26
+ "lib/serenity.rb",
27
+ "serenity.gemspec",
28
+ "spec/serenity_spec.rb",
29
+ "spec/spec.opts",
30
+ "spec/spec_helper.rb"
31
+ ]
32
+ s.homepage = %q{http://github.com/progressions/serenity}
33
+ s.rdoc_options = ["--charset=UTF-8"]
34
+ s.require_paths = ["lib"]
35
+ s.rubygems_version = %q{1.3.5}
36
+ s.summary = %q{Gracefully handles multi-level configuration options from Yaml files}
37
+ s.test_files = [
38
+ "spec/serenity_spec.rb",
39
+ "spec/spec_helper.rb"
40
+ ]
41
+
42
+ if s.respond_to? :specification_version then
43
+ current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
44
+ s.specification_version = 3
45
+
46
+ if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
47
+ s.add_development_dependency(%q<rspec>, [">= 1.2.6"])
48
+ else
49
+ s.add_dependency(%q<rspec>, [">= 1.2.6"])
50
+ end
51
+ else
52
+ s.add_dependency(%q<rspec>, [">= 1.2.6"])
53
+ end
54
+ end
55
+
@@ -0,0 +1,88 @@
1
+ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
2
+
3
+ describe "Configuration" do
4
+ before(:each) do
5
+ $stdout.stub!(:puts)
6
+ @options = {
7
+ "ship" => {
8
+ "name" => "Serenity",
9
+ "class" => "Firefly",
10
+ "crew" => {
11
+ "captain" => "Mal Reynolds"
12
+ }
13
+ }
14
+ }
15
+ @filename = "#config.yml"
16
+ YAML.stub!(:load_file).with(@filename).and_return(@options)
17
+ end
18
+
19
+ describe "initialization" do
20
+ it "should make a new object" do
21
+ Serenity::Configuration.new(@filename).should_not be_nil
22
+ end
23
+
24
+ it "should raise an error if file doesn't exist" do
25
+ YAML.stub!(:load_file).and_raise(Errno::ENOENT)
26
+ lambda {
27
+ Serenity::Configuration.new("config_doesnt_exist.yml")
28
+ }.should raise_error
29
+ end
30
+
31
+ it "should raise an error if filename is blank" do
32
+ lambda {
33
+ Serenity::Configuration.new("")
34
+ }.should raise_error
35
+ end
36
+
37
+ it "should raise an error if filename is nil" do
38
+ lambda {
39
+ Serenity::Configuration.new
40
+ }.should raise_error
41
+ end
42
+
43
+ describe "accessors" do
44
+ before(:each) do
45
+ @config = Serenity::Configuration.new(@filename)
46
+ end
47
+
48
+ it "should set filename" do
49
+ @config.filename.should == @filename
50
+ end
51
+
52
+ it "should return options" do
53
+ @config.to_hash.should == @options
54
+ end
55
+ end
56
+ end
57
+
58
+ describe "get" do
59
+ before(:each) do
60
+ @config = Serenity::Configuration.new(@filename)
61
+ end
62
+
63
+ it "should return hash of complex values" do
64
+ @config.get("ship").should == @options["ship"]
65
+ end
66
+
67
+ it "should go down several levels" do
68
+ @config.get("ship", "crew", "captain").should == @options["ship"]["crew"]["captain"]
69
+ end
70
+
71
+ it "should return error if option doesn't exist" do
72
+ $stdout.should_receive(:puts).with("The following option was not found in #{@filename}:")
73
+ lambda {
74
+ @config.get("ship", "albatross")
75
+ }.should raise_error
76
+ end
77
+ end
78
+ end
79
+
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+
@@ -0,0 +1 @@
1
+ --color
@@ -0,0 +1,9 @@
1
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
2
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
3
+ require 'serenity'
4
+ require 'spec'
5
+ require 'spec/autorun'
6
+
7
+ Spec::Runner.configure do |config|
8
+
9
+ end
metadata ADDED
@@ -0,0 +1,76 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: serenity
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Jeff Coleman
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+
12
+ date: 2010-01-13 00:00:00 -06:00
13
+ default_executable:
14
+ dependencies:
15
+ - !ruby/object:Gem::Dependency
16
+ name: rspec
17
+ type: :development
18
+ version_requirement:
19
+ version_requirements: !ruby/object:Gem::Requirement
20
+ requirements:
21
+ - - ">="
22
+ - !ruby/object:Gem::Version
23
+ version: 1.2.6
24
+ version:
25
+ description: Handles configuration options from Yaml files, returning multi-level values with appropriate error messaging.
26
+ email: progressions@gmail.com
27
+ executables: []
28
+
29
+ extensions: []
30
+
31
+ extra_rdoc_files:
32
+ - LICENSE
33
+ - README.rdoc
34
+ files:
35
+ - .document
36
+ - .gitignore
37
+ - LICENSE
38
+ - README.rdoc
39
+ - Rakefile
40
+ - VERSION
41
+ - lib/serenity.rb
42
+ - serenity.gemspec
43
+ - spec/serenity_spec.rb
44
+ - spec/spec.opts
45
+ - spec/spec_helper.rb
46
+ has_rdoc: true
47
+ homepage: http://github.com/progressions/serenity
48
+ licenses: []
49
+
50
+ post_install_message:
51
+ rdoc_options:
52
+ - --charset=UTF-8
53
+ require_paths:
54
+ - lib
55
+ required_ruby_version: !ruby/object:Gem::Requirement
56
+ requirements:
57
+ - - ">="
58
+ - !ruby/object:Gem::Version
59
+ version: "0"
60
+ version:
61
+ required_rubygems_version: !ruby/object:Gem::Requirement
62
+ requirements:
63
+ - - ">="
64
+ - !ruby/object:Gem::Version
65
+ version: "0"
66
+ version:
67
+ requirements: []
68
+
69
+ rubyforge_project:
70
+ rubygems_version: 1.3.5
71
+ signing_key:
72
+ specification_version: 3
73
+ summary: Gracefully handles multi-level configuration options from Yaml files
74
+ test_files:
75
+ - spec/serenity_spec.rb
76
+ - spec/spec_helper.rb