opt_parse_validator 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da564ea023221e95e2ef0ee45258754314e7bcd8
-  data.tar.gz: e23c41c855f934d09205ce95b5231d4e5a781568
+  metadata.gz: 9f71cf9bbecec6b8c33d14c3cab01c0af1112735
+  data.tar.gz: d033f1ef4649cd628d415657c2375d014616a3b2
 SHA512:
-  metadata.gz: bb975e401d8c2b44c46d0c7b242a9f6050e37ea74fff3ec3759339f6ee2f65edbedf56e67198e0a16c7a4eed8b3f1dc9387042400eb69f4309d07119917617da
-  data.tar.gz: 1b1bce2783b48eb104edf9e35a921cbed61c3ddbd527bcbf571ae915e1fa6c356668497ce8710def3cf9efbf3e157087f6d4928626f454e7af1e9f3d4e01c7f0
+  metadata.gz: 63b1f0f830f821e9639b5a6c239c20a472ba9fef16850fb7c37eabf54d589ca463bd30f087a7da906d9ee458a12a23f7162976a0d033a32c06aaec9531f9645a
+  data.tar.gz: 66311acd02e0b17a87d653e5b12609d94a5138e7a1a915e63a401c23004e9c00499c236cf376bf33603f3135f15c38f4e40af229dcb0a4552f1131d3bed98aff

data/README.md

@@ -26,6 +26,11 @@ OptParseValidator
   - :readable
   - :writable
 - Integer
+- IntegerRange
+  - separator (default: '-')
+- MultiChoices
+  - choices (mandatory)
+  - separator (default: ',')
 - Positive Integer
 - Path
   - :file
@@ -37,8 +42,6 @@ OptParseValidator
 - Proxy
   - :protocols
   - :default_protocol
-- Scope
-  - separator (default: ',')
 - String
 - URI
   - :protocols

data/lib/opt_parse_validator/opts/array.rb

@@ -5,8 +5,7 @@ module OptParseValidator
     #
     # @return [ Array ]
     def validate(value)
-      super(value)
-      value.split(separator)
+      super(value).split(separator)
     end
 
     # @return [ String ] The separator used to split the string into an array
@@ -15,7 +14,7 @@ module OptParseValidator
     end
 
     # See OptBase#normalize
-    # @param [ Array ] value
+    # @param [ Array ] values
     def normalize(values)
       values.each_with_index do |value, index|
         values[index] = super(value)

data/lib/opt_parse_validator/opts/base.rb

@@ -9,7 +9,7 @@ module OptParseValidator
     # @param [ Hash ] attrs
     # @option attrs [ Boolean ] :required
     # @option attrs [ Mixed ] :default The default value to use if the option is not supplied
-    # @option attrs [ Boolean ] :to_sym If true, returns the symbol of the validated value
+    # @option attrs [ Mixed ] :value_if_empty The value to use if no arguments have been supplied
     # @option attrs [ Array<Symbol> ] :normalize See #normalize
     #
     # @note The :default and :normalize 'logics' are done in OptParseValidator::OptParser#add_option
@@ -20,12 +20,30 @@ module OptParseValidator
 
     # @return [ Boolean ]
     def required?
-      @required || attrs[:required]
+      @required ||= attrs[:required]
+    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
 
     # @param [ String ] value
     def validate(value)
-      fail 'Empty option value supplied' if value.nil? || value.to_s.empty?
+      if value.nil? || value.to_s.empty?
+        fail 'Empty option value supplied' if value_if_empty.nil?
+        return value_if_empty
+      end
       value
     end
 

data/lib/opt_parse_validator/opts/choice.rb

@@ -16,8 +16,7 @@ module OptParseValidator
     # If :case_sensitive if false (or nil), the downcased value of the choice
     # will be returned
     def validate(value)
-      value   = value.to_s
-      choices = attrs[:choices]
+      value = value.to_s
 
       unless attrs[:case_sensitive]
         value.downcase!

data/lib/opt_parse_validator/opts/integer_range.rb

@@ -0,0 +1,21 @@
+module OptParseValidator
+  # Implementation of the Integer Range Option
+  class OptIntegerRange < OptBase
+    # @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
+
+      (a.first.to_i..a.last.to_i)
+    end
+
+    # @return [ String ]
+    def separator
+      attrs[:separator] || '-'
+    end
+  end
+end

data/lib/opt_parse_validator/opts/multi_choices.rb

@@ -0,0 +1,52 @@
+module OptParseValidator
+  # Implementation of the MultiChoices Option
+  class OptMultiChoices < OptArray
+    # @param [ Array ] option See OptBase#new
+    # @param [ Hash ] attrs
+    # @option attrs [ Hash ] :choices
+    # @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)
+
+      super(option, attrs)
+    end
+
+    # @param [ String ] value
+    #
+    # @return [ Hash ]
+    def validate(value)
+      results = {}
+
+      super(value).each do |item|
+        opt = choices[item.to_sym]
+
+        if opt
+          opt_value = opt.value_if_empty.nil? ? true : opt.value_if_empty
+        else
+          opt, opt_value = value_from_pattern(item)
+        end
+
+        results[opt.to_sym] = opt.normalize(opt.validate(opt_value))
+      end
+
+      results
+    end
+
+    # @return [ Array ]
+    def value_from_pattern(item)
+      choices.each do |key, opt|
+        next unless item.match(/\A#{key.to_s}(.*)\z/)
+
+        return [opt, Regexp.last_match[1]]
+      end
+
+      fail "Unknown choice: #{item}"
+    end
+
+    # No normalization
+    def normalize(value)
+      value
+    end
+  end
+end

data/lib/opt_parse_validator/opts.rb

@@ -1,6 +1,6 @@
 %w(
   base string integer positive_integer choice boolean uri url proxy credentials
-  path file_path directory_path array
+  path file_path directory_path array integer_range multi_choices
 ).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.6'
+  VERSION = '0.0.7'
 end

data/lib/opt_parse_validator.rb

@@ -40,7 +40,7 @@ module OptParseValidator
       @opts         << opt
       @symbols_used << opt.to_sym
       # Set the default option value if it exists
-      @results[opt.to_sym] = opt.attrs[:default] if opt.attrs.key?(:default)
+      @results[opt.to_sym] = opt.default unless opt.default.nil?
 
       on(*opt.option) do |arg|
         begin

data/opt_parse_validator.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   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 'bundler',   '~> 1.7'
-  s.add_development_dependency 'rubocop',   '~> 0.28'
+  s.add_development_dependency 'bundler',   '~> 1.6'
+  s.add_development_dependency 'rubocop',   '~> 0.29'
   s.add_development_dependency 'simplecov', '~> 0.9'
 end

data/spec/lib/opt_parse_validator/opts/array_spec.rb

@@ -5,9 +5,23 @@ describe OptParseValidator::OptArray do
   let(:attrs)   { {} }
 
   describe '#validate' do
-    context 'when an empty value is given' do
-      it 'raises an error' do
-        expect { opt.validate('') }.to raise_error('Empty option value supplied')
+    context 'when an empty or nil value is given' do
+      context 'when no value_if_empty attribute' do
+        it 'raises an error' do
+          [nil, ''].each do |value|
+            expect { opt.validate(value) }.to raise_error('Empty option value supplied')
+          end
+        end
+      end
+
+      context 'when value_if_empty attribute' do
+        let(:attrs) { super().merge(value_if_empty: 'a,b') }
+
+        it 'returns the expected array' do
+          [nil, ''].each do |value|
+            expect(opt.validate(value)).to eql %w(a b)
+          end
+        end
       end
     end
 

data/spec/lib/opt_parse_validator/opts/base_spec.rb

@@ -6,7 +6,7 @@ describe OptParseValidator::OptBase do
   let(:attrs)   { {} }
 
   describe '#to_long' do
-    after { expect(described_class.new(@option).to_long).to eq @expected }
+    after { expect(described_class.new(@option).to_long).to eql @expected }
 
     context 'when not found' do
       it 'returns nil' do
@@ -28,7 +28,7 @@ describe OptParseValidator::OptBase do
       if @exception
         expect { described_class.new(@option).to_sym }.to raise_error(@exception)
       else
-        expect(described_class.new(@option).to_sym).to eq(@expected)
+        expect(described_class.new(@option).to_sym).to eql(@expected)
       end
     end
 
@@ -112,7 +112,7 @@ describe OptParseValidator::OptBase do
   end
 
   describe '#normalize' do
-    after { expect(opt.normalize(@value)).to eq @expected }
+    after { expect(opt.normalize(@value)).to eql @expected }
 
     context 'when no :normalize attribute' do
       it 'returns the value' do
@@ -150,18 +150,38 @@ describe OptParseValidator::OptBase do
   end
 
   describe '#validate' do
-    context 'when an empty or nil value' do
-      it 'raises an error' do
-        [nil, ''].each do |value|
-          expect { opt.validate(value) }
-            .to raise_error('Empty option value supplied')
+    context 'when no value_if_empty attribute' do
+      context 'when an empty or nil value' do
+        it 'raises an error' do
+          [nil, ''].each do |value|
+            expect { opt.validate(value) }
+              .to raise_error('Empty option value supplied')
+          end
+        end
+      end
+
+      context 'when a valid value' do
+        it 'returns it' do
+          expect(opt.validate('testing')).to eql 'testing'
         end
       end
     end
 
-    context 'when a valid value' do
-      it 'returns it' do
-        expect(opt.validate('testing')).to eq 'testing'
+    context 'when value_if_empty attribute' do
+      let(:attrs) { super().merge(value_if_empty: 'it works') }
+
+      context 'when nil or empty value' do
+        it 'returns the value from the value_if_empty attribute' do
+          [nil, ''].each do |value|
+            expect(opt.validate(value)).to eql attrs[:value_if_empty]
+          end
+        end
+      end
+
+      context 'when a valid value' do
+        it 'returns it' do
+          expect(opt.validate('tt')).to eql 'tt'
+        end
       end
     end
   end

data/spec/lib/opt_parse_validator/opts/integer_range_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe OptParseValidator::OptIntegerRange do
+  subject(:opt) { described_class.new(['--range RANGE'], attrs) }
+  let(:attrs)   { {} }
+
+  describe '#validate' do
+    context 'when incorrect number of ranges given' do
+      it 'raises an error' do
+        expect { opt.validate('1-2-3') }.to raise_error('Incorrect number of ranges found: 3, should be 2')
+      end
+    end
+
+    context 'when not an integer range' do
+      it 'raises an error' do
+        expect { opt.validate('a-e') }.to raise_error('Argument is not a valid integer range')
+      end
+    end
+
+    context 'when a valid range' do
+      it 'returns the range' do
+        expect(opt.validate('1-5')).to eql((1..5))
+      end
+
+      context 'when another separator' do
+        let(:attrs) { super().merge(separator: ':') }
+
+        it 'returns the range' do
+          expect(opt.validate('0:10')).to eql((0..10))
+        end
+      end
+    end
+
+    context 'when nil or "" supplied' do
+      context 'when no value_if_empty attribute' do
+        it 'raises an error' do
+          [nil, ''].each do |value|
+            expect { opt.validate(value) }.to raise_error 'Empty option value supplied'
+          end
+        end
+      end
+
+      context 'when value_if_empty attribute' do
+        let(:attrs) { super().merge(value_if_empty: '0-2') }
+
+        it 'returns the value_if_empty value' do
+          [nil, ''].each do |value|
+            expect(opt.validate(value)).to eql((0..2))
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/opt_parse_validator/opts/multi_choices_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe OptParseValidator::OptMultiChoices do
+  subject(:opt) { described_class.new(['--enumerate [CHOICES]'], attrs) }
+  let(:attrs) do
+    {
+      choices: {
+        vp: OptParseValidator::OptBoolean.new(['--vulenrable-plugins']),
+        u:  OptParseValidator::OptIntegerRange.new(['--users'], value_if_empty: '1-10')
+      }
+    }
+  end
+
+  describe '#new' do
+    context 'when no choices attribute' do
+      let(:attrs) { {} }
+
+      it 'raises an error' do
+        expect { opt }.to raise_error 'The :choices attribute is mandatory'
+      end
+    end
+
+    context 'when choices attribute' do
+      context 'when not a hash' do
+        let(:attrs) { { choices: 'invalid' } }
+
+        it 'raises an error' do
+          expect { opt }.to raise_error 'The :choices attribute must be a hash'
+        end
+      end
+
+      context 'when a hash' do
+        it 'does not raise any error' do
+          expect { opt }.to_not raise_error
+        end
+      end
+    end
+  end
+
+  describe '#validate' do
+    context 'when an unknown choice is given' do
+      it 'raises an error' do
+        expect { opt.validate('vp,n') }.to raise_error 'Unknown choice: n'
+      end
+    end
+
+    context 'when nil or empty value' do
+      context 'when no value_if_empty attribute' do
+        it 'raises an error' do
+          [nil, ''].each do |value|
+            expect { opt.validate(value) }.to raise_error 'Empty option value supplied'
+          end
+        end
+      end
+
+      context 'when value_if_empty attribute' do
+        let(:attrs) { super().merge(value_if_empty: 'vp,u') }
+
+        it 'returns the expected hash' do
+          [nil, ''].each do |value|
+            expect(opt.validate(value)).to eql(vulenrable_plugins: true, users: (1..10))
+          end
+        end
+      end
+    end
+
+    context 'when value' do
+      it 'returns the expected hash' do
+        expect(opt.validate('u2-5')).to eql(users: (2..5))
+      end
+    end
+  end
+
+  describe '#normalize' do
+    it 'returns the same value (no normalization)' do
+      expect(opt.normalize('a')).to eql 'a'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opt_parse_validator
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - WPScanTeam - Erwan le Rousseau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-03 00:00:00.000000000 Z
+date: 2015-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.28'
+        version: '0.29'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.28'
+        version: '0.29'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,8 @@ files:
 - lib/opt_parse_validator/opts/directory_path.rb
 - lib/opt_parse_validator/opts/file_path.rb
 - lib/opt_parse_validator/opts/integer.rb
+- lib/opt_parse_validator/opts/integer_range.rb
+- lib/opt_parse_validator/opts/multi_choices.rb
 - lib/opt_parse_validator/opts/path.rb
 - lib/opt_parse_validator/opts/positive_integer.rb
 - lib/opt_parse_validator/opts/proxy.rb
@@ -158,7 +160,9 @@ files:
 - spec/lib/opt_parse_validator/opts/credentials_spec.rb
 - spec/lib/opt_parse_validator/opts/direcyory_path_spec.rb
 - spec/lib/opt_parse_validator/opts/file_path_spec.rb
+- spec/lib/opt_parse_validator/opts/integer_range_spec.rb
 - spec/lib/opt_parse_validator/opts/integer_spec.rb
+- spec/lib/opt_parse_validator/opts/multi_choices_spec.rb
 - spec/lib/opt_parse_validator/opts/path_spec.rb
 - spec/lib/opt_parse_validator/opts/positive_integer_spec.rb
 - spec/lib/opt_parse_validator/opts/proxy_spec.rb
@@ -206,7 +210,9 @@ test_files:
 - spec/lib/opt_parse_validator/opts/credentials_spec.rb
 - spec/lib/opt_parse_validator/opts/direcyory_path_spec.rb
 - spec/lib/opt_parse_validator/opts/file_path_spec.rb
+- spec/lib/opt_parse_validator/opts/integer_range_spec.rb
 - spec/lib/opt_parse_validator/opts/integer_spec.rb
+- spec/lib/opt_parse_validator/opts/multi_choices_spec.rb
 - spec/lib/opt_parse_validator/opts/path_spec.rb
 - spec/lib/opt_parse_validator/opts/positive_integer_spec.rb
 - spec/lib/opt_parse_validator/opts/proxy_spec.rb