kharon 0.3.0 → 0.3.1

data/lib/cool_validator.rb

@@ -0,0 +1,32 @@
+require "./lib/validator.rb"
+
+module Kharon
+  # This validator is really cooler than the other one. It will help you validate datas without raising exception, if you don't want to.
+  # @author Vincent Courtois <vincent.courtois@mycar-innovations.com>
+  class CoolValidator < Kharon::Validator
+
+    # @!attribute [r] errors
+      # @return an array of strings, each string representing an error occured while validating the hash.
+    attr_reader :errors
+
+    # Constructor of the classe, receiving the datas to validate and filter.
+    # @param [Hash] datas the datas to validate in the validator.
+    # @example create a new instance of validator.
+    #   @validator = Kharon::CoolValidator.new({key: "value"})
+    def initialize(datas)
+      super(datas)
+      @errors = Array.new
+    end
+
+    # Fancy method to see if the validator have seen an error in the given hash.
+    def has_errors?
+      return (@errors.empty? ? false : true)
+    end
+
+    protected
+
+    def raise_error(message)
+      errors.push(message)
+    end
+  end
+end

data/lib/validator_factory.rb

@@ -0,0 +1,34 @@
+require "./lib/validator.rb"
+require "./lib/cool_validator.rb"
+
+module Kharon
+  module Factory
+
+    # @!attribute [r|w] use_exceptions
+      # @return TRUE if Kharon currently use exceptions, FALSE if not.
+    @@use_exceptions = true
+
+    # Acts as a creation method for validators, considering the options you transmitted.
+    # @param [Hash] datas the datas to validate in the validator.
+    def self.validator(datas)
+      @@use_exceptions ? Kharon::Validator.new(datas) : Kharon::CoolValidator.new(datas)
+    end
+
+    # Allows you to pass a whole block to configure the Kharon module.
+    # @param [Hash] block a block of configuration instructions to pass to the module. See documentation for further informations.
+    def self.configure(&block)
+      self.instance_eval(&block)
+    end
+
+    # Sets the use of exceptions in the whole process.
+    # @param [Boolean] status TRUE if you want to use the eceptions, FALSE if not.
+    def self.use_exceptions(status)
+      @@use_exceptions = status
+    end
+
+    # Fancy method to know if the module uses the exceptions or not.
+    def self.uses_exceptions?
+      return @@use_exceptions
+    end
+  end
+end

data/spec/lib/cool_validator_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe "CoolValidator" do
+  context "handling errors" do
+
+    before do
+      @validator = Kharon::CoolValidator.new({key: "value"})
+    end
+
+    it "doesn't raise an exception when an error occurs" do
+      expect(->{@validator.any(:another, required: true)}).to_not raise_error
+    end
+
+    it "has an error when an error has occured" do
+      @validator.any(:another, required: true)
+      expect(@validator.has_errors?).to be(true)
+    end
+
+    it "doesn't have an error when none has occured" do
+      @validator.any(:key, required: true)
+      expect(@validator.has_errors?).to be(false)
+    end
+  end
+end

data/spec/lib/validator_factory_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe "Kharon::Factory" do
+
+  context "validator" do
+    it "produces a Kharon::Validator when exceptions are wanted" do
+      Kharon::Factory.use_exceptions(true)
+      expect(Kharon::Factory.validator({key: "value"})).to be_a(Kharon::Validator)
+    end
+
+    it "produces a Kharon::CoolValidator when exceptions are not wanted" do
+      Kharon::Factory.use_exceptions(false)
+      expect(Kharon::Factory.validator({key: "value"})).to be_a(Kharon::CoolValidator)
+    end
+  end
+
+  context "configure" do
+    it "correctly configures the module to use exceptions" do
+      Kharon::Factory.configure do |configuration|
+        configuration.use_exceptions(true)
+      end
+      expect(Kharon::Factory.uses_exceptions?).to be(true)
+    end
+
+    it "correctly configures the module to not use exceptions" do
+      Kharon::Factory.configure do |configuration|
+        configuration.use_exceptions(false)
+      end
+      expect(Kharon::Factory.uses_exceptions?).to be(false)
+    end
+  end
+
+end

data/spec/lib/validator_spec.rb

@@ -1,6 +1,4 @@
-require 'rack/test'
-require 'moped'
-require './lib/validator.rb'
+require 'spec_helper'
 
 shared_examples "options" do |process|
   context ":rename" do

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+# Sets the environment variable to test before loading all the files.
+ENV['RACK_ENV'] = 'test'
+
+require 'rack/test'
+require 'bson'
+
+require './lib/cool_validator.rb'
+require './lib/validator_factory.rb'
+require './lib/validator.rb'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kharon
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2014-04-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bson
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
 description: Kharon is a ruby hash validator that helps you fix the structure of a
   hash (type of the keys, dependencies, ...).
 email: vincent.courtois@mycar-innovations.com
@@ -20,7 +36,12 @@ extra_rdoc_files: []
 files:
 - lib/validator.rb
 - lib/validate.rb
+- lib/validator_factory.rb
+- lib/cool_validator.rb
+- spec/spec_helper.rb
 - spec/lib/validator_spec.rb
+- spec/lib/cool_validator_spec.rb
+- spec/lib/validator_factory_spec.rb
 homepage: https://rubygems.org/gems/kharon
 licenses:
 - Apache License 2
@@ -47,4 +68,7 @@ signing_key:
 specification_version: 3
 summary: Ruby Hash validator
 test_files:
+- spec/spec_helper.rb
 - spec/lib/validator_spec.rb
+- spec/lib/cool_validator_spec.rb
+- spec/lib/validator_factory_spec.rb