opt_parse_validator 0.0.14.1 → 0.0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0286c5b4aeeef23b862af3aa5f029908b5965bd1'
-  data.tar.gz: 625e42c2b8e97c9f448aec2612a6893ad0c02539
+  metadata.gz: 4781af5c07e14acc18ea3aeb507e30a695fb76f1
+  data.tar.gz: d30c05cf7536638a26646750bbf1ec35e8add56a
 SHA512:
-  metadata.gz: f7d1bd2b8315771f040b1467cd27d475151d860c898ee90b8872f16efca592de1d73f14cbe502e4556e6cc5d9438250335800cca71e8b67fa9f5ae95676cbeea
-  data.tar.gz: 59e2147c23f7ce56a749c3c124a49b7b8508d86be105a7ab7a537830c71afe8dc98da23836cec2819770e17d87b2da9ddc100dec889db2fb6fb1bbfaac4b4452
+  metadata.gz: cb916606bb5d3eee896ca9adfa54cfcaa7d77710c5d4a0a7defb2602a89b5b8ba2d20f09b386084193a77f2b22858edb8db7789f594b0e4ad8e182447b57f36d
+  data.tar.gz: '094c7bb730917e6a488490380417a5e4d3e92681c132116956150724020247c6afdbb8f44dc5ea7268c2e3922c89c4ab9df3c50a4aae653dd5121830418a884e'

data/README.md

@@ -4,7 +4,7 @@ OptParseValidator
 [![Gem Version](https://badge.fury.io/rb/opt_parse_validator.svg)](https://badge.fury.io/rb/opt_parse_validator)
 [![Build Status](https://img.shields.io/travis/wpscanteam/OptParseValidator.svg)](https://travis-ci.org/wpscanteam/OptParseValidator)
 [![Coverage Status](https://img.shields.io/coveralls/wpscanteam/OptParseValidator.svg)](https://coveralls.io/r/wpscanteam/OptParseValidator?branch=master)
-[![Code Climate](https://img.shields.io/codeclimate/github/wpscanteam/OptParseValidator.svg)](https://codeclimate.com/github/wpscanteam/OptParseValidator)
+[![Code Climate](https://api.codeclimate.com/v1/badges/56f0307bbbda6d41b99a/maintainability)](https://codeclimate.com/github/wpscanteam/OptParseValidator/maintainability)
 [![Dependency Status](https://img.shields.io/gemnasium/wpscanteam/OptParseValidator.svg)](https://gemnasium.com/wpscanteam/OptParseValidator)
 
 
@@ -19,18 +19,17 @@ OptParseValidator
 
 require 'opt_parse_validator'
 
-# For contructor options, such as setting a banner, the summary width and indent,
-# see http://ruby-doc.org/stdlib-2.4.2/libdoc/optparse/rdoc/OptionParser.html#method-c-new
-parser = OptParseValidator::OptParser.new
-
-parser.add(
-  OptParseValidator::OptString.new(['-m', '--mandatory PARAM', 'A Mandatory CLI option'], required: true),
-  OptParseValidator::OptBoolean.new(['--test', '-t', 'Option Helper Message']),
-  OptParseValidator::OptFilePath.new(['-o', '--output FILE', 'Output to FILE'], writable: true, exists: false)
-)
-
 begin
-  p parser.results
+  # For constructor options, such as setting a banner, the summary width and indent,
+  # see http://ruby-doc.org/stdlib-2.4.2/libdoc/optparse/rdoc/OptionParser.html#method-c-new
+  parsed_cli_options = OptParseValidator::OptParser.new.add(
+    OptParseValidator::OptString.new(['-m', '--mandatory PARAM', 'A Mandatory CLI option'], required: true),
+    OptParseValidator::OptBoolean.new(['--test', '-t', 'Option Helper Message']),
+    OptParseValidator::OptFilePath.new(['-o', '--output FILE', 'Output to FILE'], writable: true, exists: false),
+    OptParseValidator::OptAlias.new(['--alias', '-a'], alias_for: '--test -o file.txt')
+  ).results
+
+  p parsed_cli_options
 rescue OptParseValidator::Error => e
   puts 'Parsing Error: ' + e.message
 end
@@ -41,11 +40,13 @@ Then have a play with
 ```ruby test.rb -m hh -t```
 ```ruby test.rb -t```
 
+It is worth to note that when aliases are used, it is recommended to provide them first in the CLI. Otherwise, they might override user-suplied cli options. For example, using the options above, ```ruby test.rb -m aa -o override.txt --alias``` won't have the desired effect (to have --output as override.txt), but ```ruby test.rb --alias -m aa -o override.txt``` will.
+
 For more option examples, see
  - https://github.com/wpscanteam/CMSScanner/blob/master/app/controllers/core/cli_options.rb
  - https://github.com/wpscanteam/wpscan-v3/blob/master/app/controllers/enumeration/cli_options.rb
 
-Please Feel free to send Pull Requests to improve this Readme
+Please feel free to send Pull Requests to improve this Readme
 
 ### Global Attributes
 
@@ -56,6 +57,8 @@ Some attributes are available for all Validators:
 - :value_if_empty (Value to use if no argument has been supplied for the related option)
 
 ### Available Validators & Associated Attributes:
+- Alias:
+  - :alias_for (mandatory)
 - Array
   - :separator (default: ',')
 - Boolean

data/lib/opt_parse_validator/opts/alias.rb

@@ -0,0 +1,26 @@
+module OptParseValidator
+  # Implementation of the Alias Option
+  class OptAlias < OptBase
+    def initialize(option, attrs = {})
+      raise Error, 'The :alias_for attribute is required' unless attrs.key?(:alias_for)
+
+      super(option, attrs)
+    end
+
+    def append_help_messages
+      super
+
+      option << "Alias for #{alias_for}"
+    end
+
+    # @return [ String ]
+    def alias_for
+      @alias_for ||= attrs[:alias_for]
+    end
+
+    # @return [ Boolean ]
+    def alias?
+      true
+    end
+  end
+end

data/lib/opt_parse_validator/opts/base.rb

@@ -55,6 +55,11 @@ module OptParseValidator
       attrs[:value_if_empty]
     end
 
+    # @return [ Boolean ]
+    def alias?
+      false
+    end
+
     # @param [ String ] value
     def validate(value)
       if value.nil? || value.to_s.empty?

data/lib/opt_parse_validator/opts/credentials.rb

@@ -3,9 +3,8 @@ module OptParseValidator
   class OptCredentials < OptBase
     # @return [ Hash ] A hash containing the :username and :password
     def validate(value)
-      unless value.index(':')
-        raise Error, 'Incorrect credentials format, username:password expected'
-      end
+      raise Error, 'Incorrect credentials format, username:password expected' unless value.index(':')
+
       creds = value.split(':', 2)
 
       { username: creds[0], password: creds[1] }

data/lib/opt_parse_validator/opts/uri.rb

@@ -25,9 +25,7 @@ module OptParseValidator
     def validate(value)
       uri = Addressable::URI.parse(value)
 
-      if !uri.scheme && default_protocol
-        uri = Addressable::URI.parse("#{default_protocol}://#{value}")
-      end
+      uri = Addressable::URI.parse("#{default_protocol}://#{value}") if !uri.scheme && default_protocol
 
       unless allowed_protocols.empty? || allowed_protocols.include?(uri.scheme)
         # For future refs: will have to check if the uri.scheme exists,

data/lib/opt_parse_validator/opts.rb

@@ -1,7 +1,7 @@
 %w[
   base string integer positive_integer choice boolean uri url proxy credentials
   path file_path directory_path array integer_range multi_choices regexp headers
-  smart_list
+  smart_list alias
 ].each do |opt|
   require 'opt_parse_validator/opts/' + opt
 end

data/lib/opt_parse_validator/version.rb

@@ -1,4 +1,4 @@
 # Gem Version
 module OptParseValidator
-  VERSION = '0.0.14.1'.freeze
+  VERSION = '0.0.15.0'.freeze
 end

data/lib/opt_parse_validator.rb

@@ -25,46 +25,30 @@ module OptParseValidator
       super(banner, width, indent)
     end
 
-    # @param [ OptBase ] options
-    #
-    # @return [ void ]
-    def add(*options)
-      options.each { |option| add_option(option) }
+    # @return [ OptParseValidator::OptionsFiles ]
+    def options_files
+      @options_files ||= OptionsFiles.new
     end
 
-    # @param [ OptBase ] opt
+    # @param [ Array<OptBase> ] options
     #
-    # @return [ void ]
-    def add_option(opt)
-      check_option(opt)
+    # @return [ Self ] For chaining #new.add.results
+    def add(*options)
+      options.each do |option|
+        check_option(option)
 
-      @opts << opt
-      @symbols_used << opt.to_sym
-      # Set the default option value if it exists
-      # The default value is not validated as provided by devs
-      # and should be set to the correct format/value directly
-      @results[opt.to_sym] = opt.default unless opt.default.nil?
+        @opts << option
+        @symbols_used << option.to_sym
 
-      on(*opt.option) do |arg|
-        begin
-          @results[opt.to_sym] = opt.normalize(opt.validate(arg))
-        rescue StandardError => e
-          # Adds the long option name to the message
-          # And raises it as an OptParseValidator::Error if not already one
-          # e.g --proxy Invalid Scheme format.
-          raise e.is_a?(Error) ? e.class : Error, "#{opt.to_long} #{e}"
-        end
+        # Set the default option value if it exists
+        # The default value is not validated as it is provided by devs
+        # and should be set to the correct format/value directly
+        @results[option.to_sym] = option.default unless option.default.nil?
+
+        register_callback(option)
       end
-    end
 
-    # Ensures the opt given is valid
-    #
-    # @param [ OptBase ] opt
-    #
-    # @return [ void ]
-    def check_option(opt)
-      raise Error, "The option is not an OptBase, #{opt.class} supplied" unless opt.is_a?(OptBase)
-      raise Error, "The option #{opt.to_sym} is already used !" if @symbols_used.include?(opt.to_sym)
+      self
     end
 
     # @return [ Hash ]
@@ -79,6 +63,38 @@ module OptParseValidator
       raise e.is_a?(Error) ? e.class : Error, e.message
     end
 
+    protected
+
+    # Ensures the opt given is valid
+    #
+    # @param [ OptBase ] opt
+    #
+    # @return [ void ]
+    def check_option(opt)
+      raise Error, "The option is not an OptBase, #{opt.class} supplied" unless opt.is_a?(OptBase)
+      raise Error, "The option #{opt.to_sym} is already used !" if @symbols_used.include?(opt.to_sym)
+    end
+
+    # @param [ OptBase ] opt
+    #
+    # @return [ void ]
+    def register_callback(opt)
+      on(*opt.option) do |arg|
+        begin
+          if opt.alias?
+            parse!(opt.alias_for.split(' '))
+          else
+            @results[opt.to_sym] = opt.normalize(opt.validate(arg))
+          end
+        rescue StandardError => e
+          # Adds the long option name to the message
+          # And raises it as an OptParseValidator::Error if not already one
+          # e.g --proxy Invalid Scheme format.
+          raise e.is_a?(Error) ? e.class : Error, "#{opt.to_long} #{e}"
+        end
+      end
+    end
+
     # @return [ Void ]
     def load_options_files
       files_data = options_files.parse
@@ -90,23 +106,15 @@ module OptParseValidator
       end
     end
 
-    # @return [ OptParseValidator::OptionsFiles ]
-    def options_files
-      @options_files ||= OptionsFiles.new
-    end
-
     # Ensure that all required options are supplied
     # Should be overriden to modify the behavior
     #
     # @return [ Void ]
     def post_processing
       @opts.each do |opt|
-        if opt.required?
-          raise NoRequiredOption, "The option #{opt} is required" unless @results.key?(opt.to_sym)
-        end
+        raise NoRequiredOption, "The option #{opt} is required" if opt.required? && !@results.key?(opt.to_sym)
 
-        next if opt.required_unless.empty?
-        next if @results.key?(opt.to_sym)
+        next if opt.required_unless.empty? || @results.key?(opt.to_sym)
 
         fail_msg = "One of the following options is required: #{opt}, #{opt.required_unless.join(', ')}"
 

data/opt_parse_validator.gemspec

@@ -41,6 +41,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake', '~> 12.0'
   s.add_development_dependency 'rspec',     '~> 3.7.0'
   s.add_development_dependency 'rspec-its', '~> 1.2.0'
-  s.add_development_dependency 'rubocop',   '~> 0.51.0'
+  s.add_development_dependency 'rubocop',   '~> 0.52.0'
   s.add_development_dependency 'simplecov', '~> 0.14.0' # Can't update to 0.15 as it breaks coveralls dep
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opt_parse_validator
 version: !ruby/object:Gem::Version
-  version: 0.0.14.1
+  version: 0.0.15.0
 platform: ruby
 authors:
 - WPScanTeam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-08 00:00:00.000000000 Z
+date: 2018-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.52.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.52.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -155,6 +155,7 @@ files:
 - lib/opt_parse_validator/options_file/yml.rb
 - lib/opt_parse_validator/options_files.rb
 - lib/opt_parse_validator/opts.rb
+- lib/opt_parse_validator/opts/alias.rb
 - lib/opt_parse_validator/opts/array.rb
 - lib/opt_parse_validator/opts/base.rb
 - lib/opt_parse_validator/opts/boolean.rb