opt_parse_validator 0.0.2

data/spec/lib/opt_parse_validator_spec.rb

@@ -0,0 +1,152 @@
+require 'spec_helper'
+
+describe OptParseValidator::OptParser do
+
+  subject(:parser)  { described_class.new }
+  let(:verbose_opt) { OptParseValidator::OptBase.new(%w(-v --verbose)) }
+  let(:url_opt)     { OptParseValidator::OptURL.new(['-u', '--url URL'], required: true) }
+
+  describe '#add_option' do
+    after do
+      if @exception
+        expect { parser.add_option(@option) }.to raise_error(@exception)
+      else
+        parser.add_option(@option)
+
+        expect(parser.symbols_used).to eq @expected_symbols
+      end
+    end
+
+    context 'when not an OptBase' do
+      it 'raises an error' do
+        @option    = 'just a string'
+        @exception = 'The option is not an OptBase, String supplied'
+      end
+    end
+
+    context 'when the option symbol is already used' do
+      it 'raises an error' do
+        @option    = verbose_opt
+        @exception = 'The option verbose is already used !'
+        parser.add_option(@option)
+      end
+    end
+
+    context 'when a valid option' do
+      let(:option) { OptParseValidator::OptBase.new(['-u', '--url URL']) }
+
+      it 'sets the option' do
+        @option           = option
+        @expected_symbols = [:url]
+      end
+    end
+  end
+
+  describe '#add' do
+    context 'when not an Array<OptBase> or an OptBase' do
+      after { expect { parser.add(*@options) }.to raise_error(@exception) }
+
+      it 'raises an error when an Array<String>' do
+        @options   = ['string', 'another one']
+        @exception = 'The option is not an OptBase, String supplied'
+      end
+    end
+
+    context 'when valid' do
+      after do
+        parser.add(*@options)
+
+        expect(parser.symbols_used).to eq @expected_symbols
+      end
+
+      it 'adds the options' do
+        @options          = [verbose_opt, url_opt]
+        @expected_symbols = [:verbose, :url]
+      end
+
+      it 'adds the option' do
+        @options          = verbose_opt
+        @expected_symbols = [:verbose]
+      end
+    end
+  end
+
+  describe '#results' do
+    before { parser.add(*options) }
+
+    after do
+      if @expected
+        expect(parser.results(@argv)).to eq @expected
+      else
+        expect { parser.results(@argv) }.to raise_error(@exception)
+      end
+    end
+
+    let(:options) { [verbose_opt, url_opt] }
+
+    context 'when an option is required but not supplied' do
+      it 'raises an error' do
+        @exception = 'The option url is required'
+        @argv      = %w(-v)
+      end
+    end
+
+    context 'when the #validate raises an error' do
+      it 'adds the option.to_long as a prefix' do
+        @exception = Addressable::URI::InvalidURIError
+        @argv      = %w(--url www.google.com)
+      end
+    end
+
+    context 'when the default attribute is used' do
+      let(:options)     { [verbose_opt, default_opt] }
+      let(:default_opt) { OptParseValidator::OptBase.new(['--default VALUE'], default: false) }
+
+      context 'when the option is supplied' do
+        it 'overrides the default value' do
+          @argv     = %w(--default overriden)
+          @expected = { default: 'overriden' }
+        end
+      end
+
+      context 'when the option is not supplied' do
+        it 'sets the default value' do
+          @argv     = %w(-v)
+          @expected = { verbose: true, default: false }
+        end
+      end
+    end
+
+    # See https://github.com/wpscanteam/CMSScanner/issues/2
+    context 'when no short option' do
+      let(:options)  { [verbose_opt, http_opt] }
+      let(:http_opt) { OptParseValidator::OptBase.new(['--http-auth log:pass']) }
+
+      it 'calls the help' do
+        expect(parser).to receive(:help)
+
+        @argv      = %w(-h)
+        @exception = SystemExit
+      end
+
+      it 'returns the results' do
+        @argv     = %w(--http-auth user:passwd)
+        @expected = { http_auth: 'user:passwd' }
+      end
+    end
+
+    context 'when the normalize attrbite is used' do
+      let(:options) { [OptParseValidator::OptString.new(['--test V'], normalize: :to_sym)] }
+
+      it 'returns the symbol' do
+        @argv     = %w(--test test)
+        @expected = { test: :test }
+      end
+    end
+
+    it 'returns the results' do
+      @argv     = %w(--url http://hello.com -v)
+      @expected = { url: 'http://hello.com', verbose: true }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+FIXTURES = File.expand_path(File.join(File.dirname(__FILE__), 'fixtures'))
+
+require 'rspec/its'
+require 'simplecov'
+
+if ENV['TRAVIS']
+  require 'coveralls'
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+end
+
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+# See http://betterspecs.org/
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+require 'opt_parse_validator'

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: opt_parse_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- WPScanTeam - Erwan le Rousseau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.26'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.26'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Testing Gem ...
+email:
+- erwan.lr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/opt_parse_validator.rb
+- lib/opt_parse_validator/hacks.rb
+- lib/opt_parse_validator/options_file.rb
+- lib/opt_parse_validator/opts.rb
+- lib/opt_parse_validator/opts/base.rb
+- lib/opt_parse_validator/opts/boolean.rb
+- lib/opt_parse_validator/opts/choice.rb
+- lib/opt_parse_validator/opts/credentials.rb
+- 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/path.rb
+- lib/opt_parse_validator/opts/positive_integer.rb
+- lib/opt_parse_validator/opts/proxy.rb
+- lib/opt_parse_validator/opts/string.rb
+- lib/opt_parse_validator/opts/uri.rb
+- lib/opt_parse_validator/opts/url.rb
+- lib/opt_parse_validator/version.rb
+- opt_parse_validator.gemspec
+- spec/fixtures/options_file/default.json
+- spec/fixtures/options_file/malformed.json
+- spec/fixtures/options_file/override.yml
+- spec/fixtures/options_file/unsupported.ext
+- spec/fixtures/r.txt
+- spec/fixtures/rwx.txt
+- spec/lib/opt_parse_validator/options_file_spec.rb
+- spec/lib/opt_parse_validator/opts/base_spec.rb
+- spec/lib/opt_parse_validator/opts/boolean_spec.rb
+- spec/lib/opt_parse_validator/opts/choice_spec.rb
+- 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_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
+- spec/lib/opt_parse_validator/opts/uri_spec.rb
+- spec/lib/opt_parse_validator/opts/url_spec.rb
+- spec/lib/opt_parse_validator/version_spec.rb
+- spec/lib/opt_parse_validator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/wpscanteam/OptParseValidator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Testing Gem
+test_files:
+- spec/fixtures/options_file/default.json
+- spec/fixtures/options_file/malformed.json
+- spec/fixtures/options_file/override.yml
+- spec/fixtures/options_file/unsupported.ext
+- spec/fixtures/r.txt
+- spec/fixtures/rwx.txt
+- spec/lib/opt_parse_validator/options_file_spec.rb
+- spec/lib/opt_parse_validator/opts/base_spec.rb
+- spec/lib/opt_parse_validator/opts/boolean_spec.rb
+- spec/lib/opt_parse_validator/opts/choice_spec.rb
+- 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_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
+- spec/lib/opt_parse_validator/opts/uri_spec.rb
+- spec/lib/opt_parse_validator/opts/url_spec.rb
+- spec/lib/opt_parse_validator/version_spec.rb
+- spec/lib/opt_parse_validator_spec.rb
+- spec/spec_helper.rb