yacht 0.2.0 → 0.2.5

data/README.rdoc

@@ -55,17 +55,57 @@ First create two (or more) YAML files in the same directory to define your setti
     production:
       cdn_host: localhost
 
-=== Step 2: Use Yacht.my_key or Yacht['my_key']
+=== Step 2: Use Yacht.my_key or Yacht['my_key'] in ruby
 
 * <b>Rails</b>:
     # now you can access any key set in your YAML files with:
-    #   Yacht.my_key
+    Yacht.my_key
+    # => "my_value"
 
 * Outside of rails, you need to tell +Yacht+ where your YAML files are stored, and what environment you want to use.
     Yacht::Loader.dir          = '/path/to/YAML/dir'
     Yacht::Loader.environment  = 'my_environment'
     Yacht.my_key
 
+
+== Other features
+
+=== Yacht::Loader.to_js_snippet export to javascript
+If you would like to access values stored in Yacht inside of javascript, there is a helper for that. First, create a YAML file to tell Yacht which keys should be exported:
+
+    # config/yacht/base_keys.yml
+    # only keys listed here will be available in javascript
+    # remember that any values exported to javascript will be visible to all visitors to your site
+    - cookie_domain
+
+Then use Yacht::Loader#to_js_snippet to create a string that can be eval'd or included in the DOM:
+
+    Yacht::Loader.to_js_snippet
+    # => ";var Yacht = {\"cookie_domain\":\"example.com\"};"
+
+You can also add in extra values from outside of Yacht using the :merge option, like so:
+
+    Yacht::Loader.to_js_snippet(:merge => {:current_time => Time.now.to_s})
+    # => ";var Yacht = {\"cookie_domain\":\"example.com\",\"current_time\":\"06/29/2011\"};"
+
+
+=== yacht_js_snippet Rails helper
+
+When using Yacht inside of a Rails application, you can use the yacht_js_snippet method to wrap the string from Yacht::Loader#to_js_snippet in a script tag using Rails' javascript_tag helper.
+
+    Yacht.rails_env
+    # => "development"  # Yacht automatically adds the current Rails environment in ruby
+    # If you want rails_env included in javascript, just add it to js_keys.yml
+
+    # inside a view or helper:
+    yacht_js_snippet
+    # => "<script type=\"text/javascript\">\n//<![CDATA[\n;var Yacht = {\"cookie_domain\":\"localhost\",\"rails_env\":\"development\"};\n//]]>\n</script>"
+
+    # you can also pass options to yacht_js_snippet:
+    yacht_js_snippet(:merge => {:current_time => Time.now.to_s})
+    # => "<script type=\"text/javascript\">\n//<![CDATA[\n;var Yacht = {\"cookie_domain\":\"localhost\",\"rails_env\":\"development\",\"current_time\":\"06/29/2011\"};\n//]]>\n</script>"
+
+
 == License
 
 Yacht is licensed under the MIT License with one addition: The Software shall be used for Good, not Evil.

data/features/load.feature

@@ -4,7 +4,7 @@ Feature: Load configuration settings
   I want to load configuration settings from an external source like a YAML file
 
   Background:
-    Given a file named "base.yml" with:
+    Given a file named "yacht/base.yml" with:
     """
     default:
       :api_key: some_fake_key
@@ -24,6 +24,7 @@ Feature: Load configuration settings
         host: example.com
         reply-to: info@example.com
     """
+    And I set Yacht's YAML directory to: "yacht"
 
   Scenario: Load from YAML
     When I load Yacht with environment: "development"
@@ -43,7 +44,7 @@ Feature: Load configuration settings
       """
 
   Scenario: Local overrides with local.yml
-    Given a file named "local.yml" with:
+    Given a file named "yacht/local.yml" with:
       """
       :api_key: some_crazy_local_key
       """
@@ -64,7 +65,7 @@ Feature: Load configuration settings
         """
 
   Scenario: Whitelisting with whitelist.yml
-  Given a file named "whitelist.yml" with:
+    Given a file named "yacht/whitelist.yml" with:
     """
     - :partner_sites
     """
@@ -77,4 +78,16 @@ Feature: Load configuration settings
                                 'github'
                               ]
         }
-      """
+      """
+
+  @js
+  Scenario: Generate a Yacht.js file
+    Given a file named "yacht/js_keys.yml" with:
+    """
+    - :partner_sites
+    """
+    When I use Yacht to generate a javascript snippet with environment: "development"
+    Then the javascript snippet should contain:
+    """
+    ;var Yacht = {"partner_sites":["twitter","github"]};
+    """

data/features/missing_yaml_files.feature

@@ -3,28 +3,29 @@ Feature: Handle missing YAML files reasonably
   Missing YAML files should cause an error to be raised when reasonable
 
   Background:
-    Given a file named "base.yml" with:
+    Given a file named "yacht/base.yml" with:
     """
     development:
       api_key: some_fake_key
     """
+    And I set Yacht's YAML directory to: "yacht"
 
   Scenario: No base.yml
-    Given a file named "base.yml" does not exist
+    Given a file named "yacht/base.yml" does not exist
     When I try to use Yacht
     Then Yacht should raise an error with message: "Couldn't load base config"
 
   Scenario: No local.yml
-    Given a file named "local.yml" does not exist
+    Given a file named "yacht/local.yml" does not exist
     When I try to use Yacht
     Then Yacht should not raise an error
 
   Scenario: No whitelist.yml but whitelist not used
-    Given a file named "whitelist.yml" does not exist
+    Given a file named "yacht/whitelist.yml" does not exist
     When I try to use Yacht
     Then Yacht should not raise an error
 
   Scenario: No whitelist.yml and whitelist used
-    Given a file named "whitelist.yml" does not exist
+    Given a file named "yacht/whitelist.yml" does not exist
     When I try to use Yacht with a whitelist
     Then Yacht should raise an error with message: "Couldn't load whitelist"

data/features/step_definitions/aruba_extension_steps.rb

@@ -2,4 +2,9 @@ Given /^a file named "([^"]*)" does not exist$/ do |file_name|
   in_current_dir do
     FileUtils.rm(file_name) if File.file?(file_name)
   end
+end
+
+# Stock Aruba step definition doesn't recognize triple-quoted multiline strings
+Then /^the file "([^"]*)" should contain:$/ do |file, exact_content|
+  check_exact_file_content(file, exact_content)
 end

data/features/step_definitions/debugger_steps.rb

@@ -0,0 +1,4 @@
+Then /^debugger$/ do
+  debugger
+  nil
+end

data/features/step_definitions/error_handling_steps.rb

@@ -16,7 +16,6 @@ module ErrorHandlingHelpers
   # If an error is raised, return it instead
   def use_yacht(whitelist=false)
     in_current_dir do
-      Yacht::Loader.dir = '.'
       Yacht::Loader.environment = 'development'
       Yacht::Loader.to_classy_struct(:apply_whitelist? => whitelist)
     end

data/features/step_definitions/javascript_steps.rb

@@ -0,0 +1,9 @@
+When /^I use Yacht to generate a javascript snippet with environment: "([^"]*)"$/ do |env|
+  in_current_dir do
+    @js_snippet = Yacht::Loader.to_js_snippet(:env => env)
+  end
+end
+
+Then /^the javascript snippet should contain:$/ do |string|
+  @js_snippet.should == string
+end

data/features/step_definitions/loader_steps.rb

@@ -1,6 +1,11 @@
+Given /^I set Yacht's YAML directory to: "([^"]*)"$/ do |dir|
+  in_current_dir do
+    Yacht::Loader.dir = dir
+  end
+end
+
 When /^I define the constant "([^"]*)" with environment: "([^"]*)"( using a whitelist)?$/ do |constant_name, env, whitelist|
   in_current_dir do
-    Yacht::Loader.dir = '.'
     Yacht::Loader.environment = env
     Object.const_set( constant_name, Yacht::Loader.to_classy_struct(:apply_whitelist? => whitelist ) )
   end
@@ -15,7 +20,6 @@ Then /^the constant "([^"]*)" should contain the following hash:$/ do |constant_
 end
 
 When /^I load Yacht with environment: "([^"]*)"$/ do |env|
-  Yacht::Loader.dir = '.'
   Yacht::Loader.environment = env
 end
 

data/features/support/env.rb

@@ -1,4 +1,5 @@
 $:.unshift(File.dirname(__FILE__) + '/../../lib')
 
 require 'aruba/cucumber'
-require 'yacht'
+require 'yacht'
+require 'ruby-debug'

data/lib/monkeypatches/rails_helper.rb

@@ -0,0 +1,17 @@
+module Yacht::RailsHelper
+  # Create a string with a javascript version of Yacht values intended for inclusion in an HTML page
+  #
+  # @note environment will be set to Rails.env by default
+  #
+  # @example Set custom environment
+  #   yacht_js_snippet(:env => 'local_development')
+  #   # => "<script type=\"text/javascript\">;var Yacht = {\"foo\":\"bar\"};</script>"
+  def yacht_js_snippet(opts={})
+    javascript_tag Yacht::Loader.to_js_snippet(opts)
+  end
+end
+
+# TODO: use a Railtie to do this Rails-3-style
+module ApplicationHelper
+  include Yacht::RailsHelper
+end

data/lib/yacht/base.rb

@@ -3,10 +3,12 @@ class Yacht < BasicObject
   end
 
   class << self
+    # Return value for key retrieved from Yacht::Loader.to_hash
     def [](key)
       self._hash[key]
     end
 
+    # Return a hash with all values for current environment
     def _hash
       @_hash ||= Loader.to_hash
     end

data/lib/yacht/javascript.rb

@@ -0,0 +1,21 @@
+require 'json'
+
+class Yacht::Loader
+  class << self
+    # Returns a string snippet that can be eval'd in javascript
+    #  or included in the DOM
+    # @param [Hash] opts the options to pass to to_hash
+    # @option opts [Hash] :merge ({}) hash to be merged into to_hash
+    def to_js_snippet(opts={})
+      hash_to_merge = opts.delete(:merge) || {}
+      hash          = to_hash(opts).slice(*js_keys).merge(hash_to_merge)
+      ";var Yacht = #{hash.to_json};"
+    end
+
+    def js_keys
+      load_config_file(:js_keys, :expect_to_load => Array) || begin
+        raise Yacht::LoadError.new("Couldn't load js_keys")
+      end
+    end
+  end
+end

data/lib/yacht/loader.rb

@@ -7,12 +7,11 @@ class Yacht::Loader
     end
     attr_writer :environment
 
-    def dir
-      @dir ||= File.join( File.dirname(__FILE__), 'yacht')
-    end
-    attr_writer :dir
+    attr_accessor :dir
 
     def full_file_path_for_config(config_type)
+      raise Yacht::LoadError.new "No directory set" unless dir
+
       File.join( self.dir, "#{config_type}.yml" )
     end
 
@@ -23,13 +22,16 @@ class Yacht::Loader
     end
 
     def valid_config_types
-      %w( base local whitelist )
+      %w( base local whitelist js_keys )
     end
 
     def all
       chain_configs(base_config, self.environment).deep_merge(local_config)
     end
 
+    # @param [Hash] opts the options for creating the hash
+    # @option opts [String] :env environment to use from base.yml
+    # @option opts [Boolean] :apply_whitelist? (false) only include keys in whitelist.yml
     def to_hash(opts={})
      opts[:apply_whitelist?] ||= false unless opts.has_key?(:apply_whitelist?)
      self.environment = opts[:env] if opts.has_key?(:env)

data/lib/yacht/rails.rb

@@ -12,5 +12,12 @@ class Yacht::Loader
     def full_file_path_for_config(config_type)
       dir.join("#{config_type}.yml")
     end
+
+    # Add current Rails environment to defined keys
+    def all_with_rails_env
+      all_without_rails_env.merge('rails_env' => Rails.env)
+    end
+    alias_method_chain :all, :rails_env
+
   end
 end

data/lib/yacht/version.rb

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

data/lib/yacht.rb

@@ -1,7 +1,14 @@
+require "yacht/version"
+
+require 'monkeypatches/hash'
+
 require "yacht/base"
 require "yacht/loader"
-require "yacht/classy_struct"
-require "yacht/version"
 
-require "yacht/rails" if Object.const_defined?(:Rails)
-require 'monkeypatches/hash'
+if Object.const_defined?(:Rails)
+  require "yacht/rails"
+  require "monkeypatches/rails_helper"
+end
+
+require "yacht/classy_struct"
+require "yacht/javascript"

data/spec/monkeypatches/rails_helper_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe 'Yacht::RailsHelper' do
+  let(:mock_js_string) {
+    ';var Yacht = {"foo":"bar"};'
+  }
+
+  # need a dummy class to test out the Yacht::RailsHelper module
+  let(:dummy_class) {
+    class DummyClass
+    end
+    DummyClass
+  }
+
+  let(:dummy_instance) {
+    dummy_class.new
+  }
+
+  before do
+    Rails             = stub('Rails')
+
+    require "monkeypatches/rails_helper"
+
+    dummy_class.send(:include, Yacht::RailsHelper)
+  end
+
+  describe :yacht_js_snippet do
+    it "should use javascript_tag to create a snippet using the current Rails environment by default" do
+      Yacht::Loader.stub(:to_js_snippet).and_return(mock_js_string)
+      dummy_instance.should_receive(:javascript_tag).with(mock_js_string)
+
+      dummy_instance.yacht_js_snippet
+    end
+
+    it "should pass options to Yacht::Loader#to_js_snippet" do
+      dummy_instance.stub(:javascript_tag).as_null_object
+
+      Yacht::Loader.should_receive(:to_js_snippet).with(:foo => 'bar').and_return("")
+
+      dummy_instance.yacht_js_snippet(:foo => 'bar')
+    end
+
+    it "should add yacht_js_snippet to ApplicationHelper" do
+      ApplicationHelper.should <= Yacht::RailsHelper
+    end
+  end
+end

data/spec/yacht/classy_struct_spec.rb

@@ -51,7 +51,6 @@ describe Yacht::Loader do
 end
 
 describe Yacht do
-  subject { Yacht }
   after do
     Yacht.instance_variable_set(:@_hash, nil)
     Yacht.instance_variable_set(:@_classy_struct, nil)

data/spec/yacht/javascript_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Yacht::Loader do
+  subject{ Yacht::Loader }
+
+  let(:mock_js_string) {
+    ';var Yacht = {"foo":"bar"};'
+  }
+
+  describe :to_js_snippet do
+    it "should export Yacht values to a javascript file" do
+      subject.stub(:all).and_return(:foo => 'bar')
+      subject.stub(:js_keys).and_return(:foo)
+
+      subject.to_js_snippet.should == ';var Yacht = {"foo":"bar"};'
+    end
+
+    it "should only export values defined in javascript.yml" do
+      subject.stub(:to_hash).and_return(:foo => 'bar', :baz => 'snafu')
+      subject.stub(:js_keys).and_return(:baz)
+
+      subject.to_js_snippet.should == ';var Yacht = {"baz":"snafu"};'
+    end
+
+    it "merges the hash passed with :merge" do
+      subject.stub(:to_hash).and_return(:foo => 'bar', :baz => 'snafu')
+      subject.stub(:js_keys).and_return(:baz)
+
+      subject.to_js_snippet(:merge => {:request_id => 123}).should == ';var Yacht = {"baz":"snafu","request_id":123};'
+    end
+  end
+
+  describe :js_keys do
+    it "raises an error if load_config_file returns nil" do
+      subject.stub(:load_config_file).with(:js_keys, :expect_to_load => Array).and_return(nil)
+
+      expect {
+        subject.js_keys
+      }.to raise_error( Yacht::LoadError, "Couldn't load js_keys")
+    end
+
+    it "expects load_config_file to return an Array" do
+      subject.should_receive(:load_config_file).with(:js_keys, :expect_to_load => Array).and_return([])
+
+      subject.js_keys
+    end
+  end
+end

data/spec/yacht/loader_spec.rb

@@ -16,6 +16,9 @@ describe Yacht::Loader do
     }
   end
 
+  describe :dir do
+  end
+
   describe :to_hash do
     before do
       subject.stub(:base_config).and_return(mock_base_config)
@@ -96,6 +99,7 @@ describe Yacht::Loader do
           :color_of_the_day => 'purple',
         }
       })
+      subject.stub(:local_config).and_return({})
 
       subject.environment = 'wacky'
       subject.to_hash[:color_of_the_day].should == 'purple'
@@ -198,7 +202,37 @@ describe Yacht::Loader do
         subject.send(:load_config_file, :foo, :expect_to_load => Array)
       }.to raise_error( Yacht::LoadError, "foo_file must contain Array (got Hash)" )
     end
+  end
+
+  describe :_load_config_file do
+    it "returns nil if file does not exist" do
+      File.stub(:exists?).with('some_file').and_return(false)
+      subject.send(:_load_config_file, 'some_file').should be_nil
+    end
+
+    it "opens the file using YAML.load if the file exists" do
+      File.stub(:exists?).with('some_file').and_return(true)
+      File.stub(:read).with('some_file').and_return('some contents')
+      YAML.should_receive(:load).with('some contents')
+
+      subject.send(:_load_config_file, 'some_file')
+    end
+  end
+
+  describe :full_file_path_for_config do
+    it "raises an error if dir is blank" do
+      subject.stub(:dir).and_return(nil)
+
+      expect {
+        subject.full_file_path_for_config(:base)
+      }.to raise_error( Yacht::LoadError, "No directory set" )
+    end
 
+    it "returns the full path to the YAML file for the given config type" do
+      subject.stub(:dir).and_return('/full/path')
+
+      subject.full_file_path_for_config(:foo).should == '/full/path/foo.yml'
+    end
   end
 
   context "checks environment and sets sensible defaults" do

data/spec/yacht/rails_spec.rb

@@ -4,18 +4,17 @@ describe "Rails support" do
   subject { Yacht::Loader }
 
   before do
+    Rails = stub("Rails")
+    Object.stub(:alias_method_chain).as_null_object
     require "yacht/rails"
     @yacht_dir = "/path/to/rails/config/yacht"
   end
 
   describe :environment do
-    before do
-      Rails = stub("Rails")
-    end
     it "uses the current rails environment by default" do
-      Rails.should_receive(:env)
+      Rails.should_receive(:env).and_return('awesome')
 
-      subject.environment
+      subject.environment.should == 'awesome'
     end
   end
 
@@ -36,4 +35,18 @@ describe "Rails support" do
       subject.full_file_path_for_config("some")
     end
   end
+
+  describe :all_with_rails_env do
+    it "adds the current Rails environment to super" do
+      subject.stub(:all_without_rails_env).and_return(:foo => :bar)
+
+      Rails.stub(:env).and_return(:awesome)
+      subject.all_with_rails_env.should == {:foo => :bar, 'rails_env' => :awesome}
+    end
+
+    it "aliases all to all_without_rails_env" do
+      Object.should_receive(:alias_method_chain).with(:all, :rails_env)
+      load "yacht/rails.rb"
+    end
+  end
 end

data/yacht.gemspec

@@ -16,14 +16,16 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
 
   s.add_dependency "classy_struct", ">= 0.3.2"
+  s.add_dependency "json"
 
-  s.add_development_dependency "gherkin", '~> 2.3.0'
+  s.add_development_dependency "gherkin", '>= 2.4.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.2.0
+  version: 0.2.5
 platform: ruby
 authors: 
 - Mani Tadayon
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-16 00:00:00 -07:00
+date: 2011-06-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,60 +26,71 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: gherkin
+  name: json
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.0
-  type: :development
+        version: "0"
+  type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: cucumber
+  name: gherkin
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.10.0
+        version: 2.4.0
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: aruba
+  name: cucumber
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 0.10.0
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: aruba
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.6.0
+        version: "0"
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: simplecov
+  name: rspec
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.4.1
+        version: 2.6.0
   type: :development
   version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.1
+  type: :development
+  version_requirements: *id007
 description: Yacht is Yet Another Configuration Helper Tool.
 email: 
 - mtadayon@atti.com
@@ -103,22 +114,28 @@ files:
 - features/load.feature
 - features/missing_yaml_files.feature
 - features/step_definitions/aruba_extension_steps.rb
+- features/step_definitions/debugger_steps.rb
 - features/step_definitions/error_handling_steps.rb
+- features/step_definitions/javascript_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/monkeypatches/rails_helper.rb
 - lib/yacht.rb
 - lib/yacht/base.rb
 - lib/yacht/classy_struct.rb
+- lib/yacht/javascript.rb
 - lib/yacht/loader.rb
 - lib/yacht/rails.rb
 - lib/yacht/version.rb
+- spec/monkeypatches/rails_helper_spec.rb
 - spec/spec_helper.rb
 - spec/yacht/base_spec.rb
 - spec/yacht/classy_struct_spec.rb
+- spec/yacht/javascript_spec.rb
 - spec/yacht/loader_spec.rb
 - spec/yacht/rails_spec.rb
 - yacht.gemspec
@@ -146,13 +163,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.9.1
+rubygems_version: 1.3.9.2
 signing_key: 
 specification_version: 3
-summary: yacht-0.2.0
+summary: yacht-0.2.5
 test_files: 
+- spec/monkeypatches/rails_helper_spec.rb
 - spec/spec_helper.rb
 - spec/yacht/base_spec.rb
 - spec/yacht/classy_struct_spec.rb
+- spec/yacht/javascript_spec.rb
 - spec/yacht/loader_spec.rb
 - spec/yacht/rails_spec.rb