yamo 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+vendor/gems
+vendor/bin
+
+## PROJECT::SPECIFIC

data/Gemfile

@@ -0,0 +1,7 @@
+gem "jeweler"
+gem "kwalify"
+gem "rake"
+gem "yard"
+
+bin_path "vendor/bin"
+disable_system_gems

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kenneth Vestergaard Schmidt
+
+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.rdoc

@@ -0,0 +1,17 @@
+= yamo
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Kenneth Vestergaard Schmidt. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "yamo"
+    gem.summary = %Q{YAML Model Objects}
+    gem.description = %Q{Classes for loading schema-validated YAML, and creating nice Ruby-objects with accessors}
+    gem.email = "kvs@binarysolutions.dk"
+    gem.homepage = "http://github.com/kvs/yamo"
+    gem.authors = ["Kenneth Vestergaard Schmidt"]
+    gem.add_development_dependency "yard", ">= 0"
+    gem.add_dependency('kwalify', '>=0.7.1')
+    gem.required_ruby_version = '>= 1.9.1'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/yamo.rb

@@ -0,0 +1,6 @@
+# -*- mode: ruby; tab-width: 2; indent-tabs-mode: nil; -*-
+
+module Yamo; end
+
+require 'yamo/collection'
+require 'yamo/singleton'

data/lib/yamo/collection.rb

@@ -0,0 +1,41 @@
+# -*- mode: ruby; tab-width: 2; indent-tabs-mode: nil; -*-
+
+require 'yamo/object'
+require 'singleton'
+
+module Yamo; end
+
+class Yamo::Collection < Yamo::Object
+  extend Enumerable
+
+  attr_reader :name
+
+  def initialize(name, data)
+    @name = name
+    @data = data
+  end
+
+  def self.objectdir(objectdir)
+    @objectdir = objectdir
+  end
+
+  def self.get(name)
+    begin
+      self.new(name, load_and_validate_file("#{@objectdir}/#{name}"))
+    rescue Errno::ENOENT
+      nil
+    end
+  end
+
+  def self.each
+    Dir.foreach(@objectdir) do |o|
+      next if o.match(/^\./)
+      yield get(o)
+    end
+  end
+
+  # Include name in +to_s+
+  def to_s
+    return '#<' + self.class.to_s + ":" + self.name + '>'
+  end
+end

data/lib/yamo/object.rb

@@ -0,0 +1,49 @@
+# -*- mode: ruby; tab-width: 2; indent-tabs-mode: nil; -*-
+
+require 'yamo/validator'
+
+module Yamo; end
+
+# Yamo::Object is a base-class for a data-object, externally stored in YAML,
+# with a Kwalify-schema and optional validation-hooks.
+class Yamo::Object
+  attr_reader :data
+
+  def self.schema(schema)
+    @validator = Yamo::Validator.new(schema)
+    @validator.hook = self
+
+    create_accessors(@validator.schema["mapping"])
+  end
+
+  def self.validator
+    @validator
+  end
+  
+  def self.create_accessors(schema, obj=nil)
+    # Generate instance accessor methods
+    schema.each_pair do |key, value|
+      # We either generate methods on the Class instance of this object, or on a simple instance-object.
+      receiver = (obj.nil?) ? self : (class << obj ; self; end)
+      receiver.send :define_method, key.gsub('-', '_') do
+        retval = (obj ? obj[key] : @data[key]) || value["default"]
+        if value["type"] == "map"
+          retval = retval.nil? ? Hash.new : retval.dup
+          Yamo::Object.create_accessors(value["mapping"], retval)
+        end
+        retval
+      end
+    end
+  end
+
+  # Load and validate +file+. Source is either eval'd or YAML, depending on +yaml+
+  def self.load_and_validate_file(file, yaml=false); load_and_validate_source(file, yaml, true); end
+
+  # Validate +data+. Source is either eval'd or YAML, depending on +yaml+
+  def self.validate_data(data, yaml=false); load_and_validate_source(data, yaml, false); end
+
+  # Validate +src+, interpreting it as a file if +file+ is true, or as a String to eval if +file+ is false.
+  def self.load_and_validate_source(src, yaml, file)
+    @validator.load_and_validate_source(src, yaml, file)
+  end
+end

data/lib/yamo/singleton.rb

@@ -0,0 +1,19 @@
+# -*- mode: ruby; tab-width: 2; indent-tabs-mode: nil; -*-
+
+require 'yamo/object'
+require 'singleton'
+
+module Yamo; end
+
+class Yamo::Singleton < Yamo::Object
+  include Singleton
+
+  def self.object(file)
+    @@data = self.load_and_validate_file(file)
+    @object = file
+  end
+
+  def initialize
+    @data = @@data
+  end
+end

data/lib/yamo/validator.rb

@@ -0,0 +1,69 @@
+# -*- mode: ruby; tab-width: 2; indent-tabs-mode: nil; -*-
+
+require 'kwalify'
+require 'shellwords'
+
+module Yamo; end
+
+class Yamo::ValidateError < Exception; end
+
+class Yamo::Validator
+  attr_reader :schema
+  attr_reader :hook
+
+  def initialize(schema)
+    @hook = nil
+
+    metavalidator = Kwalify::MetaValidator.instance
+    parser = Kwalify::Yaml::Parser.new(metavalidator)
+    @schema = parser.parse_file(schema)
+    
+    if parser.errors and !parser.errors.empty?
+      raise Yamo::ValidateError, parser.errors
+    end
+
+    @validator = Kwalify::Validator.new(@schema)
+  end
+
+  def hook=(klass)
+    @hook = klass
+
+    @validator.define_singleton_method :validate_hook do |v,r,p,e|
+      klass.validate_hook(v,r,p,e) if klass.respond_to? :validate_hook
+    end
+  end
+
+  def load_and_validate_source(src, yaml, file)
+    errors = nil
+    doc = nil
+    
+    if yaml
+      parser = Kwalify::Yaml::Parser.new(validator)
+      if file
+        doc = parser.parse_file(src)
+      else
+        doc = parser.parse(src)
+      end
+      errors = parser.errors()
+    else
+      if file
+        doc = eval(IO.readlines(src).join(""))
+      else
+        doc = eval(src)
+      end
+
+      if doc.class != Hash
+        raise Yamo::ValidateError, "data did not produce a Hash"
+      end
+
+      doc = if @hook.respond_to?(:pre_validate) then @hook.pre_validate(doc) else doc end
+      errors = @validator.validate(doc)
+    end
+
+    if errors and !errors.empty?
+      raise Yamo::ValidateError, "\n#{file ? src : 'input'} did not validate:\n" + errors.join("\n")
+    end
+
+    if @hook.respond_to?(:post_validate) then @hook.post_validate(doc) else doc end
+  end
+end

data/test/data/collection/obj1

@@ -0,0 +1,5 @@
+{
+    'a' => 'a',
+    'c' => 'b',
+    'd' => 'Foo',
+};

data/test/data/collection/obj2

@@ -0,0 +1,9 @@
+{
+    'a' => 'a',
+    'b' => {
+        'a' => [ 'a', 'b', 'c' ],
+        'b' => 'a',
+    },
+    'c' => 'b',
+    'd' => 'Bar',
+};

data/test/data/collection_bogus/obj1

@@ -0,0 +1,5 @@
+{
+    'a' => 'a',
+    'c' => 'b',
+    'd' => 'Foo',
+};

data/test/data/collection_bogus/obj2

@@ -0,0 +1,8 @@
+{
+    'a' => 'a',
+    'b' => {
+        'a' => [ 'a', 'b', 'c' ],
+        'b' => 'a',
+    },
+    'c' => 'b',
+};

data/test/data/schemas/collection.yaml

@@ -0,0 +1,34 @@
+---
+class: Collection
+type: map
+mapping:
+    "a":
+        type: str
+        enum:
+          - a
+          - b
+        default: "a"
+    "b":
+        type: map
+        mapping:
+            "a":
+                type: seq
+                required: no
+                sequence:
+                  - { type: str, unique: yes }
+            "b":
+                type: any
+                default: true
+            "c":
+                type: seq
+                required: no
+                sequence:
+                  - { type: str, unique: yes }
+    "c":
+        type: str
+        pattern: /^(a|b|c)$/
+        required: no
+    "d":
+        type: str
+        name: HookOne
+        required: yes

data/test/data/schemas/collection_bogus.yaml

@@ -0,0 +1,33 @@
+---
+class: Collection
+mapping:
+    "a":
+        type: str
+        enum:
+          - a
+          - b
+        default: "a"
+    "b":
+        type: map
+        mapping:
+            "a":
+                type: seq
+                required: no
+                sequence:
+                  - { type: str, unique: yes }
+            "b":
+                type: any
+                default: true
+            "c":
+                type: seq
+                required: no
+                sequence:
+                  - { type: str, unique: yes }
+    "c":
+        type: str
+        pattern: /^(a|b|c)$/
+        required: no
+    "d":
+        type: str
+        name: HookOne
+        required: yes

data/test/data/schemas/singleton.yaml

@@ -0,0 +1,18 @@
+# -*- mode: yaml; tab-width: 2; indent-tabs-mode: nil; -*-
+---
+class: Config
+type: map
+mapping:
+  "a":
+    type: map
+    mapping:
+      "b": { type: int, required: yes }
+      "c": { type: int, required: yes }
+      "d": { type: int, required: yes }
+      "e": { type: int, required: yes }
+      "f":
+        type: seq
+        required: no
+        sequence:
+          - type: str
+            unique: yes

data/test/data/singleton.conf

@@ -0,0 +1,12 @@
+{
+    'a' => {
+        'b' => 8,
+        'c' => 6,
+        'd' => 4,
+        'e' => 3,
+        'f' => [ 'a',
+                 'b',
+                 'c',
+        ],
+    },
+};

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'test/unit'
+
+TESTDIR = File.dirname(__FILE__)
+$LOAD_PATH.unshift(TESTDIR)
+$LOAD_PATH.unshift(File.join(TESTDIR, '..', 'lib'))
+
+require 'yamo'
+
+class CollectionTest < Yamo::Collection
+  schema "#{TESTDIR}/data/schemas/collection.yaml"
+  objectdir "#{TESTDIR}/data/collection"
+end
+
+class SingletonTest < Yamo::Singleton
+  schema "#{TESTDIR}/data/schemas/singleton.yaml"
+  object "#{TESTDIR}/data/singleton.conf"
+end

data/test/test_collection.rb

@@ -0,0 +1,11 @@
+require 'helper'
+
+class TestCollection < Test::Unit::TestCase
+  def test_load
+    assert_equal(2, CollectionTest.entries.count)
+    assert_equal('obj1', CollectionTest.get("obj1").name)
+    assert_equal(1, CollectionTest.find_all { |c| c.d == "Bar" }.count)
+    obj = CollectionTest.entries.first
+    assert_equal(true, obj.b.b)
+  end
+end

data/test/test_singleton.rb

@@ -0,0 +1,8 @@
+require 'helper'
+
+class TestSingleton < Test::Unit::TestCase
+  def test_load
+    assert_equal(8, SingletonTest.instance.a.b)
+    assert_equal(3, SingletonTest.instance.a.f.count)
+  end
+end

data/test/test_validation.rb

@@ -0,0 +1,14 @@
+require 'helper'
+
+class TestValidation < Test::Unit::TestCase
+  def test_load
+    CollectionTest.objectdir "#{TESTDIR}/data/collection_bogus"
+    assert_raise Yamo::ValidateError do
+      CollectionTest.entries
+    end
+
+    assert_raise Yamo::ValidateError do
+      CollectionTest.schema "#{TESTDIR}/data/schemas/collection_bogus.yaml"
+    end
+  end
+end

data/yamo.gemspec

@@ -0,0 +1,75 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{yamo}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kenneth Vestergaard Schmidt"]
+  s.date = %q{2009-12-03}
+  s.description = %q{Classes for loading schema-validated YAML, and creating nice Ruby-objects with accessors}
+  s.email = %q{kvs@binarysolutions.dk}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/yamo.rb",
+     "lib/yamo/collection.rb",
+     "lib/yamo/object.rb",
+     "lib/yamo/singleton.rb",
+     "lib/yamo/validator.rb",
+     "test/data/collection/obj1",
+     "test/data/collection/obj2",
+     "test/data/collection_bogus/obj1",
+     "test/data/collection_bogus/obj2",
+     "test/data/schemas/collection.yaml",
+     "test/data/schemas/collection_bogus.yaml",
+     "test/data/schemas/singleton.yaml",
+     "test/data/singleton.conf",
+     "test/helper.rb",
+     "test/test_collection.rb",
+     "test/test_singleton.rb",
+     "test/test_validation.rb",
+     "yamo.gemspec"
+  ]
+  s.homepage = %q{http://github.com/kvs/yamo}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9.1")
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{YAML Model Objects}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_collection.rb",
+     "test/test_singleton.rb",
+     "test/test_validation.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_runtime_dependency(%q<kwalify>, [">= 0.7.1"])
+    else
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<kwalify>, [">= 0.7.1"])
+    end
+  else
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<kwalify>, [">= 0.7.1"])
+  end
+end
+

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: yamo
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kenneth Vestergaard Schmidt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-03 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: kwalify
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.7.1
+    version: 
+description: Classes for loading schema-validated YAML, and creating nice Ruby-objects with accessors
+email: kvs@binarysolutions.dk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/yamo.rb
+- lib/yamo/collection.rb
+- lib/yamo/object.rb
+- lib/yamo/singleton.rb
+- lib/yamo/validator.rb
+- test/data/collection/obj1
+- test/data/collection/obj2
+- test/data/collection_bogus/obj1
+- test/data/collection_bogus/obj2
+- test/data/schemas/collection.yaml
+- test/data/schemas/collection_bogus.yaml
+- test/data/schemas/singleton.yaml
+- test/data/singleton.conf
+- test/helper.rb
+- test/test_collection.rb
+- test/test_singleton.rb
+- test/test_validation.rb
+- yamo.gemspec
+has_rdoc: true
+homepage: http://github.com/kvs/yamo
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.9.1
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: YAML Model Objects
+test_files: 
+- test/helper.rb
+- test/test_collection.rb
+- test/test_singleton.rb
+- test/test_validation.rb