wpscanteam/OptParseValidator

# frozen_string_literal: true
 
module OptParseValidator
  # Base Option
  # This Option should not be called, children should be used.
  class OptBase
    attr_writer :required
    attr_reader :option, :attrs
 
    # @param [ Array ] option See OptionParser#on
    # @param [ Hash ] attrs
    # @option attrs  [ Boolean ] :required
    # @options attrs [ Array<Symbol>, Symbol ] :required_unless
    # @option attrs  [ Mixed ] :default The default value to use if the option is not supplied
    # @option attrs  [ Mixed ] :value_if_empty The value to use if no argument has been supplied
    # @option attrs  [ Array<Symbol> ] :normalize See #normalize
    #
    # @note The :default and :normalize 'logics' are done in OptParseValidator::OptParser#add_option
    def initialize(option, attrs = {})
      @option = option
      @attrs  = attrs
 
      # TODO: incompatible attributes, ie required and require_unless at the same time
 
      append_help_messages
    end
 
    # @return [ Void ]
    def append_help_messages
      option << "Default: #{help_message_for_default}" if default
      option << "Value if no argument supplied: #{value_if_empty}" if value_if_empty
      option << 'This option is mandatory' if required?
      option << "This option is mandatory unless #{required_unless.join(' or ')} is/are supplied" unless required_unless.empty?
    end
 
    def help_message_for_default
      default.to_s
    end
 
    # @return [ Boolean ]
    def required?
      @required ||= attrs[:required]
    end
 
    def required_unless
      @required_unless ||= Array(attrs[:required_unless])
    end
 
    # @return [ Mixed ]
    def default
      attrs[:default]
    end
 
    # @return [ Array<Mixed> ]
    def choices
      attrs[:choices]
    end
 
    # @return [ Mixed ]
    def value_if_empty
      attrs[:value_if_empty]
    end
 
    # @return [ Boolean ]
    def alias?
      false
    end
 
    # @return [ Boolean ]
    def advanced?
      attrs[:advanced] ? true : false
    end
 
    # @param [ String ] value
    def validate(value)
      if value.nil? || value.to_s.empty?
        raise Error, 'Empty option value supplied' if value_if_empty.nil?
 
        return value_if_empty
      end
      value
    end
 
    # Apply each methods from attrs[:normalize] to the value if possible
    # User input should not be used in this attrs[:normalize]
    #
    # e.g: normalize: :to_sym will return the symbol of the value
    #      normalize: [:to_sym, :upcase] Will return the upercased symbol
    #
    # @param [ Mixed ] value
    #
    # @return [ Mixed ]
Method `normalize` has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    def normalize(value)
      Array(attrs[:normalize]).each do |method|
        next unless method.is_a?(Symbol)
 
        value = value.send(method) if value.respond_to?(method)
      end
 
      value
    end
 
    # @return [ Symbol ]
    def to_sym
      unless @symbol
        long_option = to_long
 
        raise Error, "Could not find option symbol for #{option}" unless long_option
 
        @symbol = long_option.delete_prefix('--').tr('-', '_').to_sym
      end
      @symbol
    end
 
    # @return [ String ] The raw long option (e.g: --proxy)
    def to_long
      option.each do |option_attr|
        if option_attr.start_with?('--')
          return option_attr.gsub(/ .*$/, '')
                            .gsub(/\[[^\]]+\]/, '')
        end
      end
      nil
    end
 
    # @return [ String ]
    def to_s
      to_sym.to_s
    end
 
    # @return [ Array<String> ]
    def help_messages
      first_message_index = option.index { |e| e[0] != '-' }
 
      return [] unless first_message_index
 
      option[first_message_index..-1]
    end
  end
end