todotxt 0.1.0 → 0.2.0

data/lib/todotxt/version.rb

@@ -1,3 +1,3 @@
 module Todotxt
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'.freeze
 end

data/spec/config_spec.rb

@@ -1,52 +1,72 @@
-require "spec_helper"
-require "todotxt/config"
+require 'spec_helper'
+require 'todotxt/config'
 
 describe Todotxt::Config do
   before(:each) do
-    ENV["HOME"] = File.join "/", "tmp"
-    @config_file = File.join ENV["HOME"], ".todotxt.cfg"
+    ENV['HOME'] = File.join '/', 'tmp'
+    @config_file = File.join ENV['HOME'], '.todotxt.cfg'
   end
 
-  context "valid config" do
+  context 'valid config' do
     before(:each) do
-      @cfg = Todotxt::Config.new "spec/fixtures/config_new.cfg"
+      @cfg = Todotxt::Config.new(config_file: 'spec/fixtures/config_new.cfg')
     end
 
     it 'should have a "files"' do
-      @cfg.files.keys.should include "todo"
+      expect(@cfg.files.keys).to include('todo')
     end
 
     it 'should not be deprecated' do
-      @cfg.should_not be_deprecated
+      expect(@cfg).not_to be_deprecated
+    end
+
+    describe '#files' do
+      it 'should return a list of TodoFile objects as configured in config' do
+        expect(@cfg.files).to be_kind_of(Hash)
+        expect(@cfg.files).to match('todo' => Todotxt::TodoFile.new('/tmp/todo.txt'))
+      end
+    end
+    describe '#file' do
+      it "should return the 'todo' file from the 'files' hash" do
+        expect(@cfg.file).to match(@cfg.files['todo'])
+      end
+    end
+  end
+
+  context 'invalid config' do
+    it 'not allow both "files" and "todo_txt_path"' do
+      expect do
+        Todotxt::Config.new(config_file: 'spec/fixtures/config_both.cfg')
+      end.to raise_error 'Bad configuration file: use either files or todo_txt_path'
+    end
+
+    it 'should complain when there is no "todo" in files and no file is requested' do
+      expect do
+        Todotxt::Config.new(config_file: 'spec/fixtures/config_no_todo.cfg').file
+      end.to raise_error "Bad configuration file: 'todo' is a required file."
     end
   end
 
-  context "old style config" do
+  context 'old style config' do
     before(:each) do
-      @cfg = Todotxt::Config.new "spec/fixtures/config_old.cfg"
+      @cfg = Todotxt::Config.new(config_file: 'spec/fixtures/config_old.cfg')
     end
 
     it 'should place "todo_txt_path" under files' do
-      @cfg.files.keys.should include "todo"
+      expect(@cfg.files.keys).to include('todo')
     end
 
     it 'should be deprecated' do
-      @cfg.should be_deprecated
+      expect(@cfg).to be_deprecated
     end
   end
 
-  it 'not allow both "files" and "todo_txt_path"' do
-    expect do
-      Todotxt::Config.new "spec/fixtures/config_both.cfg"
-    end.to raise_error "Bad configuration file: use either files or todo_txt_path"
-  end
-
-  context "#generate!" do
+  context '#generate!' do
     it 'should create a template' do
-      File.delete @config_file if File.exists? @config_file
+      File.delete @config_file if File.exist? @config_file
       todo = Todotxt::Config.new
       todo.generate!
-      File.exists?(@config_file).should be_true
+      expect(File.exist?(@config_file)).to be_truthy
     end
   end
 end

data/spec/fixtures/config_no_todo.cfg

@@ -0,0 +1,2 @@
+[files]
+  done = "/tmp/done.txt"

data/spec/todo_spec.rb

@@ -1,141 +1,128 @@
-require "spec_helper"
-require "todotxt/todo"
+require 'spec_helper'
+require 'todotxt/todo'
 
 describe Todotxt::Todo do
-
-  it "creates a todo item string" do
-    todo = Todotxt::Todo.new "an item"
-    todo.to_s.should eql("an item")
+  it 'creates a todo item string' do
+    todo = Todotxt::Todo.new 'an item'
+    expect(todo.to_s).to match('an item')
   end
 
-  it "parses metadata when creating a simple item" do
-    todo = Todotxt::Todo.new "x an item +project1 +project2 @context1 @context2"
-
-    todo.to_s.should eql "x an item +project1 +project2 @context1 @context2"
-    todo.priority.should eql nil
-    todo.projects.should eql ["+project1", "+project2"]
-    todo.contexts.should eql ["@context1", "@context2"]
-    todo.done.should eql true
+  it 'parses metadata when creating a simple item' do
+    todo = Todotxt::Todo.new 'x an item +project1 +project2 @context1 @context2'
+    expect(todo.to_s).to match('x an item +project1 +project2 @context1 @context2')
+    expect(todo.priority).to be_nil
+    expect(todo.projects).to contain_exactly('+project1', '+project2')
+    expect(todo.contexts).to contain_exactly('@context1', '@context2')
+    expect(todo.done).to be_truthy
   end
 
-  it "parses metadata when creating an item with priority" do
-    todo = Todotxt::Todo.new "(A) x an item +project1 +project2 @context1 @context2"
-
-    todo.to_s.should eql "(A) x an item +project1 +project2 @context1 @context2"
-    todo.priority.should eql "A"
-    todo.projects.should eql ["+project1", "+project2"]
-    todo.contexts.should eql ["@context1", "@context2"]
-    todo.done.should eql true
+  it 'parses metadata when creating an item with priority' do
+    todo = Todotxt::Todo.new '(A) x an item +project1 +project2 @context1 @context2'
+    expect(todo.to_s).to match('(A) x an item +project1 +project2 @context1 @context2')
+    expect(todo.priority).to match('A')
+    expect(todo.projects).to contain_exactly('+project1', '+project2')
+    expect(todo.contexts).to contain_exactly('@context1', '@context2')
+    expect(todo.done).to be_truthy
   end
 
-  it "parses a due date" do
-    todo = Todotxt::Todo.new "(A) x 2012-12-12 an item +project1 +project2 @context1 @context2"
-    todo.due.should eql Chronic.parse("12 December 2012").to_date
+  it 'parses a due date' do
+    todo = Todotxt::Todo.new '(A) x 2012-12-12 an item +project1 +project2 @context1 @context2'
+    expect(todo.due).to eql(Chronic.parse('12 December 2012').to_date)
 
-    todo = Todotxt::Todo.new "2012-1-2 an item +project1 +project2 @context1 @context2"
-    todo.due.should eql Chronic.parse("2 January 2012").to_date
+    todo = Todotxt::Todo.new '2012-1-2 an item +project1 +project2 @context1 @context2'
+    expect(todo.due).to eql(Chronic.parse('2 January 2012').to_date)
 
-    todo = Todotxt::Todo.new "42 folders"
-    todo.due.should be_nil
+    todo = Todotxt::Todo.new '42 folders'
+    expect(todo.due).to be_nil
   end
 
-  it "stores line number when creating an item" do
-    todo = Todotxt::Todo.new "an item", "2"
-
-    todo.line.should eql "2"
+  it 'stores line number when creating an item' do
+    todo = Todotxt::Todo.new 'an item', '2'
+    expect(todo.line).to match('2')
   end
 
-  it "sets an item as done" do
-    todo = Todotxt::Todo.new "an item"
-
+  it 'sets an item as done' do
+    todo = Todotxt::Todo.new 'an item'
     todo.do
 
-    todo.to_s.should eql "x an item"
-    todo.done.should eql true
+    expect(todo.to_s).to match 'x an item'
+    expect(todo.done).to be_truthy
   end
 
-  it "sets an item as not done" do
-    todo = Todotxt::Todo.new "x an item"
+  it 'sets an item as not done' do
+    todo = Todotxt::Todo.new 'x an item'
 
     todo.undo
 
-    todo.to_s.should eql "an item"
-    todo.done.should eql false
+    expect(todo.to_s).to match('an item')
+    expect(todo.done).to be_falsy
   end
 
-  it "adds priority to an item" do
-    todo = Todotxt::Todo.new "an item"
-
-    todo.prioritize "a"
+  it 'adds priority to an item' do
+    todo = Todotxt::Todo.new 'an item'
+    todo.prioritize 'a'
 
-    todo.to_s.should eql "(A) an item"
-    todo.priority.should eql "A"
+    expect(todo.to_s).to match('(A) an item')
+    expect(todo.priority).to match('A')
   end
 
-  it "changes priority of an item" do
-    todo = Todotxt::Todo.new "(A) an item"
-
-    todo.prioritize "z"
+  it 'changes priority of an item' do
+    todo = Todotxt::Todo.new '(A) an item'
+    todo.prioritize 'z'
 
-    todo.to_s.should eql "(Z) an item"
-    todo.priority.should eql "Z"
+    expect(todo.to_s).to match('(Z) an item')
+    expect(todo.priority).to match('Z')
   end
 
-  it "removes priority from an item" do
-    todo = Todotxt::Todo.new "(A) an item"
-
+  it 'removes priority from an item' do
+    todo = Todotxt::Todo.new '(A) an item'
     todo.prioritize
 
-    todo.to_s.should eql "an item"
-    todo.priority.should eql nil
+    expect(todo.to_s).to match('an item')
+    expect(todo.priority).to be_nil
   end
 
-  it "appends text to an item" do
-    todo = Todotxt::Todo.new "an item"
-
-    todo.append "more text"
+  it 'appends text to an item' do
+    todo = Todotxt::Todo.new 'an item'
+    todo.append 'more text'
 
-    todo.to_s.should eql "an item more text"
+    expect(todo.to_s).to match('an item more text')
   end
 
-  it "prepends text to an item" do
-    todo = Todotxt::Todo.new "an item"
-
-    todo.prepend "more text"
+  it 'prepends text to an item' do
+    todo = Todotxt::Todo.new 'an item'
+    todo.prepend 'more text'
 
-    todo.to_s.should eql "more text an item"
+    expect(todo.to_s).to match('more text an item')
   end
 
-  it "preserves priority when prepending text to an item" do
-    todo = Todotxt::Todo.new "(A) an item"
+  it 'preserves priority when prepending text to an item' do
+    todo = Todotxt::Todo.new '(A) an item'
+    todo.prepend 'more text'
 
-    todo.prepend "more text"
-
-    todo.to_s.should eql "(A) more text an item"
-    todo.priority.should eql "A"
+    expect(todo.to_s).to match('(A) more text an item')
+    expect(todo.priority).to match('A')
   end
 
-  it "replaces an item with new text" do
-    todo = Todotxt::Todo.new "an item"
-
-    todo.replace "(A) a replacement item"
+  it 'replaces an item with new text' do
+    todo = Todotxt::Todo.new 'an item'
+    todo.replace '(A) a replacement item'
 
-    todo.to_s.should eql "(A) a replacement item"
-    todo.priority.should eql "A"
+    expect(todo.to_s).to match('(A) a replacement item')
+    expect(todo.priority).to match('A')
   end
 
-  it "sorts based on line number" do
-    todo1 = Todotxt::Todo.new "an item 1", 1
-    todo2 = Todotxt::Todo.new "an item 2", 2
+  it 'sorts based on line number' do
+    todo1 = Todotxt::Todo.new 'an item 1', 1
+    todo2 = Todotxt::Todo.new 'an item 2', 2
 
-    (todo1 <=> todo2).should eql -1
+    expect(todo1 <=> todo2).to eql -1
   end
 
-  it "values items with priority higher when sorting" do
-    todo1 = Todotxt::Todo.new "an item 1", 1
-    todo2 = Todotxt::Todo.new "(A) an item 2", 2
+  it 'values items with priority higher when sorting' do
+    todo1 = Todotxt::Todo.new 'an item 1', 1
+    todo2 = Todotxt::Todo.new '(A) an item 2', 2
 
-    (todo1 <=> todo2).should eql 1
+    expect(todo1 <=> todo2).to eql 1
   end
-
 end

data/spec/todofile_spec.rb

@@ -1,31 +1,36 @@
-require "spec_helper"
-require "todotxt/config"
-require "todotxt/todofile"
+require 'spec_helper'
+require 'todotxt/config'
+require 'todotxt/todofile'
 
 describe Todotxt::TodoFile do
   before(:each) do
-    @todo_path = "/tmp/todo.txt"
-    Todotxt::Config.any_instance.stub(:files) do
-      {todo:@todo_path}
-    end
+    @todo_path = '/tmp/todo.txt'
+    allow_any_instance_of(Todotxt::Config).to receive(:files).and_return(todo: @todo_path)
   end
   after(:each) do
-    File.delete @todo_path if File.exists? @todo_path
+    File.delete @todo_path if File.exist? @todo_path
   end
 
   it 'should create a new file when initializing' do
     file = Todotxt::TodoFile.new(@todo_path)
-    file.class.should == Todotxt::TodoFile
+    expect(file).to be_kind_of(Todotxt::TodoFile)
   end
 
   it 'should create a new file via the key in config' do
     file = Todotxt::TodoFile.from_key(:todo)
-    file.class.should == Todotxt::TodoFile
+    expect(file).to be_kind_of(Todotxt::TodoFile)
   end
 
   it 'should throw an error for undefined keys' do
-    expect { 
+    expect do
       Todotxt::TodoFile.from_key(:does_not_exist)
-    }.to raise_error "Key not found in config"
+    end.to raise_error 'Key not found in config'
+  end
+
+  describe '#==' do
+    it 'should compare using paths' do
+      expect(Todotxt::TodoFile.new(@todo_path)).to eq(Todotxt::TodoFile.new(@todo_path))
+      expect(Todotxt::TodoFile.new(@todo_path)).not_to eq(Todotxt::TodoFile.new('/other/path'))
+    end
   end
 end

data/spec/todolist_spec.rb

@@ -1,117 +1,116 @@
-require "spec_helper"
-require "todotxt/todolist"
-require "todotxt/todofile"
+require 'spec_helper'
+require 'todotxt/todolist'
+require 'todotxt/todofile'
 
 describe Todotxt::TodoList do
-
-  describe "with simple list" do
+  describe 'with simple list' do
     before :each do
-      @file = Todotxt::TodoFile.new File.join(File.dirname(__FILE__), "fixtures", "simple_todo.txt")
+      @file = Todotxt::TodoFile.new File.join(File.dirname(__FILE__), 'fixtures', 'simple_todo.txt')
       @list = Todotxt::TodoList.new @file
     end
 
-    it "parses a file on creation" do
-      @list.todos[0].to_s.should eql "First item"
-      @list.todos[1].to_s.should eql "Second item"
-      @list.todos[2].to_s.should eql "Third item"
-      @list.todos[3].to_s.should eql "x First done item"
+    it 'parses a file on creation' do
+      expect(@list.todos[0].to_s).to match('First item')
+      expect(@list.todos[1].to_s).to match('Second item')
+      expect(@list.todos[2].to_s).to match('Third item')
+      expect(@list.todos[3].to_s).to match('x First done item')
 
-      @list.todos[0].line.should eql 1
-      @list.todos[1].line.should eql 2
-      @list.todos[2].line.should eql 3
-      @list.todos[3].line.should eql 4
+      expect(@list.todos[0].line).to eql 1
+      expect(@list.todos[1].line).to eql 2
+      expect(@list.todos[2].line).to eql 3
+      expect(@list.todos[3].line).to eql 4
     end
 
-    it "adds a new item" do
-      @list.add "Fourth item"
-
-      @list.todos[4].to_s.should eql "Fourth item"
-      @list.todos[4].line.should eql 5
+    it 'adds a new item' do
+      @list.add 'Fourth item'
+      expect(@list.todos[4].to_s).to match('Fourth item')
+      expect(@list.todos[4].line).to eql 5
     end
 
-    it "removes an item" do
+    it 'removes an item' do
       @list.remove 1
-
-      @list.todos[0].to_s.should eql "Second item"
+      expect(@list.todos[0].to_s).to match('Second item')
     end
 
-    it "finds item by line" do
+    it 'finds item by line' do
       todo = @list.find_by_line 3
-
-      todo.to_s.should eql "Third item"
+      expect(todo.to_s).to match('Third item')
     end
 
-    it "filters list when searching" do
-      @list.filter "First"
-
-      @list.todos.count.should eql 1
+    it 'filters list when searching' do
+      @list.filter 'First'
+      expect(@list.todos.count).to eql 1
     end
 
-    it "filters list when searching case-sensitive" do
-      @list.filter "first"
-
-      @list.todos.count.should eql 1
+    it 'filters list when searching case-sensitive' do
+      @list.filter 'first'
+      expect(@list.todos.count).to eql 1
     end
 
-    it "fetches items for a certain date" do
-      @list.add "2012-12-12 item"
-      date = DateTime.parse("2012-12-12")
-      @list.on_date(date).count.should eql 1
-      @list.on_date(date).should eql [@list.todos.last]
+    it 'fetches items for a certain date' do
+      @list.add '2012-12-12 item'
+      date = DateTime.parse('2012-12-12')
+      expect(@list.on_date(date).count).to eql 1
+      expect(@list.on_date(date)).to match([@list.todos.last])
     end
 
-    it "fetchs items before a cereain date" do
-      @list.add "2012-11-11 item"
-      @list.add "2012-12-12 item"
-      date = DateTime.parse("2012-12-12")
-      @list.before_date(date).count.should eql 1
+    it 'fetchs items before a cereain date' do
+      @list.add '2012-11-11 item'
+      @list.add '2012-12-12 item'
+      date = DateTime.parse('2012-12-12')
+      expect(@list.before_date(date).count).to eql 1
     end
 
-    it "includes done items in search when told to do so" do
-      @list.filter "first", :with_done => true
-
-      @list.todos.count.should eql 2
+    it 'includes done items in search when told to do so' do
+      @list.filter 'first', with_done: true
+      expect(@list.todos.count).to eql 2
     end
 
-    it "only includes done items in search when told to do so" do
-      @list.filter "first", :only_done => true
-
-      @list.todos.count.should eql 1
+    it 'only includes done items in search when told to do so' do
+      @list.filter 'first', only_done: true
+      expect(@list.todos.count).to eql 1
     end
 
-    it "renders plain text" do
+    it 'renders plain text' do
       comparison_string = <<EOF
 First item
 Second item
 Third item
 x First done item
 EOF
-      @list.to_txt.should eql comparison_string.strip
+      expect(@list.to_txt).to match(comparison_string.strip)
     end
   end
 
-  describe "with complex list" do
+  describe 'with complex list' do
     before :each do
-      @file = Todotxt::TodoFile.new File.join(File.dirname(__FILE__), "fixtures", "complex_todo.txt")
+      @file = Todotxt::TodoFile.new File.join(File.dirname(__FILE__), 'fixtures', 'complex_todo.txt')
       @list = Todotxt::TodoList.new @file
     end
 
-    it "sorts itself automatically on parse" do
-      @list.todos[0].to_s.should eql "(A) an item"
-      @list.todos[0].line.should eql 3
+    it 'sorts itself automatically on parse' do
+      expect(@list.todos[0].to_s).to match('(A) an item')
+      expect(@list.todos[0].line).to eql(3)
     end
 
-    it "re-sorts itself after adding a new item" do
-      @list.add "(B) A new item"
+    it 're-sorts itself after adding a new item' do
+      @list.add '(B) A new item'
 
-      @list.todos[1].to_s.should eql "(B) A new item"
-      @list.todos[1].line.should eql 4
+      expect(@list.todos[1].to_s).to match('(B) A new item')
+      expect(@list.todos[1].line).to eql(4)
     end
 
-    it "lists all projects and contexts in the list" do
-      @list.projects.should eql ["+project1", "+project2"]
-      @list.contexts.should eql ["@context1", "@context2"]
+    it 'lists all projects and contexts in the list' do
+      expect(@list.projects).to contain_exactly('+project1', '+project2')
+      expect(@list.contexts).to contain_exactly('@context1', '@context2')
     end
   end
 
+  describe 'with line-number provided' do
+    it 'starts counting at the number' do
+      @file = Todotxt::TodoFile.new File.join(File.dirname(__FILE__), 'fixtures', 'simple_todo.txt')
+      @list = Todotxt::TodoList.new @file, 42
+      expect(@list.todos[0].line).to eql 43
+    end
+  end
 end