kwalify 0.1.0 → 0.2.0

data/ChangeLog

@@ -1,62 +1,29 @@
-.=title:	ChangeLog
-.?revision:	$Rev: 9 $
-.?release:	$Release: 0.1.0 $
-.?lastupdate:	$Date: 2005-08-01 06:48:56 +0900 (Mon, 01 Aug 2005) $
-
-.: 2005-08-01 (rev.9) - release 0.1.0
-	.- [change] block arguments of Kwalify::Validator.new() changed 
-	.- [change] webiste/* added
-
-.: 2005-07-29 (rev.8)
-	.- [bugfix] meta-validator.rb is fixed to work fine
-	.- [change] enclose key name in schema with '"' (ex. "email", "addr", ...)
-	.- [change] document update (Tips section added)
-	.- [enhance] command-line option '-M' which invoke Kwalify::meta_validator2
-
-.: 2005-07-27 (rev.7)
-	.- [change] use 'seq' and 'map' instead of 'list' and 'hash' as type
-	.- [change] use 'sequence:' and 'mapping:' instead of 'elements:'
-	.- [enhance] use meta-validator for validating schema definition
-	.- [change] command-line option '-c' is renamed to '-m'
-	.- [enhance] 'type:' is keeped at @type and class name is at @klass in Schema class
-	.- [enhance] 'name:' support
-	.- [enahnce] (experimental) block support for Validator#initialize()
-
-.: 2005-07-26 (rev.6)
-	.- [enhance] support multiple documents using YAML::load_stream()
-	.- [enhance] new command-line option '-t' : expand tab characters
-	.- [enhance] support domain document
-	.- [enhance] add examples - 'address-book' and 'invoice'
-	.- [enhance] add 'lib/kwalify/util/option-parser.rb'
-
-.: 2005-07-25 (rev.5)
-	.- [enhance] Kwalify::DEFAULT_TYPE is String
-	.- [change] array index starts with 1
-	.- [change] command-line option '-s' is changed to '-f'
-	.- [enhance] new command-line option '-s' (silent)
-	.- [change] output format of bin/kwalify changed
-	.- [enhance] untabify schema and document file using YAML::Helper
-	.- [enhance] add new file 'lib/kwalify/util/yaml-helper.rb'
-
-.: 2005-07-25 (rev.4)
-	.- [change] class Kwalify::RuleSet is renamed to Kwalify::Schema
-	.- [enhance] add new class Kwalify::Validator
-	.- [enhance] add bin/kwalify
-	.- [enhance] add doc/users-guide.txt
-	.- [enhance] add README.txt, COPYING, setup.rb, kwalify.gemspec
-
-.: 2005-07-25 (rev.3)
-	.- [change] use mappings at elements of Hash
-	.- [change] rename 'children' to 'elements'
-	.- [enhance] support recursive collections
-	.- [enhance] add RuleSet#inspect
-	.- [change] rename 'error-messages.rb' to 'error-msg.rb'
-	.- [change] rename Text and Boolean to Kwalify::Text and Kwalify::Boolean
-
-.: 2005-07-24 (rev.2)
-	.- [enhance] add pattern check
-	.- [enhance] add Text class
-	.- [enhance] add test script
-
-.: 2005-07-24 (rev.1)
-	.- initial commit
+.=title:          ChangeLog
+.?release:        $Release: 0.2.0 $
+.?lastupdate:     $Date$
+.?version:        $Rev$
+
+.: 2005-09-25 (release 0.2.0)
+   .* Enhances:
+      .- New type 'scalar' and 'timestamp' added
+      .- Add new rule 'range:' which validates value range.
+         See users' guide for details.
+      .- Add new rule 'length:' which validate length of string value.
+         See users' guide for details.
+      .- Add experimental rule 'assert:' which validates value with an
+         expression. See users' guide for details.
+      .- New method 'Kwalify::Validator#validate_hook()' is added.
+         This method is called by Kwalify::Validator#validate().
+         See users' guide for details.
+      .- New class 'MetaValidator' added.
+      .- New test script 'test/test-metavalidator.rb' added.
+   .* Changes:
+      .- Type name changed to suite YAML data type: 
+         .= string -> str
+         .= integer -> int
+         .= boolean -> bool
+      .- Error index starts with 0 (before starts with 1).
+      .- Class 'Schema' is renamed to 'Rule'.
+
+.: 2005-08-01 (release 0.1.0)
+    .- beta release

data/README.txt

@@ -1,7 +1,7 @@
 .=title:	README
-.?version:	$Rev: 9 $
-.?lastupdate:	$Date: 2005-08-01 06:48:56 +0900 (Mon, 01 Aug 2005) $
-.?release:	$Release: 0.1.0 $
+.?version:	$Rev: 18 $
+.?lastupdate:	$Date: 2005-09-25 22:36:35 +0900 (Sun, 25 Sep 2005) $
+.?release:	$Release: 0.2.0 $
 
 
 .$ About Kwalify
@@ -15,14 +15,42 @@
 
 .$ Installation
 
-   Just type 'gem install --remote kwalify' if you have installed RubyGems.
-   Or use setup.rb as following:
-   .====================
-   $ ruby setup.rb config
-   $ ruby setup.rb setup
-   $ su -
-   # ruby setup.rb install
-   .====================
+   .* Just type 'gem install --remote kwalify' if you have installed RubyGems.
+       .====================
+       $ sudo gem install --remote kwalify
+       .====================
+   
+   .* If you can be root user, use 'setup.rb' as following:
+       .====================
+       $ tar xjf kwalify_x.x.x.tar.bz2
+       $ cd kwalify_x.x.x/
+       $ ruby setup.rb config
+       $ ruby setup.rb setup
+       $ sudo ruby setup.rb install
+       .====================
+
+   .* If you can't be root user, copy script and libraries to proper directory.
+       .====================
+       $ tar xjf kwalify_x.x.x.tar.bz2
+       $ cd kwalify_x.x.x/
+       $ mkdir -p $HOME/bin
+       $ cp -a bin/* $HOME/bin
+       $ export PATH=$PATH:$HOME/bin
+       $ mkdir -p $HOME/lib/ruby
+       $ cp -a lib/* $HOME/lib/ruby
+       $ export RUBYLIB=$HOME/lib/ruby
+       .====================
+
+   .* Or use 'contrib/inline-require' script to concatenate all script and
+      libraries into one file.
+       .====================
+       $ tar xjf kwalify_x.x.x.tar.bz2
+       $ cd kwalify_x.x.x/
+       $ unset RUBYLIB
+       $ ruby contrib/inline-require -I ./lib bin/kwalify > kwalify
+       $ mv kwalify $HOME/bin
+       $ chmod a+x $HOME/bin/kwalify
+       .====================
 
 
 .$ License

data/bin/kwalify

@@ -1,185 +1,24 @@
 #!/usr/bin/env ruby
 
 ###
-### $Rev: 8 $
-### $Release: 0.1.0 $
+### $Rev: 12 $
+### $Release: 0.2.0 $
 ### copyright(c) 2005 kuwata-lab all rights reserved.
 ###
 
 require 'kwalify'
-require 'yaml'
-require 'kwalify/meta-validator'
-require 'kwalify/util/yaml-helper'
-require 'kwalify/util/option-parser'
-
-
-module Kwalify
-
-   RELEASE = ("$Release: 0.1.0 $" =~ /[.\d]+/) && $&
-
-
-   class Main
-
-      def initialize(command, argv=ARGV)
-         @command   = command
-         @options, @proerties = parse_argv(argv)
-         @filenames = argv
-      end
-
-
-      def execute(out=$stdout)
-         if @options[:help] || @options[:version]
-            $stderr.puts "Kwalify: #{RELEASE}" if @options[:version]
-            $stderr.puts usage()   if @options[:help]
-            return
-         end
-         if !@options[:meta] && !@options[:schema]
-            raise CommandOptionError.new("command-line option '-f' or '-m' required.")
-         end
-         #
-         if @options[:meta]
-            meta_validate(out)
-         else
-            validate(out)
-         end
-      end
-
-
-      private
-
-
-      def meta_validate(out)
-         meta_validator = @options[:meta2] ? Kwalify.meta_validator2() : Kwalify.meta_validator()
-         if @filenames.empty?
-            _meta_validate(out, meta_validator, nil)
-         else
-            @filenames.each do |fname|
-               _meta_validate(out, meta_validator, fname)
-            end
-         end
-      end
-
-
-      def _meta_validate(out, meta_validator, filename=nil)
-         s = filename ? File.open(filename) { |f| f.read() } : $stdin.read()
-         s = YamlHelper.untabify(s) if @options[:untabify]
-         yaml = YAML.load(s)
-         yaml = yaml.value if yaml.is_a?(YAML::Syck::DomainType)
-         filename ||= "(stdin)"
-         if !yaml || yaml.empty?
-            out.puts "#{filename}: empty."
-            return
-         end
-         errors = meta_validator.validate(yaml)
-         if !errors.empty?
-            out.puts "#{filename}: NG!"
-            errors.each { |error| out.puts "  - #{error.message}" }
-            return
-         end
-         begin
-            validator = Kwalify::Validator.new(yaml)  # error raised when schema is wrong
-            out.puts "#{filename}: ok." unless @options[:silent]
-         rescue Kwalify::SchemaError => ex
-            out.puts "#{filename}: NG! #{ex.message}"
-         end
-      end
-
-
-      def validate(out)
-         schema_filename = @options[:schema]
-         s = File.open(schema_filename) { |f| f.read() }
-         s = YamlHelper.untabify(s) if @options[:untabify]
-         yaml = YAML.load(s)
-         yaml = yaml.value if yaml.is_a?(YAML::Syck::DomainType)
-         validator = Kwalify::Validator.new(yaml)
-         #
-         if @filenames.empty?
-            _validate(out, validator, nil)
-         else
-            @filenames.each do |fname|
-               _validate(out, validator, fname)
-            end
-         end
-      end
-
-
-      def _validate(out, validator, filename=nil)
-         s = filename ? File.open(filename) { |f| f.read() } : $stdin.read() 
-         s = YamlHelper.untabify(s) if @options[:untabify]
-         stream = YAML::load_stream(s)
-         filename ||= "(stdin)"
-         i = 0
-         stream.documents.each do |document|
-            i += 1
-            document = document.value if document.is_a?(YAML::Syck::DomainType)
-            if !document || document.empty?
-               out.puts "#{filename}: empty."
-               return
-            end
-            errors = validator.validate(document)
-            if errors.empty?
-               out.puts "#{filename}\##{i}: valid." unless @options[:silent]
-            else
-               out.puts "#{filename}\##{i}: INVALID"
-               errors.each { |error| out.puts "  - #{error.message}" }
-            end
-         end
-      end
-
-
-      def usage()
-         s = ""
-         s << "Usage1: #{@command} [-hvs] -f schema.yaml document.yaml [document2.yaml ...]\n"
-         s << "Usage2: #{@command} [-hvs] -c schema.yaml [schema2.yaml ...]\n"
-         s << "  -h, --help      :  help\n"
-         s << "  -v              :  version\n"
-         s << "  -s              :  silent\n"
-         s << "  -f schema.yaml  :  schema definition file\n"
-         s << "  -m              :  meta-validation mode\n"
-         s << "  -t              :  expand tab character automatically\n"
-         return s
-      end
-
-
-      def parse_argv(argv)
-         opt_parser = CommandOptionParser.new("hvstmM", "f")
-         #opts, props = opt_parser.parse(argv)
-         #properties = {}
-         #props.each do |pname, pvalue|
-         #   key   = pname.gsub(/-/, '_').intern
-         #   value = value == nil ? true: CommandOptionParser.to_value(pvalue)
-         #   properties[key] = value
-         #end
-         auto_convert = true
-         opts, properties = opt_parser.parse(argv, auto_convert)
-         options = {}
-         options[:help]     = opts[?h]  || properties[:help]
-         options[:version]  = opts[?v]  || properties[:version]
-         options[:silent]   = opts[?s]
-         options[:schema]   = opts[?f]
-         options[:meta]     = opts[?m] || opts[?M]
-         options[:meta2]    = opts[?M]
-         options[:untabify] = opts[?t]
-         return options, properties
-      end
-
-   end
-
-end
-
-
-#if __FILE__ == $0
-unless defined?(KWALIFY_NOEXEC)
-   command = File.basename($0)
-   begin
-      main = Kwalify::Main.new(command, ARGV)
-      main.execute()
-      exit 0
-   rescue Kwalify::KwalifyError => ex
-      $stderr.puts "ERROR: #{ex.message}"
-      exit 1
-   #rescue => ex
-   #   $stderr.puts ex.message
-   #   exit 1
-   end
+require 'kwalify/main-program'
+
+
+command = File.basename($0)
+begin
+   main = Kwalify::MainProgram.new(ARGV, command)
+   s = main.execute()
+   print s if s
+rescue CommandOptionError => ex
+   $stderr.puts ex.message
+   exit 1
+rescue Kwalify::KwalifyError => ex
+   $stderr.puts "ERROR: #{ex.message}"
+   exit 1
 end

data/doc/users-guide.html

@@ -15,14 +15,46 @@
     <div align="left"><h1>Kwalify Users' Guide</h1></div>
     <div align="left">
       makoto kuwata &lt;kwa(at)kuwata-lab.com&gt;<br>
-      last update: $Date: 2005-08-01 06:48:56 +0900 (Mon, 01 Aug 2005) $<br>
+      last update: $Date: 2005-09-25 22:36:35 +0900 (Sun, 25 Sep 2005) $<br>
     </div>
 
 <a name="preface"></a>
 <h2 class="section1">Preface</h2>
 <p>Kwalify<sup>(<a href="#fnref:1" name="fnlink:1">*1</a>)</sup> is a tiny schema validator for YAML document.
 </p>
-<p>Kwalify is in fact very poor compared to Relax NG or DTD.
+<p>Do you know "80-20 rule" known as Pareto Law?  This rule suggests that 20% of the population owns 80% of the wealth.
+Kwalify is based on a new "50-5 rule" which suggests that 5% of the population owns 50 of the wealth.
+This rule is more aggressive and cost-effective than Pareto Law. The rule is named as "Levi's Law".
+</p>
+<div align="center">
+<table class="table1" border="1" cellspacing="0">
+ <tr class="tr1">
+  <th class="th1">schema technology</th>
+  <th class="th1">(A) cover range</th>
+  <th class="th1">(B) cost to pay</th>
+  <th class="th1">(A)/(B) effectiveness</th>
+ </tr>
+ <tr class="tr1">
+  <td class="td1">XML Schema</td>
+  <td class="td1">96%</td>
+  <td class="td1">80%</td>
+  <td class="td1">1.2 (= 96/80)</td>
+ </tr>
+ <tr class="tr1">
+  <td class="td1">RelaxNG</td>
+  <td class="td1">80%</td>
+  <td class="td1">20%</td>
+  <td class="td1">4.0 (= 80/20)</td>
+ </tr>
+ <tr class="tr1">
+  <td class="td1">Kwalify</td>
+  <td class="td1">50%</td>
+  <td class="td1">5%</td>
+  <td class="td1">10.0 (= 50/5)</td>
+ </tr>
+</table>
+</div>
+<p>Kwalify is very small and in fact very poor compared to RelaxNG or XML Schema.
 I hope you extend/customize Kwalify for your own way.
 </p>
 Table of Contents:
@@ -50,6 +82,8 @@ Table of Contents:
     </li>
     <li><a href="#schema-rules">Rules</a>
     </li>
+    <li><a href="#schema-hook">Validator#validator_hook()</a>
+    </li>
     <li><a href="#schema-block">Validator with Block</a>
     </li>
   </ul>
@@ -89,7 +123,7 @@ usage2: validate schema definition in command-line</div>
 </p>
 <dl class="dl3">
 <dt class="dt3"><strong>
-<code>-h</code>, <code>--help</code></strong></dt>
+<code>-h</code>, <code>--help</code> </strong></dt>
 <dd class="dd3">
 	Print help message.
 </dd>
@@ -129,17 +163,15 @@ validate YAML document in Ruby script</div>
 <pre class="program">require 'kwalify'
 
 ## parse schema definition and create validator
-str = File.read('schema.yaml')
-schema_def = YAML.load(str)
-validator = Kwalify::Validator.new(schema_def)  # raises Kwalify::SchemaError if wrong
+schema = YAML.load_file('schema.yaml')
+validator = Kwalify::Validator.new(schema)  # raises Kwalify::SchemaError if wrong
 
 ## validate YAML document
-str = File.read('document.yaml')
-document = YAML.load(str)
+document = YAML.load_file('document.yaml')
 error_list = validator.validate(document)
 unless error_list.empty?
-   error_list.each do |error|     # error is Kwalify::ValidationException
-      print error.message
+   error_list.each do |error|     # error is Kwalify::ValidationError
+      puts "[#{error.path}] #{error.message}"
    end
 end
 </pre>
@@ -158,7 +190,7 @@ end
 <code>schema01.yaml</code> : sequence of string</div>
 <pre class="program">type:   seq
 sequence:
-  - type:   string
+  - type:   str
 </pre>
 <a name="document01a.yaml"></a>
 <div class="program_caption">
@@ -170,7 +202,7 @@ sequence:
 <div class="terminal_caption">
 validate</div>
 <pre class="terminal">$ kwalify -f schema01.yaml document01a.yaml
-document01a.yaml#1: valid.
+document01a.yaml#0: valid.
 </pre>
 <a name="document01b.yaml"></a>
 <div class="program_caption">
@@ -182,10 +214,10 @@ document01a.yaml#1: valid.
 <div class="terminal_caption">
 validate</div>
 <pre class="terminal">$ kwalify -f schema01.yaml document01b.yaml
-document01b.yaml#1: INVALID
-  - [/2] string type expected but got Fixnum.
+document01b.yaml#0: INVALID
+  - [/1] '123': not a string.
 </pre>
-<p>Default '<code>type:</code>' is <code>string</code> so you can omit '<code>type: string</code>'.
+<p>Default '<code>type:</code>' is <code>str</code> so you can omit '<code>type: str</code>'.
 </p>
 <br>
 
@@ -198,13 +230,13 @@ document01b.yaml#1: INVALID
 <pre class="program">type:       map
 mapping:
   name:
-    type:      string
+    type:      str
     required:  yes
   email:
-    type:      string
+    type:      str
     pattern:   /@/
   age:
-    type:      integer
+    type:      int
   birth:
     type:      date
 </pre>
@@ -219,7 +251,7 @@ birth:  1985-01-01
 <div class="terminal_caption">
 validate</div>
 <pre class="terminal">$ kwalify -f schema02.yaml document02a.yaml
-document02a.yaml#1: valid.
+document02a.yaml#0: valid.
 </pre>
 <a name="document02b.yaml"></a>
 <div class="program_caption">
@@ -232,10 +264,10 @@ birth:  Jun 01, 1985
 <div class="terminal_caption">
 validate</div>
 <pre class="terminal">$ kwalify -f schema02.yaml document02b.yaml
-document02b.yaml#1: INVALID
-  - [/birth] date type expected but got String.
-  - [/age] integer type expected but got String.
-  - [/email] 'foo(at)mail.com' is not matched to pattern /@/.
+document02b.yaml#0: INVALID
+  - [/birth] 'Jun 01, 1985': not a date.
+  - [/age] 'twenty': not a integer.
+  - [/email] 'foo(at)mail.com': not matched to pattern /@/.
 </pre>
 <br>
 
@@ -250,10 +282,10 @@ sequence:
   - type:      map
     mapping:
       name:
-        type:      string
+        type:      str
         required:  true
       email:
-        type:      string
+        type:      str
 </pre>
 <a name="document03a.yaml"></a>
 <div class="program_caption">
@@ -268,7 +300,7 @@ sequence:
 <div class="terminal_caption">
 validate</div>
 <pre class="terminal">$ kwalify -f schema03.yaml document03a.yaml
-document03a.yaml#1: valid.
+document03a.yaml#0: valid.
 </pre>
 <a name="document03b.yaml"></a>
 <div class="program_caption">
@@ -283,10 +315,10 @@ document03a.yaml#1: valid.
 <div class="terminal_caption">
 validate</div>
 <pre class="terminal">$ kwalify -f schema03.yaml document03b.yaml
-document03b.yaml#1: INVALID
-  - [/2] key 'name' required but not found.
-  - [/2] key 'naem' is not expected.
-  - [/3] key 'mail' is not expected.
+document03b.yaml#0: INVALID
+  - [/1] key 'name:' is required.
+  - [/1] key 'naem:' is undefined.
+  - [/2] key 'mail:' is undefined.
 </pre>
 <br>
 
@@ -299,23 +331,23 @@ document03b.yaml#1: INVALID
 <pre class="program">type:      map
 mapping:
   company:
-    type:      text
+    type:      str
     required:  yes
   email:
-    type:      text
+    type:      str
   employees:
     type:      seq
     sequence:
       - type:    map
         mapping:
           code:
-            type:      integer
+            type:      int
             required:  yes
           name:
-            type:      string
+            type:      str
             required:  yes
           email:
-            type:      string
+            type:      str
 </pre>
 <a name="document04a.yaml"></a>
 <div class="program_caption">
@@ -333,7 +365,7 @@ employees:
 <div class="terminal_caption">
 validate</div>
 <pre class="terminal">$ kwalify -f schema04.yaml document04a.yaml
-document04a.yaml#1: valid.
+document04a.yaml#0: valid.
 </pre>
 <a name="document04b.yaml"></a>
 <div class="program_caption">
@@ -351,9 +383,9 @@ employees:
 <div class="terminal_caption">
 validate</div>
 <pre class="terminal">$ kwalify -f schema04.yaml document04b.yaml
-document04b.yaml#1: INVALID
-  - [/employees/1/code] integer type expected but got String.
-  - [/employees/2] key 'mail' is not expected.
+document04b.yaml#0: INVALID
+  - [/employees/0/code] 'A101': not a integer.
+  - [/employees/1] key 'mail:' is undefined.
 </pre>
 <br>
 
@@ -364,7 +396,7 @@ document04b.yaml#1: INVALID
 <dt class="dt3"><strong>
 <code>required:</code> </strong></dt>
 <dd class="dd3">
-	Value is required (default is false).
+	Value is required when true (default is false).
 </dd>
 <dt class="dt3"><strong>
 <code>enum:</code> </strong></dt>
@@ -391,30 +423,50 @@ document04b.yaml#1: INVALID
 <dd class="dd3">
 	Type of value. The followings are available:
 	 <ul type="circle">
-	 <li><code>string</code> (default)
+	 <li><code>str</code>
 	 </li>
-	 <li><code>integer</code>
+	 <li><code>int</code>
 	 </li>
 	 <li><code>float</code>
 	 </li>
-	 <li><code>number</code> (== integer or float)
+	 <li><code>number</code> (== int or float)
 	 </li>
-	 <li><code>text</code> (== string or number)
+	 <li><code>text</code> (== str or number)
 	 </li>
-	 <li><code>boolean</code>
+	 <li><code>bool</code>
 	 </li>
 	 <li><code>date</code>
 	 </li>
 	 <li><code>time</code>
 	 </li>
+	 <li><code>timestamp</code>
+	 </li>
 	 <li><code>seq</code>
 	 </li>
 	 <li><code>map</code>
 	 </li>
-	 <li><code>object</code>
+	 <li><code>scalar</code> (all but seq and map)
+	 </li>
+	 <li><code>any</code> (means any data)
 	 </li>
 	 </ul>
 </dd>
+<dt class="dt3"><strong>
+<code>range:</code> </strong></dt>
+<dd class="dd3">
+	Range of value between max and min. Type <code>seq</code>, <code>map</code>, <code>bool</code> and <code>any</code> are not available with <code>range:</code>.
+</dd>
+<dt class="dt3"><strong>
+<code>length:</code> </strong></dt>
+<dd class="dd3">
+	Range of length of value between max and min. Only type <code>str</code> and <code>text</code> are available with <code>length:</code>.
+</dd>
+<dt class="dt3"><strong>
+<code>assert:</code> </strong></dt>
+<dd class="dd3">
+	String which represents validation expression. String should contain variable name <code>val</code> which repsents value.
+	(This is an experimental function.) 
+</dd>
 </dl>
 <a name="schema05.yaml"></a>
 <div class="program_caption">
@@ -424,16 +476,21 @@ sequence:
   - type:      map
     mapping:
       name:
-        #type:      string              # omittable
+        type:       str
         required:   yes
       email:
-        #type:      string              # omittable
+        type:       str
         required:   yes
         pattern:    /@/
+      password:
+        type:       str
+        length:     { max: 16, min: 8 }
       age:
-        type:       integer
+        type:       int
+        range:      { max: 30, min: 18 }
+        # or assert: 30 &lt;= val &amp;&amp; val &lt;= 18
       blood:
-        #type:      string              # omittable
+        type:       str
         enum:
           - A
           - B
@@ -441,92 +498,127 @@ sequence:
           - AB
       birth:
         type:       date
+      memo:
+        type:       any
 </pre>
 <a name="document05a.yaml"></a>
 <div class="program_caption">
 <code>document05a.yaml</code> : valid document example</div>
-<pre class="program">- name:    foo
-  email:   foo@mail.com
-  age:     20
-  blood:   A
-  birth:   1985-01-01
-- name:    bar
-  email:   bar@mail.net
-  age:     25
-  blood:   AB
-  birth:   1980-01-01
+<pre class="program">- name:     foo
+  email:    foo@mail.com
+  password: xxx123456
+  age:      20
+  blood:    A
+  birth:    1985-01-01
+- name:     bar
+  email:    bar@mail.net
+  age:      25
+  blood:    AB
+  birth:    1980-01-01
 </pre>
 <div class="terminal_caption">
 validate</div>
 <pre class="terminal">$ kwalify -f schema05.yaml document05a.yaml
-document05a.yaml#1: valid.
+document05a.yaml#0: valid.
 </pre>
 <a name="document05b.yaml"></a>
 <div class="program_caption">
 <code>document05b.yaml</code> : invalid document example</div>
-<pre class="program">- name:    foo
-  email:   foo(at)mail.com
-  age:     twenty
-  blood:   a
-  birth:   1985-01-01
+<pre class="program">- name:     foo
+  email:    foo(at)mail.com
+  password: xxx123
+  age:      twenty
+  blood:    a
+  birth:    1985-01-01
 - given-name:  bar
   family-name: Bar
-  email:   bar@mail.net
-  age:     25
-  blood:   AB
-  birth:   1980/01/01
+  email:    bar@mail.net
+  age:      15
+  blood:    AB
+  birth:    1980/01/01
 </pre>
 <div class="terminal_caption">
 validate</div>
 <pre class="terminal">$ kwalify -f schema05.yaml document05b.yaml
-document05b.yaml#1: INVALID
-  - [/1/blood] 'a' is invalid enum value.
-  - [/1/age] integer type expected but got String.
-  - [/1/email] 'foo(at)mail.com' is not matched to pattern /@/.
-  - [/2] key 'name' required but not found.
-  - [/2] key 'family-name' is not expected.
-  - [/2] key 'given-name' is not expected.
-  - [/2/birth] date type expected but got String.
+document05b.yaml#0: INVALID
+  - [/0/blood] 'a': invalid blood value.
+  - [/0/age] 'twenty': not a integer.
+  - [/0/password] 'xxx123': too short (length 6 &lt; min 8).
+  - [/0/email] 'foo(at)mail.com': not matched to pattern /@/.
+  - [/1] key 'name:' is required.
+  - [/1] key 'family-name:' is undefined.
+  - [/1] key 'given-name:' is undefined.
+  - [/1/birth] '1980/01/01': not a date.
+  - [/1/age] '15': too small (&lt; min 18).
 </pre>
 <br>
 
 
-<a name="schema-block"></a>
-<h3 class="section2">Validator with Block</h3>
-<p><strong>Notice: This is an experimental feature.</strong>
-</p>
-<p><code>Kwalify::Validator.new()</code> method can take a block which is invoked when validation.
+<a name="schema-hook"></a>
+<h3 class="section2">Validator#validator_hook()</h3>
+<p>You can extend Kwalify::Validator class and override Kwalify::Validator#validator_hook() method.
+This method is called by Kwalify::Validator#validate().
 </p>
+<a name="schema06.yaml"></a>
+<div class="program_caption">
+schema06.yaml : 'name:' is important.</div>
+<pre class="program">type:      map
+mapping:
+  questionnaires:
+    type:      seq
+    sequence:
+      - type:      map
+        <strong>name:        Questionnaire</strong>
+        mapping:
+          name:
+            type:      str
+            required:  yes
+          answer:
+            type:      str
+            required:  yes
+            enum:
+              - good
+              - not bad
+              - bad
+          reason:
+            type:      str
+</pre>
 <a name="validate06.rb"></a>
 <div class="program_caption">
-<code>validate06.rb</code> : validate script</div>
+validate06.rb : validate script</div>
 <pre class="program">#!/usr/bin/env ruby
 
 require 'kwalify'
 require 'yaml'
 
-## load schema definition
-schema_filename = 'schema06.yaml'
-schema_str = File.read(schema_filename)
-schema_hash = YAML.load(schema_str)
-
-## create validator with a block
-validator = Kwalify::Validator.new(schema_hash) <strong>{ |schema, data, errors, path|</strong>
-   case <strong>schema.name</strong>     ## refer schema name
-   when <strong>"USERNAME"</strong>
-      username = data
-      if username.length &gt; 16
-         errors &lt;&lt; Kwalify::ValidationError.new("too long (&gt;16).", path, schema)
-      end
-   when <strong>"AGE"</strong>
-      age = data
-      if age &lt; 13
-         errors &lt;&lt; Kwalify::ValidationError.new("too young (&lt;13).", path, schema)
-      elsif age &gt;= 60
-         errors &lt;&lt; Kwalify::ValidationError.new("too old (&gt;=60).", path, schema)
+## validator class for questionnaires
+class QuestionnairesValidator &lt; Kwalify::Validator
+
+   ## load schema definition
+   @@schema = YAML.load_file('schema06.yaml')
+
+   def initialize()
+      super(@@schema)
+   end
+
+   ## hook method called by Validator#validate()
+   <strong>def validate_hook(value, rule, path, errors)</strong>
+      <strong>case rule.name</strong>
+      <strong>when 'Questionnaire'</strong>
+         if value['answer'] == 'bad'
+            reason = value['reason']
+            if !reason || reason.empty?
+               msg = "reason is required when answer is 'bad'."
+               errors &lt;&lt; Kwalify::ValidationError.new(msg, path)
+            end
+         end
       end
    end
-<strong>}</strong>
+
+end
+
+## create validator
+validator = QuestionnairesValidator.new
 
 ## load YAML document
 input = ARGF.read()
@@ -540,40 +632,22 @@ else
    puts "*** INVALID!"
    errors.each do |error|
       # error.class == Kwalify::ValidationError
-      puts " - #{error.message}"
+      puts " - [#{error.path}] : #{error.message}"
    end
 end
 </pre>
-<a name="schema06.yaml"></a>
-<div class="program_caption">
-<code>schema06.yaml</code> : 'name:' is important.</div>
-<pre class="program">type:      map
-mapping:
-  members:
-    type:      seq
-    sequence:
-      - type:      map
-        mapping:
-          username:
-            required:  yes
-            <strong>name:</strong>      <strong>USERNAME</strong>
-          email:
-            required:  yes
-            pattern:   /@/
-          age:
-            type:      integer
-            <strong>name:</strong>      <strong>AGE</strong>
-</pre>
 <a name="document06a.yaml"></a>
 <div class="program_caption">
 <code>document06a.yaml</code> : valid document example</div>
-<pre class="program">members:
-  - username:     foo
-    email:        foo@mail.com
-    age:          19
-  - username:     bar
-    email:        bar@mail.org
-    age:          21
+<pre class="program">questionnaires:
+  - name:      Foo
+    answer:    good
+    reason:    I like this style.
+  - name:      Bar
+    answer:    not bad
+  - name:      Baz
+    answer:    bad
+    reason:    I don't like this style.
 </pre>
 <div class="terminal_caption">
 validate</div>
@@ -583,20 +657,80 @@ Valid.
 <a name="document06b.yaml"></a>
 <div class="program_caption">
 <code>document06b.yaml</code> : invalid document example</div>
-<pre class="program">members:
-  - username:     toooooooloooooong
-    email:        foo@mail.com
-    age:          20
-  - username:     bar
-    email:        bar@mail.org
-    age:          12
+<pre class="program">questionnaires:
+  - name:    Foo
+    answer:   good
+  - name:    Bar
+    answer:   bad
+  - name:    Baz
+    answer:   not bad
 </pre>
 <div class="terminal_caption">
 validate</div>
 <pre class="terminal">$ ruby validate06.rb document06b.yaml
 *** INVALID!
- - [/members/1/username] too long (&gt;16).
- - [/members/2/age] too young (&lt;13).
+ - [/questionnaires/1] : reason is required when answer is 'bad'.
+</pre>
+<br>
+
+
+<a name="schema-block"></a>
+<h3 class="section2">Validator with Block</h3>
+<p><strong>Notice: This is an experimental feature.</strong>
+</p>
+<p><code>Kwalify::Validator.new()</code> method can take a block which is invoked when validation.
+</p>
+<a name="validate07.rb"></a>
+<div class="program_caption">
+<code>validate07.rb</code> : validate script</div>
+<pre class="program">#!/usr/bin/env ruby
+
+require 'kwalify'
+require 'yaml'
+
+## load schema definition
+schema = YAML.load_file('schema06.yaml')
+
+## create validator for questionnaires
+validator = Kwalify::Validator.new(schema) <strong>{ |value, rule, path, errors|</strong>
+   <strong>case rule.name</strong>
+   <strong>when 'Questionnaire'</strong>
+      if value['answer'] == 'bad'
+         reason = value['reason']
+         if !reason || reason.empty?
+            msg = "reason is required when answer is 'bad'."
+            errors &lt;&lt; Kwalify::ValidationError.new(msg, path)
+         end
+      end
+   end
+<strong>}</strong>
+
+## load YAML document
+input = ARGF.read()
+document = YAML.load(input)
+
+## validate
+errors = validator.validate(document)
+if errors.empty?
+   puts "Valid."
+else
+   puts "*** INVALID!"
+   errors.each do |error|
+      # error.class == Kwalify::ValidationError
+      puts " - [#{error.path}] : #{error.message}"
+   end
+end
+</pre>
+<div class="terminal_caption">
+validate</div>
+<pre class="terminal">$ ruby validate07.rb document06a.yaml
+Valid.
+</pre>
+<div class="terminal_caption">
+validate</div>
+<pre class="terminal">$ ruby validate07.rb document06b.yaml
+*** INVALID!
+ - [/questionnaires/1] : reason is required when answer is 'bad'.
 </pre>
 <br>
 
@@ -620,7 +754,7 @@ mapping:
   "email":
     pattern:   /@/
   "age":
-    type:      integer
+    type:      int
   "birth":
     type:      date
 </pre>
@@ -635,7 +769,7 @@ mapping:
  "email":
     pattern:   /@/
  "age":
-    type:      integer
+    type:      int
  "birth":
     type:      date
 </pre>
@@ -655,7 +789,7 @@ sequence:
     type:      map
     mapping:
      "given-name": <strong>&amp;name</strong>
-        type:     string
+        type:     str
         required: yes
      "family-name": <strong>*name</strong>
      "post":
@@ -691,7 +825,7 @@ sequence:
 <div class="terminal_caption">
 validate</div>
 <pre class="terminal">$ kwalify -f schema12.yaml document12a.yaml
-document12a.yaml#1: valid.
+document12a.yaml#0: valid.
 </pre>
 <br>