poise 2.3.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fb584605a370cd20300d0456630ffe8a0d5351a
-  data.tar.gz: 7df0b817befc116a8cb5e8729ee604707771ae1b
+  metadata.gz: 2670b11e79bcee699172c7eaa7a842df9432324e
+  data.tar.gz: 56e5b571574d41de09f7af34da94034557fa741a
 SHA512:
-  metadata.gz: fc97265d1907474050c72893815a35c1b20a31dbd1740bdb8d05ab70a60fb9e28dc0850a1afc52ad4202a49834c99580c2f139e8133cbcc5401af01c7c47aff9
-  data.tar.gz: d4c49153950ba2736fba3d4f24054543edd4cf2c464205a40a73dca08257288ce8de497db11b8025da080cb76c76cedafb56dd320d6e367eab1e508b065aadd8
+  metadata.gz: 58b803a269f764c6a061077d27f608d14e14f572c2e016f3986eeee22adc39bf408683cac41c6714b32bc4ad56dba6d03e87095e1c228d6edebc6d744a685209
+  data.tar.gz: 047b174a37deae87fb3658b6e465be97fe86826028d4575c2f46298d573115eb1c83794289df262b66f6771f9d538ea14f07851aeb139d779cd9f22a38b69874

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## v2.4.0
+
+* Added return value to `Container#register_subresource` to track if the resource
+  was already added.
+* Improve inspect output for subresources and containers.
+* Ensure notifications work with subresources.
+* Inversion providers process name equivalences.
+
 ## v2.3.2
 
 * Improve handling of deeply nested subresources.

data/README.md

@@ -10,7 +10,7 @@
 ## What is Poise?
 
 The poise cookbook is a set of libraries for writing reusable cookbooks. It
-providers helpers for common patterns and a standard structure to make it easier to create flexible cookbooks.
+provides helpers for common patterns and a standard structure to make it easier to create flexible cookbooks.
 
 ## Writing your first resource
 

data/lib/poise/helpers/inversion.rb

@@ -78,7 +78,11 @@ module Poise
         #   end
         def provider(val=nil)
           if val && !val.is_a?(Class)
-            provider_class = Poise::Helpers::Inversion.provider_for(resource_name, node, val)
+            resource_names = [resource_name]
+            # If subclass_providers! might be in play, check for those names too.
+            resource_names.concat(self.class.subclass_resource_equivalents) if self.class.respond_to?(:subclass_resource_equivalents)
+            # Silly ruby tricks to find the first provider that exists and no more.
+            provider_class = resource_names.lazy.map {|name| Poise::Helpers::Inversion.provider_for(name, node, val) }.select {|x| x }.first
             Chef::Log.debug("[#{self}] Checking for an inversion provider for #{val}: #{provider_class && provider_class.name}")
             val = provider_class if provider_class
           end

data/lib/poise/helpers/resource_subclass.rb

@@ -27,8 +27,8 @@ module Poise
       include ResourceName
 
       module ClassMethods
-        def subclass_providers!(superclass_resource_name=nil)
-          resource_name = self.resource_name
+        def subclass_providers!(superclass_resource_name=nil, resource_name: nil)
+          resource_name ||= self.resource_name
           superclass_resource_name ||= if superclass.respond_to?(:resource_name)
             superclass.resource_name
           elsif superclass.respond_to?(:dsl_name)
@@ -57,6 +57,7 @@ module Poise
           else
             subclass_resource_equivalents << superclass_resource_name
           end
+          subclass_resource_equivalents.uniq!
         end
 
         # An array of names for the resources this class is equivalent to for

data/lib/poise/helpers/subresources/child.rb

@@ -37,6 +37,10 @@ module Poise
             @resource = resource
           end
 
+          def inspect
+            to_text
+          end
+
           def to_text
             if @resource.nil?
               'nil'

data/lib/poise/helpers/subresources/container.rb

@@ -31,6 +31,10 @@ module Poise
         # is used to show the value of @subresources during Chef's error formatting.
         # @api private
         class NoPrintingResourceCollection < Chef::ResourceCollection
+          def inspect
+            to_text
+          end
+
           def to_text
             "[#{all_resources.map(&:to_s).join(', ')}]"
           end
@@ -80,12 +84,24 @@ module Poise
             end
             @run_context.resource_collection.insert(order_fixer)
             @subcontexts.each do |ctx|
+              # Copy all resources to the outer context.
               ctx.resource_collection.each do |r|
                 Chef::Log.debug("   * #{r}")
                 # Fix the subresource to use the outer run context.
                 r.run_context = @run_context
                 @run_context.resource_collection.insert(r)
               end
+              # Copy all notifications to the outer context.
+              %w{immediate delayed}.each do |notification_type|
+                ctx.send(:"#{notification_type}_notification_collection").each do |key, notifications|
+                  notifications.each do |notification|
+                    parent_notifications = @run_context.send(:"#{notification_type}_notification_collection")[key]
+                    unless parent_notifications.any? { |existing_notification| existing_notification.duplicates?(notification) }
+                      parent_notifications << notification
+                    end
+                  end
+                end
+              end
             end
             Chef::Log.debug("Collection: #{@run_context.resource_collection.map(&:to_s).join(', ')}")
           end
@@ -140,11 +156,19 @@ module Poise
           resource.first
         end
 
+        # Register a resource as part of this container. Returns true if the
+        # resource was added to the collection and false if it was already
+        # known.
+        #
+        # @note Return value added in 2.4.0.
+        # @return [Boolean]
         def register_subresource(resource)
           subresources.lookup(resource)
+          false
         rescue Chef::Exceptions::ResourceNotFound
           Chef::Log.debug("[#{self}] Adding #{resource} to subresources")
           subresources.insert(resource)
+          true
         end
 
         private
@@ -193,6 +217,7 @@ module Poise
             super
             klass.extend(ClassMethods)
             klass.const_get(:HIDDEN_IVARS) << :@subcontexts
+            klass.const_get(:FORBIDDEN_IVARS) << :@subcontexts
           end
         end
 

data/lib/poise/version.rb

@@ -16,5 +16,5 @@
 
 
 module Poise
-  VERSION = '2.3.2'
+  VERSION = '2.4.0'
 end

data/test/spec/helpers/resource_subclass_spec.rb

@@ -29,7 +29,7 @@ module PoiseTestSubclass
     include Poise
     provides(:poise_test_subclass)
     def action_run
-      node.run_state[:really_did_run] = true
+      (node.run_state[:really_did_run] ||= []) << new_resource.name
     end
   end
 end
@@ -45,7 +45,24 @@ describe Poise::Helpers::ResourceSubclass do
     end
 
     it { is_expected.to run_poise_sub('test') }
-    it { expect(chef_run.node.run_state[:really_did_run]).to be true }
+    it { expect(chef_run.node.run_state[:really_did_run]).to eq %w{test} }
+
+    context 'with multiple resource names' do
+      before { step_into << :poise_test_subclass_other_name }
+      resource(:poise_sub, parent: PoiseTestSubclass::Resource) do
+        provides(:poise_sub)
+        provides(:poise_test_subclass_other_name)
+        subclass_providers!
+      end
+      recipe do
+        poise_sub 'test'
+        poise_test_subclass_other_name 'test2'
+      end
+
+      it { is_expected.to run_poise_sub('test') }
+      it { is_expected.to ChefSpec::Matchers::ResourceMatcher.new('poise_test_subclass_other_name', 'run', 'test2') }
+      it { expect(chef_run.node.run_state[:really_did_run]).to eq %w{test test2} }
+    end # /context with multiple resource names
   end # /describe .subclass_providers!
 
   describe '.subclass_resource_equivalents' do

data/test/spec/helpers/subresources/container_spec.rb

@@ -286,4 +286,54 @@ describe Poise::Helpers::Subresources::Container do
       it { is_expected.to run_poise_child('three').with(parent: chef_run.poise_parent('two'), order: 3) }
     end # /context un-nested
   end # /describe triple nesting
+
+  describe 'subresources with notifications' do
+    step_into(:ruby_block)
+    resource(:poise_parent) do
+      include described_class
+    end
+    provider(:poise_parent)
+    resource(:poise_child) do
+      include Poise::Helpers::Subresources::Child
+      parent_type :poise_parent
+    end
+    provider(:poise_child) do
+      def action_run
+        new_resource.updated_by_last_action(true)
+      end
+    end
+    subject { chef_run.node.run_state['poise_notified'] }
+
+    context 'delayed notification' do
+      recipe(subject: false) do
+        ruby_block 'one' do
+          action :nothing
+          block { node.run_state['poise_notified'] = true }
+        end
+        poise_parent 'two' do
+          poise_child 'three' do
+            notifies :run, 'ruby_block[one]', :delayed
+          end
+        end
+      end
+
+      it { is_expected.to be true }
+    end # /context delayed notification
+
+    context 'immediate notification' do
+      recipe(subject: false) do
+        ruby_block 'one' do
+          action :nothing
+          block { node.run_state['poise_notified'] = true }
+        end
+        poise_parent 'two' do
+          poise_child 'three' do
+            notifies :run, 'ruby_block[one]', :immediately
+          end
+        end
+      end
+
+      it { is_expected.to be true }
+    end # /context immediate notification
+  end # /describe subresources with notifications
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poise
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.4.0
 platform: ruby
 authors:
 - Noah Kantrowitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-31 00:00:00.000000000 Z
+date: 2015-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: halite