todo 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  data.tar.gz: 59080b13500a1e05d58a5505d101d870732b1bd8
-  metadata.gz: aed1b7b5805537d015c1402c8d297d237ca32542
-SHA512: 
-  data.tar.gz: a93f3040b469d5cc553c5bef1983285052d5faafe568265df8085f382d160d72aaa108f916137dd4d5e23027c3269516a7c476e7487a14438a5fec3081f22efa
-  metadata.gz: 586f3e600d86f9da380b5981add91118957cb9dedccf3c367df97958bd1d1bba4f4205a6d291073a516630ce8be1f1a83ce863671b0b5c7ff2646b5b76fae959
+---
+SHA1:
+  metadata.gz: 24203ee1ee57fddc956f45411f545fc2424435c9
+  data.tar.gz: 0852e391ab564895c1dc0b36bd9c7f085cacd442
+SHA512:
+  metadata.gz: a4313713da987294539c5da5e65efbaede7e2643832048a95b705af8469a2030508addbfb83d8176e0004accb1485ad52a062279b6f2d328ae0050bd31fbb14b
+  data.tar.gz: 288e3c1f27a9263de0a21bf4246ab956e3342a70df6204a99547eac422bb7742ba007f28ff7d986940a43241c95bb42e27ba4e1f74090102d049e07cce190b3d

data/README.rdoc

@@ -4,51 +4,38 @@ 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:
+== 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.
+* Supports project specific todo lists.
+   (Creates automatically a file '.todo.yml' in the project-directory you are using it)
+* Supports tagging
 
 == Install
 
-First make sure you install the dependency gems.
-  sudo gem install main
-  sudo gem install highline
+  gem install todo
 
-  then;
-  sudo gem install todo
-
-  You can also install from github:
-  gem sources -a http://gems.github.com
-  sudo gem install laktek-todo
-
-== Example:
+== 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
+  #add a task
   todo add "write the specs"
-  - add tags : important, due:24/08/2008
+  - add tags : important, due:24/08/2014
 
   #listing all tasks
-  todo list --all
+  todo list
 
   #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
+  #removing a task by his number (index)
+  todo remove 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
+Todo is very minimalistic by its nature.
+Feel free to try, fork and send PRs.

data/lib/todo.rb

@@ -1,6 +1,5 @@
 require 'todo/version'
-require 'todo/list'
-require 'todo/store'
+require 'todo/controller'
 
 module Todo
 

data/lib/todo/cli.rb

@@ -1,134 +1,65 @@
 require 'rubygems'
 require 'main'
-require 'highline/import'
 require 'fileutils'
+require 'highline/import'
 
-def read_list(environment)
-  file = environment.nil? ? Todo::Store.read('.todo/list.yml') : Todo::Store.read(environment)
-  if file
-    yield(file)
-  else
-    say "Todo list file is invalid or do not exist."
-  end
-end
-
-def write_list(list, environment)
-  file = environment.nil? ? Todo::Store.write(list, '.todo/list.yml') : Todo::Store.write(list, environment)
-end
+#
+TODO_FILE   = '.todo.yml'
+ADD_DESC    = "Adds a new task"
+REMOVE_DESC = "Removes a task from this todo list"
+LIST_DESC   = "Lists the tasks"
+#
 
 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")
-        FileUtils.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
+    puts
+    puts "The available commands are:"
+    puts "  - add    => #{ADD_DESC}"
+    puts "  - remove => #{REMOVE_DESC}"
+    puts "  - list   => #{LIST_DESC}"
+    puts
   end
 
   mode 'add' do
-    description 'Adds a new todo item'
-     argument('item'){
-        description 'todo item to add'
-     }
+    description ADD_DESC
+    argument('task'){ description 'Task to add' }
 
-     environment('FILE'){
-        synopsis 'export FILE=path'
-     }
-
-     option('notags', 'n'){
+    option('notags', 'n'){
       cast :bool
       default false
-     }
-
-    def run
-       unless params['notags'].value
-        tags = ask("Enter tags for this item (separate with commas) ", lambda {|str|
-               str.split(/,\s*/) })
-       end
+    }
 
-       read_list(params['FILE'].value) do |list|
-        list.add(params['item'].value, tags)
-        say "Successfully added your task." if write_list(list, params['FILE'].value)
-       end
-    end
+    define_method(:run) { say(Todo::add_task(TODO_FILE,
+                                             params['notags'].value,
+                                             params['task'].value)) }
   end
 
   mode 'remove' do
-    description 'Removes an item from todo list'
-
-    environment('FILE'){
-        synopsis 'export FILE=path'
-     }
+    description REMOVE_DESC
 
-    argument('item'){
-       argument_optional
-       description 'Name of the todo item to remove'
-    }
-
-    option('index', 'i'){
+    argument('index'){
+      required
       cast :int
-      argument :required
-      description 'Index of the todo item to remove (starting from 1). Use instead of item name'
+      validate { |index| index>0 }
+      description 'Task number to remove'
     }
 
-    def run
-      read_list(params['FILE'].value) do |list|
-        if list.remove(params['item'].value || params['index'].value)
-          say "Removed item from the list." if write_list(list, params['FILE'].value)
-        else
-          say "Could not find item to remove."
-        end
-      end
-    end
+    define_method(:run) { say(Todo::del_task(TODO_FILE,params['index'].value)) }
   end
 
   mode 'list' do
-    description 'Lists todo items'
-
-    environment('FILE'){
-        synopsis 'export barfoo=value'
-     }
+    description LIST_DESC
 
-    option('tag', 't'){
-      argument_required
-    }
+    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
+    option('all=[all]', 'a'){
+      cast :bool
+      default false
     }
 
-    def run
-      read_list(params['FILE'].value) do |list|
-
-        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
+    define_method(:run) { say(Todo::show_tasks(TODO_FILE,params['tag'].value)) }
 
-      end
-    end
   end
 }

data/lib/todo/controller.rb

@@ -0,0 +1,70 @@
+require 'fileutils'
+require 'highline/import'
+require 'SecureRandom'
+require 'yaml'
+
+module Todo
+
+  def self.add_task(filename,notags,description,taskid=SecureRandom.hex(4),created_at=Time.now.to_s)
+    tags   = []
+    _tasks = load_tasks(filename)
+    tags   = ask("(optional) Enter comma-separated tags: ", lambda {|s| s.split(/,\s*/) }) unless notags
+
+    _tasks << {
+      "taskid" => taskid,
+      "created_at" => created_at,
+      "description" => description,
+      "tags" => tags
+    }
+
+    "<%= color('Task added', :green) %>" if(save_tasks(filename,_tasks))
+  end
+
+  def self.del_task(filename,index)
+    _tasks=load_tasks(filename)
+    if(_tasks.delete_at(index-1) && save_tasks(filename,_tasks))
+      "<%= color('Task deleted', :yellow) %>"
+    else
+      "<%= color('No task deleted', :red) %>"
+    end
+  end
+
+  def self.show_tasks(filename,tag)
+    _tasks=load_tasks(filename)
+
+    _rtn      = "Listing tasks (#{tag ? tag.to_s : 'all'})\n"
+    _tasks.each_with_index do |task, i|
+      next if(tag && !(task["tags"].include?(tag)))
+      _rtn   += "(#{i+1})\n"
+      _rtn   += "\t taskid      : #{task['taskid']}\n"
+      _rtn   += "\t created_at  : #{task['created_at']}\n"
+      _rtn   += "\t description : <%= color('"+task['description']+"', :yellow) %>\n"
+      unless(task['tags'].empty?)
+        _rtn += "\t tags        : #{task['tags']}\n\n"
+      end
+    end
+    _rtn
+  end
+
+  #
+
+  def self.save_tasks(filename,tasks,file=File)
+    begin
+      File.open(filename,"w+") { |f| f << tasks.to_yaml }
+    rescue
+      nil
+    end
+  end
+
+  def self.load_tasks(filename)
+    begin
+      _tasks = YAML::load(File.open(filename))
+    rescue
+      nil
+    end
+    _tasks ? _tasks : []
+  end
+
+  private_class_method :save_tasks, :load_tasks
+
+end

data/lib/todo/version.rb

@@ -1,6 +1,6 @@
 module Todo
   MAJOR = 0
-  MINOR = 1
+  MINOR = 2
   TINY  = 0
 
   VERSION = [MAJOR, MINOR, TINY].join('.')

data/spec/todo_controller_spec.rb

@@ -0,0 +1,70 @@
+require 'todo/controller'
+
+RSpec.describe 'Todo::Controller' do
+
+  let(:filename) { ".todo.yml" }
+
+  let(:empty_task_list) { [] }
+  let(:created_at) { Time.now.to_s }
+  let(:one_todo_item) { [{ "taskid"=>"123abc",
+                           "created_at"=>created_at,
+                           "description"=>":-)",
+                           "tags"=>[]}] }
+  let(:new_task_list) { [
+                         { "taskid"=>"123abc",
+                           "created_at"=>created_at,
+                           "description"=>":-)",
+                           "tags"=>[] },
+                         { "taskid"=>"456def",
+                           "created_at"=>created_at,
+                           "description"=>":-D",
+                           "tags"=>[] },
+                        ] }
+
+  context "add task" do
+    it "should create the file if it does not exist" do
+      expect(Todo).to receive(:load_tasks).with(filename).and_return(empty_task_list)
+      expect(Todo).to receive(:save_tasks).with(filename,one_todo_item).and_return(true)
+      expect(Todo::add_task(filename,true,":-)","123abc",created_at)).to eq("<%= color('Task added', :green) %>")
+    end
+
+    it "should add another task to the existing ones" do
+      expect(Todo).to receive(:load_tasks).with(filename).and_return(one_todo_item)
+      expect(Todo).to receive(:save_tasks).with(filename,new_task_list).and_return(true)
+      expect(Todo::add_task(filename,true,":-D","456def")).to eq("<%= color('Task added', :green) %>")
+    end
+  end
+
+  context "del task" do
+    it "should delete a task" do
+      expect(Todo).to receive(:load_tasks).with(filename).and_return(new_task_list)
+      expect(Todo).to receive(:save_tasks).with(filename,one_todo_item).and_return(true)
+      expect(Todo::del_task(filename,2)).to eq("<%= color('Task deleted', :yellow) %>")
+    end
+
+    it "should delete nothing if wrong index" do
+      expect(Todo).to receive(:load_tasks).with(filename).and_return(new_task_list)
+      expect(Todo).not_to receive(:save_tasks).with(any_args)
+      expect(Todo::del_task(filename,99)).to eq("<%= color('No task deleted', :red) %>")
+    end
+  end
+
+  context "show tasks" do
+    it "should show nothing when no tasks in the list" do
+      expect(Todo).to receive(:load_tasks).with(filename).and_return(empty_task_list)
+      expect(Todo::show_tasks(filename,nil)).to eq("Listing tasks (all)\n")
+    end
+
+    it "should show all tasks when no tag given" do
+      expect(Todo).to receive(:load_tasks).with(filename).and_return(one_todo_item)
+      final = "Listing tasks (all)\n(1)\n\t taskid      : 123abc\n\t created_at  : #{created_at}\n\t description : <%= color(':-)', :yellow) %>\n"
+      expect(Todo::show_tasks(filename,nil)).to eq(final)
+    end
+
+    it "should show only tagged tasks when tag given" do
+      expect(Todo).to receive(:load_tasks).with(filename).and_return(new_task_list)
+      expect(Todo::show_tasks(filename,["a"])).to eq("Listing tasks ([\"a\"])\n")
+    end
+  end
+
+end

data/todo.gemspec

@@ -6,11 +6,11 @@ require 'todo/version'
 Gem::Specification.new do |spec|
   spec.name          = "todo"
   spec.version       = Todo::VERSION
-  spec.authors       = ["Lakshan Perera", "Aniket Pant"]
-  spec.email         = ["lakshan@web2media.net", "me@aniketpant.com"]
+  spec.authors       = ["Lakshan Perera", "Aniket Pant", "Dennis Theisen"]
+  spec.email         = ["lakshanlaktek.com"]
   spec.description   = %q{simple command line todo list manager}
   spec.summary       = %q{simple command line todo list manager}
-  spec.homepage      = %q{http://todo.rubyforge.org}
+  spec.homepage      = %q{http://github.com/laktek/todo}
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 2.6"
+  spec.add_development_dependency "rspec", "~> 3.0"
 
   spec.add_runtime_dependency "main", ">= 2.8.2"
   spec.add_runtime_dependency "highline", ">= 1.4.0"

metadata

@@ -1,80 +1,96 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: todo
-version: !ruby/object:Gem::Version 
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Lakshan Perera
 - Aniket Pant
+- Dennis Theisen
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-05-23 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.3"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - &id006 
-      - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2.6"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: main
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: main
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 2.8.2
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: highline
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.2
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.4.0
   type: :runtime
-  version_requirements: *id005
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
 description: simple command line todo list manager
-email: 
-- lakshan@web2media.net
-- me@aniketpant.com
-executables: 
+email:
+- lakshanlaktek.com
+executables:
 - todo
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".gitignore"
 - Gemfile
 - History.txt
 - LICENSE.txt
@@ -83,35 +99,33 @@ files:
 - bin/todo
 - lib/todo.rb
 - lib/todo/cli.rb
-- lib/todo/list.rb
-- lib/todo/store.rb
+- lib/todo/controller.rb
 - lib/todo/version.rb
-- spec/todo_list_spec.rb
-- spec/todo_store_spec.rb
+- spec/todo_controller_spec.rb
 - todo.gemspec
-homepage: http://todo.rubyforge.org
-licenses: 
+homepage: http://github.com/laktek/todo
+licenses:
 - MIT
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id006
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id006
+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.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: simple command line todo list manager
-test_files: 
-- spec/todo_list_spec.rb
-- spec/todo_store_spec.rb
+test_files:
+- spec/todo_controller_spec.rb

data/lib/todo/list.rb

@@ -1,25 +0,0 @@
-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

@@ -1,26 +0,0 @@
-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/spec/todo_list_spec.rb

@@ -1,63 +0,0 @@
-require 'todo/list'
-
-describe "Todo::List" do
-
-  describe "filtering by tag" do
-    before(:each) do
-      @todolist  = Todo::List["dummy task" => ["added:31-07-2008", "important"], "Buy milk" => ["important", "home"]]
-      @list_with_task_tagged_home = {"Buy milk" => ["important", "home"]}
-    end
-
-    it "should return matched items by tag" do
-      @todolist.tagged("important").should == @todolist
-    end
-
-    it "should filter items by tags" do
-      @todolist.tagged("home").should == @list_with_task_tagged_home
-    end
-
-    it "should be able to apply chain of filters" do
-      @todolist.tagged("important").tagged("home").should == @list_with_task_tagged_home
-    end
-
-  end
-
-  describe "add" do
-    before(:each) do
-      @todolist =Todo::List["dummy task" => ["added:31-07-2008", "important"]]
-      @after_list  =Todo::List["dummy task" => ["added:31-07-2008", "important"], "Buy milk" => []]
-    end
-
-    it "should add new item to the exisitng task list" do
-      @todolist.add("Buy milk").should == @after_list
-    end
-
-    it "should accept list of tags with the item" do
-      list_with_tags_added = {"dummy task" => ["added:31-07-2008", "important"], "Buy milk" => ["important", "assigned:mom"]}
-
-      @todolist.add("Buy milk", "important", "assigned:mom").should == list_with_tags_added
-    end
-
-  end
-
-  describe "remove" do
-    before(:each) do
-      @todolist  =Todo::List["dummy task" => ["added:31-07-2008", "important"], "Buy milk" => []]
-      @after_list =Todo::List["dummy task" => ["added:31-07-2008", "important"]]
-    end
-
-    it "should remove a task by name" do
-      @todolist.remove("Buy milk").should == @after_list
-    end
-
-    it "should remove a task by its index" do
-      @todolist.remove(2).should == @after_list
-    end
-
-    it "should return nil if the task is not found" do
-      @todolist.remove("not done").should == nil
-    end
-
-  end
-
-end

data/spec/todo_store_spec.rb

@@ -1,8 +0,0 @@
-require 'todo/store'
-
-describe "Todo::CLI" do
-  it "should read the YAML file and output Todo::List hash" do
-    #list = {"Buy milk" => ["important", "home"]}
-    #Todo::Store.read(list.to_yaml).should be_an_instance_of(Todo::List)
-  end
-end