todo-notify 0.1

data/README.md

@@ -0,0 +1,51 @@
+# Todo.notify
+
+todo-notify is a command line program designed to work with Gina Trapani's
+[todo.txt](github.com/ginatrapani/todo.txt-cli). It takes your todo.txt and
+notifies you of a random task. If you set this up with cron, you can have
+a periodic reminder of tasks that are on your todo list. Neat, right? :)
+
+# Installation
+
+    gem install todo-notify
+
+# Usage
+
+    todo-notify --path ~/Dropbox/todo/todo.txt
+
+# Output of the --help
+
+Usage: todo-notify [options]
+
+## Placeholders
+
+todo-notify uses a placeholder system for generating its titles and content.
+The placeholders are as following:
+
+    %t - The text content of the task.
+    %P - The task priority.
+    %p - The task +projects.
+    %c - The task @contexts.
+
+Example task:    "(A) My task, woot. +project @context"
+Example title:   "Todo: %P %p %c"
+Example content: "%t"
+
+The notification will then look like this:
+
+    Todo: A +project @context
+    My task, woot.
+
+## Notifications
+
+todo-notify uses the "notify-send" command to show its notifications. If your
+operating system doesn't have a "notify-send" program then todo-notify will not
+work.
+
+## Available arguments
+
+    -p, --path FILE                  Path to your todo.txt FILE.
+    -t, --title TITLE                Title of the notification.
+    -c, --content CONTENT            The content of the notification.
+    -h, --help                       Display this screen.
+

data/bin/todo-notify

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+
+require 'todo-txt'
+require 'optparse'
+
+# Configuration variables
+$todo_file = File.expand_path "~/Dropbox/todo/todo.txt"
+$title     = "Todo: %P %p %c"
+$content   = "%t"
+
+# Parse command line options
+OptionParser.new do |o|
+  # Set some introductory text that explains the placeholders etc.
+  o.separator %(
+# Placeholders
+
+todo-notify uses a placeholder system for generating its titles and content.
+The placeholders are as following:
+
+    %t - The text content of the task.
+    %P - The task priority.
+    %p - The task +projects.
+    %c - The task @contexts.
+
+Example task:    "(A) My task, woot. +project @context"
+Example title:   "Todo: %P %p %c"
+Example content: "%t"
+
+The notification will then look like this:
+
+    Todo: A +project @context
+    My task, woot.
+
+# Notifications
+
+todo-notify uses the "notify-send" command to show its notifications. If your
+operating system doesn't have a "notify-send" program then todo-notify will not
+work.
+
+# Available arguments
+  )
+
+  # Path to your todo.txt file.
+  o.on('-p',
+       '--path FILE',
+       'Path to your todo.txt FILE. Defaults to
+        "~/Dropbox/todo/todo.txt".') do |file|
+    $todo_file = File.expand_path file
+  end
+
+  # Notification title.
+  o.on('-t',
+       '--title TITLE',
+       'Title of the notification. Defaults to
+        "Todo: %P %p %c".') do |title|
+    $title = title
+  end
+
+  # Notification content.
+  o.on('-c',
+       '--content CONTENT',
+       'The content of the notification. Defaults to
+        "%t".') do |content|
+    $content = content
+  end
+
+  # Display help.
+  o.on('-h', '--help', 'Display this screen.') do
+    puts o
+    exit
+  end
+end.parse!
+
+def parse_placeholders string, task
+  string.gsub('%c', task.contexts.join(', ')).
+         gsub('%p', task.projects.join(', ')).
+         gsub('%P', task.priority).
+         gsub('%t', task.text).
+         gsub(/\s+/, ' ')
+end
+
+list  = Todo::List.new $todo_file
+task  = list.sample
+
+title   = parse_placeholders $title, task
+content = parse_placeholders $content, task
+
+`notify-send "#{title}" "#{content}"`

data/todo-notify.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name = %q{todo-notify}
+  s.version = "0.1"
+  s.date = %q{2011-08-21}
+  s.authors = ["Sam Rose"]
+  s.email = %q{samwho@lbak.co.uk}
+  s.summary = %q{A command line program for reminding you of items on your todo list.}
+  s.description = %q{A command line program for reminding you of items on your todo list.}
+  s.homepage = %q{http://github.com/samwho/todo-notify-gem}
+  s.required_ruby_version = '>= 1.9.2'
+  s.license = 'GPL-2'
+  s.bindir = 'bin'
+  s.executables = ["todo-notify"]
+  s.add_dependency 'todo-txt'
+  s.requirements << 'The "notify-send" command line program.'
+  s.requirements << 'A "todo.txt" file in Gina Trapani\'s todo.txt format.'
+
+  # Add all files to the files parameter.
+  s.files = []
+  Dir["**/*.*"].each { |path| s.files.push path }
+  s.files.push ".gemtest"
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: todo-notify
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Sam Rose
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: todo-txt
+  requirement: &79079580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *79079580
+description: A command line program for reminding you of items on your todo list.
+email: samwho@lbak.co.uk
+executables:
+- todo-notify
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/todo-notify
+- README.md
+- todo-notify-0.1.gem
+- todo-notify.gemspec
+- .gemtest
+homepage: http://github.com/samwho/todo-notify-gem
+licenses:
+- GPL-2
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- The "notify-send" command line program.
+- A "todo.txt" file in Gina Trapani's todo.txt format.
+rubyforge_project: 
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: A command line program for reminding you of items on your todo list.
+test_files: []