yacht 0.2.7 → 0.3.0

data/.gitignore

@@ -1,7 +1,12 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
 coverage
 tmp
 doc
 .yardoc
-*.gem
 .DS_Store
-Gemfile.lock
+
+.rvmrc
+.rbenv*

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree

data/HISTORY.md

@@ -1,3 +1,18 @@
+## [0.3.0](https://github.com/attinteractive/yacht/compare/0.2.7...0.3.0)
+
+### Less features
+* Remove some unnecessary Rails support features ([#18](https://github.com/attinteractive/yacht/issues/18))
+
+### Add Travis CI to github repo
+
+## [0.2.7](https://github.com/attinteractive/yacht/compare/0.2.6...0.2.7)
+
+### Bugfixes
+* Compatibility with ruby 1.8.7 ([#16](https://github.com/attinteractive/yacht/issues/16) Mani Tadayon)
+
+### New features
+* Don't monkeypatch Hash, use a module instead ([#11](https://github.com/attinteractive/yacht/issues/11) Mani Tadayon)
+
 ## [0.2.6](https://github.com/attinteractive/yacht/compare/0.2.5...0.2.6)
 
 ### Bugfixes

data/LICENSE

@@ -10,8 +10,6 @@ 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 shall be used for Good, not Evil.
-
 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

data/README.rdoc

@@ -1,4 +1,4 @@
-= Yacht
+= Yacht {<img src="https://secure.travis-ci.org/attinteractive/yacht.png" alt="Build Status" />}[http://travis-ci.org/attinteractive/yacht]
 
 Yacht is an application configuration gem that lets you define settings for multiple environments in YAML files. It is similar to AppConfig[https://github.com/cjbottaro/app_config] with additional features like:
 * use of ClassyStruct for improved performance over OpenStruct
@@ -55,8 +55,7 @@ First create one or more of the following YAML files in the same directory to de
     # config/yacht/local.yml (optional)
     # any values set in local.yml will override values set in base.yml
     # useful for development and testing
-    production:
-      cdn_host: localhost
+    cdn_host: localhost
 
 === Step 2: Use +Yacht.my_key+ or <tt>Yacht['my_key']</tt> in ruby
 
@@ -78,12 +77,12 @@ First create one or more of the following YAML files in the same directory to de
 === <tt>Yacht::Loader.to_js_snippet</tt> 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
+    # config/yacht/js_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:
+Then use <tt>Yacht::Loader#to_js_snippet</tt> 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\"};"
@@ -94,27 +93,31 @@ You can also add in extra values from outside of Yacht using the :merge option,
     # => ";var Yacht = {\"cookie_domain\":\"example.com\",\"current_time\":\"06/29/2011\"};"
 
 
-=== +yacht_js_snippet+ Rails helper
+=== Rails
+
+To use Yacht inside of Rails, just add an initializer to <tt>config/initializers</tt>:
 
-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.
+    # config/initializers/00_yacht_init.rb
 
-    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
+    # Yacht needs to know where to find its YAML files...
+    # ...and the current Rails environment
+    Yacht::Loader.dir          = Rails.root.join('config', 'yacht')
+    Yacht::Loader.environment  = Rails.env
+
+When used inside of a Rails application, the <tt>yacht_js_snippet</tt> Rails helper is included in the global <tt>ApplicationHelper</tt> so you can use it in views. <tt>yacht_js_snippet</tt> wraps the string from <tt>Yacht::Loader#to_js_snippet</tt> in a script tag using Rails' +javascript_tag+ helper.
 
     # 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>"
+    # => "<script type=\"text/javascript\">\n//<![CDATA[\n;var Yacht = {\"cookie_domain\":\"localhost\"\n//]]>\n</script>"
 
-    # you can also pass options to yacht_js_snippet:
-    yacht_js_snippet(:merge => {:current_time => Time.now.to_s})
+    # you can also pass options to yacht_js_snippet, like the the current Rails environment:
+    yacht_js_snippet(:merge => {:current_time => Time.now.to_s, :rails_env => Rails.env})
     # => "<script type=\"text/javascript\">\n//<![CDATA[\n;var Yacht = {\"cookie_domain\":\"localhost\",\"rails_env\":\"development\",\"current_time\":\"06/29/2011\"};\n//]]>\n</script>"
 
-
 == Ruby compatibility
 
 Yacht works with ruby 1.8.7 and 1.9.2.
 
 == 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.

data/Rakefile

@@ -1,8 +1,4 @@
-# encoding: utf-8
-require 'rubygems'
-require 'bundler'
-Bundler.setup
-Bundler::GemHelper.install_tasks
+require 'bundler/gem_tasks'
 
 Dir['gem_tasks/**/*.rake'].each { |rake| load rake }
 

data/features/load.feature

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

data/lib/monkeypatches/rails_helper.rb

@@ -1,8 +1,6 @@
 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>"

data/lib/yacht.rb

@@ -1,12 +1,9 @@
 require "yacht/version"
 
-# require 'monkeypatches/hash'
-
 require "yacht/base"
 require "yacht/loader"
 
 if Object.const_defined?(:Rails)
-  require "yacht/rails"
   require "monkeypatches/rails_helper"
 end
 

data/lib/yacht/loader.rb

@@ -10,7 +10,7 @@ class Yacht::Loader
     attr_accessor :dir
 
     def full_file_path_for_config(config_type)
-      raise Yacht::LoadError.new "No directory set" unless dir
+      raise Yacht::LoadError.new "No directory set" unless self.dir
 
       File.join( self.dir, "#{config_type}.yml" )
     end

data/lib/yacht/version.rb

@@ -1,3 +1,3 @@
 class Yacht
-  VERSION = "0.2.7"
+  VERSION = "0.3.0"
 end

data/spec/monkeypatches/rails_helper_spec.rb

@@ -17,7 +17,7 @@ describe 'Yacht::RailsHelper' do
   }
 
   before do
-    Rails             = stub('Rails')
+    Kernel.stub('Rails')
 
     require "monkeypatches/rails_helper"
 

data/spec/spec_helper.rb

@@ -7,6 +7,8 @@ Bundler.setup
 
 require 'yacht'
 
+Dir['./spec/support/**/*.rb'].map {|f| require f}
+
 RSpec.configure do |config|
   config.before :all do
     # ==============

data/spec/support/constants.rb

@@ -0,0 +1,57 @@
+# Mock a constant within the passed block
+# @example mock RAILS_ENV constant
+#   it "does not allow links to be added in production environment" do
+#     with_constants :RAILS_ENV => 'production' do
+#       get :add, @nonexistent_link.url
+#       response.should_not be_success
+#     end
+#   end
+# @note adapted from:
+#   * http://stackoverflow.com/a/7849835/457819
+#   * http://digitaldumptruck.jotabout.com/?p=551
+def with_constants(constants)
+  @constants_to_restore = {}
+  @constants_to_unset   = []
+
+  constants.each do |name, val|
+    if Object.const_defined?(name)
+      @constants_to_restore[name] = Object.const_get(name)
+    else
+      @constants_to_unset << name
+    end
+
+    Object.const_set( name, val )
+  end
+
+  begin
+    yield
+  ensure
+    @constants_to_restore.each do |name, val|
+      Object.const_set( name, val )
+    end
+
+    @constants_to_unset.each do |name|
+      Object.send(:remove_const, name)
+    end
+  end
+end
+
+def without_constants(constants)
+  @constants_to_restore = {}
+
+  constants.each do |name, val|
+    if Object.const_defined?(name)
+      @constants_to_restore[name] = Object.const_get(name)
+    end
+
+    Object.send(:remove_const, name)
+  end
+
+  begin
+    yield
+  ensure
+    @constants_to_restore.each do |name, val|
+      Object.const_set( name, val )
+    end
+  end
+end

data/spec/yacht/javascript_spec.rb

@@ -26,7 +26,13 @@ describe Yacht::Loader 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};'
+      correct_snippets = [  # hash key order is random in ruby 1.8.7
+        ';var Yacht = {"baz":"snafu","request_id":123};',
+        ';var Yacht = {"request_id":123,"baz":"snafu"};'
+      ]
+
+      actual = subject.to_js_snippet(:merge => {:request_id => 123})
+      correct_snippets.should include(actual)
     end
   end
 

data/yacht.gemspec

@@ -1,6 +1,5 @@
 # -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib/', __FILE__)
-$:.unshift lib unless $:.include?(lib)
+$:.push File.expand_path("../lib", __FILE__)
 
 require 'yacht/version'
 
@@ -8,28 +7,22 @@ Gem::Specification.new do |s|
   s.name        = "yacht"
   s.version     = Yacht::VERSION
   s.authors     = ["Mani Tadayon", "Rico Rodriquez Collins"]
-  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"
+  s.summary     = "yacht-#{s.version}"
+  s.description = "Yacht is Yet Another Configuration Helper Tool."
 
-  s.platform    = Gem::Platform::RUBY
-
-  s.add_dependency "classy_struct", ">= 0.3.2"
+  s.add_dependency "classy_struct", "~> 0.3.2"
   s.add_dependency "json"
 
-  s.add_development_dependency "gherkin", '>= 2.4.0'
+  s.add_development_dependency "gherkin", '~> 2.4.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'
-
-
-
-  s.required_rubygems_version = ">= 1.3.7"
-  s.files            = `git ls-files`.split("\n")
-  s.test_files       = `git ls-files -- spec/*`.split("\n")
-  s.extra_rdoc_files = ["LICENSE", "README.rdoc"]
-  s.rdoc_options     = ["--charset=UTF-8"]
-  s.require_path = "lib"
-end
+  s.add_development_dependency "rspec", '~> 2.6.0'
+  s.add_development_dependency "simplecov", '~> 0.4.1'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: yacht
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
-  - 7
-  version: 0.2.7
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Mani Tadayon
@@ -16,7 +16,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-27 00:00:00 Z
+date: 2012-01-06 00:00:00 -08:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: classy_struct
@@ -24,7 +25,7 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 23
         segments: 
@@ -54,7 +55,7 @@ dependencies:
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 31
         segments: 
@@ -99,7 +100,7 @@ dependencies:
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 23
         segments: 
@@ -115,7 +116,7 @@ dependencies:
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 13
         segments: 
@@ -133,13 +134,12 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
 - .gitignore
 - .rspec
-- .rvmrc
+- .travis.yml
 - .yardopts
 - Gemfile
 - HISTORY.md
@@ -164,22 +164,22 @@ files:
 - lib/yacht/hash_helper.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/support/constants.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
+has_rdoc: true
 homepage: https://github.com/attinteractive/yacht
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -196,24 +196,31 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 21
+      hash: 3
       segments: 
-      - 1
-      - 3
-      - 7
-      version: 1.3.7
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: yacht-0.2.7
+summary: yacht-0.3.0
 test_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
 - spec/monkeypatches/rails_helper_spec.rb
 - spec/spec_helper.rb
+- spec/support/constants.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

data/.rvmrc

@@ -1,23 +0,0 @@
-#!/usr/bin/env bash
-
-# adapted from: http://rvm.beginrescueend.com/workflow/rvmrc/
-
-ruby_string="1.9.2-p0"
-gemset_name="yacht"
-
-if rvm list strings | grep -q "${ruby_string}" ; then
-
-  # Load or create the specified environment
-  if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
-    && -s "${rvm_path:-$HOME/.rvm}/environments/${ruby_string}@${gemset_name}" ]] ; then
-    \. "${rvm_path:-$HOME/.rvm}/environments/${ruby_string}@${gemset_name}"
-  else
-    rvm --create  "${ruby_string}@${gemset_name}"
-  fi
-
-else
-
-  # Notify the user to install the desired interpreter before proceeding.
-  echo "${ruby_string} was not found, please run 'rvm install ${ruby_string}' and then cd back into the project directory."
-
-fi

data/lib/yacht/rails.rb

@@ -1,25 +0,0 @@
-class Yacht::Loader
-  class << self
-    # use the current rails environment by default
-    def environment
-      @environment ||= Rails.env
-    end
-
-    def dir
-      @dir ||= Rails.root.join('config', 'yacht')
-    end
-
-    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 is wonky in rspec with ruby 1.8.7
-    alias_method :all_without_rails_env, :all
-    alias_method :all, :all_with_rails_env
-
-  end
-end

data/spec/yacht/rails_spec.rb

@@ -1,47 +0,0 @@
-require 'spec_helper'
-
-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
-    it "uses the current rails environment by default" do
-      Rails.should_receive(:env).and_return('awesome')
-
-      subject.environment.should == 'awesome'
-    end
-  end
-
-  describe :dir do
-    it "uses config/yacht by default" do
-      Rails.stub_chain(:root, :join).and_return(@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")
-      subject.stub(:dir).and_return(fake_dir)
-      fake_dir.should_receive(:join).with("some.yml")
-
-      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
-  end
-end