opt_parse_validator 0.0.13.8 → 0.0.13.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8b96bf2df00c21b5dd5be7b553495196f7f7190
-  data.tar.gz: 7091246c62fe01bb6a1437ba265ef5d755409d46
+  metadata.gz: d415463f07cdf6040286e6d663e30e595dd1baa5
+  data.tar.gz: afd3bdd186e2509e4b7374c6922eba90c37cc350
 SHA512:
-  metadata.gz: '0338d5ddadd4aeef34af392f5aa3d51ada1deb93cffe3f04cb7fb86073c6c8613e8b9b70f78b833a2106e2ff9ac35605b9b65b792cb3f66eb2ecf859c7fcea5f'
-  data.tar.gz: b0641b222b4f7ff8136e5bfaa4d6fb2d2e61543ed1fd915e526470b4ae03282b38ac9ee143bce8f077f0f9180053bbd17fbc021028cc3b7e22f8a6c09a05d317
+  metadata.gz: a8a1f3f9423004010b3063deac7ad196f054b1a8b5f3ca2d4a06465312a292051b384c007aa65a1556ba594cd49621fe52dc855d255195ca04cd3bc5fd1e23ec
+  data.tar.gz: 47629f4e35fa33ad43c2ac16682a6ef32b040828f62886259f4289ecefda410a75f46b8e0ad32fed09d1bd97335183e24a3bfe10333afe12736823a5c964fb73

data/README.md

@@ -47,6 +47,14 @@ For more option examples, see
 
 Please Feel free to send Pull Requests to improve this Readme
 
+### Global Attributes
+
+Some attributes are available for all Validators:
+- :required (whether or not the associated cli option is required/mandatory - [example](https://github.com/wpscanteam/CMSScanner/blob/master/app/controllers/core/cli_options.rb#L9)).
+- :required_unless (like the above, except if the option/s given in this parameter are called in the CLI - [example](https://github.com/wpscanteam/wpscan-v3/blob/master/app/controllers/core.rb#L7), can be a single symbol or array of symbols)
+- :default (Default value to use if the option is not supplied)
+- :value_if_empty (Value to use if no argument has been supplied for the related option)
+
 ### Available Validators & Associated Attributes:
 - Array
   - :separator (default: ',')
@@ -72,7 +80,6 @@ Please Feel free to send Pull Requests to improve this Readme
 - MultiChoices
   - choices (mandatory)
   - separator (default: ',')
-  - value_if_empty
   - incompatible
 - Positive Integer
 - Path
@@ -87,6 +94,8 @@ Please Feel free to send Pull Requests to improve this Readme
   - :default_protocol
 - Regexp:
   - :options (See http://ruby-doc.org/core-2.2.1/Regexp.html#method-c-new)
+- SmartList
+  - separator (default: ',')
 - String
 - URI
   - :protocols

data/lib/opt_parse_validator/opts.rb

@@ -1,6 +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
 ].each do |opt|
   require 'opt_parse_validator/opts/' + opt
 end

data/lib/opt_parse_validator/opts/array.rb

@@ -4,6 +4,8 @@ module OptParseValidator
     # @return [ Void ]
     def append_help_messages
       option << "Separator to use between the values: '#{separator}'"
+
+      super
     end
 
     # @param [ String ] value

data/lib/opt_parse_validator/opts/base.rb

@@ -10,7 +10,7 @@ module OptParseValidator
     # @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 arguments have been 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
@@ -18,12 +18,17 @@ module OptParseValidator
       @option = option
       @attrs  = attrs
 
-      append_help_messages if respond_to?(:append_help_messages)
+      # TODO: incompatible attributes, ie required and require_unless at the same time
+
+      append_help_messages
     end
 
     # @return [ Void ]
     def append_help_messages
       option << "Default: #{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
 
     # @return [ Boolean ]

data/lib/opt_parse_validator/opts/choice.rb

@@ -14,13 +14,9 @@ module OptParseValidator
 
     # @return [ Void ]
     def append_help_messages
-      msg = 'Available choices:'
+      super
 
-      choices.each do |choice|
-        msg += choice.to_s == default.to_s ? " #{choice} (default)," : " #{choice},"
-      end
-
-      option << msg[0..-2]
+      option << "Available choices: #{choices.join(', ')}"
     end
 
     # @return [ String ]

data/lib/opt_parse_validator/opts/headers.rb

@@ -3,6 +3,8 @@ module OptParseValidator
   class OptHeaders < OptBase
     # @return [ Void ]
     def append_help_messages
+      super
+
       option << "Separator to use between the headers: '; '"
       option << "Examples: 'X-Forwarded-For: 127.0.0.1', 'X-Forwarded-For: 127.0.0.1; Another: aaa'"
     end

data/lib/opt_parse_validator/opts/integer_range.rb

@@ -4,7 +4,8 @@ module OptParseValidator
     # @return [ Void ]
     def append_help_messages
       option << "Range separator to use: '#{separator}'"
-      option << "If no range is supplied, #{value_if_empty} will be used" if value_if_empty
+
+      super
     end
 
     # @param [ String ] value

data/lib/opt_parse_validator/opts/multi_choices.rb

@@ -18,8 +18,7 @@ module OptParseValidator
 
       append_choices_help_messages
 
-      option << "Multiple choices can be supplied, use the '#{separator}' char as a separator"
-      option << "If no choice is supplied, '#{value_if_empty}' will be used" if value_if_empty
+      super
 
       append_incompatible_help_messages
     end

data/lib/opt_parse_validator/opts/smart_list.rb

@@ -0,0 +1,28 @@
+module OptParseValidator
+  # Implementation of the SmartList Option
+  # Such option allow users to supply a list like
+  # - name1
+  # - name1,name2,name3
+  # - /tmp/names.txt
+  class OptSmartList < OptArray
+    # @return [ Void ]
+    def append_help_messages
+      super
+      # removes the help message from OptArray about the separator as useless here
+      # can't use option as it's an attr_reader only
+      @option -= ["Separator to use between the values: '#{separator}'"]
+
+      option << "Examples: 'a1', '#{%w[a1 a2 a3].join(separator)}', '/tmp/a.txt'"
+    end
+
+    # @param [ String ] value
+    #
+    # @return [ Array<String> ]
+    def validate(value)
+      # Might be a better way to do this especially with a big file
+      File.open(value).map(&:chomp)
+    rescue Errno::ENOENT
+      super(value)
+    end
+  end
+end

data/lib/opt_parse_validator/opts/uri.rb

@@ -5,6 +5,8 @@ module OptParseValidator
     def append_help_messages
       option << "Allowed Protocols: #{allowed_protocols.join(', ')}" unless allowed_protocols.empty?
       option << "Default Protocol if none provided: #{default_protocol}" if default_protocol
+
+      super
     end
 
     # @return [ Array<String> ]

data/lib/opt_parse_validator/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opt_parse_validator
 version: !ruby/object:Gem::Version
-  version: 0.0.13.8
+  version: 0.0.13.9
 platform: ruby
 authors:
 - WPScanTeam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-04 00:00:00.000000000 Z
+date: 2017-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -170,6 +170,7 @@ files:
 - lib/opt_parse_validator/opts/positive_integer.rb
 - lib/opt_parse_validator/opts/proxy.rb
 - lib/opt_parse_validator/opts/regexp.rb
+- lib/opt_parse_validator/opts/smart_list.rb
 - lib/opt_parse_validator/opts/string.rb
 - lib/opt_parse_validator/opts/uri.rb
 - lib/opt_parse_validator/opts/url.rb