otask 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 72e2f8c4d11c95a93aa27235eb107d48f8311238
+  data.tar.gz: 3b98b4d521835a01861347136ffc6d4f74ae82b7
+SHA512:
+  metadata.gz: 6077b721ef8255456a790852a3f1392bc73f53958f17fc7c58ad00a53aa41ae561917aa3e5216f6f37c83a8b21faaf0950e49de53ed577b526cbd2b207fc9b8c
+  data.tar.gz: 71889ff718473bec68d0b8e8d57e6bf59d50f5d78e233402527fdcf63bb14f76c8f3ea72bfce325e544ffb59d179fb11cce6e219b543eee5ea2690b3ff0e8bbc

data/README.md

@@ -0,0 +1,83 @@
+[appscript]: http://appscript.sourceforge.net/
+
+This is a CLI for OmniFocus. I had an AppleScript/Ruby monstrosity that actually worked with TaskPaper, The Hit List, Things and OmniFocus, but that one got out of hand. I took the good parts of it, concentrated on OmniFocus and converted it to [appscript][]. The result is OTask.
+
+I don't know how long appscript is going to work for us, and it's now a dead project. I make no promises. This version of oTask has been tested on Ruby 2.0 (Mavericks) and with OmniFocus and OmniFocus 2.
+
+### Installation
+
+	$ [sudo] gem install otask
+
+### 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.
+
+ * @context			   (fragment, no spaces)
+ * \#project             (fragment, no spaces)
+ * due(due date)        (can be shortened as d(date))
+ * create(creation date)    (can be shortened as c(date))
+ * (notes)
+ * !						(sets task as flagged)
+ 
+Contexts and project specifiers should not include spaces. The algorithm that is used will find the best match for the string you give it, so you only need to include enough of it to distinguish it from other contexts or projects. For example, if I were going to put an action directly into my Markdown QuickTags folder, I could just use "#mdqt" and it will find it. "@corr" will get me the "correspondence" context.
+
+Dates are entered in natural language format. You can type "tomorrow," "in 3 days," "next tuesday," etc. You can also use "+3" to set a date 3 days from the current day, "+7" for a week, and so on.
+
+### Command line options
+
+ -h, --help     Displays help message   
+ -q, --quiet    Output as little as possible, overrides verbose   
+ -V, --verbose  Verbose output   
+ -g, --growl    Use Growl for feedback
+ 
+### Example usage
+
+	$ otask "Write a letter to mom"
+	
+This will put a task into your inbox with the name "Write a letter to mom." Nothing else will be set, it will wait there for you to pick it up.
+ 
+	$ otask -g "Pick up the kids from school @err #single due(today 3pm) !"
+
+This creates a new task in a project called Single Tasks, with a context of "errands", a due date of 3pm on the current day, and flags the task. 
+
+The task will go to your inbox by default, and--if provided--project and context will be set. Your settings for automatic cleanup will determine what happens after that. Task elements not specified are left unset.
+
+The `-g` parameter gives us our feedback via Growl, which is handy if you're calling it from a background script or application launcher like Quicksilver or LaunchBar.
+
+	$ otask "Brainstorm for the morning meeting (Bill had some ideas, it might be worth checking in with him this afternoon) d(tomorrow 8am) #hipstartup @think"
+	
+This will create a task with a note. Everything in parenthesis is removed from the task name and placed into the notes of the action, sans parenthesis. Note that the due date prefix can be shortened to just "d".
+
+OTask looks for notes in parenthesis, but it can also receive piped input from other applications as a note for the task. If you wanted to include text from a file, the output of a command or the plain-text contents of your clipboard, you can just pipe the output into the command, specifying the rest of the options as usual.
+
+	$ pbpaste | otask "Notes from the morning meeting @ref"
+	
+That would take the current contents of your clipboard and make them the attached note on the "Notes from the morning meeting" task (with the context "reference").
+
+### Calling from LaunchBar (et al.)
+
+You can do this with any app that can run a script with input, or call it from automated scripts if you could think of a reason to. Below is the AppleScript for a LaunchBar action. Create a new script in AppleScript Editor and paste the code in. Edit the path in the last function to point to wherever you put the otask script. Save the AppleScript as OTask.scpt in `~/Library/Application Support/LaunchBar/Actions`. 
+
+You'll find the Action in LaunchBar after it indexes. Type 'ota' (or as much as you need to get it to come up) and then press space bar. Use the syntax shown above to write out your action and its elements, but leave out the 'otask' part and any parameters. Hit return and Growl (you have it [installed, right?](http://growl.info)) will tell you what's up.
+
+	on handle_string(actionString)
+		if (length of actionString is not 0) then
+			my runRubyScript(actionString)
+		end if
+		open location "x-launchbar:hide"
+	end handle_string
+
+	on runRubyScript(action)
+		do shell script "/usr/bin/otask -g \"" & action & "\""
+	end runRubyScript
+
+
+### Author
+
+Brett Terpstra
+
+### Copyright
+
+Copyright (c) 2011 Brett Terpstra. Licensed under the MIT License:
+
+<http://www.opensource.org/licenses/mit-license.php>

data/bin/otask

@@ -0,0 +1,267 @@
+#! /usr/bin/env ruby
+
+# == Synopsis
+#   OTask provides CLI functionality for adding tasks to OmniFocus.
+#
+# == Usage
+#   otask [options] "Task string"
+#
+#   For help use: otask -h
+#
+# == Options
+#   -h, --help          Displays help message
+#   -q, --quiet         Output as little as possible, overrides verbose
+#   -V, --verbose       Verbose output
+#   -g, --growl         Use Growl for feedback
+#
+# == Author
+#   Brett Terpstra
+#
+# == Copyright
+#   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
+
+app = OTask.new(ARGV, STDIN)
+app.run

data/lib/otask.rb

@@ -0,0 +1,3 @@
+class Otask
+  VERSION = '0.2.2'
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: otask
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Brett Terpstra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+- !ruby/object:Gem::Dependency
+  name: rb-appscript
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: amatch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+description: A CLI for OmniFocus task entry with natural language syntax and fuzzy
+  project/context matching.
+email: me@brettterpstra.com
+executables:
+- otask
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- bin/otask
+- lib/otask.rb
+homepage: http://brettterpstra.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --title
+- doing
+- --main
+- README.md
+- --markup
+- markdown
+- -ri
+require_paths:
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A command line tool for creating OmniFocus tasks (Mac)
+test_files: []