kharon 1.0.0 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzczMmFkMWJhZGQ5ODMwN2NjYTE2YTE0N2IxMGQzYWEzNmNiZjRmYg==
+    ZWM0YTEzZTQ2MTZjOGMxMTQzMTVkMDFhZWNjOTljMTFkY2QxNTQyMA==
   data.tar.gz: !binary |-
-    OTc5ZTY2MDUyOTQ0MTU4MWY4NGMxMjRlOTE4NzkyNzE5MTMxYTE3Mw==
+    OWVmZTUzOTZmNGQxNmE0NmIxZGNhZTcyZDI5YzM1Njc4NDQ3YTYyZg==
 SHA512:
   metadata.gz: !binary |-
-    MzZhNDIxNjY3ODI4NWY5NzA4NTU2NzZkY2QzNzJkYjI3NjM1YTI0YThiNjEz
-    NmFiNzM0NjQ1YzE1OTA5ZjQ1MjM1N2Y5YWFjODk4MTcwODMyMTIwMWRlZjlk
-    MzE1ZWIzZjhkYWYzZWZjNWM1ODdjODc5MmJiZjM0MmQ0OWE0ZGY=
+    OWQwNjQ5ZDZmZWE4NzdkZDY5NDg1ZmY1Y2UwNGYyMjhjYzlmZjk2YjM1OWQx
+    ZmE1MjFhOTFhODg5NmE2YjE1MDkxZTQ2NjdhNDhiY2Y5M2E0ZGE2ZDQ1ZDRj
+    YzY1MjZhMWIxZDQyODIzODU5NDZhOWI4NGIzNWYyYjFlMGVjODQ=
   data.tar.gz: !binary |-
-    MmNjNGU0OTlhMGI5MTBmYWI4Yzg2NGY2N2ZiZmVjMzJlNmJjODFjNjAyZDc2
-    YzljNjc1N2QyM2U5NGRmNDY5MmRkZTIzMWUyMGY4ODMzOWJhZTQ1NmFjYzQz
-    YWE1Mzc3OWU1N2NmMGNhZTMwMjExZmJlNDFjYzM3ZWUyZTlhYzg=
+    YTIxNDI4N2I3NTMyOTBlZTIxOTkyNDkzOTM3NTI0NDk2ZDU2OGUxMzhkNmIw
+    MGEwMGNkZDY3NzkzZGYwNGQ5YmM2OTY4NGIyYzA0ZDQxOGViODRkODkyN2Ey
+    MWRiMjAyNDE3YTI2MWQxYjYyOTVhM2U3MzBjYmI3MDJhY2Y4YTY=

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kharon (1.1.0)
+    kharon (1.0.0)
       bson (~> 2.2, >= 2.2.2)
 
 GEM
@@ -39,3 +39,6 @@ DEPENDENCIES
   redcarpet (= 3.3.1)
   rspec (~> 3.0, >= 3.0.0)
   yard (~> 0.8)
+
+BUNDLED WITH
+   1.12.3

data/README.md

@@ -96,27 +96,30 @@ validator = Kharon::Validator.new(hash_to_validate)
 Now your validator knows which hash it has to validate, now you can do :
 
 ```ruby
-# Sees if the "required_integer_key" key is present, and an integer
-validator.integer("required_integer_key", required: true)
+# Sees if the :required_integer_key key is present, and an integer
+validator.integer(:required_integer_key, required: true)
 ```
 
+Note: all keys are converted in symbols, and you must use symbols in all method calls on a validator.
+
 All the functions are listed in the full documentation below.
 
 ### The helper
 
-This gem was firstly designed to be used as a helper for Sinatra applications, so it contains another useful module : Kharon::Helpers. To use it in your Sinatra application, just type this in the controllers where you want it included :
-
-```ruby
-helpers Kharon::Helpers
-```
-
-From there, you can type it in any of the routes of this controller :
+This gem was firstly designed to be used in controllers for Rails or Sinatra applications. To use it easily in such a context, include the Kharon::Validate module and the validate method, for example for a Rails controller :
 
 ```ruby
-validate(hash_to_validate) do
-  integer "required_integer_key", required: true
+class DummyController < ApplicationController
+  include Kharon::Validate
+
+  def show
+    validate(params) do
+      mongoid :id
+    end
+  end
 end
 ```
+```
 
 This code is strictly equivalent to the one presented above, it uses the block syntax of ruby to give you a nice and fancy way to validate your datas !
 
@@ -170,7 +173,11 @@ This option is used to give an array of possible values for the given key. If th
 
 #### :equals
 
-For the value of a given key in the hash to be equal to the given value. It can be used with all methods.
+this method compares the value of the given key in the hash to be equal to the given value. It can be used with all methods.
+
+#### :equals_key
+
+this method compares the value of the given key in the hash to be equal to the value associated with the compared key in the same hash. It can be used with all methods.
 
 #### :min
 
@@ -229,7 +236,16 @@ The value of this option must be passed as a box. When given, this option indica
 
 In Kharon, errors are formatted in a particular way. Each error contains a hash (or associative array) describing its type, and giving special caracteristics if necessary.
 
-#### Type error
+#### standard error
+
+This error is the one raised when an error occurs that has nothing to deal with the validation itself. It's mainly raised when a ruby errors occurs. It's formatted as followed :
+
+- type: always has the value "standard"
+- exception: the type of the exception
+- message: the formatted message for the exception
+- backtrace: the whole backtrace for the exception
+
+#### type error
 
 The most common error. It's raised when a type is expected for a key, and the given type for this key is different. It's formatted as followed :
 

data/doc/Kharon.html

@@ -80,7 +80,7 @@
   
     <dt class="r1 last">Defined in:</dt>
     <dd class="r1 last">lib/kharon.rb<span class="defines">,<br />
-  lib/kharon/errors.rb,<br /> lib/kharon/version.rb,<br /> lib/kharon/handlers.rb,<br /> lib/kharon/validator.rb,<br /> lib/kharon/errors/validation.rb,<br /> lib/kharon/handlers/messages.rb,<br /> lib/kharon/handlers/exceptions.rb</span>
+  lib/kharon/errors.rb,<br /> lib/kharon/version.rb,<br /> lib/kharon/validate.rb,<br /> lib/kharon/handlers.rb,<br /> lib/kharon/validator.rb,<br /> lib/kharon/errors/validation.rb,<br /> lib/kharon/handlers/messages.rb,<br /> lib/kharon/handlers/exceptions.rb</span>
 </dd>
   
 </dl>
@@ -117,7 +117,7 @@
 <p class="children">
   
     
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Kharon/Errors.html" title="Kharon::Errors (module)">Errors</a></span>, <span class='object_link'><a href="Kharon/Handlers.html" title="Kharon::Handlers (module)">Handlers</a></span>
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Kharon/Errors.html" title="Kharon::Errors (module)">Errors</a></span>, <span class='object_link'><a href="Kharon/Handlers.html" title="Kharon::Handlers (module)">Handlers</a></span>, <span class='object_link'><a href="Kharon/Validate.html" title="Kharon::Validate (module)">Validate</a></span>
     
   
     
@@ -144,7 +144,7 @@
 
 </div>
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.1.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.0.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
       
         <dt id="use_exceptions-classvariable" class="">@@use_exceptions =
           
@@ -355,7 +355,7 @@ stores error messages.</p>
 </div>
 
     <div id="footer">
-  Generated on Tue Sep 15 10:54:07 2015 by
+  Generated on Tue May 17 11:54:24 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

data/doc/Kharon/Errors.html

@@ -136,7 +136,7 @@ the application.</p>
 </div>
 
     <div id="footer">
-  Generated on Tue Sep 15 10:54:07 2015 by
+  Generated on Tue May 17 11:54:24 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

data/doc/Kharon/Errors/Validation.html

@@ -427,7 +427,7 @@ error in the validation.</p>
 </div>
 
     <div id="footer">
-  Generated on Tue Sep 15 10:54:08 2015 by
+  Generated on Tue May 17 11:54:25 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

data/doc/Kharon/Handlers.html

@@ -135,7 +135,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue Sep 15 10:54:07 2015 by
+  Generated on Tue May 17 11:54:24 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

data/doc/Kharon/Handlers/Exceptions.html

@@ -264,7 +264,7 @@ during validation.</p>
 </div>
 
     <div id="footer">
-  Generated on Tue Sep 15 10:54:08 2015 by
+  Generated on Tue May 17 11:54:25 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

data/doc/Kharon/Handlers/Messages.html

@@ -416,7 +416,7 @@ the report_error method</p>
 </div>
 
     <div id="footer">
-  Generated on Tue Sep 15 10:54:08 2015 by
+  Generated on Tue May 17 11:54:25 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

data/doc/Kharon/Validate.html

@@ -0,0 +1,276 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Module: Kharon::Validate
+  
+    &mdash; Documentation by YARD 0.8.7.6
+  
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../';
+  framesUrl = "../frames.html#!Kharon/Validate.html";
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="../_index.html">Index (V)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Kharon.html" title="Kharon (module)">Kharon</a></span></span>
+     &raquo; 
+    <span class="title">Validate</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="../method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="../file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Module: Kharon::Validate
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/kharon/validate.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>Module to include to use the #validate method in your own classes. It
+offers an easier way to validate datas than creating the validator from
+scratch.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Author:</p>
+<ul class="author">
+  
+    <li>
+      
+      
+      
+      
+        
+        <div class='inline'>
+<p>Vincent Courtois &lt;courtois.vincent@outlook.com&gt;</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+
+
+
+
+
+
+  
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#validate-instance_method" title="#validate (instance method)">- (Hash) <strong>validate</strong>(datas, &amp;block) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Validates the datas passed as parameter with a Kharon::Validator and the
+given instructions.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="validate-instance_method">
+  
+    - (<tt>Hash</tt>) <strong>validate</strong>(datas, &amp;block) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Validates the datas passed as parameter with a Kharon::Validator and the
+given instructions.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>datas</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the parameters to validate with the given instructions.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>block</span>
+      
+      
+        <span class='type'>(<tt>Proc</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the instructions to apply on the validator.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the validated and filtered datas.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+9
+10
+11
+12
+13</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/kharon/validate.rb', line 9</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_validate'>validate</span><span class='lparen'>(</span><span class='id identifier rubyid_datas'>datas</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_validator'>validator</span> <span class='op'>=</span> <span class='const'>Kharon</span><span class='op'>::</span><span class='const'>Validator</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_datas'>datas</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_validator'>validator</span><span class='period'>.</span><span class='id identifier rubyid_instance_eval'>instance_eval</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+  <span class='kw'>return</span> <span class='id identifier rubyid_validator'>validator</span><span class='period'>.</span><span class='id identifier rubyid_filtered'>filtered</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+    <div id="footer">
+  Generated on Tue May 17 11:54:24 2016 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.6 (ruby-1.9.3).
+</div>
+
+  </body>
+</html>