rubdo 0.2.6 → 0.3.0

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format progress
+--fail-fast

data/README.md

@@ -2,47 +2,69 @@
 
 Why does todo applications need to be so complicated?
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+Since version `0.3.0`, `rubdo` can handle several TODO files with
+environment variables. So you can change TODO file by setting:
 
-    gem 'rubdo'
+```bash
+$ export TODO_FILE="PATH/TO/TODO_FILE" # i.e ~/.tasks/Work.yml
+```
 
-And then execute:
+When you are done with your other TODO file, just simply kill the
+environment variable or reload the shell
 
-    $ bundle
+Here are the available commands for `rubdo`
 
-Or install it yourself as:
+```bash
+Commands for rubdo:
+-------------------
+add/a [task description] - Add a new task. If the description is empty, $EDITOR is opened
+list/ls - Lists all tasks
+done/d [task id] - Complete a task
+edit/e [task id] - Opens up $EDITOR to edit the task description
+remove/rm [task id] - Deletes the specific task, same as done
+help - Prints out this information
+```
+
+`rubdo` createas _~/.tasks_ where it holds the YAML file with the todos inside.
+If you want to keep your todos synced accross your machines, make a symlink to say
+directory inside of _~/Dropbox_
 
-    $ gem install rubdo
+```bash
+$ ln -s ~/Dropbox/tasks/ ~/.tasks
+```
 
-## Usage
+ Make sure to save your todos first!
 
-Here are the available commands for `rubdo`
+A tip is to alias `rubdo` to `t` for easier typing
+for `bash` and `zsh`
 
-    Commands for rubdo:
-    ------------------     
-    add/a [task description] - Add a new task. If the description is empty, $EDITOR is opened
-    list/ls - Lists all tasks
-    done/d [task id] - Complete a task
-    edit/e [task id] - Opens up $EDITOR to edit the task description
-    remove/rm [task id] - Deletes the specific task, same as done
-    help - Prints out this information
+```bash
+alias t="rubdo"
+```
 
-`rubdo` createas _~/.tasks_ where it holds the YAML files with the todos inside.
-If you want to keep your todos synced accross your machines, make a symlink to say
-a directory inside of _~/Dropbox_ 
+and add that to your _{bash, zsh}rc_
 
-    $ ln -s ~/Dropbox/tasks/ ~/.tasks
+## Installation
 
-Make sure to save your todos first!
+Add this line to your application's Gemfile:
 
-A tip is to alias `rubdo` to `t` for easier typing
-for `bash` and `zsh`
+```bash
+gem 'rubdo'
+```
+
+And then execute:
 
-    alias t="rubdo"
+```bash
+$ bundle
+```
+
+Or install it yourself as:
 
-and add that to your _{bash, zsh}rc_ 
+```bash
+$ gem install rubdo
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,9 +1,11 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
 
+RSpec::Core::RakeTask.new(:spec)
 task :default => :spec
-desc 'Run all tests' do
-  task :spec do
-    `rspec --color --format nested spec/*`
-  end
+
+task :console do
+  sh "pry -I lib -r rubdo"
 end
+task c: :console

data/bin/rubdo

@@ -6,7 +6,7 @@ require 'abbrev'
 cli = Rubdo::CLI.new
 methods = Rubdo::CLI.public_instance_methods(false).map(&:to_s).abbrev
 cli.list if ARGV[0].nil?
-begin 
+begin
   cli.send methods[ARGV[0]] unless ARGV[0].nil?
 rescue
   puts "cowardly refuses" unless methods[ARGV[0]]

data/lib/rubdo.rb

@@ -1,4 +1,3 @@
-require "rubdo/version"
-require 'rubdo/cli'
-require 'rubdo/item'
-require 'rubdo/list'
+Dir[File.dirname(__FILE__) + '/rubdo/**/*.rb'].each do |file|
+  require file
+end

data/lib/rubdo/cli.rb

@@ -3,7 +3,7 @@ require 'tempfile'
 module Rubdo
   class CLI
     def initialize
-      todos = List.read(File.expand_path('~/.tasks/Todo.yml'))
+      todos = List.read(todo_file)
       @list = List.new(todos)
       @id = ARGV[1].to_i - 1
     end
@@ -12,14 +12,7 @@ module Rubdo
       if ARGV[1]
         @list.add ARGV[1]
       else
-        tmp_file = Tempfile.new('new_task')
-        system("$EDITOR #{tmp_file.path}")
-        unless File.read(tmp_file.path).empty?
-          @list.add File.read(tmp_file).chomp
-          tmp_file.delete
-        else
-          puts "aborted due to empty file"
-        end
+        Tempfile.open('new_task') { |tf| @list.add Rubdo::Editor.add(tf.path) }
       end
       save
     end
@@ -28,20 +21,16 @@ module Rubdo
       @list.done @id
       save
     end
+    alias_method :rm, :done
 
     def list
-      @list.to_a.each_with_index { |item, index| puts "#{index + 1}: #{item.description}" }
-      puts "no tasks" if @list.to_a.empty?
+      list_tasks unless @list.to_a.empty?
     end
+    alias_method :ls, :list
 
     def edit
-      abort("not a valid id") if @id == -1 or @id > @list.to_a.length
-
-      tmp_file = Tempfile.new('new_description')
-      File.open(tmp_file.path, 'w') { |f| f.write(@list.to_a[@id].description) }
-      system("$EDITOR #{tmp_file.path}")
-      @list.to_a[@id].description = File.read(tmp_file).chomp
-      tmp_file.delete
+      abort("not a valid id") if @id > @list.to_a.size
+      Tempfile.open('new_description') { |tf| task.description = Rubdo::Editor.edit(tf.path, task.description) }
       save
     end
 
@@ -57,13 +46,22 @@ help - Prints out this information
       HELP
     end
 
-    alias_method :ls, :list
-    alias_method :rm, :done
-
     private
 
     def save
       @list.write
     end
+
+    def list_tasks
+      @list.to_a.each_with_index { |item, index| puts "#{index + 1}: #{item.description}" }
+    end
+
+    def task
+      @list.to_a[@id]
+    end
+
+    def todo_file
+      @todo_file ||= '~/.tasks/Todo.yml'
+    end
   end
 end

data/lib/rubdo/editor.rb

@@ -0,0 +1,29 @@
+module Rubdo
+  class Editor
+
+    def self.edit(file, description)
+      write_description(file, description)
+      open_with_editor(file)
+      read_description(file)
+    end
+
+    def self.add(file)
+      open_with_editor(file)
+      read_description(file)
+    end
+
+    private
+
+    def self.open_with_editor(file)
+      system "$EDITOR #{file}"
+    end
+
+    def self.write_description(file, description)
+      File.open(file, 'w') { |f| f.write(description) }
+    end
+
+    def self.read_description(file)
+      File.read(file).chomp
+    end
+  end
+end

data/lib/rubdo/item.rb

@@ -7,7 +7,7 @@ module Rubdo
     end
 
     def to_s
-      self.description
+      description
     end
   end
 end

data/lib/rubdo/list.rb

@@ -1,45 +1,42 @@
 require 'time'
 require 'yaml'
-require 'fileutils'
 
 module Rubdo
   class List
-    attr_accessor :items, :storage
 
-    def self.read(file)
-      todos = YAML.load_file(file) if File.exists? file
-      todos ||=[]
+    attr_reader :items, :todo_file
 
-      todos
+    def self.read(file = nil)
+      todo_file = File.expand_path(file)
+      items = File.exists?(todo_file) ? YAML.load_file(todo_file) : []
+      { items: items, todo_file: todo_file }
     end
 
-    def initialize(todos)
-      @items = todos
-      @storage = File.expand_path('~/.tasks/Todo.yml')
-      FileUtils.mkdir_p File.dirname @storage
+    def initialize(options)
+      @items = options.fetch(:items) { [] }
+      @todo_file = options.fetch(:todo_file) { File.expand_path("~/.tasks/Todo.yml") }
     end
 
     def add(description)
-      @items << Item.new(description)
+      items << Item.new(description)
     end
+    alias_method :<<, :add
 
     def done(id)
-      @items.delete_at id
+      items.delete_at id
     end
 
     def edit(id)
-      @items[id]
+      items[id]
     end
 
     def write
-      File.open(self.storage, 'w') { |todos| todos.write(@items.to_yaml) }
+      File.open(todo_file, 'w') { |f| f.write(items.to_yaml) }
     end
+    alias_method :save, :write
 
     def to_a
-      self.items
+      items
     end
-
-    alias_method :<<, :add
-    alias_method :save, :write
   end
 end

data/lib/rubdo/version.rb

@@ -1,3 +1,3 @@
 module Rubdo
-  VERSION = "0.2.6"
+  VERSION = "0.3.0"
 end

data/spec/item_spec.rb

@@ -0,0 +1,11 @@
+require_relative '../lib/rubdo/item'
+
+describe Rubdo::Item do
+  let(:item) { Rubdo::Item.new 'New todo item' }
+
+  describe '#new' do
+    it 'assigns a description to the item' do
+      item.description.should eq 'New todo item'
+    end
+  end
+end

data/spec/list_spec.rb

@@ -0,0 +1,55 @@
+require_relative '../lib/rubdo/list'
+require_relative '../lib/rubdo/item'
+
+describe Rubdo::List do
+  let(:list) { Rubdo::List.new items: [], todo_file: '/tmp/todo.yml' }
+
+  describe '#new' do
+    let(:empty_list) { Rubdo::List.new({})}
+
+    context 'with parameters' do
+      it 'sets `items` and `todo_file`' do
+        list.items.should eq []
+        list.todo_file.should eq '/tmp/todo.yml'
+      end
+    end
+
+    context 'without parameters' do
+      it 'fallback for `items` and `todo_file`' do
+        empty_list.items.should eq []
+        empty_list.todo_file.should eq File.expand_path('~/.tasks/Todo.yml')
+      end
+    end
+  end
+
+  describe '#add' do
+    it 'adds 3 items to the list' do
+      list.add 'Buy milk'
+      list.add 'Buy beer'
+      list.add 'But peanuts'
+
+      list.to_a.size.should eq 3
+    end
+  end
+
+  describe '#done' do
+    it 'deletes an item from the list' do
+      list.add 'Watch TV'
+      list.add 'Walk the dog'
+      list.to_a.size.should eq 2
+      list.done 0
+
+      list.to_a.size.should eq 1
+    end
+  end
+
+  describe '#edit' do
+    it 'changes the description of a certain task' do
+      list.add "I can't go out, I'm sik"
+      list.edit(0).description = "I can't go out, I'm sick"
+
+      list.to_a[0].description.should eq "I can't go out, I'm sick"
+      list.to_a.size.should eq 1
+    end
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rubdo
 version: !ruby/object:Gem::Version
-  version: 0.2.6
   prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Teo Ljungberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-22 00:00:00.000000000 Z
+date: 2013-01-19 00:00:00.000000000 Z
 dependencies: []
 description: My take on the todo-applications
 email:
@@ -21,6 +21,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rake_tasks
+- .rspec
 - Gemfile
 - LICENSE
 - README.md
@@ -28,11 +29,13 @@ files:
 - bin/rubdo
 - lib/rubdo.rb
 - lib/rubdo/cli.rb
+- lib/rubdo/editor.rb
 - lib/rubdo/item.rb
 - lib/rubdo/list.rb
 - lib/rubdo/version.rb
 - rubdo.gemspec
-- spec/rubdo_tests.rb
+- spec/item_spec.rb
+- spec/list_spec.rb
 homepage: http://github.com/metamorfos/rubdo
 licenses: []
 post_install_message: 
@@ -40,17 +43,17 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -58,4 +61,5 @@ signing_key:
 specification_version: 3
 summary: My take on the todo-applications
 test_files:
-- spec/rubdo_tests.rb
+- spec/item_spec.rb
+- spec/list_spec.rb

data/spec/rubdo_tests.rb

@@ -1,55 +0,0 @@
-require 'rspec'
-require 'rubdo'
-
-describe Rubdo::Item do
-  before do
-    @item = Rubdo::Item.new('New todo item')
-  end
-
-  describe '#new' do
-    it 'assigns a text value to rubdo' do
-      @item.description.should eq('New todo item')
-    end
-  end
-end
-
-describe Rubdo::List do
-  before do
-    @list = Rubdo::List.new(Rubdo::List.read(File.join(File.dirname(__FILE__), 'test.yml')))
-  end
-
-  describe '#add' do
-    it 'adds 3 todo items' do
-      @list.add('Buy milk')
-      @list.add('Buy beer')
-      @list.add('But peanuts')
-      @list.to_a.size.should eq(3)
-    end
-  end
-
-  describe '#done' do
-    before do
-      @list = Rubdo::List.new(Rubdo::List.read(File.join(File.dirname(__FILE__), 'test.yml')))
-    end
-
-    it 'deletes a todo item' do
-      @list.add('Watch TV')
-      @list.add('Walk the dog')
-      @list.done(0).description.should eq('Watch TV')
-      @list.to_a.size.should eq(1)
-    end
-  end
-
-  describe '#edit' do
-    before do
-      @list = Rubdo::List.new(Rubdo::List.read(File.join(File.dirname(__FILE__), 'test.yml')))
-    end
-
-    it 'edits a task' do
-      @list.add("I can't go out, I'm sik")
-      @list.edit(0).description = "I can't go out, I'm sick"
-      @list.to_a[0].description.should eq("I can't go out, I'm sick")
-      @list.to_a.size.should eq(1)
-    end
-  end
-end