laktek-todo 0.0.2

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-08-26
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Lakshan Perera
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,29 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+bin/todo
+config/hoe.rb
+config/requirements.rb
+lib/todo.rb
+lib/todo/version.rb
+lib/todo/cli.rb
+lib/todo/list.rb
+lib/todo/store.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+spec/todo_list_specs.rb
+spec/todo_store_specs.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on todo, see http://todo.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.txt

@@ -0,0 +1,58 @@
+= Simple command-line todo list manager
+
+Really want to get things done? Don't want to juggle with web based todo lists? 
+Get your things done with command-line. No hassle, no distraction - Try out todo ruby gem. 
+
+
+== FEATURES:
+
+* Uses human readable YAML to store the todo lists (You could edit the todo list manually)
+* Supportss project specific todo lists. (Just run 'todo create' in your project directory)
+* Supports tagging.
+
+== Install
+
+First make sure you install the dependency gems.
+  sudo gem install main
+  sudo gem install highline
+
+  then;
+  sudo gem install todo (should work)
+  
+  You can also install from git
+  git clone git://github.com/laktek/todo.git
+  cd todo
+  rake install_gem
+  
+== Example:
+
+  Here is a small sample on how to use todo gem
+  
+  #visit your project folder
+  cd projects/newapp
+  
+  #create a new todo list for the project
+  todo create
+  
+  #add a new task
+  todo add "write the specs"
+  - add tags : important, due:24/08/2008
+  
+  #listing all tasks
+  todo list --all
+  
+  #listing tasks tagged 'important'
+  todo list --tag important
+  
+  #removing a task by name
+  todo remove "write the specs"
+  
+  #removing a task by index
+  todo remove -i 1
+  
+== Issues/Improvements
+
+Todo is still its infant days and have very minimum functionality. If you come across any issues or like to suggest any improvements, please feel free to contact me : lakshan [at] web2media [dot] net
+
+
+

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/todo

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'todo'
+require 'todo/cli'

data/config/hoe.rb

@@ -0,0 +1,71 @@
+require 'todo/version'
+
+AUTHOR = 'Lakshan Perera'  # can also be an array of Authors
+EMAIL = "lakshan@web2media.net"
+DESCRIPTION = "simple command line todo list manager"
+GEM_NAME = 'todo' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'todo' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [['main', '>= 2.8.2'], ['highline', '>= 1.4.0']]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Todo::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'todo documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/todo.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.dirname(__FILE__)) 
+require 'todo/version'
+require 'todo/list'
+require 'todo/store'
+
+module Todo
+  
+end

data/lib/todo/cli.rb

@@ -0,0 +1,137 @@
+require 'rubygems'
+require 'main'
+require 'highline/import'
+require 'ftools'
+
+def read_file(environment)
+  file = environment.nil? ? Todo::Store.read('.todo/list.yml') : Todo::Store.read(environment)
+end
+
+def write_file(list, environment)
+  file = environment.nil? ? Todo::Store.write(list, '.todo/list.yml') : Todo::Store.write(list, environment)
+end
+
+Main {
+  def run
+    puts "todo [command] --help for usage instructions."
+    puts "The available commands are: \n   add, remove, list, modify."
+  end
+  
+  mode 'create' do
+    description 'Creates a new todo list for this directory'
+    
+    def run
+      unless File.exist?(".todo/list.yml")
+        File.makedirs(".todo")
+        newfile = File.new(".todo/list.yml", "w+")
+        say "Created a new todo list inside this directory" if newfile
+        newfile.close
+      else
+         say "Todo list already exists inside this directory"
+      end
+    end
+  end
+  
+  mode 'add' do
+    description 'Adds a new todo item'
+     argument('item'){
+        description 'todo item to add'        
+     }
+     
+     environment('FILE'){
+        synopsis 'export FILE=path'
+     }
+     
+     option('notags', 'n'){
+      cast :bool
+      default false     
+     }
+    
+    def run
+       unless params['notags'].value
+        tags = ask("Enter tags for this item (seperate from commas) ", lambda {|str| 
+               str.split(/,\s*/) })
+       end
+       
+       #read the YAML file
+       if list=read_file(params['FILE'].value)
+        #add the task
+        list.add(params['item'].value, tags)
+        #write the changes
+        say "Successfully added your task." if write_file(list, params['FILE'].value)
+       else
+        say "Todo list file is invalid or do not exist."
+       end
+    end
+  end
+  
+  mode 'remove' do
+    description 'Removes an item from todo list'
+    
+    environment('FILE'){
+        synopsis 'export FILE=path'
+     }
+         
+    argument('item'){
+       argument_optional 
+       description 'Name of the todo item to remove'
+    }
+    
+    option('index', 'i'){
+      cast :int
+      argument :required
+      description 'Index of the todo item to remove (starting from 1). Use instead of item name'
+    }
+       
+    def run
+      if list=read_file(params['FILE'].value)
+        if list.remove(params['item'].value || params['index'].value)
+          say "Removed item from the list." if write_file(list, params['FILE'].value)
+        else 
+          say "Could not find item to remove."
+        end
+      else
+        say "Todo list file is invalid or do not exist."
+      end      
+    end
+  end
+  
+  mode 'list' do
+    description 'Lists todo items'
+    
+    environment('FILE'){
+        synopsis 'export barfoo=value'
+     }
+     
+    option('tag', 't'){
+      argument_required    
+    }
+    
+    option('all=[all]', 'a'){  # note shortcut syntax for optional args
+        #argument_optional      # we could also use this method
+        cast :bool
+        default false
+    }
+        
+    def run
+      if list=read_file(params['FILE'].value)
+      
+        if params['tag'].given?
+          title = "Listing todos tagged '#{params['tag'].value}'"
+          tasks = list.tagged(params['tag'].value) 
+        else
+          title = "Listing all todos"
+          tasks = list
+        end
+             
+        say title
+        tasks.each do |task, tags|
+          tag_string = ("(#{tags.join(", ")})") unless tags.include?(nil)
+          say " - #{task} #{tag_string} \n"
+        end
+      else
+        say "Todo list file is invalid or do not exist."
+      end
+    end  
+  end
+}

data/lib/todo/list.rb

@@ -0,0 +1,25 @@
+module Todo
+
+  class List < Hash
+      
+    def tagged(tag)
+      self.reject do |name, tags|
+        not tags.include?(tag)
+      end
+    end
+    
+    def add(task, *tags)
+      self.store(task, tags.flatten)
+      self
+    end
+    
+    #Returns the list after removing specific item
+    def remove(task)
+      #find key by index
+      task = self.keys[task - 1] if task.instance_of? Fixnum
+      self if self.delete(task)
+    end
+  
+  end  
+end
+

data/lib/todo/store.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'yaml'
+
+module Todo
+  class Store
+      def self.read(file)
+        begin
+         loaded_list = YAML::load( File.open( file ) )
+         loaded_list ? List[loaded_list] : List.new 
+        rescue
+          nil
+        end
+      end
+      
+      def self.write(list, file)
+        begin
+          File.open( file, 'w' ) do |f|
+            f << list.to_yaml
+          end
+        rescue
+          nil
+        end
+      end
+      
+  end
+end

data/lib/todo/version.rb

@@ -0,0 +1,9 @@
+module Todo
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 2
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/todo.rb'}"
+puts "Loading todo gem"
+exec "#{irb} #{libs} --simple-prompt"