things-client 0.1.0 → 0.2.0

data/README.rdoc

@@ -4,16 +4,23 @@ Things is a Ruby API for the popular GTD app Things, available on the Mac.
 
 == Installation
 
-Currently, because this is an alpha version and it's too early for a release, installation must be done manually, like this:
+The gem is hosted on Gemcutter. To install it, use the following command:
 
-  git clone http://github.com/marcinbunsch/things
-  cd things
+  sudo gem install things-client --source http://gemcutter.org
+  
+To get the latest version, clone the gem from github and run rake install:
+
+  git clone http://github.com/marcinbunsch/things-client
+  cd things-client
   rake check_dependencies:runtime
-  rake build
-  sudo gem install pkg/things-0.0.1.gem
+  sudo rake install
 
 == Usage
 
+Before using this gem you must require it by calling:
+
+  require 'things'
+
 === Application
 
 The Application can be accessed at all times by calling Things::App. It has a few useful methods which will be described below. If you want Things to gain focus and move to the front of the window stack, you can call the Things::App.activate method.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/appscript/reference.rb

@@ -5,5 +5,19 @@ module Appscript #:nodoc:
     def todos
       to_dos
     end
+    
+    def identify
+      name = self.to_s.match(/Things.app"\)\.([^\.]*)/)[1]
+    
+      begin
+        name = name.gsub('_', '')
+        # inflections
+        name = 'persons' if name == 'people'
+        Things.const_get(name.capitalize[0..-2]) 
+      rescue NameError
+        nil
+      end
+    end
+    
   end
 end

data/lib/things.rb

@@ -13,11 +13,8 @@ module Things
   autoload :Area, File.dirname(__FILE__) + '/things/area'
   autoload :Project, File.dirname(__FILE__) + '/things/project'
   autoload :Tag, File.dirname(__FILE__) + '/things/tag'
-  
-  module Collections
-    autoload :Todo, File.dirname(__FILE__) + '/things/collections/todo'
-  end
-  
+  autoload :Person, File.dirname(__FILE__) + '/things/person'
+    
   module Reference
     autoload :Base, File.dirname(__FILE__) + '/things/reference/base'
     autoload :Inheritance, File.dirname(__FILE__) + '/things/reference/inheritance'

data/lib/things/app.rb

@@ -16,11 +16,6 @@ module Things
       List
     end
     
-    # get a collection of Todos
-    def self.todos
-      Collections::Todo
-    end
-    
     # activate the app and bring it to front
     def self.activate
       instance!.activate

data/lib/things/area.rb

@@ -8,5 +8,10 @@ module Things
     # collection is used for findings
     collection :areas
    
+    def todos
+      Things::Todo.convert(reference.todos.get)
+    end
+   
   end
+  
 end

data/lib/things/list.rb

@@ -1,18 +1,45 @@
 module Things
-  class List
+  class List < Reference::Base
+    
     DEFAULTS = [:inbox, :today, :next, :scheduled, :someday, :projects, :logbook, :trash]
-      class << self
-        def all
-          Things::App.instance.lists
-        end
+    
+    def todos
+      Things::Todo.convert(reference.todos.get)
+    end
+    
+    class << self
+      
+      # Returns an Appscript Reference to the entire collection of todos
+      def reference
+        Things::App.instance.lists
+      end
+
+      # Converts a collection of reference into a collection of objects
+      def convert(references)
+        references = [references] if !references.is_a?(Array)
+        references.collect { |todo| build(todo) }
+      end
+      
+      def all
+        convert(reference.get)
+      end
+      
+      # build a new instance and link it to the supplied reference
+      #
+      # Returns a object associated with a reference
+      def build(reference)
+        todo = self.new
+        todo.reference = reference
+        todo
+      end
 
-        DEFAULTS.each do |list|
-          class_eval <<-"eval"
-            def #{list}
-              all['#{list.to_s.capitalize}']
-            end
-          eval
-        end
+      DEFAULTS.each do |list|
+        class_eval <<-"eval"
+          def #{list}
+            convert(reference['#{list.to_s.capitalize}'].get).first
+          end
+        eval
       end
+    end
   end
 end

data/lib/things/person.rb

@@ -0,0 +1,42 @@
+module Things
+  # Things::Person
+  #
+  # People in Things cannot be created, they are fetched from Address Book
+  class Person < Reference::Record
+    
+    properties :name
+    # identifier is required for creation
+    identifier :person
+    # collection is used for findings
+    collection :people
+    
+    # Find a Person in Address Book and add a teammate in Things
+    #
+    # Returns a Things::Person object
+    def self.create(address_book_name)
+      reference = Things::App.instance.add_teammate_named(address_book_name)
+      raise 'Could not find person in Address Book' if reference == :missing_value
+      build(reference)
+    end
+    
+    def todos
+      Things::Todo.convert(reference.todos.get)
+    end
+    
+    # Not supported by Things::Person
+    # 
+    # Raises a RuntimeError when called
+    def save
+      raise 'Currently Things does not support this method'
+    end
+    
+    # Not supported by Things::Person
+    # 
+    # Raises a RuntimeError when called
+    def delete
+      reference.delete
+    end
+    
+  end
+  
+end

data/lib/things/project.rb

@@ -8,5 +8,9 @@ module Things
     # collection is used for findings
     collection :projects
    
+    def todos
+      Things::Todo.convert(reference.todos.get)
+    end
+    
   end
 end

data/lib/things/reference/record.rb

@@ -21,16 +21,16 @@ module Things
         if args
           @_properties += args
           @_properties.each do |property|
-            attr_writer(property) if !instance_methods.include?(property.to_s)
+            attr_writer(property) if !instance_methods.include?(property.to_s+'=')
             if !instance_methods.include?(property.to_s )
               class_eval <<-"eval"
                 def #{property}
-                  if !@#{property}
-                    fetched = @reference.#{property}.get rescue nil
-                    @#{property} = fetched if fetched and fetched != :missing_value
-                  else
-                    @#{property}
+                  return @#{property} if @#{property}
+                  fetched = @reference.#{property}.get rescue nil
+                  if fetched.is_a?(Appscript::Reference)
+                    fetched = fetched.identify.build(fetched)
                   end
+                  @#{property} = fetched if fetched and fetched != :missing_value
                 end
               eval
             end
@@ -58,12 +58,24 @@ module Things
         if new?
           properties = {}
           (self.class.properties - [:id_]).each do |property|
-            properties[property] = self.send(property) if self.send(property)
+            if value = self.send(property)
+              properties[property] = value.respond_to?(:reference) ? value.reference : value
+            end
           end
-          self.reference = Things::App.instance.make(:new => self.class.identifier, :with_properties => properties)
+          # only set name in make, then set the rest of the properties
+          name = properties.delete(:name)
+          self.reference = Things::App.instance.make(:new => self.class.identifier, :with_properties => { :name => name })
+          properties.each_pair { |name, property| self.reference.send(name).set(property) }
         else
           (self.class.properties - [:id_]).each do |property|
-            self.reference.send(property).set(self.send(property)) if self.send(property)
+            if value = self.send(property)
+              self.reference.send(property).set(value.respond_to?(:reference) ? value.reference : value)
+            else
+              begin
+                self.reference.send(property).delete
+              rescue
+              end
+            end
           end
         end
         self

data/lib/things/todo.rb

@@ -2,7 +2,7 @@ module Things
   # Things::Todo
   class Todo < Reference::Record
     
-    properties :name, :notes, :completion_date
+    properties :name, :notes, :completion_date, :delegate, :status, :area, :project
     # identifier is required for creation
     identifier :to_do
     # collection is used for findings
@@ -11,8 +11,88 @@ module Things
     # Move a todo to a different list <br />
     # Moving to Trash will delete the todo
     def move(list)
+      list = list.reference if !list.is_a?(Appscript::Reference)
       Things::App.instance.move(reference, { :to => list })
     end
     
+    # Set the status to :completed
+    #
+    # Does not save the Todo
+    def complete
+      self.status = :completed
+    end
+
+    # Set the status to :completed
+    #
+    # Saves the Todo
+    def complete!
+      complete
+      self.save
+    end
+
+    # Check whether the Todo is completed or not
+    def completed?
+      self.status == :completed
+    end
+    
+    # Set the status to :open
+    #
+    # Does not save the Todo
+    def open
+      self.status = :open
+    end
+
+    # Set the status to :open
+    #
+    # Saves the Todo
+    def open!
+      open
+      self.save
+    end
+
+    # Check whether the Todo is open or not
+    def open?
+      self.status == :open
+    end
+    
+    # class methods, for accessing collections
+    class << self
+      
+      # Returns an Appscript Reference to the entire collection of todos
+      def reference
+        Things::App.instance.todos
+      end
+      
+      # Converts a collection of reference into a collection of objects
+      def convert(references)
+        references.to_a.collect { |todo| build(todo) }
+      end
+      
+      # these are references and should be stored somewhere else...
+      Things::List::DEFAULTS.each do |list|
+        class_eval <<-"eval"
+          def #{list}
+            convert(Things::List.#{list}.reference.todos.get)
+          end
+        eval
+      end
+      
+      # Returns an array of Things::Todo objects
+      def all
+        convert(reference.get)
+      end
+
+      # Get all not completed Todos
+      # Note this returns an array of Todos, not references
+      # TODO: find a better way of filtering references
+      def active
+        result = (reference.get - Things::List.trash.reference.todos.get).select do |todo| 
+          todo.completion_date.get == :missing_value
+        end
+        convert(result.compact)
+      end
+
+    end
+    
   end
 end

data/spec/things/app_spec.rb

@@ -12,13 +12,9 @@ describe "Things::App" do
   
   describe '#activate' do
   
-    it 'should start the app if it is not running' do
-      
-      # close if running
-      #Things::App.instance!.quit if `ps x | grep Things`.include?('Things.app')
-      #{}`ps x | grep Things`.should_not match('Things.app')
-      #Things::App.instance!.activate
-      #{}`ps x | grep Things`.should match('Things.app')
+    it 'should put the app in the front' do      
+      Things::App.instance!.activate
+      Things::App.instance.frontmost.get.should == true
     end
     
   end
@@ -30,14 +26,5 @@ describe "Things::App" do
     end
 
   end
-  
-  describe '#todos' do
     
-    it "should return Things::Collections::Todo" do
-      Things::App.todos.should == Things::Collections::Todo
-    end
-
-  end
-
-  
 end

data/spec/things/area_spec.rb

@@ -3,17 +3,9 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe "Things::Area" do
 
   before do
-    Things::App.activate
     @area = Things::Area.new(:name => 'TEST - Foo')
   end
   
-  after do
-    # close all windows when done
-    Things::App.instance.windows.get.each do |window|
-      Things::App.instance!.close(window)
-    end
-  end
-  
   describe "#self.new" do
       
     it "should create a new Things::Area instance with properties" do      
@@ -148,6 +140,29 @@ describe "Things::Area" do
     
   end
   
+  describe '#todos' do
+    
+    before do
+      @foo = Things::Todo.new(:name => 'TEST - Foo')
+      @bar = Things::Todo.new(:name => 'TEST - Bar')
+    end
+    
+    after do
+      @foo.delete
+      @bar.delete
+      Things::App.instance.empty_trash
+    end
+    
+    it "should get todo assigner to a area" do
+      @area.save
+      @foo.area= @area
+      @foo.save
+      @foo.area.should == @area
+      @area.delete
+    end
+    
+  end
+  
   
 
 end

data/spec/things/list_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Things::List" do
+  
+end

data/spec/things/person_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Things::Person" do
+  
+  before do
+    Appscript.app('Address Book').make(:new => :person, :with_properties => { :organization => 'ThingsClientTest', :company => true })
+  end
+  
+  it "should add a new person" do
+    @person = Things::Person.create('ThingsClientTest')
+    
+  end
+end

data/spec/things/project_spec.rb

@@ -3,17 +3,9 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe "Things::Project" do
 
   before do
-    Things::App.activate
     @project = Things::Project.new(:name => 'TEST - Foo')
   end
   
-  after do
-    # close all windows when done
-    Things::App.instance.windows.get.each do |window|
-      Things::App.instance!.close(window)
-    end
-  end
-  
   describe "#self.new" do
       
     it "should create a new Things::Project instance with properties" do      

data/spec/things/tag_spec.rb

@@ -3,17 +3,9 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe "Things::Tag" do
 
   before do
-    Things::App.activate
     @tag = Things::Tag.new(:name => 'TEST - Foo')
   end
-  
-  after do
-    # close all windows when done
-    Things::App.instance.windows.get.each do |window|
-      Things::App.instance!.close(window)
-    end
-  end
-  
+    
   describe "#self.new" do
       
     it "should create a new Things::Tag instance with properties" do      

data/spec/things/todo_spec.rb

@@ -3,17 +3,9 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe "Things::Todo" do
 
   before do
-    Things::App.activate
     @todo = Things::Todo.new(:name => 'TEST - Foo', :notes => 'TEST - Fooer')
   end
   
-  after do
-    # close all windows when done
-    Things::App.instance.windows.get.each do |window|
-      Things::App.instance!.close(window)
-    end
-  end
-  
   describe "#self.new" do
       
     it "should create a new Things::Todo instance with properties" do      
@@ -23,7 +15,7 @@ describe "Things::Todo" do
     
     it "should not be sent to Things yet" do
       @todo.id_.should == nil
-      active = (Things::App.instance.todos.get - Things::List.trash.todos.get)
+      active = (Things::App.instance.todos.get - Things::List.trash.reference.todos.get)
       active.collect { |todo| todo.name.get }.should_not include("TEST - Foo")
     end
     
@@ -53,7 +45,7 @@ describe "Things::Todo" do
       it "should create the todo" do
         @todo.id_.should_not be_nil
         @todo.new?.should == false
-        active = (Things::App.instance.todos.get - Things::List.trash.todos.get)
+        active = (Things::App.instance.todos.get - Things::List.trash.reference.todos.get)
         active.collect { |todo| todo.name.get }.should include("TEST - Foo")
       end
       
@@ -96,13 +88,13 @@ describe "Things::Todo" do
     
     before do
       @todo.save
-      Things::App.lists.inbox.todos.name.get.should include(@todo.name)
+      Things::App.lists.inbox.reference.todos.name.get.should include(@todo.name)
     end
     
     it "should remove a todo" do
       @todo.delete
-      Things::App.lists.inbox.todos.name.get.should_not include(@todo.name)      
-      Things::App.lists.trash.todos.name.get.should include(@todo.name)
+      Things::App.lists.inbox.reference.todos.name.get.should_not include(@todo.name)      
+      Things::App.lists.trash.reference.todos.name.get.should include(@todo.name)
     end
     
     after do
@@ -155,6 +147,54 @@ describe "Things::Todo" do
     
   end
   
+  describe "#self.all" do
+    before do 
+      @todo_a = Things::Todo.create(:name => 'TEST - AAA')
+      @todo_b = Things::Todo.create(:name => 'TEST - BBB')
+    end
+    
+    after do
+      @todo_a.delete
+      @todo_b.delete      
+      Things::App.instance.empty_trash
+    end
+    
+    it "should return a collection of all todos as Things::Todo objects" do
+      Things::Todo.all.collect(&:id_).should include(@todo_a.id_)
+      Things::Todo.all.collect(&:id_).should include(@todo_b.id_)
+    end
+    
+  
+  end
   
+  describe "#self.active" do
+    
+    before do 
+      @todo_a = Things::Todo.create(:name => 'TEST - AAA')
+      @todo_b = Things::Todo.create(:name => 'TEST - BBB')
+      Things::Todo.active.collect(&:id_).should include(@todo_a.id_)
+      Things::Todo.active.collect(&:id_).should include(@todo_b.id_)
+    end
+    
+    after do
+      @todo_a.delete
+      @todo_b.delete      
+      Things::App.instance.empty_trash
+    end
+    
+    it "should not include completed todos" do
+      @todo_b.completion_date = Time.now
+      @todo_b.save
+      Things::Todo.active.collect(&:id_).should include(@todo_a.id_)
+      Things::Todo.active.collect(&:id_).should_not include(@todo_b.id_)      
+    end
+    
+    it "should not include deleted todos" do
+      @todo_a.delete
+      Things::Todo.active.collect(&:id_).should_not include(@todo_a.id_)
+      Things::Todo.active.collect(&:id_).should include(@todo_b.id_)
+    end
+    
+  end
 
 end

data/spec/things_spec.rb

@@ -8,7 +8,10 @@ describe "Things" do
       Things::Todo
       Things::List
       Things::Status
-      Things::Collections::Todo
+      Things::Area
+      Things::Project
+      Things::Tag
+      Things::Person
     end.should_not raise_error(NameError)
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: things-client
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Marcin Bunsch
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-08 00:00:00 +01:00
+date: 2010-02-23 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,8 +52,8 @@ files:
 - lib/things.rb
 - lib/things/app.rb
 - lib/things/area.rb
-- lib/things/collections/todo.rb
 - lib/things/list.rb
+- lib/things/person.rb
 - lib/things/project.rb
 - lib/things/reference/base.rb
 - lib/things/reference/inheritance.rb
@@ -65,7 +65,8 @@ files:
 - spec/spec_helper.rb
 - spec/things/app_spec.rb
 - spec/things/area_spec.rb
-- spec/things/collections/todo_spec.rb
+- spec/things/list_spec.rb
+- spec/things/person_spec.rb
 - spec/things/project_spec.rb
 - spec/things/tag_spec.rb
 - spec/things/todo_spec.rb
@@ -103,7 +104,8 @@ test_files:
 - spec/spec_helper.rb
 - spec/things/app_spec.rb
 - spec/things/area_spec.rb
-- spec/things/collections/todo_spec.rb
+- spec/things/list_spec.rb
+- spec/things/person_spec.rb
 - spec/things/project_spec.rb
 - spec/things/tag_spec.rb
 - spec/things/todo_spec.rb

data/lib/things/collections/todo.rb

@@ -1,42 +0,0 @@
-module Things
-  module Collections
-    class Todo
-    
-      class << self
-        
-        # Returns an Appscript Reference to the entire collection of todos
-        def reference
-          Things::App.instance.todos
-        end
-        
-        # these are references and should be stored somewhere else...
-        Things::List::DEFAULTS.each do |list|
-          class_eval <<-"eval"
-            def #{list}
-              Things::App.lists.#{list}.todos
-            end
-          eval
-        end
-        
-        # Returns an array of Things::Todo objects
-        def all
-          reference.get.collect { |todo| Things::Todo.build(todo) }
-        end
-
-        # Get all not completed Todos
-        # Note this returns an array of Todos, not references
-        # TODO: find a better way of filtering references
-        def active
-          result = (reference.get - Things::List.trash.todos.get).collect do |todo| 
-            Things::Todo.build(todo) if todo.completion_date.get.to_s == 'missing_value'
-          end
-          result.compact
-        end
-    
-
-
-      end
-      
-    end
-  end
-end

data/spec/things/collections/todo_spec.rb

@@ -1,54 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
-
-describe "Things::Collections::Todo" do
-  
-  describe "#self.all" do
-    before do 
-      @todo_a = Things::Todo.create(:name => 'TEST - AAA')
-      @todo_b = Things::Todo.create(:name => 'TEST - BBB')
-    end
-    
-    after do
-      @todo_a.delete
-      @todo_b.delete      
-      Things::App.instance.empty_trash
-    end
-    
-    it "should return a collection of all todos as Things::Todo objects" do
-      Things::Collections::Todo.all.collect(&:id_).should include(@todo_a.id_)
-      Things::Collections::Todo.all.collect(&:id_).should include(@todo_b.id_)
-    end
-    
-  
-  end
-  
-  describe "#self.active" do
-    
-    before do 
-      @todo_a = Things::Todo.create(:name => 'TEST - AAA')
-      @todo_b = Things::Todo.create(:name => 'TEST - BBB')
-      Things::Collections::Todo.active.collect(&:id_).should include(@todo_a.id_)
-      Things::Collections::Todo.active.collect(&:id_).should include(@todo_b.id_)
-    end
-    
-    after do
-      @todo_a.delete
-      @todo_b.delete      
-      Things::App.instance.empty_trash
-    end
-    
-    it "should not include completed todos" do
-      @todo_b.completion_date = Time.now
-      @todo_b.save
-      Things::Collections::Todo.active.collect(&:id_).should include(@todo_a.id_)
-      Things::Collections::Todo.active.collect(&:id_).should_not include(@todo_b.id_)      
-    end
-    
-    it "should not include deleted todos" do
-      @todo_a.delete
-      Things::Collections::Todo.active.collect(&:id_).should_not include(@todo_a.id_)
-      Things::Collections::Todo.active.collect(&:id_).should include(@todo_b.id_)
-    end
-    
-  end
-end