puppet 3.8.7 → 4.0.0.rc1

data/lib/puppet/pops/validation/checker4_0.rb

@@ -14,8 +14,6 @@ class Puppet::Pops::Validation::Checker4_0
   Model = Puppet::Pops::Model
 
   attr_reader :acceptor
-  attr_reader :migration_checker
-
   # Initializes the validator with a diagnostics producer. This object must respond to
   # `:will_accept?` and `:accept`.
   #
@@ -30,9 +28,6 @@ class Puppet::Pops::Validation::Checker4_0
     @@idem_visitor        ||= Puppet::Pops::Visitor.new(self, "idem", 0, 0)
 
     @acceptor = diagnostics_producer
-
-    # Use null migration checker unless given in context
-    @migration_checker ||= (Puppet.lookup(:migration_checker) { Puppet::Pops::Migration::MigrationChecker.new() })
   end
 
   # Validates the entire model by visiting each model element and calling `check`.
@@ -187,18 +182,12 @@ class Puppet::Pops::Validation::Checker4_0
 
   def check_AttributesOperation(o)
     # Append operator use is constrained
-    parent1 = o.eContainer
-    case parent1
-    when Model::AbstractResource
-    when Model::CollectExpression
-    else
-      # protect against just testing a snippet that has no parent, error message will be a bit strange
-      # but it is not for a real program.
-      parent2 = parent1.nil? ? o : parent1.eContainer
-      unless parent2.is_a?(Model::AbstractResource)
-        acceptor.accept(Issues::UNSUPPORTED_OPERATOR_IN_CONTEXT, parent2, :operator=>'* =>')
-      end
+    parent = o.eContainer
+    parent = parent.eContainer unless parent.nil?
+    unless parent.is_a?(Model::ResourceExpression)
+      acceptor.accept(Issues::UNSUPPORTED_OPERATOR_IN_CONTEXT, o, :operator=>'* =>')
     end
+
     rvalue(o.expr)
   end
 
@@ -214,7 +203,6 @@ class Puppet::Pops::Validation::Checker4_0
         break # only flag the first
       end
     end
-    migration_checker.report_array_last_in_block(o.statements[-1])
   end
 
   def check_CallNamedFunctionExpression(o)
@@ -233,7 +221,6 @@ class Puppet::Pops::Validation::Checker4_0
   def check_EppExpression(o)
     if o.eContainer.is_a?(Puppet::Pops::Model::LambdaExpression)
       internal_check_no_capture(o.eContainer, o)
-      internal_check_parameter_name_uniqueness(o.eContainer)
     end
   end
 
@@ -297,12 +284,6 @@ class Puppet::Pops::Validation::Checker4_0
     'runtime' => true,
   }
 
-  FUTURE_RESERVED_WORDS = {
-    'application' => true,
-    'produces' => true,
-    'consumes' => true
-  }
-
   # for 'class', 'define', and function
   def check_NamedDefinition(o)
     top(o.eContainer, o)
@@ -314,12 +295,6 @@ class Puppet::Pops::Validation::Checker4_0
       acceptor.accept(Issues::RESERVED_TYPE_NAME, o, {:name => o.name})
     end
 
-    # This is perhaps not ideal but it's very difficult to pass a ReservedWord through
-    # the mechanism that creates qualified names (namestack, namepop etc.)
-    if FUTURE_RESERVED_WORDS[o.name]
-      acceptor.accept(Issues::FUTURE_RESERVED_WORD, o, {:word => o.name})
-    end
-
     if violator = ends_with_idem(o.body)
       acceptor.accept(Issues::IDEM_NOT_ALLOWED_LAST, violator, {:container => o})
     end
@@ -328,14 +303,12 @@ class Puppet::Pops::Validation::Checker4_0
   def check_HostClassDefinition(o)
     check_NamedDefinition(o)
     internal_check_no_capture(o)
-    internal_check_parameter_name_uniqueness(o)
     internal_check_reserved_params(o)
   end
 
   def check_ResourceTypeDefinition(o)
     check_NamedDefinition(o)
     internal_check_no_capture(o)
-    internal_check_parameter_name_uniqueness(o)
     internal_check_reserved_params(o)
   end
 
@@ -369,13 +342,6 @@ class Puppet::Pops::Validation::Checker4_0
     end
   end
 
-  def internal_check_parameter_name_uniqueness(o)
-    unique = Set.new
-    o.parameters.each do |p|
-      acceptor.accept(Issues::DUPLICATE_PARAMETER, p, {:param_name => p.name}) unless unique.add?(p.name)
-    end
-  end
-
   def check_IfExpression(o)
     rvalue(o.test)
   end
@@ -395,14 +361,6 @@ class Puppet::Pops::Validation::Checker4_0
     o.values.each {|v| rvalue(v) }
   end
 
-  def check_LiteralFloat(o)
-    migration_checker.report_ambiguous_float(o)
-  end
-
-  def check_LiteralInteger(o)
-    migration_checker.report_ambiguous_integer(o)
-  end
-
   def check_NodeDefinition(o)
     # Check that hostnames are valid hostnames (or regular expressions)
     hostname(o.host_matches, o)
@@ -449,10 +407,6 @@ class Puppet::Pops::Validation::Checker4_0
     if o.name =~ /^(?:0x)?[0-9]+$/
       acceptor.accept(Issues::ILLEGAL_NUMERIC_PARAMETER, o, :name => o.name)
     end
-
-    unless o.name =~ Puppet::Pops::Patterns::PARAM_NAME
-      acceptor.accept(Issues::ILLEGAL_PARAM_NAME, o, :name => o.name)
-    end
   end
 
   #relationship_side: resource
@@ -502,11 +456,7 @@ class Puppet::Pops::Validation::Checker4_0
   end
 
   def check_ReservedWord(o)
-    if o.future
-      acceptor.accept(Issues::FUTURE_RESERVED_WORD, o, :word => o.word)
-    else
-      acceptor.accept(Issues::RESERVED_WORD, o, :word => o.word)
-    end
+    acceptor.accept(Issues::RESERVED_WORD, o, :word => o.word)
   end
 
   def check_SelectorExpression(o)

data/lib/puppet/pops/validation/validator_factory_4_0.rb

@@ -23,9 +23,7 @@ class Puppet::Pops::Validation::ValidatorFactory_4_0 < Puppet::Pops::Validation:
     p[Issues::RT_NO_STORECONFIGS_EXPORT]    = Puppet[:storeconfigs] ? :ignore : :warning
     p[Issues::RT_NO_STORECONFIGS]           = Puppet[:storeconfigs] ? :ignore : :warning
 
-    p[Issues::FUTURE_RESERVED_WORD]          = :deprecation
-
-    p[Issues::NAME_WITH_HYPHEN]              = :error
+    p[Issues::NAME_WITH_HYPHEN]             = :error
     p[Issues::EMPTY_RESOURCE_SPECIALIZATION] = :ignore
     p
   end

data/lib/puppet/pops/visitor.rb

@@ -24,11 +24,14 @@ class Puppet::Pops::Visitor
 
   # Visit the configured receiver
   def visit(thing, *args)
-    visit_this(@receiver, thing, *args)
+    visit_this(@receiver, thing, args)
   end
 
+  DOUBLE_COLON = '::'
+  NO_ARGS = [].freeze
+
   # Visit an explicit receiver
-  def visit_this(receiver, thing, *args)
+  def visit_this(receiver, thing, args)
     raise "Visitor Error: Too few arguments passed. min = #{@min_args}" unless args.length >= @min_args
     if @max_args
       raise "Visitor Error: Too many arguments passed. max = #{@max_args}" unless args.length <= @max_args
@@ -37,7 +40,7 @@ class Puppet::Pops::Visitor
       return receiver.send(method_name, thing, *args)
     else
       thing.class.ancestors().each do |ancestor|
-        method_name = :"#{@message}_#{ancestor.name.split(/::/).last}"
+        method_name = :"#{@message}_#{ancestor.name.split(DOUBLE_COLON).last}"
         next unless receiver.respond_to?(method_name, true)
         @cache[thing.class] = method_name
         return receiver.send(method_name, thing, *args)
@@ -53,7 +56,7 @@ class Puppet::Pops::Visitor
     if method_name = @cache[thing.class]
       return receiver.send(method_name, thing)
     end
-    visit_this(receiver, thing)
+    visit_this(receiver, thing, NO_ARGS)
   end
 
   # Visit an explicit receiver with 1 args
@@ -63,7 +66,7 @@ class Puppet::Pops::Visitor
     if method_name = @cache[thing.class]
       return receiver.send(method_name, thing, arg)
     end
-    visit_this(receiver, thing, arg)
+    visit_this(receiver, thing, [arg])
   end
 
   # Visit an explicit receiver with 2 args
@@ -73,7 +76,7 @@ class Puppet::Pops::Visitor
     if method_name = @cache[thing.class]
       return receiver.send(method_name, thing, arg1, arg2)
     end
-    visit_this(receiver, thing, arg1, arg2)
+    visit_this(receiver, thing, [arg1, arg2])
   end
 
   # Visit an explicit receiver with 3 args
@@ -83,7 +86,7 @@ class Puppet::Pops::Visitor
     if method_name = @cache[thing.class]
       return receiver.send(method_name, thing, arg1, arg2, arg3)
     end
-    visit_this(receiver, thing, arg1, arg2, arg3)
+    visit_this(receiver, thing, [arg1, arg2, arg3])
   end
 
 end

data/lib/puppet/property.rb

@@ -33,9 +33,6 @@ require 'puppet/parameter'
 #   handling of measurements such as kb, mb, gb. If a type requires two different size measurements it requires
 #   one concrete class per such measure; e.g. MinSize (:parent => Size), and MaxSize (:parent => Size).
 #
-# @todo Describe meta-parameter shadowing. This concept can not be understood by just looking at the descriptions
-#   of the methods involved.
-#
 # @see Puppet::Type
 # @see Puppet::Parameter
 #
@@ -137,11 +134,6 @@ class Puppet::Property < Puppet::Parameter
   # @option options [Symbol] :event The event that should be emitted when this value is set.
   # @todo Option :event original comment says "event should be returned...", is "returned" the correct word
   #   to use?
-  # @option options [Symbol] :call When to call any associated block. The default value is `:instead` which
-  #   means that the block should be called instead of the provider. In earlier versions (before 20081031) it
-  #   was possible to specify a value of `:before` or `:after` for the purpose of calling
-  #   both the block and the provider. Use of these deprecated options will now raise an exception later
-  #   in the process when the _is_ value is set (see #set).
   # @option options [Symbol] :invalidate_refreshes Indicates a change on this property should invalidate and
   #   remove any scheduled refreshes (from notify or subscribe) targeted at the same resource. For example, if
   #   a change in this property takes into account any changes that a scheduled refresh would have performed,
@@ -149,18 +141,24 @@ class Puppet::Property < Puppet::Parameter
   # @option options [Object] any Any other option is treated as a call to a setter having the given
   #   option name (e.g. `:required_features` calls `required_features=` with the option's value as an
   #   argument).
-  # @todo The original documentation states that the option `:method` will set the name of the generated
-  #   setter method, but this is not implemented. Is the documentatin or the implementation in error?
-  #   (The implementation is in Puppet::Parameter::ValueCollection#new_value).
-  # @todo verify that the use of :before and :after have been deprecated (or rather - never worked, and
-  #   was never in use. (This means, that the option :call could be removed since calls are always :instead).
   #
   # @dsl type
   # @api public
   def self.newvalue(name, options = {}, &block)
     value = value_collection.newvalue(name, options, &block)
 
-    define_method(value.method, &value.block) if value.method and value.block
+    unless value.method.nil?
+      method = value.method.to_sym
+      if value.block
+        if instance_methods(false).include?(method)
+          raise ArgumentError, "Attempt to redefine method #{method} with block"
+        end
+        define_method(method, &value.block)
+      else
+        # Let the method be an alias for calling the providers setter unless we already have this method
+        alias_method(method, :call_provider) unless method_defined?(method)
+      end
+    end
     value
   end
 
@@ -171,45 +169,13 @@ class Puppet::Property < Puppet::Parameter
   # @api private
   #
   def call_provider(value)
-      method = self.class.name.to_s + "="
-      unless provider.respond_to? method
-        self.fail "The #{provider.class.name} provider can not handle attribute #{self.class.name}"
-      end
-      provider.send(method, value)
-  end
-
-  # Sets the value of this property to the given value by calling the dynamically created setter method associated with the "valid value" referenced by the given name.
-  # @param name [Symbol, Regexp] a valid value "name" as returned by {value_name}
-  # @param value [Object] the value to set as the value of the property
-  # @raise [Puppet::DevError] if there was no method to call
-  # @raise [Puppet::Error] if there were problems setting the value
-  # @raise [Puppet::ResourceError] if there was a problem setting the value and it was not raised
-  #   as a Puppet::Error. The original exception is wrapped and logged.
-  # @todo The check for a valid value option called `:method` does not seem to be fully supported
-  #   as it seems that this option is never consulted when the method is dynamically created. Needs to
-  #   be investigated. (Bug, or documentation needs to be changed).
-  # @see #set
-  # @api private
-  #
-  def call_valuemethod(name, value)
-    if method = self.class.value_option(name, :method) and self.respond_to?(method)
-      begin
-        self.send(method)
-      rescue Puppet::Error
-        raise
-      rescue => detail
-        error = Puppet::ResourceError.new("Could not set '#{value}' on #{self.class.name}: #{detail}", @resource.line, @resource.file, detail)
-        error.set_backtrace detail.backtrace
-        Puppet.log_exception(detail, error.message)
-        raise error
-      end
-    elsif block = self.class.value_option(name, :block)
-      # FIXME It'd be better here to define a method, so that
-      # the blocks could return values.
-      self.instance_eval(&block)
-    else
-      devfail "Could not find method for value '#{name}'"
+    # We have no idea how to handle this unless our parent have a provider
+    self.fail "#{self.class.name} cannot handle values of type #{value.inspect}" unless @resource.provider
+    method = self.class.name.to_s + "="
+    unless provider.respond_to? method
+      self.fail "The #{provider.class.name} provider can not handle attribute #{self.class.name}"
     end
+    provider.send(method, value)
   end
 
   # Formats a message for a property change from the given `current_value` to the given `newvalue`.
@@ -277,27 +243,6 @@ class Puppet::Property < Puppet::Parameter
     resource.event attrs
   end
 
-  # @todo What is this?
-  # What is this used for?
-  attr_reader :shadow
-
-  # Initializes a Property the same way as a Parameter and handles the special case when a property is shadowing a meta-parameter.
-  # @todo There is some special initialization when a property is not a metaparameter but
-  #   Puppet::Type.metaparamclass(for this class's name) is not nil - if that is the case a
-  #   setup_shadow is performed for that class.
-  #
-  # @param hash [Hash] options passed to the super initializer {Puppet::Parameter#initialize}
-  # @note New properties of a type should be created via the DSL method {Puppet::Type.newproperty}.
-  # @see Puppet::Parameter#initialize description of Parameter initialize options.
-  # @api private
-  def initialize(hash = {})
-    super
-
-    if ! self.metaparam? and klass = Puppet::Type.metaparamclass(self.class.name)
-      setup_shadow(klass)
-    end
-  end
-
   # Determines whether the property is in-sync or not in a way that is protected against missing value.
   # @note If the wanted value _(should)_ is not defined or is set to a non-true value then this is
   #   a state that can not be fixed and the property is reported to be in sync.
@@ -423,16 +368,6 @@ class Puppet::Property < Puppet::Parameter
     self.class.array_matching == :all
   end
 
-  # (see Puppet::Parameter#munge)
-  # If this property is a meta-parameter shadow, the shadow's munge is also called.
-  # @todo Incomprehensible ! The concept of "meta-parameter-shadowing" needs to be explained.
-  #
-  def munge(value)
-    self.shadow.munge(value) if self.shadow
-
-    super
-  end
-
   # @return [Symbol] the name of the property as stated when the property was created.
   # @note A property class (just like a parameter class) describes one specific property and
   #   can only be used once within one type's inheritance chain.
@@ -472,56 +407,41 @@ class Puppet::Property < Puppet::Parameter
   end
 
   # Sets the current _(is)_ value of this property.
-  # The value is set using the provider's setter method for this property ({#call_provider}) if nothing
-  # else has been specified. If the _valid value_ for the given value defines a `:call` option with the
-  # value `:instead`, the
-  # value is set with {#call_valuemethod} which invokes a block specified for the valid value.
-  #
-  # @note In older versions (before 20081031) it was possible to specify the call types `:before` and `:after`
-  #   which had the effect that both the provider method and the _valid value_ block were called.
-  #   This is no longer supported.
-  #
-  # @param value [Object] the value to set as the value of this property
-  # @return [Object] returns what {#call_valuemethod} or {#call_provider} returns
-  # @raise [Puppet::Error] when the provider setter should be used but there is no provider set in the _associated
-  #  resource_
-  # @raise [Puppet::DevError] when a deprecated call form was specified (e.g. `:before` or `:after`).
+  # The _name_ associated with the value is first obtained by calling {value_name}. A dynamically created setter
+  # method associated with this _name_ is called if it exists, otherwise the value is set using using the provider's
+  # setter method for this property by calling ({#call_provider}).
+  #
+  # @param value [Object] the value to set
+  # @return [Object] returns the result of calling the setter method or {#call_provider}
+  # @raise [Puppet::Error] if there were problems setting the value using the setter method or when the provider
+  #  setter should be used but there is no provider in the associated resource_
+  # @raise [Puppet::ResourceError] if there was a problem setting the value and it was not raised
+  #   as a Puppet::Error. The original exception is wrapped and logged.
   # @api public
   #
   def set(value)
     # Set a name for looking up associated options like the event.
     name = self.class.value_name(value)
-
-    call = self.class.value_option(name, :call) || :none
-
-    if call == :instead
-      call_valuemethod(name, value)
-    elsif call == :none
-      # They haven't provided a block, and our parent does not have
-      # a provider, so we have no idea how to handle this.
-      self.fail "#{self.class.name} cannot handle values of type #{value.inspect}" unless @resource.provider
-      call_provider(value)
+    if method = self.class.value_option(name, :method) and self.respond_to?(method)
+      begin
+        self.send(method)
+      rescue Puppet::Error
+        raise
+      rescue => detail
+        error = Puppet::ResourceError.new("Could not set '#{value}' on #{self.class.name}: #{detail}", @resource.line, @resource.file, detail)
+        error.set_backtrace detail.backtrace
+        Puppet.log_exception(detail, error.message)
+        raise error
+      end
+    elsif block = self.class.value_option(name, :block)
+      # FIXME It'd be better here to define a method, so that
+      # the blocks could return values.
+      self.instance_eval(&block)
     else
-      # LAK:NOTE 20081031 This is a change in behaviour -- you could
-      # previously specify :call => [;before|:after], which would call
-      # the setter *in addition to* the block.  I'm convinced this
-      # was never used, and it makes things unecessarily complicated.
-      # If you want to specify a block and still call the setter, then
-      # do so in the block.
-      devfail "Cannot use obsolete :call value '#{call}' for property '#{self.class.name}'"
+      call_provider(value)
     end
   end
 
-  # Sets up a shadow property for a shadowing meta-parameter.
-  # This construct allows the creation of a property with the
-  # same name as a meta-parameter. The metaparam will only be stored as a shadow.
-  # @param klass [Class<inherits Puppet::Parameter>] the class of the shadowed meta-parameter
-  # @return [Puppet::Parameter] an instance of the given class (a parameter or property)
-  #
-  def setup_shadow(klass)
-    @shadow = klass.new(:resource => self.resource)
-  end
-
   # Returns the wanted _(should)_ value of this property.
   # If the _array matching mode_ {#match_all?} is true, an array of the wanted values in unmunged format
   # is returned, else the first value in the array of wanted values in unmunged format is returned.

data/lib/puppet/provider.rb

@@ -64,14 +64,6 @@ class Puppet::Provider
     # @return [???] The source is WHAT?
     attr_writer :source
 
-    # @todo Original = _"LAK 2007-05-09: Keep the model stuff around for backward compatibility"_
-    #   Is this really needed? The comment about backwards compatibility was made in 2007.
-    #
-    # @return [???] A model kept for backwards compatibility.
-    # @api private
-    # @deprecated This attribute is available for backwards compatibility reasons.
-    attr_reader :model
-
     # @todo What is this type? A reference to a Puppet::Type ?
     # @return [Puppet::Type] the resource type (that this provider is ... WHAT?)
     #
@@ -99,11 +91,6 @@ class Puppet::Provider
     attr_writer :doc
   end
 
-  # @todo original = _"LAK 2007-05-09: Keep the model stuff around for backward compatibility"_, why is it
-  #   both here (instance) and at class level? Is this a different model?
-  # @return [???] model is WHAT?
-  attr_reader :model
-
   # @return [???] This resource is what? Is an instance of a provider attached to one particular Puppet::Resource?
   #
   attr_accessor :resource
@@ -391,31 +378,6 @@ class Puppet::Provider
     raise Puppet::DevError, "Provider #{self.name} has not defined the 'instances' class method"
   end
 
-  # Creates the methods for a given command.
-  # @api private
-  # @deprecated Use {commands}, {optional_commands}, or {has_command} instead. This was not meant to be part of a public API
-  def self.make_command_methods(name)
-    Puppet.deprecation_warning "Provider.make_command_methods is deprecated; use Provider.commands or Provider.optional_commands instead for creating command methods"
-
-    # Now define a method for that command
-    unless singleton_class.method_defined?(name)
-      meta_def(name) do |*args|
-        # This might throw an ExecutionFailure, but the system above
-        # will catch it, if so.
-        command = Puppet::Provider::Command.new(name, command(name), Puppet::Util, Puppet::Util::Execution)
-        return command.execute(*args)
-      end
-
-      # And then define an instance method that just calls the class method.
-      # We need both, so both instances and classes can easily run the commands.
-      unless method_defined?(name)
-        define_method(name) do |*args|
-          self.class.send(name, *args)
-        end
-      end
-    end
-  end
-
   # Creates getter- and setter- methods for each property supported by the resource type.
   # Call this method to generate simple accessors for all properties supported by the
   # resource type. These simple accessors lookup and sets values in the property hash.
@@ -493,17 +455,6 @@ class Puppet::Provider
     !!satisfies?(*features)
   end
 
-#    def self.to_s
-#        unless defined?(@str)
-#            if self.resource_type
-#                @str = "#{resource_type.name} provider #{self.name}"
-#            else
-#                @str = "unattached provider #{self.name}"
-#            end
-#        end
-#        @str
-#    end
-
   dochook(:defaults) do
     if @defaults.length > 0
       return @defaults.collect do |d|
@@ -533,7 +484,6 @@ class Puppet::Provider
   # Clears this provider instance to allow GC to clean up.
   def clear
     @resource = nil
-    @model = nil
   end
 
   # (see command)
@@ -565,8 +515,6 @@ class Puppet::Provider
       @property_hash = resource
     elsif resource
       @resource = resource
-      # LAK 2007-05-09: Keep the model stuff around for backward compatibility
-      @model = resource
       @property_hash = {}
     else
       @property_hash = {}