yacht 0.1.2 → 0.2.0

data/spec/yacht/classy_struct_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe Yacht::Loader do
+  subject { Yacht::Loader }
+
+  describe :classy_struct_instance do
+    it "should create a new ClassyStruct" do
+      ClassyStruct.should_receive(:new)
+      subject.classy_struct_instance
+    end
+  end
+
+  describe :to_classy_struct do
+    it "creates a ClassyStruct based on to_hash" do
+      subject.stub(:to_hash).and_return(:foo => 'bar')
+      subject.to_classy_struct.foo.should == "bar"
+    end
+
+    # ClassyStruct improves performance by adding accessors to the instance object
+    # If the instance is not reused, there is no advantage to ClassyStruct over OpenStruct
+    it "reuses the instance of ClassyStruct on subsequent calls" do
+      first_obj   = subject.classy_struct_instance
+      second_obj  = subject.classy_struct_instance
+
+      first_obj.object_id.should == second_obj.object_id.should
+    end
+
+    it "passes options to to_hash" do
+      subject.should_receive(:to_hash).with({:my => :awesome_option})
+
+      subject.to_classy_struct({:my => :awesome_option})
+    end
+
+    it "raises a custom error if ClassyStruct cannot be created" do
+      subject.stub!(:to_hash).and_raise("some funky error")
+
+      expect {
+        subject.to_classy_struct
+      }.to raise_error(Yacht::LoadError, /some funky error/)
+    end
+
+    it "does not intercept YachtLoader custom errors" do
+      subject.stub!(:to_hash).and_raise Yacht::LoadError.new("custom error message")
+
+      expect {
+        subject.to_classy_struct
+      }.to raise_error(Yacht::LoadError, "custom error message")
+    end
+  end
+
+end
+
+describe Yacht do
+  subject { Yacht }
+  after do
+    Yacht.instance_variable_set(:@_hash, nil)
+    Yacht.instance_variable_set(:@_classy_struct, nil)
+  end
+
+  context "just like a classy struct instance" do
+    it "should retrieve values by key" do
+      Yacht::Loader.stub(:to_hash).and_return(:foo => 'bar')
+
+      Yacht.foo.should == 'bar'
+    end
+
+    it "should return nil for nonexistent keys" do
+      Yacht::Loader.stub(:to_hash).and_return(:foo => 'bar')
+
+      Yacht.snafu.should be_nil
+    end
+
+    it "should handles nested hashes" do
+      Yacht::Loader.stub(:to_hash).and_return({:foo => {:bar => 'baz'}})
+
+      Yacht.foo.to_hash.should  == {:bar => 'baz'}
+      Yacht.foo.bar.should      == 'baz'
+      Yacht.foo.fu.should       be_nil
+    end
+  end
+end

data/spec/yacht/loader_spec.rb

@@ -0,0 +1,215 @@
+require 'spec_helper'
+
+describe Yacht::Loader do
+  subject{ Yacht::Loader }
+
+  let(:mock_base_config) do
+    {
+      'default' => {
+        :color_of_the_day   => 'orange',
+        :super_secret_info  => 'swordfish'
+      },
+      'wacky' => {
+        :color_of_the_day   => 'purple',
+        :super_secret_info  => 'mackerel',
+      }
+    }
+  end
+
+  describe :to_hash do
+    before do
+      subject.stub(:base_config).and_return(mock_base_config)
+      subject.stub(:local_config).and_return({})
+      subject.stub(:whitelist).and_return([:color_of_the_day])
+    end
+
+    it "returns all keys by default" do
+      subject.to_hash.should  == mock_base_config['default']
+    end
+
+    it "only returns keys included in whitelist when :apply_whitelist? option is true" do
+      subject.to_hash(:apply_whitelist? => true).should  == {:color_of_the_day => 'orange'}
+    end
+
+    it "allows selection of the environment by passing an :env param" do
+      subject.to_hash(:env => 'wacky').should  == mock_base_config['wacky']
+    end
+
+    it "raises an error if an environment is requested that doesn't exist" do
+      expect {
+        subject.environment = 'nonexistent'
+        subject.to_hash
+      }.to raise_error( Yacht::LoadError, /does not exist/)
+    end
+
+    context "with inheritance" do
+      let(:mock_base_config_with_inheritance) do
+        {
+          'default' => {
+            :doggies   => {
+              'lassie'  => 'nice',
+              'cujo'    => 'mean'
+            }
+          },
+          'papa'    => {
+            :use_ssl? => false,
+            :doggies  => {
+              'benji'   => 'smart'
+            }
+          },
+          'kid'     => {
+            '_parent' => 'papa',
+            :doggies   => {
+              'cerberus'   => '3-headed'
+            }
+          }
+        }
+      end
+
+      before do
+        subject.stub(:base_config).and_return(mock_base_config_with_inheritance)
+        subject.environment = 'kid'
+      end
+
+      it "transfer values from _parent environment if _parent is set" do
+        subject.to_hash[:use_ssl?].should be_false
+      end
+
+      it "merges the hashes recursively" do
+        subject.to_hash[:doggies].should == {
+          'lassie'  => 'nice',
+          'cujo'    => 'mean',
+          'benji'   => 'smart',
+          'cerberus'   => '3-headed'
+        }
+      end
+    end
+  end
+
+  describe :all do
+    it "merges configuration for named environment onto defaults" do
+      subject.stub(:base_config).and_return({
+        'default' => {
+          :color_of_the_day => 'orange',
+        },
+        'wacky' => {
+          :color_of_the_day => 'purple',
+        }
+      })
+
+      subject.environment = 'wacky'
+      subject.to_hash[:color_of_the_day].should == 'purple'
+    end
+  end
+
+  describe :base_config do
+    it "calls load_config_file" do
+      subject.should_receive(:load_config_file).with(:base).and_return('foo')
+
+      subject.base_config
+    end
+
+    it "raises an error if load_config_file returns nil" do
+      subject.stub(:load_config_file).with(:base).and_return(nil)
+      expect {
+        subject.base_config
+      }.to raise_error(Yacht::LoadError, "Couldn't load base config")
+    end
+  end
+
+  describe :local_config do
+    it "calls load_config_file" do
+      subject.should_receive(:load_config_file).with(:local).and_return('local_foo')
+
+      subject.local_config
+    end
+
+    it "returns an empty hash if load_config_file returns nil" do
+      subject.stub(:load_config_file).with(:local).and_return(nil)
+      subject.local_config.should == {}
+    end
+
+    # Handling of empty local.yml file
+    # YAML.load("")
+    # => false
+    it "returns an empty hash if load_config_file returns false" do
+      subject.stub(:load_config_file).with(:local).and_return(false)
+      subject.local_config.should == {}
+    end
+  end
+
+  describe :whitelist do
+    # before do
+    #   subject.stub(:base_config).and_return(mock_base_config)
+    #   subject.stub(:local_config).and_return({})
+    #   subject.stub(:whitelist).and_return([:color_of_the_day])
+    # end
+
+    it "raises an error if load_config_file returns nil" do
+      subject.stub(:load_config_file).with(:whitelist, :expect_to_load => Array).and_return(nil)
+
+      expect {
+        subject.whitelist
+      }.to raise_error( Yacht::LoadError, "Couldn't load whitelist")
+    end
+
+    it "expects load_config_file to return an Array" do
+      subject.should_receive(:load_config_file).with(:whitelist, :expect_to_load => Array).and_return([])
+
+      subject.whitelist
+    end
+  end
+
+  describe :config_file_for do
+    it "returns the full file path for the following config files: base, local & whitelist" do
+      %w(base local whitelist).each do |config_file|
+        subject.should_receive(:full_file_path_for_config).with(config_file)
+
+        subject.config_file_for(config_file)
+      end
+    end
+
+    it "raises an error if the config file is not found" do
+      expect {
+        subject.config_file_for(:foo)
+      }.to raise_error( Yacht::LoadError, "foo is not a valid config type")
+    end
+  end
+
+  describe :load_config_file do
+    it "loads the specified file" do
+      subject.stub(:config_file_for).with(:base).and_return('base_foo')
+      subject.stub(:_load_config_file).with('base_foo').and_return('base_bar')
+      subject.send(:load_config_file, :base, :expect_to_load => String).should == "base_bar"
+    end
+
+    it "raises an error if opening the file leads to an exception" do
+      subject.stub(:config_file_for).and_raise(StandardError.new("my_unique_error_message"))
+
+      expect {
+        subject.send(:load_config_file, "some file")
+      }.to raise_error( Yacht::LoadError, %r{ERROR: loading.+my_unique_error_message} )
+    end
+
+    it "raises an error if :expect_to_load param is passed but does not match loaded object" do
+      subject.stub(:config_file_for).with(:foo).and_return('foo_file')
+      subject.stub(:_load_config_file).with('foo_file').and_return(Hash.new) # notice the underscore!
+      expect {
+        subject.send(:load_config_file, :foo, :expect_to_load => Array)
+      }.to raise_error( Yacht::LoadError, "foo_file must contain Array (got Hash)" )
+    end
+
+  end
+
+  context "checks environment and sets sensible defaults" do
+    it "sets the environment to 'default'" do
+      subject.environment.should == "default"
+    end
+  end
+end
+
+describe YachtLoader do
+  it "should alias YachtLoader to Yacht::Loader for backwards compatibility" do
+    ::YachtLoader.should == Yacht::Loader
+  end
+end

data/spec/{yacht_loader → yacht}/rails_spec.rb

@@ -1,8 +1,10 @@
 require 'spec_helper'
 
 describe "Rails support" do
+  subject { Yacht::Loader }
+
   before do
-    require "yacht_loader/rails"
+    require "yacht/rails"
     @yacht_dir = "/path/to/rails/config/yacht"
   end
 
@@ -13,7 +15,7 @@ describe "Rails support" do
     it "uses the current rails environment by default" do
       Rails.should_receive(:env)
 
-      YachtLoader.environment
+      subject.environment
     end
   end
 
@@ -21,17 +23,17 @@ describe "Rails support" do
     it "uses config/yacht by default" do
       Rails.stub_chain(:root, :join).and_return(@yacht_dir)
 
-      YachtLoader.dir.should == @yacht_dir
+      subject.dir.should == @yacht_dir
     end
   end
 
   describe :full_file_path_for_config do
     it "calls dir.join" do
       fake_dir = stub("dir stub")
-      YachtLoader.stub(:dir).and_return(fake_dir)
+      subject.stub(:dir).and_return(fake_dir)
       fake_dir.should_receive(:join).with("some.yml")
 
-      YachtLoader.full_file_path_for_config("some")
+      subject.full_file_path_for_config("some")
     end
   end
 end

data/yacht.gemspec

@@ -2,13 +2,13 @@
 lib = File.expand_path('../lib/', __FILE__)
 $:.unshift lib unless $:.include?(lib)
 
-require 'yacht_loader/version'
+require 'yacht/version'
 
 Gem::Specification.new do |s|
   s.name        = "yacht"
-  s.version     = YachtLoader::VERSION
+  s.version     = Yacht::VERSION
   s.authors     = ["Mani Tadayon", "Rico Rodriquez Collins"]
-  s.description = "Yacht is Yet Another Application Configuration Helper Tool."
+  s.description = "Yacht is Yet Another Configuration Helper Tool."
   s.summary     = "yacht-#{s.version}"
   s.email       = ["mtadayon@atti.com", "rcollins@atti.com"]
   s.homepage    = "https://github.com/attinteractive/yacht"
@@ -17,9 +17,13 @@ Gem::Specification.new do |s|
 
   s.add_dependency "classy_struct", ">= 0.3.2"
 
+  s.add_development_dependency "gherkin", '~> 2.3.0'
+  s.add_development_dependency "cucumber", '>= 0.10.0'
+  s.add_development_dependency 'aruba'
   s.add_development_dependency "rspec", '>= 2.6.0'
   s.add_development_dependency "simplecov", '>= 0.4.1'
 
+
   s.required_rubygems_version = ">= 1.3.7"
   s.files            = `git ls-files`.split("\n")
   s.test_files       = `git ls-files -- spec/*`.split("\n")

metadata

@@ -2,7 +2,7 @@
 name: yacht
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - Mani Tadayon
@@ -11,7 +11,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-20 00:00:00 Z
+date: 2011-06-16 00:00:00 -07:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: classy_struct
@@ -25,28 +26,61 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: gherkin
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: aruba
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: 2.6.0
   type: :development
-  version_requirements: *id002
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: simplecov
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: 0.4.1
   type: :development
-  version_requirements: *id003
-description: Yacht is Yet Another Application Configuration Helper Tool.
+  version_requirements: *id006
+description: Yacht is Yet Another Configuration Helper Tool.
 email: 
 - mtadayon@atti.com
 - rcollins@atti.com
@@ -61,22 +95,34 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .yardopts
 - Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
+- features/load.feature
+- features/missing_yaml_files.feature
+- features/step_definitions/aruba_extension_steps.rb
+- features/step_definitions/error_handling_steps.rb
+- features/step_definitions/loader_steps.rb
+- features/support/cleanup.rb
+- features/support/env.rb
+- gem_tasks/cucumber.rake
 - gem_tasks/spec.rake
 - lib/monkeypatches/hash.rb
 - lib/yacht.rb
-- lib/yacht_loader/base.rb
-- lib/yacht_loader/classy_struct.rb
-- lib/yacht_loader/rails.rb
-- lib/yacht_loader/version.rb
+- lib/yacht/base.rb
+- lib/yacht/classy_struct.rb
+- lib/yacht/loader.rb
+- lib/yacht/rails.rb
+- lib/yacht/version.rb
 - spec/spec_helper.rb
-- spec/yacht_loader/base_spec.rb
-- spec/yacht_loader/classy_struct_spec.rb
-- spec/yacht_loader/rails_spec.rb
+- spec/yacht/base_spec.rb
+- spec/yacht/classy_struct_spec.rb
+- spec/yacht/loader_spec.rb
+- spec/yacht/rails_spec.rb
 - yacht.gemspec
+has_rdoc: true
 homepage: https://github.com/attinteractive/yacht
 licenses: []
 
@@ -100,12 +146,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.3.9.1
 signing_key: 
 specification_version: 3
-summary: yacht-0.1.2
+summary: yacht-0.2.0
 test_files: 
 - spec/spec_helper.rb
-- spec/yacht_loader/base_spec.rb
-- spec/yacht_loader/classy_struct_spec.rb
-- spec/yacht_loader/rails_spec.rb
+- spec/yacht/base_spec.rb
+- spec/yacht/classy_struct_spec.rb
+- spec/yacht/loader_spec.rb
+- spec/yacht/rails_spec.rb

data/lib/yacht_loader/classy_struct.rb

@@ -1,15 +0,0 @@
-require 'classy_struct'
-
-class YachtLoader
-  class << self
-    def classy_struct_instance
-      @classy_struct_instance ||= ClassyStruct.new
-    end
-
-    def to_classy_struct(opts={})
-      classy_struct_instance.new( self.to_hash(opts) )
-    rescue StandardError => e
-      raise LoadError.new("Error creating ClassyStruct: #{e.message}")
-    end
-  end
-end

data/lib/yacht_loader/version.rb

@@ -1,3 +0,0 @@
-class YachtLoader
-  VERSION = "0.1.2"
-end