todorb 0.2.1 → 1.0.0

data/CHANGELOG.rdoc

@@ -0,0 +1,12 @@
+= todorb 0.2.2, 2010-06-15
+* Added subtask addition. One may add subtasks under a task.
+* This effects everything! Deleting a task, you may wanna delete all
+children. Changing the status of a task may affect all children.
+Renumberign and redoing etc affects subtasks. The impact of this change
+is quite huge.
+
+= todorb 0.2.1
+* Version without subtask. This is a simpler version which i prefer.
+
+
+## vim:tw=72:ai:formatoptions=tcqln:nocindent

data/Makefile

@@ -0,0 +1,29 @@
+DISTFILES := README.markdown get_serial_number colors.sh todoapp.sh
+VERSION := `cat VERSION_FILE`
+ 
+all: install
+
+install:
+
+	rake build && sudo rake install
+	
+#
+# Testing
+#
+TESTS = $(wildcard tests/t[0-9][0-9][0-9][0-9]-*.sh)
+#TEST_OPTIONS=--verbose
+
+test-pre-clean:
+	rm -rf tests/test-results "tests/trash directory"*
+
+aggregate-results: $(TESTS)
+
+$(TESTS): test-pre-clean
+	-cd tests && sh $(notdir $@) $(TEST_OPTIONS)
+
+test: aggregate-results
+	tests/aggregate-results.sh tests/test-results/t*-*
+	rm -rf tests/test-results
+    
+# Force tests to get run every time
+.PHONY: test test-pre-clean aggregate-results $(TESTS)

data/README.markdown

@@ -10,11 +10,56 @@ The fun things about this app, is that I am having to write ruby code that will
 
 The TODO file output is TODO2.txt and is a plain text file. A TAB separates the task number from the Task. I use task numbers, since I may refer to tasks elsewhere. Gina's app never saved a task Id but kept showing them.
 
-The shell version, todoapp, allowed for any levels of sub-tasks. I have not yet added that, I may.
-
-I also may fork this and make a YAML file, so that the format is standard, especially when having sub-tasks.
 After this, I will port over my bug tracker, [bugzy.txt](http://github.com/rkumar/bugzy.txt), which uses a TAB delimited file. It's a cool app to use for bug tracking - you should try it out. I will possibly use sqlite instead of screwing around with a delimited file. 
 
+## Features
+
+1. multiple todo lists (per directory)
+2. subtasks (recursive delete or status update)
+3. priorities - (A) (B)
+4. status - [ ], [x], [@] etc
+5. tag    - @WORK
+6. project - +myproj
+7. component - @comp1
+8. notes attached to task
+9. delete tasks
+10. archive completed tasks
+11. colored or plain output
+12. show or hide completed tasks (default: hide)
+13. Search, filter, sort tasks by priority (default) or task id.
+14. Renumber the file
+
+## Sample Output
+
+       3 [ ] Add a close for status close (2010-06-14) 
+         3.1 [ ] hello there new a u 3 (2010-06-15) 
+             3.1.1 [ ] hello there new a u 3 (2010-06-15) 
+             3.1.2 [ ] hello there new a u 3 (2010-06-15) 
+             3.1.3 [ ] hello there new a u 3 (2010-06-15) 
+         3.2 [ ] hello there new a u 3.2 (2010-06-15) 
+             3.2.1 [ ] hello there new a u 3.2.1 (2010-06-15) 
+                 3.2.1.1 [ ] hello there new a u 3.2.1.1 
+                        * a note for frank (2010-06-15) 
+       5 [ ] list: if dir given then show full path of TODO2.txt at end (2010-06-14) 
+         5.2 [ ] start rubyforge project for todorb (2010-06-14) 
+       6 [@] allow for ENV VARS such as verbose, plain, force (2010-06-15) 
+         6.1 [@] what if no serial_number file? (2010-06-14) 
+       7 [ ] list: search terms with - + and = @RUBY (2010-06-15) 
+       8 [ ] testing out add 1 @MYTAG @RUBY (2010-06-19) 
+       9 [ ] testing out another one @RUBY 
+              * a note for chris 
+              * a note for steve (2010-06-19) 
+      11 [x] (A) move common app code to common/cmdapp 
+             * refactor it also, so not so reliant on variables (2010-06-20) 
+      16 [ ] (A) add aliases to subcommand (2010-06-21) 
+     
+     17 of 17 rows displayed from TODO2.txt 
+
+## File format
+
+1. The file format is almost identical to the output except that there is a TAB after the task number.
+2. Notes are saved on same line as task, but displayed on another line with asterisk prefix.
+
 ## Copyright
 
 Copyright (c) 2010 Rahul Kumar. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "todorb"
+    gem.summary = %Q{command-line todo list manager }
+    gem.description = %Q{command-line program that manages a todo list text file }
+    gem.email = "sentinel1879@gmail.com"
+    gem.homepage = "http://github.com/rkumar/todorb"
+    gem.authors = ["Rahul Kumar"]
+    gem.rubyforge_project = "todorb"
+    #gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "todorb #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -1 +1 @@
-0.2.1
+1.0.0

data/bin/todorb

@@ -2,4 +2,4 @@
 require 'rubygems'
 #require 'todorb/todo.rb'
 require 'todorb'
-Todo.main(ARGV)
+exit Todo.main(ARGV)

data/lib/common/cmdapp.rb

@@ -0,0 +1,170 @@
+#!/usr/bin/env ruby -w
+=begin
+  * Name          : cmdapp.rb
+  * Description   : some basic command line things
+  *               : Moving some methods from todorb.rb here
+  * Author        : rkumar
+  * Date          : 2010-06-20 11:18 
+  * License       :
+    Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+
+=end
+require 'common/sed'
+
+ERRCODE = 1
+
+module Cmdapp
+
+  ## 
+  # external dependencies:
+  #  @app_default_action - action to run if none specified
+  #  @app_file_path - data file we are backing up, or reading into array
+  #  @app_serial_path - serial_number file
+  ##
+  # check whether this action is mapped to some alias and *changes*
+  # @action and @argv if true.
+  # @param [String] action asked by user
+  # @param [Array] rest of args on command line
+  # @return [Boolean] whether it is mapped or not.
+  #
+  def check_aliases action, args
+    ret = @aliases[action]
+    if ret
+      a = ret.shift
+      b = [*ret, *args]
+      @action = a
+      @argv = b
+      #puts " #{@action} ; argv: #{@argv} "
+      return true
+    end
+    return false
+  end
+  ## 
+  # runs method after checking if valid or alias.
+  # If not found prints help.
+  # @return [0, ERRCODE] success 0.
+  def run
+    @action = @argv[0] || @app_default_action
+    @action = @action.downcase
+    @action.sub!('priority', 'pri')
+    @action.sub!(/^del$/, 'delete')
+
+
+    ret = 0
+    @argv.shift
+    if @actions.include? @action
+      ret = send(@action, @argv)
+    else
+      # check aliases
+      if check_aliases @action, @argv
+        ret = send(@action, @argv)
+      else
+        help @argv
+        ret = ERRCODE
+      end
+    end
+    ret ||= 0
+    ret = 0 if ret != ERRCODE
+    return ret
+  end
+  def help args
+    puts "Actions are "
+    @actions.each_pair { |name, val| puts "#{name}\t#{val}" }
+    puts " "
+    puts "Aliases are "
+    @aliases.each_pair { |name, val| puts "#{name}:\t#{val.join(' ')}" }
+    0
+  end
+
+  ##
+  # reads serial_number file, returns serialno for this app
+  # and increments the serial number and writes back.
+  def _get_serial_number
+    require 'fileutils'
+    appname = @appname
+    filename = @app_serial_path || "serial_numbers"
+    h = {}
+    # check if serial file existing in curr dir. Else create
+    if File.exists?(filename)
+      File.open(filename).each { |line|
+        #sn = $1 if line.match regex
+        x = line.split ":"
+        h[x[0]] = x[1].chomp
+      }
+    end
+    sn = h[appname] || 1
+    # update the sn in file
+    nsn = sn.to_i + 1
+    # this will create if not exists in addition to storing if it does
+    h[appname] = nsn
+    # write back to file
+    File.open(filename, "w") do |f|
+      h.each_pair {|k,v| f.print "#{k}:#{v}\n"}
+    end
+    return sn
+  end
+  ##
+  # After doing a redo of the numbering, we need to reset the numbers for that app
+  def _set_serial_number number
+    appname = @appname
+    pattern = Regexp.new "^#{appname}:.*$"
+    filename = @app_serial_path || "serial_numbers"
+    _backup filename
+    change_row filename, pattern, "#{appname}:#{number}"
+  end
+
+  def _backup filename=@app_file_path
+    require 'fileutils'
+    FileUtils.cp filename, "#{filename}.org"
+  end
+  def die text
+    $stderr.puts text
+    exit ERRCODE
+  end
+  # prints messages to stderr
+  # All messages should go to stderr.
+  # Keep stdout only for output which can be used by other programs
+  def message text
+    $stderr.puts text
+  end
+  # print to stderr only if verbose set
+  def verbose text
+    message(text) if @options[:verbose]
+  end
+  # print to stderr only if verbose set
+  def warning text
+    print_red("WARNING: #{text}") 
+  end
+  def print_red text
+    message "#{RED}#{text}#{CLEAR}"
+  end
+  def print_green text
+    message "#{GREEN}#{text}#{CLEAR}"
+  end
+
+  ##
+  # load data into array as item and task
+  # @see save_array to write
+  def load_array
+    #return if $valid_array
+    $valid_array = false
+    @data = []
+    File.open(@app_file_path).each do |line|
+      row = line.chomp.split "\t"
+      @data << row
+    end
+    $valid_array = true
+  end
+  ## 
+  # saves the task array to disk
+  # Please use load_array to load, and not populate
+  def save_array
+    raise "Cannot save array! Please use load_array to load" if $valid_array == false
+
+    File.open(@app_file_path, "w") do |file| 
+      @data.each { |row| file.puts "#{row[0]}\t#{row[1]}" }
+    end
+  end
+
+
+end

data/lib/common/sed.rb

@@ -11,54 +11,94 @@
 # matching lines to it
 
 module Sed
-def change_row filename, pattern, replacement = nil
-  d = _read filename
-  d.each { |row|
-    if row =~ pattern
-      if replacement
-        row.gsub!( pattern, replacement)
-      else
-        yield row
+  def change_row filename, pattern, replacement = nil
+    d = _read filename
+    d.each { |row|
+      if row =~ pattern
+        if replacement
+          row.gsub!( pattern, replacement)
+        else
+          yield row
+        end
       end
+    }
+    _write filename, d
+  end
+  def change_file filename
+    d = _read filename
+    d.each { |row|
+      yield row
+    }
+    _write filename, d
+  end
+  ##
+  # deletes on more rows based on a pattern
+  # Also takes a block and yields each row to it
+  def delete_row filename, pattern = nil
+    d = _read filename
+    if pattern
+      d.delete_if { |row| row =~ pattern }
+    else
+      d.delete_if { |row| yield row }
     end
-  }
-  _write filename, d
-end
-def change_file filename
-  d = _read filename
-  d.each { |row|
-    yield row
-  }
-  _write filename, d
-end
-##
-# deletes on more rows based on a pattern
-# Also takes a block and yields each row to it
-def delete_row filename, pattern = nil
-  d = _read filename
-  if pattern
-    d.delete_if { |row| row =~ pattern }
-  else
-    d.delete_if { |row| yield row }
+    _write filename, d
   end
-  _write filename, d
-end
-##
-# read the given filename into an array
-def _read filename
-  d = []
-  File.open(filename).each { |line|
-    d << line
-  }
-  return d
-end
-## 
-# write the given array to the filename
-def _write filename, array
-  File.open(filename, "w") do |file| 
-    array.each { |row| file.puts row }
+  ## 
+  # inserts text in filename at lineno.
+  #
+  def insert_row filename, lineno, text
+    d = _read filename
+    d.insert(lineno, text)
+    _write filename, d
+    0
+  end
+  ##
+  # read the given filename into an array
+  def _read filename
+    d = []
+    File.open(filename).each { |line|
+      d << line
+    }
+    return d
+  end
+  ## 
+  # write the given array to the filename
+  def _write filename, array
+    File.open(filename, "w") do |file| 
+      array.each { |row| file.puts row }
+    end
+  end
+  ## 
+  # searches filelist array for pattern yielding filename, linenumber and line
+  # @return [Array, nil] array of lines containing filename,lineno,line tab delimited
+  #    or nil if nothing found
+  # Taken from http://facets.rubyforge.org/apidoc/index.html more filelist.
+  # egrepoptions - count only, linenumber, filename, invert etc
+  def egrep(filelist, pattern, egrepoptions={})
+    lines = []
+    filelist.each do |fn|
+      open(fn) do |inf|
+        count = 0
+
+        inf.each do |line|
+          count += 1
+          if pattern.match(line)
+            if block_given?
+              yield fn, count, line
+            else
+              #puts "#{fn}:#{count}:#{line}"
+              lines <<  "#{fn}#{@todo_delim}#{count}#{@todo_delim}#{line}"
+            end
+          end
+        end
+
+      end
+    end
+    unless block_given?
+      ret = lines.empty? nil:lines
+      return ret
+    end
   end
-end
 end # module
 
 if __FILE__ == $0