things-rb 0.3.0 → 0.4.0

data/CHANGELOG

@@ -1,3 +1,9 @@
+*0.4.0* (June 23, 2010)
+
+* Added support to filter tasks by tags from the command line tool
+
+*0.3.0* (August 29, 2009)
+
 *0.2.0* (August 29, 2009)
 
 * Added support for due dates, scheduled items & notes

data/README.markdown

@@ -15,13 +15,13 @@ There are many reasons why you would use a command line version of Things, inclu
 
 ## Install
 
-    $ sudo gem install haraldmartin-things-rb --source http://gems.github.com
+    $ gem install things-rb
 
 If you're on default Mac OS X Leopard and haven't upgraded your RubyGem installation you'll need to to this first:
 
-    $ sudo gem update --system
+    $ gem update --system
 
-When the upgrade is done, just runt the `gem install ...` command above and you're set.
+When the upgrade is done, just run the `gem install ...` command above and you're set.
 
 
 ## Usage
@@ -38,8 +38,7 @@ Example usage:
     tasks = things.today.map do |task|
       tags    = "(#{task.tags.join(' ')})" if task.tags?
       project = "[#{task.parent}]" if task.parent?
-      bullet  = task.completed? ? "✓" : task.canceled? ? "×" : "-"
-      [bullet, task.title, tags, project].compact.join(" ")
+      [task.bullet, task.title, tags, project].compact.join(" ")
     end
     
     puts tasks.compact.sort.join("\n")
@@ -71,17 +70,28 @@ Replace `today` with other focus to list the task
     $ things --all next
     $ things logbook
 
+To just show tasks with a specific tag, use the `-t` or `--tag` option
+    
+    $ things -t errands today
+
 
 ## Testing
 
-To view test document (`test/fixtures/Database.xml`) in Things, just launch Things.app with ⌥ (option/alt) down and click "Choose Library" and point it to `things-rb/test/fixtures`. 
+To view the test document (`test/fixtures/Database.xml`) in Things, just launch Things with ⌥ (option/alt) down and click "Choose Library" and point it to `things-rb/test/fixtures`. 
 Be sure to disable automatic logging of completed tasks in the Things.app preferences so they won't be moved around in the document.
 
+To play nice with other package managers than Rubygems, the command line tool (`bin/things`) and the tests `test/test_helper.rb` *don't* `require 'rubygems'` before `require 'hpricot'`. So if hpricot isn't in your path you need to run the tests slightly different. 
+
+`RUBYOPT=rubygems rake` works for me to load hpricot and the other required gems, but still test the local things version (i.e. not the gem).
+
+Run the local command line tool using `ruby -r rubygems -I lib bin/things`. 
+
+Of course you can just add the require statements in your code in development without committing them.
+
 
 ## TODO
 - Support "Projects" focus
 - Optimize test and XML queries
-- Add tag support to binary
 - Organize the classes, make internal methods private
 
 
@@ -89,7 +99,7 @@ Be sure to disable automatic logging of completed tasks in the Things.app prefer
 
 By [Martin Ström](http://my-domain.se) under the MIT license:
 
->  Copyright (c) 2009 Martin Ström
+>  Copyright (c) 2009-2010 Martin Ström
 >
 >  Permission is hereby granted, free of charge, to any person obtaining a copy
 >  of this software and associated documentation files (the "Software"), to deal

data/Rakefile

@@ -1,3 +1,4 @@
+# -*- encoding: utf-8 -*-
 require "rubygems"
 require "rake/testtask"
 

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/bin/things

@@ -1,14 +1,18 @@
 #!/usr/bin/env ruby
 
+require 'rubygems'
 require "optparse"
+
+$: << File.dirname(__FILE__) + '/lib/things'
+
 require 'things'
 
 options = { :tasks => { :completed => false } }
+
 opts = OptionParser.new do |opts|
   opts.separator ''
   opts.separator 'Options:'
-  
-  opts.banner = "Usage: things [options] today|next|inbox|logbook|trash"
+  opts.banner = "Usage: things [options] today|next|inbox|someday|logbook|trash"
   
   def opts.show_usage
     puts self
@@ -20,8 +24,9 @@ opts = OptionParser.new do |opts|
   end
   
   opts.on("-c", "--completed", 'Shows only completed tasks') { options[:tasks] = { :completed => true } }
-  opts.on("-a", "--all", 'Shows all tasks in the focus') { |f| options[:tasks] = { } }
-
+  opts.on("-a", "--all", 'Shows all tasks in the focus') { options[:tasks].delete(:completed) }
+  opts.on("-t TAG", "--tag TAG", 'Filter tasks by tag') { |f| options[:tasks][:tag] = f }
+  
   opts.on_tail("-h", "--help", "Shows this help message") { opts.show_usage }
   opts.on_tail("-v", "--version", "Shows version") do
     puts Things::Version::STRING
@@ -48,5 +53,8 @@ tasks = things.focus(options[:focus]).tasks(options[:tasks]).map do |task|
   [task.bullet, task.title, tags, project].compact.join(" ")
 end
 
-puts tasks.compact.sort.join("\n")
+if (sorted = tasks.compact.sort).any?
+  puts sorted.join("\n")
+end
+
 

data/lib/things/document.rb

@@ -19,7 +19,7 @@ module Things
       @focus_cache[name] ||= Focus.new(name, @doc)
     end
   
-    [:today, :inbox, :trash, :logbook, :next, :scheduled].each do |name|
+    [:today, :inbox, :trash, :logbook, :next, :scheduled, :someday].each do |name|
       class_eval <<-EOF
         def #{name}(options = {})               # def inbox(options = {})
           focus(:#{name}).tasks(options)        #   focus(:inbox).tasks(options)

data/lib/things/focus.rb

@@ -58,6 +58,10 @@ module Things
           end
         end
       end
+            
+      if tag = options[:tag]
+        @tasks = @tasks.select { |t| t.tag?(tag) }
+      end
     end
   end
 end

data/lib/things/task.rb

@@ -1,3 +1,4 @@
+# -*- encoding: utf-8 -*-
 module Things
   class Task
     include Comparable
@@ -5,14 +6,21 @@ module Things
     INCOMPLETED = 0
     CANCELED    = 2
     COMPLETED   = 3
-
+    CHECK_MARK  = "✓"
+    X_MARK      = "×"
+    MINUS_MARK  = "-"
+    
     def initialize(task_xml, doc)
       @doc      = doc
       @xml_node = task_xml
     end
 
     def title
-      @xml_node.at("attribute[@name='title']").inner_text
+      if n = @xml_node.at("attribute[@name='title']")
+        n.inner_text
+      else
+        "FAIL: [#{@xml_node}]"
+      end
     end
 
     alias_method :to_s, :title
@@ -44,7 +52,7 @@ module Things
     end
     
     def tag?(name)
-      tags.include?(name)
+      tags.any? { |t| t.casecmp(name) == 0 }
     end
     
     def parent_id
@@ -101,7 +109,7 @@ module Things
     end
 
     def due?
-      due_date && Time.now > due_date
+      !!due_date && Time.now > due_date
     end
 
     def scheduled_date
@@ -113,7 +121,14 @@ module Things
     end
 
     def bullet
-      completed? ? "✓" : canceled? ? "×" : "-"
+      case
+      when completed?
+        CHECK_MARK
+      when canceled?
+        X_MARK
+      else
+        MINUS_MARK
+      end
     end
 
     def children_ids

data/lib/things/version.rb

@@ -1,7 +1,7 @@
 module Things
   module Version
     MAJOR  = 0
-    MINOR  = 3
+    MINOR  = 4
     TINY   = 0
 
     STRING = [MAJOR, MINOR, TINY].join(".")

data/test/test_focus.rb

@@ -89,6 +89,17 @@ class FocusTest < Test::Unit::TestCase
     assert !canceled.all? { |e| e.title.include?("cancel") }
   end
   
+  test "should not find canceled nor completed tasks when passing :canceled => false, :completed => false" do
+    tasks = @things.focus(:next).tasks(:canceled => false, :completed => false)
+    assert_equal 0, tasks.select(&:canceled?).length
+    assert_equal 0, tasks.select(&:completed?).length
+  end
+  
+  test "should filter tasks by tag" do
+    tasks = @things.focus(:next).tasks(:tag => 'home')
+    assert tasks.all? { |e| e.tag?('home') }
+  end
+  
   test "should not include projects when listing tasks" do
     with_children = @things.focus(:next).tasks.select(&:children?)
     assert_equal 0, with_children.length

data/test/test_helper.rb

@@ -1,3 +1,4 @@
+require "rubygems"
 require "things"
 require "test/unit"
 require "mocha"
@@ -23,4 +24,4 @@ class Test::Unit::TestCase
       end
     end
   end
-end
+end

data/test/test_task.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'test_helper'
 
 class TaskTest < Test::Unit::TestCase
@@ -65,6 +67,12 @@ class TaskTest < Test::Unit::TestCase
     assert(!task.tag?("Errand"))
   end
   
+  test "if the task has a specific tag in other case" 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)

data/things-rb.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{things-rb}
-  s.version = "0.3.0"
+  s.version = "0.4.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.date = %q{2010-06-23}
   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}
@@ -41,7 +41,7 @@ Gem::Specification.new do |s|
   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.rubygems_version = %q{1.3.7}
   s.summary = %q{Library and command-line tool for accessing Things.app databases}
   s.test_files = [
     "test/test_document.rb",
@@ -54,7 +54,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<hpricot>, [">= 0"])
     else
       s.add_dependency(%q<hpricot>, [">= 0"])

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: things-rb
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - "Martin Str\xC3\xB6m"
@@ -9,19 +15,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-20 00:00:00 +01:00
+date: 2010-06-23 00:00:00 +02:00
 default_executable: things
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hpricot
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 description: Library and command-line tool for accessing Things.app databases
 email: name@my-domain.se
 executables: 
@@ -60,21 +70,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Library and command-line tool for accessing Things.app databases