zzamboni-things2thl 0.7.0 → 0.8.0

data/ChangeLog

@@ -1,6 +1,43 @@
+2009-05-25  Diego Zamboni <diego@zzamboni.org>
+
+	* VERSION: Version bump to 0.8.0
+
+2009-05-25  Diego Zamboni <diego@zzamboni.org>
+
+	* bin/things2thl, lib/Things2THL.rb: Added new mode of operation
+	--inbox (-I) to transfer only tasks from the Inbox.
+
+2009-05-25  Diego Zamboni <diego@zzamboni.org>
+
+	* bin/things2thl, lib/Things2THL.rb: Added printing of some
+	statistics at the end - number of items created, total time elapsed.
+	Can be disabled by specifying -q twice (-qq).
+
+2009-05-25  Diego Zamboni <diego@zzamboni.org>
+
+	* bin/things2thl, lib/Things2THL.rb: Added option --sync, which
+	causes items (areas, projects and tasks) not to be created if they
+	already exist. This is useful if you add more items to Things after
+	you have transferred to THL, and want to re-transfer just the new
+	ones.  This option is disabled by default because the duplicate checking is
+	done using only the item's name, so if you have multiple entries
+	with the same name in Things, they will only be transferred once
+	with --sync enabled.
+
+2009-05-24  Diego Zamboni <diego@zzamboni.org>
+
+	* bin/things2thl, lib/Things2THL.rb: Added options --areas-as-tags
+	and --areas-as-contexts, which specify that areas in Things should
+	be transferred to THL as tags/contexts respectively, instead of
+	created as separate entities.  Thanks to @biomac101 for the suggestion.
+
+2009-05-21  Diego Zamboni <diego@zzamboni.org>
+
+	* things2thl.gemspec: Regenerated gemspec for version 0.7.0
+
 2009-05-21  Diego Zamboni <diego@zzamboni.org>
 
-	* VERSION, lib/Things2THL.rb: Version bump to 0.7.0
+	* ChangeLog, VERSION, lib/Things2THL.rb: Version bump to 0.7.0
 
 2009-05-21  Diego Zamboni <diego@zzamboni.org>
 

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.8.0

data/bin/things2thl

@@ -4,6 +4,7 @@
 require File.join(File.dirname(__FILE__), *%w".. lib Things2THL")
 require "optparse"
 require "ostruct"
+require "time"
 
 options=Things2THL.default_options
 opts = OptionParser.new do |opts|
@@ -14,6 +15,10 @@ opts = OptionParser.new do |opts|
     puts self
     exit  
   end
+
+  def yesno(v)
+    "(default: #{v ? 'yes' : 'no'})"
+  end
   
   opts.separator ''
   opts.separator("Modes of operation (required):")
@@ -25,14 +30,20 @@ opts = OptionParser.new do |opts|
           "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.on("-I", "--inbox", "Transfer only Inbox tasks." ) do
+    options.inboxonly = true
+    options.structure = :projects_as_lists
+  end
 
   opts.separator ''
   opts.separator("Options:")
-  opts.on("--[no-]areas", "Transfer areas from Things (default: #{options.areas ? 'yes' : 'no'})") { |v| options.areas = v }
+  opts.on("--[no-]areas", "Transfer areas from Things #{yesno(options.areas)}") { |v| options.areas = v }
+  opts.on("--areas-as-tags", "Transfer areas as tags in THL.") { options.areas_as=:tags }
+  opts.on("--areas-as-contexts", "Transfer areas as contexts in THL.") { options.areas_as=:contexts }
   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|
+          "  accordingly #{yesno(options.timetags)}.") do |value|
     options.timetags = value
   end
   opts.on('--[no-]context-tags [REGEX]',
@@ -42,6 +53,7 @@ opts = OptionParser.new do |opts|
           "  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("--sync", "Only transfer new items #{yesno(options.sync)}") { options.sync = true }
   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
@@ -65,11 +77,13 @@ opts = OptionParser.new do |opts|
 
   opts.on("-c", "--completed",
           "Transfer also completed/canceled tasks",
-          "  and projects (default: #{options.completed ? 'yes' : 'no'})") { options.completed = true }
+          "  and projects #{yesno(options.completed)}") { options.completed = true }
   opts.on("--[no-]archive-completed",
           "If transferring completed/canceled tasks,",
-          "  also mark them as archived (default: #{options.archivecompleted ? 'yes' : 'no'})") {|v| options.archivecompleted = v }
-  opts.on("-q", "--quiet", "Do not print items as they are processed") { options.quiet = true }
+          "  also mark them as archived #{yesno(options.archivecompleted)}") {|v| options.archivecompleted = v }
+  opts.on("-q", "--quiet",
+          "Do not print items as they are processed.",
+          "Twice: do not print stats at the end.") { options.quiet+=1 }
 #  opts.on("-n", "--dry-run", "Do not create anything in THL, just print the items that would be created") { options.dryrun = true }
 #  opts.on("-n", "--notes", "Shows only tasks with notes") { options[:tasks] = { :onlynotes => true } }
 #  opts.on("-a", "--all", 'Shows all tasks in the focus') { |f| options[:tasks] = { :children => false } }
@@ -100,7 +114,7 @@ end
 ######################################################################
 
 opts.parse!
-unless options.structure
+unless options.structure || options.inboxonly
   puts "Error: you didn't specify the mode of operation to use."
   puts ''
   opts.show_usage 
@@ -110,27 +124,30 @@ converter = Things2THL.new(options, options.thingsapp, options.thlapp)
 things = converter.things
 thl = converter.thl
 
-# Create top-level containers if needed
+# Start timing
+start=Time.new
 
-# First, traverse all areas
-if options.areas
-  puts "Processing Areas of Responsibility" unless options.quiet
-  things.areas.get.each do |area|
-    converter.process(Things2THL::ThingsNode.new(area))
+unless options.inboxonly
+  # First, traverse all areas
+  if options.areas && !options.areas_as
+    puts "Processing Areas of Responsibility" unless options.quiet.nonzero?
+    things.areas.get.each do |area|
+      converter.process(Things2THL::ThingsNode.new(area))
+    end
   end
-end
 
-# Next, traverse all projects, putting each one inside its corresponding area
-puts "Processing Projects" unless options.quiet
-if options.completed
-  puts "   (fetching all projects - this may take a while)" unless options.quiet
-  projlist=things.projects.get
-else
-  puts "   (fetching only open projects - this may take a while)" unless options.quiet
-  projlist=things.projects[its.status.eq(:open)].get
-end
-projlist.each do |project|
-  converter.process(Things2THL::ThingsNode.new(project))
+  # Next, traverse all projects, putting each one inside its corresponding area
+  puts "Processing Projects" unless options.quiet.nonzero?
+  if options.completed
+    puts "   (fetching all projects - this may take a while)" unless options.quiet.nonzero?
+    projlist=things.projects.get
+  else
+    puts "   (fetching only open projects - this may take a while)" unless options.quiet.nonzero?
+    projlist=things.projects[its.status.eq(:open)].get
+  end
+  projlist.each do |project|
+    converter.process(Things2THL::ThingsNode.new(project))
+  end
 end
 
 # Now do the tasks
@@ -138,13 +155,18 @@ end
 # - to_dos returns not only tasks, also projects (not areas)
 # - to-dos returns tasks from all the views: Inbox, Today, Scheduled, Someday, and Next, so we have
 #   to separate them and create the appropriate containers as needed
-puts "Processing tasks" unless options.quiet
+puts "Processing tasks" unless options.quiet.nonzero?
+if options.inboxonly
+  queryobj=things.lists['Inbox']
+else
+  queryobj=things
+end
 if options.completed
-  puts "   (fetching all tasks - this may take a while)" unless options.quiet
-  tasklist=things.to_dos.get
+  puts "   (fetching all tasks - this may take a while)" unless options.quiet.nonzero?
+  tasklist=queryobj.to_dos.get
 else
-  puts "   (fetching only open tasks - this may take a while)" unless options.quiet
-  tasklist=things.to_dos[its.status.eq(:open)].get
+  puts "   (fetching only open tasks - this may take a while)" unless options.quiet.nonzero?
+  tasklist=queryobj.to_dos[its.status.eq(:open)].get
 end
 tasklist.each do |t|
   task=Things2THL::ThingsNode.new(t)
@@ -152,3 +174,11 @@ tasklist.each do |t|
   converter.process(task)
 end
 
+# End timing
+diff=Time.new-start
+
+# Print stats at the end
+unless options.quiet >= 2
+  puts "Conversion done in #{diff} seconds."
+  converter.created.each_pair { |key,val| puts "  #{val} #{key}#{val!=1 ? 's' : ''} created" }
+end

data/lib/Things2THL.rb

@@ -263,7 +263,7 @@ module Things2THL
   ####################################################################
 
   class Converter
-    attr_accessor :options, :things, :thl
+    attr_accessor :options, :things, :thl, :created
 
     def initialize(opt_struct = nil, things_location = nil, thl_location = nil)
       @options=opt_struct || Things2THL.default_options
@@ -295,6 +295,14 @@ module Things2THL
       # id_ of each node that belongs to that focus. Existence of the key
       # indicates existence in the focus.
       @cache_focus = {}
+
+      # Statistics
+      @created = {
+        :task      => 0,
+        :list      => 0,
+        :folder    => 0
+      }
+
     end
 
     # Get the type of the THL node that corresponds to the given Things node,
@@ -360,24 +368,48 @@ module Things2THL
       end
     end
 
+    # Simplified version of find_or_create which simply takes :new and :name
+    def simple_find_or_create(what, name, parent = @thl.folders_group.get)
+      find_or_create({:new => what, :with_properties => { :name => name } }, parent)
+    end
+
     # Find or create a list or a folder inside the given parent (or the top-level folders group if not given)
-    def find_or_create(what, name, parent = @thl.folders_group.get)
-      unless what == :list || what == :folder
-        raise "find_or_create: 'what' parameter has to be :list or :folder"
+    def find_or_create(props, parent = @thl.folders_group.get)
+      puts "find_or_create: props = #{props.inspect}" if $DEBUG
+      what=props[:new]
+      name=(what==:task) ? props[:with_properties][:title] : props[:with_properties][:name]
+      parentclass=parent.class_.get
+      unless what == :list || what == :folder || what == :task
+        raise "find_or_create: 'props[:new]' parameter has to be :list, :folder or :task"
       end
       puts "parent of #{name} = #{parent}" if $DEBUG
-      if parent.class_.get != :folder
-        raise "find_or_create: parent is not a folder, it's a #{parent.class_.get}"
+      if (what == :folder || what == :list) && parentclass != :folder
+        raise "find_or_create: parent is not a folder, it's a #{parentclass}"
+      elsif what == :task && parentclass != :list && parentclass != :task
+        raise "find_or_create: parent is not a list, it's a #{parentclass}"
       else
-        if parent.groups[name].exists
-          parent.groups[name].get
+        if what == :task
+          query = parent.tasks[its.title.eq(name)]
+          if ! query.get.empty?
+            query.get[0]
+          else
+            @created[what]+=1
+            parent.end.make(props)
+          end
         else
-          parent.end.make(:new => what, :with_properties => {:name => name})
+          query = parent.groups[name]
+          if query.exists
+            query.get
+          else
+            @created[what]+=1
+            parent.end.make(props)
+          end
         end
       end
     end
 
     def new_folder(name, parent = @thl.folders_group.get)
+      @created[:folder]+=1
       parent.end.make(:new => :folder,
                       :with_properties => { :name => name })
     end
@@ -388,7 +420,11 @@ module Things2THL
 
       unless @top_level_node
         # Create the top-level node if we don't have it cached yet
-        @top_level_node=new_folder(options.toplevel)
+        if options.sync
+          @top_level_node=simple_find_or_create(:folder, options.toplevel)
+        else
+          @top_level_node=new_folder(options.toplevel)
+        end
       end
       @top_level_node
     end
@@ -416,17 +452,17 @@ module Things2THL
                    when 'Trash', 'Today'
                      nil
                    when 'Inbox', 'Next'
-                     find_or_create(:list, focusname, top_level_node)
+                     simple_find_or_create(:list, focusname, top_level_node)
                    when 'Scheduled', 'Logbook'
-                     find_or_create((thl_node_type(:project) == :task) ? :list : :folder, focusname, top_level_node)
+                     simple_find_or_create((thl_node_type(:project) == :task) ? :list : :folder, focusname, top_level_node)
                    when 'Someday'
-                     find_or_create(:folder, focusname, top_level_node)
+                     simple_find_or_create(:folder, focusname, top_level_node)
                    when 'Projects'
                      if thl_node_type(:project) == :task
-                       find_or_create(:list, options.projectsfolder || 'Projects', top_level_node)
+                       simple_find_or_create(:list, options.projectsfolder || 'Projects', top_level_node)
                      else
                        if options.projectsfolder
-                         find_or_create(:folder, options.projectsfolder, top_level_node)
+                         simple_find_or_create(:folder, options.projectsfolder, top_level_node)
                        else
                          top_level_node
                        end
@@ -443,15 +479,15 @@ module Things2THL
                    when 'Next'
                      top_level_node
                    when 'Scheduled', 'Logbook'
-                     find_or_create((thl_node_type(:project) == :task) ? :list : :folder, focusname, top_level_node)
+                     simple_find_or_create((thl_node_type(:project) == :task) ? :list : :folder, focusname, top_level_node)
                    when 'Someday'
-                     find_or_create(:folder, focusname, top_level_node)
+                     simple_find_or_create(:folder, focusname, top_level_node)
                    when 'Projects'
                      if thl_node_type(:project) == :task
-                       find_or_create(:list, options.projectsfolder || 'Projects', top_level_node)
+                       simple_find_or_create(:list, options.projectsfolder || 'Projects', top_level_node)
                      else
                        if options.projectsfolder
-                         find_or_create(:folder, options.projectsfolder, top_level_node)
+                         simple_find_or_create(:folder, options.projectsfolder, top_level_node)
                        else
                          top_level_node
                        end
@@ -478,7 +514,7 @@ module Things2THL
           return top_level_for_focus('Someday')
         else
           if options.areasfolder
-            return find_or_create(:folder, options.areasfolder || 'Areas', top_level_node)
+            return simple_find_or_create(:folder, options.areasfolder || 'Areas', top_level_node)
           else
             return top_level_node
           end
@@ -491,10 +527,10 @@ module Things2THL
       if foci.empty?
         if node.project?
           tl=top_level_for_node(node.project)
-          if !tl && node.area?
+          if !tl && node.area? && !options.areas_as
             tl=top_level_for_node(node.area)
           end
-        elsif node.area?
+        elsif node.area? && !options.areas_as
           tl=top_level_for_node(node.area)
         end
         return tl
@@ -530,7 +566,7 @@ module Things2THL
                   when :area
                     tlcontainer
                   when :project
-                    if options.areas && (options.structure != :projects_areas_as_lists)  && node.area?
+                    if options.areas && !options.areas_as && (options.structure != :projects_areas_as_lists)  && node.area?
                       get_cached_or_process(node.area)
                     else
                       tlcontainer
@@ -538,7 +574,7 @@ module Things2THL
                   when :selected_to_do
                     if node.project?
                       get_cached_or_process(node.project)
-                    elsif node.area? && options.areas
+                    elsif node.area? && options.areas && !options.areas_as
                       get_cached_or_process(node.area)
                     else
                       # It's a loose task
@@ -552,9 +588,9 @@ module Things2THL
       # so if the container is a folder, we have to create a list to hold the task
       if container && (container.class_.get == :folder) && (thl_node_type(node) == :task)
         if node.type == :project
-          find_or_create(:list, options.projectsfolder || 'Projects', container)
+          simple_find_or_create(:list, options.projectsfolder || 'Projects', container)
         else
-          find_or_create(:list, loose_tasks_name(container), container)
+          simple_find_or_create(:list, loose_tasks_name(container), container)
         end
       else
         container
@@ -566,8 +602,15 @@ module Things2THL
         new_node_type = thl_node_type(node)
         new_node_props = props_from_node(node)
         additional_nodes = new_node_props.delete(:__newnodes__)
-        result=parent.end.make(:new => new_node_type,
-                               :with_properties => new_node_props )
+        new_node_spec = {
+          :new => new_node_type,
+          :with_properties => new_node_props }
+        if options.sync
+          result=find_or_create(new_node_spec, parent)
+        else
+          @created[new_node_type]+=1
+          result=parent.end.make(new_node_spec)
+        end
         if node.type == :area || node.type == :project
           @cache_nodes[node.id_]={}
           @cache_nodes[node.id_][:things_node] = node
@@ -576,7 +619,12 @@ module Things2THL
         # Add new nodes
         if additional_nodes
           additional_nodes.each do |n|
-            result.end.make(n)
+            if options.sync
+              find_or_create(n, result)
+            else
+              @created[n[:new]]+=1
+              result.end.make(n)
+            end
           end
         end
         return result
@@ -598,11 +646,11 @@ module Things2THL
       container=container_for(node)
       puts "Container for #{node.name}: #{container}" if $DEBUG
       unless container
-        puts "Skipping trashed task '#{node.name}'" unless options.quiet
+        puts "Skipping trashed task '#{node.name}'" unless options.quiet.nonzero?
         return
       end
       
-      unless (options.quiet) 
+      unless (options.quiet.nonzero?) 
         bullet  = (node.type == :area) ? "*" : ((node.status == :completed) ? "✓" : (node.status == :canceled) ? "×" : "-")
         puts bullet + " " + node.name
       end
@@ -689,17 +737,34 @@ module Things2THL
     # Process tags
     def process_tags(node, prop, inherit_project_tags, inherit_area_tags)
       tasktags = node.tags.map {|t| t.name }
+      taskcontexts = []
       if inherit_project_tags
         # Merge project and area tags
         if node.project?
           tasktags |= node.project.tags.map {|t| t.name }
           if options.areas && node.project.area?
             tasktags |= node.project.area.tags.map {|t| t.name }
+            if options.areas_as
+              case options.areas_as
+              when :tags
+                tasktags.push(node.project.area.name)
+              when :contexts
+                taskcontexts.push(node.project.area.name)
+              end
+            end
           end
         end
       end
       if options.areas && node.area? && inherit_area_tags
         tasktags |= node.area.tags.map {|t| t.name }
+        if options.areas_as
+          case options.areas_as
+          when :tags
+            tasktags.push(node.area.name)
+          when :contexts
+            taskcontexts.push(node.area.name)
+          end
+        end
       end
       unless tasktags.empty?
         # First process time-estimate tags if needed
@@ -742,6 +807,12 @@ module Things2THL
                           end
                         end].join(' ')
       end
+      unless taskcontexts.empty?
+        prop[:title] = [prop[:title], taskcontexts.map do |c|
+                          # Contexts cannot have spaces, we also remove any initial @'s before adding our own.
+                          "@" + c.gsub(/^@+/, "").gsub(/ /, '_')
+                        end].join(' ')
+      end
     end
 
     # Check if node is in the Today list
@@ -835,13 +906,16 @@ module Things2THL
     options.database = nil
     options.structure = nil
     options.areas = true
-    options.quiet = false
+    options.quiet = 0
     options.archivecompleted = true
     options.projectsfolder = nil
     options.areasfolder = nil
     options.contexttagsregex = '^@'
     options.timetagsregex = '^(\d+)(min|sec|hr)$'
     options.timetags = false
+    options.areas_as = nil
+    options.sync = false
+    options.inboxonly = false
     return options
   end
 

data/things2thl.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{things2thl}
-  s.version = "0.7.0"
+  s.version = "0.8.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-21}
+  s.date = %q{2009-05-25}
   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}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: zzamboni-things2thl
 version: !ruby/object:Gem::Version 
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Diego Zamboni
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-21 00:00:00 -07:00
+date: 2009-05-25 00:00:00 -07:00
 default_executable: things2thl
 dependencies: 
 - !ruby/object:Gem::Dependency