develapp-tardef 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cddf9ca825967c199ebf4723feb255ceee7a4fd
-  data.tar.gz: e7fafc692f3c0c52b5ed2bd4b888b3b361811a03
+  metadata.gz: c31b137a9f1f4ce717a25eebf9acd24ef6b8ca01
+  data.tar.gz: 6196199c59c39e098b7fc9a1dc06a298e1775f74
 SHA512:
-  metadata.gz: 47d61d20565d3daf785028b25cf72822ec331674d48ebfc64d424af151898bc99843def09de184a611276aa7a45826205526aba258f76704b82f4c375a31be59
-  data.tar.gz: 48a5f30d5492c6cc276ee4f6b2f09572cbc9c59b1b9e6136665640cb65aee1beffe6629bb2bf7e69217a52fb33561e17fa97602107873f93b259d2a1c0376d8d
+  metadata.gz: a08f9fb8c0fc94a39e089d222918f5e89ebaa5a020cee52bbfeb0f3b66979fc9ad12b3e6c321089ca9853a82e26b8b2c26859fdc3fd075cc4e6c8f42692a898f
+  data.tar.gz: 6ac56ab2b3ff64515f4a05debf129ce651c274e73cabd49ce4c89876fe8259a333f16a71adaf6cd865802718d47fd330ddfcac939aee3e5b2c1f1b9d512cf94b

data/README.md

@@ -1,19 +1,28 @@
 About
-====
+-----
 TARDEF is a format for saving and exchanging data for tasks and related data - like lists and tags - in an easy format. By default, YAML and JSON are supported as file formats by TARDEF, but any format that supports the same kind of structures as YAML / JSON could be used.
 
 Advantages
-===
+----------
 * Text based: Files can be read and written by humans and also supports versioning files using Git, SVN, etc.
 * Extensions: Extensions can be used to add functionality to the TARDEF file that is not supported by the default format.
 
 Usage
-===
+-----
 The TARDEF repository contains a Ruby library that can be used for accessing the files. There are also schemas following the Kwalify (http://www.kuwata-lab.com/kwalify/) standard that can be used for validating TARDEF files. A ruby tool for doing so is also included.
 
 The validator can be used by calling tardef_validate -f <file> -t <type>
 
 An up-to-date documentation of the library can be found at http://rubydoc.info/github/DevelAppUG/tardef/master/frames.
-File Format Description
-===
-Coming soon...
+
+Schemas
+-------
+There are several schemas available:
+
+Base schema: http://develapp.moskitapp.com/tardef/schema/v1/tardef.yaml
+
+Reminders extension: http://develapp.moskitapp.com/tardef/schema/v1/extension/reminder.yaml
+
+Location extension: http://develapp.moskitapp.com/tardef/schema/v1/extension/location.yaml
+
+Attachement extension: http://develapp.moskitapp.com/tardef/schema/v1/extension/attachement.yaml

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = false
+end

data/bin/tardef

@@ -96,7 +96,7 @@ begin
     raise "Output file must be given using -of <filename>" if output_file == ""
     output_type = derive_type(output_file, output_type)
     check_type(output_type)
-    obj = Tardef::File.new(output_file, Tardef::VERSION, Time.now.iso8601(0))
+    obj = Tardef::File.new(output_file, Tardef::VERSION)
     obj.schema = Tardef::DEFAULT_SCHEMA
     write_file(output_file, output_type, obj)
     puts "[SUCCESS] File generated"

data/lib/tardef/base.rb

@@ -7,11 +7,7 @@ module Tardef
     def add_extension(extension)
       @extensions << extension
     end
-  
-    def self.parse_date(datestring)
-      return DateTime.iso8601(datestring)
-    end
-  
+
     def to_hash
       hash = {}
       # Add all instance variables
@@ -54,19 +50,11 @@ module Tardef
     end
   end
 
-  class Extension < Base
-    attr_accessor :name, :data
-    
-    def initialize(name, schema)
-      @name, @data = name, data
-    end
-  end
-
   class File < Base
     attr_accessor :filename, :title, :editor, :imports, :schema
     attr_accessor :last_changed, :lists, :tags, :tasks, :extension_defs
   
-    def initialize(filename, protocol_version, last_changed, title = "", editor = "", imports = [], schema = "")
+    def initialize(filename, protocol_version, last_changed = Time.now.iso8601(0), title = "", editor = "", imports = [], schema = Tardef::DEFAULT_SCHEMA)
       super()
       @filename, @last_changed, @title = filename, last_changed, title
       @editor, @lists, @tags, @tasks, @imports = editor, [], [], [], imports
@@ -84,12 +72,7 @@ module Tardef
     def add_task(task)
       @tasks << task
     end
-    
-    def hash_has_object?(list, uid)
-      list.each { |item| return true if item.uid == uid }
-      return false
-    end
-  
+      
     def has_list?(uid)
       hash_has_object?(@lists, uid)
     end
@@ -122,5 +105,12 @@ module Tardef
       end
       return hash
     end
+    
+    private
+    def hash_has_object?(list, uid)
+      list.each { |item| return true if item.uid == uid }
+      return false
+    end
+    
   end
 end

data/lib/tardef/connector/base.rb

@@ -9,38 +9,20 @@ module Tardef::Connector
       file.load_hash(hash["meta"])
       file.filename = @filename
 
-      if hash["lists"]
-        hash["lists"].each do |hsh|
-          list = Tardef::List.new(nil, nil)
-          list.load_hash(hsh)
-          file.add_list(list)
+      list, tag, task = Tardef::List, Tardef::Tag, Tardef::Task
+      extension       = Tardef::Extension
+      entries = {"lists" => list, "tags" => tag, "tasks" => task,
+                 "extensions" => extension}
+      
+      entries.map do |key, value|
+        next unless hash[key]
+        hash[key].each do |hsh|
+          entry = value.new("", "", "")
+          entry.load_hash(hsh)
+          file << entry
         end
       end
-
-      if hash["tags"]
-        hash["tags"].each do |hsh|
-          tag = Tardef::Tag.new(nil, nil)
-          tag.load_hash(hsh)
-          file.add_tag(tag)
-        end
-      end
-
-      if hash["tasks"]
-        hash["tasks"].each do |hsh|
-          task = Tardef::Task.new(nil, nil, nil)
-          task.load_hash(hsh)
-          file.add_task(task)
-        end
-      end
-
-      if hash["extensions"]
-        hash["extensions"].each do |hsh|
-          ext = Tardef::Extension.new(nil, nil)
-          ext.load_hash(hsh)
-          file.add_extension(ext)
-        end
-      end
-  
+      
       file.schema = hash["schema"] if hash["schema"]
       file
     end

data/lib/tardef/object.rb

@@ -26,4 +26,12 @@ module Tardef
       @due_at, @hidden, @tags = due_at, hidden, tags
     end
   end
+  
+  class Extension < Base
+    attr_accessor :name, :data
+    
+    def initialize(name, schema)
+      @name, @data = name, data
+    end
+  end
 end

data/lib/tardef/version.rb

@@ -1,4 +1,4 @@
 module Tardef
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
   DEFAULT_SCHEMA = "http://develapp.moskitapp.com/tardef/schema/v1/tardef.yaml"
 end

data/schema/v1/tardef.yaml

@@ -32,7 +32,7 @@ mapping:
         sequence:
           - type: map
             mapping:
-              "name"  : { type: str, required: yes }
+              "name"  : { type: str, required: yes, unique: yes }
               "schema": { type: str, required: yes }
               "target": 
                 type: str

data/test/test_library.rb

@@ -0,0 +1,12 @@
+require 'test/unit'
+require 'tardef'
+
+class TestBaseFile < Test::Unit::TestCase
+  def testEmptyFileHasValidSyntax
+    file = Tardef::File.new(nil, nil)
+    validator = Tardef::Validator::Syntax.new(Tardef::DEFAULT_SCHEMA)
+    result = validator.validate(file)
+    
+    assert_equal([], result)
+  end
+end

data/test/test_schema.rb

@@ -0,0 +1,31 @@
+require 'test/unit'
+require 'tardef'
+
+class TestSchemas < Test::Unit::TestCase
+  def schemaValidation(file)
+    metavalidator = Kwalify::MetaValidator.instance
+    parser = Kwalify::Yaml::Parser.new(metavalidator)
+    parser.parse_file(file)
+    parser.errors
+  end
+  
+  def testBaseSchema
+    errors = schemaValidation 'schema/v1/tardef.yaml'
+    assert_equal([], errors)
+  end
+  
+  def testReminderSchema
+    errors = schemaValidation 'schema/v1/extension/reminder.yaml'
+    assert_equal([], errors)
+  end
+
+  def testLocationSchema
+    errors = schemaValidation 'schema/v1/extension/location.yaml'
+    assert_equal([], errors)
+  end
+
+  def testAttachementSchema
+    errors = schemaValidation 'schema/v1/extension/attachement.yaml'
+    assert_equal([], errors)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: develapp-tardef
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Timo Puschkasch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-30 00:00:00.000000000 Z
+date: 2013-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -125,6 +125,8 @@ files:
 - schema/v1/extension/reminder.yaml
 - schema/v1/tardef.yaml
 - tardef.gemspec
+- test/test_library.rb
+- test/test_schema.rb
 homepage: http://develapp.moskitapp.com/tardef
 licenses:
 - MIT
@@ -149,4 +151,6 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Task and Related Data Exchange Format
-test_files: []
+test_files:
+- test/test_library.rb
+- test/test_schema.rb