otask 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72e2f8c4d11c95a93aa27235eb107d48f8311238
-  data.tar.gz: 3b98b4d521835a01861347136ffc6d4f74ae82b7
+  metadata.gz: fcddd03631acb9fa09856952c64f9f21551967fb
+  data.tar.gz: 5160e3408d228bbd720077989047235f43adba1c
 SHA512:
-  metadata.gz: 6077b721ef8255456a790852a3f1392bc73f53958f17fc7c58ad00a53aa41ae561917aa3e5216f6f37c83a8b21faaf0950e49de53ed577b526cbd2b207fc9b8c
-  data.tar.gz: 71889ff718473bec68d0b8e8d57e6bf59d50f5d78e233402527fdcf63bb14f76c8f3ea72bfce325e544ffb59d179fb11cce6e219b543eee5ea2690b3ff0e8bbc
+  metadata.gz: 82f6959605968cbe7bc2751184b7f598cde23f31b5701dcb70facc82eccd7a9f80b3b024b6d182d8c46017a3e2823f5c61723ccbd9f746e1389eacdec81cc754
+  data.tar.gz: fcd38123ced5d14de8a2e060b8552f2633745074368109e3e1bcf1a81278111bbb54e0c44396e91ee38671549185137419f953bce8fa1771a675c010849c52c3

data/README.md

@@ -8,6 +8,8 @@ I don't know how long appscript is going to work for us, and it's now a dead pro
 
 	$ [sudo] gem install otask
 
+**Note:** If you use Xcode 5.1 and have trouble installing the gem, see [this post for a fix.](http://kaspermunck.github.io/2014/03/fixing-clang-error/)
+
 ### Documentation
 
 OTask uses a custom syntax to allow entry of the various elements of an action in one line of text. The following formats can be used anywhere in the line, with the exception of the flag (!) which must be the last character on the line, preceded by a space.

data/bin/otask

@@ -13,6 +13,7 @@
 #   -q, --quiet         Output as little as possible, overrides verbose
 #   -V, --verbose       Verbose output
 #   -g, --growl         Use Growl for feedback
+#   -l, --list [TYPE]   List all projects or contexts
 #
 # == Author
 #   Brett Terpstra
@@ -21,247 +22,7 @@
 #   Copyright (c) 2014 Brett Terpstra. Licensed under the MIT License:
 #   http://www.opensource.org/licenses/mit-license.php
 
-
-require 'optparse'
-require 'ostruct'
-require 'date'
-require 'appscript';include Appscript
-require 'amatch';include Amatch
-require 'chronic'
-require 'rdoc'
-
-class OTask
-  attr_reader :options
-
-  def initialize(arguments, stdin)
-    @arguments = arguments
-    @stdin = stdin
-
-    # Set defaults
-    @options = OpenStruct.new
-    @options.verbose = false
-    @options.quiet = false
-
-    # TO DO - add additional defaults
-  end
-
-  # Parse options, check arguments, then process the command
-  def run
-    if parsed_options? && !arguments_valid?
-      usage_and_exit
-    end
-
-    if parsed_options? && arguments_valid?
-      if @options.verbose
-        puts "Start at #{DateTime.now}\n\n"
-        puts "--Options--------------------"
-        output_options if @options.verbose # [Optional]
-        puts "--Task-Properties------------"
-      end
-      process_arguments
-      process_command
-
-      puts "\nFinished at #{DateTime.now}" if @options.verbose
-    end
-  end
-
-  protected
-
-    def parsed_options?
-
-      # Specify options
-      opts = OptionParser.new
-      opts.on( '-h', '--help', 'Display this screen' ) do
-        puts opts
-        puts "\nNotes are entered in parenthesis: This is my title (This is the note)"
-        exit(0)
-      end
-      opts.on('-V', '--verbose', 'Verbose logging')    { @options.verbose = true }
-      opts.on('-q', '--quiet', 'Run silently')      { @options.quiet = true }
-      opts.on('-g', '--growl', 'Use Growl notifications')  { @options.growl = true }
-      # TO DO - add additional options
-
-      opts.parse!(@arguments) rescue return false
-
-      process_options
-      true
-    end
-
-    # Performs post-parse processing on options
-    def process_options
-      @options.verbose = false if @options.quiet
-      if @options.growl
-        procs = app("System Events").processes.bundle_identifier.get(:result_type => :list)
-
-        if procs.include? "com.Growl.GrowlHelperApp"
-          app("Growl").register(:as_application => "OTask", :all_notifications => ['Alert'], :default_notifications => ['Alert'], :icon_of_application => "OmniFocus")
-        else
-          @options.growl = false
-        end
-      end
-    end
-
-    def output_options
-      @options.marshal_dump.each do |name, val|
-        puts "  #{name}: #{val}"
-      end
-    end
-
-    # True if required arguments were provided
-    def arguments_valid?
-      # TO DO - implement your real logic here
-      @arguments.length == 1 ? true : false
-    end
-
-    # Setup the arguments
-    def process_arguments
-      input = @stdin.stat.size > 0 ? @stdin.read : nil
-      titlestring = @arguments.join(' ')
-
-      # check for trailing ! (flagged task)
-      @options.flagged = titlestring.match(/ !\Z/).nil? ? false : true
-      titlestring.sub!(/ !\Z/,'') if @options.flagged
-
-      # check for #project in the string
-      projmatch = titlestring.match(/ ?#([a-z0-9]+)/i)
-      @options.project = projmatch.nil? ? nil : projmatch[1]
-      titlestring.sub!(/ ?##{projmatch[1]}/,'') unless projmatch.nil?
-
-      # check for @contexts
-      contextmatch = titlestring.match(/ @([^ ]+)/)
-      @options.context = contextmatch.nil? ? false : contextmatch[1]
-      titlestring.sub!(/ @[^ ]+/,'') unless contextmatch.nil?
-
-      # start/due date
-      # startmatch = titlestring.match(/ s(?:tart)?\(([^\)]+)\)/)
-      # @options.start = startmatch.nil? ? false : startmatch[1]
-      # titlestring.sub!(/ s(tart)?\(([^\)]+)\)/,'') unless startmatch.nil?
-      duematch = titlestring.match(/ d(?:ue)?\(([^\)]+)\)/)
-      @options.due = duematch.nil? ? false : duematch[1]
-      titlestring.sub!(/ d(ue)?\(([^\)]+)\)/,'') unless duematch.nil?
-
-      # creation date
-      creationmatch = titlestring.match(/ c(?:reate)?\(([^\)]+)\)/)
-      @options.creation = creationmatch.nil? ? false : creationmatch[1]
-      titlestring.sub!(/ c(reate)?\(([^\)]+)\)/,'') unless creationmatch.nil?
-
-
-
-      @options.notes = ''
-      if titlestring =~ / \(([^\)]+)\)/
-        @options.notes = $1
-        titlestring.sub!(/ \(([^\)]+)\)/,'')
-      end
-      if @options.notes == '' && !input.nil? # check for piped input on STDIN
-        @options.notes = input
-      elsif @options.notes && input
-        @options.notes = @options.notes + "\n\n" + input
-      end
-      @options.name = titlestring
-    end
-
-    def usage_and_exit
-      puts 'Usage: otask [options] "Task string [#proj @context (note) start() due()]"'
-      puts
-      puts "For help use: otask -h"
-
-      exit(0)
-    end
-
-    def output_version
-      puts "#{File.basename(__FILE__)} version #{VERSION}"
-    end
-
-    def add_task(dd, props)
-
-      if props['project']
-        proj_name = props["project"]
-        proj = dd.flattened_tasks[proj_name]
-      end
-      if props['context']
-        ctx_name = props["context"]
-        ctx = dd.flattened_contexts[ctx_name]
-      end
-
-      tprops = props.inject({}) do |h, (k, v)|
-        h[:"#{k}"] = v
-        h
-      end
-
-      tprops.delete(:project)
-      tprops[:context] = ctx if props['context']
-
-      t = dd.make(:new => :inbox_task, :with_properties => tprops)
-      t.assigned_container.set(proj) if props['project']
-
-      return true
-    end
-
-    def best_match(items,fragment)
-
-      highscore = {'score'=>0,'name'=>nil}
-      items.each {|item|
-        if fragment && !item.nil?
-          score = (Jaro.new(item).match(fragment) * 10).to_i
-          highscore = score > highscore['score'] ? {'score'=>score,'name'=>item} : highscore
-        end
-      }
-      return highscore['name']
-
-    end
-
-    def parse_date(datestring)
-      days = 0
-      if datestring =~ /^\+(\d+)$/
-        days = (60 * 60 * 24 * $1.to_i)
-        newdate = Time.now + days
-      else
-        newdate = Chronic.parse(datestring, {:context => :future, :ambiguous_time_range => 8})
-      end
-      # parsed = newdate.strftime('%D %l:%M%p').gsub(/\s+/,' ');
-      # return parsed =~ /1969/ ? false : parsed
-      return newdate
-    end
-
-    def growl(title, message)
-      app("Growl").notify(:title => title, :description => message, :application_name => "OTask", :with_name => "Alert") if @options.growl
-    end
-
-    def process_command
-      of = app('OmniFocus')
-      dd = of.default_document
-
-      @props = {}
-      @props['name'] = @options.name
-      if @options.project
-        projs = dd.flattened_projects.name.get
-        @props['project'] = best_match(projs,@options.project)
-      end
-      if @options.context
-        ctxs = dd.flattened_contexts.name.get
-        @props['context'] = best_match(ctxs,@options.context)
-      end
-      # @props['start_date'] = parse_date(@options.start) if @options.start
-      @props['due_date'] = parse_date(@options.due) if @options.due
-      @props['creation_date'] = parse_date(@options.creation) if @options.creation
-      @props['note'] = @options.notes unless @options.notes == ''
-      @props['flagged'] = @options.flagged
-      add_task(dd, @props)
-      unless @options.quiet
-        o = "Task added to "
-        o += @props['project'].nil? ? "Inbox" : @props['project']
-        o += ", context "+@props['context']+"." unless @props['context'].nil?
-        if @options.growl
-          growl("Task created",o)
-        else
-          puts o
-        end
-      end
-      @props.each do |name, val|
-        puts "  #{name}: #{val}"
-      end if @options.verbose
-    end
-end
+require 'otask'
 
 app = OTask.new(ARGV, STDIN)
 app.run

data/lib/otask.rb

@@ -1,3 +1,360 @@
-class Otask
-  VERSION = '0.2.2'
+require 'optparse'
+require 'ostruct'
+require 'date'
+require 'rubygems'
+require 'appscript';include Appscript
+require 'amatch';include Amatch
+require 'chronic'
+require 'rdoc'
+require 'version.rb'
+
+class OTask
+  attr_reader :options
+
+  def initialize(arguments, stdin)
+    @arguments = arguments
+    @stdin = stdin
+
+    # Set defaults
+    @options = OpenStruct.new
+    @options.verbose = false
+    @options.quiet = false
+    @options.list = false
+    @options.completion = false
+
+    of = app('OmniFocus')
+    @dd = of.default_document
+    # TO DO - add additional defaults
+  end
+
+  # Parse options, check arguments, then process the command
+  def run
+    if parsed_options?
+      usage_and_exit unless arguments_valid?
+    end
+
+    if parsed_options? && arguments_valid?
+      if @options.verbose
+        puts "Start at #{DateTime.now}\n\n"
+        puts "--Options--------------------"
+        output_options if @options.verbose # [Optional]
+        puts "--Task-Properties------------"
+      end
+      process_arguments
+      process_command
+
+      puts "\nFinished at #{DateTime.now}" if @options.verbose
+    else
+      usage_and_exit
+    end
+
+  end
+
+  protected
+
+    def parsed_options?
+
+      # Specify options
+      opts = OptionParser.new
+      opts.on( '-v', '--version', 'Display version number and exit' ) do
+        output_version
+        Process.exit 0
+      end
+      opts.on( '-h', '--help', 'Display this screen' ) do
+        puts opts
+        puts "\nNotes are entered in parenthesis: This is my title (This is the note)"
+        puts "Tags are added with hashmarks #like #this. They can appear anywhere in the title string, but will be removed from the output."
+        puts "Note: natural-language date parsing will work better if you install the Chronic Ruby gem (`sudo gem install chronic`)." unless TodoUtils.new.use_chronic
+        exit(0)
+      end
+      opts.on('-V', '--verbose', 'Verbose logging')    {
+        @options.verbose = true unless @options.completion
+      }
+      opts.on('-q', '--quiet', 'Run silently')      { @options.quiet = true }
+      opts.on('-g', '--growl', 'Use Growl notifications')  { @options.growl = true }
+      opts.on('-l', '--list TYPE[:filter_pattern]', 'List projects or contexts') do |arg|
+        type, filter = arg.split(/:/)
+        filter = false if filter.nil?
+        @options.list = [type, filter]
+      end
+      opts.on('-c', '--completion', 'Output project/contect list space separated') do |arg|
+        @options.verbose = false
+        @options.completion = true
+      end
+      # TO DO - add additional options
+
+      opts.parse!(@arguments) rescue return false
+
+      process_options
+      true
+    end
+
+    # Performs post-parse processing on options
+    def process_options
+      @options.verbose = false if @options.quiet
+      if @options.growl
+        procs = app("System Events").processes.bundle_identifier.get(:result_type => :list)
+
+        if procs.include? "com.Growl.GrowlHelperApp"
+          app("Growl").register(:as_application => "OTask", :all_notifications => ['Alert'], :default_notifications => ['Alert'], :icon_of_application => "OmniFocus")
+        else
+          @options.growl = false
+        end
+      end
+    end
+
+    def output_options
+      @options.marshal_dump.each do |name, val|
+        puts "  #{name}: #{val}"
+      end
+    end
+
+    def get_project_names(opt={})
+      kind = opt[:type] || :project
+
+      els = []
+      objects = opt[:type] == :context ? @dd.flattened_contexts : @dd.flattened_projects
+
+      objects.get.each{|p|
+        begin
+          if opt[:type] == :context || !p.status.respond_to?("get")
+            els.push(p.name.get)
+          else
+            els.push(p.name.get) if p.status.get == :active
+          end
+        rescue => e
+          p e
+        end
+      }
+      els
+    end
+
+    def list_type(type, filter)
+
+
+      output = []
+      filtered = filter ? ", filtered by '#{filter}'" : ""
+      case type.downcase
+      when /^p/i
+        puts "List projects#{filtered}:" if @options.verbose
+        output = get_project_names({:type => :project })
+      when /^c/i
+        puts "List contexts#{filtered}:" if @options.verbose
+        output = get_project_names({:type => :context })
+      else
+        puts "Unrecognized list option: #{type}"
+        return false
+      end
+
+      if filter
+        patt = filter.split("").join('.*?')
+        output.delete_if { |el| el !~ /#{patt}/i }
+      end
+
+      if @options.completion
+        print output.map {|item| item.strip.gsub(/\s+/,'')}.join(' ')
+      else
+        puts output
+      end
+      return true
+    end
+
+    # True if required arguments were provided
+    def arguments_valid?
+      return true if @options.list
+      # TO DO - implement your real logic here
+      @arguments.length > 0 ? true : false
+    end
+
+    # Setup the arguments
+    def process_arguments
+      input = @stdin.stat.size > 0 ? @stdin.read : nil
+      titlestring = @arguments.join(' ')
+
+      # check for trailing ! (flagged task)
+      @options.flagged = titlestring.match(/ !\Z/).nil? ? false : true
+      titlestring.sub!(/ !\Z/,'') if @options.flagged
+
+      # check for #project in the string
+      projmatch = titlestring.match(/ ?#([a-z0-9]+)/i)
+      @options.project = projmatch.nil? ? nil : projmatch[1]
+      titlestring.sub!(/ ?##{projmatch[1]}/,'') unless projmatch.nil?
+
+      # check for @contexts
+      contextmatch = titlestring.match(/ @([^ ]+)/)
+      @options.context = contextmatch.nil? ? false : contextmatch[1]
+      titlestring.sub!(/ @[^ ]+/,'') unless contextmatch.nil?
+
+      # start/due date
+      startmatch = titlestring.match(/ s(?:tart)?\(([^\)]+)\)/)
+      @options.start = startmatch.nil? ? false : startmatch[1]
+      titlestring.sub!(/ s(tart)?\(([^\)]+)\)/,'') unless startmatch.nil?
+      duematch = titlestring.match(/ d(?:ue)?\(([^\)]+)\)/)
+      @options.due = duematch.nil? ? false : duematch[1]
+      titlestring.sub!(/ d(ue)?\(([^\)]+)\)/,'') unless duematch.nil?
+
+      # creation date
+      creationmatch = titlestring.match(/ c(?:reate)?\(([^\)]+)\)/)
+      @options.creation = creationmatch.nil? ? false : creationmatch[1]
+      titlestring.sub!(/ c(reate)?\(([^\)]+)\)/,'') unless creationmatch.nil?
+
+
+
+      @options.notes = ''
+      if titlestring =~ /\(([^\)]+)\)/
+        @options.notes = $1
+        titlestring.gsub!(/\(([^\)]+)\)/,'')
+      end
+      if @options.notes == '' && !input.nil? # check for piped input on STDIN
+        @options.notes = input
+      elsif @options.notes && input
+        @options.notes = @options.notes + "\n\n" + input
+      end
+
+      # See if there's a bang at the end of the task name
+      unless @options.flagged
+        @options.flagged = titlestring.match(/!\Z/).nil? ? false : true
+        titlestring.sub!(/!\Z/,'') if @options.flagged
+      end
+
+      @options.name = titlestring
+    end
+
+    def usage_and_exit
+      puts 'Usage: otask [options] "Task string"'
+      puts
+      puts "For help use: otask -h"
+
+      exit(0)
+    end
+
+    def output_version
+      puts "oTask version #{OTask::VERSION}"
+    end
+
+    def add_task
+
+      if @props['project']
+        proj_name = @props["project"]
+        proj = @dd.flattened_projects[proj_name]
+      end
+      if @props['context']
+        ctx_name = @props["context"]
+        ctx = @dd.flattened_contexts[ctx_name]
+      end
+
+      tprops = @props.inject({}) do |h, (k, v)|
+        h[:"#{k}"] = v
+        h
+      end
+
+      tprops.delete(:project)
+      tprops[:context] = ctx if @props['context']
+      tprops[:flagged] = @props['flagged']
+
+      t = @dd.make(:new => :inbox_task, :with_properties => tprops)
+      t.assigned_container.set(proj) if @props['project']
+
+      return true
+    end
+
+    def best_match(items,fragment)
+      if @options.verbose
+        print "Expanding #{fragment}"
+      end
+
+      good_match = false
+      patt = fragment.split('').join('.*?')
+      # puts "Regex: #{patt}" if @options.verbose
+      items.each {|item|
+        if item =~ /#{patt}/i
+          good_match = item
+          break;
+        end
+      }
+      if good_match
+        puts "=> #{good_match} (regex)" if @options.verbose
+      else
+        highscore = {'score'=>0,'name'=>nil}
+        fragment.downcase!
+
+        items.reverse.each {|item|
+          if fragment && !item.nil?
+            score = (Jaro.new(item.downcase).match(fragment) * 10).to_i
+            # puts "#{item} (#{score})" if @options.verbose
+            if score > highscore['score']
+              highscore = {'score'=>score,'name'=>item}
+            end
+          end
+        }
+        if highscore['name'].nil?
+          good_match = highscore['name']
+          puts "=> #{good_match} (Jaro: #{highscore['score']})" if @options.verbose
+        end
+      end
+
+      puts "=> NO_MATCH" if @options.verbose && !good_match
+      good_match
+    end
+
+    def parse_date(datestring)
+      days = 0
+      if datestring =~ /^\+(\d+)$/
+        days = (60 * 60 * 24 * $1.to_i)
+        newdate = Time.now + days
+      else
+        newdate = Chronic.parse(datestring, {:context => :future, :ambiguous_time_range => 8})
+      end
+      # parsed = newdate.strftime('%D %l:%M%p').gsub(/\s+/,' ');
+      # return parsed =~ /1969/ ? false : parsed
+      return newdate
+    end
+
+    def growl(title, message)
+      app("Growl").notify(:title => title, :description => message, :application_name => "OTask", :with_name => "Alert") if @options.growl
+    end
+
+    def process_command
+      if @options.list
+        list_type(@options.list[0], @options.list[1])
+        Process.exit 0
+      end
+
+      of = app('OmniFocus')
+      dd = of.default_document
+
+      @props = {}
+      @props['name'] = @options.name
+      if @options.project
+        projs = get_project_names({:type => :project})
+        name = best_match(projs,@options.project)
+        @props['project'] = name if name
+      end
+      if @options.context
+        ctxs = get_project_names({:type => :context})
+        name = best_match(ctxs,@options.context)
+        @props['context'] = name if name
+      end
+      @props['start_date'] = parse_date(@options.start) if @options.start
+      @props['due_date'] = parse_date(@options.due) if @options.due
+      @props['creation_date'] = parse_date(@options.creation) if @options.creation
+      @props['note'] = @options.notes unless @options.notes == ''
+      @props['flagged'] = @options.flagged
+      add_task
+      unless @options.quiet
+        o = (@props['flagged'] ? "Flagged task \"" : "Task \"") + @props['name'] + "\" added to "
+        o += @props['project'].nil? ? "Inbox" : @props['project']
+        o += ", context "+@props['context']+"." unless @props['context'].nil?
+
+        if @options.growl
+          growl("Task created",o)
+        else
+          puts o
+        end
+      end
+      @props.each do |name, val|
+        puts "  #{name}: #{val}"
+      end if @options.verbose
+    end
 end
+

data/lib/version.rb

@@ -0,0 +1,3 @@
+class OTask
+  VERSION = '0.2.3'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: otask
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2014-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -130,6 +130,7 @@ files:
 - README.md
 - bin/otask
 - lib/otask.rb
+- lib/version.rb
 homepage: http://brettterpstra.com/
 licenses:
 - MIT