chef-sugar 1.1.0 → 1.2.0.beta.1

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

@@ -0,0 +1,49 @@
+#
+# 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 String
+  #
+  # Treat strings as version objects.
+  #
+  # @see Chef::Sugar::Constraints::Version
+  #
+  # @example Using pure string objects like versions
+  #   '1.2.3'.satisfies?('~> 1.2.0')
+  #
+  # @param [String, Array<String>] constraints
+  #   the list of constraints to satisfy
+  #
+  def satisfies?(*constraints)
+    Chef::Sugar::Constraints::Version.new(dup).satisfies?(*constraints)
+  end
+
+  #
+  # Treat strings as version constraints.
+  #
+  # @see Chef::Sugar::Constraints::Constraint
+  #
+  # @example Using pure string objects like constraints
+  #   '~> 1.2.0'.satisfied_by?('1.2.3')
+  #
+  # @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

data/lib/chef/sugar/data_bag.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.
@@ -17,6 +17,20 @@
 class Chef
   module Sugar
     module DataBag
+      class EncryptedDataBagSecretNotGiven < StandardError
+        def initialize
+          super <<-EOH
+You did not set your `encrypted_data_bag_secret'! In order to use the
+`encrypted_data_bag_item' helper, you must load your encrypted data bag secret
+into the `Chef::Config'.
+
+Alternatively, you can pass the secret key as the last parameter to the method
+call. For more information, please see
+http://docs.opscode.com/chef/essentials_data_bags.html#access-from-recipe.
+EOH
+        end
+      end
+
       extend self
 
       #
@@ -27,12 +41,21 @@ class Chef
       #   the name of the encrypted data bag
       # @param [String] id
       #   the id of the encrypted data bag
+      # @param [String] secret
+      #   the encrypted data bag secret (default's to the +Chef::Config+ value)
       #
       # @return [Hash]
       #
-      def encrypted_data_bag_item(bag, id)
+      def encrypted_data_bag_item(bag, id, secret = nil)
         Chef::Log.debug "Loading encrypted data bag item #{bag}/#{id}"
-        Chef::EncryptedDataBagItem.load(bag, id)
+
+        secret ||= Chef::Config[:encrypted_data_bag_secret]
+
+        if secret
+          Chef::EncryptedDataBagItem.load(bag, id, secret)
+        else
+          raise EncryptedDataBagSecretNotGiven.new
+        end
       end
 
       #
@@ -53,11 +76,13 @@ class Chef
       #   the name of the encrypted data bag
       # @param [String] id
       #   the id of the encrypted data bag
+      # @param [String] secret
+      #   the encrypted data bag secret (default's to the +Chef::Config+ value)
       #
       # @return [Hash]
       #
-      def encrypted_data_bag_item_for_environment(node, bag, id)
-        data = encrypted_data_bag_item(bag, id)
+      def encrypted_data_bag_item_for_environment(node, bag, id, secret = nil)
+        data = encrypted_data_bag_item(bag, id, secret)
 
         if data[node.chef_environment]
           Chef::Log.debug "Using #{node.chef_environment} as the key"
@@ -71,13 +96,13 @@ class Chef
 
     module DSL
       # @see Chef::Sugar::DataBag#encrypted_data_bag_item?
-      def encrypted_data_bag_item(bag, id)
-        Chef::Sugar::DataBag.encrypted_data_bag_item(bag, id)
+      def encrypted_data_bag_item(bag, id, secret = nil)
+        Chef::Sugar::DataBag.encrypted_data_bag_item(bag, id, secret)
       end
 
       # @see Chef::Sugar::DataBag#encrypted_data_bag_item_for_environment?
-      def encrypted_data_bag_item_for_environment(bag, id)
-        Chef::Sugar::DataBag.encrypted_data_bag_item_for_environment(node, bag, id)
+      def encrypted_data_bag_item_for_environment(bag, id, secret = nil)
+        Chef::Sugar::DataBag.encrypted_data_bag_item_for_environment(node, bag, id, secret)
       end
     end
   end

data/lib/chef/sugar/ip.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/kernel.rb

@@ -0,0 +1,49 @@
+#
+# 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 Kernel
+      class ChefGemLoadError < StandardError
+        def initialize(name)
+          super <<-EOH
+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.
+EOH
+        end
+      end
+
+      #
+      # Require a gem that should have been installed by Chef, such as in a
+      # recipes as a +chef_gem+. This method will gracefully degrade if the
+      # gem cannot be loaded.
+      #
+      # @param [String] name
+      #   the name of the gem to install
+      #
+      # @return [Boolean]
+      #   true if the require is successful and false if the gem is already
+      #   loaded
+      #
+      def require_chef_gem(name)
+        require(name)
+      rescue LoadError
+        raise ChefGemLoadError.new(name)
+      end
+    end
+  end
+end

data/lib/chef/sugar/node.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.
@@ -16,6 +16,16 @@
 
 class Chef
   class Node
+    class AttributeDoesNotExistError < StandardError
+      def initialize(keys)
+        hash = keys.map { |key| "['#{key}']" }
+
+        super <<-EOH
+No attribute `node#{hash.join}' exists on
+the current node. Please make sure you have spelled everything correctly.
+EOH
+      end
+    end
     #
     # Determine if the current node is in the given Chef environment
     # (or matches the given regular expression).
@@ -37,5 +47,151 @@ class Chef
       run_list.include?(recipe_name)
     end
     alias_method :include_recipe?, :includes_recipe?
+
+    #
+    # Safely fetch a deeply nested attribute by specifying a list of keys,
+    # bypassing Ruby's Hash notation. This method swallows +NoMethodError+
+    # exceptions, avoiding the most common error in Chef-land.
+    #
+    # This method will return +nil+ if any deeply nested key does not exist.
+    #
+    # @see [Node#deep_fetch!]
+    #
+    def deep_fetch(*keys)
+      deep_fetch!(*keys)
+    rescue NoMethodError, AttributeDoesNotExistError
+      nil
+    end
+
+    #
+    # Deeply fetch a node attribute by specifying a list of keys, bypassing
+    # Ruby's Hash notation.
+    #
+    # This method will raise any exceptions, such as
+    # +undefined method `[]' for nil:NilClass+, just as if you used the native
+    # attribute notation. If you want a safely vivified hash, see {deep_fetch}.
+    #
+    # @example Fetch a deeply nested key
+    #   node.deep_fetch(:foo, :bar, :zip) #=> node['foo']['bar']['zip']
+    #
+    # @param [Array<String, Symbol>] keys
+    #   the list of keys to kdeep fetch
+    #
+    # @return [Object]
+    #
+    def deep_fetch!(*keys)
+      keys.map!(&:to_s)
+
+      keys.inject(attributes.to_hash) do |hash, key|
+        hash[key]
+      end
+    rescue NoMethodError
+      raise AttributeDoesNotExistError.new(keys)
+    end
+
+    #
+    # Dynamically define the current namespace. Multiple namespaces may be
+    # nested.
+    #
+    # @example Define a simple namespace
+    #
+    #   namespace 'apache2' do
+    #     # ...
+    #   end
+    #
+    # @example Define a nested namespace
+    #
+    #   namespace 'apache2', 'config' do
+    #     # ...
+    #   end
+    #
+    # @example Define a complex nested namespace
+    #
+    #   namespace 'apache2' do
+    #     namespace 'config' do
+    #       # ...
+    #     end
+    #   end
+    #
+    # @example Define a namespace with a custom precedence level
+    #
+    #   namespace 'apache2', precedence: normal do
+    #     # Attributes here will use the "normal" level
+    #   end
+    #
+    # @example Define different nested precedence levels
+    #
+    #   namespace 'apache2', precedence: normal do
+    #     # Attributes defined here will use the "normal" level
+    #
+    #     namespace 'config', precedence: override do
+    #       # Attributes defined  here will use the "override" level
+    #     end
+    #   end
+    #
+    #
+    # @param [Array] args
+    #   the list of arguments (such as the namespace and precedence levels)
+    #   the user gave
+    # @param [Proc] block
+    #   the nested evaluation context
+    #
+    # @return [nil]
+    #   to prevent accidential method chaining if the block isn't closed
+    #
+    def namespace(*args, &block)
+      @namespace_options = {
+        precedence: default
+      }.merge(args.last.is_a?(Hash) ? args.pop : {})
+
+      keys = args.map(&:to_s)
+
+      @current_namespace = current_namespace + keys
+      instance_eval(&block)
+      @current_namespace = current_namespace - keys
+
+      nil
+    end
+
+    alias_method :old_method_missing, :method_missing
+    #
+    # Provide a nice DSL for defining attributes. +method_missing+ is called
+    # on all the attribute names. For more information on how to use the DSL,
+    # see the class-level documentation.
+    #
+    # @return [nil]
+    #   to prevent accidential method chaining if the block isn't closed
+    #
+    def method_missing(m, *args, &block)
+      old_method_missing(m, *args, &block)
+    rescue NoMethodError
+      vivified[m.to_s] = args.size == 1 ? args.first : args
+      nil
+    end
+
+    private
+
+    #
+    # The current namespace. This is actually a reverse-ordered array that
+    # vivifies the correct hash.#
+    #
+    # @return [Array<String>]
+    #
+    def current_namespace
+      @current_namespace ||= []
+    end
+
+    #
+    # The vivified (fake-filled) hash. It is assumed that the default value
+    # for non-existent keys in the hash is a new, empty hash.
+    #
+    # @return [Hash<String, Hash>]
+    #
+    def vivified
+      current_namespace.inject(@namespace_options[:precedence]) do |hash, item|
+        hash[item] ||= {}
+        hash[item]
+      end
+    end
   end
 end

data/lib/chef/sugar/platform.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/platform_family.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/ruby.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/shell.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/vagrant.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/version.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.
@@ -16,6 +16,6 @@
 
 class Chef
   module Sugar
-    VERSION = '1.1.0'
+    VERSION = '1.2.0.beta.1'
   end
 end

data/metadata.rb

@@ -5,4 +5,4 @@ license          'Apache 2.0'
 description      'Installs chef-sugar. Please see the chef-sugar ' \
                  'Ruby gem for more information.'
 long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))
-version          '1.0.1'
+version          '1.1.0'

data/recipes/default.rb

@@ -2,7 +2,7 @@
 # Cookbook Name:: chef-sugar
 # Recipe:: default
 #
-# 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.
@@ -18,7 +18,7 @@
 #
 
 chef_gem('chef-sugar') do
-  version '1.0.1'
+  version '1.2.0.beta.1'
   action  :nothing
 end.run_action(:install)