yacht 0.2.5 → 0.2.6

data/README.rdoc

@@ -22,10 +22,13 @@ Yacht is an application configuration gem that lets you define settings for mult
 
 === Step 1: YAML files
 
-First create two (or more) YAML files in the same directory to define your settings:
+First create one or more of the following YAML files in the same directory to define your settings:
 
     # config/yacht/base.yml (required)
     production:
+      public_info:
+        copyright_year: 2011
+        company_name: AT&T Interactive
       cdn_host: 1.2.3.4
       super_secret_info:
         aws_key: foofoo
@@ -38,7 +41,7 @@ First create two (or more) YAML files in the same directory to define your setti
         #   see https://gist.github.com/979804 for an explanation
         aws_key: bazbaz
 
-    # config/yacht/whitelist.yml (required)
+    # config/yacht/whitelist.yml (optional)
     # any keys specified here can be used as a whitelist filter:
     #   Yacht::Loader.to_hash(:apply_whitelist? => true)
     #   or
@@ -47,7 +50,7 @@ First create two (or more) YAML files in the same directory to define your setti
     # NOTE: the whitelist is ignored when using Yacht.my_key or Yacht['my_key']
     #       you have to use Yacht::Loader#to_hash or
     #       Yacht::Loader#to_classy_struct to use the whitelist
-    - super_secret_info
+    - public_info
 
     # config/yacht/local.yml (optional)
     # any values set in local.yml will override values set in base.yml
@@ -108,4 +111,4 @@ When using Yacht inside of a Rails application, you can use the yacht_js_snippet
 
 == License
 
-Yacht is licensed under the MIT License with one addition: The Software shall be used for Good, not Evil.
+Yacht is licensed under the MIT License with one addition: The Software shall be used for Good, not Evil.

data/features/load.feature

@@ -81,7 +81,7 @@ Feature: Load configuration settings
       """
 
   @js
-  Scenario: Generate a Yacht.js file
+  Scenario: Generate a javascript snippet
     Given a file named "yacht/js_keys.yml" with:
     """
     - :partner_sites

data/features/step_definitions/loader_steps.rb

@@ -13,10 +13,9 @@ end
 
 
 Then /^the constant "([^"]*)" should contain the following hash:$/ do |constant_name, stringified|
-  hash = eval(stringified)
-  Object.const_get(constant_name).to_hash.should == hash # don't forget to tack on to_hash to avoid weird errors
-                                                         # TODO: make ClassyStruct more Hash-like so
-                                                         # i t can be compared against hashes using `==`
+  # don't forget to tack on to_hash to avoid weird errors
+  # TODO: make ClassyStruct more Hash-like so it can be compared against hashes using `==`
+  stringified_hash_should_match( stringified, Object.const_get(constant_name).to_hash )
 end
 
 When /^I load Yacht with environment: "([^"]*)"$/ do |env|
@@ -24,9 +23,18 @@ When /^I load Yacht with environment: "([^"]*)"$/ do |env|
 end
 
 Then /^Yacht should contain the following hash:$/ do |stringified|
-  hash = eval(stringified)
-
   in_current_dir do
-    Yacht::Loader.to_hash.should == hash
+    stringified_hash_should_match(stringified, Yacht::Loader.to_hash)
+  end
+end
+
+module LoaderHelpers
+  def stringified_hash_should_match(string, hash)
+    hash_from_string = eval(string)
+
+    in_current_dir do
+      hash_from_string.should == hash
+    end
   end
 end
+World(LoaderHelpers)

data/lib/yacht/javascript.rb

@@ -13,9 +13,7 @@ class Yacht::Loader
     end
 
     def js_keys
-      load_config_file(:js_keys, :expect_to_load => Array) || begin
-        raise Yacht::LoadError.new("Couldn't load js_keys")
-      end
+      load_config_file(:js_keys, :expect_to_load => Array) || raise( Yacht::LoadError.new("Couldn't load js_keys") )
     end
   end
 end

data/lib/yacht/loader.rb

@@ -1,5 +1,3 @@
-# TODO: Rename YachtLoader to Yacht and somehow incorporate ClassyStruct
-
 class Yacht::Loader
   class << self
     def environment
@@ -16,7 +14,9 @@ class Yacht::Loader
     end
 
     def config_file_for(config_type)
-      raise Yacht::LoadError.new "#{config_type} is not a valid config type" unless valid_config_types.include?(config_type.to_s)
+      if !valid_config_types.include?(config_type.to_s)
+        raise Yacht::LoadError.new "#{config_type} is not a valid config type"
+      end
 
       full_file_path_for_config(config_type)
     end
@@ -69,8 +69,9 @@ class Yacht::Loader
       file_name = self.config_file_for(file_type)
       loaded    = self._load_config_file(file_name)
 
-      # YAML contained the wrong type
-      raise Yacht::LoadError.new "#{file_name} must contain #{expected_class} (got #{loaded.class})" if loaded && !loaded.is_a?(expected_class)
+      if loaded && !loaded.is_a?(expected_class) # YAML contained the wrong type
+        raise Yacht::LoadError.new "#{file_name} must contain #{expected_class} (got #{loaded.class})"
+      end
 
       loaded
     rescue => e
@@ -78,25 +79,27 @@ class Yacht::Loader
       if e.is_a? Yacht::LoadError
         raise e
       else
-        # convert other errors to YachtLoader::Yacht::LoadError
+        # convert other errors to Yacht::LoadError
         raise Yacht::LoadError.new "ERROR: loading config file: '#{file_type}': #{e}"
       end
     end
 
     def chain_configs(config, env)
-      raise Yacht::LoadError.new "environment '#{env}' does not exist" unless config.has_key?(env)
-
-      parent = if config[env]['_parent']
-                 chain_configs(config, config[env]['_parent'])
-               else
-                 config['default'] || {}
-               end
-
-      parent.deep_merge(config[env])
+      if config.has_key?(env)
+        parent = if parent_env = config[env]['_parent']
+                   raise Yacht::LoadError.new "environment '#{parent_env}' does not exist" unless config.has_key?(parent_env)
+                   chain_configs(config, config[env]['_parent'])
+                 else
+                   config['default'] || {}
+                 end
+
+        parent.deep_merge(config[env])
+      else
+        config['default'] || {}
+      end
     end
   end
-
 end
 
 # Alias for Yacht::Loader for backwards compatibility
-Object.const_set(:YachtLoader, Yacht::Loader)
+Object.const_set(:YachtLoader, Yacht::Loader)

data/lib/yacht/version.rb

@@ -1,3 +1,3 @@
 class Yacht < BasicObject
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

data/spec/yacht/loader_spec.rb

@@ -38,13 +38,6 @@ describe Yacht::Loader 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
         {
@@ -87,6 +80,36 @@ describe Yacht::Loader do
         }
       end
     end
+
+    context "with inheritance when a parent is missing" do
+      let(:mock_base_config_with_inheritance) do
+        {
+          'default' => {
+            :doggies   => {
+              'lassie'  => 'nice',
+              'cujo'    => 'mean'
+            }
+          },
+          'kid'     => {
+            '_parent' => 'deadbeat_dad',
+            :doggies   => {
+              'cerberus'   => '3-headed'
+            }
+          }
+        }
+      end
+
+      before do
+        subject.stub(:base_config).and_return(mock_base_config_with_inheritance)
+        subject.environment = 'kid'
+      end
+
+      it "raises an error if an environment is requested whose parent doesn't exist" do
+        expect {
+          subject.to_hash
+        }.to raise_error( Yacht::LoadError, /does not exist/)
+      end
+    end
   end
 
   describe :all do
@@ -104,6 +127,21 @@ describe Yacht::Loader do
       subject.environment = 'wacky'
       subject.to_hash[:color_of_the_day].should == 'purple'
     end
+
+    it "returns the defaults for environments that do not exist" do
+      subject.stub(:base_config).and_return({
+        'default' => {
+          :color_of_the_day => 'orange',
+        },
+        'wacky' => {
+          :color_of_the_day => 'purple',
+        }
+      })
+      subject.stub(:local_config).and_return({})
+
+      subject.environment = 'nerdy'
+      subject.to_hash.should == {:color_of_the_day => 'orange'}
+    end
   end
 
   describe :base_config do
@@ -246,4 +284,4 @@ describe YachtLoader do
   it "should alias YachtLoader to Yacht::Loader for backwards compatibility" do
     ::YachtLoader.should == Yacht::Loader
   end
-end
+end

data/yacht.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.add_dependency "json"
 
   s.add_development_dependency "gherkin", '>= 2.4.0'
-  s.add_development_dependency "cucumber", '>= 0.10.0'
+  s.add_development_dependency "cucumber", '~> 1.0'
   s.add_development_dependency 'aruba'
   s.add_development_dependency "rspec", '>= 2.6.0'
   s.add_development_dependency "simplecov", '>= 0.4.1'

metadata

@@ -2,7 +2,7 @@
 name: yacht
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors: 
 - Mani Tadayon
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-29 00:00:00 -07:00
+date: 2011-07-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,9 +53,9 @@ dependencies:
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.10.0
+        version: "1.0"
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
@@ -166,7 +166,7 @@ rubyforge_project:
 rubygems_version: 1.3.9.2
 signing_key: 
 specification_version: 3
-summary: yacht-0.2.5
+summary: yacht-0.2.6
 test_files: 
 - spec/monkeypatches/rails_helper_spec.rb
 - spec/spec_helper.rb