puppet-strings 2.9.0 → 3.0.0

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

@@ -21,15 +21,15 @@ 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 do |parameter|
+    args = @parameters.map { |parameter|
       name, default = parameter
       tag = tags.find { |t| t.name == name } if tags
       type = tag&.types ? "#{tag.type} " : 'Any '
-      prefix = "#{name[0]}" if name.start_with?('*', '&')
+      prefix = (name[0]).to_s if name.start_with?('*', '&')
       name = name[1..-1] if prefix
       default = " = #{default}" if default
       "#{type}#{prefix}$#{name}#{default}"
-    end.join(', ')
+    }.join(', ')
     @name + '(' + args + ')'
   end
 
@@ -57,7 +57,7 @@ class PuppetStrings::Yard::Tags::OverloadTag < YARD::Tags::Tag
   # Determines if a tag with the given name is present.
   # @param [String, Symbol] name The tag name.
   # @return [Boolean] Returns true if there is at least one tag with the given name or false if not.
-  def has_tag?(name)
+  def has_tag?(name) # rubocop:disable Naming/PredicateName
     @docstring.has_tag?(name)
   end
 
@@ -67,7 +67,7 @@ class PuppetStrings::Yard::Tags::OverloadTag < YARD::Tags::Tag
   def object=(value)
     super(value)
     @docstring.object = value
-    @docstring.tags.each {|tag| tag.object = value }
+    @docstring.tags.each { |tag| tag.object = value }
   end
 
   # Responsible for forwarding method calls to the associated object.
@@ -102,8 +102,8 @@ class PuppetStrings::Yard::Tags::OverloadTag < YARD::Tags::Tag
     hash[:tag_name] = tag_name
     hash[:text] = text if text
     hash[:signature] = signature
-    hash[:docstring] = PuppetStrings::Yard::Util.docstring_to_hash(docstring) if !docstring.blank?
-    defaults = Hash[*parameters.reject{ |p| p[1].nil? }.flatten]
+    hash[:docstring] = PuppetStrings::Yard::Util.docstring_to_hash(docstring) unless docstring.blank?
+    defaults = Hash[*parameters.reject { |p| p[1].nil? }.flatten]
     hash[:defaults] = defaults unless defaults.empty?
     hash[:types] = types if types
     hash[:name] = name if name

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

@@ -12,8 +12,8 @@ class PuppetStrings::Yard::Tags::ParameterDirective < YARD::Tags::Directive
     # Add a parameter to the resource
     parameter = PuppetStrings::Yard::CodeObjects::Type::Parameter.new(tag.name, tag.text)
     tag.types&.each do |value|
-        parameter.add(value)
-      end
+      parameter.add(value)
+    end
     object.add_parameter parameter
   end
 

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

@@ -12,8 +12,8 @@ class PuppetStrings::Yard::Tags::PropertyDirective < YARD::Tags::Directive
     # Add a property to the resource
     property = PuppetStrings::Yard::CodeObjects::Type::Property.new(tag.name, tag.text)
     tag.types&.each do |value|
-        property.add(value)
-      end
+      property.add(value)
+    end
     object.add_property property
   end
 

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

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
 # Implements a summary tag for general purpose short descriptions
-
 class PuppetStrings::Yard::Tags::SummaryTag < YARD::Tags::Tag
   # Registers the tag with YARD.
   # @return [void]
   def self.register!
-    YARD::Tags::Library.define_tag("puppet.summary", :summary)
+    YARD::Tags::Library.define_tag('puppet.summary', :summary)
   end
 end

data/lib/puppet-strings/yard/util.rb

@@ -9,7 +9,7 @@ module PuppetStrings::Yard::Util
   # @param [String] str The string to scrub.
   # @return [String] A scrubbed string.
   def self.scrub_string(str)
-    match = str.match(/^%[Qq]{(.*)}$/m)
+    match = str.match(%r{^%[Qq]{(.*)}$}m)
     if match
       return Puppet::Util::Docs.scrub(match[1])
     end
@@ -25,8 +25,8 @@ module PuppetStrings::Yard::Util
   # @param [String] data HTML document to convert
   # @return [String] HTML document with links converted
   def self.github_to_yard_links(data)
-    data.scan(/href\=\"\#(.+)\"/).each do |bad_link|
-      data = data.gsub("=\"##{bad_link.first}\"", "=\"#label-#{bad_link.first.capitalize.gsub('-', '+')}\"")
+    data.scan(%r{href\=\"\#(.+)\"}).each do |bad_link|
+      data = data.gsub("=\"##{bad_link.first}\"", "=\"#label-#{bad_link.first.capitalize.tr('-', '+')}\"")
     end
 
     data
@@ -59,7 +59,7 @@ module PuppetStrings::Yard::Util
   # @param [YARD::Docstring, String] docstring The docstring to convert to a hash.
   # @param [Array] select_tags List of tags to select. Other tags will be filtered out.
   # @return [Hash] Returns a hash representation of the given docstring.
-  def self.docstring_to_hash(docstring, select_tags=nil)
+  def self.docstring_to_hash(docstring, select_tags = nil)
     hash = {}
     hash[:text] = docstring
 
@@ -79,4 +79,11 @@ module PuppetStrings::Yard::Util
 
     hash
   end
+
+  # Convert Puppet AST to text.
+  # @param [Puppet::Pops::Model::PopsObject] ast The Puppet AST to convert to text.
+  # @return [String] Returns a string of Puppet code.
+  def self.ast_to_text(ast)
+    ast.locator.extract_tree_text(ast)
+  end
 end

data/lib/puppet-strings/yard.rb

@@ -61,7 +61,7 @@ class YARD::CLI::Yardoc
       :puppet_provider,
       :puppet_function,
       :puppet_task,
-      :puppet_plan
+      :puppet_plan,
     )
   end
 end
@@ -114,18 +114,18 @@ class YARD::CLI::Stats
     @undocumented += undoc if undoc.is_a?(Integer)
     data =
       if undoc
-        ('%5s (% 5d undocumented)' % [data, undoc])
+        "#{data} (#{undoc} undocumented)"
       else
-        '%5s' % data
+        data.to_s
       end
-    log.puts('%-21s %s' % [name + ':', data])
+    log.puts("#{name.ljust(25)} #{data}")
   end
 
   # This differs from the YARD implementation in that it considers
   # a docstring without text but with tags to be undocumented.
   def type_statistics_all(type)
-    objs = all_objects.select {|m| m.type == type }
-    undoc = objs.find_all {|m| m.docstring.all.empty? }
+    objs = all_objects.select { |m| m.type == type }
+    undoc = objs.select { |m| m.docstring.all.empty? }
     @undoc_list |= undoc if @undoc_list
     [objs.size, undoc.size]
   end

data/lib/puppet-strings.rb

@@ -1,16 +1,11 @@
+# rubocop:disable Naming/FileName
+
 # frozen_string_literal: true
 
 # The root module for Puppet Strings.
 module PuppetStrings
   # The glob patterns used to search for files to document.
-  DEFAULT_SEARCH_PATTERNS = %w(
-    manifests/**/*.pp
-    functions/**/*.pp
-    types/**/*.pp
-    lib/**/*.rb
-    tasks/*.json
-    plans/**/*.pp
-  ).freeze
+  DEFAULT_SEARCH_PATTERNS = ['manifests/**/*.pp', 'functions/**/*.pp', 'types/**/*.pp', 'lib/**/*.rb', 'tasks/*.json', 'plans/**/*.pp'].freeze
 
   # Generates documentation.
   # @param [Array<String>] search_patterns The search patterns (e.g. manifests/**/*.pp) to look for files.
@@ -39,7 +34,7 @@ module PuppetStrings
       file = if options[:json]
                options[:path]
              elsif options[:markdown]
-               options[:path] || "REFERENCE.md"
+               options[:path] || 'REFERENCE.md'
              end
       # Disable output and prevent stats/progress when writing to STDOUT
       args << '-n'
@@ -64,13 +59,12 @@ module PuppetStrings
       render_markdown(file)
     end
 
-    if options[:describe]
-      render_describe(options[:describe_types], options[:describe_list], options[:providers])
-    end
+    return unless options[:describe]
+    render_describe(options[:describe_types], options[:describe_list], options[:providers])
   end
 
   def self.puppet_5?
-    Puppet::Util::Package.versioncmp(Puppet.version, "5.0.0") >= 0
+    Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0
   end
 
   def self.render_json(path)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-strings
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Puppet Inc.
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-29 00:00:00.000000000 Z
+date: 2022-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -28,17 +28,17 @@ dependencies:
   name: rgen
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Puppet documentation via YARD
+        version: 0.9.0
+description: 
 email: info@puppet.com
 executables: []
 extensions: []
@@ -60,20 +60,13 @@ files:
 - lib/puppet-strings/markdown.rb
 - lib/puppet-strings/markdown/base.rb
 - lib/puppet-strings/markdown/data_type.rb
-- lib/puppet-strings/markdown/data_types.rb
 - lib/puppet-strings/markdown/defined_type.rb
-- lib/puppet-strings/markdown/defined_types.rb
 - lib/puppet-strings/markdown/function.rb
-- lib/puppet-strings/markdown/functions.rb
+- lib/puppet-strings/markdown/helpers.rb
 - lib/puppet-strings/markdown/puppet_class.rb
-- lib/puppet-strings/markdown/puppet_classes.rb
 - lib/puppet-strings/markdown/puppet_plan.rb
-- lib/puppet-strings/markdown/puppet_plans.rb
 - lib/puppet-strings/markdown/puppet_task.rb
-- lib/puppet-strings/markdown/puppet_tasks.rb
 - lib/puppet-strings/markdown/resource_type.rb
-- lib/puppet-strings/markdown/resource_types.rb
-- lib/puppet-strings/markdown/table_of_contents.rb
 - lib/puppet-strings/markdown/templates/classes_and_defines.erb
 - lib/puppet-strings/markdown/templates/data_type.erb
 - lib/puppet-strings/markdown/templates/data_type_function.erb
@@ -228,7 +221,7 @@ homepage: https://github.com/puppetlabs/puppet-strings
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -236,16 +229,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- puppet, >= 5.0.0
+- puppet, >= 6.0.0
 rubygems_version: 3.1.6
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Puppet documentation via YARD
 test_files: []

data/lib/puppet-strings/markdown/data_types.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'data_type'
-
-module PuppetStrings::Markdown
-  module DataTypes
-
-    # @return [Array] list of data types
-    def self.in_dtypes
-      arr = YARD::Registry.all(:puppet_data_type).map!(&:to_hash)
-      arr.concat(YARD::Registry.all(:puppet_data_type_alias).map!(&:to_hash))
-
-      arr.sort! { |a,b| a[:name] <=> b[:name] }
-      arr.map! { |a| PuppetStrings::Markdown::DataType.new(a) }
-    end
-
-    def self.contains_private?
-      result = false
-      unless in_dtypes.nil?
-        in_dtypes.find { |type| type.private? }.nil? ? false : true
-      end
-    end
-
-    def self.render
-      final = in_dtypes.length > 0 ? "## Data types\n\n" : ""
-      in_dtypes.each do |type|
-        final += type.render unless type.private?
-      end
-      final
-    end
-
-
-    def self.toc_info
-      final = ["Data types"]
-
-      in_dtypes.each do |type|
-        final.push(type.toc_info)
-      end
-
-      final
-    end
-  end
-end

data/lib/puppet-strings/markdown/defined_types.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'defined_type'
-
-module PuppetStrings::Markdown
-  module DefinedTypes
-
-    # @return [Array] list of defined types
-    def self.in_dtypes
-      arr = YARD::Registry.all(:puppet_defined_type).sort_by!(&:name).map!(&:to_hash)
-      arr.map! { |a| PuppetStrings::Markdown::DefinedType.new(a) }
-    end
-
-    def self.contains_private?
-      result = false
-      unless in_dtypes.nil?
-        in_dtypes.find { |type| type.private? }.nil? ? false : true
-      end
-    end
-
-    def self.render
-      final = in_dtypes.length > 0 ? "## Defined types\n\n" : ""
-      in_dtypes.each do |type|
-        final += type.render unless type.private?
-      end
-      final
-    end
-
-    def self.toc_info
-      final = ["Defined types"]
-
-      in_dtypes.each do |type|
-        final.push(type.toc_info)
-      end
-
-      final
-    end
-  end
-end

data/lib/puppet-strings/markdown/functions.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'function'
-
-module PuppetStrings::Markdown
-  module Functions
-
-    # @return [Array] list of functions
-    def self.in_functions
-      arr = YARD::Registry.all(:puppet_function).sort_by!(&:name).map!(&:to_hash)
-      arr.map! { |a| PuppetStrings::Markdown::Function.new(a) }
-    end
-
-    def self.contains_private?
-      result = false
-      unless in_functions.nil?
-        in_functions.find { |func| func.private? }.nil? ? false : true
-      end
-    end
-
-    def self.render
-      final = in_functions.length > 0 ? "## Functions\n\n" : ""
-      in_functions.each do |func|
-        final += func.render unless func.private?
-      end
-      final
-    end
-
-    def self.toc_info
-      final = ["Functions"]
-
-      in_functions.each do |func|
-        final.push(func.toc_info)
-      end
-
-      final
-    end
-  end
-end
-

data/lib/puppet-strings/markdown/puppet_classes.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'puppet_class'
-
-module PuppetStrings::Markdown
-  module PuppetClasses
-
-    # @return [Array] list of classes
-    def self.in_classes
-      arr = YARD::Registry.all(:puppet_class).sort_by!(&:name).map!(&:to_hash)
-      arr.map! { |a| PuppetStrings::Markdown::PuppetClass.new(a) }
-    end
-
-    def self.contains_private?
-      result = false
-      unless in_classes.nil?
-        in_classes.find { |klass| klass.private? }.nil? ? false : true
-      end
-    end
-
-    def self.render
-      final = in_classes.length > 0 ? "## Classes\n\n" : ""
-      in_classes.each do |klass|
-        final += klass.render unless klass.private?
-      end
-      final
-    end
-
-    def self.toc_info
-      final = ["Classes"]
-
-      in_classes.each do |klass|
-        final.push(klass.toc_info)
-      end
-
-      final
-    end
-  end
-end

data/lib/puppet-strings/markdown/puppet_plans.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'puppet_plan'
-
-module PuppetStrings::Markdown
-  module PuppetPlans
-
-    # @return [Array] list of classes
-    def self.in_plans
-      arr = YARD::Registry.all(:puppet_plan).sort_by!(&:name).map!(&:to_hash)
-      arr.map! { |a| PuppetStrings::Markdown::PuppetPlan.new(a) }
-    end
-
-    def self.contains_private?
-      result = false
-      unless in_plans.nil?
-        in_plans.find { |plan| plan.private? }.nil? ? false : true
-      end
-    end
-
-    def self.render
-      final = in_plans.length > 0 ? "## Plans\n\n" : ""
-      in_plans.each do |plan|
-        final += plan.render unless plan.private?
-      end
-      final
-    end
-
-    def self.toc_info
-      final = ["Plans"]
-
-      in_plans.each do |plan|
-        final.push(plan.toc_info)
-      end
-
-      final
-    end
-  end
-end

data/lib/puppet-strings/markdown/puppet_tasks.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'puppet_task'
-
-module PuppetStrings::Markdown
-  module PuppetTasks
-
-    # @return [Array] list of classes
-    def self.in_tasks
-      arr = YARD::Registry.all(:puppet_task).sort_by!(&:name).map!(&:to_hash)
-      arr.map! { |a| PuppetStrings::Markdown::PuppetTask.new(a) }
-    end
-
-    def self.contains_private?
-      false
-    end
-
-    def self.render
-      final = in_tasks.length > 0 ? "## Tasks\n\n" : ""
-      in_tasks.each do |task|
-        final += task.render unless task.private?
-      end
-      final
-    end
-
-    def self.toc_info
-      final = ["Tasks"]
-
-      in_tasks.each do |task|
-        final.push(task.toc_info)
-      end
-
-      final
-    end
-  end
-end

data/lib/puppet-strings/markdown/resource_types.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'resource_type'
-
-module PuppetStrings::Markdown
-  module ResourceTypes
-
-    # @return [Array] list of resource types
-    def self.in_rtypes
-      arr = YARD::Registry.all(:puppet_type).sort_by!(&:name).map!(&:to_hash)
-      arr.map! { |a| PuppetStrings::Markdown::ResourceType.new(a) }
-    end
-
-    def self.contains_private?
-      result = false
-      unless in_rtypes.nil?
-        in_rtypes.find { |type| type.private? }.nil? ? false : true
-      end
-    end
-
-    def self.render
-      final = in_rtypes.length > 0 ? "## Resource types\n\n" : ""
-      in_rtypes.each do |type|
-        final += type.render unless type.private?
-      end
-      final
-    end
-
-    def self.toc_info
-      final = ["Resource types"]
-
-      in_rtypes.each do |type|
-        final.push(type.toc_info)
-      end
-
-      final
-    end
-  end
-end

data/lib/puppet-strings/markdown/table_of_contents.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module PuppetStrings::Markdown
-  module TableOfContents
-    def self.render
-      final = "## Table of Contents\n\n"
-
-      [PuppetStrings::Markdown::PuppetClasses,
-      PuppetStrings::Markdown::DefinedTypes,
-      PuppetStrings::Markdown::ResourceTypes,
-      PuppetStrings::Markdown::Functions,
-      PuppetStrings::Markdown::DataTypes,
-      PuppetStrings::Markdown::PuppetTasks,
-      PuppetStrings::Markdown::PuppetPlans].each do |r|
-        toc = r.toc_info
-        group_name = toc.shift
-        group = toc
-        priv = r.contains_private?
-
-        template = File.join(File.dirname(__FILE__),"templates/table_of_contents.erb")
-        final += ERB.new(File.read(template), nil, '-').result(binding)
-      end
-      final
-    end
-  end
-end