compat_resource 12.5.10 → 12.5.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fa16b436f408af71be67cea805e6efe50489f91
-  data.tar.gz: d9d1497a1f8053979e585cd1058b7d536dc93e65
+  metadata.gz: 945c69b844a9383c193df2623398c426f0022340
+  data.tar.gz: 1b6533381e1f85a1f12bd80042059f5ad2ea6ee5
 SHA512:
-  metadata.gz: f29ddaf1dfee4d494888d4afd987696ecb393bd18d371049e71ae1b398292da6708c49d41b9a35e6084b2b734d6fff44c996393755cbe0dca90c1a2563262ec5
-  data.tar.gz: f4747ca15c2b9ff2ca15e867f61168974657df45af2b2c7b625f90b70904e657e35d2746aeab9bf215ad776c9bbd515f67cf875d00f7e1c53e61a3b8e3a9d0a9
+  metadata.gz: e356b9380f8e99b432ab210d70134e1f6a711ef3b25db04f0998ae4cc83549fdb5b9a38c8fda4c0487a4718bfe26eb1c4a850e46333b3c84021893c8e009d97f
+  data.tar.gz: e398d09c2e35040aa9eff70979289126a322734157a5bae4b0207980df58e7fb1db5b07a13cca2375893c074a68d2cf195ad20e2bf4567ae28dbbec203ad0948

data/Rakefile

@@ -15,11 +15,15 @@ task default: :spec
 #
 CHEF_FILES = %w(chef/constants chef/delayed_evaluator chef/property
                 chef/resource chef/resource/action_class chef/provider
-                chef/mixin/params_validate)
-SPEC_FILES = %w(unit/property_spec.rb unit/property/state_spec.rb unit/property/validation_spec.rb
+                chef/mixin/params_validate chef/mixin/properties)
+SPEC_FILES = %w(unit/mixin/properties_spec.rb
+                unit/property_spec.rb
+                unit/property/state_spec.rb
+                unit/property/validation_spec.rb
                 integration/recipes/resource_action_spec.rb
                 integration/recipes/resource_converge_if_changed_spec.rb
-                integration/recipes/resource_load_spec.rb)
+                integration/recipes/resource_load_spec.rb
+             )
 KEEP_FUNCTIONS = {
   'chef/resource' => %w(
     initialize
@@ -49,7 +53,7 @@ KEEP_FUNCTIONS = {
   ),
 }
 KEEP_INCLUDES = {
-  'chef/resource' => %w(Chef::Mixin::ParamsValidate),
+  'chef/resource' => %w(Chef::Mixin::ParamsValidate Chef::Mixin::Properties),
   'chef/provider' => [],
 }
 KEEP_CLASSES = {

data/files/lib/chef_compat.rb

@@ -1,5 +1,6 @@
 require 'chef_compat/version'
 require 'chef_compat/resource'
+require 'chef_compat/mixin/properties'
 
 module ChefCompat
 end

data/files/lib/chef_compat/copied_from_chef/chef/mixin/properties.rb

@@ -0,0 +1,324 @@
+require 'chef_compat/copied_from_chef'
+class Chef
+module ::ChefCompat
+module CopiedFromChef
+require 'chef_compat/copied_from_chef/chef/delayed_evaluator'
+require 'chef_compat/copied_from_chef/chef/mixin/params_validate'
+require 'chef_compat/copied_from_chef/chef/property'
+
+class Chef < (defined?(::Chef) ? ::Chef : Object)
+  module Mixin
+    if defined?(::Chef::Mixin)
+      require 'chef_compat/delegating_class'
+      extend DelegatingClass
+      @delegates_to = ::Chef::Mixin
+    end
+    module Properties
+      if defined?(::Chef::Mixin::Properties)
+        require 'chef_compat/delegating_class'
+        extend DelegatingClass
+        @delegates_to = ::Chef::Mixin::Properties
+      end
+      module ClassMethods
+        if defined?(::Chef::Mixin::Properties::ClassMethods)
+          require 'chef_compat/delegating_class'
+          extend DelegatingClass
+          @delegates_to = ::Chef::Mixin::Properties::ClassMethods
+        end
+        #
+        # The list of properties defined on this resource.
+        #
+        # Everything defined with `property` is in this list.
+        #
+        # @param include_superclass [Boolean] `true` to include properties defined
+        #   on superclasses; `false` or `nil` to return the list of properties
+        #   directly on this class.
+        #
+        # @return [Hash<Symbol,Property>] The list of property names and types.
+        #
+        def properties(include_superclass=true)
+          if include_superclass
+            result = {}
+            ancestors.reverse_each { |c| result.merge!(c.properties(false)) if c.respond_to?(:properties) }
+            result
+          else
+            @properties ||= {}
+          end
+        end
+
+        #
+        # Create a property on this resource class.
+        #
+        # If a superclass has this property, or if this property has already been
+        # defined by this resource, this will *override* the previous value.
+        #
+        # @param name [Symbol] The name of the property.
+        # @param type [Object,Array<Object>] The type(s) of this property.
+        #   If present, this is prepended to the `is` validation option.
+        # @param options [Hash<Symbol,Object>] Validation options.
+        #   @option options [Object,Array] :is An object, or list of
+        #     objects, that must match the value using Ruby's `===` operator
+        #     (`options[:is].any? { |v| v === value }`).
+        #   @option options [Object,Array] :equal_to An object, or list
+        #     of objects, that must be equal to the value using Ruby's `==`
+        #     operator (`options[:is].any? { |v| v == value }`)
+        #   @option options [Regexp,Array<Regexp>] :regex An object, or
+        #     list of objects, that must match the value with `regex.match(value)`.
+        #   @option options [Class,Array<Class>] :kind_of A class, or
+        #     list of classes, that the value must be an instance of.
+        #   @option options [Hash<String,Proc>] :callbacks A hash of
+        #     messages -> procs, all of which match the value. The proc must
+        #     return a truthy or falsey value (true means it matches).
+        #   @option options [Symbol,Array<Symbol>] :respond_to A method
+        #     name, or list of method names, the value must respond to.
+        #   @option options [Symbol,Array<Symbol>] :cannot_be A property,
+        #     or a list of properties, that the value cannot have (such as `:nil` or
+        #     `:empty`). The method with a questionmark at the end is called on the
+        #     value (e.g. `value.empty?`). If the value does not have this method,
+        #     it is considered valid (i.e. if you don't respond to `empty?` we
+        #     assume you are not empty).
+        #   @option options [Proc] :coerce A proc which will be called to
+        #     transform the user input to canonical form. The value is passed in,
+        #     and the transformed value returned as output. Lazy values will *not*
+        #     be passed to this method until after they are evaluated. Called in the
+        #     context of the resource (meaning you can access other properties).
+        #   @option options [Boolean] :required `true` if this property
+        #     must be present; `false` otherwise. This is checked after the resource
+        #     is fully initialized.
+        #   @option options [Boolean] :name_property `true` if this
+        #     property defaults to the same value as `name`. Equivalent to
+        #     `default: lazy { name }`, except that #property_is_set? will
+        #     return `true` if the property is set *or* if `name` is set.
+        #   @option options [Boolean] :name_attribute Same as `name_property`.
+        #   @option options [Object] :default The value this property
+        #     will return if the user does not set one. If this is `lazy`, it will
+        #     be run in the context of the instance (and able to access other
+        #     properties).
+        #   @option options [Boolean] :desired_state `true` if this property is
+        #     part of desired state. Defaults to `true`.
+        #   @option options [Boolean] :identity `true` if this property
+        #     is part of object identity. Defaults to `false`.
+        #
+        # @example Bare property
+        #   property :x
+        #
+        # @example With just a type
+        #   property :x, String
+        #
+        # @example With just options
+        #   property :x, default: 'hi'
+        #
+        # @example With type and options
+        #   property :x, String, default: 'hi'
+        #
+        def property(name, type=NOT_PASSED, **options)
+          name = name.to_sym
+
+          options.each { |k,v| options[k.to_sym] = v if k.is_a?(String) }
+
+          options[:instance_variable_name] = :"@#{name}" if !options.has_key?(:instance_variable_name)
+          options.merge!(name: name, declared_in: self)
+
+          if type == NOT_PASSED
+            # If a type is not passed, the property derives from the
+            # superclass property (if any)
+            if properties.has_key?(name)
+              property = properties[name].derive(**options)
+            else
+              property = property_type(**options)
+            end
+
+          # If a Property is specified, derive a new one from that.
+          elsif type.is_a?(Property) || (type.is_a?(Class) && type <= Property)
+            property = type.derive(**options)
+
+          # If a primitive type was passed, combine it with "is"
+          else
+            if options[:is]
+              options[:is] = ([ type ] + [ options[:is] ]).flatten(1)
+            else
+              options[:is] = type
+            end
+            property = property_type(**options)
+          end
+
+          local_properties = properties(false)
+          local_properties[name] = property
+
+          property.emit_dsl
+        end
+
+        #
+        # Create a reusable property type that can be used in multiple properties
+        # in different resources.
+        #
+        # @param options [Hash<Symbol,Object>] Validation options. see #property for
+        #   the list of options.
+        #
+        # @example
+        #   property_type(default: 'hi')
+        #
+        def property_type(**options)
+          Property.derive(**options)
+        end
+
+        #
+        # Create a lazy value for assignment to a default value.
+        #
+        # @param block The block to run when the value is retrieved.
+        #
+        # @return [Chef::DelayedEvaluator] The lazy value
+        #
+        def lazy(&block)
+          DelayedEvaluator.new(&block)
+        end
+
+        #
+        # Get or set the list of desired state properties for this resource.
+        #
+        # State properties are properties that describe the desired state
+        # of the system, such as file permissions or ownership.
+        # In general, state properties are properties that could be populated by
+        # examining the state of the system (e.g., File.stat can tell you the
+        # permissions on an existing file). Contrarily, properties that are not
+        # "state properties" usually modify the way Chef itself behaves, for example
+        # by providing additional options for a package manager to use when
+        # installing a package.
+        #
+        # This list is used by the Chef client auditing system to extract
+        # information from resources to describe changes made to the system.
+        #
+        # This method is unnecessary when declaring properties with `property`;
+        # properties are added to state_properties by default, and can be turned off
+        # with `desired_state: false`.
+        #
+        # ```ruby
+        # property :x # part of desired state
+        # property :y, desired_state: false # not part of desired state
+        # ```
+        #
+        # @param names [Array<Symbol>] A list of property names to set as desired
+        #   state.
+        #
+        # @return [Array<Property>] All properties in desired state.
+        #
+        def state_properties(*names)
+          if !names.empty?
+            names = names.map { |name| name.to_sym }.uniq
+
+            local_properties = properties(false)
+            # Add new properties to the list.
+            names.each do |name|
+              property = properties[name]
+              if !property
+                self.property name, instance_variable_name: false, desired_state: true
+              elsif !property.desired_state?
+                self.property name, desired_state: true
+              end
+            end
+
+            # If state_attrs *excludes* something which is currently desired state,
+            # mark it as desired_state: false.
+            local_properties.each do |name,property|
+              if property.desired_state? && !names.include?(name)
+                self.property name, desired_state: false
+              end
+            end
+          end
+
+          properties.values.select { |property| property.desired_state? }
+        end
+
+        #
+        # Set the identity of this resource to a particular set of properties.
+        #
+        # This drives #identity, which returns data that uniquely refers to a given
+        # resource on the given node (in such a way that it can be correlated
+        # across Chef runs).
+        #
+        # This method is unnecessary when declaring properties with `property`;
+        # properties can be added to identity during declaration with
+        # `identity: true`.
+        #
+        # ```ruby
+        # property :x, identity: true # part of identity
+        # property :y # not part of identity
+        # ```
+        #
+        # If no properties are marked as identity, "name" is considered the identity.
+        #
+        # @param names [Array<Symbol>] A list of property names to set as the identity.
+        #
+        # @return [Array<Property>] All identity properties.
+        #
+        def identity_properties(*names)
+          if !names.empty?
+            names = names.map { |name| name.to_sym }
+
+            # Add or change properties that are not part of the identity.
+            names.each do |name|
+              property = properties[name]
+              if !property
+                self.property name, instance_variable_name: false, identity: true
+              elsif !property.identity?
+                self.property name, identity: true
+              end
+            end
+
+            # If identity_properties *excludes* something which is currently part of
+            # the identity, mark it as identity: false.
+            properties.each do |name,property|
+              if property.identity? && !names.include?(name)
+
+                self.property name, identity: false
+              end
+            end
+          end
+
+          result = properties.values.select { |property| property.identity? }
+          result = [ properties[:name] ] if result.empty?
+          result
+        end
+
+        def included(other)
+          other.extend ClassMethods
+        end
+      end
+
+      def self.included(other)
+        other.extend ClassMethods
+      end
+
+      include Chef::Mixin::ParamsValidate
+
+      #
+      # Whether this property has been set (or whether it has a default that has
+      # been retrieved).
+      #
+      # @param name [Symbol] The name of the property.
+      # @return [Boolean] `true` if the property has been set.
+      #
+      def property_is_set?(name)
+        property = self.class.properties[name.to_sym]
+        raise ArgumentError, "Property #{name} is not defined in class #{self}" if !property
+        property.is_set?(self)
+      end
+
+      #
+      # Clear this property as if it had never been set. It will thereafter return
+      # the default.
+      # been retrieved).
+      #
+      # @param name [Symbol] The name of the property.
+      #
+      def reset_property(name)
+        property = self.class.properties[name.to_sym]
+        raise ArgumentError, "Property #{name} is not defined in class #{self}" if !property
+        property.reset(self)
+      end
+    end
+  end
+end
+end
+end
+end

data/files/lib/chef_compat/copied_from_chef/chef/provider.rb

@@ -28,26 +28,39 @@ super if defined?(::Chef::Provider)
         specified_properties = properties.select { |property| new_resource.property_is_set?(property) }
         modified = specified_properties.select { |p| new_resource.send(p) != current_resource.send(p) }
         if modified.empty?
-          Chef::Log.debug("Skipping update of #{new_resource.to_s}: has not changed any of the specified properties #{specified_properties.map { |p| "#{p}=#{new_resource.send(p).inspect}" }.join(", ")}.")
+          properties_str = if sensitive
+            specified_properties.join(", ")
+          else
+            specified_properties.map { |p| "#{p}=#{new_resource.send(p).inspect}" }.join(", ")
+          end
+          Chef::Log.debug("Skipping update of #{new_resource.to_s}: has not changed any of the specified properties #{properties_str}.")
           return false
         end
 
         # Print the pretty green text and run the block
         property_size = modified.map { |p| p.size }.max
-        modified = modified.map { |p| "  set #{p.to_s.ljust(property_size)} to #{new_resource.send(p).inspect} (was #{current_resource.send(p).inspect})" }
+        modified.map! do |p|
+          properties_str = if sensitive
+            '(suppressed sensitive property)'
+          else
+            "#{new_resource.send(p).inspect} (was #{current_resource.send(p).inspect})"
+          end
+          "  set #{p.to_s.ljust(property_size)} to #{properties_str}"
+        end
         converge_by([ "update #{current_resource.identity}" ] + modified, &converge_block)
 
       else
         # The resource doesn't exist. Mark that we are *creating* this, and
         # write down any properties we are setting.
         property_size = properties.map { |p| p.size }.max
-        created = []
-        properties.each do |property|
-          if new_resource.property_is_set?(property)
-            created << "  set #{property.to_s.ljust(property_size)} to #{new_resource.send(property).inspect}"
+        created = properties.map do |property|
+          default = ' (default value)' unless new_resource.property_is_set?(property)
+          properties_str = if sensitive
+            '(suppressed sensitive property)'
           else
-            created << "  set #{property.to_s.ljust(property_size)} to #{new_resource.send(property).inspect} (default value)"
+            new_resource.send(property).inspect
           end
+          "  set #{property.to_s.ljust(property_size)} to #{properties_str}#{default}"
         end
 
         converge_by([ "create #{new_resource.identity}" ] + created, &converge_block)

data/files/lib/chef_compat/copied_from_chef/chef/resource.rb

@@ -2,10 +2,12 @@ require 'chef_compat/copied_from_chef'
 class Chef
 module ::ChefCompat
 module CopiedFromChef
-require 'chef_compat/copied_from_chef/chef/mixin/params_validate'
 require 'chef_compat/copied_from_chef/chef/resource/action_class'
+require 'chef_compat/copied_from_chef/chef/mixin/properties'
 class Chef < (defined?(::Chef) ? ::Chef : Object)
   class Resource < (defined?(::Chef::Resource) ? ::Chef::Resource : Object)
+    include Chef::Mixin::Properties
+    property :name, String, coerce: proc { |v| v.is_a?(Array) ? v.join(', ') : v.to_s }, desired_state: false
     def initialize(name, run_context=nil)
 super if defined?(::Chef::Resource)
       name(name) unless name.nil?
@@ -35,18 +37,6 @@ super if defined?(::Chef::Resource)
       @elapsed_time = 0
       @sensitive = false
     end
-    def self.properties(include_superclass=true)
-      @properties ||= {}
-      if include_superclass
-        if superclass.respond_to?(:properties)
-          superclass.properties.merge(@properties)
-        else
-          @properties.dup
-        end
-      else
-        @properties
-      end
-    end
     def action(arg=nil)
       if arg
         arg = Array(arg).map(&:to_sym)
@@ -82,113 +72,6 @@ super if defined?(::Chef::Resource)
       return result.values.first if identity_properties.size == 1
       result
     end
-    include Chef::Mixin::ParamsValidate
-    def self.property(name, type=NOT_PASSED, **options)
-      name = name.to_sym
-
-      options.each { |k,v| options[k.to_sym] = v if k.is_a?(String) }
-
-      options[:instance_variable_name] = :"@#{name}" if !options.has_key?(:instance_variable_name)
-      options.merge!(name: name, declared_in: self)
-
-      if type == NOT_PASSED
-        # If a type is not passed, the property derives from the
-        # superclass property (if any)
-        if properties.has_key?(name)
-          property = properties[name].derive(**options)
-        else
-          property = property_type(**options)
-        end
-
-      # If a Property is specified, derive a new one from that.
-      elsif type.is_a?(Property) || (type.is_a?(Class) && type <= Property)
-        property = type.derive(**options)
-
-      # If a primitive type was passed, combine it with "is"
-      else
-        if options[:is]
-          options[:is] = ([ type ] + [ options[:is] ]).flatten(1)
-        else
-          options[:is] = type
-        end
-        property = property_type(**options)
-      end
-
-      local_properties = properties(false)
-      local_properties[name] = property
-
-      property.emit_dsl
-    end
-    def self.property_type(**options)
-      Property.derive(**options)
-    end
-    property :name, String, coerce: proc { |v| v.is_a?(Array) ? v.join(', ') : v.to_s }, desired_state: false
-    def property_is_set?(name)
-      property = self.class.properties[name.to_sym]
-      raise ArgumentError, "Property #{name} is not defined in class #{self}" if !property
-      property.is_set?(self)
-    end
-    def reset_property(name)
-      property = self.class.properties[name.to_sym]
-      raise ArgumentError, "Property #{name} is not defined in class #{self}" if !property
-      property.reset(self)
-    end
-    def self.lazy(&block)
-      DelayedEvaluator.new(&block)
-    end
-    def self.state_properties(*names)
-      if !names.empty?
-        names = names.map { |name| name.to_sym }.uniq
-
-        local_properties = properties(false)
-        # Add new properties to the list.
-        names.each do |name|
-          property = properties[name]
-          if !property
-            self.property name, instance_variable_name: false, desired_state: true
-          elsif !property.desired_state?
-            self.property name, desired_state: true
-          end
-        end
-
-        # If state_attrs *excludes* something which is currently desired state,
-        # mark it as desired_state: false.
-        local_properties.each do |name,property|
-          if property.desired_state? && !names.include?(name)
-            self.property name, desired_state: false
-          end
-        end
-      end
-
-      properties.values.select { |property| property.desired_state? }
-    end
-    def self.identity_properties(*names)
-      if !names.empty?
-        names = names.map { |name| name.to_sym }
-
-        # Add or change properties that are not part of the identity.
-        names.each do |name|
-          property = properties[name]
-          if !property
-            self.property name, instance_variable_name: false, identity: true
-          elsif !property.identity?
-            self.property name, identity: true
-          end
-        end
-
-        # If identity_properties *excludes* something which is currently part of
-        # the identity, mark it as identity: false.
-        properties.each do |name,property|
-          if property.identity? && !names.include?(name)
-            self.property name, identity: false
-          end
-        end
-      end
-
-      result = properties.values.select { |property| property.identity? }
-      result = [ properties[:name] ] if result.empty?
-      result
-    end
     def self.identity_property(name=nil)
       result = identity_properties(*Array(name))
       if result.size > 1

data/files/lib/chef_compat/mixin/properties.rb

@@ -0,0 +1,8 @@
+require 'chef_compat/monkeypatches'
+require 'chef_compat/copied_from_chef/chef/mixin/properties'
+
+module ChefCompat
+  module Mixin
+    Properties = ChefCompat::CopiedFromChef::Chef::Mixin::Properties
+  end
+end

data/files/lib/chef_compat/monkeypatches/chef.rb

@@ -3,7 +3,7 @@ class Chef
   # Earlier versions of Chef didn't have this message
   module ChefCompatDeprecation
     def log_deprecation(message, location=nil)
-      if superclass.respond_to?(:log_deprecation)
+      if superclass.method(:log_deprecation).owner != ChefCompatDeprecation
         if !location
           # Pick the first caller that is *not* part of the Chef or ChefCompat gem,
           # that's the thing the user wrote.

data/files/lib/chef_compat/version.rb

@@ -1,3 +1,3 @@
 module ChefCompat
-  VERSION = '12.5.10' if !defined?(VERSION)
+  VERSION = '12.5.11' if !defined?(VERSION)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compat_resource
 version: !ruby/object:Gem::Version
-  version: 12.5.10
+  version: 12.5.11
 platform: ruby
 authors:
 - John Keiser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-20 00:00:00.000000000 Z
+date: 2015-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -96,11 +96,13 @@ files:
 - files/lib/chef_compat/copied_from_chef/chef/constants.rb
 - files/lib/chef_compat/copied_from_chef/chef/delayed_evaluator.rb
 - files/lib/chef_compat/copied_from_chef/chef/mixin/params_validate.rb
+- files/lib/chef_compat/copied_from_chef/chef/mixin/properties.rb
 - files/lib/chef_compat/copied_from_chef/chef/property.rb
 - files/lib/chef_compat/copied_from_chef/chef/provider.rb
 - files/lib/chef_compat/copied_from_chef/chef/resource.rb
 - files/lib/chef_compat/copied_from_chef/chef/resource/action_class.rb
 - files/lib/chef_compat/delegating_class.rb
+- files/lib/chef_compat/mixin/properties.rb
 - files/lib/chef_compat/monkeypatches.rb
 - files/lib/chef_compat/monkeypatches/chef.rb
 - files/lib/chef_compat/monkeypatches/chef/exceptions.rb