things-rb 0.3.0

data/test/test_document.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+
+class DocumentTest < Test::Unit::TestCase
+  def setup
+    @things = @@things ||= Things.new(:database => DATABASE_FIXTURE_PATH)
+  end
+  
+  test "should use the specified database if any" do
+    IO.expects(:read).with('/path/to/database.xml').returns("foo").at_least_once
+    things = Things.new(:database => '/path/to/database.xml')
+    assert_equal('/path/to/database.xml', things.database_file)
+  end
+
+  test "should use default database unless other is specified" do
+    default_db = ENV['HOME'] + '/Library/Application Support/Cultured Code/Things/Database.xml'
+    IO.expects(:read).with(default_db).returns("foo").at_least_once
+    assert_equal(default_db, Things.new.database_file)
+  end
+  
+  test "should return a parsed Hpricot document" do
+    IO.expects(:read).with('/my/db.xml').returns("foo").at_least_once
+    things = Things.new(:database => '/my/db.xml')
+    assert_equal("Hpricot::Doc", things.database.class.to_s)
+    assert_equal "foo", things.database.to_s
+  end
+
+  [:today, :inbox, :trash, :logbook, :next, :scheduled].each do |type|
+    test "should create a Focus instance for type #{type}" do
+      focus = @things.focus(type)
+      assert_instance_of(Things::Focus, focus)
+    end
+
+    test "should only create one Focus instance for #{type}" do
+      focus = @things.focus(type)
+      2.times { |i| assert_equal(focus, @things.focus(type)) }
+    end
+
+    test %Q{should have a shortcuts to the Focus "#{type}"} do
+      Things::Focus.any_instance.stubs(:tasks).returns(%[foo bar baz])
+      assert_equal(@things.focus(type).tasks, @things.send(type))
+    end
+  end
+  
+  test %Q{Should allow to send options to the focus today} do
+    completed = @things.today(:completed => true )
+    assert completed.all? { |e| e.title.include?("complete") }
+  end
+  
+  [Things, Things::Document].each do |klass|
+    test "should allow a block for #{klass}.new" do
+      block = false
+      klass.new(:database => DATABASE_FIXTURE_PATH) do |d|
+        block = true
+        assert_instance_of(Things::Document, d)
+      end
+      assert(block)
+    end
+  end
+end

data/test/test_focus.rb

@@ -0,0 +1,96 @@
+require 'test_helper'
+
+class FocusTest < Test::Unit::TestCase
+  def setup
+    @things = @@things ||= Things.new(:database => DATABASE_FIXTURE_PATH)
+    @todays_tasks = [
+      "complete today item",
+      "today item with notes",
+      "complete today item with notes",
+      "complete today item with a tag",
+      "today item with multiple tags",
+      "email bar",
+      "today item",
+      "today item with content (notes)"
+    ]
+  end
+
+  test 'should find the Today focus' do
+    assert_equal("z124", @things.focus(:today).id)
+  end
+  
+  test "should find the focustype for Today" do
+    assert_equal("65536", @things.focus(:today).type_id)
+  end
+  
+  test "should find the focuses" do
+    { :inbox       => "z120",
+      :trash       => "z138",
+      :logbook     => "z127",
+      :nextactions => "z141"
+    }.each do |name, id|
+      assert_equal(id, @things.focus(name).id)
+    end
+  end
+  
+  test 'should allow "next" as alias for NextActions focus' do
+    focus = Things::Focus.new(:next, stub(:at => ''))
+    assert_equal "FocusNextActions", focus.type_name
+  end
+
+  test 'should allow "nextactions" as alias for NextActions focus' do
+    focus = Things::Focus.new(:nextactions, stub(:at => ''))
+    assert_equal "FocusNextActions", focus.type_name
+  end
+  
+  test 'should allow "someday" as alias for Maybe focus' do
+    focus = Things::Focus.new(:someday, stub(:at => ''))
+    assert_equal "FocusMaybe", focus.type_name
+  end
+
+  test "should raise FocusNotFound if the focus isn't found" do
+    assert_raise(Things::InvalidFocus) { @things.focus(:invalid_focus) }
+  end
+
+  test "should find the same number of tasks as in Today" do
+    tasks = @things.focus(:today).tasks
+    assert_instance_of(Array, tasks)
+    assert_equal(8, tasks.length)
+  end
+  
+  test "should find the tasks' titles" do
+    assert_equal(@todays_tasks.sort, @things.today.map(&:title).sort)
+  end
+  
+  test "should sort the tasks by their position" do
+    # TODO: tasks with projects/parent have other sorting order but need to 
+    # figure out how Things handles that. Therefore skip these tasks for now
+    todays_tasks = @todays_tasks.reject { |e| e == 'email bar' }
+    assert_equal(todays_tasks, @things.today.reject { |e| e.parent? }.map(&:title))
+  end
+  
+  test "should only find completed tasks when passing :completed => true" do
+    complete = @things.focus(:today).tasks(:completed => true)
+    assert complete.all? { |e| e.title.include?("complete") }
+  end
+
+  test "should not include completed tasks when passing :completed => false" do
+    complete = @things.focus(:today).tasks(:completed => false)
+    assert !complete.all? { |e| e.title.include?("complete") }
+  end
+  
+  test "include canceled tasks when passing :canceled => true" do
+    canceled = @things.focus(:next).tasks(:canceled => true)
+    assert canceled.all? { |e| e.title.include?("cancel") }
+  end
+
+  test "dont include canceled tasks when passing :canceled => false" do
+    canceled = @things.focus(:next).tasks(:canceled => false)
+    assert !canceled.all? { |e| e.title.include?("cancel") }
+  end
+  
+  test "should not include projects when listing tasks" do
+    with_children = @things.focus(:next).tasks.select(&:children?)
+    assert_equal 0, with_children.length
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,26 @@
+require "things"
+require "test/unit"
+require "mocha"
+
+class Test::Unit::TestCase
+  FIXTURES_PATH = File.expand_path(File.join(File.dirname(__FILE__), "fixtures")) unless defined?(FIXTURES_PATH)
+  DATABASE_FIXTURE_PATH = File.join(FIXTURES_PATH, 'Database.xml') unless defined?(DATABASE_FIXTURE_PATH)
+  
+  def database_content
+    IO.read(DATABASE_FIXTURE_PATH)
+  end
+  
+  # From Rails ActiveSupport::Testing::Declarative
+  def self.test(name, &block)
+    test_name = "test_#{name.gsub(/\s+/,'_')}".to_sym
+    defined = instance_method(test_name) rescue false
+    raise "#{test_name} is already defined in #{self}" if defined
+    if block_given?
+      define_method(test_name, &block)
+    else
+      define_method(test_name) do
+        flunk "No implementation provided for #{name}"
+      end
+    end
+  end
+end

data/test/test_task.rb

@@ -0,0 +1,163 @@
+require 'test_helper'
+
+class TaskTest < Test::Unit::TestCase
+  def setup
+    @things = @@things ||= Things.new(:database => DATABASE_FIXTURE_PATH)
+  end
+  
+  def find_task(name)
+    title = {
+      :with_tags   => 'today item with multiple tags',
+      :basic       => 'today item',
+      :with_parent => 'email bar',
+      :with_notes  => 'today item with content (notes)',
+    }[name]
+    @things.today.detect { |t| t.title == title }
+  end
+  
+  def task_with_children
+    task_by_id("z154")
+  end
+  
+  def task_by_id(id)
+    node = @things.database.at("object[@type='TODO']##{id}")
+    Things::Task.new(node, @things.database)
+  end
+
+  test "should use the task's title for to_s" do
+    task = find_task(:basic)
+    assert_equal("today item", task.to_s)
+  end
+
+  test "should find the task's tag ids" do
+    task = find_task(:with_tags)
+    assert_instance_of Array, task.tag_ids
+    assert_equal %w[z151 z150].sort, task.tag_ids.sort
+  end
+  
+  test "should not find any tags if there isnt any" do
+    assert_equal 0, find_task(:basic).tag_ids.length
+  end
+
+  test "should find the task's notes" do
+    task = find_task(:with_notes)
+    assert_equal %{Check wait times here: http://www.mass.gov/qrmv/boston.shtm}, task.notes
+  end
+  
+  test "should know if there are notes" do
+    assert find_task(:with_notes).notes?
+    assert !find_task(:basic).notes?
+  end
+  
+  test "should find the task's tag titles" do
+    task = find_task(:with_tags)
+    assert_equal(%w[Home City].sort, task.tags.sort)
+  end
+  
+  test "should know if there are any tags" do
+    assert(find_task(:with_tags).tags?)
+    assert(!find_task(:basic).tags?)
+  end
+  
+  test "if the task has a specific tag" do
+    task = find_task(:with_tags)
+    assert(task.tag?("Home"))
+    assert(!task.tag?("Errand"))
+  end
+  
+  test "should find the tasks parent_id" do
+    task = find_task(:with_parent)
+    assert_equal("z154", task.parent_id)
+  end
+  
+  test "should not find the task's parent project if it doesn't have any" do
+    task = find_task(:basic)
+    assert_equal(nil, task.parent_id)
+  end
+  
+  test "should find the parent's title" do
+    task = find_task(:with_parent)
+    assert_equal "Make dinner", task.parent.title
+  end
+  
+  test "should know if there is a parent project" do
+    assert(find_task(:with_parent).parent?)
+    assert(!find_task(:basic).parent?)
+  end
+  
+  test "should know if the task is completed" do
+    @things.today.each do |task|
+      if task.title.include?('complete')
+        assert(task.complete?)
+        assert(!task.incompleted?)
+      else
+        assert(task.incompleted?)
+        assert(!task.completed?)
+      end
+    end
+  end
+
+  test "if a task is canceled" do
+    assert task_by_id("z189").canceled?
+  end
+
+  test "should find the task's order index" do
+    assert_equal(7, find_task(:basic).position.to_i)
+  end
+  
+  test "list the tasks children" do
+    assert_instance_of(Array, task_with_children.children)
+  end
+  
+  test "find the right number of children" do
+    assert_equal(9, task_with_children.children.length)
+  end
+  
+  test "know if there are child tasks" do
+    assert task_with_children.children?
+    assert !find_task(:basic).children?
+  end
+  
+  test "populate the children array with Task objects" do
+    assert task_with_children.children.all? { |c| c.class == Things::Task }
+  end
+  
+  test "find the children_ids" do
+    ids = %w[z163 z161 z160 z157 z159 z156 z165 z158 z162].sort
+    assert_equal(ids, task_with_children.children_ids.sort)
+  end
+
+  test "should find the due date" do
+    task = task_by_id("z186")
+    assert_equal "2009-08-01", task.due_date.strftime("%Y-%m-%d")
+  end
+
+  test "should know that the task is due" do
+    assert task_by_id("z186").due?
+  end
+
+  test "should know that the task is not due" do
+    Time.stubs(:now).returns(Time.parse('2009-07-31'))
+    assert !task_by_id("z186").due?
+  end
+
+  test "should not be due for a task without due date" do
+    assert !find_task(:basic).due?
+  end
+  
+  test "should find the schedule date" do
+    scheduled = task_by_id("z166")
+    assert_equal "2019-03-20", scheduled.scheduled_date.strftime("%Y-%m-%d")
+  end
+  
+  test "should know if a task i scheduled" do
+    assert task_by_id("z166").scheduled?
+    assert !find_task(:basic).scheduled?
+  end
+
+  test "each state should have a bullet" do
+    assert_equal "✓", task_by_id("z173").bullet # complete
+    assert_equal "×", task_by_id("z189").bullet # canceled
+    assert_equal "-", find_task(:basic).bullet  # regular
+  end
+end

data/things-rb.gemspec

@@ -0,0 +1,66 @@
+# 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{things-rb}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Str\303\266m"]
+  s.date = %q{2010-01-20}
+  s.default_executable = %q{things}
+  s.description = %q{Library and command-line tool for accessing Things.app databases}
+  s.email = %q{name@my-domain.se}
+  s.executables = ["things"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "bin/things",
+     "lib/things.rb",
+     "lib/things/document.rb",
+     "lib/things/focus.rb",
+     "lib/things/task.rb",
+     "lib/things/version.rb",
+     "test/fixtures/Database.xml",
+     "test/test_document.rb",
+     "test/test_focus.rb",
+     "test/test_helper.rb",
+     "test/test_task.rb",
+     "things-rb.gemspec"
+  ]
+  s.homepage = %q{http://github.com/haraldmartin/things-rb}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Library and command-line tool for accessing Things.app databases}
+  s.test_files = [
+    "test/test_document.rb",
+     "test/test_focus.rb",
+     "test/test_helper.rb",
+     "test/test_task.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_runtime_dependency(%q<hpricot>, [">= 0"])
+    else
+      s.add_dependency(%q<hpricot>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<hpricot>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: things-rb
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- "Martin Str\xC3\xB6m"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-20 00:00:00 +01:00
+default_executable: things
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Library and command-line tool for accessing Things.app databases
+email: name@my-domain.se
+executables: 
+- things
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .gitignore
+- CHANGELOG
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- bin/things
+- lib/things.rb
+- lib/things/document.rb
+- lib/things/focus.rb
+- lib/things/task.rb
+- lib/things/version.rb
+- test/fixtures/Database.xml
+- test/test_document.rb
+- test/test_focus.rb
+- test/test_helper.rb
+- test/test_task.rb
+- things-rb.gemspec
+has_rdoc: true
+homepage: http://github.com/haraldmartin/things-rb
+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: "0"
+  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: Library and command-line tool for accessing Things.app databases
+test_files: 
+- test/test_document.rb
+- test/test_focus.rb
+- test/test_helper.rb
+- test/test_task.rb