chef-cookie_cutter 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4db0c57ad4430870c0c6bdf8c3c522ffd14787c
-  data.tar.gz: fa7dd0a9ce574447b8da18c156344f3ca1c32794
+  metadata.gz: b0f8d1f2d2e240ce7fc042f2eb7cd00faf800848
+  data.tar.gz: 28fafa9dd01fc4f4803b6d187f6dbfb40cb75ab9
 SHA512:
-  metadata.gz: 1d41c1d0325d21a8dd7daa6fede520be658718ba2a48b69b13edfa063bda69d7578b4605e42fd48270335352ed6e64594b8a3f8c9ca4895843148ad7102d0c42
-  data.tar.gz: ab1b3e57a68edb7845ae5a92818f59187d3776f7b5b31bc8b40b57a11778a9803474ebe0a755b340000684f430a4834e18b5dc032e3af7a8cc427cc8fee502cb
+  metadata.gz: 6c203b0f3b695aab6074c8719edc2c1e2e12d58b5d0d6cc494560fdd8019e1b13f0ea2791141fd21f1a6660703b0d4202f18ea05015d67389c886e2af91452a4
+  data.tar.gz: 76f64c329450c0b2ce2c28b39da21557d80f03335ec20e154fa07c5dfbe8ea9190a7b6a350452690930e6679f826980b6dfeeaad06460e65d28c4192ca789b47

data/lib/chef/cookie_cutter/extended_provides/monkey_patches.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.
+#
+
+class Chef
+  module CookieCutter
+    module ExtendedProvides
+      module MonkeyPatches
+        module RunContext
+          attr_reader :resource_builder
+
+          def build_resource(builder)
+            @resource_builder = builder
+          end
+        end
+
+        module ResourceBuilder
+          def build(&block)
+            run_context.build_resource(self)
+            super(&block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/cookie_cutter/extended_provides.rb

@@ -14,33 +14,16 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+require 'chef/run_context'
+require 'chef/resource_builder'
 
 class Chef
   module CookieCutter
     module ExtendedProvides
-      module_function
+      require_relative 'extended_provides/monkey_patches'
 
-      def register
-        Chef::RunContext.send :prepend, MonkeyPatches::RunContext
-        Chef::ResourceBuilder.send :prepend, MonkeyPatches::ResourceBuilder
-      end
-
-      module MonkeyPatches
-        module RunContext
-          attr_reader :resource_builder
-
-          def build_resource(builder)
-            @resource_builder = builder
-          end
-        end
-
-        module ResourceBuilder
-          def build(&block)
-            run_context.build_resource(self)
-            super(&block)
-          end
-        end
-      end
+      ::Chef::RunContext.send :prepend, MonkeyPatches::RunContext
+      ::Chef::ResourceBuilder.send :prepend, MonkeyPatches::ResourceBuilder
     end
   end
 end

data/lib/chef/cookie_cutter/fancy_property/cookbook_doc.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 FancyPropertyModule
+      module MonkeyPatches
+        # Monkey Patches for KnifeCookbookDoc::ResourceModel
+        # Enriches attribute/property description with additional info
+        # if certain options are passed to FancyProperty
+        # Removes argument declaration from description if present, and makes
+        # it available accessor
+        module DocumentResourceModel
+          ARGS_REGEX = /@args\s*\(([^\(\)]+)\)\s*(.*)/
+
+          def attribute_description(attribute)
+            description = attribute_descriptions[attribute.to_s] || ''
+            description = ARGS_REGEX.match(description)[2] if description =~ ARGS_REGEX
+            opts = @native_resource.attribute_specifications[attribute]
+            description += " Must be a `#{opts[:coerce_resource]}` resource or a block." if opts.key?(:coerce_resource)
+            description += ' This attribute can be specified multiple times.' if opts.key?(:collect)
+            description
+          end
+
+          def attribute_arguments(attribute)
+            description = attribute_descriptions[attribute.to_s]
+            return [] unless description =~ ARGS_REGEX
+            ARGS_REGEX.match(description)[1].split(',').map(&:strip)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/cookie_cutter/fancy_property/property.rb

@@ -0,0 +1,150 @@
+# 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
+    class FancyProperty < ::Chef::Property
+      def call(resource, *args, **kwargs, &blk)
+        return get(resource) if args.empty? && kwargs.empty? && !block_given?
+        return get(resource) if args[0] == NOT_PASSED
+        set(resource, *args, **kwargs, &blk)
+      end
+
+      def get(resource)
+        if instance_variable_name && collect? && !is_set?(resource)
+          []
+        else
+          super
+        end
+      end
+
+      def set(resource, *args, **kwargs, &blk)
+        if args[0].is_a?(DelayedEvaluator)
+          set_value(resource, args[0])
+        else
+          value = coerce(resource, *args, **kwargs, &blk)
+          validate(resource, value)
+          set_value(resource, value)
+        end
+      end
+
+      def coerce(resource, *args, **kwargs, &blk)
+        if options.key?(:coerce_class)
+          value = coerce_class(options[:coerce_class], *args, **kwargs, &blk)
+          value = coerce_proc(resource, options[:coerce], value) if options.key?(:coerce)
+          value
+        elsif options.key?(:coerce_resource)
+          value = coerce_resource(resource, options[:coerce_resource], args[0], &blk)
+          value = coerce_proc(resource, options[:coerce], value) if options.key?(:coerce)
+          value
+        elsif options.key?(:coerce)
+          coerce_proc(resource, options[:coerce], *args, **kwargs, &blk)
+        elsif args.length == 1 && kwargs.empty?
+          args[0]
+        else
+          fail Chef::Exceptions::ValidationFailed, "No coercion given for arguments #{args}, #{kwargs}"
+        end
+      end
+
+      def coerce_class(clazz, *args, **kwargs, &blk)
+        args << kwargs unless kwargs.empty?
+        value = clazz.new(*args)
+        value.instance_eval(&blk) if block_given?
+        value
+      end
+
+      def coerce_resource(resource, resource_type, value, &blk)
+        return value if value.is_a?(::Chef::Resource) && value.declared_type == resource_type
+        new_resource = ::Chef::ResourceBuilder.new(
+          type: resource_type,
+          name: value,
+          created_at: caller[0],
+          params: nil,
+          run_context: resource.run_context,
+          cookbook_name: resource.cookbook_name,
+          recipe_name: resource.recipe_name,
+          enclosing_provider: nil
+        ).build(&blk)
+        resource.run_context.resource_collection.insert(
+          new_resource,
+          resource_type: resource_type,
+          instance_name: value
+        )
+        new_resource
+      end
+
+      def coerce_proc(resource, coerce, *args, **kwargs, &blk)
+        args << kwargs unless kwargs.empty?
+        value = resource.instance_exec(*args, &coerce) unless resource.nil?
+        value.instance_eval(&blk) if block_given?
+        value = coerce(resource, value) if value.is_a?(DelayedEvaluator)
+        value
+      end
+
+      def emit_dsl
+        return unless instance_variable_name
+
+        if allow_kwargs?
+          declared_in.class_eval <<-EOM, __FILE__, __LINE__ + 1
+            def #{name}(*args, **kwargs, &blk)
+              self.class.properties[#{name.inspect}].call(self, *args, **kwargs, &blk)
+            end
+          EOM
+        else
+          declared_in.class_eval <<-EOM, __FILE__, __LINE__ + 1
+            def #{name}(value=NOT_PASSED, &blk)
+              self.class.properties[#{name.inspect}].call(self, value, {}, &blk)
+            end
+            def #{name}=(value)
+              self.class.properties[#{name.inspect}].set(self, value, {})
+            end
+          EOM
+        end
+      end
+
+      def collect?
+        options[:collect]
+      end
+
+      def allow_kwargs?
+        return true if options[:allow_kwargs]
+        return true if options.key?(:coerce) && options[:coerce].arity != 1
+        return true if options.key?(:coerce_class) && options[:coerce_class].instance_method(:initialize).arity != 1
+        false
+      end
+
+      def validation_options
+        @validation_options ||= options.reject do |k, _|
+          [
+            :declared_in, :name, :instance_variable_name, :desired_state,
+            :identity, :default, :name_property, :coerce, :required, :collect,
+            :allow_kwargs, :coerce_class, :coerce_resource
+          ].include?(k)
+        end
+      end
+
+      def set_value(resource, value)
+        if instance_variable_name && collect?
+          resource.instance_variable_set(instance_variable_name, []) unless is_set?(resource)
+          get_value(resource) << value
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/chef/cookie_cutter/fancy_property.rb

@@ -23,169 +23,11 @@ class Chef
 
   module CookieCutter
     module FancyPropertyModule
-      module_function
+      require_relative 'fancy_property/property'
+      require_relative 'fancy_property/cookbook_doc'
 
-      # rubocop:disable Style/GuardClause
-      def register
-        if defined?(DocumentingLWRPBase)
-          DocumentingLWRPBase.send :extend, DocumentingResourceDSL
-        end
-        if defined?(KnifeCookbookDoc)
-          KnifeCookbookDoc::ResourceModel.send :prepend, MonkeyPatches::DocumentResourceModel
-        end
-      end
-
-      module DocumentingResourceDSL
-        def property(name, type = NOT_PASSED, **options)
-          result = super(name, type, options)
-          attribute_specifications[name] = options
-          result
-        end
-      end
-
-      module MonkeyPatches
-        # Monkey Patches for KnifeCookbookDoc::ResourceModel
-        # Enriches attribute/property description with additional info
-        # if certain options are passed to FancyProperty
-        module DocumentResourceModel
-          def attribute_description(attribute)
-            description = super || ''
-            opts = @native_resource.attribute_specifications[attribute]
-            description += " Must be a `#{opts[:coerce_resource]}` resource or a block." if opts.key?(:coerce_resource)
-            description += ' This attribute can be specified multiple times.' if opts.key?(:collect)
-            description
-          end
-        end
-      end
-    end
-
-    class FancyProperty < ::Chef::Property
-      def call(resource, *args, **kwargs, &blk)
-        return get(resource) if args.empty? && kwargs.empty? && !block_given?
-        return get(resource) if args[0] == NOT_PASSED
-        set(resource, *args, **kwargs, &blk)
-      end
-
-      def get(resource)
-        if instance_variable_name && collect? && !is_set?(resource)
-          []
-        else
-          super
-        end
-      end
-
-      def set(resource, *args, **kwargs, &blk)
-        if args[0].is_a?(DelayedEvaluator)
-          set_value(resource, args[0])
-        else
-          value = coerce(resource, *args, **kwargs, &blk)
-          validate(resource, value)
-          set_value(resource, value)
-        end
-      end
-
-      def coerce(resource, *args, **kwargs, &blk)
-        if options.key?(:coerce_class)
-          value = coerce_class(options[:coerce_class], *args, **kwargs, &blk)
-          value = coerce_proc(resource, options[:coerce], value) if options.key?(:coerce)
-          value
-        elsif options.key?(:coerce_resource)
-          value = coerce_resource(resource, options[:coerce_resource], args[0], &blk)
-          value = coerce_proc(resource, options[:coerce], value) if options.key?(:coerce)
-          value
-        elsif options.key?(:coerce)
-          coerce_proc(resource, options[:coerce], *args, **kwargs, &blk)
-        elsif args.length == 1 && kwargs.empty?
-          args[0]
-        else
-          fail Chef::Exceptions::ValidationFailed, "No coercion given for arguments #{args}, #{kwargs}"
-        end
-      end
-
-      def coerce_class(clazz, *args, **kwargs, &blk)
-        args << kwargs unless kwargs.empty?
-        value = clazz.new(*args)
-        value.instance_eval(&blk) if block_given?
-        value
-      end
-
-      def coerce_resource(resource, resource_type, value, &blk)
-        return value if value.is_a?(::Chef::Resource) && value.declared_type == resource_type
-        new_resource = ::Chef::ResourceBuilder.new(
-          type: resource_type,
-          name: value,
-          created_at: caller[0],
-          params: nil,
-          run_context: resource.run_context,
-          cookbook_name: resource.cookbook_name,
-          recipe_name: resource.recipe_name,
-          enclosing_provider: nil
-        ).build(&blk)
-        resource.run_context.resource_collection.insert(
-          new_resource,
-          resource_type: resource_type,
-          instance_name: value
-        )
-        new_resource
-      end
-
-      def coerce_proc(resource, coerce, *args, **kwargs, &blk)
-        args << kwargs unless kwargs.empty?
-        value = resource.instance_exec(*args, &coerce) unless resource.nil?
-        value.instance_eval(&blk) if block_given?
-        value = coerce(resource, value) if value.is_a?(DelayedEvaluator)
-        value
-      end
-
-      def emit_dsl
-        return unless instance_variable_name
-
-        if allow_kwargs?
-          declared_in.class_eval <<-EOM, __FILE__, __LINE__ + 1
-            def #{name}(*args, **kwargs, &blk)
-              self.class.properties[#{name.inspect}].call(self, *args, **kwargs, &blk)
-            end
-          EOM
-        else
-          declared_in.class_eval <<-EOM, __FILE__, __LINE__ + 1
-            def #{name}(value=NOT_PASSED, &blk)
-              self.class.properties[#{name.inspect}].call(self, value, {}, &blk)
-            end
-            def #{name}=(value)
-              self.class.properties[#{name.inspect}].set(self, value, {})
-            end
-          EOM
-        end
-      end
-
-      def collect?
-        options[:collect]
-      end
-
-      def allow_kwargs?
-        return true if options[:allow_kwargs]
-        return true if options.key?(:coerce) && options[:coerce].arity != 1
-        return true if options.key?(:coerce_class) && options[:coerce_class].instance_method(:initialize).arity != 1
-        false
-      end
-
-      def validation_options
-        @validation_options ||= options.reject do |k, _|
-          [
-            :declared_in, :name, :instance_variable_name, :desired_state,
-            :identity, :default, :name_property, :coerce, :required, :collect,
-            :allow_kwargs, :coerce_class, :coerce_resource
-          ].include?(k)
-        end
-      end
-
-      def set_value(resource, value)
-        if instance_variable_name && collect?
-          resource.instance_variable_set(instance_variable_name, []) unless is_set?(resource)
-          get_value(resource) << value
-        else
-          super
-        end
+      if defined?(KnifeCookbookDoc)
+        KnifeCookbookDoc::ResourceModel.send :prepend, MonkeyPatches::DocumentResourceModel
       end
     end
   end

data/lib/chef/cookie_cutter/include_properties/dsl.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.
+#
+require_relative 'errors'
+
+class Chef
+  module CookieCutter
+    module IncludeProperties
+      module DSL
+        def properties_shared?(name)
+          exist_state?(:cookie_cutter, :shared_properties, name)
+        end
+
+        def share_properties(name, &block)
+          fail Errors::SharedPropertiesAlreadyDefined, name if properties_shared? name
+          store_state(:cookie_cutter, :shared_properties, name, block)
+        end
+
+        def include_properties(name)
+          fail Errors::SharedPropertiesNotDefined, name unless properties_shared? name
+          block = fetch_state(:cookie_cutter, :shared_properties, name)
+          instance_eval(&block)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# 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 IncludeProperties
+      module Errors
+        class SharedPropertiesAlreadyDefined < StandardError
+          def initialize(name)
+            super <<-EOH
+A shared property set with the name #{name} already exists. Please make sure that
+every shared property set you define has a unique name.
+EOH
+          end
+        end
+
+        class SharedPropertiesNotDefined < StandardError
+          def initialize(name)
+            super <<-EOH
+A property set with the name #{name} has not been shared.
+EOH
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/cookie_cutter/include_properties.rb

@@ -0,0 +1,33 @@
+# 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/recipe'
+require 'chef/resource'
+require 'chef/provider'
+require_relative 'run_state'
+
+class Chef
+  module CookieCutter
+    module IncludeProperties
+      require_relative 'include_properties/dsl'
+      require_relative 'include_properties/errors'
+
+      ::Chef::Recipe.send :include, DSL
+      ::Chef::Resource.send :include, DSL
+      ::Chef::Provider.send :include, DSL
+    end
+  end
+end

data/lib/chef/cookie_cutter/{lwrp_include.rb → include_resource/cookbook_doc.rb}

@@ -17,70 +17,13 @@
 
 class Chef
   module CookieCutter
-    module LWRPInclude
-      module_function
-
-      # rubocop:disable Style/GuardClause
-      def register
-        Chef::Resource::LWRPBase.send :extend, ResourceDSL
-        Chef::Provider::LWRPBase.send :extend, ProviderDSL
-        if defined?(DocumentingLWRPBase)
-          DocumentingLWRPBase.send :extend, DocumentingResourceDSL
-          DocumentingLWRPBase.send :extend, FakeResource
-        end
-        if defined?(KnifeCookbookDoc)
-          KnifeCookbookDoc::ReadmeModel.send :prepend, MonkeyPatches::DocumentReadmeModel
-          KnifeCookbookDoc::ResourceModel.send :prepend, MonkeyPatches::DocumentResourceModel
-        end
-      end
-
-      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 ResourceDSL
-        def lwrp_include(name, cookbook: nil)
-          cookbook = lwrp_cookbook_name if cookbook.nil?
-          context = lwrp_run_context
-          filename = LWRPInclude.filename_for_record(context, cookbook, :resources, name)
-          include LWRPInclude.build_resource_module_from_file(filename)
-        end
-      end
-
-      module ProviderDSL
-        def lwrp_include(name, cookbook: nil)
-          cookbook = lwrp_cookbook_name if cookbook.nil?
-          context = lwrp_run_context
-          filename = LWRPInclude.filename_for_record(context, cookbook, :providers, name)
-          include LWRPInclude.build_resource_module_from_file(filename)
-        end
-      end
-
-      module DocumentingResourceDSL
+    module IncludeResource
+      module CookbookDocDSL
         def mixins
           @mixins ||= []
         end
 
-        def lwrp_include(name, cookbook: nil)
+        def include_resource(name, cookbook: nil)
           mixins << { name: name, cookbook: cookbook }
         end
       end
@@ -107,7 +50,7 @@ class Chef
         end
 
         # Monkey Patches for KnifeCookbookDoc::ResourceModel
-        # Overwrites load_descriptions to additionally check if a lwrp is a mixin.
+        # Overwrites load_descriptions to additionally check if a resource is a mixin.
         # Saves cookbook and file name in instance variables
         module DocumentResourceModel
           def initialize(cookbook_name, file)
@@ -138,7 +81,7 @@ class Chef
             @native_resource.description.each_line do |line|
               if /^ *\@action *([^ ]*) (.*)$/ =~ line
                 action_descriptions[$1] = $2.strip
-              elsif /^ *\@attribute *([^ ]*) (.*)$/ =~ line
+              elsif /^ *(?:\@attribute|\@property) *([^ ]*) (.*)$/ =~ line
                 attribute_descriptions[$1] = $2.strip
               elsif /^ *\@section (.*)$/ =~ line
                 current_section = $1.strip