poise-hoist 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17c2ff1e81f2fe651f4c3a048482985b8f57431c
-  data.tar.gz: df81c9f07b4009c074d02db0783140e286cbad44
+  metadata.gz: fa17c579cae5930699ac620980f878e0a8512889
+  data.tar.gz: a0f4dddbe610cfe9f9dca8993d73a16b21b3fa25
 SHA512:
-  metadata.gz: 5bc25b30445c863e1b3205b537bc49985c0a4216943df3930b9721527c2ca5659964aef54b6a2430baa07129a5bc55da111f5a6216a5d7eba81ec47e26e5ac15
-  data.tar.gz: f6d9e8490017afa7b2077e260e8a8bf46bba4509ad0394dcfd313a0cab9c51d17674d8f7017583289974ee7b0f477cf55570497f2461a025bca5297debcc79e1
+  metadata.gz: c066fd3561a0f3885316fabcdf4f3a246dfcfdcd2e769f794f30a8706e36f200c4ed5d0852b7e4e54f28308cb5fe7fb1f3dc80131fbc2f453d6300caac59717b
+  data.tar.gz: 088b1d2b6cc2b7c53c43e56fe79c666a3c9fc34d28991e1946f9a3f686b863d30850e833deeeb0158f3d0e3e93ef9b61f449e040ed13ee234f2f089b5d28ae96

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Poise-Hoist Changelog
 
+## v1.1.0
+
+* Add `node.chef_environment` shim for older cookbooks.
+
 ## v1.0.0
 
 * Initial release!

data/README.md

@@ -41,6 +41,12 @@ group will always be `local`.
 default['local']['myapp']['debug_mode'] = true
 ```
 
+## Environment Shim
+
+For older cookbooks still expecting to use `node.chef_environment`, by default
+that method will be patched to return the policy group label instead. This can
+be disabled by setting `node['poise-hoist']['hoist_chef_environment'] = false`.
+
 ## Sponsors
 
 Development sponsored by [Bloomberg](http://www.bloomberg.com/company/technology/).

data/chef/attributes/default.rb

@@ -14,5 +14,8 @@
 # limitations under the License.
 #
 
+# Enable node.chef_environment by default.
+default['poise-hoist']['hoist_chef_environment'] = true
+
 # If we weren't able to run it during library load, do it now.
 PoiseHoist.hoist!(node) unless defined?(Chef.node)

data/lib/poise_hoist.rb

@@ -23,15 +23,42 @@ require 'chef/mixin/deep_merge'
 module PoiseHoist
   autoload :VERSION, 'poise_hoist/version'
 
+  # Run the attribute hoist process.
+  #
+  # @param node [Chef::Node] Node object to modify.
+  # @return [void]
   def self.hoist!(node)
-    # Do nothing if we aren't using policies.
     policy_group = (defined?(node.policy_group) && node.policy_group) || \
                    Chef::Config[:policy_group] || \
                    (Chef::Config[:deployment_group] && Chef::Config[:deployment_group].split(/-/).last)
+    # Don't continue if we aren't using policies.
     return unless policy_group
     Chef::Log.debug("Running attribute Hoist for group #{policy_group}")
     # Hoist away, mateys!
     Chef::Mixin::DeepMerge.hash_only_merge!(node.role_default, node.role_default[policy_group]) if node.role_default.include?(policy_group)
     Chef::Mixin::DeepMerge.hash_only_merge!(node.role_override, node.role_override[policy_group]) if node.role_override.include?(policy_group)
+    # Install the patch for chef_environment.
+    patch_chef_environment!(node, policy_group)
   end
+
+  # Patch `node.chef_environment` to return the policy group name if enabled
+  # via `node['poise-hoist']['hoist_chef_environment']`.
+  #
+  # @api private
+  # @since 1.1.0
+  # @param node [Chef::Node] Node object to modify.
+  # @param policy_group [String] Policy group name.
+  # @return [void]
+  def self.patch_chef_environment!(node, policy_group)
+    old_accessor = node.method(:chef_environment)
+    # Not using Poise::NOT_PASSED because this doesn't depend on Poise.
+    node.define_singleton_method(:chef_environment) do |*args|
+      if args.empty? && node['poise-hoist']['hoist_chef_environment']
+        policy_group
+      else
+        old_accessor.call(*args)
+      end
+    end
+  end
+
 end

data/lib/poise_hoist/version.rb

@@ -17,5 +17,5 @@
 
 module PoiseHoist
   # Version for the poise-hoist gem.
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/test/cookbook/recipes/default.rb

@@ -17,3 +17,7 @@
 file '/hoist_test' do
   content node['hoist_test'].to_hash.to_json
 end
+
+file '/hoist_environment' do
+  content node.chef_environment
+end

data/test/integration/default/default_spec.rb

@@ -17,3 +17,7 @@
 describe file('/hoist_test') do
   its(:content) { is_expected.to eq '{"one":11,"two":222,"three":3}' }
 end
+
+describe file('/hoist_environment') do
+  its(:content) { is_expected.to eq 'local' }
+end

data/test/spec/poise_hoist_spec.rb

@@ -126,4 +126,15 @@ describe PoiseHoist do
     its(%w{baseline deep four}) { is_expected.to eq [4] }
     its(%w{top}) { is_expected.to eq 'dog' }
   end # /context with a top-level override policy attribute
+
+  describe 'patch_chef_environment!' do
+    context 'with patching enabled (default)' do
+      it { subject; expect(chef_run.node.chef_environment).to eq 'mygroup' }
+    end # /context with patching enabled (default)
+
+    context 'with patching disabled' do
+      before { override_attributes['poise-hoist'] = {'hoist_chef_environment' => false} }
+      it { subject; expect(chef_run.node.chef_environment).to eq '_default' }
+    end # /context with patching disabled
+  end # /describe patch_chef_environment!
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poise-hoist
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Noah Kantrowitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-22 00:00:00.000000000 Z
+date: 2016-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: halite