opt_parse_validator 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2005faf0fda899b8304fc50a4c3e7d6284c6b03b
-  data.tar.gz: d36c2268f69d3a2e917e19aaa7d66fe1db9ad9bf
+  metadata.gz: 43def9fd548b86ee8844a86c29be72114c4084d1
+  data.tar.gz: 4c7e6bf5a5013eb6f3a4a2461a8e1bc5781a2099
 SHA512:
-  metadata.gz: 8e871a6e7480a37abae8c4c19e13ca364b3e2bd82968fbbf76e5e2ef04ca387ef058f7d5f658e9ed7c4098e3e7840a10fe2236973c4c77a1ba54c2b2f3710dd0
-  data.tar.gz: 71c191d035bb3e7711d5c9fd3d17cf692bad1086672f461bd8a4e6c6fd109f17a722ae7b06dd797ccbc90dd49577d8d0d50cb74ef29fc2b7959e392e2a997d03
+  metadata.gz: 0139f362ac63532f3fc770809f7e68a8db764c40dbc5fcb1463bd64abd832334b09236cb6dc7871424a08c863e179a2dc49929212802da81877d704f9b7984d6
+  data.tar.gz: bb6f8190fd84d757212fbb5c0aa7d97bd3255c3b5c6b327cbfb89167fada4fd437b7d46d63c4d7c0e00324b2785790413e68b3e044d973b55a349c34558b0604

data/lib/opt_parse_validator/errors.rb

@@ -1,4 +1,7 @@
 module OptParseValidator
-  class NoRequiredOption < StandardError
+  class Error < RuntimeError
+  end
+
+  class NoRequiredOption < Error
   end
 end

data/lib/opt_parse_validator/options_file.rb

@@ -36,12 +36,12 @@ module OptParseValidator
       file_ext       = File.extname(file_path).delete('.')
       method_to_call = "parse_#{file_ext}"
 
-      fail "The format #{file_ext} is not supported" unless respond_to?(method_to_call, true) # The true allows to check protected & private methods
+      fail Error, "The format #{file_ext} is not supported" unless respond_to?(method_to_call, true) # The true allows to check protected & private methods
 
       begin
         method(method_to_call).call(file_path)
       rescue
-        raise "Parse Error, #{file_path} seems to be malformed"
+        raise Error, "Parse Error, #{file_path} seems to be malformed"
       end
     end
 

data/lib/opt_parse_validator/opts/array.rb

@@ -1,6 +1,11 @@
 module OptParseValidator
   # Implementation of the Array Option
   class OptArray < OptBase
+    # @return [ Void ]
+    def append_help_messages
+      option << "Separator to use between the values: '#{separator}'"
+    end
+
     # @param [ String ] value
     #
     # @return [ Array ]

data/lib/opt_parse_validator/opts/base.rb

@@ -17,6 +17,13 @@ module OptParseValidator
     def initialize(option, attrs = {})
       @option = option
       @attrs  = attrs
+
+      append_help_messages if respond_to?(:append_help_messages)
+    end
+
+    # @return [ Void ]
+    def append_help_messages
+      option << "Default: #{default}" if default
     end
 
     # @return [ Boolean ]
@@ -46,7 +53,7 @@ module OptParseValidator
     # @param [ String ] value
     def validate(value)
       if value.nil? || value.to_s.empty?
-        fail 'Empty option value supplied' if value_if_empty.nil?
+        fail Error, 'Empty option value supplied' if value_if_empty.nil?
         return value_if_empty
       end
       value
@@ -76,7 +83,7 @@ module OptParseValidator
       unless @symbol
         long_option = to_long
 
-        fail "Could not find option symbol for #{option}" unless long_option
+        fail Error, "Could not find option symbol for #{option}" unless long_option
 
         @symbol = long_option.gsub(/^--/, '').gsub(/-/, '_').to_sym
       end
@@ -98,5 +105,14 @@ module OptParseValidator
     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

data/lib/opt_parse_validator/opts/boolean.rb

@@ -13,7 +13,7 @@ module OptParseValidator
       elsif value.match(FALSE_PATTERN)
         return false
       else
-        fail 'Invalid boolean value, expected true|t|yes|y|1|false|f|no|n|0'
+        fail Error, 'Invalid boolean value, expected true|t|yes|y|1|false|f|no|n|0'
       end
     end
   end

data/lib/opt_parse_validator/opts/choice.rb

@@ -6,12 +6,23 @@ module OptParseValidator
     #   :choices [ Array ] The available choices (mandatory)
     #   :case_sensitive [ Boolean ] Default: false
     def initialize(option, attrs = {})
-      fail 'The :choices attribute is mandatory' unless attrs.key?(:choices)
-      fail 'The :choices attribute must be an array' unless attrs[:choices].is_a?(Array)
+      fail Error, 'The :choices attribute is mandatory' unless attrs.key?(:choices)
+      fail Error, 'The :choices attribute must be an array' unless attrs[:choices].is_a?(Array)
 
       super(option, attrs)
     end
 
+    # @return [ Void ]
+    def append_help_messages
+      msg = 'Available choices:'
+
+      choices.each do |choice|
+        msg += choice.to_s == default ? " #{choice} (default)," : " #{choice},"
+      end
+
+      option << msg[0..-2]
+    end
+
     # @return [ String ]
     # If :case_sensitive if false (or nil), the downcased value of the choice
     # will be returned
@@ -23,7 +34,7 @@ module OptParseValidator
         choices.map!(&:downcase)
       end
 
-      fail "'#{value}' is not a valid choice, expected one " \
+      fail Error,  "'#{value}' is not a valid choice, expected one " \
            "of the followings: #{choices.join(',')}" unless choices.include?(value)
 
       value

data/lib/opt_parse_validator/opts/credentials.rb

@@ -4,7 +4,7 @@ module OptParseValidator
     # @return [ Hash ] A hash containing the :username and :password
     def validate(value)
       unless value.index(':')
-        fail 'Incorrect credentials format, username:password expected'
+        fail Error, 'Incorrect credentials format, username:password expected'
       end
       creds = value.split(':', 2)
 

data/lib/opt_parse_validator/opts/file_path.rb

@@ -18,7 +18,7 @@ module OptParseValidator
     def check_extensions(path)
       return if [*attrs[:extensions]].include?(path.extname.delete('.'))
 
-      fail "The extension of '#{path}' is not allowed"
+      fail Error, "The extension of '#{path}' is not allowed"
     end
   end
 end

data/lib/opt_parse_validator/opts/integer.rb

@@ -5,7 +5,7 @@ module OptParseValidator
     #
     # @return [ Integer ]
     def validate(value)
-      fail "#{value} is not an integer" if value.to_i.to_s != value
+      fail Error, "#{value} is not an integer" if value.to_i.to_s != value
       value.to_i
     end
   end

data/lib/opt_parse_validator/opts/integer_range.rb

@@ -1,16 +1,26 @@
 module OptParseValidator
   # Implementation of the Integer Range Option
   class OptIntegerRange < OptBase
+    # @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
+    end
+
     # @param [ String ] value
     #
     # @return [ Range ]
     def validate(value)
       a = super(value).split(separator)
 
-      fail "Incorrect number of ranges found: #{a.size}, should be 2" unless a.size == 2
-      fail 'Argument is not a valid integer range' unless a.first.to_i.to_s == a.first && a.last.to_i.to_s == a.last
+      fail Error, "Incorrect number of ranges found: #{a.size}, should be 2" unless a.size == 2
+
+      first_integer = a.first.to_i
+      last_integer  = a.last.to_i
+
+      fail Error, 'Argument is not a valid integer range' unless first_integer.to_s == a.first && last_integer.to_s == a.last
 
-      (a.first.to_i..a.last.to_i)
+      (first_integer..last_integer)
     end
 
     # @return [ String ]

data/lib/opt_parse_validator/opts/multi_choices.rb

@@ -7,12 +7,53 @@ module OptParseValidator
     # @option attrs [ Array<Array> ] :incompatible
     # @options attrs [ String ] :separator See OptArray#new
     def initialize(option, attrs = {})
-      fail 'The :choices attribute is mandatory' unless attrs.key?(:choices)
-      fail 'The :choices attribute must be a hash' unless attrs[:choices].is_a?(Hash)
+      fail Error, 'The :choices attribute is mandatory' unless attrs.key?(:choices)
+      fail Error, 'The :choices attribute must be a hash' unless attrs[:choices].is_a?(Hash)
 
       super(option, attrs)
     end
 
+    def append_help_messages
+      option << 'Available Choices:'
+
+      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
+
+      append_incomptable_help_messages
+    end
+
+    def append_choices_help_messages
+      max_spaces = choices.keys.max.size
+
+      choices.each do |key, opt|
+        first_line_prefix  = " #{key} #{' ' * (max_spaces - key.length)}"
+        other_lines_prefix = ' ' * first_line_prefix.size
+
+        opt_help_messages(opt).each_with_index do |message, index|
+          option << "#{index == 0 ? first_line_prefix : other_lines_prefix} #{message}"
+        end
+      end
+    end
+
+    # @param [ OptBase ] opt
+    #
+    # @return [ Array<String> ]
+    def opt_help_messages(opt)
+      opt.help_messages.empty? ? [opt.to_s.humanize] : opt.help_messages
+    end
+
+    def append_incomptable_help_messages
+      return if incompatible.empty?
+
+      option << 'Incompatible choices (only one of each group/s can be used):'
+
+      incompatible.each do |a|
+        option << " - #{a.map(&:to_s).join(', ')}"
+      end
+    end
+
     # @param [ String ] value
     #
     # @return [ Hash ]
@@ -42,24 +83,29 @@ module OptParseValidator
         return [opt, Regexp.last_match[1]]
       end
 
-      fail "Unknown choice: #{item}"
+      fail Error, "Unknown choice: #{item}"
+    end
+
+    # @return [ Array<Array<Symbol>> ]
+    def incompatible
+      [*attrs[:incompatible]]
     end
 
     # @param [ Hash ] values
     #
     # @return [ Hash ]
     def verify_compatibility(values)
-      [*attrs[:incompatible]].each do |a|
+      incompatible.each do |a|
         last_match = ''
 
-        a.each do |sym|
+        a.each do |key|
+          sym = choices[key].to_sym
+
           next unless values.key?(sym)
 
-          if last_match.empty?
-            last_match = sym
-          else
-            fail "Incompatible choices detected: #{last_match}, #{sym}"
-          end
+          fail Error, "Incompatible choices detected: #{last_match}, #{key}" unless last_match.empty?
+
+          last_match = key
         end
       end
       values

data/lib/opt_parse_validator/opts/path.rb

@@ -32,22 +32,22 @@ module OptParseValidator
 
     # @param [ Pathname ] path
     def check_file(path)
-      fail "'#{path}' is not a file" unless path.file? || attrs[:exists] == false
+      fail Error, "'#{path}' is not a file" unless path.file? || attrs[:exists] == false
     end
 
     # @param [ Pathname ] path
     def check_directory(path)
-      fail "'#{path}' is not a directory" unless path.directory? || attrs[:exists] == false
+      fail Error, "'#{path}' is not a directory" unless path.directory? || attrs[:exists] == false
     end
 
     # @param [ Pathname ] path
     def check_executable(path)
-      fail "'#{path}' is not executable" unless path.executable?
+      fail Error, "'#{path}' is not executable" unless path.executable?
     end
 
     # @param [ Pathname ] path
     def check_readable(path)
-      fail "'#{path}' is not readable" unless path.readable?
+      fail Error, "'#{path}' is not readable" unless path.readable?
     end
 
     # If the path does not exist, it will check for the parent
@@ -55,7 +55,7 @@ module OptParseValidator
     #
     # @param [ Pathname ] path
     def check_writable(path)
-      fail "'#{path}' is not writable" if path.exist? && !path.writable? || !path.parent.writable?
+      fail Error, "'#{path}' is not writable" if path.exist? && !path.writable? || !path.parent.writable?
     end
   end
 end

data/lib/opt_parse_validator/opts/positive_integer.rb

@@ -6,7 +6,7 @@ module OptParseValidator
     # @return [ Integer ]
     def validate(value)
       i = super(value)
-      fail "#{i} is not > 0" unless i > 0
+      fail Error, "#{i} is not > 0" unless i > 0
       i
     end
   end

data/lib/opt_parse_validator/opts/uri.rb

@@ -1,6 +1,13 @@
 module OptParseValidator
   # Implementation of the URI Option
   class OptURI < OptBase
+    # return [ Void ]
+    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
+    end
+
+    # @return [ Array<String> ]
     def allowed_protocols
       @allowed_protocols ||= [*attrs[:protocols]]
     end

data/lib/opt_parse_validator/version.rb

@@ -1,4 +1,4 @@
 # Gem Version
 module OptParseValidator
-  VERSION = '0.0.11'
+  VERSION = '0.0.12'
 end

data/lib/opt_parse_validator.rb

@@ -1,5 +1,6 @@
 # Gems
 require 'addressable/uri'
+require 'active_support/inflector'
 # Standard Libs
 require 'optparse'
 require 'pathname'
@@ -35,8 +36,7 @@ module OptParseValidator
     #
     # @return [ void ]
     def add_option(opt)
-      fail "The option is not an OptBase, #{opt.class} supplied" unless opt.is_a?(OptBase)
-      fail "The option #{opt.to_sym} is already used !" if @symbols_used.include?(opt.to_sym)
+      check_option(opt)
 
       @opts << opt
       @symbols_used << opt.to_sym
@@ -48,12 +48,23 @@ module OptParseValidator
           @results[opt.to_sym] = opt.normalize(opt.validate(arg))
         rescue => 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.class, "#{opt.to_long} #{e}"
+          raise e.is_a?(Error) ? e.class : Error, "#{opt.to_long} #{e}"
         end
       end
     end
 
+    # Ensures the opt given is valid
+    #
+    # @param [ OptBase ] opt
+    #
+    # @return [ void ]
+    def check_option(opt)
+      fail Error, "The option is not an OptBase, #{opt.class} supplied" unless opt.is_a?(OptBase)
+      fail Error, "The option #{opt.to_sym} is already used !" if @symbols_used.include?(opt.to_sym)
+    end
+
     # @return [ Hash ]
     def results(argv = default_argv)
       load_options_files

data/opt_parse_validator.gemspec

@@ -32,11 +32,12 @@ Gem::Specification.new do |s|
   s.require_paths         = ['lib']
 
   s.add_dependency 'addressable', '~> 2.3'
+  s.add_dependency 'activesupport', '~> 4.2'
 
   s.add_development_dependency 'rake', '~> 10.4'
-  s.add_development_dependency 'rspec',     '~> 3.2'
-  s.add_development_dependency 'rspec-its', '~> 1.1'
+  s.add_development_dependency 'rspec',     '~> 3.3'
+  s.add_development_dependency 'rspec-its', '~> 1.2'
   s.add_development_dependency 'bundler',   '~> 1.6'
-  s.add_development_dependency 'rubocop',   '~> 0.30'
-  s.add_development_dependency 'simplecov', '~> 0.9'
+  s.add_development_dependency 'rubocop',   '~> 0.32'
+  s.add_development_dependency 'simplecov', '~> 0.10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opt_parse_validator
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - WPScanTeam - Erwan le Rousseau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 2015-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -86,28 +100,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.30'
+        version: '0.32'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.30'
+        version: '0.32'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.10'
 description: Testing Gem ...
 email:
 - erwan.lr@gmail.com
@@ -162,8 +176,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Testing Gem
 test_files: []
+has_rdoc: