kwalify 0.1.0

data/examples/address-book/Makefile

@@ -0,0 +1,4 @@
+
+all:
+	kwalify -f address-book.schema.yaml address-book.yaml
+

data/examples/address-book/address-book.schema.yaml

@@ -0,0 +1,43 @@
+##
+## Kwalify schema example for address book
+##
+## $Release: 0.1.0 $
+## copyright(c) 2005 kuwata-lab all rights reserved.
+##
+##
+## NOTE: 'type:  string' is omitted in this example because 'string' is default type.
+##
+
+type:      seq
+required:  yes
+sequence:
+  - type:      map
+    required:  yes
+    mapping:
+     "name":
+        #type:      string
+        required:  yes
+     "email":
+        #type:      string
+        pattern:   /@/
+     "tel":
+        #type:      string
+        pattern:   /^\d+-\d+-\d+$/
+     "birth":
+        type:      date
+     "age":
+        type:      integer
+     "zip":
+        #type:      string
+        pattern:   /^\d+-\d+$/
+     "addr":
+        #type:      string
+     "blood":
+        #type:      string
+        enum:
+          - A
+          - B
+          - O
+          - AB
+     "memo":
+        type:      object

data/examples/address-book/address-book.yaml

@@ -0,0 +1,36 @@
+##
+## address book example
+##
+
+- name:    Sumire
+  email:   amethyst@mail.com
+  tel:     012-111-1111
+  birth:   1985-01-01
+  age:     20
+  zip:     123-4567
+  addr:    xxxx xxxx xxxx
+  blood:   B
+  memo:    My friend
+
+- name:    Kasumi
+  email:   mist@mail.net
+  tel:     012-222-2222
+  birth:   1980-02-02
+  age:     25
+  blood:   AB
+  memo:
+    - Home tutor
+    - A doctor (university)
+
+- name:    Nana
+  email:   seven@mail.com
+  tel:     012-333-3333
+  birth:   1990-03-03
+  age:     15
+  blood:   O
+  memo:    My sister
+
+- name:    Sizuka
+  email:   quiet@mail.org
+  memo:     Firend of Sumire
+

data/examples/invoice/Makefile

@@ -0,0 +1,3 @@
+all:
+	kwalify -f invoice.schema.yaml invoice.yaml
+

data/examples/invoice/invoice.schema.yaml

@@ -0,0 +1,59 @@
+###
+### Kwalify schema example for invoice
+###
+### $Rev$
+### $Release: 0.1.0 $
+### copyright(c) 2005 kuwata-lab all rights reserved.
+###
+
+type:      map
+required:  yes
+mapping:
+ "invoice":
+    type:      integer
+    required:  yes
+ "date":
+    type:      date
+    required:  yes
+ "bill-to":  &customer
+    type:      map
+    required:  yes
+    mapping:
+     "given":
+        required:  yes
+     "family":
+        required:  yes
+     "address":
+        type:      map
+        required:  yes
+        mapping:
+         "lines":
+         "city":
+         "state":
+         "postal":
+            type:      integer
+ "ship-to":   *customer
+ "product":
+    type:      seq
+    required:  yes
+    sequence:
+      - type:      map
+        required:  yes
+        mapping:
+         "sku":
+            required:  yes
+            pattern:   /^[A-Z0-9]+$/
+         "quantity":
+            type:      integer
+            required:  yes
+         "description":
+         "price":
+            type:      float
+ "tax":
+    type:      float
+ "total":
+    type:      float
+    required:  yes
+ "comments":
+    type:      text
+

data/examples/invoice/invoice.yaml

@@ -0,0 +1,32 @@
+##
+## from http://www.yaml.org/start.html
+##
+--- !clarkevans.com/^invoice
+invoice: 34843
+date   : 2001-01-23
+bill-to: &id001
+    given  : Chris
+    family : Dumars
+    address:
+        lines: |
+            458 Walkman Dr.
+            Suite #292
+        city    : Royal Oak
+        state   : MI
+        postal  : 48046
+ship-to: *id001
+product:
+    - sku         : BL394D
+      quantity    : 4
+      description : Basketball
+      price       : 450.00
+    - sku         : BL4438H
+      quantity    : 1
+      description : Super Hoop
+      price       : 2392.00
+tax  : 251.42
+total: 4443.52
+comments: >
+    Late afternoon is best.
+    Backup contact is Nancy
+    Billsmer @ 338-4338.

data/lib/kwalify.rb

@@ -0,0 +1,10 @@
+###
+### $Rev: 5 $
+### $Release: 0.1.0 $
+### copyright(c) 2005 kuwata-lab all rights reserved.
+###
+
+require 'kwalify/types'
+require 'kwalify/error-msg'
+require 'kwalify/errors'
+require 'kwalify/validator'

data/lib/kwalify/error-msg.rb

@@ -0,0 +1,41 @@
+###
+### $Rev: 8 $
+### $Release: 0.1.0 $
+### copyright(c) 2005 kuwata-lab all rights reserved.
+###
+
+module Kwalify
+
+   ERROR_MESSAGES = {}
+
+   ## validation error
+   ERROR_MESSAGES[:missing_value]        = "value required but not found."
+   ERROR_MESSAGES[:invalid_type]         = "%s type expected but got %s."
+   ERROR_MESSAGES[:invalid_enum]         = "'%s' is invalid enum value."
+   ERROR_MESSAGES[:invalid_pattern]      = "'%s' is not matched to pattern %s."
+   ERROR_MESSAGES[:missing_key]          = "key '%s' required but not found."
+   ERROR_MESSAGES[:invalid_key]          = "key '%s' is not expected."
+
+   ## ruleset error
+   ERROR_MESSAGES[:ruleset_not_hash]     = "ruleset is not a hash."
+   ERROR_MESSAGES[:type_not_found]       = "type '%s' is not found."
+   ERROR_MESSAGES[:required_not_boolean] = "'required:' is not 'true' nor 'false'."
+   ERROR_MESSAGES[:regexp_error]         = "'pattern:' has regexp error (= %s)."
+   ERROR_MESSAGES[:enum_not_seq]         = "'enum:' is not a sequence."
+   ERROR_MESSAGES[:sequence_not_seq]     = "'sequence:' should be a sequence."
+   ERROR_MESSAGES[:sequence_no_elem]     = "'sequence:' requires one element."
+   ERROR_MESSAGES[:sequence_too_many]    = "'sequence:' requires just one element."
+   ERROR_MESSAGES[:mapping_not_map]      = "'mapping:' should be a mapping."
+   ERROR_MESSAGES[:mapping_no_elem]      = "'mapping:' requires at least one element."
+   ERROR_MESSAGES[:duplicate_key]        = "key '%s' is duplicated."
+   ERROR_MESSAGES[:unexpected_key]       = "'%s' is not expected."
+   ERROR_MESSAGES[:seq_has_enum]         = "'enum:' is not available with sequence type."
+   ERROR_MESSAGES[:seq_has_pattern]      = "'pattern:' is not available with sequence type."
+   ERROR_MESSAGES[:seq_has_mapping]      = "'mapping:' is not available with sequence type."
+   ERROR_MESSAGES[:map_has_enum]         = "'enum:' is not available with mapping type."
+   ERROR_MESSAGES[:map_has_pattern]      = "'pattern:' is not available with mapping type."
+   ERROR_MESSAGES[:map_has_sequence]     = "'sequence:' is not available with mapping type."
+   ERROR_MESSAGES[:scalar_has_sequence]  = "scalar cannot take 'sequence:'."
+   ERROR_MESSAGES[:scalar_has_mapping]   = "scalar cannot take 'mapping:'."
+
+end

data/lib/kwalify/errors.rb

@@ -0,0 +1,112 @@
+###
+### $Rev: 8 $
+### $Release: 0.1.0 $
+### copyright(c) 2005 kuwata-lab all rights reserved.
+###
+
+module Kwalify
+
+   class KwalifyError < StandardError
+   end
+
+
+   class AssertionError < KwalifyError
+      def initialize(msg)
+         super("*** assertion error: " + msg)
+      end
+   end
+
+
+   class BaseError < KwalifyError
+      def initialize(message="", path=nil, schema=nil, error_symbol=nil)
+         super(message)
+         @error_symbol = error_symbol
+         @schema       = schema
+         @path         = path
+      end
+      attr_reader :error_symbol, :schema, :path
+
+      def to_s
+         return super() if @path == nil
+         return "[/] #{super()}" if @path.empty?
+         return "[#{@path}] #{super()}"
+      end
+   end
+
+
+   class SchemaError < BaseError
+      def initialize(message="", path=nil, schema=nil, error_symbol=nil)
+         super(message, path, schema, error_symbol)
+      end
+   end
+
+
+   class ValidationError < BaseError
+      def initialize(message="", path=nil, schema=nil, error_symbol=nil, data=nil)
+         super(message, path, schema, error_symbol)
+         @data  = data
+      end
+      attr_reader :data
+   end
+
+
+   module Errors
+
+      def assert_error(message="")
+         raise AssertionError.new(message)
+      end
+
+
+      def error_message(error_symbol, schema, data, arg)
+         msg = nil
+         case error_symbol
+
+         ## validation error
+         when :missing_value
+            msg = ERROR_MESSAGES[error_symbol]
+         when :invalid_type
+            msg = ERROR_MESSAGES[error_symbol] % [ schema.type, data.class.name ]
+         when :invalid_enum
+            msg = ERROR_MESSAGES[error_symbol] % [ data.to_s ]
+         when :invalid_pattern
+            msg = ERROR_MESSAGES[error_symbol] % [ data.to_s, schema.pattern.inspect ]
+         when :missing_key
+            msg = ERROR_MESSAGES[error_symbol] % [ arg ]     # arg is keyname
+         when :invalid_key
+            msg = ERROR_MESSAGES[error_symbol] % [ arg ]     # arg is keyname
+
+         ## schema error
+         when :unexpected_key
+            msg = ERROR_MESSAGES[error_symbol] % [ arg ]     # arg is keyname
+         when :duplicate_key
+            msg = ERROR_MESSAGES[error_symbol] % [ arg ]     # arg is keyname
+         when :type_not_found
+            msg = ERROR_MESSAGES[error_symbol] % [ arg ]     # arg is typename
+         when :regexp_error
+            msg = ERROR_MESSAGES[error_symbol] % [ data ]
+         else
+            msg = ERROR_MESSAGES[error_symbol]
+         end
+
+         ##
+         return msg
+      end
+
+
+      def validate_error(error_symbol, schema, path, data, arg=nil)
+         msg = error_message(error_symbol, schema, data, arg)
+         return ValidationError.new(msg, path, schema, error_symbol, data)
+      end
+
+
+      def schema_error(error_symbol, schema, path, arg=nil)
+         msg = error_message(error_symbol, schema, nil, arg)
+         return SchemaError.new(msg, path, schema, error_symbol)
+      end
+
+
+      module_function :assert_error, :validate_error, :schema_error, :error_message
+
+   end
+
+end

data/lib/kwalify/meta-validator.rb

@@ -0,0 +1,137 @@
+###
+### $Rev: 9 $
+### $Release: 0.1.0 $
+### copyright(c) 2005 kuwata-lab all rights reserved.
+###
+
+require 'kwalify/errors'
+require 'kwalify/validator'
+require 'yaml'
+
+module Kwalify
+
+   META_SCHEMA_DEF = <<'END'
+
+name:      MAIN
+type:      map
+required:  yes
+mapping:   &main-schema
+ "name":
+    type:      string
+ "desc":
+    type:      text
+ "type":
+    type:      string
+    enum:
+      - seq
+      - sequence
+      #- list
+      - map
+      - mapping
+      #- hash
+      - string
+      - integer
+      - float
+      - number
+      - numeric
+      - bool
+      - boolean
+      - text
+      - date
+      - time
+      - object
+      - any
+ "required":
+    type:      boolean
+ "enum":
+    type:      seq
+    sequence:
+      - type:     object
+ "pattern":
+    type:      string
+ "sequence":
+    name:      SEQUENCE
+    type:      seq
+    sequence:
+      - type:      map
+        mapping:   *main-schema
+        name:      MAIN
+ "mapping":
+    name:      MAPPING
+    type:      map
+    mapping:
+      '*':
+        type:      map
+        mapping:   *main-schema
+        name:      MAIN
+
+END
+
+
+   def self.meta_validator()
+      yaml = YAML.load(META_SCHEMA_DEF)
+      validator = Kwalify::Validator.new(yaml)
+      return validator
+   end
+
+
+   def self.meta_validator2()
+      yaml = YAML.load(META_SCHEMA_DEF)
+      validator = Kwalify::Validator.new(yaml) { |schema, obj, errors, path|
+         next if obj == nil     ## realy?
+         if schema.name == "MAIN"
+            hash = obj
+            if hash.key?('pattern')
+               val = hash['pattern']
+               pat = (val =~ /\A\/(.*)\/\z/ ? $1 : val)
+               begin
+                  Regexp.compile(pat)
+               rescue RegexpError => ex
+                  errors << Kwalify::Errors.validate_error(:regexp_error, schema, path, obj)
+               end
+            end
+            type = hash['type']
+            if type == nil
+               if hash.key?('sequence')
+                  type = 'seq'
+               elsif hash.key?('mapping')
+                  type = 'map'
+               else
+                  type = Kwalify::DEFAULT_TYPE
+               end
+            end
+            klass = Kwalify.type_table[type]
+            if klass == nil
+               errors << Kwalify::Errors.validate_error(:invalid_type, schema, path, obj)
+            elsif klass == Array
+               errors << Kwalify::Errors.validate_error(:seq_has_enum,     schema, path, obj) if hash.key?('enum')
+               errors << Kwalify::Errors.validate_error(:seq_has_pattern,  schema, path, obj) if hash.key?('pattern')
+               errors << Kwalify::Errors.validate_error(:seq_has_mapping,  schema, path, obj) if hash.key?('mapping')
+            elsif klass == Hash
+               errors << Kwalify::Errors.validate_error(:map_has_enum,     schema, path, obj) if hash.key?('enum')
+               errors << Kwalify::Errors.validate_error(:map_has_pattern,  schema, path, obj) if hash.key?('pattern')
+               errors << Kwalify::Errors.validate_error(:map_has_sequence, schema, path, obj) if hash.key?('sequence')
+            else
+               errors << Kwalify::Errors.validate_error(:scalar_has_sequence, schema, path, obj) if hash.key?('sequence')
+               errors << Kwalify::Errors.validate_error(:scalar_has_mapping,  schema, path, obj) if hash.key?('mapping')
+            end
+         elsif schema.name == "SEQUENCE"
+            if !obj.is_a?(Array)
+               errors << Kwalify::Errors.validate_error(:sequence_not_seq,  schema, path, obj)
+            else
+               errors << Kwalify::Errors.validate_error(:sequence_no_elem,  schema, path, obj) if obj.empty?
+               errors << Kwalify::Errors.validate_error(:sequence_too_many, schema, path, obj) if obj.length > 1
+            end
+         elsif schema.name == "MAPPING"
+            if !obj.is_a?(Hash)
+               errors << Kwalify::Errors.validate_error(:mapping_not_map,   schema, path, obj)
+            else
+               errors << Kwalify::Errors.validate_error(:mapping_no_elem,   schema, path, obj) if obj.empty?
+            end
+         end
+      }
+      return validator
+   end
+
+end
+