puppet-strings 3.0.1 → 4.0.0.rc.1

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

@@ -8,17 +8,17 @@ require 'puppet-strings/yard/util'
 # Implements the handler for Puppet functions written in Ruby.
 class PuppetStrings::Yard::Handlers::Ruby::FunctionHandler < PuppetStrings::Yard::Handlers::Ruby::Base
   # Represents the list of Puppet 4.x function API methods to support.
-  DISPATCH_METHOD_NAMES = [
-    'param',
-    'required_param',
-    'optional_param',
-    'repeated_param',
-    'optional_repeated_param',
-    'required_repeated_param',
-    'block_param',
-    'required_block_param',
-    'optional_block_param',
-    'return_type',
+  DISPATCH_METHOD_NAMES = %w[
+    param
+    required_param
+    optional_param
+    repeated_param
+    optional_repeated_param
+    required_repeated_param
+    block_param
+    required_block_param
+    optional_block_param
+    return_type
   ].freeze
 
   namespace_only
@@ -39,7 +39,7 @@ class PuppetStrings::Yard::Handlers::Ruby::FunctionHandler < PuppetStrings::Yard
     is_3x = ['Puppet::Parser::Functions', 'newfunction'].include?(module_name)
     object = PuppetStrings::Yard::CodeObjects::Function.new(
       get_name(statement, 'Puppet::Functions.create_function'),
-      is_3x ? PuppetStrings::Yard::CodeObjects::Function::RUBY_3X : PuppetStrings::Yard::CodeObjects::Function::RUBY_4X,
+      is_3x ? PuppetStrings::Yard::CodeObjects::Function::RUBY_3X : PuppetStrings::Yard::CodeObjects::Function::RUBY_4X
     )
     object.source = statement
     register object
@@ -76,21 +76,21 @@ class PuppetStrings::Yard::Handlers::Ruby::FunctionHandler < PuppetStrings::Yard
     log.warn "Missing documentation for Puppet function '#{object.name}' at #{statement.file}:#{statement.line}." if object.docstring.empty? && object.tags.empty?
 
     unless object.tags(:param).empty?
-      log.warn "The docstring for Puppet 4.x function '#{object.name}' "\
-        "contains @param tags near #{object.file}:#{object.line}: parameter "\
-        'documentation should be made on the dispatch call.'
+      log.warn "The docstring for Puppet 4.x function '#{object.name}' " \
+               "contains @param tags near #{object.file}:#{object.line}: parameter " \
+               'documentation should be made on the dispatch call.'
     end
 
     unless object.tags(:return).empty?
-      log.warn "The docstring for Puppet 4.x function '#{object.name}' "\
-      "contains @return tags near #{object.file}:#{object.line}: return "\
-      'value documentation should be made on the dispatch call.'
+      log.warn "The docstring for Puppet 4.x function '#{object.name}' " \
+               "contains @return tags near #{object.file}:#{object.line}: return " \
+               'value documentation should be made on the dispatch call.'
     end
 
     unless object.tags(:overload).empty?
-      log.warn "The docstring for Puppet 4.x function '#{object.name}' "\
-      "contains @overload tags near #{object.file}:#{object.line}: overload "\
-      'tags are automatically generated from the dispatch calls.'
+      log.warn "The docstring for Puppet 4.x function '#{object.name}' " \
+               "contains @overload tags near #{object.file}:#{object.line}: overload " \
+               'tags are automatically generated from the dispatch calls.'
     end
 
     # Delete any existing param/return/overload tags
@@ -123,6 +123,7 @@ class PuppetStrings::Yard::Handlers::Ruby::FunctionHandler < PuppetStrings::Yard
 
     # If there's only one overload, move the tags to the object itself
     return unless overloads.length == 1
+
     overload = overloads.first
     object.parameters = overload.parameters
     object.add_tag(*overload.tags)
@@ -184,7 +185,7 @@ class PuppetStrings::Yard::Handlers::Ruby::FunctionHandler < PuppetStrings::Yard
         node_as_string(parameters[0]),
         nil, # TODO: determine default from corresponding Ruby method signature?
         method_name.include?('optional'),
-        method_name.include?('repeated'),
+        method_name.include?('repeated')
       )
     end
 
@@ -215,7 +216,7 @@ class PuppetStrings::Yard::Handlers::Ruby::FunctionHandler < PuppetStrings::Yard
           nil, # TODO: determine default from corresponding Ruby method signature?
           block.method_name.source.include?('optional'),
           false, # Not repeated
-          true, # Is block
+          true # Is block
         )
       end
     end
@@ -243,7 +244,7 @@ class PuppetStrings::Yard::Handlers::Ruby::FunctionHandler < PuppetStrings::Yard
         param_tags,
         parameter.source,
         parameter.file,
-        parameter.line,
+        parameter.line
       )
     end
 
@@ -258,7 +259,7 @@ class PuppetStrings::Yard::Handlers::Ruby::FunctionHandler < PuppetStrings::Yard
         parameter.line,
         nil,
         parameter[1].source,
-        true,
+        true
       )
     end
 
@@ -274,7 +275,7 @@ class PuppetStrings::Yard::Handlers::Ruby::FunctionHandler < PuppetStrings::Yard
         nil,
         nil,
         false,
-        true,
+        true
       )
     end
 
@@ -291,7 +292,7 @@ class PuppetStrings::Yard::Handlers::Ruby::FunctionHandler < PuppetStrings::Yard
         nil,
         false,
         false,
-        true,
+        true
       )
     end
 
@@ -309,15 +310,15 @@ class PuppetStrings::Yard::Handlers::Ruby::FunctionHandler < PuppetStrings::Yard
     log.warn "Missing @param tag for parameter '#{name}' near #{file}:#{line}." unless tag || object.docstring.all.empty?
 
     if type && tag && tag.types && !tag.types.empty?
-      log.warn "The @param tag for parameter '#{name}' should not contain a "\
-        "type specification near #{file}:#{line}: ignoring in favor of "\
-        'dispatch type information.'
+      log.warn "The @param tag for parameter '#{name}' should not contain a " \
+               "type specification near #{file}:#{line}: ignoring in favor of " \
+               'dispatch type information.'
     end
 
     if repeated
-      name = '*' + name
+      name = "*#{name}"
     elsif block
-      name = '&' + name
+      name = "&#{name}"
     end
 
     type ||= tag&.types ? tag.type : 'Any'

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

@@ -94,7 +94,7 @@ class PuppetStrings::Yard::Handlers::Ruby::ProviderHandler < PuppetStrings::Yard
 
           object.add_confine(node_as_string(kvp[0]) || kvp[0].source, node_as_string(kvp[1]) || kvp[1].source)
         end
-      elsif ['has_feature', 'has_features'].include?(method_name)
+      elsif %w[has_feature has_features].include?(method_name)
         # Add the features to the object
         parameters.each do |parameter|
           object.add_feature(node_as_string(parameter) || parameter.source)

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

@@ -53,9 +53,9 @@ class PuppetStrings::Yard::Handlers::Ruby::RsapiHandler < PuppetStrings::Yard::H
   # check that the params of the register_type call are key/value pairs.
   def kv_arg_list?(params)
     params.type == :list &&
-      params.children.count > 0 &&
+      params.children.count.positive? &&
       params.children.first.type == :list &&
-      params.children.first.children.count > 0 &&
+      params.children.first.children.count.positive? &&
       statement.parameters.children.first.children.first.type == :assoc
   end
 
@@ -101,7 +101,7 @@ class PuppetStrings::Yard::Handlers::Ruby::RsapiHandler < PuppetStrings::Yard::H
     kv_pairs = node.children.map do |assoc|
       [value_from_node(assoc.children[0]), value_from_node(assoc.children[1])]
     end
-    Hash[kv_pairs]
+    kv_pairs.to_h
   end
 
   def var_ref_from_node(node)
@@ -129,7 +129,7 @@ class PuppetStrings::Yard::Handlers::Ruby::RsapiHandler < PuppetStrings::Yard::H
 
     schema['attributes'].each do |name, definition|
       # puts "Processing #{name}: #{definition.inspect}"
-      if ['parameter', 'namevar'].include? definition['behaviour']
+      if %w[parameter namevar].include? definition['behaviour']
         object.add_parameter(create_parameter(name, definition))
       else
         object.add_property(create_property(name, definition))

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

@@ -110,15 +110,18 @@ class PuppetStrings::Yard::Handlers::Ruby::TypeBase < PuppetStrings::Yard::Handl
     return unless object.is_a? PuppetStrings::Yard::CodeObjects::Type::Parameter
     # Process the options for parameter base types
     return unless parameters.count >= 2
+
     parameters[1].each do |kvp|
       next unless kvp.count == 2
       next unless node_as_string(kvp[0]) == 'parent'
 
       if kvp[1].source == 'Puppet::Parameter::Boolean'
+        # rubocop:disable Performance/InefficientHashSearch
         object.add('true') unless object.values.include? 'true'
         object.add('false') unless object.values.include? 'false'
         object.add('yes') unless object.values.include? 'yes'
         object.add('no') unless object.values.include? 'no'
+        # rubocop:enable Performance/InefficientHashSearch
       end
       break
     end

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

@@ -52,7 +52,8 @@ class PuppetStrings::Yard::Handlers::Ruby::TypeHandler < PuppetStrings::Yard::Ha
       method_name = node.method_name.source
       parameters = node.parameters(false)
 
-      if method_name == 'newproperty'
+      case method_name
+      when 'newproperty'
         # Add a property to the object
         next unless parameters.count >= 1
 
@@ -60,7 +61,7 @@ class PuppetStrings::Yard::Handlers::Ruby::TypeHandler < PuppetStrings::Yard::Ha
         next unless name
 
         object.add_property(create_property(name, node))
-      elsif method_name == 'newparam'
+      when 'newparam'
         # Add a parameter to the object
         next unless parameters.count >= 1
 
@@ -68,7 +69,7 @@ class PuppetStrings::Yard::Handlers::Ruby::TypeHandler < PuppetStrings::Yard::Ha
         next unless name
 
         object.add_parameter(create_parameter(name, node))
-      elsif method_name == 'newcheck'
+      when 'newcheck'
         # Add a check to the object
         next unless parameters.count >= 1
 
@@ -76,7 +77,7 @@ class PuppetStrings::Yard::Handlers::Ruby::TypeHandler < PuppetStrings::Yard::Ha
         next unless name
 
         object.add_check(create_check(name, node))
-      elsif method_name == 'feature'
+      when 'feature'
         # Add a feature to the object
         next unless parameters.count >= 2
 
@@ -87,7 +88,7 @@ class PuppetStrings::Yard::Handlers::Ruby::TypeHandler < PuppetStrings::Yard::Ha
         next unless docstring
 
         object.add_feature(PuppetStrings::Yard::CodeObjects::Type::Feature.new(name, docstring))
-      elsif method_name == 'ensurable'
+      when 'ensurable'
         if node.block
           property = create_property('ensure', node)
           property.docstring = DEFAULT_ENSURABLE_DOCSTRING if property.docstring.empty?

data/lib/puppet-strings/yard/parsers/json/parser.rb

@@ -28,7 +28,7 @@ class PuppetStrings::Yard::Parsers::JSON::Parser < YARD::Parser::Base
       # TODO: this should compare json to a Task metadata json-schema or perform some other hueristics
       # to determine what type of statement it represents
       @statements.push(PuppetStrings::Yard::Parsers::JSON::TaskStatement.new(json, @source, @file)) unless json.empty?
-    rescue
+    rescue StandardError
       log.error "Failed to parse #{@file}: "
       @statements = []
     end

data/lib/puppet-strings/yard/parsers/puppet/parser.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable Naming/MethodName
-
 require 'puppet'
 require 'puppet/pops'
 require 'puppet-strings/yard/parsers/puppet/statement'
@@ -24,10 +22,6 @@ class PuppetStrings::Yard::Parsers::Puppet::Parser < YARD::Parser::Base
   # @return [void]
   def parse
     begin
-      if @file.to_s.match?(%r{^plans|/plans/}) && Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') < 0
-        log.warn "Skipping #{@file}: Puppet Plans require Puppet 5 or greater."
-        return
-      end
       Puppet[:tasks] = true if Puppet.settings.include?(:tasks)
       @statements ||= (@visitor.visit(::Puppet::Pops::Parser::Parser.new.parse_string(source)) || []).compact
     rescue ::Puppet::ParseError => e

data/lib/puppet-strings/yard/parsers/puppet/statement.rb

@@ -7,13 +7,9 @@ module PuppetStrings::Yard::Parsers::Puppet
   # Represents the base Puppet language statement.
   class Statement
     # The pattern for parsing docstring comments.
-    COMMENT_REGEX = %r{^\s*#+\s?}.freeze
+    COMMENT_REGEX = /^\s*#+\s?/.freeze
 
-    attr_reader :source
-    attr_reader :file
-    attr_reader :line
-    attr_reader :docstring
-    attr_reader :comments_range
+    attr_reader :source, :file, :line, :docstring, :comments_range
 
     # Initializes the Puppet language statement.
     # @param object The Puppet parser model object for the statement.
@@ -67,7 +63,7 @@ module PuppetStrings::Yard::Parsers::Puppet
     private
 
     def first_line
-      @source.split(%r{\r?\n}).first.strip
+      @source.split(/\r?\n/).first.strip
     end
   end
 
@@ -75,20 +71,17 @@ module PuppetStrings::Yard::Parsers::Puppet
   class ParameterizedStatement < Statement
     # Implements a parameter for a parameterized statement.
     class Parameter
-      attr_reader :name
-      attr_reader :type
-      attr_reader :value
+      attr_reader :name, :type, :value
 
       # Initializes the parameter.
       # @param [Puppet::Pops::Model::Parameter] parameter The parameter model object.
       def initialize(parameter)
         @name = parameter.name
         # Take the exact text for the type expression
-        if parameter.type_expr
-          @type = PuppetStrings::Yard::Util.ast_to_text(parameter.type_expr)
-        end
+        @type = PuppetStrings::Yard::Util.ast_to_text(parameter.type_expr) if parameter.type_expr
         # Take the exact text for the default value expression
         return unless parameter.value
+
         @value = PuppetStrings::Yard::Util.ast_to_text(parameter.value)
       end
     end
@@ -106,8 +99,7 @@ module PuppetStrings::Yard::Parsers::Puppet
 
   # Implements the Puppet class statement.
   class ClassStatement < ParameterizedStatement
-    attr_reader :name
-    attr_reader :parent_class
+    attr_reader :name, :parent_class
 
     # Initializes the Puppet class statement.
     # @param [Puppet::Pops::Model::HostClassDefinition] object The model object for the class statement.
@@ -134,8 +126,7 @@ module PuppetStrings::Yard::Parsers::Puppet
 
   # Implements the Puppet function statement.
   class FunctionStatement < ParameterizedStatement
-    attr_reader :name
-    attr_reader :type
+    attr_reader :name, :type
 
     # Initializes the Puppet function statement.
     # @param [Puppet::Pops::Model::FunctionDefinition] object The model object for the function statement.
@@ -144,8 +135,10 @@ module PuppetStrings::Yard::Parsers::Puppet
       super(object, file)
       @name = object.name
       return unless object.respond_to? :return_type
+
       type = object.return_type
       return unless type
+
       @type = PuppetStrings::Yard::Util.ast_to_text(type).gsub('>> ', '')
     end
   end
@@ -165,8 +158,7 @@ module PuppetStrings::Yard::Parsers::Puppet
 
   # Implements the Puppet data type alias statement.
   class DataTypeAliasStatement < Statement
-    attr_reader :name
-    attr_reader :alias_of
+    attr_reader :name, :alias_of
 
     # Initializes the Puppet data type alias statement.
     # @param [Puppet::Pops::Model::TypeAlias] object The model object for the type statement.
@@ -178,7 +170,7 @@ module PuppetStrings::Yard::Parsers::Puppet
       case type_expr
       when Puppet::Pops::Model::AccessExpression
         # TODO: I don't like rebuilding the source from the AST, but AccessExpressions don't expose the original source
-        @alias_of = PuppetStrings::Yard::Util.ast_to_text(type_expr.left_expr) + '['
+        @alias_of = +"#{PuppetStrings::Yard::Util.ast_to_text(type_expr.left_expr)}[" # alias_of should be mutable so we add a + to the string.
         @alias_of << type_expr.keys.map { |key| PuppetStrings::Yard::Util.ast_to_text(key) }.join(', ')
         @alias_of << ']'
       else

data/lib/puppet-strings/yard/tags/overload_tag.rb

@@ -21,16 +21,16 @@ class PuppetStrings::Yard::Tags::OverloadTag < YARD::Tags::Tag
   # @return [String] Returns the signature of the overload.
   def signature
     tags = self.tags(:param)
-    args = @parameters.map { |parameter|
+    args = @parameters.map do |parameter|
       name, default = parameter
       tag = tags.find { |t| t.name == name } if tags
       type = tag&.types ? "#{tag.type} " : 'Any '
       prefix = (name[0]).to_s if name.start_with?('*', '&')
-      name = name[1..-1] if prefix
+      name = name[1..] if prefix
       default = " = #{default}" if default
       "#{type}#{prefix}$#{name}#{default}"
-    }.join(', ')
-    @name + '(' + args + ')'
+    end.join(', ')
+    "#{@name}(#{args})"
   end
 
   # Adds a tag to the overload's docstring.

data/lib/puppet-strings/yard/tags/parameter_directive.rb

@@ -7,7 +7,7 @@ class PuppetStrings::Yard::Tags::ParameterDirective < YARD::Tags::Directive
   # Called to invoke the directive.
   # @return [void]
   def call
-    return unless object&.respond_to?(:add_parameter)
+    return unless object.respond_to?(:add_parameter)
 
     # Add a parameter to the resource
     parameter = PuppetStrings::Yard::CodeObjects::Type::Parameter.new(tag.name, tag.text)

data/lib/puppet-strings/yard/tags/property_directive.rb

@@ -7,7 +7,7 @@ class PuppetStrings::Yard::Tags::PropertyDirective < YARD::Tags::Directive
   # Called to invoke the directive.
   # @return [void]
   def call
-    return unless object&.respond_to?(:add_property)
+    return unless object.respond_to?(:add_property)
 
     # Add a property to the resource
     property = PuppetStrings::Yard::CodeObjects::Type::Property.new(tag.name, tag.text)

data/lib/puppet-strings/yard/templates/default/fulldoc/html/setup.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Generates the searchable Puppet class list.
 # @return [void]
 def generate_puppet_class_list
@@ -10,7 +12,7 @@ end
 # Generates the searchable Puppet data type list.
 # @return [void]
 def generate_puppet_data_type_list
-  @items = Registry.all(:puppet_data_type, :puppet_data_type_alias).sort_by {|dt| dt.name.to_s }
+  @items = Registry.all(:puppet_data_type, :puppet_data_type_alias).sort_by { |dt| dt.name.to_s }
   @list_title = 'Data Type List'
   @list_type = 'puppet_data_type'
   generate_list_contents
@@ -19,7 +21,7 @@ end
 # Generates the searchable Puppet defined type list.
 # @return [void]
 def generate_puppet_defined_type_list
-  @items = Registry.all(:puppet_defined_type).sort_by {|dt| dt.name.to_s }
+  @items = Registry.all(:puppet_defined_type).sort_by { |dt| dt.name.to_s }
   @list_title = 'Defined Type List'
   @list_type = 'puppet_defined_type'
   generate_list_contents
@@ -28,7 +30,7 @@ end
 # Generates the searchable Puppet resource type list.
 # @return [void]
 def generate_puppet_type_list
-  @items = Registry.all(:puppet_type).sort_by {|t| t.name.to_s }
+  @items = Registry.all(:puppet_type).sort_by { |t| t.name.to_s }
   @list_title = 'Resource Type List'
   @list_type = 'puppet_type'
   generate_list_contents
@@ -37,7 +39,7 @@ end
 # Generates the searchable Puppet provider list.
 # @return [void]
 def generate_puppet_provider_list
-  @items = Registry.all(:puppet_provider).sort_by {|p| p.name.to_s }
+  @items = Registry.all(:puppet_provider).sort_by { |p| p.name.to_s }
   @list_title = 'Provider List'
   @list_type = 'puppet_provider'
   generate_list_contents
@@ -46,7 +48,7 @@ end
 # Generates the searchable Puppet function list.
 # @return [void]
 def generate_puppet_function_list
-  @items = Registry.all(:puppet_function).sort_by {|f| f.name.to_s }
+  @items = Registry.all(:puppet_function).sort_by { |f| f.name.to_s }
   @list_title = 'Puppet Function List'
   @list_type = 'puppet_function'
   generate_list_contents
@@ -56,8 +58,8 @@ end
 # @return [void]
 def generate_method_list
   @items = prune_method_listing(Registry.all(:method), false)
-  @items = @items.reject {|m| m.name.to_s =~ /=$/ && m.is_attribute? }
-  @items = @items.sort_by {|m| m.name.to_s }
+  @items = @items.reject { |m| m.name.to_s =~ /=$/ && m.is_attribute? }
+  @items = @items.sort_by { |m| m.name.to_s }
   @list_title = 'Ruby Method List'
   @list_type = 'method'
   generate_list_contents
@@ -75,7 +77,7 @@ end
 # Generates the searchable Puppet Task list.
 # @return [void]
 def generate_puppet_task_list
-  @items = Registry.all(:puppet_task).sort_by {|t| t.name.to_s }
+  @items = Registry.all(:puppet_task).sort_by { |t| t.name.to_s }
   @list_title = 'Puppet Task List'
   @list_type = 'puppet_task'
   generate_list_contents
@@ -84,7 +86,7 @@ end
 # Generates the searchable Puppet Plan list.
 # @return [void]
 def generate_puppet_plan_list
-  @items = Registry.all(:puppet_plan).sort_by {|t| t.name.to_s }
+  @items = Registry.all(:puppet_plan).sort_by { |t| t.name.to_s }
   @list_title = 'Puppet Plan List'
   @list_type = 'puppet_plan'
   generate_list_contents

data/lib/puppet-strings/yard/templates/default/layout/html/setup.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 # Initializes the template.
 # @return [void]
 def init
   case object
   when '_index.html'
     @page_title = options.title
-    sections :layout, [:index, [:listing, [:classes, :data_types, :defined_types, :types, :providers, :functions, :tasks, :plans, :files, :objects]]]
+    sections :layout, [:index, [:listing, %i[classes data_types defined_types types providers functions tasks plans files objects]]]
   else
     super
   end
@@ -64,9 +66,7 @@ def layout
 
   final_layout = erb(:layout)
 
-  if @file && @file.name == 'README'
-    PuppetStrings::Yard::Util.github_to_yard_links(final_layout)
-  end
+  PuppetStrings::Yard::Util.github_to_yard_links(final_layout) if @file && @file.name == 'README'
 
   final_layout
 end
@@ -83,12 +83,12 @@ def create_menu_lists
     {
       type: 'puppet_data_type',
       title: 'Data Types',
-      search_title: 'Data Types',
+      search_title: 'Data Types'
     },
     {
       type: 'puppet_defined_type',
       title: 'Defined Types',
-      search_title: 'Defined Types',
+      search_title: 'Defined Types'
     },
     {
       type: 'puppet_type',
@@ -124,17 +124,19 @@ def create_menu_lists
       type: 'method',
       title: 'Ruby Methods',
       search_title: 'Method List'
-    },
+    }
   ]
 
   menu_lists.delete_if { |e| YARD::Registry.all(e[:type].intern).empty? }
 
   # We must always return at least one group, so always keep the files list
-  menu_lists << {
-    type: 'file',
-    title: 'Files',
-    search_title: 'File List'
-  } if menu_lists.empty? || !YARD::Registry.all(:file).empty?
+  if menu_lists.empty? || !YARD::Registry.all(:file).empty?
+    menu_lists << {
+      type: 'file',
+      title: 'Files',
+      search_title: 'File List'
+    }
+  end
 
   menu_lists
 end
@@ -150,9 +152,9 @@ end
 # @return [Hash] Returns a hash of first letter of the object name to list of objects.
 def objects_by_letter(*types)
   hash = {}
-  objects = Registry.all(*types).sort_by {|o| o.name.to_s }
+  objects = Registry.all(*types).sort_by { |o| o.name.to_s }
   objects = run_verifier(objects)
-  objects.each {|o| (hash[o.name.to_s[0,1].upcase] ||= []) << o }
+  objects.each { |o| (hash[o.name.to_s[0, 1].upcase] ||= []) << o }
   hash
 end
 

data/lib/puppet-strings/yard/templates/default/puppet_class/html/deprecated.erb

@@ -0,0 +1,6 @@
+<% object.tags(:deprecated).each do |tag| %>
+  <div class="note deprecated">
+    <strong>DEPRECATED:</strong>
+    <%= htmlify_line deprecated.text %>
+  </div>
+<% end %>

data/lib/puppet-strings/yard/templates/default/puppet_class/html/setup.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 # Initializes the template.
 # @return [void]
 def init
-  sections :header, :box_info, :summary, :overview, :note, :todo, T('tags'), :source
+  sections :header, :box_info, :summary, :overview, :note, :todo, :deprecated, T('tags'), :source
 end
 
 # Renders the box_info section.
 # @return [String] Returns the rendered section.
 def box_info
-  @subclasses = Registry.all(:puppet_class).find_all { |c|
+  @subclasses = Registry.all(:puppet_class).find_all do |c|
     c.statement.parent_class == object.name.to_s
-  }
+  end
   erb(:box_info)
 end

data/lib/puppet-strings/yard/templates/default/puppet_data_type/html/deprecated.erb

@@ -0,0 +1,6 @@
+<% object.tags(:deprecated).each do |tag| %>
+  <div class="note deprecated">
+    <strong>DEPRECATED:</strong>
+    <%= htmlify_line deprecated.text %>
+  </div>
+<% end %>

data/lib/puppet-strings/yard/templates/default/puppet_data_type/html/setup.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 # Initializes the template.
 # @return [void]
 def init
-  sections :header, :box_info, :summary, :overview, :note, :todo, T('tags'), :method_details_list, [T('method_details')], :source
+  sections :header, :box_info, :summary, :overview, :note, :todo, :deprecated, T('tags'), :method_details_list, [T('method_details')], :source
 end
 
 def method_listing
@@ -9,5 +11,5 @@ def method_listing
 end
 
 def sort_listing(list)
-  list.sort_by {|o| [o.scope.to_s, o.name.to_s.downcase] }
+  list.sort_by { |o| [o.scope.to_s, o.name.to_s.downcase] }
 end

data/lib/puppet-strings/yard/templates/default/puppet_data_type_alias/html/deprecated.erb

@@ -0,0 +1,6 @@
+<% object.tags(:deprecated).each do |tag| %>
+  <div class="note deprecated">
+    <strong>DEPRECATED:</strong>
+    <%= htmlify_line deprecated.text %>
+  </div>
+<% end %>

data/lib/puppet-strings/yard/templates/default/puppet_data_type_alias/html/setup.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 # Initializes the template.
 # @return [void]
 def init
-  sections :header, :box_info, :summary, :overview, :alias_of, :note, :todo, T('tags'), :source
+  sections :header, :box_info, :summary, :overview, :alias_of, :note, :todo, :deprecated, T('tags'), :source
 end
 
 # Renders the alias_of section.
@@ -9,8 +11,8 @@ end
 def alias_of
   # Properties are the same thing as parameters (from the documentation standpoint),
   # so reuse the same template but with a different title and data source.
-  #@parameters = object.properties || []
-  #@parameters.sort_by! { |p| p.name }
+  # @parameters = object.properties || []
+  # @parameters.sort_by! { |p| p.name }
   @tag_title = 'Alias of'
   @alias_of = object.alias_of
   erb(:alias_of)