kwalify 0.6.1 → 0.7.0

data/test/Rookbook.yaml

@@ -0,0 +1,10 @@
+
+recipes:
+
+  - product:	:diff
+    ingreds:	[ test-parser-yaml.yaml, test-yaml-parser.yaml ]
+    byprods:	[ hoge.yaml, hoge.diff ]
+    method*: |
+	sys "ruby -e 's=ARGF.read(); print s.gsub(/^locations:.*?(?=^\\S)/m,\"\").gsub(/Kwalify::SyntaxError/,\"Kwalify::YamlSyntaxError\")' #{@ingreds[0]} > #{@byprods[0]}"
+	sys! "diff -U5 hoge.yaml #{@ingreds[1]} | tee #{@byprods[1]}"
+	rm @byprods

data/test/{tmp.dir/Context.java → data/users-guide/AddressBook.java.expected}

@@ -1,18 +1,18 @@
-// generated by kwalify from action2.schema
+// generated by kwalify from address_book.schema.yaml
 
 import java.util.*;
 
 /**
- *  
+ *  address-book class
  */
-public class Context {
+public class AddressBook {
 
     private List _groups;
-    private List _users;
+    private List _people;
 
-    public Context() {}
+    public AddressBook() {}
 
-    public Context(Map map) {
+    public AddressBook(Map map) {
         List seq;
         Object obj;
         if ((seq = (List)map.get("groups")) != null) {
@@ -23,18 +23,18 @@ public class Context {
             }
         }
         _groups       = seq;
-        if ((seq = (List)map.get("users")) != null) {
+        if ((seq = (List)map.get("people")) != null) {
             for (int i = 0; i < seq.size(); i++) {
                 if ((obj = seq.get(i)) instanceof Map) {
-                    seq.set(i, new User((Map)obj));
+                    seq.set(i, new Person((Map)obj));
                 }
             }
         }
-        _users        = seq;
+        _people       = seq;
     }
 
     public List getGroups() { return _groups; }
     public void setGroups(List groups_) { _groups = groups_; }
-    public List getUsers() { return _users; }
-    public void setUsers(List users_) { _users = users_; }
+    public List getPeople() { return _people; }
+    public void setPeople(List people_) { _people = people_; }
 }

data/test/data/users-guide/BABEL.data.yaml

@@ -0,0 +1,24 @@
+teams:
+  - &thechildren
+    name:   The Children
+    desc:   Level 7 ESPers
+    chief:  *minamoto                  # preceding alias
+    members:  [*kaoru, *aoi, *shiho]   # preceding aliases
+
+members:
+  - &minamoto
+    name:   Kohichi Minamoto
+    desc:   Scientist
+    team:   *thechildren
+  - &kaoru
+    name:   Kaoru Akashi
+    desc:   Psychokino
+    team:   *thechildren
+  - &aoi
+    name:   Aoi Nogami
+    desc:   Teleporter
+    team:   *thechildren
+  - &shiho
+    name:   Shiho Sannomiya
+    desc:   Psycometrer
+    team:   *thechildren

data/test/data/users-guide/BABEL.schema.yaml

@@ -0,0 +1,30 @@
+type: map
+required: yes
+mapping:
+ "teams":
+    type: seq
+    required: yes
+    sequence:
+      - &team
+        type:  map
+        required: yes
+        class:  Team
+        mapping:
+         "name":  {type: str, required: yes, unique: yes}
+         "desc":  {type: str}
+         "chief":  *member       # preceding alias
+         "members":
+            type: seq
+            sequence: [*member]  # preceding alias
+ "members":
+    type: seq
+    required: yes
+    sequence:
+      - &member
+        type:  map
+        required: yes
+        class:  Member
+        mapping:
+         "name":  {type: str, required: yes, unique: yes}
+         "desc":  {type: str}
+         "team":  *team

data/test/data/users-guide/ExampleAddressBook.java

@@ -0,0 +1,47 @@
+import java.util.*;
+import kwalify.*;
+
+public class ExampleAddressBook {
+    public static void main(String args[]) throws Exception {
+        // read schema
+        String schema_str = Util.readFile("address_book.schema.yaml");
+        schema_str = Util.untabify(schema_str);
+        Object schema = new YamlParser(schema_str).parse();
+
+        // read document file
+        String document_str = Util.readFile("address_book.yaml");
+        document_str = Util.untabify(document_str);
+        YamlParser parser = new YamlParser(document_str);
+        Object document = parser.parse();
+
+        // create address book object
+        AddressBook addrbook = new AddressBook((Map)document);
+
+        // show groups
+        List groups = addrbook.getGroups();
+        if (groups != null) {
+            for (Iterator it = groups.iterator(); it.hasNext(); ) {
+                Group group = (Group)it.next();
+                System.out.println("group name: " + group.getName());
+                System.out.println("group desc: " + group.getDesc());
+                System.out.println();
+            }
+        }
+
+        // show people
+        List people = addrbook.getPeople();
+        if (people != null) {
+            for (Iterator it = people.iterator(); it.hasNext(); ) {
+                Person person = (Person)it.next();
+                System.out.println("person name:  " + person.getName());
+                System.out.println("person group: " + person.getGroup());
+                System.out.println("person email: " + person.getEmail());
+                System.out.println("person phone: " + person.getPhone());
+                System.out.println("person blood: " + person.getBlood());
+                System.out.println("person birth: " + person.getBirth());
+                System.out.println();
+            }
+        }
+    }
+
+}

data/test/{tmp.dir/Group.java → data/users-guide/Group.java.expected}

@@ -1,33 +1,24 @@
-// generated by kwalify from action2.schema
+// generated by kwalify from address_book.schema.yaml
 
 import java.util.*;
 
 /**
- *  
+ *  group class
  */
 public class Group {
 
     private String _name;
     private String _desc;
-    private User _owner;
 
     public Group() {}
 
     public Group(Map map) {
         _name         = (String)map.get("name");
         _desc         = (String)map.get("desc");
-        Object obj;
-        if ((obj = map.get("owner")) != null && obj instanceof Map) {
-            _owner    = new User((Map)obj);
-        } else {
-            _owner    = (User)obj;
-        }
     }
 
     public String getName() { return _name; }
     public void setName(String name_) { _name = name_; }
     public String getDesc() { return _desc; }
     public void setDesc(String desc_) { _desc = desc_; }
-    public User getOwner() { return _owner; }
-    public void setOwner(User owner_) { _owner = owner_; }
 }

data/test/data/users-guide/Person.java.expected

@@ -0,0 +1,44 @@
+// generated by kwalify from address_book.schema.yaml
+
+import java.util.*;
+
+/**
+ *  person class
+ */
+public class Person {
+
+    private String _name;
+    private String _desc;
+    private String _group;
+    private String _email;
+    private String _phone;
+    private Date _birth;
+    private String _blood;
+
+    public Person() {}
+
+    public Person(Map map) {
+        _name         = (String)map.get("name");
+        _desc         = (String)map.get("desc");
+        _group        = (String)map.get("group");
+        _email        = (String)map.get("email");
+        _phone        = (String)map.get("phone");
+        _birth        = (Date)map.get("birth");
+        _blood        = (String)map.get("blood");
+    }
+
+    public String getName() { return _name; }
+    public void setName(String name_) { _name = name_; }
+    public String getDesc() { return _desc; }
+    public void setDesc(String desc_) { _desc = desc_; }
+    public String getGroup() { return _group; }
+    public void setGroup(String group_) { _group = group_; }
+    public String getEmail() { return _email; }
+    public void setEmail(String email_) { _email = email_; }
+    public String getPhone() { return _phone; }
+    public void setPhone(String phone_) { _phone = phone_; }
+    public Date getBirth() { return _birth; }
+    public void setBirth(Date birth_) { _birth = birth_; }
+    public String getBlood() { return _blood; }
+    public void setBlood(String blood_) { _blood = blood_; }
+}

data/test/data/users-guide/address_book.rb

@@ -0,0 +1,52 @@
+## address-book class
+class AddressBook
+  def initialize(hash=nil)
+    if hash.nil?
+      return
+    end
+    @groups           = (v=hash['groups']) ? v.map!{|e| e.is_a?(Group) ? e : Group.new(e)} : v
+    @people           = (v=hash['people']) ? v.map!{|e| e.is_a?(Person) ? e : Person.new(e)} : v
+  end
+  attr_accessor :groups           # seq
+  attr_accessor :people           # seq
+end
+
+## group class
+class Group
+  def initialize(hash=nil)
+    if hash.nil?
+      return
+    end
+    @name             = hash['name']
+    @desc             = hash['desc']
+  end
+  attr_accessor :name             # str
+  attr_accessor :desc             # str
+end
+
+## person class
+class Person
+  def initialize(hash=nil)
+    if hash.nil?
+      @deleted          = false
+      return
+    end
+    @name             = hash['name']
+    @desc             = hash['desc']
+    @group            = hash['group']
+    @email            = hash['email']
+    @phone            = hash['phone']
+    @birth            = hash['birth']
+    @blood            = hash['blood']
+    @deleted          = (v=hash['deleted']).nil? ? false : v
+  end
+  attr_accessor :name             # str
+  attr_accessor :desc             # str
+  attr_accessor :group            # str
+  attr_accessor :email            # str
+  attr_accessor :phone            # str
+  attr_accessor :birth            # date
+  attr_accessor :blood            # str
+  attr_accessor :deleted          # bool
+  def deleted?      ;  @deleted      ; end
+end

data/test/data/users-guide/address_book.schema.yaml

@@ -0,0 +1,28 @@
+type:  map
+class:  AddressBook
+desc:  address-book class
+mapping:
+ "groups":
+    type:  seq
+    sequence:
+      - type:  map
+        class:  Group
+        desc:  group class
+        mapping:
+         "name":  { type: str,  required: yes }
+         "desc":  { type: str }
+ "people":
+    type:  seq
+    sequence:
+      - type:  map
+        class:  Person
+        desc:  person class
+        mapping:
+         "name":  { type: str, required: yes }
+         "desc":  { type: str }
+         "group": { type: str }
+         "email": { type: str, pattern: '/@/' }
+         "phone": { type: str }
+         "birth": { type: date }
+         "blood": { type: str, enum: [A, B, O, AB] }
+         "deleted": { type: bool, default: false }

data/test/data/users-guide/address_book.yaml

@@ -0,0 +1,27 @@
+groups:
+
+  - name:   family
+    desc:   my family
+
+  - name:   friend
+    desc:   my friends
+
+  - name:   business
+    desc:   those who works together
+
+people:
+
+  - name:   Sumire
+    group:  family
+    birth:  2000-01-01
+    blood:  A
+
+  - name:   Shiina
+    group:  friend
+    birth:  1995-01-01
+    email:  shiina@mail.org
+
+  - name:   Sakura
+    group:  business
+    email:  cherry@mail.net
+    phone:  012-345-6789

data/test/data/users-guide/answers-schema.yaml

@@ -0,0 +1,12 @@
+type:      map
+mapping:
+ "answers":
+    type:      seq
+    sequence:
+      - type:      map
+        name:        Answer
+        mapping:
+         "name":   { type: str, required: yes }
+         "answer": { type: str, required: yes,
+                     enum: [good, not bad, bad] }
+         "reason": { type: str }

data/test/data/users-guide/answers-validator.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+require 'kwalify'
+
+## validator class for answers
+class AnswersValidator < Kwalify::Validator
+
+   ## load schema definition
+   @@schema = Kwalify::Yaml.load_file('answers-schema.yaml')
+   ## or
+   ##   require 'yaml'
+   ##   @@schema = YAML.load_file('answers-schema.yaml')
+
+   def initialize()
+      super(@@schema)
+   end
+
+   ## hook method called by Validator#validate()
+   def validate_hook(value, rule, path, errors)
+      case rule.name
+      when 'Answer'
+         if value['answer'] == 'bad'
+            reason = value['reason']
+            if !reason || reason.empty?
+               msg = "reason is required when answer is 'bad'."
+               errors << Kwalify::ValidationError.new(msg, path)
+            end
+         end
+      end
+   end
+
+end
+
+## create validator
+validator = AnswersValidator.new
+
+## load YAML document
+input = ARGF.read()
+document = Kwalify::Yaml.load(input)
+## or  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

data/test/data/users-guide/babel_genclass.result

@@ -0,0 +1,26 @@
+$ kwalify -a genclass-ruby -P -f BABEL.schema.yaml \
+    --hashlike --initialize=false --module=Babel
+require 'kwalify/util/hashlike'
+
+module Babel
+
+  ## 
+  class Team
+    include Kwalify::Util::HashLike
+    attr_accessor :name             # str
+    attr_accessor :desc             # str
+    attr_accessor :chief            # map
+    attr_accessor :members          # seq
+  end
+
+  ## 
+  class Member
+    include Kwalify::Util::HashLike
+    attr_accessor :name             # str
+    attr_accessor :desc             # str
+    attr_accessor :team             # map
+  end
+
+end
+$ kwalify -a genclass-ruby -P -f BABEL.schema.yaml  \
+    --hashlike --initialize=false --module=Babel > models.rb