tdo 0.0.4 → 0.0.5

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/bin/tdo

@@ -27,12 +27,12 @@ opts = OptionParser.new do |opts|
   end
   
   opts.on("--summary", "-s", "Summary") do
-    puts Tdo.task_summary
+    puts Tdo.summary
     exit 0
   end
   
   opts.on("--clear", "-c", "Clear done items") do
-    Tdo.clear_done
+    Tdo.clear
     exit 0
   end
   
@@ -46,9 +46,9 @@ opts.parse!
 
 
 if ARGV.size == 2
-  Tdo.add_task(ARGV[1], ARGV[0])
+  Tdo.add(ARGV[1], ARGV[0])
 elsif ARGV.size == 1
-  Tdo.add_task(ARGV[0])
+  Tdo.add(ARGV[0])
 else
-  puts Tdo.task_summary
+  puts Tdo.summary
 end

data/lib/tdo.rb

@@ -1,154 +1,223 @@
 module Tdo
 
   class InvalidGroup < ArgumentError; end
-
-  TODO_FILE = File.expand_path "~/.todo.txt"
   
-  # Reads the TODO file
-  #
-  # @param [String] group to read tasks from
-  # @return [String] the tasks
-  def self.read_tasks( group=nil )
-    unless group
-      File.new(TODO_FILE, "r").read
-    else
-      t = File.new(TODO_FILE, "r").read
-      raise InvalidGroup, "'#{group}' is not a valid group name", caller unless self.group?(group) 
-      to_s( to_hash(t)[ group[1..-1] ] )
-    end
-  end
+  # If using ENV, path must be absolute
+  TODO_FILE = ENV['TDO_FILE'] || File.expand_path("~/.todo.txt")
+  
   
   # Gives a summary of remaining tasks
   #
   # @return [String] summary of tasks
-  def self.task_summary
-    t = to_hash( self.read_tasks )
-    groups = t.size
+  def self.summary
+    t = Tasks.new.items
+    groups = t.size-1
     tasks = t.inject(0) {|sum, t| sum += t[1].size}
     done = t.inject(0) {|sum, t| sum += t[1].delete_if {|i| !i.include? ' #done' }.size}
     "#{tasks} tasks in #{groups} groups, #{done} done"
   end
   
-  # Allows you to add a new task to the file
-  #
-  # @param [String] task to add
-  # @param [String] group to add the task to
-  def self.add_task( task, group='@ungrouped' )
-    if File.exists? TODO_FILE
-      t = to_hash( self.read_tasks ) 
-    else
-      t = {}
-    end
-    if group[0] == "@"
-      group = group[1..-1] 
+  # Takes the groups name from a string
+  def self.get_group( str )
+    if str[0] == '@'
+      return str[1..-1]
     else
-      raise InvalidGroup, "'#{group}' is not a valid group name", caller
+      return str
     end
-    t[group] ||= [] # need to create new group if it doesn't exist
-    t[group] << task.strip
-    
-    write_hash t
   end
   
-  # Marks the selected item as done
-  #
-  # @param [String, Integer] task to mark as done
-  # @param [String] group that the task belongs to
-  def self.mark_done( id, group='@ungrouped' )
-    if group[0] == "@"
-      group = group[1..-1] 
-    else
-      raise InvalidGroup, "'#{group}' is not a valid group name", caller
-    end
   
-    t = to_hash( self.read_tasks )
-    if id.is_a? String      
-      t[group].each_with_index do |task, i|
-        if task.include? id
-          t[group][i] += ' #done'
+  
+  class Tasks
+    
+    attr_accessor :items
+    
+    # Creates a new Tasks object and loads in the TODO_FILE
+    def initialize
+      @items = {'ungrouped' => []}
+      self.read
+    end
+    
+    # Reads TODO_FILE and converts it to a hash
+    def read
+      t = File.new(TODO_FILE, "r").read
+      _group = ''
+      t.split("\n").each do |l|
+        if l[0] == '-'
+          @items['ungrouped'] << l[1..-1].strip
+        elsif l[0] == '@'
+          _group = l[1..-1].strip
+          @items[_group] = []
+        elsif l[0..1] == ' -'
+          @items[_group] << l[2..-1].strip
         end
       end
-    elsif id.is_a? Integer
-      t[group][id] += ' #done'
     end
-    write_hash t
-  end
-  
-  
-  # Deletes all items which have been marked done
-  #
-  # @return [Integer] number of tasks cleared
-  def self.clear_done
-    t = to_hash( self.read_tasks )
-    r = 0
-    t.each do |group, tasks|
-      s = tasks.size
-      r += tasks.delete_if {|i| i.include? ' #done' }.size - s
+    
+    # Adds the task to the list
+    #
+    # @param [String] task to add
+    # @param [String] group to add the task to
+    # @return [Boolean] whether the task has been added successfully
+    def add(task, group=nil)
+      if group.nil?
+        group = 'ungrouped'
+      else
+        group = Tdo.get_group(group)
+      end
+      
+      if self.find(task, group)
+        false
+      else
+        @items[group] ||= []
+        @items[group] << task.strip
+        self.write
+        true
+      end
+    end
+    
+    # Marks the selected item as done
+    #
+    # @param [String, Integer] task to mark as done
+    # @param [String] group that the task belongs to
+    def mark_done(id, group=nil)
+      unless group.nil?
+        group = Tdo.get_group(group) 
+        self.group?(group)
+      end
+      
+      if id.is_a? Integer
+        if group
+          @items[group][id] += ' #done'
+        else
+          # should really count across groups, another time!
+          @items['ungrouped'][id] += ' #done'
+        end
+      elsif id.is_a? String
+        if group
+          @items[group].collect! { |t| 
+            t.include?(id) ? t += ' #done' : t
+          }
+        else
+          # should test in every group as above
+          @items['ungrouped'].collect! { |t| 
+            t.include?(id) ? t += ' #done' : t
+          }
+        end
+      else
+        # error
+        return false
+      end
+      self.write
+      true
+    end 
+    
+    # Deletes all tasks marked as done
+    #
+    # @return [Integer] number of tasks cleared
+    def clear
+      r = 0
+      @items.each do |g, ts|
+        s = ts.size
+        ts.delete_if {|i| i.include?(' #done') }
+        r += s - ts.size
+      end
+      @items.delete_if {|g, ts| ts == [] }
+      self.write
+      r
+    end
+    
+    # Finds tasks which contain the string to look for
+    #
+    # @param [String] arg string to look for
+    # @param [String] group to look within
+    # @return [Array] found tasks
+    # @todo find within group
+    def find(str, group=nil)
+      r = []
+      @items.each do |g, ts|
+        ts.each do |t|
+          r << t if t.include?(str)
+        end
+      end
+      if r == []
+        false
+      else
+        r
+      end
+    end
+    
+    # Converts the tasks to a string which can then be written to a file
+    #
+    # @param [String] group
+    # @return [String] string representation of tasks
+    def to_s(group=nil)
+      r = ''
+      if group
+        self.group?(group)
+        group = Tdo.get_group(group)
+        @items[group].each do |t|
+          r += "- #{t}\n"
+        end
+      else
+        @items.each do |g, ts|
+          if g == 'ungrouped'
+            ts.each do |t|
+              r += "- #{t}\n"
+            end
+          else
+            r += "\n@#{g}\n"
+            ts.each do |t|
+              r += " - #{t}\n"
+            end
+          end
+        end
+      end
+      r
+    end
+    
+    # Writes the tasks to a file
+    def write
+      File.open(TODO_FILE, "w") {|f| f.write( self.to_s )}
+    end
+    
+    # Tests whether the group exists
+    #
+    # @param [String] group name
+    # @return [Boolean] whether the group exists
+    def group?( name )
+      if self.items.has_key?( Tdo.get_group(name) )
+        true
+      else
+        raise InvalidGroup, "'#{name}' is not a valid group name", caller
+      end
     end
-    t.delete_if {|k, v| v == [] }
-    write_hash t
-    r
+    
+    # Override default insepct
+    def inspect
+      "#<Tdo::Tasks>"
+    end
+  
   end
   
-  # Converts the given hash to a string and writes to the TODO_FILE
+  ##
+  # These are a group of methods to make it easy to use the above class
   #
-  # @param [Hash] tasks hash to write
-  def self.write_hash( hash )
-    File.open(TODO_FILE, "w") {|f| f.write( to_s(hash) )}
+  def self.read_tasks(group=nil)
+    Tdo::Tasks.new.to_s(group)
   end
   
-  
-  # Tests whether the group exists
-  #
-  # @param [String] group name
-  # @return [Boolean] whether the group exists
-  def self.group?( name )
-    t = to_hash( self.read_tasks )
-    t.has_key?(name[1..-1])
+  def self.mark_done(id, group=nil)
+    Tdo::Tasks.new.mark_done(id, group)
   end
   
-  # Converts the string read from the file to a hash so it can easily be used
-  #
-  # @param [String] read file string
-  # @return [Hash] the string as a hash
-  def self.to_hash( s )
-    r = {'ungrouped' => []}
-    last_group ||= ''
-    s.split("\n").each do |l|
-      if l[0] == '@'
-        last_group = l[1..-1].strip
-        r[last_group] = []
-      elsif l[1] == '-'
-        r[last_group] << l[2..-1].strip
-      elsif l[0] == '-'
-        r['ungrouped']  << l[1..-1].strip
-      end
-    end
-    r
+  def self.clear
+    Tdo::Tasks.new.clear
   end
   
-  # Converts the given hash to a string which can then be written to a file
-  #
-  # @param [Hash] hash of todo tasks
-  # @return [String] string representation of hash
-  def self.to_s( hash )
-    if !hash.is_a? Hash
-      hash = {'ungrouped' => hash}
-    end
-    r = ""
-    hash.each do |group, tasks|
-      if group == 'ungrouped'
-        tasks.each do |task|
-          r += "- #{task}\n"
-        end
-      else
-        r += "\n@#{group}\n"
-        tasks.each do |task|
-          r += " - #{task}\n"
-        end
-      end
-    end
-    r
+  def self.add(task, group=nil)
+    Tdo::Tasks.new.add(task, group)
   end
+  
 
 end

data/tdo.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tdo}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joshua Hawxwell"]
-  s.date = %q{2010-06-26}
+  s.date = %q{2010-07-01}
   s.default_executable = %q{tdo}
   s.description = %q{Tdo is a simple ruby app to add, edit and read your todo list. It stores the list at ~/.todo.txt}
   s.email = %q{m@hawx.me}

data/test/test_tdo.rb

@@ -1,63 +1,70 @@
 require 'helper'
 
 class TestTdo < Test::Unit::TestCase
-  
+
   should "read tasks" do
     clear_todo
-    assert_equal Tdo.read_tasks, file_text
+    t = Tdo::Tasks.new
+    assert_equal t.to_s, file_text
   end
   
   should "read tasks from specific group" do
     clear_todo
-    assert_equal Tdo.read_tasks('@home'), "- Another group\n"
+    assert_equal "- Another group\n", Tdo::Tasks.new.to_s('@home')
   end
 
   should "add new task" do
     clear_todo
-    b = Tdo.read_tasks
-    Tdo.add_task("Pick up milk")
-
-    assert_equal Tdo.read_tasks.size, b.size + " - Pick up milk".size
+    t = Tdo::Tasks.new
+    b = t.to_s
+    t.add("Pick up milk")
+    
+    assert_equal b.size + " - Pick up milk".size, t.to_s.size
   end
   
   should "add new task to group" do
     clear_todo
-    Tdo.add_task('Pick up milk', '@test')
+    t = Tdo::Tasks.new
+    t.add('Pick up milk', '@test')
     
-    assert_equal Tdo.read_tasks('@test').size, " - Pick up milk".size
+    assert_equal " - Pick up milk".size, t.to_s('@test').size
   end
   
   should "mark task as done" do
     clear_todo
-    b = Tdo.read_tasks('@ungrouped').strip
-    Tdo.mark_done('A task', '@ungrouped')
+    t = Tdo::Tasks.new
+    b = t.to_s('@ungrouped').strip
+    t.mark_done('A task', '@ungrouped')
     
-    assert_equal Tdo.read_tasks('@ungrouped'), b + " #done\n"
+    assert_equal b + " #done\n", t.to_s('@ungrouped')
   end
   
   should "mark task at index as done" do
     clear_todo
-    b = Tdo.read_tasks( '@ungrouped').strip
-    Tdo.mark_done(0, '@ungrouped')
+    t = Tdo::Tasks.new
+    b = t.to_s('@ungrouped').strip
+    t.mark_done(0, '@ungrouped')
     
-    assert_equal Tdo.read_tasks('@ungrouped'), b + " #done\n"
+    assert_equal b + " #done\n", t.to_s('@ungrouped')
   end
   
   should "remove all tasks marked done" do
     clear_todo
-    Tdo.clear_done
+    t = Tdo::Tasks.new
+    t.clear
     
-    assert_equal Tdo.read_tasks('@group'), "- Another task\n"
+    assert_equal "- Another task\n", t.to_s('@group')
   end
   
   should "remove group when all tasks are cleared" do
     clear_todo
-    Tdo.mark_done(0, '@home')
-    Tdo.clear_done
+    t = Tdo::Tasks.new
+    t.mark_done(0, '@home')
+    t.clear
     
     assert_raise Tdo::InvalidGroup do
-      Tdo.read_tasks('@home') 
+      t.to_s('@home') 
     end
   end
-  
+
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Joshua Hawxwell
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-26 00:00:00 +01:00
+date: 2010-07-01 00:00:00 +01:00
 default_executable: tdo
 dependencies: 
 - !ruby/object:Gem::Dependency