openvox 7.37.1 → 8.19.0

data/lib/puppet/util/rdoc/generators/puppet_generator.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require 'rdoc/generators/html_generator'
 require_relative '../../../../puppet/util/rdoc/code_objects'
 require 'digest/md5'
 
 module Generators
-
   # This module holds all the classes needed to generate the HTML documentation
   # of a bunch of puppet manifests.
   #
@@ -36,11 +37,11 @@ module Generators
   module MarkUp
     alias :old_markup :markup
 
-    def new_markup(str, remove_para=false)
+    def new_markup(str, remove_para = false)
       first = @markup.nil?
       res = old_markup(str, remove_para)
-      if first and not @markup.nil?
-        @markup.add_special(/\b([a-z]\w+(::\w+)*)/,:CROSSREF)
+      if first and !@markup.nil?
+        @markup.add_special(/\b([a-z]\w+(::\w+)*)/, :CROSSREF)
         # we need to call it again, since we added a rule
         res = old_markup(str, remove_para)
       end
@@ -51,10 +52,9 @@ module Generators
 
   # This is a specialized HTMLGenerator tailored to Puppet manifests
   class PuppetGenerator < HTMLGenerator
-
-    def PuppetGenerator.for(options)
-      AllReferences::reset
-      HtmlMethod::reset
+    def self.for(options)
+      AllReferences.reset
+      HtmlMethod.reset
 
       if options.all_one_file
         PuppetGeneratorInOne.new(options)
@@ -63,18 +63,18 @@ module Generators
       end
     end
 
-    def initialize(options) #:not-new:
-      @options    = options
+    def initialize(options) # :not-new:
+      @options = options
       load_html_template
     end
 
     # loads our own html template file
     def load_html_template
-        require_relative '../../../../puppet/util/rdoc/generators/template/puppet/puppet'
-        extend RDoc::Page
+      require_relative '../../../../puppet/util/rdoc/generators/template/puppet/puppet'
+      extend RDoc::Page
     rescue LoadError
-        $stderr.puts "Could not find Puppet template '#{template}'"
-        exit 99
+      $stderr.puts "Could not find Puppet template '#{template}'"
+      exit 99
     end
 
     def gen_method_index
@@ -115,6 +115,7 @@ module Generators
       # build the modules, classes and per modules classes and define list
       @toplevels.each do |toplevel|
         next unless toplevel.document_self
+
         file = HtmlFile.new(toplevel, @options, FILE_DIR)
         classes = []
         methods = []
@@ -137,22 +138,22 @@ module Generators
         end
 
         classes.each do |k|
-          @allclasses[k.index_name] = k if !@allclasses.has_key?(k.index_name)
+          @allclasses[k.index_name] = k unless @allclasses.has_key?(k.index_name)
         end
 
         # generate nodes and plugins found
         classes.each do |k|
-          if k.context.is_module?
-            k.context.each_node do |name,node|
-              nodes << HTMLPuppetNode.new(node, toplevel, NODE_DIR, @options)
-              @nodes << nodes.last
-            end
-            k.context.each_plugin do |plugin|
-              @plugins << HTMLPuppetPlugin.new(plugin, toplevel, PLUGIN_DIR, @options)
-            end
-            k.context.each_fact do |fact|
-              @plugins << HTMLPuppetPlugin.new(fact, toplevel, PLUGIN_DIR, @options)
-            end
+          next unless k.context.is_module?
+
+          k.context.each_node do |_name, node|
+            nodes << HTMLPuppetNode.new(node, toplevel, NODE_DIR, @options)
+            @nodes << nodes.last
+          end
+          k.context.each_plugin do |plugin|
+            @plugins << HTMLPuppetPlugin.new(plugin, toplevel, PLUGIN_DIR, @options)
+          end
+          k.context.each_fact do |fact|
+            @plugins << HTMLPuppetPlugin.new(fact, toplevel, PLUGIN_DIR, @options)
           end
         end
 
@@ -163,11 +164,11 @@ module Generators
       # scan all classes to create the child's references
       @allclasses.values.each do |klass|
         superklass = klass.context.superclass
-        if superklass
-          superklass = AllReferences[superklass]
-          if superklass && (superklass.is_a?(HTMLPuppetClass) || superklass.is_a?(HTMLPuppetNode))
-            superklass.context.add_child(klass.context)
-          end
+        next unless superklass
+
+        superklass = AllReferences[superklass]
+        if superklass && (superklass.is_a?(HTMLPuppetClass) || superklass.is_a?(HTMLPuppetNode))
+          superklass.context.add_child(klass.context)
         end
       end
 
@@ -195,13 +196,13 @@ module Generators
 
     # generate all the subdirectories, modules, classes and files
     def gen_sub_directories
-        super
-        File.makedirs(MODULE_DIR)
-        File.makedirs(NODE_DIR)
-        File.makedirs(PLUGIN_DIR)
+      super
+      File.makedirs(MODULE_DIR)
+      File.makedirs(NODE_DIR)
+      File.makedirs(PLUGIN_DIR)
     rescue
-        $stderr.puts $ERROR_INFO.message
-        exit 1
+      $stderr.puts $ERROR_INFO.message
+      exit 1
     end
 
     # generate the index of modules
@@ -215,16 +216,16 @@ module Generators
       res = []
       collection.sort.each do |f|
         if f.document_self
-          res << { "classlist" => CGI.escapeHTML("#{MODULE_DIR}/fr_#{f.index_name}.html"), "module" => CGI.escapeHTML("#{CLASS_DIR}/#{f.index_name}.html"),"name" => CGI.escapeHTML(f.index_name) }
+          res << { "classlist" => CGI.escapeHTML("#{MODULE_DIR}/fr_#{f.index_name}.html"), "module" => CGI.escapeHTML("#{CLASS_DIR}/#{f.index_name}.html"), "name" => CGI.escapeHTML(f.index_name) }
         end
       end
 
       values = {
-        "entries"    => res,
+        "entries" => res,
         'list_title' => CGI.escapeHTML(title),
-        'index_url'  => main_url,
-        'charset'    => @options.charset,
-        'style_url'  => style_url('', @options.css),
+        'index_url' => main_url,
+        'charset' => @options.charset,
+        'style_url' => style_url('', @options.css),
       }
 
       Puppet::FileSystem.open(filename, nil, "w:UTF-8") do |f|
@@ -236,14 +237,13 @@ module Generators
     def gen_class_index
       gen_an_index(@classes, 'All Classes', RDoc::Page::CLASS_INDEX, "fr_class_index.html")
       @allfiles.each do |file|
-        unless file['file'].context.file_relative_name =~ /\.rb$/
-
-          gen_composite_index(
-            file,
-              RDoc::Page::COMBO_INDEX,
+        next if file['file'].context.file_relative_name =~ /\.rb$/
 
-              "#{MODULE_DIR}/fr_#{file["file"].context.module_name}.html")
-        end
+        gen_composite_index(
+          file,
+          RDoc::Page::COMBO_INDEX,
+          "#{MODULE_DIR}/fr_#{file['file'].context.module_name}.html"
+        )
       end
     end
 
@@ -254,54 +254,54 @@ module Generators
       res1 = []
       collection['classes'].sort.each do |f|
         if f.document_self
-          res1 << { "href" => "../"+CGI.escapeHTML(f.path), "name" => CGI.escapeHTML(f.index_name) } unless f.context.is_module?
+          res1 << { "href" => "../" + CGI.escapeHTML(f.path), "name" => CGI.escapeHTML(f.index_name) } unless f.context.is_module?
         end
       end
 
       res2 = []
       collection['methods'].sort.each do |f|
-        res2 << { "href" => "../#{f.path}", "name" => f.index_name.sub(/\(.*\)$/,'') } if f.document_self
+        res2 << { "href" => "../#{f.path}", "name" => f.index_name.sub(/\(.*\)$/, '') } if f.document_self
       end
 
       module_name = []
       res3 = []
       res4 = []
       collection['modules'].sort.each do |f|
-        module_name << { "href" => "../"+CGI.escapeHTML(f.path), "name" => CGI.escapeHTML(f.index_name) }
+        module_name << { "href" => "../" + CGI.escapeHTML(f.path), "name" => CGI.escapeHTML(f.index_name) }
         unless f.facts.nil?
           f.facts.each do |fact|
-            res3 << {"href" => "../"+CGI.escapeHTML(AllReferences["PLUGIN(#{fact.name})"].path), "name" => CGI.escapeHTML(fact.name)}
+            res3 << { "href" => "../" + CGI.escapeHTML(AllReferences["PLUGIN(#{fact.name})"].path), "name" => CGI.escapeHTML(fact.name) }
           end
         end
-        unless f.plugins.nil?
-          f.plugins.each do |plugin|
-            res4 << {"href" => "../"+CGI.escapeHTML(AllReferences["PLUGIN(#{plugin.name})"].path), "name" => CGI.escapeHTML(plugin.name)}
-          end
+        next if f.plugins.nil?
+
+        f.plugins.each do |plugin|
+          res4 << { "href" => "../" + CGI.escapeHTML(AllReferences["PLUGIN(#{plugin.name})"].path), "name" => CGI.escapeHTML(plugin.name) }
         end
       end
 
       res5 = []
       collection['nodes'].sort.each do |f|
-        res5 << { "href" => "../"+CGI.escapeHTML(f.path), "name" => CGI.escapeHTML(f.name) } if f.document_self
+        res5 << { "href" => "../" + CGI.escapeHTML(f.path), "name" => CGI.escapeHTML(f.name) } if f.document_self
       end
 
       values = {
         "module" => module_name,
-        "classes"    => res1,
+        "classes" => res1,
         'classes_title' => CGI.escapeHTML("Classes"),
         'defines_title' => CGI.escapeHTML("Defines"),
         'facts_title' => CGI.escapeHTML("Custom Facts"),
         'plugins_title' => CGI.escapeHTML("Plugins"),
         'nodes_title' => CGI.escapeHTML("Nodes"),
-        'index_url'  => main_url,
-        'charset'    => @options.charset,
-        'style_url'  => style_url('', @options.css),
+        'index_url' => main_url,
+        'charset' => @options.charset,
+        'style_url' => style_url('', @options.css),
       }
 
-      values["defines"] = res2 if res2.size>0
-      values["facts"] = res3 if res3.size>0
-      values["plugins"] = res4 if res4.size>0
-      values["nodes"] = res5 if res5.size>0
+      values["defines"] = res2 if res2.size > 0
+      values["facts"] = res3 if res3.size > 0
+      values["plugins"] = res4 if res4.size > 0
+      values["nodes"] = res5 if res5.size > 0
 
       Puppet::FileSystem.open(filename, nil, "w:UTF-8") do |f|
         template.write_html_on(f, values)
@@ -322,7 +322,7 @@ module Generators
       end
 
       unless ref
-        for file in @files
+        @files.each do |file|
           if file.document_self and file.context.global
             ref = CGI.escapeHTML("#{CLASS_DIR}/#{file.context.module_name}.html")
             break
@@ -331,7 +331,7 @@ module Generators
       end
 
       unless ref
-        for file in @files
+        @files.each do |file|
           if file.document_self and !file.context.global
             ref = CGI.escapeHTML("#{CLASS_DIR}/#{file.context.module_name}.html")
             break
@@ -347,7 +347,6 @@ module Generators
 
       ref
     end
-
   end
 
   # This module is used to generate a referenced full name list of ContextUser
@@ -375,17 +374,17 @@ module Generators
   module ResourceContainer
     def collect_resources
       list = @context.resource_list
-      @resources = list.collect {|m| HTMLPuppetResource.new(m, self, @options) }
+      @resources = list.collect { |m| HTMLPuppetResource.new(m, self, @options) }
     end
 
-    def build_resource_summary_list(path_prefix='')
+    def build_resource_summary_list(path_prefix = '')
       collect_resources unless @resources
       resources = @resources.sort
       res = []
       resources.each do |r|
         res << {
           "name" => CGI.escapeHTML(r.name),
-          "aref" => Puppet::Util.uri_encode(path_prefix)+"\#"+Puppet::Util.uri_query_encode(r.aref)
+          "aref" => Puppet::Util.uri_encode(path_prefix) + "\#" + Puppet::Util.uri_query_encode(r.aref)
         }
       end
       res
@@ -396,14 +395,14 @@ module Generators
       resources = @resources.sort
       resources.each do |r|
         row = {}
-        if r.section == section and r.document_self
-          row["name"]        = CGI.escapeHTML(r.name)
-          desc = r.description.strip
-          row["m_desc"]      = desc unless desc.empty?
-          row["aref"]        = r.aref
-          row["params"]      = r.params
-          outer << row
-        end
+        next unless r.section == section and r.document_self
+
+        row["name"] = CGI.escapeHTML(r.name)
+        desc = r.description.strip
+        row["m_desc"]      = desc unless desc.empty?
+        row["aref"]        = r.aref
+        row["params"]      = r.params
+        outer << row
       end
       outer
     end
@@ -419,12 +418,12 @@ module Generators
 
       @context.sections.each do |section|
         secdata = @values["sections"].select { |s| s["secsequence"] == section.sequence }
-        if secdata.size == 1
-          secdata = secdata[0]
+        next unless secdata.size == 1
 
-          rdl = build_resource_detail_list(section)
-          secdata["resource_list"] = rdl unless rdl.empty?
-        end
+        secdata = secdata[0]
+
+        rdl = build_resource_detail_list(section)
+        secdata["resource_list"] = rdl unless rdl.empty?
       end
 
       rl = build_require_list(@context)
@@ -483,7 +482,7 @@ module Generators
     # which is also its url
     def http_url(full_name, prefix)
       path = full_name.dup
-      path.gsub!(/<<\s*(\w*)/) { "from-#$1" } if path['<<']
+      path.gsub!(/<<\s*(\w*)/) { "from-#{::Regexp.last_match(1)}" } if path['<<']
       File.join(prefix, path.split("::").collect { |p| Digest::MD5.hexdigest(p) }) + ".html"
     end
 
@@ -498,11 +497,11 @@ module Generators
     def write_on(f)
       value_hash
 
-        template = TemplatePage.new(
-          RDoc::Page::BODYINC,
-            RDoc::Page::NODE_PAGE,
-
-            RDoc::Page::METHOD_LIST)
+      template = TemplatePage.new(
+        RDoc::Page::BODYINC,
+        RDoc::Page::NODE_PAGE,
+        RDoc::Page::METHOD_LIST
+      )
       template.write_html_on(f, @values)
     end
 
@@ -535,7 +534,6 @@ module Generators
       @values["childs"] = cl unless cl.empty?
 
       @values["sections"] = @context.sections.map do |section|
-
         secdata = {
           "sectitle" => section.title,
           "secsequence" => section.sequence,
@@ -571,17 +569,18 @@ module Generators
       res = []
       atts.each do |att|
         next unless att.section == section
-        if att.visibility == :public || att.visibility == :protected || @options.show_all
-          entry = {
-            "name"   => CGI.escapeHTML(att.name),
-            "rw"     => att.rw,
-            "a_desc" => markup(att.comment, true)
-          }
-          unless att.visibility == :public || att.visibility == :protected
-            entry["rw"] << "-"
-          end
-          res << entry
+
+        next unless att.visibility == :public || att.visibility == :protected || @options.show_all
+
+        entry = {
+          "name" => CGI.escapeHTML(att.name),
+          "rw" => att.rw,
+          "a_desc" => markup(att.comment, true)
+        }
+        unless att.visibility == :public || att.visibility == :protected
+          entry["rw"] << "-"
         end
+        res << entry
       end
       res
     end
@@ -622,7 +621,7 @@ module Generators
         res["full_path"]     = full_path
         res["full_path_url"] = aref_to(f.viewer.path) if f.document_self
 
-        res["cvsurl"] = cvs_url( @options.webcvs, full_path ) if @options.webcvs
+        res["cvsurl"] = cvs_url(@options.webcvs, full_path) if @options.webcvs
 
         files << res
       end
@@ -643,16 +642,11 @@ module Generators
     end
 
     def <=>(other)
-      self.name <=> other.name
+      name <=> other.name
     end
   end
 
   class HTMLPuppetModule < HtmlClass
-
-    def initialize(context, html_file, prefix, options)
-      super(context, html_file, prefix, options)
-    end
-
     def value_hash
       @values = super
 
@@ -673,23 +667,23 @@ module Generators
       prefix = "&nbsp;&nbsp;::" * level;
 
       context.nodes.sort.each do |node|
-        if node.document_self
-          res <<
+        next unless node.document_self
+
+        res <<
           prefix <<
           "Node " <<
           href(url(node.viewer.path), "link", node.full_name) <<
           "<br />\n"
-        end
       end
       res
     end
 
     def build_facts_summary_list
-      potentially_referenced_list(context.facts) {|fn| ["PLUGIN(#{fn})"] }
+      potentially_referenced_list(context.facts) { |fn| ["PLUGIN(#{fn})"] }
     end
 
     def build_plugins_summary_list
-      potentially_referenced_list(context.plugins) {|fn| ["PLUGIN(#{fn})"] }
+      potentially_referenced_list(context.plugins) { |fn| ["PLUGIN(#{fn})"] }
     end
 
     def facts
@@ -699,7 +693,6 @@ module Generators
     def plugins
       @context.plugins
     end
-
   end
 
   class HTMLPuppetPlugin < ContextUser
@@ -731,7 +724,7 @@ module Generators
     # which is also its url
     def http_url(full_name, prefix)
       path = full_name.dup
-      path.gsub!(/<<\s*(\w*)/) { "from-#$1" } if path['<<']
+      path.gsub!(/<<\s*(\w*)/) { "from-#{::Regexp.last_match(1)}" } if path['<<']
       File.join(prefix, path.split("::")) + ".html"
     end
 
@@ -746,11 +739,11 @@ module Generators
     def write_on(f)
       value_hash
 
-        template = TemplatePage.new(
-          RDoc::Page::BODYINC,
-            RDoc::Page::PLUGIN_PAGE,
-
-            RDoc::Page::PLUGIN_LIST)
+      template = TemplatePage.new(
+        RDoc::Page::BODYINC,
+        RDoc::Page::PLUGIN_PAGE,
+        RDoc::Page::PLUGIN_LIST
+      )
       template.write_html_on(f, @values)
     end
 
@@ -807,7 +800,7 @@ module Generators
         res["full_path"]     = full_path
         res["full_path_url"] = aref_to(f.viewer.path) if f.document_self
 
-        res["cvsurl"] = cvs_url( @options.webcvs, full_path ) if @options.webcvs
+        res["cvsurl"] = cvs_url(@options.webcvs, full_path) if @options.webcvs
 
         files << res
       end
@@ -816,9 +809,8 @@ module Generators
     end
 
     def <=>(other)
-      self.name <=> other.name
+      name <=> other.name
     end
-
   end
 
   class HTMLPuppetResource
@@ -857,7 +849,7 @@ module Generators
     end
 
     def index_name
-      "#{@context.name}"
+      @context.name.to_s
     end
 
     def params
@@ -896,11 +888,10 @@ module Generators
       @context.document_self
     end
 
-    def find_symbol(symbol, method=nil)
+    def find_symbol(symbol, method = nil)
       res = @context.parent.find_symbol(symbol, method)
       res && res.viewer
     end
-
   end
 
   class PuppetGeneratorInOne < HTMLGeneratorInOne
@@ -908,5 +899,4 @@ module Generators
       gen_an_index(HtmlMethod.all_methods, 'Defines')
     end
   end
-
 end