taskwarrior 0.0.3 → 0.0.4

data/README.md

@@ -1,6 +1,6 @@
 # taskwarrior
 
-Ruby bindings for [TaskWarrior](http://taskwarrior.org)
+Ruby bindings for [TaskWarrior](http://taskwarrior.org). Right now this gem provides read-only access to tasks, projects, tags etc.
 
 [![Build Status](https://secure.travis-ci.org/nerab/taskwarrior.png?branch=master)](http://travis-ci.org/nerab/taskwarrior)
 
@@ -20,7 +20,22 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+`TaskWarrior::Repository` is the main entry point. It expects an array of JSON objects, typically produced by `task export`. Technically, anything that can be consumed by `JSON.parse` is fine as long as it follows the format TaskWarrior uses.
+
+	# Assuming that a TaskWarrior export was written to a file
+	r = TaskWarrior::Repository.new(File.read('/tmp/task_export.json'))
+
+Once instantiated, the repository provides access to tasks, projects and tags. Each task will also carry its attributes (description, uuid, etc) as well as its project and tags.
+
+	puts r.tasks.size
+	puts r.projects.size
+	puts r.tags.size
+
+	puts r.tasks.first.description
+	puts r.tasks.first.project.name
+	puts r.tasks.first.tags.join(' ')
+
+Please see the [examples](/nerab/taskwarrior/tree/master/examples) for further use, or have a look at the [twdeps](/nerab/twdeps) tool which creates a graph that visualizes the dependencies between tasks.
 
 ## Contributing
 

data/lib/taskwarrior/annotation.rb

@@ -1,4 +1,5 @@
 require 'active_model'
+require 'date'
 
 module TaskWarrior
   class Annotation
@@ -11,12 +12,24 @@ module TaskWarrior
     include TaskWarrior::Validations
     validate :entry_cannot_be_in_the_future
 
-    def initialize(description = nil)
+    def initialize(description = nil, entry = nil)
       @description = description
+      @entry = entry
     end
 
     def to_s
       "Annotation (#{entry}): #{description}"
     end
+
+    def hash
+      entry.hash + description.hash
+    end
+
+    # Annotations are value objects. They have no identity.
+    # If entry date and description are the same, the annotations are identical.
+    def ==(other)
+      return false unless other.is_a?(Annotation)
+      entry.eql?(other.entry) && description.eql?(other.description)
+    end
   end
 end

data/lib/taskwarrior/project.rb

@@ -23,6 +23,17 @@ module TaskWarrior
       "Project #{name} (#{@tasks.size} tasks)"
     end
 
+    def hash
+      name.hash + tasks.hash
+    end
+
+    # Projects are value objects. They have no identity.
+    # If name and tasks are the same, the projects are identical.
+    def ==(other)
+      return false unless other.is_a?(Project)
+      name.eql?(other.name) && tasks.eql?(other.tasks)
+    end
+
     private
     def name_may_not_contain_spaces
       if !name.blank? and name[/\s/]

data/lib/taskwarrior/tag.rb

@@ -34,8 +34,15 @@ module TaskWarrior
       "Tag: #{name} (#{@tasks.size} tasks)"
     end
 
+    def hash
+      name.hash + tasks.hash
+    end
+
+    # Tags are value objects. They have no identity.
+    # If name and tasks are the same, the tags are identical.
     def ==(other)
-      name == other.name
+      return false unless other.is_a?(Tag)
+      name.eql?(other.name) && tasks.eql?(other.tasks)
     end
 
     private

data/lib/taskwarrior/task.rb

@@ -35,10 +35,37 @@ module TaskWarrior
       @children = []
       @tags = []
       @annotations = []
+
+      # http://www.ruby-forum.com/topic/164078#722181
+      @uuid = %x[uuidgen].strip
     end
 
     def to_s
       "Task '#{description}'".tap{|result| result << " <#{uuid}>" if uuid}
     end
+
+    # other may have the same uuid, but if its attributes differ, it will not be equal
+    def eql?(other)
+      # TODO Find a way to call attributes instead of listing them here again
+      # Maybe Virtus?
+      # http://solnic.eu/2012/01/10/ruby-datamapper-status.html
+      [:description, :id, :entry, :status, :uuid, 
+       :project, :dependencies, :parent, :children, 
+       :priority, :tags, :annotations, :start_at, :wait_at, 
+       :end_at, :due_at].each do |attr|
+        return false unless send(attr).eql?(other.send(attr))
+      end
+    end
+
+    def hash
+      uuid.hash
+    end
+
+    # Tasks are entity objects. They have their identity defined by the uuid.
+    # If the uuids are the same, the tasks are identical.
+    def ==(other)
+      return false unless other.is_a?(Task)
+      uuid == other.uuid
+    end
   end
 end

data/lib/taskwarrior/version.rb

@@ -1,3 +1,3 @@
 module TaskWarrior
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/test/test_helper.rb

@@ -18,6 +18,24 @@ module TaskWarrior
         assert(task.invalid?, 'Expect validation to fail')
       end
 
+      def assert_equality(a1, a2)
+        assert_not_equal(a1.object_id, a2.object_id)
+        assert_equal(a1, a2)
+        assert(a1 == a2)
+        assert(a1.hash == a2.hash)
+        assert(a1.eql?(a2))
+        assert_equal(1, [a1, a2].uniq.size)
+      end
+
+      def assert_inequality(a1, a2)
+        assert_not_equal(a1.object_id, a2.object_id)
+        assert_not_equal(a1, a2)
+        assert(!(a1 == a2))
+        assert(!(a1.hash == a2.hash))
+        assert(!a1.eql?(a2))
+        assert_equal(2, [a1, a2].uniq.size)
+      end
+
       def error_message(errors)
         errors.each_with_object([]){|e, result|
           result << e.join(' ')

data/test/unit/test_annotation.rb

@@ -50,4 +50,37 @@ class TestAnnotation < Test::Unit::TestCase
   def test_valid
     assert_valid(@annotation)
   end
+
+  def test_equality
+    a1 = TaskWarrior::Annotation.new('foo')
+    a2 = TaskWarrior::Annotation.new('foo')
+
+    assert_equal(a1, a2)
+  end
+
+  def test_equality_different_description
+    a1 = TaskWarrior::Annotation.new('foo')
+    a2 = TaskWarrior::Annotation.new('bar')
+    assert_inequality(a1, a2)
+  end
+
+  def test_equality_different_entry
+    a1 = TaskWarrior::Annotation.new('foo')
+    a1.entry = DateTime.now
+
+    a2 = TaskWarrior::Annotation.new('foo')
+    a2.entry = DateTime.now.advance(:days => -1)
+
+    assert_inequality(a1, a2)
+  end
+
+  def test_equality_different_description_and_entry
+    a1 = TaskWarrior::Annotation.new('foo')
+    a1.entry = DateTime.now
+
+    a2 = TaskWarrior::Annotation.new('bar')
+    a2.entry = DateTime.now.advance(:days => -1)
+
+    assert_inequality(a1, a2)
+  end
 end

data/test/unit/test_project.rb

@@ -52,4 +52,31 @@ class TestProject < Test::Unit::TestCase
     assert_equal(project, t1.project)
     assert_equal(project, t2.project)
   end
+
+  def test_equality
+    a1 = TaskWarrior::Project.new('foo')
+    a2 = TaskWarrior::Project.new('foo')
+
+    assert_equal(a1, a2)
+  end
+
+  def test_equality_different_name
+    a1 = TaskWarrior::Project.new('foo')
+    a2 = TaskWarrior::Project.new('bar')
+    assert_inequality(a1, a2)
+  end
+
+  def test_equality_different_tasks
+    a1 = TaskWarrior::Project.new('foo')
+    a2 = TaskWarrior::Project.new('foo', [TaskWarrior::Task.new('foobar')])
+
+    assert_inequality(a1, a2)
+  end
+
+  def test_equality_different_name_and_tasks
+    a1 = TaskWarrior::Project.new('foo')
+    a2 = TaskWarrior::Project.new('bar', [TaskWarrior::Task.new('baz')])
+
+    assert_inequality(a1, a2)
+  end
 end

data/test/unit/test_repository.rb

@@ -46,8 +46,8 @@ class TestRepository < Test::Unit::TestCase
     tags = @repo.tags
     assert_not_nil(tags)
     assert_equal(2, tags.size)
-    assert(tags.include?(Tag.new('finance')))
-    assert(tags.include?(Tag.new('mall')))
+    assert(tags.include?(@repo.tag('finance')))
+    assert(tags.include?(@repo.tag('mall')))
   end
 
   def test_tasks_of_tag_finance
@@ -61,4 +61,14 @@ class TestRepository < Test::Unit::TestCase
     assert_not_nil(mall)
     assert_equal(3, mall.tasks.size)
   end
+
+  def test_equality
+    t1 = @repo['b587f364-c68e-4438-b4d6-f2af6ad62518']
+    t2 = t1.dup
+    assert_not_equal(t1.object_id, t2.object_id)
+
+    t1.description = 'changed'
+    assert_equal(t1, t2)
+    assert(!(t1.eql?(t2)))
+  end
 end

data/test/unit/test_tag.rb

@@ -48,10 +48,32 @@ class TestTag < Test::Unit::TestCase
     assert_equal(Tag.new(foo), foo)
   end
 
-  def test_value_object
-    f1 = Tag.new('foo')
-    f2 = Tag.new('foo')
-    assert_not_equal(f1.object_id, f2.object_id)
-    assert_equal(f1, f2)
+  def test_equality
+    a1 = Tag.new('foo')
+    a2 = Tag.new('foo')
+
+    assert_equal(a1, a2)
+  end
+
+  def test_equality_different_name
+    a1 = Tag.new('foo')
+    a2 = Tag.new('bar')
+    assert_inequality(a1, a2)
+  end
+
+  def test_equality_different_tasks
+    a1 = Tag.new('foo')
+    a2 = Tag.new('foo')
+    a2 << TaskWarrior::Task.new('baz')
+
+    assert_inequality(a1, a2)
+  end
+
+  def test_equality_different_name_and_tasks
+    a1 = Tag.new('foo')
+    a2 = Tag.new('bar')
+    a2 << TaskWarrior::Task.new('baz')
+
+    assert_inequality(a1, a2)
   end
 end

data/test/unit/test_task.rb

@@ -5,10 +5,11 @@ require 'active_support/core_ext'
 # TODO Add tests for dependencies
 
 class TestTask < Test::Unit::TestCase
+  include TaskWarrior
   include TaskWarrior::Test::Validations
   
   def setup
-    @task = TaskWarrior::Task.new('foobar')
+    @task = Task.new('foobar')
     @task.id = 1
     @task.uuid = '66465716-b08d-41ea-8567-91b988a2bcbf'
     @task.entry = DateTime.now
@@ -182,4 +183,43 @@ class TestTask < Test::Unit::TestCase
     @task.send("#{sym}=", DateTime.now.advance(:days => -1))
     assert_valid(@task)
   end
+
+  def test_equality
+    a1 = Task.new('foo')
+    a2 = Task.new('foo')
+
+    # Tasks are entities, so even with the same attributes, two different objects
+    # must not be treated equal
+    assert_inequality(a1, a2)
+    
+    # But comparing the same thing to itself is fine
+    assert_equal(a1, a1)
+    assert_equal(a2, a2)
+  end
+
+  def test_equality_different_description
+    a1 = Task.new('foo')
+    a2 = Task.new('bar')
+    assert_inequality(a1, a2)
+  end
+
+  def test_equality_different_entry
+    a1 = Task.new('foo')
+    a1.entry = DateTime.now
+
+    a2 = Task.new('foo')
+    a2.entry = DateTime.now.advance(:days => -1)
+
+    assert_inequality(a1, a2)
+  end
+
+  def test_equality_different_description_and_entry
+    a1 = Task.new('foo')
+    a1.entry = DateTime.now
+
+    a2 = Task.new('bar')
+    a2.entry = DateTime.now.advance(:days => -1)
+
+    assert_inequality(a1, a2)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taskwarrior
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-09 00:00:00.000000000 Z
+date: 2012-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel