todo-txt 0.6 → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87c3206db6b8a924eeedaaee0699cbaa9a63ea0f
-  data.tar.gz: ba6c31c870bd51c7a191a250bf20c9e1a8fbb5ea
+  metadata.gz: dd4d9a9131316d54020bfc771727481a05a7694f
+  data.tar.gz: 98e9a7d6a3ba5070db9521140d7d2f340a59cc27
 SHA512:
-  metadata.gz: 0ee77ef0490c7b423a52f779b810af66521ed1ed253560cd08c5a1b207102fcf36e4ab6d3f78666039c49d748c27e9d96d2149e28eeb0d2b3ad60e7cc6307760
-  data.tar.gz: 82050a6db87b76ef1c3ab51c428d26b7f045242628eeebbd3817b1c884634f73f159004435db20b9967bf40feb99a0d043afb4dab5502d9d7389417ba32909f9
+  metadata.gz: 5d7c8d30855037df15053d219e4051dbd2f93d29bca14fa2f7477b706d634a433a282f9e51d3a7239b92d63f5e47bf291463846c5f663ac19b31cff197e0772a
+  data.tar.gz: 1cd0e7eed6b6de21fc4e6d19b8addff687f0c513c1c823441696ff8dae4c9466ac9ca3283fa53290d6e2525f518c89ace94dafef66895b3b8fe24a1db978fd89

data/.travis.yml

@@ -1,5 +1,4 @@
 language: ruby
-rvm:
 rvm:
   - 2.0
   - 2.1
@@ -9,3 +8,5 @@ rvm:
   - jruby-9000
   - jruby-head
   - ruby-head
+before_install: gem install bundler -v 1.10.6
+script: bundle exec rspec

data/README.md

@@ -1,15 +1,18 @@
 # Todo.txt
 
-[![Development Build Status](https://secure.travis-ci.org/samwho/todo-txt-gem.png?branch=develop)](http://travis-ci.org/samwho/todo-txt-gem)
-[![Master Build Status](https://secure.travis-ci.org/samwho/todo-txt-gem.png?branch=master)](http://travis-ci.org/samwho/todo-txt-gem)
+[![Gem Version](http://img.shields.io/gem/v/todo-txt.svg)](https://rubygems.org/gems/todo-txt)
+[![Build Status](https://travis-ci.org/samwho/todo-txt-gem.svg?branch=master)](https://travis-ci.org/samwho/todo-txt-gem)
 
 This is a Ruby client library for Gina Trapani's
 [todo.txt](https://github.com/ginatrapani/todo.txt-cli/). It allows for easy
-parsing of task lists and tasks in the todo.txt format.
+management of task lists and tasks in the todo.txt format.
 
 Find the project on GitHub:
 [http://github.com/samwho/todo-txt-gem](http://github.com/samwho/todo-txt-gem).
 
+Find the full API docs on Rubydoc.info:
+[http://www.rubydoc.info/gems/todo-txt](http://www.rubydoc.info/gems/todo-txt).
+
 # Installation
 
 Installation is very simple. The project is packaged as a Ruby gem and can be
@@ -49,12 +52,12 @@ list.by_priority "A"
 list.by_context "@code"
 # => Returns a new Todo::List with only tasks that have a @code context.
 
-list.by_project "+manhatten"
+list.by_project "+manhattan"
 # => Returns a new Todo::List with only tasks that are part of the
-#    +manhatten project (see what I did there?)
+#    +manhattan project (see what I did there?)
 
 # And you can combine these, like so
-list.by_project("+manhatten").by_priority("B")
+list.by_project("+manhattan").by_priority("B")
 ```
 
 ## Todo::Task
@@ -107,4 +110,4 @@ Tasks without a priority will always be less than a task with a priority.
 
 # Requirements
 
-The todo-txt gem requires Ruby 1.8.7 or higher.
+The todo-txt gem requires Ruby 2.0 or higher.

data/lib/todo-txt/logger.rb

@@ -1,21 +1,24 @@
 require 'logger'
 
 module Todo
+  # Handles depreciation warnings and other issues related to API usage
   module Logger
-    def self.included base
+    def self.included(base)
       base.extend(self)
     end
 
-    def self.logger= new_logger
-      @@logger = new_logger
+    def logger
+      Todo::Logger.logger
     end
 
-    def self.logger
-      @@logger ||= ::Logger.new(STDOUT)
-    end
+    class << self
+      # Sets a new logger object
+      attr_writer :logger
 
-    def logger
-      Todo::Logger.logger
+      # Creates a new logger object
+      def logger
+        @logger ||= ::Logger.new(STDOUT)
+      end
     end
   end
 end

data/lib/todo-txt/syntax.rb

@@ -1,33 +1,94 @@
 module Todo
   module Syntax
     # The regular expression used to match contexts.
-    def contexts_regex
-       /(?:\s+|^)@[^\s]+/
-    end
+    CONTEXTS_PATTERN = /(?:\s+|^)@[^\s]+/.freeze
 
     # The regex used to match projects.
-    def projects_regex
-       /(?:\s+|^)\+[^\s]+/
-    end
+    PROJECTS_PATTERN = /(?:\s+|^)\+[^\s]+/.freeze
 
     # The regex used to match priorities.
-    def priority_regex
-      /(?:^|\s+)\(([A-Za-z])\)\s+/
-    end
+    PRIORITY_PATTERN = /(?:^|\s+)\(([A-Za-z])\)\s+/
 
     # The regex used to match creation date.
-    def created_on_regex
-      /(?:^|-\d{2}\s|\)\s)(\d{4}-\d{2}-\d{2})\s/
-    end
+    CREATED_ON_PATTERN = /(?:^|-\d{2}\s|\)\s)(\d{4}-\d{2}-\d{2})\s/.freeze
 
     # The regex used to match completion.
-    def done_regex
-      /^x\s+(\d{4}-\d{2}-\d{2})\s+/
-    end
+    COMPLETED_ON_PATTERN = /^x\s+(\d{4}-\d{2}-\d{2})\s+/.freeze
 
     # The regex used to match due date.
-    def due_on_regex
-      /(?:due:)(\d{4}-\d{2}-\d{2})(?:\s+|$)/i
+    DUE_ON_PATTERN = /(?:due:)(\d{4}-\d{2}-\d{2})(?:\s+|$)/i.freeze
+
+    def get_item_text(line)
+      line.
+        gsub(COMPLETED_ON_PATTERN, '').
+        gsub(PRIORITY_PATTERN, '').
+        gsub(CREATED_ON_PATTERN, '').
+        gsub(CONTEXTS_PATTERN, '').
+        gsub(PROJECTS_PATTERN, '').
+        gsub(DUE_ON_PATTERN, '').
+        strip
+    end
+
+    def orig_priority(line)
+      line.match(PRIORITY_PATTERN)[1] if line =~ PRIORITY_PATTERN
+    end
+
+    # Extracts the creation date for the given todo item.
+    # Returns nil if a valid date is not found.
+    #
+    # @param line [String] the todo item to be processed
+    # @return [Date] the created date of the line
+    def orig_created_on(line)
+      date = line.match CREATED_ON_PATTERN
+      begin
+        Date.parse(date[1]) if date
+      rescue ArgumentError
+        return nil # The given date is not valid
+      end
+    end
+
+    # Extracts the completion date for the given todo item.
+    # Returns nil if a valid date is not found.
+    #
+    # @param line [String] the todo item to be processed
+    # @return [Date] the completed date of the line
+    def get_completed_date(line)
+      date = COMPLETED_ON_PATTERN.match(line)
+      begin
+        Date.parse(date[1]) if date
+      rescue ArgumentError
+        return nil # The given date is not valid
+      end
+    end
+
+    # Extracts the completion date for the given todo item.
+    # Returns nil if a valid date is not found.
+    #
+    # @param line [String] the todo item to be processed
+    # @return [Date] the due date of the line
+    def get_due_on_date(line)
+      date = DUE_ON_PATTERN.match(line)
+      begin
+        Date.parse(date[1]) if date
+      rescue ArgumentError
+        return nil # The given date is not valid
+      end
+    end
+
+    # Extract the list of `@context` tags out of the task line.
+    #
+    # @param [String] line Line of text encoding a single task
+    # @return [Array<String>] List of context tags
+    def extract_contexts(line)
+      line.scan(CONTEXTS_PATTERN).map { |tag| tag.strip }
+    end
+
+    # Extract the list of `+project` tags out of the task line.
+    #
+    # @param [String] line Line of text encoding a single task
+    # @return [Array<String>] List of project tags
+    def extract_projects(line)
+      line.scan(PROJECTS_PATTERN).map { |tag| tag.strip }
     end
   end
 end

data/lib/todo-txt/task.rb

@@ -14,11 +14,11 @@ module Todo
     #   task = Todo::Task.new("(A) A high priority task!")
     def initialize task
       @orig = task
-      @completed_on = get_completed_date #orig.scan(self.class.done_regex)[1] ||= nil
-      @priority, @created_on = orig_priority, orig_created_on
-      @due_on = get_due_on_date
-      @contexts ||= orig.scan(contexts_regex).map { |item| item.strip }
-      @projects ||= orig.scan(projects_regex).map { |item| item.strip }
+      @completed_on = get_completed_date(orig)
+      @priority, @created_on = orig_priority(orig), orig_created_on(orig)
+      @due_on = get_due_on_date(orig)
+      @contexts ||= extract_contexts(orig)
+      @projects ||= extract_projects(orig)
     end
 
     # Returns the original content of the task.
@@ -103,14 +103,7 @@ module Todo
     #   task = Todo::Task.new "(A) @test Testing!"
     #   task.text #=> "Testing!"
     def text
-      @text ||= orig.
-        gsub(done_regex, '').
-        gsub(priority_regex, '').
-        gsub(created_on_regex, '').
-        gsub(contexts_regex, '').
-        gsub(projects_regex, '').
-        gsub(due_on_regex, '').
-        strip
+      @text ||= get_item_text(orig)
     end
 
     # Returns the task's creation date, if any.
@@ -195,7 +188,27 @@ module Todo
     #   #=> nil
     def undo!
       @completed_on = nil
-      @priority = orig_priority
+      @priority = orig_priority(orig)
+    end
+
+    # Increases the priority until A. If it's nil, it sets it to A.
+    # @return [Char] the new priority of the task
+    def priority_inc!
+      if @priority.nil?
+        @priority = 'A'
+      elsif @priority.ord > 65
+        @priority = (@priority.ord - 1).chr
+      end
+      @priority
+    end
+
+    # Decreases the priority until Z. if it's nil, it does nothing and
+    # returns nil.
+    # @return [Char] the new priority of the task
+    def priority_dec!
+      return if @priority.nil?
+      @priority = @priority.next if @priority.ord < 90
+      @priority
     end
 
     # Toggles the task from complete to incomplete or vice versa.
@@ -260,36 +273,5 @@ module Todo
         other_task.priority <=> self.priority
       end
     end
-
-    private
-
-    def orig_priority
-      @orig.match(priority_regex)[1] if @orig =~ priority_regex
-    end
-
-    def orig_created_on
-      begin
-        if @orig =~ created_on_regex
-          date = @orig.match created_on_regex
-          return Date.parse(date[1]) unless date.nil?
-        end
-      rescue; end
-      nil
-    end
-
-    def get_completed_date
-      begin
-        return Date.parse(done_regex.match(@orig)[1])
-      rescue; end
-      nil
-    end
-
-    def get_due_on_date
-      begin
-        return Date.parse(due_on_regex.match(@orig)[1])
-      rescue; end
-      nil
-    end
-
   end
 end

data/spec/todo-txt/list_spec.rb

@@ -4,75 +4,116 @@ describe Todo::List do
   let(:path) { File.dirname(__FILE__) + '/../data/todo.txt' }
   let(:list) { Todo::List.new(path) }
 
-  it 'should have the correct path' do
+  context 'create with an array' do
+    it 'successfully creates an object' do
+      array = Array.new
+      array.push "(A) A string task!"
+      array.push Todo::Task.new("(A) An actual task!")
+      expect(Todo::List.new array).not_to eq(nil)
+    end
+
+    it 'does not have a path' do
+      array = Array.new
+      array.push "(A) A string task!"
+      array.push Todo::Task.new("(A) An actual task!")
+      expect(Todo::List.new(array).path).to eq(nil)
+    end
+  end
+
+  it 'accepts a mix of tasks and strings' do
+    l = Todo::List.new([
+      "A task!",
+      Todo::Task.new("Another task!"),
+    ])
+
+    expect(l.length).to eq(2)
+  end
+
+  it 'has the correct path' do
     expect(list.path).to eq(path)
   end
 
-  it 'should grab a list of Todo::Tasks' do
+  it 'creates a list of Todo::Tasks' do
     list.each do |task|
       expect(task.class).to eq(Todo::Task)
     end
+  end
 
-    # This is a little bit fragile but it helps me sleep at night.
-    expect(list[0].priority).to eq("A")
+  it 'it retrieves the list in the expected order' do
+    expect(list.first.text).to eq('Crack the Da Vinci Code.')
+    expect(list.last.text).to eq(
+      'This task is completed and has created and completion dates')
   end
 
-  it 'should be able to filter by priority' do
-    list.by_priority("A").each do |task|
-      expect(task.priority).to eq("A")
-    end
+  it 'it retrieves the expected number of items' do
+    expect(list.count).to eq(11)
+  end
 
+  it 'should be able to filter by priority' do
     # Make sure some data was actually checked
-    expect(list.by_priority("A").length).to be > 0
-  end
+    priority_list = list.by_priority('A')
+    expect(priority_list.length).to be > 0
 
-  it 'should be able to filter by context' do
-    list.by_context("@context").each do |task|
-      expect(task.contexts).to include "@context"
+    priority_list.each do |task|
+      expect(task.priority).to eq('A')
     end
+  end
 
+  it 'should be able to filter by context' do
     # Make sure some data was actually checked
-    expect(list.by_context("@context").length).to be > 0
-  end
+    context_list = list.by_context('@context')
+    expect(context_list.length).to be > 0
 
-  it 'should be able to filter by project' do
-    list.by_project("+project").each do |task|
-      expect(task.projects).to include "+project"
+    context_list.each do |task|
+      expect(task.contexts).to include '@context'
     end
+  end
 
+  it 'should be able to filter by project' do
     # Make sure some data was actually checked
-    expect(list.by_project("+project").length).to be > 0
+    project_list = list.by_project('+project')
+    expect(project_list.length).to be > 0
+
+    project_list.each do |task|
+      expect(task.projects).to include '+project'
+    end
   end
 
   it 'should be able to filter by project, context and priority' do
-    filtered = list.by_project("+project").
-                    by_context("@context").
-                    by_priority("C")
+    filtered = list.by_project('+project').
+                    by_context('@context').
+                    by_priority('C')
+
+    # Make sure some data was actually checked
+    expect(filtered.length).to be > 0
 
     filtered.each do |task|
-      expect(task.projects).to include "+project"
-      expect(task.contexts).to include "@context"
-      expect(task.priority).to eq("C")
+      expect(task.projects).to include '+project'
+      expect(task.contexts).to include '@context'
+      expect(task.priority).to eq('C')
     end
+  end
+
+  it 'filters by done' do
+    done_list = list.by_done
 
     # Make sure some data was actually checked
-    expect(filtered.length).to be > 0
-  end
+    expect(done_list.length).to eq(2)
 
-  it 'should be able to filter by done' do
     list.by_done.each do |task|
       expect(task.text).to include 'This task is completed'
     end
-
-    expect(list.by_done.length).to eq(2)
   end
 
-  it 'should be able to filter by not done' do
-    list.by_not_done.each do |task|
+  it 'filters by not done' do
+    not_done_list = list.by_not_done
+
+    # Make sure some data was actually checked
+    expect(not_done_list.length).to eq(9)
+
+    not_done_list.each do |task|
       expect(task.text).not_to include 'This task is completed'
     end
-
-    expect(list.by_not_done.length).to eq(9)
   end
 
   it 'should be sortable' do
@@ -82,20 +123,10 @@ describe Todo::List do
 
     # Make sure some data was actually checked
     expect(list.sort.length).to be > 0
-
-    # Class should still be Todo::List
-    # This assertion currently fails. TODO.
-    # list.sort.should be_a Todo::List
   end
 
-  describe 'manual list creation' do
-    it 'should be possible with a mix of tasks and strings' do
-      l = Todo::List.new([
-        "A task!",
-        Todo::Task.new("Another task!"),
-      ])
-
-      expect(l.length).to eq(2)
-    end
-  end
+  it 'returns a list on sort'
+  # Class should still be Todo::List
+  # This assertion currently fails. TODO.
+  # expect(list.sort).to be_a Todo::List
 end

data/spec/todo-txt/syntax_spec.rb

@@ -0,0 +1,131 @@
+require 'spec_helper'
+
+describe Todo::Syntax do
+  include Todo::Syntax
+
+  describe '#get_context_tags' do
+    specify 'empty task' do
+      expect(extract_contexts('')).to eq([])
+    end
+
+    specify 'task without context' do
+      expect(extract_contexts('something to do')).to eq([])
+    end
+
+    specify 'task with single context' do
+      expect(extract_contexts('something to do @work')).to eq(['@work'])
+    end
+
+    specify 'task with multiple contexts' do
+      expect(extract_contexts('something to do @work @play')).to eq(['@work', '@play'])
+    end
+  end
+
+  describe '#get_project_tags' do
+    specify 'empty task' do
+      expect(extract_projects('')).to eq([])
+    end
+
+    specify 'task without project' do
+      expect(extract_projects('something to do')).to eq([])
+    end
+
+    specify 'task with single project' do
+      expect(extract_projects('something to do +report')).to eq(['+report'])
+    end
+
+    specify 'task with multiple projects' do
+      expect(extract_projects('something to do +report +analysis')).to eq(['+report', '+analysis'])
+    end
+  end
+
+  describe '#orig_priority' do
+    specify 'empty task' do
+      expect(orig_priority('')).to be nil
+    end
+
+    specify 'task without priority' do
+      expect(orig_priority('something to do')).to be nil
+    end
+
+    specify 'task with priority A' do
+      expect(orig_priority('(A) something to do')).to eq('A')
+    end
+
+    specify 'task with priority B' do
+      expect(orig_priority('(B) something to do')).to eq('B')
+    end
+  end
+
+  describe '#orig_created_on' do
+    specify 'empty task' do
+      expect(orig_created_on('')).to be nil
+    end
+
+    specify 'task without date' do
+      expect(orig_created_on('something to do')).to be nil
+    end
+
+    specify 'task with created date' do
+      expect(orig_created_on('2016-03-29 something to do')).to eq(Date.new(2016, 03, 29))
+    end
+
+    specify 'prioritised task with created date' do
+      expect(orig_created_on('(A) 2016-03-29 something to do')).to eq(Date.new(2016, 03, 29))
+    end
+
+    specify 'date included in task text' do
+      expect(orig_created_on('(A) something to do on 2016-03-29')).to be nil
+    end
+  end
+
+  describe '#get_completed_date' do
+    specify 'empty task' do
+      expect(get_completed_date('')).to be nil
+    end
+
+    specify 'uncompleted task' do
+      expect(get_completed_date('2016-03-29 something to do')).to be nil
+    end
+
+    specify 'completed task without date' do
+      expect(get_completed_date('2016-03-29 something to do')).to be nil
+    end
+
+    specify 'completed task without date' do
+      expect(get_completed_date('2016-03-29 something to do')).to be nil
+    end
+  end
+
+  describe '#get_due_on_date' do
+    specify 'empty task' do
+      expect(get_due_on_date('')).to be nil
+    end
+
+    specify 'task without due date' do
+      expect(get_due_on_date('something to do')).to be nil
+    end
+
+    specify 'task with due date' do
+      expect(get_due_on_date('something to do due:2016-03-30')).to eq(Date.new(2016, 03, 30))
+    end
+  end
+
+  describe '#get_item_text' do
+    specify 'empty task' do
+      expect(get_item_text('')).to eq('')
+    end
+
+    specify 'task without markup' do
+      expect(get_item_text('something to do')).to eq('something to do')
+    end
+
+    specify 'task with date, priority, projects and context' do
+      expect(get_item_text('(A) 2016-03-29 something to do +experiment @work')).to eq('something to do')
+    end
+
+    specify 'completed task with projects and context' do
+      expect(get_item_text('x 2016-03-30 2016-03-29 something to do +experiment @work')).to eq('something to do')
+    end
+  end
+end

data/spec/todo-txt/task_spec.rb

@@ -1,131 +1,203 @@
 require 'spec_helper'
 
 describe Todo::Task do
-  describe "Descriptions:" do
+  describe 'Descriptions:' do
     it 'should convert to a string' do
-      task = Todo::Task.new "(A) 2012-12-08 My task @test +test2"
-      expect(task.to_s).to eq("(A) 2012-12-08 My task @test +test2")
+      task = Todo::Task.new '(A) 2012-12-08 My task @test +test2'
+      expect(task.to_s).to eq('(A) 2012-12-08 My task @test +test2')
     end
 
     it 'should keep track of the original string after changing the task' do
-      task = Todo::Task.new "(A) 2012-12-08 My task @test +test2"
+      task = Todo::Task.new '(A) 2012-12-08 My task @test +test2'
       Timecop.freeze(2013, 12, 8) do
         task.do!
-        expect(task.orig).to eq("(A) 2012-12-08 My task @test +test2")
+        expect(task.orig).to eq('(A) 2012-12-08 My task @test +test2')
       end
     end
 
     it 'should be modifiable' do
-      task = Todo::Task.new "2012-12-08 My task @test +test2"
+      task = Todo::Task.new '2012-12-08 My task @test +test2'
       task.projects.clear
-      task.contexts << ["@test3"]
+      task.contexts << ['@test3']
       Timecop.freeze(2013, 12, 8) do
         task.do!
-        expect(task.to_s).to eq("x 2013-12-08 2012-12-08 My task @test @test3")
+        expect(task.to_s).to eq('x 2013-12-08 2012-12-08 My task @test @test3')
       end
     end
 
     it 'should be able to get just the text, no due date etc.' do
-      task = Todo::Task.new "x 2012-09-11 (B) 2012-03-04 This is a sweet task. @context due:2012-01-01 +project"
-      expect(task.text).to eq("This is a sweet task.")
+      task = Todo::Task.new 'x 2012-09-11 (B) 2012-03-04 This is a sweet task. @context due:2012-01-01 +project'
+      expect(task.text).to eq('This is a sweet task.')
     end
 
     it 'should retain the original task creation string' do
-      task = Todo::Task.new "(A) This is an awesome task, yo. +winning"
-      expect(task.orig).to eq("(A) This is an awesome task, yo. +winning")
+      task = Todo::Task.new '(A) This is an awesome task, yo. +winning'
+      expect(task.orig).to eq('(A) This is an awesome task, yo. +winning')
     end
 
     it 'should be able to get just the text, no contexts etc.' do
-      task = Todo::Task.new "x 2012-09-11 (B) 2012-03-04 This is a sweet task. @context +project"
-      expect(task.text).to eq("This is a sweet task.")
+      task = Todo::Task.new 'x 2012-09-11 (B) 2012-03-04 This is a sweet task. @context +project'
+      expect(task.text).to eq('This is a sweet task.')
     end
   end
 
-  describe "Priorities:" do
+  describe 'Priorities:' do
     it 'should recognise priorities' do
-      task = Todo::Task.new "(A) Hello world!"
-      expect(task.priority).to eq("A")
+      task = Todo::Task.new '(A) Hello world!'
+      expect(task.priority).to eq('A')
     end
 
     it 'should only recognise priorities at the start of a task' do
-      task = Todo::Task.new "Hello, world! (A)"
+      task = Todo::Task.new 'Hello, world! (A)'
       expect(task.priority).to eq(nil)
     end
 
     it 'should recognize priorities around dates' do
-      task = Todo::Task.new "x 2012-09-11 (B) 2012-03-04 This is a sweet task. @context +project"
-      expect(task.priority).to eq("B")
+      task = Todo::Task.new 'x 2012-09-11 (B) 2012-03-04 This is a sweet task. @context +project'
+      expect(task.priority).to eq('B')
     end
 
     it 'should remove the priority when calling Task#do!' do
-      task = Todo::Task.new "(A) Task"
+      task = Todo::Task.new '(A) Task'
       task.do!
       expect(task.priority).to be_nil
     end
 
     it 'should reset to the original priority when calling Task#undo!' do
-      task = Todo::Task.new "(A) Task"
+      task = Todo::Task.new '(A) Task'
       task.do!
       task.undo!
-      expect(task.priority).to eq("A")
+      expect(task.priority).to eq('A')
     end
   end
 
-  describe "Completion:" do
+  describe 'Step priority:' do
+    context 'Increment' do
+      it 'increments the priority by one' do
+        task = Todo::Task.new '(B) Task'
+        task.priority_inc!
+        expect(task.priority).to eq('A')
+      end
+
+      it 'returns the new priority' do
+        task = Todo::Task.new '(B) Task'
+        expect(task.priority_inc!).to eq('A')
+      end
+
+      it 'does not increment priority beyond A' do
+        task = Todo::Task.new '(A) Task'
+        task.priority_inc!
+        expect(task.priority).to eq('A')
+      end
+
+      it 'returns A if the priority did not change' do
+        task = Todo::Task.new '(A) Task'
+        expect(task.priority_inc!).to eq('A')
+      end
+
+      it 'sets a priority if previous priority was nil' do
+        task = Todo::Task.new 'Task'
+        task.priority_inc!
+        expect(task.priority).to eq('A')
+      end
+
+      it 'returns A if the previous priority was nil' do
+        task = Todo::Task.new 'Task'
+        expect(task.priority_inc!).to eq('A')
+      end
+    end
+
+    context 'Decrement' do
+      it 'lowers the priority by one' do
+        task = Todo::Task.new '(A) Task'
+        task.priority_dec!
+        expect(task.priority).to eq('B')
+      end
+
+      it 'returns the new priority' do
+        task = Todo::Task.new '(A) Task'
+        expect(task.priority_dec!).to eq('B')
+      end
+
+      it 'does not go below Z' do
+        task = Todo::Task.new '(Z) Task'
+        task.priority_dec!
+        expect(task.priority).to eq('Z')
+      end
+
+      it 'returns Z if priority did not change' do
+        task = Todo::Task.new '(Z) Task'
+        expect(task.priority_dec!).to eq('Z')
+      end
+
+      it 'does not set a priority if priority was nil' do
+        task = Todo::Task.new 'Task'
+        task.priority_dec!
+        expect(task.priority).to eq(nil)
+      end
+
+      it 'returns nil if priority was nil' do
+        task = Todo::Task.new 'Task'
+        expect(task.priority_dec!).to eq(nil)
+      end
+    end
+  end
+
+  describe 'Completion:' do
     it 'should be not done with missing date' do
-      task = Todo::Task.new "x This is not done"
+      task = Todo::Task.new 'x This is not done'
       expect(task.done?).to be false
     end
 
     it 'should be not done with malformed date' do
-      task = Todo::Task.new "x 01-01-2013 This is not done"
+      task = Todo::Task.new 'x 01-01-2013 This is not done'
       expect(task.done?).to be false
       expect(task.completed_on).to be nil
     end
 
     it 'should be not done with an invalid date' do
-      task = Todo::Task.new "x 2013-02-31 This is not done"
+      task = Todo::Task.new 'x 2013-02-31 This is not done'
       expect(task.done?).to be false
       expect(task.completed_on).to be nil
     end
 
     it 'should be done on 2013-04-22' do
-      task = Todo::Task.new "x 2013-04-22 This is really done"
+      task = Todo::Task.new 'x 2013-04-22 This is really done'
       expect(task.done?).to be true
       expect(task.completed_on).to eq(Date.parse('22th April 2013'))
     end
 
     it 'should be able to recognise completed tasks' do
-      task = Todo::Task.new "x 2012-12-08 This is done!"
+      task = Todo::Task.new 'x 2012-12-08 This is done!'
       expect(task.done?).to be true
     end
 
     it 'should not recognize incomplete tasks as done' do
-      task = Todo::Task.new "2012-12-08 This ain't done!"
+      task = Todo::Task.new '2012-12-08 This is not done!'
       expect(task.done?).to be false
     end
 
     it 'should be completable' do
-      task = Todo::Task.new "2012-12-08 This ain't done!"
+      task = Todo::Task.new '2012-12-08 This is not done!'
       task.do!
       expect(task.done?).to be true
     end
 
     it 'should be marked as incomplete' do
-      task = Todo::Task.new "x 2012-12-08 This is done!"
+      task = Todo::Task.new 'x 2012-12-08 This is done!'
       task.undo!
       expect(task.done?).to be false
     end
 
     it 'should be marked as incomplete without any date' do
-      task = Todo::Task.new "x 2012-12-08 This is done!"
+      task = Todo::Task.new 'x 2012-12-08 This is done!'
       task.undo!
       expect(task.completed_on).to be_nil
       expect(task.created_on).to be_nil
     end
 
     it 'should be toggable' do
-      task = Todo::Task.new "2012-12-08 This ain't done!"
+      task = Todo::Task.new '2012-12-08 This is not done!'
       task.toggle!
       expect(task.done?).to be true
       task.toggle!
@@ -133,93 +205,93 @@ describe Todo::Task do
     end
   end
 
-  describe "Contexts:" do
+  describe 'Contexts:' do
     it 'should recognise contexts' do
-      task = Todo::Task.new "Hello, world! @test"
-      expect(task.contexts).to eq(["@test"])
+      task = Todo::Task.new 'Hello, world! @test'
+      expect(task.contexts).to eq(['@test'])
     end
 
     it 'should recognise multiple contexts' do
-      task = Todo::Task.new "Hello, world! @test @test2"
-      expect(task.contexts).to eq(["@test", "@test2"])
+      task = Todo::Task.new 'Hello, world! @test @test2'
+      expect(task.contexts).to eq(['@test', '@test2'])
     end
 
     it 'should recognise contexts with dashes and underscores' do
-      task = Todo::Task.new "Hello, world! @test-me @test2_me"
-      expect(task.contexts).to eq(["@test-me", "@test2_me"])
+      task = Todo::Task.new 'Hello, world! @test-me @test2_me'
+      expect(task.contexts).to eq(['@test-me', '@test2_me'])
     end
   end
 
-  describe "Projects:" do
+  describe 'Projects:' do
     it 'should recognise projects' do
-      task = Todo::Task.new "Hello, world! +test"
-      expect(task.projects).to eq(["+test"])
+      task = Todo::Task.new 'Hello, world! +test'
+      expect(task.projects).to eq(['+test'])
     end
 
     it 'should recognise multiple projects' do
-      task = Todo::Task.new "Hello, world! +test +test2"
-      expect(task.projects).to eq(["+test", "+test2"])
+      task = Todo::Task.new 'Hello, world! +test +test2'
+      expect(task.projects).to eq(['+test', '+test2'])
     end
 
     it 'should recognise projects with dashes and underscores' do
-      task = Todo::Task.new "Hello, world! +test-me +test2_me"
-      expect(task.projects).to eq(["+test-me", "+test2_me"])
+      task = Todo::Task.new 'Hello, world! +test-me +test2_me'
+      expect(task.projects).to eq(['+test-me', '+test2_me'])
     end
   end
 
-  describe "Creation dates:" do
+  describe 'Creation dates:' do
     it 'should be able to recognise creation dates' do
-      task = Todo::Task.new "(C) 2012-03-04 This has a date!"
-      expect(task.created_on).to eq(Date.parse("4th March 2012"))
+      task = Todo::Task.new '(C) 2012-03-04 This has a date!'
+      expect(task.created_on).to eq(Date.parse('4th March 2012'))
     end
 
     it 'should be able to recognise creation dates without priority' do
-      task = Todo::Task.new "2012-03-04 This has a date!"
-      expect(task.created_on).to eq(Date.parse("4th March 2012"))
+      task = Todo::Task.new '2012-03-04 This has a date!'
+      expect(task.created_on).to eq(Date.parse('4th March 2012'))
     end
 
     it 'should return nil if no creation date is present' do
-      task = Todo::Task.new "No date!"
+      task = Todo::Task.new 'No date!'
       expect(task.created_on).to be_nil
     end
 
     it 'should not recognise malformed dates' do
-      task = Todo::Task.new "03-04-2012 This has a malformed date!"
+      task = Todo::Task.new '03-04-2012 This has a malformed date!'
       expect(task.created_on).to be_nil
     end
 
     it 'should be able to tell if the task is overdue' do
-      task = Todo::Task.new((Date.today - 1).to_s + " This task is overdue!")
+      task = Todo::Task.new((Date.today - 1).to_s + ' This task is overdue!')
       expect(task.overdue?).to be false
     end
 
     it 'should return false on overdue? if there is no creation date' do
-      task = Todo::Task.new "No date!"
+      task = Todo::Task.new 'No date!'
       expect(task.overdue?).to be false
     end
 
     it 'should return nil on ridiculous date data' do
-      task = Todo::Task.new "2012-56-99 This has a malformed date!"
+      task = Todo::Task.new '2012-56-99 This has a malformed date!'
       expect(task.created_on).to be_nil
     end
   end
 
-  describe "Completion dates:" do
+  describe 'Completion dates:' do
     it 'should be able to recognise completion dates' do
-      task = Todo::Task.new "x 2012-12-08 This is done!"
-      expect(task.completed_on).to eq(Date.parse("8th December 2012"))
+      task = Todo::Task.new 'x 2012-12-08 This is done!'
+      expect(task.completed_on).to eq(Date.parse('8th December 2012'))
     end
 
     it 'should set the current completion dates when calling Task#do!' do
-      task = Todo::Task.new "2012-12-08 Task"
+      task = Todo::Task.new '2012-12-08 Task'
       Timecop.freeze(2013, 12, 8) do
         task.do!
-        expect(task.completed_on).to eq(Date.parse("8th December 2013"))
+        expect(task.completed_on).to eq(Date.parse('8th December 2013'))
       end
     end
   end
 
-  describe "Due dates:" do
+  describe 'Due dates:' do
     it 'should have a due date' do
       task = Todo::Task.new '(A) this task has due date due:2013-12-22'
       expect(task.due_on).not_to be_nil
@@ -245,17 +317,17 @@ describe Todo::Task do
     end
 
     it 'should convert to a string with due date' do
-      task = Todo::Task.new "x 2012-09-11 (B) 2012-03-04 This is a sweet task. @context due:2012-01-01 +project"
-      expect(task.to_s).to eq("x 2012-09-11 (B) 2012-03-04 This is a sweet task. @context +project due:2012-01-01")
+      task = Todo::Task.new 'x 2012-09-11 (B) 2012-03-04 This is a sweet task. @context due:2012-01-01 +project'
+      expect(task.to_s).to eq('x 2012-09-11 (B) 2012-03-04 This is a sweet task. @context +project due:2012-01-01')
     end
 
     it 'should have no due date with malformed date' do
-      task = Todo::Task.new "x 2012-09-11 (B) 2012-03-04 This is a sweet task. @context due:01-01-2012 +project"
+      task = Todo::Task.new 'x 2012-09-11 (B) 2012-03-04 This is a sweet task. @context due:01-01-2012 +project'
       expect(task.due_on).to be_nil
     end
 
     it 'should have no due date with invalid date' do
-      task = Todo::Task.new "x 2012-09-11 (B) 2012-03-04 This is a sweet task. @context due:2012-02-31 +project"
+      task = Todo::Task.new 'x 2012-09-11 (B) 2012-03-04 This is a sweet task. @context due:2012-02-31 +project'
       expect(task.due_on).to be_nil
     end
 
@@ -265,56 +337,56 @@ describe Todo::Task do
     end
 
     it 'should reset to the original due date when calling Task#undo!' do
-      task = Todo::Task.new "2012-12-08 Task"
+      task = Todo::Task.new '2012-12-08 Task'
       Timecop.freeze(2013, 12, 8) do
         task.do!
         task.undo!
-        expect(task.created_on).to eq(Date.parse("8th December 2012"))
+        expect(task.created_on).to eq(Date.parse('8th December 2012'))
       end
     end
 
     it 'should manage dates when calling Task#toggle!' do
-      task = Todo::Task.new "2012-12-08 This ain't done!"
+      task = Todo::Task.new '2012-12-08 This is not done!'
       Timecop.freeze(2013, 12, 8) do
         task.toggle!
-        expect(task.completed_on).to eq(Date.parse("8th December 2013"))
-        expect(task.created_on).to eq(Date.parse("8th December 2012"))
+        expect(task.completed_on).to eq(Date.parse('8th December 2013'))
+        expect(task.created_on).to eq(Date.parse('8th December 2012'))
         task.toggle!
-        expect(task.created_on).to eq(Date.parse("8th December 2012"))
+        expect(task.created_on).to eq(Date.parse('8th December 2012'))
         expect(task.completed_on).to be_nil
       end
     end
   end
 
-  describe "Comparisons:" do
+  describe 'Comparisons:' do
     it 'should be comparable' do
-      task1 = Todo::Task.new "(A) Top priority, y'all!"
-      task2 = Todo::Task.new "(B) Not quite so high."
+      task1 = Todo::Task.new '(A) Top priority!'
+      task2 = Todo::Task.new '(B) Not quite so high.'
 
       assertion = task1 > task2
       expect(assertion).to eq(true)
     end
 
     it 'should be comparable to task without priority' do
-      task1 = Todo::Task.new "Top priority, y'all!"
-      task2 = Todo::Task.new "(B) Not quite so high."
+      task1 = Todo::Task.new 'Top priority!'
+      task2 = Todo::Task.new '(B) Not quite so high.'
 
       assertion = task1 < task2
       expect(assertion).to eq(true)
     end
 
     it 'should be able to compare two tasks without priority' do
-      task1 = Todo::Task.new "Top priority, y'all!"
-      task2 = Todo::Task.new "Not quite so high."
+      task1 = Todo::Task.new 'Top priority!'
+      task2 = Todo::Task.new 'Not quite so high.'
 
       assertion = task1 == task2
       expect(assertion).to eq(true)
     end
   end
 
-  describe "Logging:" do
+  describe 'Logging:' do
     it 'should have a logger' do
-      task = Todo::Task.new "x 2012-09-11 (B) 2012-03-04 This is a sweet task. @context due:2012-02-31 +project"
+      task = Todo::Task.new 'x 2012-09-11 (B) 2012-03-04 This is a sweet task. @context due:2012-02-31 +project'
       expect(task.logger).not_to be nil
     end
 
@@ -322,7 +394,7 @@ describe Todo::Task do
       logger = double(Logger)
       Todo::Logger.logger = logger
 
-      task = Todo::Task.new "x 2012-09-11 (B) 2012-03-04 This is a sweet task. @context due:2012-02-31 +project"
+      task = Todo::Task.new 'x 2012-09-11 (B) 2012-03-04 This is a sweet task. @context due:2012-02-31 +project'
       error_message = 'Task#date is deprecated, use created_on instead.'
 
       expect(logger).to receive(:warn).with(error_message)

data/todo-txt.gemspec

@@ -1,12 +1,12 @@
 Gem::Specification.new do |s|
   s.name = %q{todo-txt}
-  s.version = "0.6"
+  s.version = '0.7'
   s.authors = ["Sam Rose"]
   s.email = %q{samwho@lbak.co.uk}
   s.summary = %q{A client library for parsing todo.txt files.}
   s.homepage = %q{http://github.com/samwho/todo-txt-gem}
   s.description = %q{Allows for simple parsing of todo.txt files, as per Gina Trapani's todo.txt project.}
-  s.required_ruby_version = '>= 1.8.7'
+  s.required_ruby_version = '>= 2.0'
   s.license = 'GPL-2'
 
   # Add all files to the files parameter.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: todo-txt
 version: !ruby/object:Gem::Version
-  version: '0.6'
+  version: '0.7'
 platform: ruby
 authors:
 - Sam Rose
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-10 00:00:00.000000000 Z
+date: 2016-04-04 00:00:00.000000000 Z
 dependencies: []
 description: Allows for simple parsing of todo.txt files, as per Gina Trapani's todo.txt
   project.
@@ -32,6 +32,7 @@ files:
 - spec/data/todo.txt
 - spec/spec_helper.rb
 - spec/todo-txt/list_spec.rb
+- spec/todo-txt/syntax_spec.rb
 - spec/todo-txt/task_spec.rb
 - todo-txt.gemspec
 homepage: http://github.com/samwho/todo-txt-gem
@@ -46,7 +47,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="