chef-sugar 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d36f781f9ad16a91e542337396dbd4bfb7eb9a5c
-  data.tar.gz: 5582a86da12f5153b7d7983ff1837a9e32809c6e
+  metadata.gz: 0a4445aeb371367f5395edf0f995fd4f52e6314a
+  data.tar.gz: 92dcd636d49954fd5095234337e363905a402c69
 SHA512:
-  metadata.gz: 1de9ff9c1e94dd9725ab54f5aa5cf51f76645dcbe56cb3b86c2b5a261326956128ba44bf91fc89e790842b8f616feac65724eec2dd65e96ce988fff35ae29617
-  data.tar.gz: f52967095ea599f2a1c524d1287546196b67e88251ca98a42e5a8a786b2068ae0e7436bb56e194fa0db981d2f60c278b5ee86ff1b6a6477838f0cef502e77ba8
+  metadata.gz: 3c97a0235cba4f0600e1f7213edfb881443a37867962a89d878d3b9976e0dc3b8198a7440a17ca0a7cf8d78a365e1b0653aedd915cea4d0a8a1aad06a0352b35
+  data.tar.gz: 067a00297c93cbb0ad32842070f7b0002e39703f7a13881d8a8c36931b56fdfd6e7da2e34c77dd3d16485ffb036431f117dafd50f9005367cf9fd64f595fca5b

data/CHANGELOG.md

@@ -2,6 +2,13 @@ Chef Sugar Changelog
 =========================
 This file is used to list changes made in each version of the chef-sugar cookbook and gem.
 
+v3.0.1 (2015-03-20)
+-------------------
+### Breaking Changes
+- Rename `compile_time` `to at_compile_time` - if your recipes are affected by
+  this breaking change, your Chef Client run will produce a verbose error
+  message with details on how to fix the error.
+
 v3.0.0 (2015-03-17)
 -------------------
 ### Breaking Changes

data/README.md

@@ -412,13 +412,13 @@ end
 ```
 
 ### Filters
-- `compile_time` - accepts a block of resources to run at compile time
+- `at_compile_time` - accepts a block of resources to run at compile time
 - `before` - insert resource in the collection before the given resource
 - `after` - insert resource in the collection after the given resource
 
 #### Examples
 ```ruby
-compile_time do
+at_compile_time do
   package 'apache2'
 end
 

data/lib/chef/sugar.rb

@@ -41,6 +41,7 @@ class Chef
 end
 
 Chef::Recipe.send(:include, Chef::Sugar::DSL)
+Chef::Recipe.send(:include, Chef::Sugar::RecipeDSL) # TODO: this is a hack
 Chef::Resource.send(:include, Chef::Sugar::DSL)
 Chef::Provider.send(:include, Chef::Sugar::DSL)
 

data/lib/chef/sugar/filters.rb

@@ -4,7 +4,7 @@ class Chef
       #
       # Evaluate resources at compile time instead of converge time.
       #
-      class CompileTime
+      class AtCompileTime
         def initialize(recipe)
           @recipe = recipe
         end
@@ -94,19 +94,19 @@ class Chef
       #   end.run_action(:install)
       #
       # @example The new way
-      #   compile_time do
+      #   at_compile_time do
       #     package('apache2')
       #   end
       #
       # @example Resource actions are run in order
-      #   compile_time do
+      #   at_compile_time do
       #     service 'apache2' do
       #       action [:enable, :start] # run_action(:enable), run_action(:start)
       #     end
       #   end
       #
-      def compile_time(&block)
-        Chef::Sugar::Filters::CompileTime.new(self).evaluate(&block)
+      def at_compile_time(&block)
+        Chef::Sugar::Filters::AtCompileTime.new(self).evaluate(&block)
       end
 
       #
@@ -149,5 +149,89 @@ class Chef
         Chef::Sugar::Filters::Injector.new(self, identifier, :after).evaluate(&block)
       end
     end
+
+    module RecipeDSL
+      #
+      # @deprecated The description is in the method body pretty accurately...
+      #
+      def compile_time(&block)
+        message = <<-EOH
+
+The Chef Sugar recipe DSL method `compile_time' has been renamed to
+`at_compile_time'! This is a breaking change that was released in a patch
+version, so please continue reading to understand the necessary semantic
+versioning violation.
+
+Despite having existed since October 15, 2013 (b4d4c0e) and being one of the
+most widely used cookbooks in the Chef ecosystem, Chef Software decided to
+implement their own version of `compile_time' in Chef 12.1, breaking any cookbook
+that uses or depends on Chef Sugar on Chef 12.1:
+
+    https://www.chef.io/blog/2015/03/03/chef-12-1-0-released
+
+As is common with Chef-ecosystem tooling, no warning was given, and maintainers
+are left to pick up the pieces from upset Chef users who get rather bespoke
+error messages now:
+
+    https://github.com/sethvargo/chef-sugar/issues/89
+    https://github.com/opscode-cookbooks/xml/issues/22
+    https://github.com/opscode-cookbooks/aws/pull/110
+
+In order to progress Chef Sugar forward, the DSL method has been renamed to
+avoid the namespace collision.
+
+In short, you should change this:
+
+    compile_time do
+      # ...
+    end
+
+to this:
+
+    at_compile_time do
+      # ...
+    end
+
+EOH
+
+        if Chef::Resource::ChefGem.instance_methods(false).include?(:compile_time)
+          message << <<-EOH
+You are running a version of Chef Client that includes the `compile_time'
+attribute on core Chef resources (most likely Chef 12.1+). Instead of continuing
+and having Chef provide you with an obscure error message, I am going to error
+here. There is no way for the Chef Recipe to successfully continue unless you
+change the Chef Sugar `compile_time' method to `at_compile_time' in your Chef
+recipes.
+
+You should NOT change resource-level `compile_time' attributes:
+
+    package "foo" do
+      compile_time true # Do NOT change these
+    end
+
+I truly apologize for the inconvienence and hope the reason for introducing this
+breaking change is clear. I am sorry if it causes extra work, but I promise this
+error message is much more informative that "wrong number of arguments".
+
+If you have any questions, please feel free to open an issue on GitHub at:
+
+    https://github.com/sethvargo/chef-sugar
+
+Thank you, and have a great day!
+EOH
+          raise RuntimeError, message
+        else
+          message << <<-EOH
+You are running a version of Chef Client that does not include the
+`compile_time' attribute on core Chef resources (most likely less than
+Chef 12.1), so this is just a warning. Please consider changing the Chef Sugar
+`compile_time' method to `at_compile_time' in your Chef recipes. If you upgrade
+Chef, your recipes WILL break.
+EOH
+          Chef::Log.warn(message)
+          at_compile_time(&block)
+        end
+      end
+    end
   end
 end

data/lib/chef/sugar/version.rb

@@ -16,6 +16,6 @@
 
 class Chef
   module Sugar
-    VERSION = '3.0.0'
+    VERSION = '3.0.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-sugar
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Seth Vargo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-17 00:00:00.000000000 Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,7 +90,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".hound.yml"
 - ".kitchen.yml"
 - ".travis.yml"
 - CHANGELOG.md

data/.hound.yml

@@ -1,2 +0,0 @@
-DotPosition:
-  EnforcedStyle: leading