opt_parse_validator 0.0.16.3 → 0.0.16.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a36bc45859bac57180decb1ac24e22070c6d42a6
-  data.tar.gz: 7220c487c0a8ed6bec72f19d60e634663ea7cdf3
+  metadata.gz: 4db0514a69c11f2c171f1e5647fbdfe93d932993
+  data.tar.gz: 5a22eaa6aa48b06f1317178ad00e73540a576a76
 SHA512:
-  metadata.gz: bf1b6eef1a17529c31d0ebe1c4d2650f52c4f023228398175e703d2844375a33f556786cfd5d47bc996234faf4eb43a3886355665f176efb41475d8adb2f0853
-  data.tar.gz: 193a1ecbd35c6a30d1987db27fc060389525cdc7c3b7b1e2bc500f880c62dd26225a60289b8172bbc0cae9caf8c611cc75fbe57146590d43171bfdb48ba71ff4
+  metadata.gz: a660a58bb66d6a0013f366b337016bdffb23c36d520ec1db5cffe2bec6fd8807445ccb2e81fed594437692fec09a419c099f3e1a3ccd8368860bb3207e478d7e
+  data.tar.gz: a7994dfd31552f5d8c972593b44e167c741cd6d80f5ddec73447ba5c887619dd0964be66b4b05deac952470aa9b95c70f7dae86689cf1854a650043c7bb0c04c

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2014-2015 - WPScanTeam
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,110 @@
+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://api.codeclimate.com/v1/badges/56f0307bbbda6d41b99a/maintainability)](https://codeclimate.com/github/wpscanteam/OptParseValidator/maintainability)
+
+
+### Installation
+
+```gem install opt_parse_validator```
+
+### Usage Example
+
+```ruby
+# test.rb
+
+require 'opt_parse_validator'
+
+begin
+  # 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
+```
+
+Then have a play with
+```ruby test.rb -h```
+```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/blob/master/app/controllers/enumeration/cli_options.rb
+
+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/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, the correct format has to be used as it won't go through the validation and normalization processes)
+- :value_if_empty (Value to use if no argument has been supplied for the related option)
+- :advanced (Whether or or not the option is an advanced one. If set to true, the option won't be displayed in the #simple_help, but will in the #full_help)
+
+### Available Validators & Associated Attributes:
+- Alias:
+  - :alias_for (mandatory)
+- Array
+  - :separator (default: ',')
+- Boolean
+- Choice
+  - :choices (mandatory)
+  - :case_sensitive
+- Credentials
+- Directory Path
+  - :create
+  - :exists
+  - :executable
+  - :readable
+  - :writable
+- File Path
+  - :create
+  - :exists
+  - :executable
+  - :readable
+  - :writable
+- Headers
+- Integer
+- IntegerRange
+  - separator (default: '-')
+- MultiChoices
+  - choices (mandatory)
+  - separator (default: ',')
+  - incompatible
+- Positive Integer
+- Path
+  - :create
+  - :file
+  - :directory
+  - :exists
+  - :executable
+  - :readable
+  - :writable
+- Proxy
+  - :protocols
+  - :default_protocol
+- Regexp:
+  - :options (See http://ruby-doc.org/core-2.2.1/Regexp.html#method-c-new)
+- SmartList
+  - separator (default: ',')
+- String
+- URI
+  - :protocols
+  - :default_protocol
+- URL
+  - :default_protocol

data/lib/opt_parse_validator/opts/base.rb

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

data/lib/opt_parse_validator/version.rb

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

data/lib/opt_parse_validator.rb

@@ -64,6 +64,31 @@ module OptParseValidator
       raise e.is_a?(Error) ? e.class : Error, e.message
     end
 
+    # @return [ String ] The simplified help (without any of the advanced option/s listed)
+    def simple_help
+      help = to_s
+
+      # Removes all advanced help messages
+      @opts.select(&:advanced?).each do |opt|
+        messages_pattern = //
+
+        opt.help_messages.each do |msg|
+          messages_pattern = /#{messages_pattern}\s*#{Regexp.escape(msg)}/
+        end
+
+        pattern = /\s*#{Regexp.escape(opt.option[0..1].select { |o| o[0] == '-' }.join(', '))}#{messages_pattern}/
+
+        help.gsub!(pattern, '')
+      end
+
+      help
+    end
+
+    # @return [ String ] The full help, with the advanced option/s listed
+    def full_help
+      to_s
+    end
+
     protected
 
     # Ensures the opt given is valid

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opt_parse_validator
 version: !ruby/object:Gem::Version
-  version: 0.0.16.3
+  version: 0.0.16.4
 platform: ruby
 authors:
 - WPScanTeam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-28 00:00:00.000000000 Z
+date: 2018-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -144,6 +144,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/opt_parse_validator.rb
 - lib/opt_parse_validator/errors.rb
 - lib/opt_parse_validator/hacks.rb