Merge pull request rapid7#20127 from bcoles/lib-msf-core-option_container

Msf::OptionContainer: Replace `.sorted` Array attribute with `self.sort`

Author: smcintyre-r7

lib/msf/core/option_container.rb

@@ -50,12 +50,18 @@ class OptionContainer < Hash
     # as necessary.
     #
     def initialize(opts = {})
-      self.sorted = []
       self.groups = {}
 
       add_options(opts)
     end
 
+    #
+    # Return the sorted array of options.
+    #
+    def sorted
+      self.sort
+    end
+
     #
     # Return the value associated with the supplied name.
     #
@@ -116,10 +122,6 @@ def has_evasion_options?
     # @param [String] name the option name
     def remove_option(name)
       delete(name)
-      sorted.each_with_index { |e, idx|
-        sorted[idx] = nil if (e[0] == name)
-      }
-      sorted.delete(nil)
     end
 
     #
@@ -170,9 +172,6 @@ def add_option(option, name = nil, owner = nil, advanced = false, evasion = fals
       option.owner    = owner
 
       self.store(option.name, option)
-
-      # Re-calculate the sorted list
-      self.sorted = self.sort
     end
 
     #
@@ -330,18 +329,11 @@ def remove_group(group_name)
       groups.delete(group_name)
     end
 
-    #
-    # The sorted array of options.
-    #
-    attr_reader :sorted
-
     # @return [Hash<String, Msf::OptionGroup>]
     attr_reader :groups
 
     protected
 
-    attr_writer :sorted # :nodoc:
-
     attr_writer :groups
   end
 

lib/msf/ui/console/module_option_tab_completion.rb

@@ -78,7 +78,7 @@ def tab_complete_option_names(mod, str, words)
             return res
           end
 
-          mod.options.sorted.each do |e|
+          mod.options.each do |e|
             name, _opt = e
             res << name
           end
@@ -101,7 +101,7 @@ def tab_complete_option_names(mod, str, words)
           if ((mod.exploit? || mod.evasion?) && mod.datastore['PAYLOAD'])
             p = framework.payloads.create(mod.datastore['PAYLOAD'])
             if p
-              p.options.sorted.each do |e|
+              p.options.each do |e|
                 name, _opt = e
                 res << name
               end
@@ -119,7 +119,8 @@ def tab_complete_option_names(mod, str, words)
               end
             end
           end
-          return res
+
+          return res.sort
         end
 
         #