zzamboni-things2thl 0.5.0 → 0.7.0

data/ChangeLog

@@ -1,6 +1,67 @@
+2009-05-21  Diego Zamboni <diego@zzamboni.org>
+
+	* VERSION, lib/Things2THL.rb: Version bump to 0.7.0
+
+2009-05-21  Diego Zamboni <diego@zzamboni.org>
+
+	* README, bin/things2thl, lib/Things2THL.rb: Added a new mode of
+	operation --projects-areas-as-lists (-B). As the name implies, in
+	this mode both projects and areas from Things are stored as lists in
+	THL. This means that projects are NOT nested inside areas, as is the
+	case in the other two modes. Instead, the lists for areas will
+	contain only single tasks that were inside the area in Things.  If --projects-top-level and --areas-top-level are not given, all the
+	lists will be created in the main folders group. Otherwise, they
+	will appear within the corresponding folder.
+
+2009-05-21  Diego Zamboni <diego@zzamboni.org>
+
+	* bin/things2thl, lib/Things2THL.rb: Added --areas-top-level option
+	to specify a folder in which imported Areas should be created.
+
+2009-05-20  Diego Zamboni <diego@zzamboni.org>
+
+	* README: Updated README
+
+2009-05-20  Diego Zamboni <diego@zzamboni.org>
+
+	* things2thl.gemspec: Regenerated gemspec for version 0.6.0
+
+2009-05-20  Diego Zamboni <diego@zzamboni.org>
+
+	* ChangeLog, VERSION, lib/Things2THL.rb: Version bump to 0.6.0
+
+2009-05-20  Diego Zamboni <diego@zzamboni.org>
+
+	* Rakefile, lib/Things2THL.rb: Vastly improved conversion of the
+	notes field. The HTML stored in the Things notes is parsed and
+	rendered as text, including all the appropriate URLs and links. It
+	does not look exactly as the original, but is quite usable.
+
 2009-05-19  Diego Zamboni <diego@zzamboni.org>
 
-	* lib/Things2THL.rb: Version bump to 0.5.0
+	* README: Updated to state limitation of transferring repeating
+	tasks.
+
+2009-05-19  Diego Zamboni <diego@zzamboni.org>
+
+	* lib/Things2THL.rb: Make Scheduled and Logbook a list instead of a
+	folder when --projects-as-tasks. Someday stays always as a folder,
+	because it can contain areas (suspended areas)
+
+2009-05-19  Diego Zamboni <diego@zzamboni.org>
+
+	* lib/Things2THL.rb: Transfer activation_date as start_date so that
+	scheduled (one-time) tasks are set appropriately. Still need to
+	figure out how to identify repeating tasks.
+
+2009-05-19  Diego Zamboni <diego@zzamboni.org>
+
+	* things2thl.gemspec: Regenerated gemspec for version 0.5.0
+
+2009-05-19  Diego Zamboni <diego@zzamboni.org>
+
+	* ChangeLog, README, VERSION, lib/Things2THL.rb: Version bump to
+	0.5.0
 
 2009-05-19  Diego Zamboni <diego@zzamboni.org>
 

data/README

@@ -1,4 +1,4 @@
-Things2THL
+Things2THL 0.7.0
 http://zzamboni.github.com/things2thl/
 
 Conversion program to transfer data from Things
@@ -17,9 +17,10 @@ support.
 Then install things2thl by running:
      $ sudo gem install zzamboni-things2thl --source http://gems.github.com/
 
-Note: things2thl need the rb-appscript library from
-http://appscript.sourceforge.net/rb-appscript/install.html. If you
-don't have it already, it will be automatically installed by gem.
+Note: things2thl need the rb-appscript
+(http://appscript.sourceforge.net/rb-appscript/) and hpricot
+(http://wiki.github.com/why/hpricot) . If you don't have them already,
+they will be automatically installed by gem.
 
 
 
@@ -31,6 +32,9 @@ Usage: things2thl <mode of operation> [options]
 Modes of operation (required):
     -L, --projects-as-lists          Convert projects in Things to lists in THL
     -T, --projects-as-tasks          Convert projects in Things to tasks in THL
+    -B, --projects-areas-as-tasks    Convert both projects and areas in Things
+                                       to lists in THL. This implies that
+                                       projects are not nested inside areas.
 
 Options:
         --[no-]areas                 Transfer areas from Things (default: yes)
@@ -53,6 +57,8 @@ Options:
                                        'Projects' list is always created, but
                                        this option can be used to specify
                                        its name.
+        --areas-top-level FOLDER     The named folder will be created to
+                                       contain all areas.
     -c, --completed                  Transfer also completed/canceled tasks
                                        and projects (default: no)
         --[no-]archive-completed     If transferring completed/canceled tasks,
@@ -67,15 +73,9 @@ Options you should seldom need:
         --thl THLAPP                 Location of the The Hit List application
                                        (default: /Applications/The Hit List.app)
 
-
 Functionality still missing:
 ---------------------------
 
-- Handle rich-text notes (with attachments, links, etc.) properly
-
-  Plan: not sure yet. Need to investigate how notes are stored in
-  THL (Things uses an XML format)
-
 - Handling delegation ("People" feature in Things)
 
   Not sure how to transfer this to THL. Ideas are welcome.
@@ -89,9 +89,9 @@ Known issues:
   completed/canceled tasks, they will all appear in your "completed
   today" view.
 
-- Tasks in the Things "Scheduled" focus are transferred, but the
-  scheduling itself is not transferred, because this information is
-  not accessible through AS from either Things not THL.
+- One-time tasks in the Things "Scheduled" focus are transferred, but
+  repeating tasks are not. The Things Applescript interface does not
+  provide access to repeating tasks.
 
 - The format of time estimate tags is fixed for the moment. May add
-  customization if I get any requests for it.
+  customization if I get any requests for it.

data/Rakefile

@@ -11,6 +11,7 @@ begin
     gemspec.description = "Library and command-line tool for migrating Things data to The Hit List"
     gemspec.authors = ["Diego Zamboni"]
     gemspec.add_dependency('rb-appscript', '>=0.5.1')
+    gemspec.add_dependency('hpricot', '>=0.6')
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.7.0

data/bin/things2thl

@@ -21,6 +21,10 @@ opts = OptionParser.new do |opts|
           "Convert projects in Things to lists in THL" ) { options.structure = :projects_as_lists }
   opts.on("-T", "--projects-as-tasks",
           "Convert projects in Things to tasks in THL" ) { options.structure = :projects_as_tasks }
+  opts.on("-B", "--projects-areas-as-tasks",
+          "Convert both projects and areas in Things",
+          "  to lists in THL. This implies that",
+          "  projects are not nested inside areas.") { options.structure = :projects_areas_as_lists }
 
   opts.separator ''
   opts.separator("Options:")
@@ -53,6 +57,11 @@ opts = OptionParser.new do |opts|
           "  its name.") do |projfolder|
     options.projectsfolder = projfolder
   end
+  opts.on("--areas-top-level FOLDER",
+          "The named folder will be created to",
+          "  contain all areas.") do |areafolder|
+    options.areasfolder = areafolder
+  end
 
   opts.on("-c", "--completed",
           "Transfer also completed/canceled tasks",

data/lib/Things2THL.rb

@@ -5,13 +5,14 @@ require "ostruct"
 require 'time'
 begin; require 'rubygems'; rescue LoadError; end
 require 'appscript'; include Appscript
+require 'hpricot'
 
 ######################################################################
 
 module Things2THL
   module Version
     MAJOR  = 0
-    MINOR  = 5
+    MINOR  = 7
     PATCH  = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")
@@ -64,13 +65,14 @@ module Things2THL
                               :due_date => :due_date,
                               :completion_date => :completed_date,
                               :cancellation_date => :canceled_date,
+                              :activation_date => :start_date,
                               :status => {
                                 :completed => :completed,
                                 :canceled  => :canceled,
                               },
-                              :notes => :notes,
                             },
                             Proc.new {|node,prop,obj|
+                              obj.add_notes(node,prop)
                               obj.fix_completed_canceled(node, prop)
                               obj.archive_completed(prop)
                               obj.process_tags(node, prop, true, true)
@@ -90,13 +92,14 @@ module Things2THL
                        :due_date => :due_date,
                        :completion_date => :completed_date,
                        :cancellation_date => :canceled_date,
+                       :activation_date => :start_date,
                        :status => {
                          :completed => :completed,
                          :canceled  => :canceled,
                        },
-                       :notes => :notes,
                      },
                      Proc.new {|node,prop,obj|
+                       obj.add_notes(node,prop)
                        obj.fix_completed_canceled(node, prop)
                        obj.archive_completed(prop)
                        obj.process_tags(node, prop, false, true)
@@ -109,19 +112,57 @@ module Things2THL
                               :due_date => :due_date,
                               :completion_date => :completed_date,
                               :cancellation_date => :canceled_date,
+                              :activation_date => :start_date,
                               :status => {
                                 :completed => :completed,
                                 :canceled  => :canceled,
                               },
-                              :notes => :notes,
                             },
                             Proc.new {|node,prop,obj|
+                              obj.add_notes(node,prop)
                               obj.fix_completed_canceled(node, prop)
                               obj.archive_completed(prop)
                               obj.process_tags(node, prop, false, true)
                               obj.check_today(node, prop)
                             }
                            ]
+      },
+      :projects_areas_as_lists => {
+        :area => [:list,
+                  {
+                    :name => :name,
+                  }],
+        :project => [:list,
+                     {
+                       :name => :name,
+                       :creation_date => :created_date,
+                     },
+                     Proc.new {|node,prop,obj|
+                       obj.add_list_notes(node,prop)
+                       obj.add_project_duedate(node,prop)
+                     }
+                    ],
+        :selected_to_do => [:task,
+                            {
+                              :name => :title,
+                              :creation_date => :created_date,
+                              :due_date => :due_date,
+                              :completion_date => :completed_date,
+                              :cancellation_date => :canceled_date,
+                              :activation_date => :start_date,
+                              :status => {
+                                :completed => :completed,
+                                :canceled  => :canceled,
+                              },
+                            },
+                            Proc.new {|node,prop,obj|
+                              obj.add_notes(node,prop)
+                              obj.fix_completed_canceled(node, prop)
+                              obj.archive_completed(prop)
+                              obj.process_tags(node, prop, true, true)
+                              obj.check_today(node, prop)
+                            }
+                           ]
       }
     }
 
@@ -259,7 +300,13 @@ module Things2THL
     # Get the type of the THL node that corresponds to the given Things node,
     # depending on the options specified
     def thl_node_type(node)
-      Constants::STRUCTURES[options.structure][node.type][0]
+      case node
+      when Symbol
+        type=node
+      else
+        type=node.type
+      end
+      Constants::STRUCTURES[options.structure][type][0]
     end
 
     # Get the name/title for a THL node.
@@ -370,10 +417,12 @@ module Things2THL
                      nil
                    when 'Inbox', 'Next'
                      find_or_create(:list, focusname, top_level_node)
-                   when 'Scheduled', 'Someday', 'Logbook'
+                   when 'Scheduled', 'Logbook'
+                     find_or_create((thl_node_type(:project) == :task) ? :list : :folder, focusname, top_level_node)
+                   when 'Someday'
                      find_or_create(:folder, focusname, top_level_node)
                    when 'Projects'
-                     if options.structure == :projects_as_tasks
+                     if thl_node_type(:project) == :task
                        find_or_create(:list, options.projectsfolder || 'Projects', top_level_node)
                      else
                        if options.projectsfolder
@@ -393,10 +442,12 @@ module Things2THL
                      thl.inbox.get
                    when 'Next'
                      top_level_node
-                   when 'Scheduled', 'Someday', 'Logbook'
+                   when 'Scheduled', 'Logbook'
+                     find_or_create((thl_node_type(:project) == :task) ? :list : :folder, focusname, top_level_node)
+                   when 'Someday'
                      find_or_create(:folder, focusname, top_level_node)
                    when 'Projects'
-                     if options.structure == :projects_as_tasks
+                     if thl_node_type(:project) == :task
                        find_or_create(:list, options.projectsfolder || 'Projects', top_level_node)
                      else
                        if options.projectsfolder
@@ -426,7 +477,11 @@ module Things2THL
         if node.suspended
           return top_level_for_focus('Someday')
         else
-          return top_level_node
+          if options.areasfolder
+            return find_or_create(:folder, options.areasfolder || 'Areas', top_level_node)
+          else
+            return top_level_node
+          end
         end
       end
 
@@ -467,7 +522,6 @@ module Things2THL
     # we need to find or create an auxiliary list to contain it.
     def container_for(node)
       # If its top-level container is nil, it means we need to skip this node
-      # unless it's an area, areas don't have a focus
       tlcontainer=top_level_for_node(node)
       return nil unless tlcontainer
 
@@ -476,7 +530,7 @@ module Things2THL
                   when :area
                     tlcontainer
                   when :project
-                    if options.areas && node.area?
+                    if options.areas && (options.structure != :projects_areas_as_lists)  && node.area?
                       get_cached_or_process(node.area)
                     else
                       tlcontainer
@@ -702,6 +756,30 @@ module Things2THL
       prop[:__newnodes__].push(newnode)
     end
 
+    def hextostring(hexstr)
+      [hexstr.delete(" ")].pack("H*")
+    end
+
+    def aliastostring(node)
+      hextostring((node/'alias').inner_text)
+    end
+
+    # Process Things notes before adding them to THL.
+    def convert_notes(notes)
+      return unless notes
+      # First, parse the notes as XML and extract the contents of the <note> tag
+      note_html = (Hpricot.XML(notes)/'/note').inner_html
+      # Then parse the HTML
+      html = Hpricot(note_html)
+      # Then swap any <alias> tags with their unencoded content
+      # TODO: this is a hack - it would be much better to understand the binary structure of the <alias> tag.
+      while html.at('alias')
+        html.at('alias').swap( aliastostring(html).gsub(/^.*\000\022\000.(.*?)\000.*$/m, 'file:///\1') )
+      end
+      # Finally return the HTML in "plain text" format, which shows the links in brackets
+      html.to_plain_text
+    end
+
     # Add a new task containing project notes when the project is a THL list,
     # since THL lists cannot have notes
     def add_list_notes(node, prop)
@@ -713,7 +791,7 @@ module Things2THL
         if node.notes? && new_node_type == :list
           newnode = {
             :new => :task,
-            :with_properties => { :title => "Notes for '#{prop[:name]}'", :notes => node.notes }}
+            :with_properties => { :title => "Notes for '#{prop[:name]}'", :notes => convert_notes(node.notes) }}
           # Mark as completed if the project is completed
           if node.status == :completed || node.status == :canceled
             newnode[:with_properties][:completed] = true
@@ -727,6 +805,11 @@ module Things2THL
       end
     end
 
+    # Transfer processed notes
+    def add_notes(node, prop)
+      prop[:notes] = convert_notes(node.notes) if node.notes?
+    end
+
     # When projects are lists, if the project has a due date, we add a bogus task to it
     # to represent its due date, since lists in THL cannot have due dates.
     def add_project_duedate(node, prop)
@@ -755,6 +838,7 @@ module Things2THL
     options.quiet = false
     options.archivecompleted = true
     options.projectsfolder = nil
+    options.areasfolder = nil
     options.contexttagsregex = '^@'
     options.timetagsregex = '^(\d+)(min|sec|hr)$'
     options.timetags = false
@@ -765,3 +849,13 @@ module Things2THL
     Converter.new(opt_struct, things_db, thl_location)
   end
 end
+
+######################################################################
+# For debugging and testing
+
+if $0 == __FILE__
+  c=Things2THL.new
+  th=c.things
+  thl=c.thl
+  true
+end

data/things2thl.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{things2thl}
-  s.version = "0.5.0"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Diego Zamboni"]
-  s.date = %q{2009-05-19}
+  s.date = %q{2009-05-21}
   s.default_executable = %q{things2thl}
   s.description = %q{Library and command-line tool for migrating Things data to The Hit List}
   s.email = %q{diego@zzamboni.org}
@@ -38,10 +38,13 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rb-appscript>, [">= 0.5.1"])
+      s.add_runtime_dependency(%q<hpricot>, [">= 0.6"])
     else
       s.add_dependency(%q<rb-appscript>, [">= 0.5.1"])
+      s.add_dependency(%q<hpricot>, [">= 0.6"])
     end
   else
     s.add_dependency(%q<rb-appscript>, [">= 0.5.1"])
+    s.add_dependency(%q<hpricot>, [">= 0.6"])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: zzamboni-things2thl
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Diego Zamboni
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-19 00:00:00 -07:00
+date: 2009-05-21 00:00:00 -07:00
 default_executable: things2thl
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.5.1
     version: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+    version: 
 description: Library and command-line tool for migrating Things data to The Hit List
 email: diego@zzamboni.org
 executables: