Renamed CLI::PayloadType to CLI::Text.

Author: postmodern

lib/ronin/payloads/cli/commands/build.rb

@@ -22,7 +22,7 @@
 require_relative '../payload_command'
 require_relative '../format_option'
 require_relative '../encoder_methods'
-require_relative '../payload_type'
+require_relative '../text'
 
 require 'ronin/core/cli/options/param'
 
@@ -61,7 +61,7 @@ class Build < PayloadCommand
           include FormatOption
           include EncoderMethods
           include Core::CLI::Options::Param
-          include PayloadType
+          include Text
 
           option :output, short: '-o',
                           value: {

lib/ronin/payloads/cli/commands/show.rb

@@ -20,7 +20,7 @@
 #
 
 require_relative '../payload_command'
-require_relative '../payload_type'
+require_relative '../text'
 require_relative '../../metadata/arch'
 require_relative '../../metadata/os'
 
@@ -59,7 +59,7 @@ class Show < PayloadCommand
           include Core::CLI::Printing::OS
           include Core::CLI::Printing::Params
           include CommandKit::Printing::Fields
-          include PayloadType
+          include Text
 
           description 'Prints information about a payload'
 

lib/ronin/payloads/cli/payload_type.rb lib/ronin/payloads/cli/text.rblib/ronin/payloads/cli/payload_type.rb renamed to lib/ronin/payloads/cli/text.rb

@@ -23,13 +23,12 @@ module Ronin
   module Payloads
     class CLI
       #
-      # Handles converting a payload's {Payload.payload_type payload_type} into
-      # a printable display name.
+      # Methods for generating display text.
       #
       # @since 0.3.0
       #
-      module PayloadType
-        # Known payload types and their printable names.
+      module Text
+        # Known payload types and their display names.
         PAYLOAD_TYPES = {
           payload: 'Custom',
 
@@ -67,13 +66,13 @@ module PayloadType
         }
 
         #
-        # Returns the printable payload type for the payload class.
+        # Returns the payload type display name for the payload class.
         #
         # @param [Class<Payload>] payload_class
         #   The payload class.
         #
         # @return [String]
-        #   The printable payload type (ex: 'ASM' or 'shellcode').
+        #   The payload type display name (ex: 'ASM' or 'shellcode').
         #
         def payload_type(payload_class)
           PAYLOAD_TYPES.fetch(payload_class.payload_type,'Unknown')

spec/cli/payload_type_spec.rb spec/cli/text_spec.rbspec/cli/payload_type_spec.rb renamed to spec/cli/text_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'ronin/payloads/cli/payload_type'
+require 'ronin/payloads/cli/text'
 require 'ronin/payloads/cli/command'
 
 require 'ronin/payloads/binary_payload'
@@ -25,14 +25,14 @@
 require 'ronin/payloads/xml_payload'
 require 'ronin/payloads/mixins/typescript'
 
-describe Ronin::Payloads::CLI::PayloadType do
-  module TestCLIPrinting
+describe Ronin::Payloads::CLI::Text do
+  module TestCLIText
     class TestCommand < Ronin::Payloads::CLI::Command
-      include Ronin::Payloads::CLI::PayloadType
+      include Ronin::Payloads::CLI::Text
     end
   end
 
-  let(:command_class) { TestCLIPrinting::TestCommand }
+  let(:command_class) { TestCLIText::TestCommand }
   subject { command_class.new }
 
   describe "#payload_type" do