yacht 0.2.6 → 0.2.7

data/HISTORY.md

@@ -0,0 +1,27 @@
+## [0.2.6](https://github.com/attinteractive/yacht/compare/0.2.5...0.2.6)
+
+### Bugfixes
+* Making it possible to have any environment without having a configuration ([#13](https://github.com/attinteractive/yacht/pull/13) Alf Mikula)
+* Correct docs
+* Update cucumber version in development dependencies
+* Clean up documentation
+* Clean up cucumber features
+
+
+## [0.2.5](https://github.com/attinteractive/yacht/compare/0.2.0...0.2.5)
+
+### Bugfixes
+* Fix bug with default value for Yacht::Loader.dir by forcing manual setting of dir outside of rails
+
+### New Features
+* Add feature that allows export to javascript ([#2](https://github.com/attinteractive/yacht/issues/2) Mani Tadayon)
+* Add :rails_env key when Rails is defined
+
+
+## [0.2.0](https://github.com/attinteractive/yacht/compare/0.1.2...0.2.0)
+
+### New Features
+* Use Yacht for name of class instead of YachtLoader
+ ([#1](https://github.com/attinteractive/yacht/issues/1) Mani Tadayon)
+* Add Cucumber features
+* Simplify RSpec examples covered by new cucumber features

data/README.rdoc

@@ -58,12 +58,14 @@ First create one or more of the following YAML files in the same directory to de
     production:
       cdn_host: localhost
 
-=== Step 2: Use Yacht.my_key or Yacht['my_key'] in ruby
+=== Step 2: Use +Yacht.my_key+ or <tt>Yacht['my_key']</tt> in ruby
 
 * <b>Rails</b>:
     # now you can access any key set in your YAML files with:
     Yacht.my_key
     # => "my_value"
+    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'
@@ -73,7 +75,7 @@ First create one or more of the following YAML files in the same directory to de
 
 == Other features
 
-=== Yacht::Loader.to_js_snippet export to javascript
+=== <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
@@ -81,7 +83,7 @@ If you would like to access values stored in Yacht inside of javascript, there i
     # 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 +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\"};"
@@ -92,9 +94,9 @@ 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
+=== +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.
+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
@@ -109,6 +111,10 @@ When using Yacht inside of a Rails application, you can use the yacht_js_snippet
     # => "<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.

data/lib/yacht/base.rb

@@ -1,4 +1,4 @@
-class Yacht < BasicObject
+class Yacht
   class LoadError < ::StandardError
   end
 

data/lib/yacht/classy_struct.rb

@@ -1,6 +1,6 @@
 require 'classy_struct'
 
-class Yacht < BasicObject
+class Yacht
   class Loader
     class << self
       def classy_struct_instance

data/lib/yacht/hash_helper.rb

@@ -0,0 +1,23 @@
+module Yacht::HashHelper
+  # adapted from https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/hash/deep_merge.rb
+  # Returns a new hash with +some_hash+ and +other_hash+ merged recursively.
+  # Equivalent to some_hash.deep_merge(other_hash) in Rails
+  def deep_merge(some_hash, other_hash)
+    some_hash.merge(other_hash) do |key, oldval, newval|
+      oldval = oldval.to_hash if oldval.respond_to?(:to_hash)
+      newval = newval.to_hash if newval.respond_to?(:to_hash)
+      oldval.class.to_s == 'Hash' && newval.class.to_s == 'Hash' ? deep_merge(oldval, newval) : newval
+    end
+  end
+  module_function :deep_merge
+
+  # adapted from http://as.rubyonrails.org/classes/ActiveSupport/CoreExtensions/Hash/Slice.html
+  # Returns a new hash with only the given keys
+  def slice(some_hash, *keys)
+    allowed = Set.new(keys)
+    hash = {}
+    allowed.each { |k| hash[k] = some_hash[k] if some_hash.has_key?(k) }
+    hash
+  end
+  module_function :slice
+end

data/lib/yacht/javascript.rb

@@ -1,3 +1,4 @@
+require "yacht/hash_helper"
 require 'json'
 
 class Yacht::Loader
@@ -8,7 +9,7 @@ class Yacht::Loader
     # @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)
+      hash          = Yacht::HashHelper.slice(to_hash(opts), *js_keys).merge(hash_to_merge)
       ";var Yacht = #{hash.to_json};"
     end
 

data/lib/yacht/loader.rb

@@ -1,3 +1,5 @@
+require "yacht/hash_helper"
+
 class Yacht::Loader
   class << self
     def environment
@@ -26,7 +28,7 @@ class Yacht::Loader
     end
 
     def all
-      chain_configs(base_config, self.environment).deep_merge(local_config)
+      Yacht::HashHelper.deep_merge( chain_configs(base_config, self.environment), local_config )
     end
 
     # @param [Hash] opts the options for creating the hash
@@ -37,7 +39,7 @@ class Yacht::Loader
      self.environment = opts[:env] if opts.has_key?(:env)
 
      if opts[:apply_whitelist?]
-       all.slice(*whitelist)
+       Yacht::HashHelper.slice(all, *whitelist)
      else
        all
      end
@@ -93,7 +95,7 @@ class Yacht::Loader
                    config['default'] || {}
                  end
 
-        parent.deep_merge(config[env])
+        Yacht::HashHelper.deep_merge(parent, config[env])
       else
         config['default'] || {}
       end

data/lib/yacht/rails.rb

@@ -17,7 +17,9 @@ class Yacht::Loader
     def all_with_rails_env
       all_without_rails_env.merge('rails_env' => Rails.env)
     end
-    alias_method_chain :all, :rails_env
+    # 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/lib/yacht/version.rb

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

data/lib/yacht.rb

@@ -1,6 +1,6 @@
 require "yacht/version"
 
-require 'monkeypatches/hash'
+# require 'monkeypatches/hash'
 
 require "yacht/base"
 require "yacht/loader"

data/spec/spec_helper.rb

@@ -5,15 +5,17 @@ require 'rubygems'
 require 'bundler'
 Bundler.setup
 
-# ==============
-# = SimpleCov! =
-# ==============
-require 'simplecov'
-SimpleCov.start
-
 require 'yacht'
 
 RSpec.configure do |config|
+  config.before :all do
+    # ==============
+    # = SimpleCov! =
+    # ==============
+    require 'simplecov'
+    SimpleCov.start
+  end
+
   config.after :each do
     Yacht::Loader.environment = nil
     Yacht::Loader.dir         = nil

data/spec/yacht/rails_spec.rb

@@ -43,10 +43,5 @@ describe "Rails support" do
       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

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: yacht
 version: !ruby/object:Gem::Version 
+  hash: 25
   prerelease: 
-  version: 0.2.6
+  segments: 
+  - 0
+  - 2
+  - 7
+  version: 0.2.7
 platform: ruby
 authors: 
 - Mani Tadayon
@@ -11,8 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-01 00:00:00 -07:00
-default_executable: 
+date: 2011-07-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: classy_struct
@@ -22,6 +26,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 3
+        - 2
         version: 0.3.2
   type: :runtime
   version_requirements: *id001
@@ -33,6 +42,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
@@ -44,6 +56,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 4
+        - 0
         version: 2.4.0
   type: :development
   version_requirements: *id003
@@ -55,6 +72,10 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
         version: "1.0"
   type: :development
   version_requirements: *id004
@@ -66,6 +87,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :development
   version_requirements: *id005
@@ -77,6 +101,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
         version: 2.6.0
   type: :development
   version_requirements: *id006
@@ -88,6 +117,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 4
+        - 1
         version: 0.4.1
   type: :development
   version_requirements: *id007
@@ -108,6 +142,7 @@ files:
 - .rvmrc
 - .yardopts
 - Gemfile
+- HISTORY.md
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -122,11 +157,11 @@ files:
 - 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/hash_helper.rb
 - lib/yacht/javascript.rb
 - lib/yacht/loader.rb
 - lib/yacht/rails.rb
@@ -139,7 +174,6 @@ files:
 - spec/yacht/loader_spec.rb
 - spec/yacht/rails_spec.rb
 - yacht.gemspec
-has_rdoc: true
 homepage: https://github.com/attinteractive/yacht
 licenses: []
 
@@ -153,20 +187,28 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 21
+      segments: 
+      - 1
+      - 3
+      - 7
       version: 1.3.7
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.9.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: yacht-0.2.6
+summary: yacht-0.2.7
 test_files: 
 - spec/monkeypatches/rails_helper_spec.rb
 - spec/spec_helper.rb

data/lib/monkeypatches/hash.rb

@@ -1,24 +0,0 @@
-if !Hash.instance_methods.include?(:deep_merge)
-  class Hash
-    # copied from ActiveSupport::CoreExtensions::Hash::DeepMerge 2.3.8
-    def deep_merge(other_hash)
-      self.merge(other_hash) do |key, oldval, newval|
-        oldval = oldval.to_hash if oldval.respond_to?(:to_hash)
-        newval = newval.to_hash if newval.respond_to?(:to_hash)
-        oldval.class.to_s == 'Hash' && newval.class.to_s == 'Hash' ? oldval.deep_merge(newval) : newval
-      end
-    end
-  end
-end
-
-if !Hash.instance_methods.include?(:slice)
-  class Hash
-    # copied from http://as.rubyonrails.org/classes/ActiveSupport/CoreExtensions/Hash/Slice.html
-    def slice(*keys)
-      allowed = Set.new(respond_to?(:convert_key) ? keys.map { |key| convert_key(key) } : keys)
-      hash = {}
-      allowed.each { |k| hash[k] = self[k] if has_key?(k) }
-      hash
-    end
-  end
-end