(MAINT) Rubocop - (lib) fixes for markdown

Author: chelnak

lib/puppet-strings/markdown/base.rb

@@ -4,11 +4,12 @@
 require 'puppet-strings/json'
 require 'puppet-strings/yard'
 
+# Implements classes that make elements in a YARD::Registry hash easily accessible for template.
 module PuppetStrings::Markdown
   # This class makes elements in a YARD::Registry hash easily accessible for templates.
   #
   # Here's an example hash:
-  #{:name=>:klass,
+  # {:name=>:klass,
   # :file=>"(stdin)",
   # :line=>16,
   # :inherits=>"foo::bar",
@@ -57,11 +58,11 @@ def initialize(registry, component_type)
 
     # generate 1:1 tag methods
     # e.g. {:tag_name=>"author", :text=>"eputnam"}
-    { :return_val => 'return',
-      :since => 'since',
-      :summary => 'summary',
-      :note => 'note',
-      :todo => 'todo' }.each do |method_name, tag_name|
+    { return_val: 'return',
+      since: 'since',
+      summary: 'summary',
+      note: 'note',
+      todo: 'todo' }.each do |method_name, tag_name|
       # @return [String] unless the tag is nil or the string.empty?
       define_method method_name do
         @tags.find { |tag| tag[:tag_name] == tag_name && !tag[:text].empty? }[:text] if @tags.any? { |tag| tag[:tag_name] == tag_name && !tag[:text].empty? }
@@ -148,7 +149,7 @@ def toc_info
       {
         name: name.to_s,
         link: link,
-        desc: summary || @registry[:docstring][:text][0..140].gsub("\n",' '),
+        desc: summary || @registry[:docstring][:text][0..140].tr("\n", ' '),
         private: private?
       }
     end
@@ -165,9 +166,9 @@ def private?
     def word_wrap(text, line_width: 120, break_sequence: "\n")
       return unless text
 
-      text.split("\n").collect! do |line|
-        line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1#{break_sequence}").strip : line
-      end * break_sequence
+      text.split("\n").map! { |line|
+        line.length > line_width ? line.gsub(%r{(.{1,#{line_width}})(\s+|$)}, "\\1#{break_sequence}").strip : line
+      } * break_sequence
     end
 
     # @return [String] full markdown rendering of a component
@@ -176,7 +177,7 @@ def render(template)
       begin
         PuppetStrings::Markdown.erb(file).result(binding)
       rescue StandardError => e
-        fail "Processing #{@registry[:file]}:#{@registry[:line]} with #{file} => #{e}"
+        raise "Processing #{@registry[:file]}:#{@registry[:line]} with #{file} => #{e}"
       end
     end
 

lib/puppet-strings/markdown/data_type.rb

@@ -20,6 +20,7 @@ def render
     end
   end
 
+  # Generates Markdown for a Puppet Function.
   class DataType::Function < Base
     def initialize(registry)
       super(registry, 'data_type_function')

lib/puppet-strings/markdown/data_types.rb

@@ -3,35 +3,32 @@
 require_relative 'data_type'
 
 module PuppetStrings::Markdown
+  # Generates Markdown for Puppet Data Types.
   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.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
+      return if in_dtypes.nil?
+      in_dtypes.find { |type| type.private? }.nil? ? false : true
     end
 
     def self.render
-      final = in_dtypes.length > 0 ? "## Data types\n\n" : ""
+      final = !in_dtypes.empty? ? "## 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"]
+      final = ['Data types']
 
       in_dtypes.each do |type|
         final.push(type.toc_info)

lib/puppet-strings/markdown/defined_type.rb

@@ -3,6 +3,7 @@
 require 'puppet-strings/markdown/base'
 
 module PuppetStrings::Markdown
+  # Generates Markdown for a Puppet Defined Type.
   class DefinedType < Base
     def initialize(registry)
       @template = 'classes_and_defines.erb'

lib/puppet-strings/markdown/defined_types.rb

@@ -3,31 +3,29 @@
 require_relative 'defined_type'
 
 module PuppetStrings::Markdown
+  # Generates Markdown for Puppet Defined Types.
   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
+      return if in_dtypes.nil?
+      in_dtypes.find { |type| type.private? }.nil? ? false : true
     end
 
     def self.render
-      final = in_dtypes.length > 0 ? "## Defined types\n\n" : ""
+      final = !in_dtypes.empty? ? "## 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"]
+      final = ['Defined types']
 
       in_dtypes.each do |type|
         final.push(type.toc_info)

lib/puppet-strings/markdown/function.rb

@@ -3,6 +3,7 @@
 require 'puppet-strings/markdown/base'
 
 module PuppetStrings::Markdown
+  # Generates Markdown for a Puppet Function.
   class Function < Base
     attr_reader :signatures
 
@@ -21,14 +22,14 @@ def render
 
     def type
       t = @registry[:type]
-      if /ruby4x/.match?(t)
-        "Ruby 4.x API"
-      elsif /ruby3/.match?(t)
-        "Ruby 3.x API"
-      elsif /ruby/.match?(t)
-        "Ruby"
+      if %r{ruby4x}.match?(t)
+        'Ruby 4.x API'
+      elsif %r{ruby3}.match?(t)
+        'Ruby 3.x API'
+      elsif %r{ruby}.match?(t)
+        'Ruby'
       else
-        "Puppet Language"
+        'Puppet Language'
       end
     end
 
@@ -37,10 +38,11 @@ def error_type(type)
     end
 
     def error_text(text)
-      "#{text.split(' ').drop(1).join(' ')}"
+      text.split(' ').drop(1).join(' ').to_s
     end
   end
 
+  # Implements methods to retrieve information about a function signature.
   class Function::Signature < Base
     def initialize(registry)
       @registry = registry

lib/puppet-strings/markdown/functions.rb

@@ -3,31 +3,29 @@
 require_relative 'function'
 
 module PuppetStrings::Markdown
+  # Generates Markdown for Puppet Functions.
   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
+      return if in_functions.nil?
+      in_functions.find { |func| func.private? }.nil? ? false : true
     end
 
     def self.render
-      final = in_functions.length > 0 ? "## Functions\n\n" : ""
+      final = !in_functions.empty? ? "## Functions\n\n" : ''
       in_functions.each do |func|
         final += func.render unless func.private?
       end
       final
     end
 
     def self.toc_info
-      final = ["Functions"]
+      final = ['Functions']
 
       in_functions.each do |func|
         final.push(func.toc_info)
@@ -37,4 +35,3 @@ def self.toc_info
     end
   end
 end
-

lib/puppet-strings/markdown/puppet_class.rb

@@ -3,6 +3,7 @@
 require 'puppet-strings/markdown/base'
 
 module PuppetStrings::Markdown
+  # Generates Markdown for a Puppet Class.
   class PuppetClass < Base
     def initialize(registry)
       @template = 'classes_and_defines.erb'

lib/puppet-strings/markdown/puppet_classes.rb

@@ -3,31 +3,29 @@
 require_relative 'puppet_class'
 
 module PuppetStrings::Markdown
+  # Generates Markdown for Puppet Classes.
   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
+      return if in_classes.nil?
+      in_classes.find { |klass| klass.private? }.nil? ? false : true
     end
 
     def self.render
-      final = in_classes.length > 0 ? "## Classes\n\n" : ""
+      final = !in_classes.empty? ? "## Classes\n\n" : ''
       in_classes.each do |klass|
         final += klass.render unless klass.private?
       end
       final
     end
 
     def self.toc_info
-      final = ["Classes"]
+      final = ['Classes']
 
       in_classes.each do |klass|
         final.push(klass.toc_info)

lib/puppet-strings/markdown/puppet_plan.rb

@@ -3,6 +3,7 @@
 require 'puppet-strings/markdown/base'
 
 module PuppetStrings::Markdown
+  # Generates Markdown for a Puppet Plan.
   class PuppetPlan < Base
     def initialize(registry)
       @template = 'classes_and_defines.erb'

lib/puppet-strings/markdown/puppet_plans.rb

@@ -3,31 +3,29 @@
 require_relative 'puppet_plan'
 
 module PuppetStrings::Markdown
+  # Generates Markdown for Puppet Plans.
   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
+      return if in_plans.nil?
+      in_plans.find { |plan| plan.private? }.nil? ? false : true
     end
 
     def self.render
-      final = in_plans.length > 0 ? "## Plans\n\n" : ""
+      final = !in_plans.empty? ? "## Plans\n\n" : ''
       in_plans.each do |plan|
         final += plan.render unless plan.private?
       end
       final
     end
 
     def self.toc_info
-      final = ["Plans"]
+      final = ['Plans']
 
       in_plans.each do |plan|
         final.push(plan.toc_info)

lib/puppet-strings/markdown/puppet_task.rb

@@ -3,6 +3,7 @@
 require 'puppet-strings/markdown/base'
 
 module PuppetStrings::Markdown
+  # Generates Markdown for a Puppet Task.
   class PuppetTask < Base
     def initialize(registry)
       @template = 'puppet_task.erb'
@@ -21,6 +22,5 @@ def supports_noop
     def input_method
       @registry[:input_method]
     end
-
   end
 end

lib/puppet-strings/markdown/puppet_tasks.rb

@@ -3,8 +3,8 @@
 require_relative 'puppet_task'
 
 module PuppetStrings::Markdown
+  # Generates Markdown for Puppet Tasks.
   module PuppetTasks
-
     # @return [Array] list of classes
     def self.in_tasks
       arr = YARD::Registry.all(:puppet_task).sort_by!(&:name).map!(&:to_hash)
@@ -16,15 +16,15 @@ def self.contains_private?
     end
 
     def self.render
-      final = in_tasks.length > 0 ? "## Tasks\n\n" : ""
+      final = !in_tasks.empty? ? "## Tasks\n\n" : ''
       in_tasks.each do |task|
         final += task.render unless task.private?
       end
       final
     end
 
     def self.toc_info
-      final = ["Tasks"]
+      final = ['Tasks']
 
       in_tasks.each do |task|
         final.push(task.toc_info)

lib/puppet-strings/markdown/resource_type.rb

@@ -3,6 +3,7 @@
 require 'puppet-strings/markdown/base'
 
 module PuppetStrings::Markdown
+  # Generates Markdown for a Puppet Resource Type.
   class ResourceType < Base
     def initialize(registry)
       @template = 'resource_type.erb'
@@ -45,7 +46,7 @@ def parameters
     end
 
     def regex_in_data_type?(data_type)
-      m = data_type.match(/\w+\[\/.*\/\]/)
+      m = data_type.match(%r{\w+\[/.*/\]})
       m unless m.nil? || m.length.zero?
     end
   end