puppet-strings 2.4.0 → 2.5.0

data/lib/puppet-strings/yard/code_objects/data_type.rb

@@ -24,7 +24,6 @@ class PuppetStrings::Yard::CodeObjects::DataType < PuppetStrings::Yard::CodeObje
   # @return [void]
   def initialize(name)
     super(PuppetStrings::Yard::CodeObjects::DataTypes.instance, name)
-    @parameters = []
     @defaults = {}
   end
 
@@ -41,10 +40,6 @@ class PuppetStrings::Yard::CodeObjects::DataType < PuppetStrings::Yard::CodeObje
     nil
   end
 
-  def parameter_exist?(name)
-    !docstring.tags(:param).find { |item| item.name == name }.nil?
-  end
-
   def add_parameter(name, type, default)
     tag = docstring.tags(:param).find { |item| item.name == name }
     if tag.nil?
@@ -65,6 +60,24 @@ class PuppetStrings::Yard::CodeObjects::DataType < PuppetStrings::Yard::CodeObje
     docstring.tags(:param).map { |tag| [tag.name, defaults[tag.name]] }
   end
 
+  def add_function(name, return_type, parameter_types)
+    meth_obj = YARD::CodeObjects::MethodObject.new(self, name, :class)
+
+    # Add return tag
+    meth_obj.add_tag(YARD::Tags::Tag.new(:return, '', return_type))
+
+    # Add parameters
+    parameter_types.each_with_index do |param_type, index|
+      meth_obj.add_tag(YARD::Tags::Tag.new(:param, '', [param_type], "param#{index + 1}"))
+    end
+
+    self.meths << meth_obj
+  end
+
+  def functions
+    meths
+  end
+
   # Converts the code object to a hash representation.
   # @return [Hash] Returns a hash representation of the code object.
   def to_hash
@@ -72,9 +85,16 @@ class PuppetStrings::Yard::CodeObjects::DataType < PuppetStrings::Yard::CodeObje
     hash[:name] = name
     hash[:file] = file
     hash[:line] = line
-    hash[:docstring] = PuppetStrings::Yard::Util.docstring_to_hash(docstring)
+    hash[:docstring] = PuppetStrings::Yard::Util.docstring_to_hash(docstring, %i[param option enum return example])
     hash[:defaults] = defaults unless defaults.empty?
     hash[:source] = source unless source && source.empty?
+    hash[:functions] = functions.map do |func|
+      {
+        name: func.name,
+        signature: func.signature,
+        docstring: PuppetStrings::Yard::Util.docstring_to_hash(func.docstring, %i[param option enum return example])
+      }
+    end
     hash
   end
 end

data/lib/puppet-strings/yard/code_objects/type.rb

@@ -73,6 +73,9 @@ class PuppetStrings::Yard::CodeObjects::Type < PuppetStrings::Yard::CodeObjects:
   class Property < Parameter
   end
 
+  class Check < Parameter
+  end
+
   # Represents a resource type feature.
   class Feature
     attr_reader :name, :docstring
@@ -95,7 +98,7 @@ class PuppetStrings::Yard::CodeObjects::Type < PuppetStrings::Yard::CodeObjects:
     end
   end
 
-  attr_reader :properties, :parameters, :features
+  attr_reader :properties, :features, :checks
 
   # Initializes a new resource type.
   # @param [String] name The resource type name.
@@ -134,17 +137,55 @@ class PuppetStrings::Yard::CodeObjects::Type < PuppetStrings::Yard::CodeObjects:
     @features << feature
   end
 
+  # Adds a check to the resource type.
+  # @param [PuppetStrings::Yard::CodeObjects::Type::Check] check The check to add.
+  # @return [void]
+  def add_check(check)
+    @checks ||= []
+    @checks << check
+  end
+
+  def parameters
+    # just return params if there are no providers
+    return @parameters if providers.empty?
+
+    # return existing params if we have already added provider
+    return @parameters if @parameters.any? { |p| p.name == 'provider' }
+
+    provider_param = Parameter.new(
+      'provider',
+      "The specific backend to use for this `#{self.name.to_s}` resource. You will seldom need " + \
+      "to specify this --- Puppet will usually discover the appropriate provider for your platform."
+    )
+
+    @parameters << provider_param
+  end
+
+  # Not sure if this is where this belongs or if providers should only be resolved at
+  # render-time. For now, this should re-resolve on every call.
+  # may be able to memoize this
+  def providers
+    providers = YARD::Registry.all("puppet_providers_#{name}".intern)
+    return providers if providers.empty?
+    providers.first.children
+  end
+
   # Converts the code object to a hash representation.
   # @return [Hash] Returns a hash representation of the code object.
   def to_hash
     hash = {}
+
     hash[:name] = name
     hash[:file] = file
     hash[:line] = line
-    hash[:docstring] = PuppetStrings::Yard::Util.docstring_to_hash(docstring)
-    hash[:properties] = properties.map(&:to_hash) if properties && !properties.empty?
-    hash[:parameters] = parameters.map(&:to_hash) if parameters && !parameters.empty?
-    hash[:features] = features.map(&:to_hash) if features && !features.empty?
+
+    hash[:docstring]  = PuppetStrings::Yard::Util.docstring_to_hash(docstring)
+    hash[:properties] = properties.sort_by { |p| p.name }.map(&:to_hash) if properties && !properties.empty?
+    hash[:parameters] = parameters.sort_by { |p| p.name }.map(&:to_hash) if parameters && !parameters.empty?
+    hash[:checks]     = checks.sort_by { |c| c.name }.map(&:to_hash) if checks && !checks.empty?
+    hash[:features]   = features.sort_by { |f| f.name }.map(&:to_hash) if features && !features.empty?
+    hash[:providers]  = providers.sort_by { |p| p.name }.map(&:to_hash) if providers && !providers.empty?
+
     hash
   end
 end

data/lib/puppet-strings/yard/handlers/ruby/data_type_handler.rb

@@ -13,13 +13,16 @@ class PuppetStrings::Yard::Handlers::Ruby::DataTypeHandler < PuppetStrings::Yard
     ruby_module_name = statement[0].source
     return unless ruby_module_name == 'Puppet::DataTypes' || ruby_module_name == 'DataTypes' # rubocop:disable Style/MultipleComparison This reads better
     object = get_datatype_yard_object(get_name(statement, 'Puppet::DataTypes.create_type'))
-
-    actual_params = extract_params_for_data_type
+    # Extract the interface definition
+    type_interface = extract_data_type_interface
+    actual_params = extract_params(type_interface)
+    actual_funcs = extract_functions(object, type_interface)
 
     # Mark the data type as public if it doesn't already have an api tag
     object.add_tag YARD::Tags::Tag.new(:api, 'public') unless object.has_tag? :api
 
-    validate_tags!(object, actual_params)
+    validate_param_tags!(object, actual_params)
+    validate_methods!(object, actual_funcs)
 
     # Set the default values for all parameters
     actual_params.each { |name, data| object.set_parameter_default(name, data[:default]) }
@@ -49,44 +52,60 @@ class PuppetStrings::Yard::Handlers::Ruby::DataTypeHandler < PuppetStrings::Yard
     object
   end
 
-  def extract_params_for_data_type
-    params = {}
-    # Traverse the block looking for interface
+  # @return [Hash{Object => Object}] The Puppet DataType interface definition as a ruby Hash
+  def extract_data_type_interface
     block = statement.block
-    return unless block && block.count >= 2
-    block[1].children.each do |node|
-      next unless node.is_a?(YARD::Parser::Ruby::MethodCallNode) &&
-                  node.method_name
+    return {} unless block
+
+    # Declare the parsed interface outside of the closure
+    parsed_interface = nil
 
-      method_name = node.method_name.source
+    # Recursively traverse the block looking for the first valid 'interface' call
+    interface_node = find_ruby_ast_node(block, true) do |node|
+      next false unless node.is_a?(YARD::Parser::Ruby::MethodCallNode) &&
+                        node.method_name &&
+                        node.method_name.source == 'interface'
       parameters = node.parameters(false)
-      if method_name == 'interface'
-        next unless parameters.count >= 1
-        interface_string = node_as_string(parameters[0])
-        next unless interface_string
+      next false unless parameters.count >= 1
+      interface_string = node_as_string(parameters[0])
+      next false unless interface_string
+
+      begin
         # Ref - https://github.com/puppetlabs/puppet/blob/ba4d1a1aba0095d3c70b98fea5c67434a4876a61/lib/puppet/datatypes.rb#L159
-        parsed_interface = nil
-        begin
-          parsed_interface = Puppet::Pops::Parser::EvaluatingParser.new.parse_string("{ #{interface_string} }").body
-        rescue Puppet::Error => e
-          log.warn "Invalid datatype definition at #{statement.file}:#{statement.line}: #{e.basic_message}"
-          next
-        end
-        next unless parsed_interface
-
-        # Now that we parsed the Puppet code (as a string) into a LiteralHash PCore type (Puppet AST),
-        #
-        # We need to convert the LiteralHash into a conventional ruby hash of strings. The
-        # LazyLiteralEvaluator does this by traversing the AST tree can converting objects to strings
-        # where possible and ignoring object types which cannot (thus the 'Lazy' name)
-        #
-        # Once we have it as a standard ruby hash we can then look at the keys and populate the YARD
-        # Code object with the correct attributes etc.
-        literal_eval = LazyLiteralEvaluator.new
-        populate_data_type_params_from_literal_hash!(literal_eval.literal(parsed_interface), params)
+        parsed_interface = Puppet::Pops::Parser::EvaluatingParser.new.parse_string("{ #{interface_string} }").body
+      rescue Puppet::Error => e
+        log.warn "Invalid datatype definition at #{statement.file}:#{statement.line}: #{e.basic_message}"
+        next false
+      end
+      !parsed_interface.nil?
+    end
+
+    # Now that we parsed the Puppet code (as a string) into a LiteralHash PCore type (Puppet AST),
+    # We need to convert the LiteralHash into a conventional ruby hash of strings. The
+    # LazyLiteralEvaluator does this by traversing the AST tree can converting objects to strings
+    # where possible and ignoring object types which cannot (thus the 'Lazy' name)
+    literal_eval = LazyLiteralEvaluator.new
+    literal_eval.literal(parsed_interface)
+  end
+
+  # Find the first Ruby AST node within an AST Tree, optionally recursively. Returns nil of none could be found
+  #
+  # @param [YARD::Parser::Ruby::AstNode] ast_node The root AST node object to inspect
+  # @param [Boolean] recurse Whether to search the tree recursively.  Defaults to false
+  # @yieldparam [YARD::Parser::Ruby::AstNode] ast_node The AST Node that should be checked
+  # @yieldreturn [Boolean] Whether the node was what was searched for
+  # @return [YARD::Parser::Ruby::AstNode, nil]
+  def find_ruby_ast_node(ast_node, recurse = false, &block)
+    raise ArgumentError, 'find_ruby_ast_node requires a block' unless block_given?
+    is_found = yield ast_node
+    return ast_node if is_found
+    if ast_node.respond_to?(:children)
+      ast_node.children.each do |child_node|
+        child_found = find_ruby_ast_node(child_node, recurse, &block)
+        return child_found unless child_found.nil?
       end
     end
-    params
+    nil
   end
 
   # Lazily evaluates a Pops object, ignoring any objects that cannot
@@ -179,7 +198,7 @@ class PuppetStrings::Yard::Handlers::Ruby::DataTypeHandler < PuppetStrings::Yard
     end
 
     def literal_LiteralList(o) # rubocop:disable Naming/UncommunicativeMethodParamName
-      o.values.map {|v| literal(v) }
+      o.values.map { |v| literal(v) }
     end
 
     def literal_LiteralHash(o) # rubocop:disable Naming/UncommunicativeMethodParamName
@@ -190,27 +209,58 @@ class PuppetStrings::Yard::Handlers::Ruby::DataTypeHandler < PuppetStrings::Yard
     end
   end
 
-  def populate_data_type_params_from_literal_hash!(hash, params_hash)
-    return if hash.nil?
+  # Extracts the datatype attributes from a Puppet Data Type interface hash.
+  # Returns a Hash with a :types key (Array of data types for the parameter) and :default key (The default value of the parameter)
+  # @return Hash[Symbol => Hash] The Datatype Attributes as a hash
+  def extract_params(hash)
+    params_hash = {}
     # Exit early if there are no entries in the hash
-    return if hash['attributes'].nil? || hash['attributes'].count.zero?
+    return params_hash if hash.nil? || hash['attributes'].nil? || hash['attributes'].empty?
 
     hash['attributes'].each do |key, value|
       data_type = nil
       default = nil
-      case value
-      when String
+      if value.is_a?(String)
         data_type = value
-      when Hash
+      elsif value.is_a?(Hash)
         data_type = value['type'] unless value['type'].nil?
         default   = value['value'] unless value['value'].nil?
       end
       data_type = [data_type] unless data_type.nil? || data_type.is_a?(Array)
       params_hash[key] = { :types => data_type, :default => default }
     end
+
+    params_hash
   end
 
-  def validate_tags!(object, actual_params_hash)
+  # Extracts the datatype functions from a Puppet Data Type interface hash.
+  # Returns a Hash with a :param_types key (Array of types for each parameter) and :return_type key (The return type of the function)
+  # @return Hash[Symbol => Hash] The Datatype Attributes as a hash
+  def extract_functions(object, hash)
+    funcs_hash = {}
+    # Exit early if there are no entries in the hash
+    return funcs_hash if hash.nil? || hash['functions'].nil? || hash['functions'].empty?
+
+    hash['functions'].each do |key, func_type|
+      func_hash = { :param_types => [], :return_type => nil }
+      begin
+        callable_type = Puppet::Pops::Types::TypeParser.singleton.parse(func_type)
+        if callable_type.is_a?(Puppet::Pops::Types::PCallableType)
+          func_hash[:param_types] = callable_type.param_types.map { |pt| pt.to_s }
+          func_hash[:return_type] = callable_type.return_type.to_s
+        else
+          log.warn "The function definition for '#{key}' near #{object.file}:#{object.line} is not a Callable type"
+        end
+      rescue Puppet::ParseError => e
+        log.warn "Unable to parse the function definition for '#{key}' near #{object.file}:#{object.line}. #{e}"
+      end
+      funcs_hash[key] = func_hash
+    end
+    funcs_hash
+  end
+
+  # Validates and automatically fixes yard @param tags for the data type
+  def validate_param_tags!(object, actual_params_hash)
     actual_param_names = actual_params_hash.keys
     tagged_param_names = object.tags(:param).map(&:name)
     # Log any errors
@@ -243,4 +293,101 @@ class PuppetStrings::Yard::Handlers::Ruby::DataTypeHandler < PuppetStrings::Yard
       tag.types = actual_params_hash[tag.name][:types]
     end
   end
+
+  # Validates and automatically fixes yard @method! tags for the data type
+  def validate_methods!(object, actual_functions_hash)
+    actual_func_names = actual_functions_hash.keys
+    tagged_func_names = object.meths.map { |meth| meth.name.to_s }
+
+    # Log any errors
+    # Find functions which are not documented
+    (actual_func_names - tagged_func_names).each do |item|
+      log.warn "Missing @!method tag for function '#{item}' near #{object.file}:#{object.line}."
+    end
+    # Find functions which are not defined
+    (tagged_func_names - actual_func_names).each do |item|
+      log.warn "The @!method tag for '#{item}' has no matching function definition near #{object.file}:#{object.line}."
+    end
+    # Functions with the wrong return type
+    object.meths.each do |meth|
+      next unless actual_func_names.include?(meth.name.to_s)
+      return_tag = meth.docstring.tag(:return)
+      next if return_tag.nil?
+      actual_return_types = [actual_functions_hash[meth.name.to_s][:return_type]]
+      next if return_tag.types == actual_return_types
+      log.warn "The @return tag for '#{meth.name}' has a different type definition than the actual function near #{object.file}:#{object.line}. Expected #{actual_return_types}"
+      return_tag.types = actual_return_types
+    end
+
+    # Automatically fix missing methods
+    (actual_func_names - tagged_func_names).each do |name|
+      object.add_function(name, actual_functions_hash[name][:return_type], actual_functions_hash[name][:param_types])
+    end
+    # Remove extra methods. Can't use `meths` as that's a derived property
+    object.children.reject! { |child| child.is_a?(YARD::CodeObjects::MethodObject) && !actual_func_names.include?(child.name.to_s) }
+
+    # Add the return type for the methods if missing
+    object.meths.each do |meth|
+      next unless meth.docstring.tag(:return).nil?
+      meth.docstring.add_tag(YARD::Tags::Tag.new(:return, '', actual_functions_hash[meth.name.to_s][:return_type]))
+    end
+
+    # Sync the method properties and add the return type for the methods if missing
+    object.meths.each do |meth|
+      validate_function_method!(object, meth, actual_functions_hash[meth.name.to_s])
+      next unless meth.docstring.tag(:return).nil?
+      meth.docstring.add_tag(YARD::Tags::Tag.new(:return, '', actual_functions_hash[meth.name.to_s][:return_type]))
+    end
+
+    # The default meth.signature assumes ruby invocation (e.g. def meth(...)) but this doesn't make sense for a
+    # Puppet Data Type function invocation. So instead we derive a signature from the method definition.
+    object.meths.each do |meth|
+      params = ''
+      unless meth.docstring.tags(:param).empty?
+        params += '(' + meth.docstring.tags(:param).map { |t| t.name }.join(', ') + ')'
+      end
+      meth.signature = "#{object.name}.#{meth.name}" + params
+    end
+
+    nil
+  end
+
+  # Validates and automatically fixes a single yard @method!
+  # Used by the validate_methods! method.
+  def validate_function_method!(object, meth, actual_function)
+    # Remove extra params
+    if meth.docstring.tags(:param).count > actual_function[:param_types].count
+      index = 0
+      meth.docstring.delete_tag_if do |tag|
+        if tag.tag_name == 'param'
+          index += 1
+          if index > actual_function[:param_types].count
+            log.warn "The @param tag for '#{tag.name}' should not exist for function '#{meth.name}' that is defined near #{object.file}:#{object.line}. Expected only #{actual_function[:param_types].count} parameter/s"
+            true
+          else
+            false
+          end
+        else
+          false
+        end
+      end
+    end
+
+    # Add missing params
+    if meth.docstring.tags(:param).count < actual_function[:param_types].count
+      start = meth.docstring.tags(:param).count + 1
+      (start..actual_function[:param_types].count).each do |index| # Using 1-based index here instead of usual zero
+        meth.add_tag(YARD::Tags::Tag.new(:param, '', actual_function[:param_types][index - 1], "param#{index}"))
+      end
+    end
+
+    # Ensure the parameter types are correct
+    meth.docstring.tags(:param).each_with_index do |tag, index|
+      actual_types = [actual_function[:param_types][index]]
+      if tag.types != actual_types
+        log.warn "The @param tag for '#{tag.name}' for function '#{meth.name}' has a different type definition than the actual function near #{object.file}:#{object.line}. Expected #{actual_types}"
+        tag.types = actual_types
+      end
+    end
+  end
 end

data/lib/puppet-strings/yard/handlers/ruby/type_base.rb

@@ -52,6 +52,12 @@ class PuppetStrings::Yard::Handlers::Ruby::TypeBase < PuppetStrings::Yard::Handl
     property
   end
 
+  def create_check(name, node)
+    check = PuppetStrings::Yard::CodeObjects::Type::Check.new(name, find_docstring(node, "Puppet resource check '#{name}'"))
+    set_values(node, check)
+    check
+  end
+
   def set_values(node, object)
     return unless node.block && node.block.count >= 2
 

data/lib/puppet-strings/yard/handlers/ruby/type_extras_handler.rb

@@ -32,7 +32,7 @@ class PuppetStrings::Yard::Handlers::Ruby::TypeExtrasHandler < PuppetStrings::Ya
 
     return unless (statement.count > 1) && (statement[0].children.count > 2)
     module_name = statement[0].children[0].source
-    method1_name = statement[0].children[1].source
+    method1_name = statement[0].children.drop(1).find{ |c| c.type == :ident }.source
     return unless (module_name == 'Puppet::Type' || module_name == 'Type') && method1_name == 'type'
 
     typename = get_name(statement[0], 'Puppet::Type.type')

data/lib/puppet-strings/yard/handlers/ruby/type_handler.rb

@@ -59,6 +59,12 @@ class PuppetStrings::Yard::Handlers::Ruby::TypeHandler < PuppetStrings::Yard::Ha
         name = node_as_string(parameters[0])
         next unless name
         object.add_parameter(create_parameter(name, node))
+      elsif method_name == 'newcheck'
+        # Add a check to the object
+        next unless parameters.count >= 1
+        name = node_as_string(parameters[0])
+        next unless name
+        object.add_check(create_check(name, node))
       elsif method_name == 'feature'
         # Add a feature to the object
         next unless parameters.count >= 2