chef-cookie_cutter 0.2.0 → 1.0.0

data/lib/chef/cookie_cutter/include_resource/dsl.rb

@@ -0,0 +1,56 @@
+# encoding: UTF-8
+#
+# Copyright 2015, Ole Claussen <claussen.ole@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 'chef/cookbook/file_vendor'
+
+class Chef
+  module CookieCutter
+    module IncludeResource
+      module_function
+
+      def try_file(filename)
+        return if File.exist?(filename) && File.readable?(filename)
+        fail IOError, "Cannot open or read #{filename}"
+      end
+
+      def filename_for_record(run_context, cookbook_name, segment, name)
+        name += '.rb' unless name.end_with?('.rb')
+        cookbook_version = run_context.cookbook_collection[cookbook_name]
+        file_vendor = ::Chef::Cookbook::FileVendor.create_from_manifest(cookbook_version.manifest)
+        manifest_record = cookbook_version.preferred_manifest_record(run_context.node, segment.to_s, name)
+        file_vendor.get_filename(manifest_record[:path])
+      end
+
+      def build_resource_module_from_file(filename)
+        try_file(filename)
+        resource_module = Module.new
+        resource_module.instance_variable_set('@filename', filename)
+        def resource_module.included(cls)
+          cls.class_eval(IO.read(@filename), @filename, 1)
+        end
+        resource_module
+      end
+
+      module DSL
+        def include_resource(name, cookbook: nil)
+          cookbook = resource_cookbook_name if cookbook.nil?
+          filename = IncludeResource.filename_for_record(run_context, cookbook, :resources, name)
+          include IncludeResource.build_resource_module_from_file(filename)
+        end
+      end
+    end
+  end
+end

data/lib/chef/cookie_cutter/include_resource/fake_resource.rb

@@ -0,0 +1,40 @@
+# encoding: UTF-8
+#
+# Copyright 2015, Ole Claussen <claussen.ole@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 CookieCutter
+    module IncludeResource
+      module FakeResource
+        class FakeClass
+          extend FakeResource
+        end
+
+        def method_missing(*)
+          # do nothing
+        end
+
+        def respond_to?(*)
+          true
+        end
+
+        def const_missing(*)
+          FakeClass
+        end
+      end
+    end
+  end
+end

data/lib/chef/cookie_cutter/include_resource/monkey_patches.rb

@@ -0,0 +1,42 @@
+# encoding: UTF-8
+#
+# Copyright 2015, Ole Claussen <claussen.ole@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 CookieCutter
+    module IncludeResource
+      module MonkeyPatches
+        # Monkey Patches for Chef::Resource::LWRPBase
+        # Makes the parameters of build_from_file (i.e. cookbook_name, filename
+        # and run_context) available in the created class.
+        module CustomResource
+          module ClassMethods
+            def build_from_file(cookbook_name, filename, run_context)
+              define_singleton_method(:resource_cookbook_name) { cookbook_name }
+              super
+            end
+          end
+
+          def self.prepended(base)
+            class << base
+              prepend ClassMethods
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/cookie_cutter/include_resource.rb

@@ -0,0 +1,39 @@
+# encoding: UTF-8
+#
+# Copyright 2015, Ole Claussen <claussen.ole@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 'chef/resource/lwrp_base'
+
+class Chef
+  module CookieCutter
+    module IncludeResource
+      require_relative 'include_resource/dsl'
+      require_relative 'include_resource/monkey_patches'
+      require_relative 'include_resource/cookbook_doc'
+      require_relative 'include_resource/fake_resource'
+
+      Chef::Resource::LWRPBase.send :extend, DSL
+      Chef::Resource::LWRPBase.send :prepend, MonkeyPatches::CustomResource
+      if defined?(DocumentingLWRPBase)
+        DocumentingLWRPBase.send :extend, CookbookDocDSL
+        DocumentingLWRPBase.send :extend, FakeResource
+      end
+      if defined?(KnifeCookbookDoc)
+        KnifeCookbookDoc::ReadmeModel.send :prepend, MonkeyPatches::DocumentReadmeModel
+        KnifeCookbookDoc::ResourceModel.send :prepend, MonkeyPatches::DocumentResourceModel
+      end
+    end
+  end
+end

data/lib/chef/cookie_cutter/{fake_resource.rb → namespace/dsl.rb}

@@ -14,24 +14,17 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+require_relative 'namespace'
 
 class Chef
   module CookieCutter
-    module FakeResource
-      class FakeClass
-        extend FakeResource
-      end
-
-      def method_missing(*)
-        # do nothing
-      end
-
-      def respond_to?(*)
-        true
-      end
-
-      def const_missing(*)
-        FakeClass
+    module Namespace
+      module DSL
+        def namespace(*args)
+          keys = args.map(&:to_s)
+          attribute = Namespace.deep_fetch(node.attributes, keys)
+          yield attribute if block_given?
+        end
       end
     end
   end

data/lib/chef/cookie_cutter/namespace/monkey_patches.rb

@@ -0,0 +1,67 @@
+# encoding: UTF-8
+#
+# Copyright 2015, Ole Claussen <claussen.ole@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 'namespace'
+
+class Chef
+  module CookieCutter
+    module Namespace
+      module MonkeyPatches
+        module Node
+          def namespace(*args, **kwargs, &blk)
+            @namespace_options = namespace_options.merge(kwargs)
+            keys = args.map(&:to_s)
+            @current_namespace = current_namespace + keys
+            instance_eval(&blk) if block_given?
+            @current_namespace = current_namespace - keys
+            @namespace_options = nil if @current_namespace.empty?
+            nil
+          end
+
+          def method_missing(method_name, *args)
+            super
+          rescue NoMethodError
+            if args.empty?
+              deep_key = current_namespace.dup << method_name.to_s
+              return Namespace.deep_fetch!(attributes, deep_key)
+            else
+              vivified[method_name.to_s] = args.size == 1 ? args.first : args
+              return nil
+            end
+          end
+
+          private
+
+          def namespace_options
+            @namespace_options ||= { precedence: default }
+          end
+
+          def current_namespace
+            @current_namespace ||= []
+          end
+
+          def vivified
+            precedence = namespace_options[:precedence]
+            current_namespace.inject(precedence) do |hash, item|
+              hash[item] ||= {}
+              hash[item]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/cookie_cutter/namespace/namespace.rb

@@ -0,0 +1,46 @@
+# encoding: UTF-8
+#
+# Copyright 2015, Ole Claussen <claussen.ole@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 CookieCutter
+    module Namespace
+      module_function
+
+      class AttributeDoesNotExistError < StandardError
+        def initialize(keys, key)
+          super <<-EOH
+No attribute `node#{keys.map { |k| "['#{k}']" }.join}' exists on the current
+node. Specifically the `#{key}' attribute is not defined. Please make sure you
+have spelled everything
+correctly.
+EOH
+        end
+      end
+
+      def deep_fetch(attributes, keys)
+        keys.map!(&:to_s)
+        keys.inject(attributes.to_hash) do |hash, key|
+          if hash.key?(key)
+            hash[key]
+          else
+            fail AttributeDoesNotExistError.new(keys, key)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/cookie_cutter/namespace.rb

@@ -14,92 +14,22 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+require 'chef/recipe'
+require 'chef/resource'
+require 'chef/provider'
+require 'chef/node'
 
 class Chef
   module CookieCutter
     module Namespace
-      module_function
-
-      def register
-        Chef::Recipe.send :include, DSL
-        Chef::Resource.send :include, DSL
-        Chef::Provider.send :include, DSL
-        Chef::Node.send :prepend, MonkeyPatches::Node
-      end
-
-      class AttributeDoesNotExistError < StandardError
-        def initialize(keys, key)
-          super <<-EOH
-No attribute `node#{keys.map { |k| "['#{k}']" }.join}' exists on the current
-node. Specifically the `#{key}' attribute is not defined. Please make sure you
-have spelled everything
-correctly.
-EOH
-        end
-      end
-
-      def deep_fetch(attributes, keys)
-        keys.map!(&:to_s)
-        keys.inject(attributes.to_hash) do |hash, key|
-          if hash.key?(key)
-            hash[key]
-          else
-            fail AttributeDoesNotExistError.new(keys, key)
-          end
-        end
-      end
-
-      module DSL
-        def namespace(*args)
-          keys = args.map(&:to_s)
-          attribute = Namespace.deep_fetch(node.attributes, keys)
-          yield attribute if block_given?
-        end
-      end
-
-      module MonkeyPatches
-        module Node
-          def namespace(*args, **kwargs, &blk)
-            @namespace_options = namespace_options.merge(kwargs)
-            keys = args.map(&:to_s)
-            @current_namespace = current_namespace + keys
-            instance_eval(&blk) if block_given?
-            @current_namespace = current_namespace - keys
-            @namespace_options = nil if @current_namespace.empty?
-            nil
-          end
-
-          def method_missing(method_name, *args)
-            super
-          rescue NoMethodError
-            if args.empty?
-              deep_key = current_namespace.dup << method_name.to_s
-              return Namespace.deep_fetch!(attributes, deep_key)
-            else
-              vivified[method_name.to_s] = args.size == 1 ? args.first : args
-              return nil
-            end
-          end
-
-          private
-
-          def namespace_options
-            @namespace_options ||= { precedence: default }
-          end
-
-          def current_namespace
-            @current_namespace ||= []
-          end
-
-          def vivified
-            precedence = namespace_options[:precedence]
-            current_namespace.inject(precedence) do |hash, item|
-              hash[item] ||= {}
-              hash[item]
-            end
-          end
-        end
-      end
+      require_relative 'namespace/dsl'
+      require_relative 'namespace/monkey_patches'
+      require_relative 'namespace/namespace'
+
+      ::Chef::Recipe.send :include, DSL
+      ::Chef::Resource.send :include, DSL
+      ::Chef::Provider.send :include, DSL
+      ::Chef::Node.send :prepend, MonkeyPatches::Node
     end
   end
 end

data/lib/chef/cookie_cutter/run_state/dsl.rb

@@ -0,0 +1,50 @@
+# encoding: UTF-8
+#
+# Copyright 2015, Ole Claussen <claussen.ole@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 'errors'
+
+class Chef
+  module CookieCutter
+    module RunState
+      module DSL
+        def store_state(*subkeys, key, value)
+          subkeys.map!(&:to_s)
+          hash = node.run_state
+          subkeys.each do |k|
+            hash[k] = {} if hash[k].nil?
+            hash = hash[k]
+          end
+          hash[key.to_s] = value
+        end
+
+        def fetch_state(*keys)
+          keys.map!(&:to_s)
+          keys.inject(node.run_state) do |hash, key|
+            fail Errors::RunStateDoesNotExistError.new(keys, key) unless hash.key? key
+            hash[key]
+          end
+        end
+
+        def exist_state?(*keys)
+          fetch_state(*keys)
+          true
+        rescue Errors::RunStateDoesNotExistError
+          false
+        end
+      end
+    end
+  end
+end

data/lib/chef/cookie_cutter/run_state/errors.rb

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+#
+# Copyright 2015, Ole Claussen <claussen.ole@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 CookieCutter
+    module RunState
+      module Errors
+        class RunStateDoesNotExistError < StandardError
+          def initialize(keys, key)
+            hash = keys.map { |k| "['#{k}']" }
+            super <<-EOH
+The run_state does not contain an element at run_state#{hash.join}.
+Specifically, #{key} is not defined.
+EOH
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/cookie_cutter/run_state.rb

@@ -14,62 +14,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+require 'chef/recipe'
+require 'chef/resource'
+require 'chef/provider'
 
 class Chef
   module CookieCutter
     module RunState
-      module_function
+      require_relative 'run_state/dsl'
+      require_relative 'run_state/errors'
 
-      def register
-        Chef::Recipe.send :include, DSL
-        Chef::Resource.send :include, DSL
-        Chef::Provider.send :include, DSL
-      end
-
-      class RunStateDoesNotExistError < StandardError
-        def initialize(keys, key)
-          hash = keys.map { |k| "['#{k}']" }
-          super <<-EOH
-The run_state does not contain an element at run_state#{hash.join}.
-Specifically, #{key} is not defined.
-EOH
-        end
-      end
-
-      def store_state(node, *subkeys, key, value)
-        subkeys.map!(&:to_s)
-        hash = node.run_state
-        subkeys.each do |k|
-          hash[k] = {} if hash[k].nil?
-          hash = hash[k]
-        end
-        hash[key.to_s] = value
-      end
-
-      def fetch_state(node, *keys)
-        keys.map!(&:to_s)
-        keys.inject(node.run_state) do |hash, key|
-          fail RunState::RunStateDoesNotExistError.new(keys, key) unless hash.key? key
-          hash[key]
-        end
-      end
-
-      module DSL
-        def store_state(*subkeys, key, value)
-          RunState.store_state(node, *subkeys, key, value)
-        end
-
-        def fetch_state(*keys)
-          RunState.fetch_state(node, *keys)
-        end
-
-        def exist_state?(*keys)
-          RunState.fetch_state(node, *keys)
-          true
-        rescue RunState::RunStateDoesNotExistError
-          false
-        end
-      end
+      ::Chef::Recipe.send :include, DSL
+      ::Chef::Resource.send :include, DSL
+      ::Chef::Provider.send :include, DSL
     end
   end
 end

data/lib/chef/cookie_cutter/spec_matchers/monkey_patches.rb

@@ -0,0 +1,48 @@
+# encoding: UTF-8
+#
+# Copyright 2015, Ole Claussen <claussen.ole@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 CookieCutter
+    module SpecMatchers
+      module MonkeyPatches
+        # Monkey Patches for Chef::Resource::LWRPBase
+        # Automatically registers chef spec matchers after building the resource
+        module CustomResource
+          module ClassMethods
+            def build_from_file(cookbook_name, filename, run_context)
+              resource = super
+              if defined?(ChefSpec) && !resource.is_a?(TrueClass)
+                resource.actions.each do |action|
+                  Object.send :define_method, "#{action}_#{resource.resource_name}" do |msg|
+                    ::ChefSpec::Matchers::ResourceMatcher.new(resource.resource_name, action, msg)
+                  end
+                end
+              end
+              resource
+            end
+          end
+
+          def self.prepended(base)
+            class << base
+              prepend ClassMethods
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/cookie_cutter/spec_matchers.rb

@@ -14,41 +14,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+require 'chef/resource'
 
 class Chef
   module CookieCutter
     module SpecMatchers
-      module_function
+      require_relative 'spec_matchers/monkey_patches'
 
-      def register
-        Chef::Resource::LWRPBase.send :prepend, MonkeyPatches::LWRPResource
-      end
-
-      module MonkeyPatches
-        # Monkey Patches for Chef::Resource::LWRPBase
-        # Automatically registers chef spec matchers after building the resource
-        module LWRPResource
-          module ClassMethods
-            def build_from_file(cookbook_name, filename, run_context)
-              resource = super
-              if defined?(ChefSpec) && !resource.is_a?(TrueClass)
-                resource.actions.each do |action|
-                  Object.send :define_method, "#{action}_#{resource.resource_name}" do |msg|
-                    ::ChefSpec::Matchers::ResourceMatcher.new(resource.resource_name, action, msg)
-                  end
-                end
-              end
-              resource
-            end
-          end
-
-          def self.prepended(base)
-            class << base
-              prepend ClassMethods
-            end
-          end
-        end
-      end
+      ::Chef::Resource::LWRPBase.send :prepend, MonkeyPatches::CustomResource
     end
   end
 end