poise 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ace7c3aba6dbd072ffe99718c8599290df36ff80
-  data.tar.gz: 4822dff3762b4c319010e93102defab184a7dd2b
+  metadata.gz: 139be873d0ca15732ed1e63cda3c64fb5f66df07
+  data.tar.gz: 5c320b061767f73716e12d14cd4435d2ac454ade
 SHA512:
-  metadata.gz: 71d3c8d0288dcad6916084eccbd21e8a25f5caae239269aecf838930ba96df15b069d08b97475930608d415eec6f38ba8991c18812c364d805d8be793ea04691
-  data.tar.gz: 0455db8c92eb97d8760dce620865ae74497fb3ba645b12aeb9890238d8ec832cdf7d836508dbfe814c0b2da68ff5c4f9eac478a692c345891713ac1dd71d048d
+  metadata.gz: 3cad8094aa339ae2da67533a14be99ad2ad855f7f9e1896540db99a23a129c714e1cc906e89fa1c46be36a417bc5dfa4b24cf7882d51cfe73b881d1bfb98dabf
+  data.tar.gz: c924334c534a43fc017a2b2437479ff8b1e73460485df2559ebceb750178ec204219a6075185c2194a214b75cf061aeb7f9e714cee8845ee47a6e678fda28915

data/.travis.yml

@@ -1,12 +1,12 @@
 sudo: false
 cache: bundler
 language: ruby
-rvm:
-- '2.2'
 addons:
   apt:
     packages:
     - libgecode-dev
+rvm:
+- '2.2'
 env:
   global:
   - USE_SYSTEM_GECODE=true

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## v2.0.1
+
+* Make the ChefspecHelpers helper a no-op if chefspec is not already loaded.
+* Fix for finding the correct cookbook for a file when using vendored gems.
+* New flag for the OptionCollector helper, `parser`:
+
+```ruby
+class Resource < Chef::Resource
+  include Poise
+  attribute(:options, option_collector: true, parser: proc {|val| parse(val) })
+
+  def parse(val)
+    {name: val}
+  end
+end
+```
+
+* Fix for a possible infinite loop when using `ResourceProviderMixin` in a nested
+  module structure.
+
 ## v2.0.0
 
 Major overhaul! Poise is now a Halite gem/cookbook. New helpers:

data/Gemfile

@@ -18,13 +18,10 @@ source 'https://rubygems.org/'
 
 gemspec path: File.expand_path('..', __FILE__)
 
-def dev_gem(name, path: File.join('..', name), github: "poise/#{name}")
-  github = "#{github}/#{name}" unless github.include?('/')
+def dev_gem(name, path: File.join('..', name))
   path = File.expand_path(File.join('..', path), __FILE__)
   if File.exist?(path)
     gem name, path: path
-  else
-    gem name, github: github
   end
 end
 

data/lib/poise/helpers/chefspec_matchers.rb

@@ -14,12 +14,8 @@
 # limitations under the License.
 #
 
-begin
-  require 'chefspec'
-  require 'rspec/expectations'
-rescue LoadError
-  # Don't panic! We will no-op later on if these aren't available.
-end
+# Not requiring chefspec or rspec/expectations since this code should only
+# activate if they are already loaded.
 
 require 'poise/helpers/lwrp_polyfill'
 require 'poise/helpers/resource_name'

data/lib/poise/helpers/option_collector.rb

@@ -16,6 +16,8 @@
 
 require 'chef/mash'
 
+require 'poise/error'
+
 
 module Poise
   module Helpers
@@ -80,8 +82,12 @@ module Poise
         # Define an option collector attribute. Normally used via {.attribute}.
         #
         # @param name [String, Symbol] Name of the attribute to define.
-        # @param default [Object] Default value for the options.
-        def option_collector_attribute(name, default: {})
+        # @param default [Hash] Default value for the options.
+        # @param parser [Proc, Symbol] Optional parser method. If a symbol it is
+        #   called as a method on self. Takes a non-hash value and returns a
+        #   hash of its parsed representation.
+        def option_collector_attribute(name, default: {}, parser: nil)
+          raise Poise::Error.new("Parser must be a Proc or Symbol: #{parser.inspect}") if parser && !(parser.is_a?(Proc) || parser.is_a?(Symbol))
           # Unlike LWRPBase.attribute, I don't care about Ruby 1.8. Worlds tiniest violin.
           define_method(name.to_sym) do |arg=nil, &block|
             iv_sym = :"@#{name}"
@@ -91,7 +97,15 @@ module Poise
               Mash.new(default) # Wrap in a mash because fuck str vs sym.
             end
             if arg
-              raise Exceptions::ValidationFailed, "Option #{name} must be a Hash" if arg && !arg.is_a?(Hash)
+              if !arg.is_a?(Hash) && parser
+                arg = case parser
+                      when Proc
+                        instance_exec(arg, &parser)
+                      when Symbol
+                        send(parser, arg)
+                      end
+              end
+              raise Exceptions::ValidationFailed, "Option #{name} must be a Hash" if !arg.is_a?(Hash)
               # Should this and the update below be a deep merge?
               value.update(arg)
             end

data/lib/poise/utils.rb

@@ -36,25 +36,35 @@ module Poise
     #     # ...
     #   end
     def find_cookbook_name(run_context, filename)
+      possibles = {}
+      Chef::Log.debug("[Poise] Checking cookbook for #{filename.inspect}")
       run_context.cookbook_collection.each do |name, ver|
         # This special method is added by Halite::Gem#as_cookbook_version.
         if ver.respond_to?(:halite_root)
           # The join is there because ../poise-ruby/lib starts with ../poise so
           # we want a trailing /.
+          Chef::Log.debug("")
           if filename.start_with?(File.join(ver.halite_root, ''))
-            return name
+            Chef::Log.debug("[Poise] Found matching halite_root in #{name}: #{ver.halite_root.inspect}")
+            possibles[ver.halite_root] = name
           end
         else
           Chef::CookbookVersion::COOKBOOK_SEGMENTS.each do |seg|
             ver.segment_filenames(seg).each do |file|
+              # Put this behind an environment variable because it is verbose
+              # even for normal debugging-level output.
+              Chef::Log.debug("[Poise] Checking #{seg} in #{name}: #{file.inspect}") if ENV['POISE_DEBUG']
               if file == filename
-                return name
+                Chef::Log.debug("[Poise] Found matching #{seg} in #{name}: #{file.inspect}")
+                possibles[file] = name
               end
             end
           end
         end
       end
-      raise Poise::Error.new("Unable to find cookbook for file #{filename.inspect}")
+      raise Poise::Error.new("Unable to find cookbook for file #{filename.inspect}") if possibles.empty?
+      # Sort the items by matching path length, pick the name attached to the longest.
+      possibles.sort_by{|key, value| key.length }.last[1]
     end
   end
 end

data/lib/poise/utils/resource_provider_mixin.rb

@@ -34,20 +34,32 @@ module Poise
     #     end
     #   end
     module ResourceProviderMixin
-      # @!classmethods
-      module ClassMethods
-        def included(klass)
-          super
-          klass.extend(ClassMethods)
-          if klass < Chef::Resource
-            klass.class_exec { include self::Resource }
-          elsif klass < Chef::Provider
-            klass.class_exec { include self::Provider }
+      def self.included(klass)
+        # Warning here be dragons.
+        # Create a new anonymous module, klass will be the module that
+        # actually included ResourceProviderMixin. We want to keep a reference
+        # to that locked down so that we can close over it and use it in the
+        # "real" .included defined below to find the original relative consts.
+        mod = Module.new do
+          # Use define_method instead of def so we can close over klass and mod.
+          define_method(:included) do |inner_klass|
+            # Has to be explicit because super inside define_method.
+            super(inner_klass)
+            # Cargo this .included to things which include us.
+            inner_klass.extend(mod)
+            # Dispatch to submodules, inner_klass is the most recent includer.
+            if inner_klass < Chef::Resource
+              # Use klass::Resource to look up relative to the original module.
+              inner_klass.class_exec { include klass::Resource }
+            elsif inner_klass < Chef::Provider
+              # As above, klass::Provider.
+              inner_klass.class_exec { include klass::Provider }
+            end
           end
         end
+        # Add our .included to the original includer.
+        klass.extend(mod)
       end
-
-      extend ClassMethods
     end
   end
 end

data/lib/poise/version.rb

@@ -16,5 +16,5 @@
 
 
 module Poise
-  VERSION = '2.0.0'
+  VERSION = '2.0.1'
 end

data/test/gemfiles/chef-12.0.gemfile

@@ -15,4 +15,5 @@
 #
 
 eval_gemfile File.expand_path('../../../Gemfile', __FILE__)
+
 gem 'chef', '~> 12.0.0'

data/test/gemfiles/chef-12.1.gemfile

@@ -15,4 +15,5 @@
 #
 
 eval_gemfile File.expand_path('../../../Gemfile', __FILE__)
+
 gem 'chef', '~> 12.1.0'

data/test/gemfiles/chef-12.2.gemfile

@@ -15,4 +15,5 @@
 #
 
 eval_gemfile File.expand_path('../../../Gemfile', __FILE__)
+
 gem 'chef', '~> 12.2.0'

data/test/gemfiles/chef-12.gemfile

@@ -15,4 +15,5 @@
 #
 
 eval_gemfile File.expand_path('../../../Gemfile', __FILE__)
+
 gem 'chef', '~> 12.0'

data/test/gemfiles/master.gemfile

@@ -15,6 +15,7 @@
 #
 
 eval_gemfile File.expand_path('../../../Gemfile', __FILE__)
+
 gem 'chef', github: 'chef/chef'
-# gem 'halite', github: 'poise/halite'
-# gem 'poise-boiler', github: 'poise/poise-boiler'
+gem 'halite', github: 'poise/halite'
+gem 'poise-boiler', github: 'poise/poise-boiler'

data/test/spec/helpers/option_collector_spec.rb

@@ -78,5 +78,49 @@ describe Poise::Helpers::OptionCollector do
     it { is_expected.to run_poise_test('test').with(options: {'one' => '1'}, value: 2) }
   end # /context with a normal attribute too
 
+  context 'with a parser Proc' do
+    resource(:poise_test) do
+      include Poise::Helpers::LWRPPolyfill
+      include described_class
+      attribute(:options, option_collector: true, parser: proc {|val| parse(val) })
+      def parse(val)
+        {name: val}
+      end
+    end
+    recipe do
+      poise_test 'test' do
+        options '1'
+      end
+    end
+
+    it { is_expected.to run_poise_test('test').with(options: {'name' => '1'}) }
+  end # /context with a parser Proc
+
+  context 'with a parser Symbol' do
+    resource(:poise_test) do
+      include Poise::Helpers::LWRPPolyfill
+      include described_class
+      attribute(:options, option_collector: true, parser: :parse)
+      def parse(val)
+        {name: val}
+      end
+    end
+    recipe do
+      poise_test 'test' do
+        options '1'
+      end
+    end
+
+    it { is_expected.to run_poise_test('test').with(options: {'name' => '1'}) }
+  end # /context with a parser Symbol
+
+  context 'with an invalid parse' do
+    it do
+      expect do
+        resource(:poise_test).send(:attribute, :options, option_collector: true, parser: 'invalid')
+      end.to raise_error(Poise::Error)
+    end
+  end # /context with an invalid parser
+
   # TODO: Write tests for mixed symbol/string data
 end

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

@@ -116,7 +116,7 @@ describe Poise::Helpers::Subresources::Container do
     it { is_expected.to run_inner('inner') }
   end # /context with a no namespace
 
-  context 'with a no namespace and no inner name' do
+  context 'with a no namespace and an empty inner name' do
     resource(:poise_test) do
       include described_class
       container_namespace(false)
@@ -127,6 +127,21 @@ describe Poise::Helpers::Subresources::Container do
       end
     end
 
+    it { is_expected.to run_poise_test('container') }
+    it { is_expected.to run_inner('container') }
+  end # /context with a no namespace and an empty inner name
+
+  context 'with a no namespace and no inner name' do
+    resource(:poise_test) do
+      include described_class
+      container_namespace(false)
+    end
+    recipe do
+      poise_test 'container' do
+        inner
+      end
+    end
+
     it { is_expected.to run_poise_test('container') }
     it { is_expected.to run_inner('container') }
   end # /context with a no namespace and no inner name

data/test/spec/utils/resource_provider_mixin_spec.rb

@@ -37,6 +37,28 @@ module ResourceProviderMixinTest
   class Provider < Chef::Provider
     include Test
   end
+
+  module Test2
+    include Poise::Utils::ResourceProviderMixin
+
+    module Resource
+      include Test
+    end
+
+    module Provider
+      include Test
+    end
+  end
+
+  class Resource2 < Chef::Resource
+    include Test
+    include Test2
+  end
+
+  class Provider2 < Chef::Provider
+    include Test
+    include Test2
+  end
 end
 
 describe Poise::Utils::ResourceProviderMixin do
@@ -49,4 +71,18 @@ describe Poise::Utils::ResourceProviderMixin do
     subject { ResourceProviderMixinTest::Provider }
     it { is_expected.to be < ResourceProviderMixinTest::Test::Provider }
   end
+
+  context 'with nested usage' do
+    context 'in a resource' do
+      subject { ResourceProviderMixinTest::Resource2 }
+      it { is_expected.to be < ResourceProviderMixinTest::Test::Resource }
+      it { is_expected.to be < ResourceProviderMixinTest::Test2::Resource }
+    end
+
+    context 'in a provider' do
+      subject { ResourceProviderMixinTest::Provider2 }
+      it { is_expected.to be < ResourceProviderMixinTest::Test::Provider }
+      it { is_expected.to be < ResourceProviderMixinTest::Test2::Provider }
+    end
+  end # /context with nested usage
 end

data/test/spec/utils_spec.rb

@@ -106,5 +106,29 @@ describe Poise::Utils do
       end
       it { is_expected.to eq 'halite_cookbook_other' }
     end # /context with a Halite cookbook on a shared prefix
+
+    context 'with a Halite cookbook on a nested prefix' do
+      let(:filename) { '/source/halite_cookbook/vendor/other/lib/something.rb' }
+      before do
+        cookbooks << Chef::CookbookVersion.new('other_cookbook', '/test/other_cookbook').tap do |ver|
+          ver.library_filenames << '/test/other_cookbook/libraries/default.rb'
+          ver.recipe_filenames << '/test/other_cookbook/recipe/default.rb'
+        end
+        cookbooks << Chef::CookbookVersion.new('halite_cookbook', '/test/halite_cookbook').tap do |ver|
+          def ver.halite_root
+            '/source/halite_cookbook'
+          end
+        end
+        cookbooks << Chef::CookbookVersion.new('halite_cookbook_other', '/test/halite_cookbook/vendor/other').tap do |ver|
+          def ver.halite_root
+            '/source/halite_cookbook/vendor/other'
+          end
+        end
+        cookbooks << Chef::CookbookVersion.new('my_cookbook', '/test/my_cookbook').tap do |ver|
+          ver.recipe_filenames << '/test/my_cookbook/recipe/default.rb'
+        end
+      end
+      it { is_expected.to eq 'halite_cookbook_other' }
+    end # /context with a Halite cookbook on a nested prefix
   end # /describe .find_cookbook_name
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poise
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Noah Kantrowitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-20 00:00:00.000000000 Z
+date: 2015-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: halite