chef-sugar 1.1.0 → 1.2.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 222ec2b0f50c5d0a482190cc2b4baec1423f124d
-  data.tar.gz: 09af24376426ba383f8b85c4e08c8ab6ad4ceef9
+  metadata.gz: 1f389cb9756b7c955888e0673f9b7cace261b3fc
+  data.tar.gz: b933fd4654ddcf8e27082a1ad0af50678f603ff6
 SHA512:
-  metadata.gz: 3341414fb14b31ca32baf45395e084f1d095cb830569669b7048429c66d92bbfa6a10103da4273cd554496289c27958fa09f03db2c3da1e7a1cb37892f2f94d7
-  data.tar.gz: 0eb0b352c56911e7c55d26f85259baf418e32c8731401ba37b6ce134b5561549ccdd2e3824a80b14018ad37b17a12bd6f322b4d89f232590cc01a9923625b1d8
+  metadata.gz: 9816746e63bc7714ea9c6b17f599b39685cbdc120abb74c7bd36c2fed268e0a221144192334de78f2ed049f2cf9b23939d6781a742cee66bdfefea8c4b4a233b
+  data.tar.gz: 434e4dd1d91d7a73d1ea4d08c25042e34b958184415561baea1df6f24b6218f0d32b99722507b04b7a70d340c4ad52a5bdf3ec2ddf10468803ef12d5c98f50b2

data/.gitignore

@@ -16,7 +16,10 @@ Gemfile.lock
 .kitchen/
 .vagrant/
 .vagrant.d/
+.yardoc/
 bin/
+coverage/
+doc/
 pkg/
 tmp/
 vendor/

data/LICENSE

@@ -186,7 +186,7 @@ APPENDIX: How to apply the Apache License to your work.
    same "printed page" as the copyright notice for easier
    identification within third-party archives.
 
-Copyright 2013 Seth Vargo
+Copyright 2013-2014 Seth Vargo
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -1,6 +1,8 @@
 Chef::Sugar
 ================
 [![Build Status](https://secure.travis-ci.org/sethvargo/chef-sugar.png?branch=master)](http://travis-ci.org/sethvargo/chef-sugar)
+[![Coverage
+Status](https://coveralls.io/repos/sethvargo/chef-sugar/badge.png?branch=master)](https://coveralls.io/r/sethvargo/chef-sugar?branch=master)
 [![Gem Version](https://badge.fury.io/rb/chef-sugar.png)](http://badge.fury.io/rb/chef-sugar)
 [![Dependency Status](https://gemnasium.com/sethvargo/chef-sugar.png)](https://gemnasium.com/sethvargo/chef-sugar)
 [![Code Climate](https://codeclimate.com/github/sethvargo/chef-sugar.png)](https://codeclimate.com/github/sethvargo/chef-sugar)
@@ -41,6 +43,7 @@ Requiring the Chef Sugar Gem will automatically extend the Recipe DSL, `Chef::Re
 If you are working outside of the Recipe DSL, you can use the module methods instead of the Recipe DSL. In general, the module methods have the same name as their Recipe-DSL counterparts, but require the node object as a parameter. For example:
 
 In a Recipe:
+
 ```ruby
 # cookbook/recipes/default.rb
 do_something if windows?
@@ -119,6 +122,87 @@ encrypted_data_bag_item('accounts', 'hipchat')
 encrypted_data_bag_item_for_environment('accounts', 'github')
 ```
 
+### Attributes
+Chef Sugar adds more Chef-like DSL to attribute definitions. Instead of using the Ruby hash syntax, you can define attributes using nested namespaces. This DSL may be more friendly to non-Ruby developers. It can safely be mixed-and-matched with the standard syntax.
+
+```ruby
+# This is functionally the same as default['apache2']['config']['root'] = '/var/www'
+namespace 'apache2' do
+  namespace 'config' do
+    root '/var/www'
+  end
+end
+```
+
+```ruby
+# Specify multiple keys instead of nesting namespaces
+namespace 'apache2', 'config' do
+  root '/var/www'
+end
+```
+
+```ruby
+# Specify different nested precedence levels
+namespace 'apache2', precedence: normal do
+  namespace 'config', precedence: override do
+    root '/var/www' #=> override['apache2']['config']['root'] = '/var/www'
+  end
+end
+```
+
+### Constraints
+- `constaints` - create a new contraint (or requirement) that can be used to test version validations.
+- `chef_version` - (DSL only) a wrapper for `version(Chef::VERSION)`
+- `version` - create a new version that can be used to test constraint validation.
+
+#### Examples
+```ruby
+# Check if a version is satisfied by a constraint
+version('1.2.3').satisfies?('~> 1.2.0')
+```
+
+```ruby
+# Check if a constraint is satisfied by a version
+constraint('~> 1.2.0').satisfied_by?('1.2.3')
+```
+
+```ruby
+# Support multiple constraints
+version('1.2.3').satisfies?('> 1.2', '< 2.0')
+constraint('> 1.2', '< 2.0').satisfied_by?('1.2.3')
+```
+
+```ruby
+# Only perform an operation if Chef is at a certain version
+package 'apache2' do
+  not_if { chef_version.satisfies?('~> 11.0') } # Ignore Chef 11
+end
+```
+
+### Kernel
+- `require_chef_gem` - "safely" require a gem. Loading a gem with Chef is sometimes difficult and confusing. The errors that Chef produces are also sometimes not very intuitive. In the event you require a gem to exist on the system, you can use `require_chef_gem`, which wil attempt to require the gem and then produce helpful output if the gem is not installed:
+
+        Chef could not load the gem `#{name}'! You may need to install the gem
+        manually with `gem install #{name}', or include a recipe before you can
+        use this resource. Please consult the documentation for this cookbook
+        for proper usage.
+
+#### Examples
+```ruby
+# LWRP
+require_chef_gem 'pry'
+```
+
+```ruby
+class Chef
+  class Provider
+    class MyProvider > Provider
+      require_chef_gem 'pry'
+    end
+  end
+end
+```
+
 ### IP
 - `best_ip_for` - determine the best IP address for the given "other" node, preferring local IP addresses over public ones.
 
@@ -134,6 +218,8 @@ end
 ```
 
 ### Node
+- `deep_fetch` - safely fetch a nested attribute.
+- `deep_fetch` - fetch a nested attribute, raising a more semantic error if the key does not exist.
 - `in?` - determine if the node is in the given Chef environment.
 - `includes_recipe?`
 
@@ -154,6 +240,10 @@ if includes_recipe?('apache2::default')
 end
 ```
 
+```ruby
+node.deep_fetch('apache2', 'config', 'root') => node['apache2']['config']['root']
+```
+
 ### Platform
 - `amazon_linux?`
 - `centos?`
@@ -287,7 +377,7 @@ License & Authors
 - Author: Seth Vargo (sethvargo@gmail.com)
 
 ```text
-Copyright 2013 Seth Vargo
+Copyright 2013-2014 Seth Vargo
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/Rakefile

@@ -1 +1,7 @@
 require 'bundler/gem_tasks'
+
+require 'stove/rake_task'
+desc "Publish chef-sugar v#{Chef::Sugar::VERSION} to the Community Site"
+Stove::RakeTask.new(:publish) do |t|
+  t.send(:options)[:version] = Chef::Sugar::VERSION
+end

data/chef-extensions.gemspec

@@ -26,11 +26,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'stove', '~> 2.0.0.beta'
 
-  spec.add_development_dependency 'chef',  '~> 11.0'
-  spec.add_development_dependency 'rspec', '~> 2.11'
-
-  spec.add_development_dependency 'chefspec',        '~> 3.0'
-  spec.add_development_dependency 'test-kitchen',    '~> 1.0'
-  spec.add_development_dependency 'kitchen-vagrant', '~> 0.14'
+  spec.add_development_dependency 'chefspec',  '~> 3.0'
+  spec.add_development_dependency 'coveralls', '~> 0.7'
 end

data/lib/chef/sugar.rb

@@ -1,5 +1,5 @@
 #
-# Copyright 2013, Seth Vargo <sethvargo@gmail.com>
+# Copyright 2013-2014, Seth Vargo <sethvargo@gmail.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -22,9 +22,11 @@ class Chef
   module Sugar
     require_relative 'sugar/architecture'
     require_relative 'sugar/cloud'
+    require_relative 'sugar/constraints'
     require_relative 'sugar/data_bag'
     require_relative 'sugar/filters'
     require_relative 'sugar/ip'
+    require_relative 'sugar/kernel'
     require_relative 'sugar/node'
     require_relative 'sugar/platform'
     require_relative 'sugar/platform_family'
@@ -38,3 +40,5 @@ end
 Chef::Recipe.send(:include, Chef::Sugar::DSL)
 Chef::Resource.send(:include, Chef::Sugar::DSL)
 Chef::Provider.send(:include, Chef::Sugar::DSL)
+
+Object.send(:include, Chef::Sugar::Kernel)

data/lib/chef/sugar/architecture.rb

@@ -1,5 +1,5 @@
 #
-# Copyright 2013, Seth Vargo <sethvargo@gmail.com>
+# Copyright 2013-2014, Seth Vargo <sethvargo@gmail.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/chef/sugar/cloud.rb

@@ -1,5 +1,5 @@
 #
-# Copyright 2013, Seth Vargo <sethvargo@gmail.com>
+# Copyright 2013-2014, Seth Vargo <sethvargo@gmail.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/chef/sugar/constraints.rb

@@ -0,0 +1,161 @@
+#
+# Copyright 2013-2014, Seth Vargo <sethvargo@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+class Chef
+  module Sugar
+    module Constraints
+      extend self
+
+      #
+      # Shortcut method for creating a new {Version} object.
+      #
+      # @param [String] version
+      #   the version (as a string) to create
+      #
+      # @return [Chef::Sugar::Constraints::Version]
+      #   the new version object
+      #
+      def version(version)
+        Chef::Sugar::Constraints::Version.new(version)
+      end
+
+      #
+      # Shortcut method for creating a new {Constraint} object.
+      #
+      # @param [String, Array<String>] constraints
+      #   the list of constraints to use
+      #
+      # @return [Chef::Sugar::Constraints::Constraint]
+      #   the new constraint object
+      #
+      def constraint(*constraints)
+        Chef::Sugar::Constraints::Constraint.new(*constraints)
+      end
+
+      #
+      # This class is a wrapper around a version requirement that adds a nice
+      # DSL for comparing constraints:
+      #
+      # @example Comparing a single constraint
+      #   Constraint.new('~> 1.2.3').satisfied_by?('1.2.7')
+      #
+      # @example Comparing multiple constraints
+      #   Constraint.new('> 1.2.3', '< 2.0.0').satisfied_by?('1.2.7')
+      #
+      class Constraint
+        #
+        # Create a new constraint object.
+        #
+        # @param [String, Array<String>] constraints
+        #   the list of constraints
+        #
+        def initialize(*constraints)
+          @requirement = Gem::Requirement.new(*constraints)
+        end
+
+        #
+        # Determine if the given version string is satisfied by this constraint
+        # or group of constraints.
+        #
+        # @example Given a satisified constraint
+        #   Constraint.new('~> 1.2.0').satisfied_by?('1.2.5') #=> true
+        #
+        # @example Given an unsatisfied constraint
+        #   Constraint.new('~> 1.2.0').satisfied_by?('2.0.0') #=> false
+        #
+        #
+        # @param [String] version
+        #   the version to compare
+        #
+        # @return [Boolean]
+        #   true if the constraint is satisfied, false otherwise
+        #
+        def satisfied_by?(version)
+          @requirement.satisfied_by?(Gem::Version.new(version))
+        end
+      end
+
+      #
+      # This class exposes a single version constraint object that wraps the
+      # string representation of a version string and proved helpful comparator
+      # methods.
+      #
+      # @example Create a new version
+      #   Chef::Sugar::Version('1.2.3')
+      #
+      # @example Compare a version with constraints
+      #   Chef::Sugar::Version('1.2.3').satisfies?('~> 1.3.4', '< 2.0.5')
+      #
+      class Version
+        #
+        # Create a new version object.
+        #
+        # @param [String] version
+        #   the version to create
+        #
+        def initialize(version)
+          @version = Gem::Version.new(version)
+        end
+
+        #
+        # Determine if the given constraint is satisfied by this version.
+        #
+        # @example Given a satisified version
+        #   Version.new('1.2.5').satisfies?('~> 1.2.0') #=> true
+        #
+        # @example Given an unsatisfied version
+        #   Version.new('2.0.0').satisfies?('~> 1.2.0') #=> false
+        #
+        #
+        # @param [String, Array<String>] constraints
+        #   the constraints to satisfy
+        #
+        # @return [Boolean]
+        #   true if the version satisfies the constraints, false otherwise
+        #
+        def satisfies?(*constraints)
+          Gem::Requirement.new(*constraints).satisfied_by?(@version)
+        end
+      end
+    end
+
+    module DSL
+      # @see Chef::Sugar::Constraints#version
+      def version(version)
+        Chef::Sugar::Constraints::Version.new(version)
+      end
+
+      # @see Chef::Sugar::Constraints#constraint
+      def constraint(*constraints)
+        Chef::Sugar::Constraints.constraint(*constraints)
+      end
+
+      #
+      # This wrapper/convenience method is only available in the recipe DSL. It
+      # creates a new version object from the {Chef::VERSION}.
+      #
+      # @example Check if Chef 11+
+      #   chef_version.satisfies?('>= 11.0.0')
+      #
+      # @return [Chef::Sugar::Constraints::Version]
+      #   a version object, wrapping the current {Chef::VERSION}
+      #
+      def chef_version
+        version(Chef::VERSION)
+      end
+    end
+  end
+end

data/lib/chef/sugar/core_extensions.rb

@@ -0,0 +1,18 @@
+#
+# Copyright 2013-2014, Seth Vargo <sethvargo@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require_relative 'core_extensions/array'
+require_relative 'core_extensions/string'

data/lib/chef/sugar/core_extensions/array.rb

@@ -0,0 +1,34 @@
+#
+# Copyright 2013-2014, Seth Vargo <sethvargo@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require_relative '../constraints'
+
+class Array
+  #
+  # Treat an array of objects as version constraints.
+  #
+  # @see Chef::Sugar::Constraints::Constraint
+  #
+  # @example Using pure Array<String> objects like constraints
+  #   ['> 2.0.0', '< 3.0.0'].satisfied_by?('2.1.0')
+  #
+  # @param [String] version
+  #   the version to check if it is satisfied
+  #
+  def satisfied_by?(version)
+    Chef::Sugar::Constraints::Constraint.new(*dup).satisfied_by?(version)
+  end
+end