(MAINT) Rubocop - (lib) fixes for puppet-strings

Author: chelnak

Diff for: 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 @@ def self.generate(search_patterns = DEFAULT_SEARCH_PATTERNS, options = {})
       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 @@ def self.generate(search_patterns = DEFAULT_SEARCH_PATTERNS, options = {})
       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)

Diff for: lib/puppet-strings/describe.rb

@@ -8,16 +8,16 @@ module PuppetStrings::Describe
   # Renders requested types or a summarized list in the current YARD registry to STDOUT.
   # @param [Array] describe_types The list of names of the types to be displayed.
   # @param [bool] list Create the summarized list instead of describing each type.
-  # @param [bool] providers Show details of the providers.
+  # @param [bool] _providers Show details of the providers.
   # @return [void]
-  def self.render(describe_types = [], list = false, providers = false)
+  def self.render(describe_types = [], list = false, _providers = false)
     document = {
       defined_types: YARD::Registry.all(:puppet_defined_type).sort_by!(&:name).map!(&:to_hash),
-      resource_types: YARD::Registry.all(:puppet_type).sort_by!(&:name).map!(&:to_hash),        
+      resource_types: YARD::Registry.all(:puppet_type).sort_by!(&:name).map!(&:to_hash),
     }
 
     if list
-      puts "These are the types known to puppet:"
+      puts 'These are the types known to puppet:'
       document[:resource_types].each { |t| list_one_type(t) }
     else
       document[:providers] = YARD::Registry.all(:puppet_provider).sort_by!(&:name).map!(&:to_hash)
@@ -26,45 +26,45 @@ def self.render(describe_types = [], list = false, providers = false)
       describe_types.each { |name| type_names[name] = true }
 
       document[:resource_types].each do |t|
-        show_one_type(t, providers) if type_names[t[:name].to_s]
+        show_one_type(t) if type_names[t[:name].to_s]
       end
     end
   end
 
-  def self.show_one_type(resource_type, providers = false)
-    puts "\n%{name}\n%{underscore}" % { name: resource_type[:name], underscore: "=" * resource_type[:name].length }
+  def self.show_one_type(resource_type)
+    puts "\n%{name}\n%{underscore}" % { name: resource_type[:name], underscore: '=' * resource_type[:name].length }
     puts resource_type[:docstring][:text]
 
     combined_list = (resource_type[:parameters].nil? ? [] : resource_type[:parameters]) +
                     (resource_type[:properties].nil? ? [] : resource_type[:properties])
 
-    if combined_list.any?
-      puts "\nParameters\n----------"
-      combined_list.sort_by { |p| p[:name] }.each { |p| show_one_parameter(p) }
-      puts "\nProviders\n---------"
-    end
-    #Show providers here - list or provide details      
+    return unless combined_list.any?
+
+    puts "\nParameters\n----------"
+    combined_list.sort_by { |p| p[:name] }.each { |p| show_one_parameter(p) }
+    puts "\nProviders\n---------"
+    # Show providers here - list or provide details
   end
 
   def self.show_one_parameter(parameter)
     puts "\n- **%{name}**\n" % { name: parameter[:name] }
     puts parameter[:description]
-    puts "Valid values are `%{values}`." % { values: parameter[:values].join("`, `") } unless parameter[:values].nil?
-    puts "Requires features %{required_features}." % { required_features: parameter[:required_features] } unless parameter[:required_features].nil?
+    puts 'Valid values are `%{values}`.' % { values: parameter[:values].join('`, `') } unless parameter[:values].nil?
+    puts 'Requires features %{required_features}.' % { required_features: parameter[:required_features] } unless parameter[:required_features].nil?
   end
 
   def self.list_one_type(type)
     targetlength = 48
     shortento = targetlength - 4
     contentstring = type[:docstring][:text]
     end_of_line = contentstring.index("\n")  # "." gives closer results to old describeb, but breaks for '.k5login'
-    if !end_of_line.nil?
+    unless end_of_line.nil?
       contentstring = contentstring[0..end_of_line]
     end
     if contentstring.length > targetlength
       contentstring = contentstring[0..shortento] + ' ...'
     end
-    
-    puts "%-15s - %-s" % [type[:name], contentstring]
+
+    puts "#{type[:name].to_s.ljust(15)} - #{contentstring}"
   end
 end

Diff for: lib/puppet-strings/tasks.rb

@@ -3,11 +3,9 @@
 require 'rake'
 require 'rake/tasklib'
 
-module PuppetStrings
-  # The module for Puppet Strings rake tasks.
-  module Tasks
-    require 'puppet-strings/tasks/generate.rb'
-    require 'puppet-strings/tasks/gh_pages.rb'
-    require 'puppet-strings/tasks/validate.rb'
-  end
+# The module for Puppet Strings rake tasks.
+module PuppetStrings::Tasks
+  require 'puppet-strings/tasks/generate.rb'
+  require 'puppet-strings/tasks/gh_pages.rb'
+  require 'puppet-strings/tasks/validate.rb'
 end

Diff for: lib/puppet-strings/yard.rb

@@ -61,7 +61,7 @@ def all_objects
       :puppet_provider,
       :puppet_function,
       :puppet_task,
-      :puppet_plan
+      :puppet_plan,
     )
   end
 end
@@ -114,18 +114,18 @@ def output(name, data, undoc = nil)
     @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