dc-kwalify 0.7.2

data/CHANGES.txt

@@ -0,0 +1,252 @@
+.=title:          ChangeLog
+.?release:        $Release: 0.7.2 $
+.?lastupdate:     $Date$
+.?version:        $Rev$
+
+
+.: Release 0.7.2 (2010-07-18)
+
+   .* bugfix:
+
+      .- Fix a bug that kwalify command raised error when YAML document is empty (thanks to Nuttall).
+
+      .- Fix a bug that Kwalify::Util.untabify() removed tailing empty strings.
+         
+
+.: Release 0.7.1 (2008-01-28)
+
+   .* bugfix:
+
+      .- 'Duplicated key' error is now not raised if corresponding rule
+         has 'default:' constraint.
+
+      .- Path is now copied in Kwalify::ValidationError#initialize()
+
+
+.: Release 0.7.0 (2008-01-27)
+
+   .* enhancements:
+
+      .- YAML parser is rewrited from scratch.
+         The new parser class Kwalify::Yaml::Parser is available.
+	 The old parser class Kwalify::YamlParser is stil available,
+	 but it is not recommended to use.
+
+      .- Validator is integrated with yaml parser.
+         It is able to parse and validate at once.
+	   .--------------------
+	   ## create validator
+	   require 'kwalify'
+	   schema = Kwalify::Yaml.load_file('schema.yaml')
+	   validator = Kwalify::Validator.new(schema)
+	   ## parse with validation
+	   parser = Kwalify::Yaml::Parser.new(validator)
+	   ydoc = parser.parse(File.read('data.yaml'))
+	   ## show validation errors if exist
+	   errors = parser.errors()
+	   if errors && !errors.empty?
+	     for e in errors
+	       puts "** %d:%d [%s] %s" % [e.linenum, e.column, e.path, e.message] 
+	     end
+	   end
+	   .--------------------
+
+      .- Data binding is integrated into Kwalify::Yaml::Parser.
+         If you set Kwalify::Yaml::Parser#data_binding to true
+	 and you specified class names in schema file,
+	 parser creates instance objects instead of Hash objects.
+	 It means that you don't need to add '!ruby/Classname'
+	 for each data.
+	   .? schema file (config.schema.yaml)
+	   .--------------------
+	   type:  map
+	   class: Config
+	   mapping:
+	    "host": { type: str, required: true }
+	    "port": { type: int }
+	    "user": { type: str, required: true }
+	    "pass": { type: str, required: true }
+	   .--------------------
+	   .? configuration file (config.yaml)
+	   .--------------------
+	   host:  localhost
+	   port:  8080
+	   user:  user1
+	   pass:  password1
+	   .--------------------
+	   .? ruby program (ex1.rb)
+	   .--------------------
+	   ## class definition
+	   require 'kwalify/util/hashlike'
+	   class Config
+	     include Kwalify::Util::HashLike  # defines [], []=, ...
+	     attr_accessor :host, :posrt, :user, :pass
+	   end
+	   ## create validator object
+	   require 'kwalify'
+	   schema = Kwalify::Yaml.load_file('config.schema.yaml')
+	   validator = Kwalify::Validator.new(schema)
+	   ## parse configuration file with data binding
+	   parser = Kwalify::Yaml::Parser.new(validator)
+	   parser.data_binding = true    # enable data binding
+	   config = parser.parse_file('config.yaml')
+	   p config  #=> #<Config:0x542590 @user="user1", @port=8080,
+	             #        @pass="password1", @host="localhost">
+	   .--------------------
+
+      .- Preceding alias supported.
+         If you set Kwalify::Yaml::Parser#preceding_alias to true,
+	 parser allows aliases to apprear before corresponding anchor
+	 appears.
+	 This is very useful when node graph is complex.
+	   .--------------------
+	   - name: Foo
+	     parent: *bar          # preceding alias
+	   - &bar
+	     name: Bar
+	     parent: *baz          # preceding alias
+	   - &baz
+	     name: Baz
+	   .--------------------
+
+      .- New command-line option '-P' enables preceding alias.
+
+      .- Kwalify::Yaml.load() and Kwalify::Yaml.load_file() are added.
+         They are similar to YAML.load() and YAML.load_file() but they
+	 use Kwalify::Yaml::Parser object.
+
+      .- New utilify method Kwalify::Util.traverse_schema() provided.
+           .--------------------
+	   require 'kwalify'
+	   require 'kwalify/util'
+           schema = Kwalify::Yaml.load('schema.yaml')
+	   Kwalify::Util.traverse_schema(schema) do |rulehash|
+	     if classname = rulehash['class']
+	       ## add namespace to class name
+	       rulehash['class'] = "Foo::Bar::#{classname}"
+	     end
+	   end
+           .--------------------
+
+      .- Add 'kwalify/util/hashlike.rb' which contains definition of
+         Kwalify::Util::HashLike module.
+	 This module defines [], []=, keys(), key?(), and each() methods,
+	 and these are required for data-binding.
+
+      .- Action 'genclass-ruby' supports '--hashlike' property.
+
+      .- Action 'genclass-ruby' supports '--initialize=false' property.
+
+      .- Add action 'geclass-php'
+
+      .- '\xXX' and '\uXXXX' are supported in Kwalify::Yaml::Parser.
+
+      .- New constrant 'default:' is added to kwalify.schema.yaml.
+         This constrant have no effect to validation and parsing,
+	 and it is used only in 'genclass-xxx' action.
+
+
+   .* changes:
+
+      .- Action 'genclass-ruby' and 'genclass-java' are changed to
+         generate boolean accessors.
+	 For example, attribute 'active' is specified as 'type: bool'
+	 in schema file, action 'genclass-ruby' generates
+	   "def active? ; @active; end"
+	 and action 'genclass-java' generates
+	   "public boolean isActive() { return _active; }".
+
+      .- Command-line option '-s' (silent) is obsolete and replaced with
+         '-q' (quiet). Option '-s' is still available but it is recommended
+	 to use '-q'.
+
+      .- License is changed from LGPL to MIT-LICENSE.
+
+
+.: Release 0.6.0 (2006-05-30)
+
+   .* enhancements:
+
+      .- Class definition generation support.
+         New command-line option '-a genclass-ruby' or '-a genclass-java' generates
+         class definitions in Ruby or Java from schema file.
+
+
+.: Release 0.5.1 (2005-12-20)
+
+   .* enhances:
+
+      .- add new command-line option '-E' which show errors in emacs-compatible style.
+
+
+.: Release 0.5.0 (2005-12-17)
+
+   .* enhancements:
+
+      .- Meta-validation check for 'max < min', 'max-ex <= min-ex', and so on.
+      .- Many test-cases are added
+
+   .* changes:
+
+      .- 'Parser' class is renamed to 'YamlParser'
+      .- 'PlainParser' class is renamed to 'PlainYamlParser'
+      .- YamlParser#set_error_linenums() is renamed to set_errors_linenum()
+      .- ValidatorError#<=> added
+      .- ParseError class is renamed to YamlSyntaxError
+
+
+.: Release 0.4.1 (2005-10-26)
+
+   .* bugfix:
+
+      .- Support Ruby 1.8.3 (around YAML::Syck::DomainType)
+      .- Show correct error line number when key is undefined or unknown.
+
+
+.: Release 0.4.0 (2005-10-25)
+
+   .* enhancements:
+
+      .- New command-line option '-l' prints error line numbers.
+      .- Supports default rule of mapping.
+
+
+.: Release 0.3.0 (2005-09-30)
+
+   .* enhancements:
+
+      .- Support 'max-ex' and 'min-ex' (max/min exclusive) support with 'range:'
+      .- Support 'max-ex' and 'min-ex' (max/min exclusive) support with 'length:'
+      .- Support 'unique' constraint
+
+
+.: Release 0.2.0 (2005-09-25)
+
+   .* enhancements:
+
+      .- 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'.
+
+
+.: Release 0.1.0 (2005-08-01)
+
+    .- beta release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+copyright(c) 2005-2010 kuwata-lab all rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.txt

@@ -0,0 +1,61 @@
+= README
+
+release::	0.7.2
+lastupdate::	$Date$
+copyright::	copyright(c) 2005-2010 kuwata-lab all rights reserved.
+
+
+
+== Introduction
+
+Kwalify is a parser, schema validator, and data binding tool for
+YAML and JSON.
+
+See doc/users-guide.html for details.
+
+
+
+== Installation
+
+If you have installed RubyGems, just type 'gem install kwalify' 
+
+  $ sudo gem install kwalify
+   
+Else if you can be root user, use 'setup.rb' as following:
+
+  $ tar xjf kwalify-0.7.2.tar.bz2
+  $ cd kwalify-0.7.2/
+  $ sudo ruby setup.rb install
+
+Else copy script and libraries to proper directory.
+
+  $ tar xjf kwalify-0.7.2.tar.bz2
+  $ cd kwalify-0.7.2/
+  $ 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
+
+(Optional) 'contrib/inline-require' script to concatenate all script
+and libraries into a file.
+  
+  $ tar xjf kwalify-0.7.2.tar.bz2
+  $ cd kwalify-0.7.2/
+  $ unset RUBYLIB
+  $ ruby contrib/inline-require -I ./lib bin/kwalify > contrib/kwalify
+  $ chmod a+x contrib/kwalify
+  $ mv contrib/kwalify $HOME/bin
+
+
+
+== License
+
+   MIT License
+
+
+
+== Copyright
+
+   copyright(c) 2005-2010 kuwata-lab all rights reserved.

data/bin/kwalify

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+###
+### $Rev$
+### $Release: 0.7.2 $
+### copyright(c) 2005-2010 kuwata-lab all rights reserved.
+###
+
+require 'kwalify'
+require 'kwalify/main'
+
+command = File.basename($0)
+Kwalify::Main.main(command, ARGV)

data/contrib/inline-require

@@ -0,0 +1,179 @@
+#!/usr/bin/env ruby
+
+###
+### inline-require - expand 'require "foo"' into inline code
+###
+### usage: inline-require [-h] [-I path[,path2,..]] script
+###
+### copyright(c) 2005-2010 kuwata-lab all rights reserved.
+### 0.7.2
+### $Rev: 10 $
+###
+
+
+class InlineRequire
+
+   def initialize(opts={})
+      @opts = opts.dup
+   end
+   attr_accessor :opts
+
+   def expand(filename)
+      sbuf = ''
+      inlined = []
+      level = 0
+      expand_require(filename, sbuf, inlined, level)
+      return sbuf
+   end
+
+   private
+
+   def expand_require(filename, sbuf, inlined, level)
+      raise "*** assertion error" if inlined.include?(filename)
+      remove_comment  = @opts[:remove_comment]
+      expand_indented = @opts[:expand_indented]
+      keep_filename   = @opts[:keep_filename]
+      loaded_features = @opts[:loaded_features]
+      inlined << filename
+      prog = File.read(filename)
+      n = 0
+      flag_if_file = false
+      prog.each_line do |line|
+         n += 1
+
+         ## comment out from 'if __FILE__ == $0' to 'end'
+         if level > 0
+            if flag_if_file
+               sbuf << "#" << line
+               flag_if_file = false if line =~ /^end$/
+               next
+            end
+            if line =~ /^if\s+__FILE__\s*==\s*\$0(\s+then)?$/ || line =~ /^if\s+\$0\s*==\s*__FILE__(\s+then)?$/
+               flag_if_file = true
+               sbuf << "#" << line
+               next
+            end
+         end
+
+         ## find 'require "foo"' and expand it to inline code
+         flag_inline = false
+         pattern = expand_indented ? /^[ \t]*require ['"](.*)["']\s*$/ \
+                                   :       /^require ['"](.*)["']\s*$/
+         if line =~ pattern
+            libname = $1
+            libpath = find_library(libname)
+            $stderr.puts "*** debug: libpath=#{libpath.inspect}" if $debug_mode
+            unless libpath
+               #raise "file '#{filename}'(line #{n}): library '#{libname}' not found."
+               warn "file '#{filename}'(line #{n}): library '#{libname}' not found."
+            else
+              flag_inline = true if libpath =~ /\.rb$/ && local_library?(libpath)
+            end
+         end
+         if !flag_inline
+            sbuf << line   unless remove_comment && line =~ /^[ \t]*\#/
+         elsif inlined.include?(libpath)
+            sbuf << "#--already included #{line}"     unless remove_comment
+         else
+            if keep_filename
+               @n ||= 0;  @n += 1;  n = @n
+            end
+            sbuf << "#--begin of #{line}"             unless remove_comment
+            sbuf << "$LOADED_FEATURES << '#{libname}.rb'\n" if loaded_features
+            sbuf << "eval <<'END_OF_SCRIPT__#{n}', TOPLEVEL_BINDING, '#{libpath}', 1\n" if keep_filename
+            expand_require(libpath, sbuf, inlined, level+1)
+            sbuf << "END_OF_SCRIPT__#{n}\n"               if keep_filename
+            sbuf << "#--end of #{line}"               unless remove_comment
+         end
+      end
+      #sbuf << "\n" if sbuf[-1] != ?\n
+   end
+
+   def local_library?(libpath)
+      return libpath !~ /^\//
+   end
+
+   def find_library(libname)
+      if libname =~ /^\.rb$/
+         libname_rb = libname
+         libname_so = nil
+      elsif libname =~ /^\.so$/
+         libname_rb = nil
+         libname_so = libname
+      else
+         libname_rb = libname + ".rb"
+         libname_so = libname + ".so"
+      end
+      $LOAD_PATH.each do |path|
+         if libname_rb
+            libpath = path + "/" + libname_rb
+            return libpath if test(?f, libpath)
+         end
+         if libname_so
+            libpath = path + "/" + libname_so
+            return libpath if test(?f, libpath)
+         end
+      end
+      return nil
+   end
+
+end
+
+if __FILE__ == $0
+
+   begin
+      require "optparse"
+      op = OptionParser.new
+      options = {}
+      op.on("-h", "--help") {|v| options[:help] = v }
+      op.on("-I libpath")   {|v| options[:libpath] = v }
+      op.on("-i")           {|v| options[:expand_indented] = v }
+      op.on("-c")           {|v| options[:remove_comment] = v }
+      op.on("-k")           {|v| options[:keep_filename] = v }
+      op.on("-l")           {|v| options[:loaded_features] = v }
+      op.on("-D")           {|v| options[:debug] = v }
+      op.parse!()
+
+      $debug_mode = options[:debug]
+
+      if options[:help]
+         command = File.basename($0)
+         puts "Usage: #{command} [-h] [-I path[,path2,..]] script"
+         puts "  -h                   : help"
+         puts "  -i                   : expand indented require(), too"
+         puts "  -c                   : remove comment lines start with '#'"
+         puts "  -k                   : keep filename (for debugging)"
+         puts "  -l                   : append libs to $LOADED_FEATURES"
+         puts "  -I path[,path2,...]  : ruby library path"
+         exit(0)
+      end
+
+      if options[:libpath]
+         rubylib_paths = options[:libpath].split(/,/)
+      else
+         rubylib_paths = []
+      end
+      $stderr.puts "*** debug: rubylib_paths=#{rubylib_paths.inspect}" if $debug_mode
+      $LOAD_PATH.concat(rubylib_paths)
+
+      filenames = ARGV
+
+      opts = { :expand_indented => options[:expand_indented],
+               :remove_comment  => options[:remove_comment],
+               :keep_filename   => options[:keep_filename],
+               :loaded_features => options[:loaded_features] }
+      inline_require = InlineRequire.new(opts)
+      filenames.each do |filename|
+         print inline_require.expand(filename)
+      end
+
+   rescue => ex
+      if $debug_mode
+         raise ex
+      else
+         $stderr.puts ex.message
+      end
+
+   end
+
+end