poise 2.0.0

data/lib/poise/helpers/subresources/default_containers.rb

@@ -0,0 +1,73 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# 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.
+#
+
+
+module Poise
+  module Helpers
+    module Subresources
+      # Helpers to track default container resources. This is used to find a
+      # default parent for a child with no parent set. It flat out violates
+      # encapsulation to allow for the use of default parents to act as
+      # system-level defaults even when created in a nested scope.
+      #
+      # @api private
+      # @since 2.0.0
+      module DefaultContainers
+        # Mutex to sync access to the containers array.
+        #
+        # @see .containers
+        CONTAINER_MUTEX = Mutex.new
+
+        # Add a resource to the array of default containers.
+        #
+        # @param resource [Chef::Resource] Resource to add.
+        # @param run_context [Chef::RunContext] Context of the current run.
+        # @return [void]
+        def self.register!(resource, run_context)
+          CONTAINER_MUTEX.synchronize do
+            containers(run_context) << resource
+          end
+        end
+
+        # Find a default container for a resource class.
+        #
+        # @param klass [Class] Resource class to search for.
+        # @param run_context [Chef::RunContext] Context of the current run.
+        # @return [Chef::Resource]
+        def self.find(klass, run_context)
+          CONTAINER_MUTEX.synchronize do
+            containers(run_context).reverse_each do |resource|
+              return resource if resource.is_a?(klass)
+            end
+            # Nothing found.
+            nil
+          end
+        end
+
+        private
+
+        # Get the array of all default container resources.
+        #
+        # @note MUST BE CALLED FROM A LOCKED CONTEXT!
+        # @param run_context [Chef::RunContext] Context of the current run.
+        # @return [Array<Chef::Resource>]
+        def self.containers(run_context)
+          run_context.node.run_state[:poise_default_containers] ||= []
+        end
+      end
+    end
+  end
+end

data/lib/poise/helpers/template_content.rb

@@ -0,0 +1,165 @@
+#
+# Copyright 2013-2015, Noah Kantrowitz
+#
+# 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/provider/template_finder'
+require 'chef/mixin/template'
+
+require 'poise/helpers/lazy_default'
+require 'poise/helpers/lwrp_polyfill'
+require 'poise/helpers/option_collector'
+require 'poise/utils'
+
+
+module Poise
+  module Helpers
+    # A resource mixin to add a new kind of attribute, template content. TODO
+    #
+    # @since 1.0.0
+    module TemplateContent
+      include LazyDefault
+      include LWRPPolyfill
+      include OptionCollector
+
+      # @!classmethods
+      module ClassMethods
+        def attribute(name, options={})
+          if options.delete(:template)
+            name_prefix = name.empty? ? '' : "#{name}_"
+
+            # If you are reading this, I'm so sorry
+            # This is used for computing the default cookbook below
+            parent_filename = caller.first.reverse.split(':', 4).last.reverse
+
+            # If our parent class also declared a template_content attribute on the same name, inherit its options
+            if superclass.respond_to?("_#{name_prefix}_template_content_options")
+              options = superclass.send("_#{name_prefix}_template_content_options").merge(options)
+            end
+
+            # Template source path if using a template
+            attribute("#{name_prefix}source", kind_of: String)
+            define_method("_#{name_prefix}source") do
+              send("#{name_prefix}source") || maybe_eval(options[:default_source])
+            end
+
+            # Template cookbook name if using a template
+            attribute("#{name_prefix}cookbook", kind_of: [String, Symbol], default: lazy do
+              if send("#{name_prefix}source")
+                cookbook_name
+              elsif options[:default_cookbook]
+                maybe_eval(options[:default_cookbook])
+              else
+                Poise::Utils.find_cookbook_name(run_context, parent_filename)
+              end
+            end)
+
+            # Template variables if using a template
+            attribute("#{name_prefix}options", option_collector: true)
+
+            # The big one, get/set content, but if you are getting and no
+            # explicit content was given, try to render the template
+            define_method("#{name_prefix}content") do |arg=nil, no_compute=false|
+              ret = set_or_return("#{name_prefix}content", arg, kind_of: String)
+              if !ret && !arg && !no_compute
+                ret = send("_#{name_prefix}content")
+                # Cache the results for next time
+                set_or_return("#{name_prefix}content", ret, {}) if ret
+              end
+              ret
+            end
+
+            # Validate that arguments work
+            define_method("_#{name_prefix}validate") do
+              if options[:required] && !send("_#{name_prefix}source") && !send("#{name_prefix}content", nil, true)
+                raise Chef::Exceptions::ValidationFailed, "#{self}: One of #{name_prefix}source or #{name_prefix}content is required"
+              end
+              if send("#{name_prefix}source") && send("#{name_prefix}content", nil, true)
+                raise Chef::Exceptions::ValidationFailed, "#{self}: Only one of #{name_prefix}source or #{name_prefix}content can be specified"
+              end
+            end
+
+            # Monkey patch #after_create to run best-effort validation. Arguments
+            # could be changed after creation, but this gives nicer errors for
+            # most cases.
+            unless options[:no_validate_on_create]
+              old_after_created = instance_method(:after_created)
+              define_method(:after_created) do
+                old_after_created.bind(self).call
+                send("_#{name_prefix}validate")
+              end
+            end
+
+            # Compile the needed content
+            define_method("_#{name_prefix}content") do
+              # Run validation again
+              send("_#{name_prefix}validate")
+              # Get all the relevant parameters
+              content = send("#{name_prefix}content", nil, true)
+              source = send("_#{name_prefix}source")
+              if content
+                content # I don't think it can ever hit this branch
+              elsif source
+                cookbook = send("#{name_prefix}cookbook")
+                template_options = send("#{name_prefix}options")
+                send("_#{name_prefix}render_template", source, cookbook, template_options)
+              else
+                maybe_eval(options[:default])
+              end
+            end
+
+            # Actually render a template
+            define_method("_#{name_prefix}render_template") do |source, cookbook, template_options|
+              all_template_options = {}
+              all_template_options.update(maybe_eval(options[:default_options])) if options[:default_options]
+              all_template_options.update(template_options)
+              all_template_options[:new_resource] = self
+              finder = Chef::Provider::TemplateFinder.new(run_context, cookbook, node)
+              context = Chef::Mixin::Template::TemplateContext.new(all_template_options)
+              context[:node] = node
+              context[:template_finder] = finder
+              context.render_template(finder.find(source))
+            end
+
+            # Used to check if a parent class already defined a template_content thing here
+            define_singleton_method("_#{name_prefix}_template_content_options") do
+              options
+            end
+          else
+            super if defined?(super)
+          end
+        end
+
+        def included(klass)
+          super
+          klass.extend(ClassMethods)
+        end
+      end
+
+      extend ClassMethods
+
+      private
+
+      # Evaluate lazy blocks if needed
+      def maybe_eval(val)
+        if val.is_a?(Chef::DelayedEvaluator)
+          instance_eval(&val)
+        else
+          val
+        end
+      end
+
+    end
+  end
+end

data/lib/poise/provider.rb

@@ -0,0 +1,55 @@
+#
+# Copyright 2013-2015, Noah Kantrowitz
+#
+# 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 'poise/helpers'
+
+
+module Poise
+  # Master provider mixin for Poise-based providers.
+  #
+  # @since 1.0.0
+  # @example Default helpers.
+  #   class MyProvider < Chef::Provider
+  #     include Poise::Provider
+  #   end
+  # @example With optional helpers.
+  #   class MyProvider < Chef::Provider
+  #     include Poise::Provider
+  #     poise_inversion(MyResource)
+  #   end
+  module Provider
+    include Poise::Helpers::DefinedIn
+    include Poise::Helpers::IncludeRecipe
+    include Poise::Helpers::LWRPPolyfill
+    include Poise::Helpers::NotifyingBlock
+
+    # @!classmethods
+    module ClassMethods
+      def poise_inversion(resource, attribute=nil)
+        include Poise::Helpers::Inversion
+        inversion_resource(resource)
+        inversion_attribute(attribute) if attribute
+      end
+
+      def included(klass)
+        super
+        klass.extend(ClassMethods)
+      end
+    end
+
+    extend ClassMethods
+  end
+end

data/lib/poise/resource.rb

@@ -0,0 +1,75 @@
+#
+# Copyright 2013-2015, Noah Kantrowitz
+#
+# 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 'poise/helpers'
+
+
+module Poise
+  # Master resource mixin for Poise-based resources.
+  #
+  # @since 1.0.0
+  # @example Default helpers.
+  #   class MyResource < Chef::Resource
+  #     include Poise::Resource
+  #   end
+  # @example With optional helpers.
+  #   class MyResource < Chef::Resource
+  #     include Poise::Resource
+  #     poise_subresource(MyParent)
+  #     poise_fused
+  #   end
+  module Resource
+    include Poise::Helpers::ChefspecMatchers
+    include Poise::Helpers::DefinedIn
+    include Poise::Helpers::LazyDefault
+    include Poise::Helpers::LWRPPolyfill
+    include Poise::Helpers::OptionCollector
+    include Poise::Helpers::ResourceName
+    include Poise::Helpers::TemplateContent
+
+    # @!classmethods
+    module ClassMethods
+      def poise_subresource_container(namespace=nil)
+        include Poise::Helpers::Subresources::Container
+        # false is a valid value.
+        container_namespace(namespace) unless namespace.nil?
+      end
+
+      def poise_subresource(parent_type=nil, parent_optional=nil, parent_auto=nil)
+        include Poise::Helpers::Subresources::Child
+        parent_type(parent_type) if parent_type
+        parent_optional(parent_optional) unless parent_optional.nil?
+        parent_auto(parent_auto) unless parent_auto.nil?
+      end
+
+      def poise_fused
+        include Poise::Helpers::Fused
+      end
+
+      def poise_inversion(options_resource=nil)
+        include Poise::Helpers::Inversion
+        inversion_options_resource(true) unless options_resource == false
+      end
+
+      def included(klass)
+        super
+        klass.extend(ClassMethods)
+      end
+    end
+
+    extend ClassMethods
+  end
+end

data/lib/poise/subcontext.rb

@@ -0,0 +1,27 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# 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.
+#
+
+
+module Poise
+  # Helpers and whatnot for dealing with subcontexts.
+  #
+  # @api private
+  # @since 2.0.0
+  module Subcontext
+    autoload :ResourceCollection, 'poise/subcontext/resource_collection'
+    autoload :Runner, 'poise/subcontext/runner'
+  end
+end

data/lib/poise/subcontext/resource_collection.rb

@@ -0,0 +1,56 @@
+#
+# Copyright 2013-2015, Noah Kantrowitz
+#
+# 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_collection'
+
+
+module Poise
+  module Subcontext
+    # A subclass of the normal Chef ResourceCollection that creates a partially
+    # isolated set of resources. Notifications and other resources lookups can
+    # propagate out to parent contexts but not back in. This is used to allow
+    # black-box resources that are still aware of things in upper contexts.
+    #
+    # @api private
+    # @since 1.0.0
+    class ResourceCollection < Chef::ResourceCollection
+      attr_accessor :parent
+
+      def initialize(parent)
+        @parent = parent
+        super()
+      end
+
+      def lookup(resource)
+        super
+      rescue Chef::Exceptions::ResourceNotFound
+        @parent.lookup(resource)
+      end
+
+      # Iterate and expand all nested contexts
+      def recursive_each(&block)
+        if @parent
+          if @parent.respond_to?(:recursive_each)
+            @parent.recursive_each(&block)
+          else
+            @parent.each(&block)
+          end
+        end
+        each(&block)
+      end
+    end
+  end
+end