opt_parse_validator 0.0.12.1 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1209eb7a2eef65f85a84150ba8214a3b5357190
-  data.tar.gz: 40e4a3c671bbe2dba9f4c61eed03c8d96366c558
+  metadata.gz: 07e2cf108f44ced6d598e64cc670a884ce7f07d3
+  data.tar.gz: 2df6f9b8762e49d5fc9ab23a43e1225e956cb9e3
 SHA512:
-  metadata.gz: a77296172e928048d89ef685da148edd360cd35635f985425bd4aadd379a92b7fd8f97cd51fbd8c22700251487c311998db3479fc2ce808c747c71a46fe0e5e4
-  data.tar.gz: cbeeca877fffb10c99ed4436591a586c9a1ac714de0096518cb69012fe5700f17db18eeddb71c80bd59d502e6096dc252d7d7a4bce06b96848cd86bcb48bac3d
+  metadata.gz: b272dba6c7e5cb56104d2fb361d76b9d792369707dcff1e53b9f21672a47c72664a5723a3e7c4fb602159608f59cddf718a7209081e17e5336b4a542c450d9db
+  data.tar.gz: 0210003389f1f445f1613c35a71565dc212e82a007661dc9b2e3c5e9e041f55a42eebbe204d39694eb9d25f8ab0855775226c94e50880fb1fb03aa4486d0a560

data/lib/opt_parse_validator.rb

@@ -9,7 +9,7 @@ require 'opt_parse_validator/errors'
 require 'opt_parse_validator/hacks'
 require 'opt_parse_validator/opts'
 require 'opt_parse_validator/version'
-require 'opt_parse_validator/options_file'
+require 'opt_parse_validator/options_files'
 
 # Gem namespace
 module OptParseValidator
@@ -72,6 +72,25 @@ module OptParseValidator
       post_processing
 
       @results
+    rescue => e
+      # Raise it as an OptParseValidator::Error if not already one
+      raise e.is_a?(Error) ? e.class : Error, e.message
+    end
+
+    # @return [ Void ]
+    def load_options_files
+      files_data = options_files.parse
+
+      @opts.each do |opt|
+        next unless files_data.key?(opt.to_sym)
+
+        @results[opt.to_sym] = opt.normalize(opt.validate(files_data[opt.to_sym]))
+      end
+    end
+
+    # @return [ OptParseValidator::OptionsFiles ]
+    def options_files
+      @options_files ||= OptionsFiles.new
     end
 
     # Ensure that all required options are supplied

data/lib/opt_parse_validator/options_file/base.rb

@@ -0,0 +1,22 @@
+module OptParseValidator
+  module OptionsFile
+    # Base class, #parse should be implemented in child classes
+    class Base
+      attr_reader :path
+
+      # @param [ String ] path The file path of the option file
+      def initialize(path)
+        @path = path
+      end
+
+      # @return [ Hash ] a { key: value } hash
+      def parse
+        fail NotImplementedError
+      end
+
+      def ==(other)
+        path == other.path
+      end
+    end
+  end
+end

data/lib/opt_parse_validator/options_file/json.rb

@@ -0,0 +1,13 @@
+require 'json'
+
+module OptParseValidator
+  module OptionsFile
+    # Json Implementation
+    class JSON < Base
+      # @return [ Hash ] a { key: value } hash
+      def parse
+        ::JSON.parse(File.read(path), symbolize_names: true)
+      end
+    end
+  end
+end

data/lib/opt_parse_validator/options_file/yml.rb

@@ -0,0 +1,13 @@
+require 'yaml'
+
+module OptParseValidator
+  module OptionsFile
+    # Yaml Implementation
+    class YML < Base
+      # @return [ Hash ] a { key: value } hash
+      def parse
+        Hash[YAML.load_file(path).map { |k, v| [k.to_sym, v] }]
+      end
+    end
+  end
+end

data/lib/opt_parse_validator/options_files.rb

@@ -0,0 +1,43 @@
+require 'opt_parse_validator/options_file/base'
+require 'opt_parse_validator/options_file/json'
+require 'opt_parse_validator/options_file/yml'
+
+module OptParseValidator
+  # Options Files container
+  class OptionsFiles < Array
+    # @return [ Array<String> ] The downcased supported extensions list
+    def supported_extensions
+      extensions = OptionsFile.constants.select do |const|
+        name = OptionsFile.const_get(const)
+        name.is_a?(Class) && name != OptionsFile::Base
+      end
+
+      extensions.map { |sym| sym.to_s.downcase }
+    end
+
+    # @param [ String ] file_path
+    #
+    # @return [ Self ]
+    def <<(file_path)
+      return self unless File.exist?(file_path)
+
+      ext = File.extname(file_path).delete('.')
+
+      fail Error, "The option file's extension '#{ext}' is not supported" unless supported_extensions.include?(ext)
+
+      super(OptionsFile.const_get(ext.upcase).new(file_path))
+    end
+
+    # @return [ Hash ] a { key: value } hash
+    def parse
+      files_data = {}
+
+      each do |option_file|
+        data = option_file.parse
+        files_data.merge!(data) if data
+      end
+
+      files_data
+    end
+  end
+end

data/lib/opt_parse_validator/version.rb

@@ -1,4 +1,4 @@
 # Gem Version
 module OptParseValidator
-  VERSION = '0.0.12.1'
+  VERSION = '0.0.13'
 end

data/opt_parse_validator.gemspec

@@ -9,10 +9,11 @@ Gem::Specification.new do |s|
   s.version               = OptParseValidator::VERSION
   s.platform              = Gem::Platform::RUBY
   s.required_ruby_version = '>= 2.0.0'
-  s.authors               = ['WPScanTeam - Erwan le Rousseau']
-  s.email                 = ['erwan.lr@gmail.com']
-  s.summary               = 'Testing Gem'
-  s.description           = 'Testing Gem ...'
+  s.authors               = ['WPScanTeam']
+  s.email                 = ['team@wpscan.org']
+  s.summary               = 'Ruby OptionParser Validators'
+  s.description           = 'Implementation of validators for the ruby OptionParser lib. ' \
+                            'Mainly used in the CMSScanner gem to define the cli options available'
   s.homepage              = 'https://github.com/wpscanteam/OptParseValidator'
   s.license               = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opt_parse_validator
 version: !ruby/object:Gem::Version
-  version: 0.0.12.1
+  version: 0.0.13
 platform: ruby
 authors:
-- WPScanTeam - Erwan le Rousseau
+- WPScanTeam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-06 00:00:00.000000000 Z
+date: 2015-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -122,9 +122,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
-description: Testing Gem ...
+description: Implementation of validators for the ruby OptionParser lib. Mainly used
+  in the CMSScanner gem to define the cli options available
 email:
-- erwan.lr@gmail.com
+- team@wpscan.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -135,7 +136,10 @@ files:
 - lib/opt_parse_validator.rb
 - lib/opt_parse_validator/errors.rb
 - lib/opt_parse_validator/hacks.rb
-- lib/opt_parse_validator/options_file.rb
+- lib/opt_parse_validator/options_file/base.rb
+- lib/opt_parse_validator/options_file/json.rb
+- lib/opt_parse_validator/options_file/yml.rb
+- lib/opt_parse_validator/options_files.rb
 - lib/opt_parse_validator/opts.rb
 - lib/opt_parse_validator/opts/array.rb
 - lib/opt_parse_validator/opts/base.rb
@@ -179,6 +183,6 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Testing Gem
+summary: Ruby OptionParser Validators
 test_files: []
 has_rdoc: 

data/lib/opt_parse_validator/options_file.rb

@@ -1,62 +0,0 @@
-require 'json'
-require 'yaml'
-
-module OptParseValidator
-  # TODO
-  class OptParser < OptionParser
-    def options_files
-      @options_files ||= []
-    end
-
-    def load_options_files
-      files_data = {}
-
-      options_files.each do |file|
-        data = parse_file(file)
-        files_data.merge!(data) if data
-      end
-
-      @opts.each do |opt|
-        # Annoying thing: the hash returned from parse_file is a string-full {"key"=>"value"}
-        # and not a ruby hash {key: value} :/ As a result, symbol.to_s has to be used
-        next unless files_data.key?(opt.to_sym.to_s)
-
-        @results[opt.to_sym] = opt.normalize(opt.validate(files_data[opt.to_sym.to_s]))
-      end
-    end
-
-    protected
-
-    # @param [ String ] file_path
-    #
-    # @return [ Hash ]
-    def parse_file(file_path)
-      return unless File.exist?(file_path)
-
-      file_ext       = File.extname(file_path).delete('.')
-      method_to_call = "parse_#{file_ext}"
-
-      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 Error, "Parse Error, #{file_path} seems to be malformed"
-      end
-    end
-
-    # @param [ String ] file_path
-    #
-    # @return [ Hash ]
-    def parse_json(file_path)
-      JSON.parse(File.read(file_path))
-    end
-
-    # @param [ String ] file_path
-    #
-    # @return [ Hash ]
-    def parse_yml(file_path)
-      YAML.load_file(file_path)
-    end
-  end
-end