zzamboni-things2thl 0.4.4 → 0.5.0

data/ChangeLog

@@ -1,3 +1,36 @@
+2009-05-19  Diego Zamboni <diego@zzamboni.org>
+
+	* lib/Things2THL.rb: Version bump to 0.5.0
+
+2009-05-19  Diego Zamboni <diego@zzamboni.org>
+
+	* bin/things2thl, lib/Things2THL.rb: Made it mandatory to specify
+	the mode of operation (--projects-as-lists or --projects-as-tasks).
+
+2009-05-19  Diego Zamboni <diego@zzamboni.org>
+
+	* bin/things2thl, lib/Things2THL.rb: Added --[no-]time-tags option,
+	which allows time-estimate tags in Things for the form Xsec/Xmin/Xhr
+	(e.g. I use "10min", "30min", "60min") to be converted to the
+	appropriate time estimate attribute of the tasks in THL. For now the
+	format of the time-estimate tags is fixed, but I might add
+	customization if I someone asks for it. This option is disabled by
+	default.  Also changed the --context-tags-regex option to be
+	--[no-]context-tags, which allows both specifying the regex and
+	(with --no-) disabling the feature in a single option.
+
+2009-05-19  Diego Zamboni <diego@zzamboni.org>
+
+	* things2thl.gemspec: Regenerated gemspec for version 0.4.4
+
+2009-05-19  Diego Zamboni <diego@zzamboni.org>
+
+	* VERSION: Version bump to 0.4.4
+
+2009-05-19  Diego Zamboni <diego@zzamboni.org>
+
+	* ChangeLog, lib/Things2THL.rb: Updated ChangeLog
+
 2009-05-19  Diego Zamboni <diego@zzamboni.org>
 
 	* things2thl.gemspec: Regenerated gemspec for version 0.4.3

data/README

@@ -7,8 +7,9 @@ Conversion program to transfer data from Things
 
 Written by Diego Zamboni <diego@zzamboni.org>
 
-INSTALL:
---------
+
+INSTALLATION:
+------------
 
 You need Things 1.1.1 or later, since things2thl requires Applescript
 support.
@@ -25,21 +26,26 @@ don't have it already, it will be automatically installed by gem.
 USAGE:
 -----
 
-Usage: things2thl [options]
+Usage: things2thl <mode of operation> [options]
 
-Options:
+Modes of operation (required):
     -L, --projects-as-lists          Convert projects in Things to lists in THL
-                                      (default)
     -T, --projects-as-tasks          Convert projects in Things to tasks in THL
+
+Options:
         --[no-]areas                 Transfer areas from Things (default: yes)
-    -C, --context-tags-regex REGEX   Regular expression to identify tags that
+        --[no-]time-tags             Consider tags of the form Xmin/Xsec/Xhr as
+                                       time estimates, set them in THL
+                                       accordingly (default: no).
+        --[no-]context-tags [REGEX]  Regular expression to identify tags that
                                        should be interpreted as contexts.
-                                       (default: ^@)
+                                       (default: ^@).
+                                       Use with no- to disable this feature.
         --top-level-folder FOLDER    Do the import inside the named folders,
                                        instead of the top level
                                        (Inbox, etc. will also be created there
                                        instead of their corresponding places)
-        --projects-folder FOLDER     The named folder will be created to
+        --projects-top-level FOLDER  The named folder will be created to
                                        contain all projects when
                                        --projects-as-lists is used (otherwise
                                        they will be in the top folders group).
@@ -74,11 +80,6 @@ Functionality still missing:
 
   Not sure how to transfer this to THL. Ideas are welcome.
 
-- Handle "time estimate" tags.
-
-  Plan: Allow specifying certain Things tags (e.g. I use "10min",
-  "30min", "60min") that should be used to set the time estimate for
-  the task in THL.
 
 Known issues:
 -------------
@@ -92,3 +93,5 @@ Known issues:
   scheduling itself is not transferred, because this information is
   not accessible through AS from either Things not THL.
 
+- The format of time estimate tags is fixed for the moment. May add
+  customization if I get any requests for it.

data/VERSION

@@ -1 +1 @@
-0.4.4
+0.5.0

data/bin/things2thl

@@ -7,29 +7,42 @@ require "ostruct"
 
 options=Things2THL.default_options
 opts = OptionParser.new do |opts|
-  opts.separator ''
-  opts.separator 'Options:'
-  
-  opts.banner = "Usage: things2thl [options]"
+
+  opts.banner = "Usage: things2thl <mode of operation> [options]"
   
   def opts.show_usage
     puts self
     exit  
   end
   
-  opts.on("-L", "--projects-as-lists", "Convert projects in Things to lists in THL", ((options.structure == :projects_as_lists) ? " (default)" : "") ) { options.structure = :projects_as_lists }
-  opts.on("-T", "--projects-as-tasks", "Convert projects in Things to tasks in THL" + ((options.structure == :projects_as_tasks) ? " (default)" : "") ) { options.structure = :projects_as_tasks }
+  opts.separator ''
+  opts.separator("Modes of operation (required):")
+  opts.on("-L", "--projects-as-lists",
+          "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.separator ''
+  opts.separator("Options:")
   opts.on("--[no-]areas", "Transfer areas from Things (default: #{options.areas ? 'yes' : 'no'})") { |v| options.areas = v }
-  opts.on('-C REGEX', '--context-tags-regex REGEX', 'Regular expression to identify tags that','  should be interpreted as contexts.',
-          "  (default: #{options.contexttagsregex})") do |regex|
-    options.contexttagsregex = regex
+  opts.on('--[no-]time-tags',
+          'Consider tags of the form Xmin/Xsec/Xhr as',
+          '  time estimates, set them in THL',
+          "  accordingly (default: #{options.timetags ? 'yes' : 'no'}).") do |value|
+    options.timetags = value
+  end
+  opts.on('--[no-]context-tags [REGEX]',
+          'Regular expression to identify tags that',
+          '  should be interpreted as contexts.',
+          "  (default: #{options.contexttagsregex}).",
+          "  Use with no- to disable this feature.") do |regex|
+    options.contexttagsregex = case regex; when false:nil; when "":options.contexttagsregex; else regex; end
   end
-
   opts.on("--top-level-folder FOLDER", "Do the import inside the named folders,","  instead of the top level",
           "  (Inbox, etc. will also be created there","  instead of their corresponding places)") do |toplevel|
     options.toplevel = toplevel
   end
-  opts.on("--projects-folder FOLDER",
+  opts.on("--projects-top-level FOLDER",
           "The named folder will be created to",
           "  contain all projects when",
           "  --projects-as-lists is used (otherwise",
@@ -78,7 +91,11 @@ end
 ######################################################################
 
 opts.parse!
-#opts.show_usage unless options.key?(:focus)
+unless options.structure
+  puts "Error: you didn't specify the mode of operation to use."
+  puts ''
+  opts.show_usage 
+end
 
 converter = Things2THL.new(options, options.thingsapp, options.thlapp)
 things = converter.things

data/lib/Things2THL.rb

@@ -11,8 +11,8 @@ require 'appscript'; include Appscript
 module Things2THL
   module Version
     MAJOR  = 0
-    MINOR  = 4
-    PATCH  = 4
+    MINOR  = 5
+    PATCH  = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end
@@ -73,7 +73,7 @@ module Things2THL
                             Proc.new {|node,prop,obj|
                               obj.fix_completed_canceled(node, prop)
                               obj.archive_completed(prop)
-                              obj.add_tags(node, prop, true, true)
+                              obj.process_tags(node, prop, true, true)
                               obj.check_today(node, prop)
                             }
                            ]
@@ -99,7 +99,7 @@ module Things2THL
                      Proc.new {|node,prop,obj|
                        obj.fix_completed_canceled(node, prop)
                        obj.archive_completed(prop)
-                       obj.add_tags(node, prop, false, true)
+                       obj.process_tags(node, prop, false, true)
                      }
                     ],
         :selected_to_do => [:task,
@@ -118,7 +118,7 @@ module Things2THL
                             Proc.new {|node,prop,obj|
                               obj.fix_completed_canceled(node, prop)
                               obj.archive_completed(prop)
-                              obj.add_tags(node, prop, false, true)
+                              obj.process_tags(node, prop, false, true)
                               obj.check_today(node, prop)
                             }
                            ]
@@ -132,6 +132,14 @@ module Things2THL
       :task => :title
     }
 
+    # Time units for time-estimate tags
+    TIMEUNITS = {
+      "sec" => 1,
+      "min" => 60,
+      "hr"  => 60*60,
+      "hour" => 60*60,
+    }
+
   end ### module Constants
 
   ####################################################################
@@ -230,7 +238,10 @@ module Things2THL
 
       # Regular expression to match context tags. Compile it here to avoid
       # repetition later on.
-      options.contexttagsregex_compiled = Regexp.compile(options.contexttagsregex)
+      options.contexttagsregex_compiled = Regexp.compile(options.contexttagsregex) if options.contexttagsregex
+      # Regular expression to match time-estimate tags. Compile it here to avoid
+      # repetition later on.
+      options.timetagsregex_compiled = Regexp.compile(options.timetagsregex) if options.timetagsregex
       # Structure to keep track of already create items
       # These hashes are indexed by Things node ID (node.id_). Each element
       # contains a hash with two elements:
@@ -621,8 +632,8 @@ module Things2THL
       prop[:archived] = true if options.archivecompleted && (prop[:completed] || prop[:canceled])
     end
 
-    # Add tags to title
-    def add_tags(node, prop, inherit_project_tags, inherit_area_tags)
+    # Process tags
+    def process_tags(node, prop, inherit_project_tags, inherit_area_tags)
       tasktags = node.tags.map {|t| t.name }
       if inherit_project_tags
         # Merge project and area tags
@@ -637,6 +648,36 @@ module Things2THL
         tasktags |= node.area.tags.map {|t| t.name }
       end
       unless tasktags.empty?
+        # First process time-estimate tags if needed
+        if options.timetags
+          # Valid time tags will be deleted from the tags list
+          tasktags=tasktags.delete_if do |t|
+            if data=options.timetagsregex_compiled.match(t)
+              timeestimate = nil
+              # If the regex includes only one group, it is assumed to be
+              # the time in minutes. If it includes two groups, the second
+              # group specifies the time unit, as defined in Constants::TIMEUNITS
+              case data.size
+              when 0
+                puts "Invalid time tags regex, does not return any groups: #{options.timetagsregex_compiled.to_s}"
+              when 1
+                # Assumed to be in minutes, timeestimate is in seconds
+                timeestimate = data[1].to_i * 60
+              else
+                # Second one is the units - the rest are ignored
+                timeunit=Constants::TIMEUNITS[data[2]]
+                if !timeunit
+                  puts "Invalid time estimate tag, I could not match the time unit: '#{t}'"
+                else 
+                  timeestimate = data[1].to_i * timeunit
+                end
+              end
+              if timeestimate
+                prop[:estimated_time] = timeestimate
+              end
+            end
+          end
+        end
         prop[:title] = [prop[:title], tasktags.map do |t|
                           if options.contexttagsregex_compiled &&
                               options.contexttagsregex_compiled.match(t)
@@ -709,12 +750,14 @@ module Things2THL
     options=OpenStruct.new
     options.completed = false
     options.database = nil
-    options.structure = :projects_as_lists
+    options.structure = nil
     options.areas = true
     options.quiet = false
     options.archivecompleted = true
     options.projectsfolder = nil
     options.contexttagsregex = '^@'
+    options.timetagsregex = '^(\d+)(min|sec|hr)$'
+    options.timetags = false
     return options
   end
 

data/things2thl.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{things2thl}
-  s.version = "0.4.4"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Diego Zamboni"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: zzamboni-things2thl
 version: !ruby/object:Gem::Version 
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors: 
 - Diego Zamboni