openvox 7.37.1 → 8.19.0

data/lib/puppet/face/help.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/face'
 require_relative '../../puppet/application/face_base'
 require_relative '../../puppet/util/constant_inflector'
@@ -5,13 +7,13 @@ require 'pathname'
 require 'erb'
 
 Puppet::Face.define(:help, '0.0.1') do
-  copyright "Puppet Inc.", 2011
+  copyright "Puppet Inc., Vox Pupuli", 2011
   license   _("Apache 2 license; see COPYING")
 
-  summary _("Display Puppet help.")
+  summary _("Display OpenVox help.")
 
   action(:help) do
-    summary _("Display help about Puppet subcommands and their actions.")
+    summary _("Display help about OpenVox subcommands and their actions.")
     arguments _("[<subcommand>] [<action>]")
     returns _("Short help text for the specified subcommand or action.")
     examples _(<<-'EOT')
@@ -40,7 +42,7 @@ Puppet::Face.define(:help, '0.0.1') do
       end
 
       if args.length > 2
-        #TRANSLATORS 'puppet help' is a command line and should not be translated
+        # TRANSLATORS 'puppet help' is a command line and should not be translated
         raise ArgumentError, _("The 'puppet help' command takes two (optional) arguments: a subcommand and an action")
       end
 
@@ -48,11 +50,9 @@ Puppet::Face.define(:help, '0.0.1') do
       if options.has_key? :version
         if options[:version].to_s !~ /^current$/i
           version = options[:version]
-        else
-          if args.length == 0
-            #TRANSLATORS '--version' is a command line option and should not be translated
-            raise ArgumentError, _("Supplying a '--version' only makes sense when a Faces subcommand is given")
-          end
+        elsif args.length == 0
+          raise ArgumentError, _("Supplying a '--version' only makes sense when a Faces subcommand is given")
+          # TRANSLATORS '--version' is a command line option and should not be translated
         end
       end
 
@@ -61,20 +61,19 @@ Puppet::Face.define(:help, '0.0.1') do
         if actionname
           raise ArgumentError, _("The legacy subcommand '%{sub_command}' does not support supplying an action") % { sub_command: facename }
         end
+
         # legacy apps already emit ronn output
         return render_application_help(facename)
+      elsif options[:ronn]
+        render_face_man(facename || :help)
+      # Calling `puppet help <app> --ronn` normally calls this action with
+      # <app> as the first argument in the `args` array. However, if <app>
+      # happens to match the name of an action, like `puppet help help
+      # --ronn`, then face_base "eats" the argument and `args` will be
+      # empty. Rather than force users to type `puppet help help help
+      # --ronn`, default the facename to `:help`
       else
-        if options[:ronn]
-          # Calling `puppet help <app> --ronn` normally calls this action with
-          # <app> as the first argument in the `args` array. However, if <app>
-          # happens to match the name of an action, like `puppet help help
-          # --ronn`, then face_base "eats" the argument and `args` will be
-          # empty. Rather than force users to type `puppet help help help
-          # --ronn`, default the facename to `:help`
-          render_face_man(facename || :help)
-        else
-          render_face_help(facename, actionname, version)
-        end
+        render_face_help(facename, actionname, version)
       end
     end
   end
@@ -96,7 +95,7 @@ Puppet::Face.define(:help, '0.0.1') do
   end
 
   def render_application_help(applicationname)
-    return Puppet::Application[applicationname].help
+    Puppet::Application[applicationname].help
   rescue StandardError, LoadError => detail
     message = []
     message << _('Could not load help for the application %{application_name}.') % { application_name: applicationname }
@@ -108,7 +107,7 @@ Puppet::Face.define(:help, '0.0.1') do
 
   def render_face_help(facename, actionname, version)
     face, action = load_face_help(facename, actionname, version)
-    return template_for(face, action).result(binding)
+    template_for(face, action).result(binding)
   rescue StandardError, LoadError => detail
     message = []
     message << _('Could not load help for the face %{face_name}.') % { face_name: facename }
@@ -122,7 +121,7 @@ Puppet::Face.define(:help, '0.0.1') do
     face = Puppet::Face[facename.to_sym, version]
     if actionname
       action = face.get_action(actionname.to_sym)
-      if ! action
+      unless action
         fail ArgumentError, _("Unable to load action %{actionname} from %{face}") % { actionname: actionname, face: face }
       end
     end
@@ -142,92 +141,112 @@ Puppet::Face.define(:help, '0.0.1') do
     template = (Pathname(__FILE__).dirname + "help" + name)
     erb = Puppet::Util.create_erb(template.read)
     erb.filename = template.to_s
-    return erb
+    erb
   end
 
   # Return a list of applications that are not simply just stubs for Faces.
   def legacy_applications
     Puppet::Application.available_application_names.reject do |appname|
-      (is_face_app?(appname)) or (exclude_from_docs?(appname))
+      is_face_app?(appname) or exclude_from_docs?(appname)
     end.sort
   end
 
+  def generate_summary(appname)
+    if is_face_app?(appname)
+      begin
+        face = Puppet::Face[appname, :current]
+        # Add deprecation message to summary if the face is deprecated
+        summary = face.deprecated? ? face.summary + ' ' + _("(Deprecated)") : face.summary
+        [appname, summary, '  ']
+      rescue StandardError, LoadError
+        error_message = _("!%{sub_command}! Subcommand unavailable due to error.") % { sub_command: appname }
+        error_message += ' ' + _("Check error logs.")
+        [error_message, '', '  ']
+      end
+    else
+      begin
+        summary = Puppet::Application[appname].summary
+        if summary.empty?
+          summary = horribly_extract_summary_from(appname)
+        end
+        [appname, summary, '  ']
+      rescue StandardError, LoadError
+        error_message = _("!%{sub_command}! Subcommand unavailable due to error.") % { sub_command: appname }
+        error_message += ' ' + _("Check error logs.")
+        [error_message, '', '  ']
+      end
+    end
+  end
+
   # Return a list of all applications (both legacy and Face applications), along with a summary
   #  of their functionality.
   # @return [Array] An Array of Arrays.  The outer array contains one entry per application; each
   #  element in the outer array is a pair whose first element is a String containing the application
   #  name, and whose second element is a String containing the summary for that application.
-  def all_application_summaries()
+  def all_application_summaries
     available_application_names_special_sort().inject([]) do |result, appname|
       next result if exclude_from_docs?(appname)
 
-      if (appname == COMMON || appname == SPECIALIZED || appname == BLANK)
+      if appname == COMMON || appname == SPECIALIZED || appname == BLANK
         result << appname
-      elsif (is_face_app?(appname))
-        begin
-          face = Puppet::Face[appname, :current]
-          # Add deprecation message to summary if the face is deprecated
-          summary = face.deprecated? ? face.summary + ' ' + _("(Deprecated)") : face.summary
-          result << [appname, summary, '  ']
-        rescue StandardError, LoadError
-          error_message = _("!%{sub_command}! Subcommand unavailable due to error.") % { sub_command: appname }
-          error_message += ' ' + _("Check error logs.")
-          result << [ error_message, '', '  ' ]
-        end
       else
-        begin
-          summary = Puppet::Application[appname].summary
-          if summary.empty?
-            summary = horribly_extract_summary_from(appname)
-          end
-          result << [appname, summary, '  ']
-        rescue StandardError, LoadError
-          error_message = _("!%{sub_command}! Subcommand unavailable due to error.") % { sub_command: appname }
-          error_message += ' ' + _("Check error logs.")
-          result << [ error_message, '', '  ' ]
-        end
+        result << generate_summary(appname)
       end
     end
   end
 
-  COMMON = 'Common:'.freeze
-  SPECIALIZED = 'Specialized:'.freeze
-  BLANK = "\n".freeze
-  def available_application_names_special_sort()
+  COMMON = 'Common:'
+  SPECIALIZED = 'Specialized:'
+  BLANK = "\n"
+  COMMON_APPS = %w[apply agent config help lookup module resource]
+  def available_application_names_special_sort
     full_list = Puppet::Application.available_application_names
-    a_list = full_list & %w{apply agent config help lookup module resource}
+    a_list = full_list & COMMON_APPS
     a_list = a_list.sort
     also_ran = full_list - a_list
     also_ran = also_ran.sort
     [[COMMON], a_list, [BLANK], [SPECIALIZED], also_ran].flatten(1)
   end
 
+  def common_app_summaries
+    COMMON_APPS.map do |appname|
+      generate_summary(appname)
+    end
+  end
+
+  def specialized_app_summaries
+    specialized_apps = Puppet::Application.available_application_names - COMMON_APPS
+    specialized_apps.filter_map do |appname|
+      generate_summary(appname) unless exclude_from_docs?(appname)
+    end
+  end
+
   def horribly_extract_summary_from(appname)
     help = Puppet::Application[appname].help.split("\n")
     # Now we find the line with our summary, extract it, and return it.  This
     # depends on the implementation coincidence of how our pages are
     # formatted.  If we can't match the pattern we expect we return the empty
     # string to ensure we don't blow up in the summary. --daniel 2011-04-11
-    while line = help.shift do #rubocop:disable Lint/AssignmentInCondition
-      md = /^puppet-#{appname}\([^\)]+\) -- (.*)$/.match(line)
+    while line = help.shift # rubocop:disable Lint/AssignmentInCondition
+      md = /^puppet-#{appname}\([^)]+\) -- (.*)$/.match(line)
       if md
         return md[1]
       end
     end
-    return ''
+    ''
   end
   # This should absolutely be a private method, but for some reason it appears
   #  that you can't use the 'private' keyword inside of a Face definition.
   #  See #14205.
-  #private :horribly_extract_summary_from
+  # private :horribly_extract_summary_from
 
   def exclude_from_docs?(appname)
-    %w{face_base indirection_base report status}.include? appname
+    %w[face_base indirection_base report status].include? appname
   end
   # This should absolutely be a private method, but for some reason it appears
   #  that you can't use the 'private' keyword inside of a Face definition.
   #  See #14205.
-  #private :exclude_from_docs?
+  # private :exclude_from_docs?
 
   def is_face_app?(appname)
     clazz = Puppet::Application.find(appname)
@@ -237,6 +256,5 @@ Puppet::Face.define(:help, '0.0.1') do
   # This should probably be a private method, but for some reason it appears
   #  that you can't use the 'private' keyword inside of a Face definition.
   #  See #14205.
-  #private :is_face_app?
-
+  # private :is_face_app?
 end

data/lib/puppet/face/module/changes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Puppet::Face.define(:module, '1.0.0') do
   action(:changes) do
     summary _("Show modified files of an installed module.")
@@ -26,6 +28,7 @@ Puppet::Face.define(:module, '1.0.0') do
       unless root_path
         raise ArgumentError, _("Could not find a valid module at %{path}") % { path: path.inspect }
       end
+
       Puppet::ModuleTool::Applications::Checksummer.run(root_path, options)
     end
 
@@ -35,9 +38,7 @@ Puppet::Face.define(:module, '1.0.0') do
       else
         Puppet.warning _("%{count} files modified") % { count: return_value.size }
       end
-      return_value.map do |changed_file|
-        "#{changed_file}"
-      end.join("\n")
+      return_value.map(&:to_s).join("\n")
     end
   end
 end

data/lib/puppet/face/module/install.rb

@@ -1,4 +1,6 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 require_relative '../../../puppet/forge'
 require_relative '../../../puppet/module_tool/install_directory'
 require 'pathname'
@@ -128,18 +130,19 @@ Puppet::Face.define(:module, '1.0.0') do
       Puppet::ModuleTool::Applications::Installer.run(name, install_dir, options)
     end
 
-    when_rendering :console do |return_value, name, options|
-      if return_value[:result] == :noop
+    when_rendering :console do |return_value, name, _options|
+      case return_value[:result]
+      when :noop
         Puppet.notice _("Module %{name} %{version} is already installed.") % { name: name, version: return_value[:version] }
         exit 0
-      elsif return_value[:result] == :failure
+      when :failure
         Puppet.err(return_value[:error][:multiline])
         exit 1
       else
         tree = Puppet::ModuleTool.build_tree(return_value[:graph], return_value[:install_dir])
 
         "#{return_value[:install_dir]}\n" +
-        Puppet::ModuleTool.format_tree(tree)
+          Puppet::ModuleTool.format_tree(tree)
       end
     end
   end

data/lib/puppet/face/module/list.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
 Puppet::Face.define(:module, '1.0.0') do
   action(:list) do
@@ -63,7 +64,7 @@ Puppet::Face.define(:module, '1.0.0') do
       modules_by_path = environment.modules_by_path
 
       {
-        :environment     => environment,
+        :environment => environment,
         :modules_by_path => modules_by_path,
         :unmet_dependencies => unmet_dependencies(environment),
       }
@@ -73,7 +74,7 @@ Puppet::Face.define(:module, '1.0.0') do
       environment     = result[:environment]
       modules_by_path = result[:modules_by_path]
 
-      output = ''
+      output = ''.dup
 
       warn_unmet_dependencies(environment)
 
@@ -86,15 +87,15 @@ Puppet::Face.define(:module, '1.0.0') do
           # The modules with fewest things depending on them will be the
           # parent of the tree.  Can't assume to start with 0 dependencies
           # since dependencies may be cyclical.
-          modules_by_num_requires = modules.sort_by {|m| m.required_by.size}
+          modules_by_num_requires = modules.sort_by { |m| m.required_by.size }
           @seen = {}
           tree = list_build_tree(modules_by_num_requires, [], nil,
-            :label_unmet => true, :path => path, :label_invalid => false)
+                                 :label_unmet => true, :path => path, :label_invalid => false)
         else
           tree = []
-          modules.sort_by { |mod| mod.forge_name or mod.name  }.each do |mod|
+          modules.sort_by { |mod| mod.forge_name or mod.name }.each do |mod|
             tree << list_build_node(mod, path, :label_unmet => false,
-                      :path => path, :label_invalid => true)
+                                               :path => path, :label_invalid => true)
           end
         end
 
@@ -105,7 +106,6 @@ Puppet::Face.define(:module, '1.0.0') do
     end
   end
 
-
   def unmet_dependencies(environment)
     error_types = [:non_semantic_version, :version_mismatch, :missing]
 
@@ -117,60 +117,58 @@ Puppet::Face.define(:module, '1.0.0') do
     end
 
     # Prepare the unmet dependencies for display on the console.
-    environment.modules.sort_by {|mod| mod.name}.each do |mod|
-      unmet_grouped = Hash.new { |h,k| h[k] = [] }
-      unmet_grouped = mod.unmet_dependencies.inject(unmet_grouped) do |acc, dep|
+    environment.modules.sort_by(&:name).each do |mod|
+      unmet_grouped = Hash.new { |h, k| h[k] = [] }
+      unmet_grouped = mod.unmet_dependencies.each_with_object(unmet_grouped) do |dep, acc|
         acc[dep[:reason]] << dep
-        acc
       end
       unmet_grouped.each do |type, deps|
-        unless deps.empty?
-          unmet_grouped[type].sort_by { |dep| dep[:name] }.each do |dep|
-            dep_name           = dep[:name].tr('/', '-')
-            installed_version  = dep[:mod_details][:installed_version]
-            version_constraint = dep[:version_constraint]
-            parent_name        = dep[:parent][:name].tr('/', '-')
-            parent_version     = dep[:parent][:version]
-
-            msg = _("'%{parent_name}' (%{parent_version}) requires '%{dependency_name}' (%{dependency_version})") % { parent_name: parent_name, parent_version: parent_version, dependency_name: dep_name, dependency_version: version_constraint }
-            unmet_deps[type][dep[:name]][:errors] << msg
-            unmet_deps[type][dep[:name]][:parent] = {
-              :name    => dep[:parent][:name],
-              :version => parent_version
-            }
-            unmet_deps[type][dep[:name]][:version] = installed_version
-          end
+        next if deps.empty?
+
+        unmet_grouped[type].sort_by { |dep| dep[:name] }.each do |dep|
+          dep_name           = dep[:name].tr('/', '-')
+          installed_version  = dep[:mod_details][:installed_version]
+          version_constraint = dep[:version_constraint]
+          parent_name        = dep[:parent][:name].tr('/', '-')
+          parent_version     = dep[:parent][:version]
+
+          msg = _("'%{parent_name}' (%{parent_version}) requires '%{dependency_name}' (%{dependency_version})") % { parent_name: parent_name, parent_version: parent_version, dependency_name: dep_name, dependency_version: version_constraint }
+          unmet_deps[type][dep[:name]][:errors] << msg
+          unmet_deps[type][dep[:name]][:parent] = {
+            :name => dep[:parent][:name],
+            :version => parent_version
+          }
+          unmet_deps[type][dep[:name]][:version] = installed_version
         end
       end
     end
     unmet_deps
   end
 
-
   def warn_unmet_dependencies(environment)
     @unmet_deps = unmet_dependencies(environment)
 
     # Display unmet dependencies by category.
     error_display_order = [:non_semantic_version, :version_mismatch, :missing]
     error_display_order.each do |type|
-      unless @unmet_deps[type].empty?
-        @unmet_deps[type].keys.sort.each do |dep|
-          name    = dep.tr('/', '-')
-          errors  = @unmet_deps[type][dep][:errors]
-          version = @unmet_deps[type][dep][:version]
-
-          msg = case type
-                when :version_mismatch
-                  _("Module '%{name}' (v%{version}) fails to meet some dependencies:\n") % { name: name, version: version }
-                when :non_semantic_version
-                  _("Non semantic version dependency %{name} (v%{version}):\n") % { name: name, version: version }
-                else
-                  _("Missing dependency '%{name}':\n") % { name: name }
-                end
-
-          errors.each { |error_string| msg << "  #{error_string}\n" }
-          Puppet.warning msg.chomp
-        end
+      next if @unmet_deps[type].empty?
+
+      @unmet_deps[type].keys.sort.each do |dep|
+        name    = dep.tr('/', '-')
+        errors  = @unmet_deps[type][dep][:errors]
+        version = @unmet_deps[type][dep][:version]
+
+        msg = case type
+              when :version_mismatch
+                _("Module '%{name}' (v%{version}) fails to meet some dependencies:\n") % { name: name, version: version }
+              when :non_semantic_version
+                _("Non semantic version dependency %{name} (v%{version}):\n") % { name: name, version: version }
+              else
+                _("Missing dependency '%{name}':\n") % { name: name }
+              end
+
+        errors.each { |error_string| msg << "  #{error_string}\n" }
+        Puppet.warning msg.chomp
       end
     end
   end
@@ -211,9 +209,10 @@ Puppet::Face.define(:module, '1.0.0') do
   #     │ └── bodepd-create_resources (v0.0.1)
   #     └── puppetlabs-sqlite (v0.0.1)
   #
-  def list_build_tree(list, ancestors=[], parent=nil, params={})
-    list.map do |mod|
+  def list_build_tree(list, ancestors = [], parent = nil, params = {})
+    list.filter_map do |mod|
       next if @seen[(mod.forge_name or mod.name)]
+
       node = list_build_node(mod, parent, params)
       @seen[(mod.forge_name or mod.name)] = true
 
@@ -228,11 +227,11 @@ Puppet::Face.define(:module, '1.0.0') do
           node[:dependencies] << { :text => str }
         end
         node[:dependencies] += list_build_tree(mod.dependencies_as_modules,
-          ancestors + [mod], mod, params)
+                                               ancestors + [mod], mod, params)
       end
 
       node
-    end.compact
+    end
   end
 
   # Prepare a module object for print in a tree view.  Each node in the tree
@@ -247,7 +246,7 @@ Puppet::Face.define(:module, '1.0.0') do
   # Returns a Hash
   #
   def list_build_node(mod, parent, params)
-    str = ''
+    str = ''.dup
     str << (mod.forge_name ? mod.forge_name.tr('/', '-') : mod.name)
     str << ' (' + colorize(:cyan, mod.version ? "v#{mod.version}" : '???') + ')'
 
@@ -260,8 +259,8 @@ Puppet::Face.define(:module, '1.0.0') do
         str << '  ' + colorize(:red, _('invalid'))
       elsif parent.respond_to?(:forge_name)
         unmet_parent = @unmet_deps[:version_mismatch][mod.forge_name][:parent]
-        if (unmet_parent[:name] == parent.forge_name &&
-            unmet_parent[:version] == "v#{parent.version}")
+        if unmet_parent[:name] == parent.forge_name &&
+           unmet_parent[:version] == "v#{parent.version}"
           str << '  ' + colorize(:red, _('invalid'))
         end
       end

data/lib/puppet/face/module/uninstall.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Puppet::Face.define(:module, '1.0.0') do
   action(:uninstall) do
     summary _("Uninstall a puppet module.")

data/lib/puppet/face/module/upgrade.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
 Puppet::Face.define(:module, '1.0.0') do
   action(:upgrade) do
@@ -70,17 +71,18 @@ Puppet::Face.define(:module, '1.0.0') do
     end
 
     when_rendering :console do |return_value|
-      if return_value[:result] == :noop
+      case return_value[:result]
+      when :noop
         Puppet.notice return_value[:error][:multiline]
         exit 0
-      elsif return_value[:result] == :failure
+      when :failure
         Puppet.err(return_value[:error][:multiline])
         exit 1
       else
         tree = Puppet::ModuleTool.build_tree(return_value[:graph], return_value[:base_dir])
 
         "#{return_value[:base_dir]}\n" +
-        Puppet::ModuleTool.format_tree(tree)
+          Puppet::ModuleTool.format_tree(tree)
       end
     end
   end

data/lib/puppet/face/module.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/face'
 require_relative '../../puppet/module_tool'
 require_relative '../../puppet/util/colors'
@@ -5,7 +7,7 @@ require_relative '../../puppet/util/colors'
 Puppet::Face.define(:module, '1.0.0') do
   extend Puppet::Util::Colors
 
-  copyright "Puppet Inc.", 2012
+  copyright "Puppet Inc., Vox Pupuli", 2012
   license   _("Apache 2 license; see COPYING")
 
   summary _("Creates, installs and searches for modules on the Puppet Forge.")

data/lib/puppet/face/node/clean.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 Puppet::Face.define(:node, '0.0.1') do
   action(:clean) do
-
     summary _("Clean up signed certs, cached facts, node objects, and reports for a node stored by the puppetmaster")
     arguments _("<host1> [<host2> ...]")
     description <<-'EOT'
@@ -102,6 +103,7 @@ Puppet::Face.define(:node, '0.0.1') do
       type = environment.known_resource_types.find_definition(resource.restype)
       return true if type && type.arguments.keys.include?('ensure')
     end
-    return false
+
+    false
   end
 end

data/lib/puppet/face/node.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/indirector/face'
 Puppet::Indirector::Face.define(:node, '0.0.1') do
-  copyright "Puppet Inc.", 2011
+  copyright "Puppet Inc., Vox Pupuli", 2011
   license   _("Apache 2 license; see COPYING")
 
   summary _("View and manage node definitions.")
   description <<-'EOT'
-    This subcommand interacts with node objects, which are used by Puppet to
+    This subcommand interacts with node objects, which are used by OpenVox to
     build a catalog. A node object consists of the node's facts, environment,
     node parameters (exposed in the parser as top-scope variables), and classes.
   EOT
@@ -17,7 +19,7 @@ Puppet::Indirector::Face.define(:node, '0.0.1') do
   find = get_action(:find)
   find.summary _("Retrieve a node object.")
   find.arguments _("<host>")
-  #TRANSLATORS the following are specific names and should not be translated `classes`, `environment`, `expiration`, `name`, `parameters`, Puppet::Node
+  # TRANSLATORS the following are specific names and should not be translated `classes`, `environment`, `expiration`, `name`, `parameters`, Puppet::Node
   find.returns _(<<-'EOT')
     A hash containing the node's `classes`, `environment`, `expiration`, `name`,
     `parameters` (its facts, combined with any ENC-set parameters), and `time`.