todo-txt 0.9 → 0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04e209879cbf8434759e4343c03bdbb2b48a7e3f
-  data.tar.gz: bad9b8396a6d32ef8eb8f647394de850d5c0a658
+  metadata.gz: 0e6194a6c093149543776903fec449488ff35e12
+  data.tar.gz: 1ff563eca42c38f95a55eda4732f4c43005a2079
 SHA512:
-  metadata.gz: 7d5599684ab23946adde905819a231f75d38029780c49e0771acd0258a6622fd88d5edd1c0e5ff2d6415b1e359047b7b6fbef8cd684c701ce94fdafa972d2b31
-  data.tar.gz: 9b7c601dad7b1a07541fea804b06a9c12490406501a7173b4e2e0dfaf26d5da320a7605960f4e8b9d5ba5f66d10dac3892c50bee9e2676d95fbb8df295f7c014
+  metadata.gz: 0d614c4914dfc5e7e84addd6185f79c52270a4196003be1bef3f88452063e4d549062855d3229b92413dfe1f9b0f896ff6fe12cc7b64786767300aa9ff430a56
+  data.tar.gz: 0b8307a2946e632a5a68fb1b03b1df5d2fcbf56317087ebac52e7d3317b742ba8e9a5f7e31de9ff8723683e940a50d2d11bd39e58a4b806265a05180f6fa123e

data/.rubocop.yml

@@ -1,2 +1,5 @@
+AllCops:
+  Exclude:
+    - 'lib/todo-txt.rb'
 StringLiterals:
   Enabled: false

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 2.0
   - 2.1
   - 2.2
   - 2.3.0

data/Gemfile

@@ -4,7 +4,7 @@ group :test do
   gem 'rspec', '~> 3.4'
   gem 'rake'
   gem 'timecop'
-  gem 'simplecov', :require => false
+  gem 'simplecov', require: false
 end
 
 group :development do

data/Rakefile

@@ -2,7 +2,7 @@ require 'bundler/setup'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-task :default => [:test]
+task default: :test
 
 desc "Run all tests"
 RSpec::Core::RakeTask.new(:test)

data/lib/todo-txt.rb

@@ -1,6 +1 @@
-require 'logger'
-require 'todo-txt/logger'
-require 'todo-txt/options'
-require 'todo-txt/syntax'
-require 'todo-txt/list'
-require 'todo-txt/task'
+require_relative 'todo'

data/lib/todo.rb

@@ -0,0 +1,38 @@
+require 'logger'
+require 'todo/logger'
+require 'todo/options'
+require 'todo/syntax'
+require 'todo/list'
+require 'todo/task'
+require 'todo/file'
+
+# Allows for easy management of task lists and tasks in the todo.txt format.
+module Todo
+  # Provides global options for customizing todo list behaviour.
+  class << self
+    attr_accessor :options_instance
+  end
+
+  # Global access to custom options.
+  #
+  # Example:
+  #
+  #   if Todo.options.require_completed_on
+  #     # Do something
+  #   end
+  def self.options
+    self.options_instance ||= Options.new
+  end
+
+  # Customize global list behaviour.
+  #
+  # Example:
+  #
+  #   Todo.customize do |opts|
+  #     opts.require_completed_on = false
+  #   end
+  def self.customize
+    self.options_instance ||= Options.new
+    yield(options_instance)
+  end
+end

data/lib/todo/file.rb

@@ -0,0 +1,83 @@
+module Todo
+  # A high level wrapper around the Ruby File interface which supports reading
+  # from and writing to an IO handle with Todo::Task objects.
+  class File
+    # Open a list file handle and pass it to the given block. The file is
+    # automatically closed when the block returns.
+    #
+    # The file is opened in read-only mode by default.
+    #
+    #  Todo::File.open("~/Dropbox/todo/todo.txt") do |file|
+    #    file.each_task do |task|
+    #      puts task.done?
+    #    end
+    #  end
+    #
+    # @param [String, Pathname] path
+    # @param [String] mode
+    def self.open(path, mode = 'r')
+      ios = new(path, mode)
+
+      if block_given?
+        yield ios
+        return ios.close
+      end
+
+      ios
+    end
+
+    # @param [String, Pathname] path
+    def self.read(path)
+      list = []
+
+      open(path) do |file|
+        file.each_task do |task|
+          list << task
+        end
+      end
+
+      list
+    end
+
+    # @param [String, Pathname] path
+    # @param [Array, Todo::List] list
+    def self.write(path, list)
+      open(path, 'w') do |file|
+        list.each do |task|
+          file.puts(task)
+        end
+      end
+    end
+
+    # @param [String, Pathname] path
+    # @param [String] mode
+    def initialize(path, mode = 'r')
+      @ios = ::File.open(path, mode)
+    end
+
+    # Executes the block for every task in the list.
+    def each
+      return enum_for(:each) unless block_given?
+
+      @ios.each_line do |line|
+        yield Task.new(line)
+      end
+    end
+
+    alias each_task each
+
+    # Writes the given tasks to the underlying IO handle.
+    #
+    # @overload puts(task, ...)
+    #   @param [Todo::Task] task
+    #   @param [Todo::Task] ...
+    def puts(*tasks)
+      @ios.puts(tasks.map(&:to_s))
+    end
+
+    # Closes the IO handle and flushes any pending writes.
+    def close
+      @ios.close
+    end
+  end
+end

data/lib/todo/list.rb

@@ -0,0 +1,127 @@
+module Todo
+  # Initializes a Todo List object with a path to the corresponding todo.txt
+  # file. For example, if your todo.txt file is located at:
+  #
+  #   /home/sam/Dropbox/todo/todo.txt
+  #
+  # You would initialize the list object like:
+  #
+  #   list = Todo::List.new("/home/sam/Dropbox/todo/todo.txt")
+  #
+  # Alternately, you can initialize the object with an array of strings or
+  # tasks. If the array is of strings, the strings will be converted into
+  # tasks. You can supply a mixed list of string and tasks if you wish.
+  #
+  # Example:
+  #
+  #   tasks = []
+  #   tasks << "A task line"
+  #   tasks << Todo::Task.new("A task object")
+  #
+  #   list = Todo::List.new(tasks)
+  class List < Array
+    def initialize(list)
+      case list
+      when Array
+        tasks = list.map do |item|
+          case item
+          when String then Task.new(item)
+          when Task then item
+          else
+            raise "Cannot add #{item.class} to list."
+          end
+        end
+
+        concat(tasks)
+
+      when String
+        @path = list
+        concat(File.read(list))
+      end
+    end
+
+    # The path to the todo.txt file that you supplied when you created the
+    # Todo::List object.
+    attr_reader :path
+
+    # Filters the list by priority and returns a new list.
+    #
+    # Example:
+    #
+    #   list = Todo::List.new("/path/to/list")
+    #   list.by_priority("A")
+    #   # => Will be a new list with only priority 'A' tasks
+    #
+    # @param priority [String]
+    # @return [Todo::List]
+    def by_priority(priority)
+      List.new(select { |task| task.priority == priority })
+    end
+
+    # Filters the list by context and returns a new list.
+    #
+    # Example:
+    #
+    #   list = Todo::List.new("/path/to/list")
+    #   list.by_context("@admin")
+    #   # => <Todo::List> filtered by '@admin'
+    #
+    # @param context [String]
+    # @return [Todo::List]
+    def by_context(context)
+      List.new(select { |task| task.contexts.include? context })
+    end
+
+    # Filters the list by project and returns a new list.
+    #
+    # Example:
+    #
+    #   list = Todo::List.new("/path/to/list")
+    #   list.by_project("+blog")
+    #   # => <Todo::List> filtered by '+blog'
+    #
+    # @param project [String]
+    # @return [Todo::List]
+    def by_project(project)
+      List.new(select { |task| task.projects.include? project })
+    end
+
+    # Filters the list by completed tasks and returns a new list.
+    #
+    # Example:
+    #
+    #   list = Todo::List.new("/path/to/list")
+    #   list.by_done
+    #   # => <Todo::List> filtered by tasks that are done
+    #
+    # @return [Todo::List]
+    def by_done
+      List.new(select(&:done?))
+    end
+
+    # Filters the list by incomplete tasks and returns a new list.
+    #
+    # Example:
+    #
+    #   list = Todo::List.new("/path/to/list")
+    #   list.by_not_done
+    #   # => <Todo::List> filtered by tasks that are not done
+    #
+    # @return [Todo::List]
+    def by_not_done
+      List.new(select { |task| task.done? == false })
+    end
+
+    # Saves the list to the original file location.
+    #
+    # Warning: This is a destructive operation and will overwrite any existing
+    # content in the file. It does not attempt to diff and append changes.
+    #
+    # If no `path` is specified in the constructor then an error is raised.
+    def save!
+      raise "No path specified." unless path
+
+      File.write(path, self)
+    end
+  end
+end

data/lib/{todo-txt → todo}/options.rb

@@ -1,17 +1,4 @@
 module Todo
-  class << self
-    attr_accessor :options_instance
-  end
-
-  def self.options
-    self.options_instance ||= Options.new
-  end
-
-  def self.customize
-    self.options_instance ||= Options.new
-    yield(options_instance)
-  end
-
   # Options for default preferences and library settings that can be customized
   # by clients of the gem.
   class Options

data/lib/{todo-txt → todo}/syntax.rb

@@ -1,5 +1,5 @@
 module Todo
-  # Parsing and extraction of the core syntax fragments in todo.txt lines.
+  # Supports parsing and extracting core syntax fragments from todo.txt lines.
   module Syntax
     # The regex used to match contexts.
     CONTEXTS_PATTERN = /(?:\s+|^)@[^\s]+/
@@ -19,6 +19,9 @@ module Todo
     # The regex used to match due date.
     DUE_ON_PATTERN = /(?:due:)(\d{4}-\d{2}-\d{2})(?:\s+|$)/i
 
+    # The regex used to match generic tags.
+    TAGS_PATTERN = /([a-z]+):([a-z0-9_-]+)/i
+
     # Extracts the readable text content of a task line, stripping out all the
     # discrete pieces of metadata (priority, dates, completion flag, projects,
     # contexts, etc).
@@ -76,8 +79,8 @@ module Todo
 
     # Checks whether the given todo item has a completion flag set.
     #
-    # This provides support for ad-hoc handwritten lists where the completed flag
-    # is set but there is no completed date.
+    # This provides support for ad-hoc handwritten lists where the completed
+    # flag is set but there is no completed date.
     #
     # @param line [String] the todo item to be processed
     # @return [Boolean]
@@ -85,18 +88,13 @@ module Todo
       line[0] == COMPLETED_FLAG && line[1] == SINGLE_SPACE
     end
 
-    # Extracts the completion date for the given todo item.
-    # Returns nil if a valid date is not found.
+    # Extracts the collection of tag annotations for the given todo item.
+    # Returns an empty hash if no tags are found.
     #
     # @param line [String] the todo item to be processed
-    # @return [Date] the due date of the line
-    def extract_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
+    # @return [Hash<Symbol,String>] the collection of tag annotations
+    def extract_tags(line)
+      line.scan(TAGS_PATTERN).map { |tag, val| [tag.downcase.to_sym, val] }.to_h
     end
 
     # Extract the list of `@context` tags out of the task line.

data/lib/{todo-txt → todo}/task.rb

@@ -12,36 +12,37 @@ module Todo
     include Todo::Logger
     include Todo::Syntax
 
-    def initialize(task)
-      @orig = task
-      @priority = extract_priority(orig)
-      @created_on = extract_created_on(orig)
-      @due_on = extract_due_on_date(orig)
-      @contexts ||= extract_contexts(orig)
-      @projects ||= extract_projects(orig)
+    def initialize(line)
+      @raw = line
+      @priority = extract_priority(raw)
+      @created_on = extract_created_on(raw)
+      @tags = extract_tags(raw)
+      @contexts ||= extract_contexts(raw)
+      @projects ||= extract_projects(raw)
 
       if Todo.options.require_completed_on
-        @completed_on = extract_completed_date(orig)
+        @completed_on = extract_completed_date(raw)
         @is_completed = !@completed_on.nil?
       else
-        @completed_on = extract_completed_date(orig)
-        @is_completed = check_completed_flag(orig)
+        @completed_on = extract_completed_date(raw)
+        @is_completed = check_completed_flag(raw)
       end
     end
 
-    # Returns the original content of the task.
+    # Returns the raw content of the original task line.
     #
     # Example:
     #
-    #   task = Todo::Task.new "(A) @context +project Hello!"
-    #   task.orig #=> "(A) @context +project Hello!"
-    attr_reader :orig
+    #   task = Todo::Task.new("(A) @context +project Hello!")
+    #   task.raw
+    #   # => "(A) @context +project Hello!"
+    attr_reader :raw
 
     # Returns the task's creation date, if any.
     #
     # Example:
     #
-    #   task = Todo::Task.new "(A) 2012-03-04 Task."
+    #   task = Todo::Task.new("(A) 2012-03-04 Task.")
     #   task.created_on
     #   #=> <Date: 2012-03-04 (4911981/2,0,2299161)>
     #
@@ -54,53 +55,57 @@ module Todo
     #
     # Example:
     #
-    #   task = Todo::Task.new "x 2012-03-04 Task."
+    #   task = Todo::Task.new("x 2012-03-04 Task.")
     #   task.completed_on
-    #   #=> <Date: 2012-03-04 (4911981/2,0,2299161)>
+    #   # => <Date: 2012-03-04 (4911981/2,0,2299161)>
     #
     # Dates _must_ be in the YYYY-MM-DD format as specified in the todo.txt
     # format. Dates in any other format will be classed as malformed and this
     # attribute will be nil.
     attr_reader :completed_on
 
-    # Returns the task's due date, if any.
+    # Returns tag annotations embedded in the list item.
     #
     # Example:
     #
-    #   task = Todo::Task.new "(A) This is a task. due:2012-03-04"
-    #   task.due_on
-    #   #=> <Date: 2012-03-04 (4911981/2,0,2299161)>
+    #   task = Todo::Task.new("Some task. due:2016-06-16 hello:world")
+    #   task.tags
+    #   # => { :due => '2016-06-16', :hello => 'world' }
     #
-    # Dates _must_ be in the YYYY-MM-DD format as specified in the todo.txt
-    # format. Dates in any other format will be classed as malformed and this
-    # attribute will be nil.
-    attr_reader :due_on
+    #   task = Todo::Task.new("Some task.")
+    #   task.tags.empty?
+    #   # => true
+    attr_reader :tags
 
     # Returns the priority, if any.
     #
     # Example:
     #
-    #   task = Todo::Task.new "(A) Some task."
-    #   task.priority #=> "A"
+    #   task = Todo::Task.new("(A) Some task.")
+    #   task.priority
+    #   # => "A"
     #
     #   task = Todo::Task.new "Some task."
-    #   task.priority #=> nil
+    #   task.priority
+    #   # => nil
     attr_reader :priority
 
     # Returns an array of all the @context annotations.
     #
     # Example:
     #
-    #   task = Todo:Task.new "(A) @context Testing!"
-    #   task.context #=> ["@context"]
+    #   task = Todo:Task.new("(A) @context Testing!")
+    #   task.context
+    #   # => ["@context"]
     attr_reader :contexts
 
     # Returns an array of all the +project annotations.
     #
     # Example:
     #
-    #   task = Todo:Task.new "(A) +test Testing!"
-    #   task.projects #=> ["+test"]
+    #   task = Todo:Task.new("(A) +test Testing!")
+    #   task.projects
+    #   # => ["+test"]
     attr_reader :projects
 
     # Gets just the text content of the todo, without the priority, contexts
@@ -108,29 +113,44 @@ module Todo
     #
     # Example:
     #
-    #   task = Todo::Task.new "(A) @test Testing!"
-    #   task.text #=> "Testing!"
+    #   task = Todo::Task.new("(A) @test Testing!")
+    #   task.text
+    #   # => "Testing!"
     def text
-      @text ||= extract_item_text(orig)
+      @text ||= extract_item_text(raw)
     end
 
-    # Returns the task's creation date, if any.
+    # Deprecated. See: #created_on
+    def date
+      logger.warn("`Task#date` is deprecated, use `Task#created_on` instead.")
+
+      @created_on
+    end
+
+    # Deprecated. See: #raw
+    def orig
+      logger.warn("`Task#orig` is deprecated, use `Task#raw` instead.")
+
+      raw
+    end
+
+    # Returns the task's due date, if any.
     #
     # Example:
     #
-    #   task = Todo::Task.new "(A) 2012-03-04 Task."
-    #   task.date
-    #   #=> <Date: 2012-03-04 (4911981/2,0,2299161)>
+    #   task = Todo::Task.new("(A) This is a task. due:2012-03-04")
+    #   task.due_on
+    #   # => <Date: 2012-03-04 (4911981/2,0,2299161)>
     #
     # Dates _must_ be in the YYYY-MM-DD format as specified in the todo.txt
     # format. Dates in any other format will be classed as malformed and this
-    # method will return nil.
-    #
-    # Deprecated
-    def date
-      logger.warn("Task#date is deprecated, use created_on instead.")
-
-      @created_on
+    # attribute will be nil.
+    def due_on
+      begin
+        Date.parse(tags[:due]) if tags[:due] =~ /(\d{4}-\d{2}-\d{2})/
+      rescue ArgumentError
+        return nil
+      end
     end
 
     # Returns whether a task's due date is in the past.
@@ -139,22 +159,22 @@ module Todo
     #
     #   task = Todo::Task.new("This task is overdue! due:#{Date.today - 1}")
     #   task.overdue?
-    #   #=> true
+    #   # => true
     def overdue?
       !due_on.nil? && due_on < Date.today
     end
 
-    # Returns if the task is done.
+    # Returns true if the task is completed.
     #
     # Example:
     #
-    #   task = Todo::Task.new "x 2012-12-08 Task."
+    #   task = Todo::Task.new("x 2012-12-08 Task.")
     #   task.done?
-    #   #=> true
+    #   # => true
     #
-    #   task = Todo::Task.new "Task."
+    #   task = Todo::Task.new("Task.")
     #   task.done?
-    #   #=> false
+    #   # => false
     def done?
       @is_completed
     end
@@ -163,17 +183,16 @@ module Todo
     #
     # Example:
     #
-    #   task = Todo::Task.new "2012-12-08 Task."
+    #   task = Todo::Task.new("2012-12-08 Task.")
+    #
     #   task.done?
-    #   #=> false
+    #   # => false
     #
+    #   # Complete the task
     #   task.do!
+    #
     #   task.done?
-    #   #=> true
-    #   task.created_on
-    #   #=> <Date: 2012-12-08 (4911981/2,0,2299161)>
-    #   task.completed_on
-    #   #=> # the current date
+    #   # => true
     def do!
       @completed_on = Date.today
       @is_completed = true
@@ -184,21 +203,19 @@ module Todo
     #
     # Example:
     #
-    #   task = Todo::Task.new "x 2012-12-08 2012-03-04 Task."
+    #   task = Todo::Task.new("x 2012-12-08 2012-03-04 Task.")
     #   task.done?
-    #   #=> true
+    #   # => true
     #
+    #   # Undo the completed task
     #   task.undo!
+    #
     #   task.done?
-    #   #=> false
-    #   task.created_on
-    #   #=> <Date: 2012-03-04 (4911981/2,0,2299161)>
-    #   task.completed_on
-    #   #=> nil
+    #   # => false
     def undo!
       @completed_on = nil
       @is_completed = false
-      @priority = extract_priority(orig)
+      @priority = extract_priority(raw)
     end
 
     # Increases the priority until A. If it's nil, it sets it to A.
@@ -225,17 +242,20 @@ module Todo
     #
     # Example:
     #
-    #   task = Todo::Task.new "x 2012-12-08 Task."
+    #   task = Todo::Task.new("x 2012-12-08 Task.")
     #   task.done?
-    #   #=> true
+    #   # => true
     #
+    #   # Toggle between complete and incomplete
     #   task.toggle!
+    #
     #   task.done?
-    #   #=> false
+    #   # => false
     #
     #   task.toggle!
+    #
     #   task.done?
-    #   #=> true
+    #   # => true
     def toggle!
       done? ? undo! : do!
     end
@@ -244,25 +264,27 @@ module Todo
     #
     # Example:
     #
-    #   task = Todo::Task.new "(A) 2012-12-08 Task"
+    #   task = Todo::Task.new("(A) 2012-12-08 Task")
     #   task.to_s
-    #   #=> "(A) 2012-12-08 Task"
+    #   # => "(A) 2012-12-08 Task"
     def to_s
-      priority_string = priority ? "(#{priority}) " : ""
-      done_string = done? ? "x #{completed_on} " : ""
-      created_on_string = created_on ? "#{created_on} " : ""
-      contexts_string = contexts.empty? ? "" : " #{contexts.join ' '}"
-      projects_string = projects.empty? ? "" : " #{projects.join ' '}"
-      due_on_string = due_on.nil? ? "" : " due:#{due_on}"
-      "#{done_string}#{priority_string}#{created_on_string}#{text}#{contexts_string}#{projects_string}#{due_on_string}"
+      [
+        done? && "x #{completed_on}",
+        priority && "(#{priority})",
+        created_on.to_s,
+        text,
+        contexts.join(' '),
+        projects.join(' '),
+        tags.map { |tag,val| "#{tag}:#{val}" }.join(' ')
+      ].grep(String).join(' ').strip
     end
 
     # Compares the priorities of two tasks.
     #
     # Example:
     #
-    #   task1 = Todo::Task.new "(A) Priority A."
-    #   task2 = Todo::Task.new "(B) Priority B."
+    #   task1 = Todo::Task.new("(A) Priority A.")
+    #   task2 = Todo::Task.new("(B) Priority B.")
     #
     #   task1 > task2
     #   # => true

data/spec/todo-txt/file_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Todo::File do
+  let(:path) { File.dirname(__FILE__) + '/../data/todo.txt' }
+
+  context 'reading input' do
+    it 'should raise a system error when file not found' do
+      expect { Todo::File.open('not_found') }.to raise_error Errno::ENOENT
+    end
+
+    it 'should yield each task from block passed to open' do
+      Todo::File.open(path) do |file|
+        file.each do |task|
+          expect(task).to be_a Todo::Task
+        end
+      end
+    end
+
+    it 'should return a file object when no block is passed to open' do
+      file = Todo::File.open(path)
+      expect(file).to be_a Todo::File
+    end
+
+    it 'should return an enumerator when no block is passed to each' do
+      enumerator = Todo::File.open(path).each
+      expect(enumerator).to be_a Enumerator
+      expect(enumerator.next).to be_a Todo::Task
+    end
+
+    it 'should read a file into an array of tasks' do
+      list = Todo::File.read(path)
+      expect(list).to be_a Array
+      expect(list.first).to be_a Todo::Task
+    end
+  end
+
+  context 'writing' do
+    let(:path) { File.dirname(__FILE__) + '/../data/test.txt' }
+
+    it 'should write to a list file when initialized in writeable mode' do
+      file = Todo::File.new(path, 'w')
+      file.puts(Todo::Task.new('Task 1'))
+      file.puts(Todo::Task.new('Task 2'))
+      file.close
+
+      target = File.open(path)
+      expect(target.gets.rstrip).to eq("Task 1")
+      expect(target.gets.rstrip).to eq("Task 2")
+    end
+
+    it 'should write to a list file when opened in writeable mode' do
+      Todo::File.open(path, 'w') do |file|
+        file.puts(Todo::Task.new('Task 1'))
+        file.puts(Todo::Task.new('Task 2'))
+      end
+
+      target = File.open(path)
+      expect(target.gets.rstrip).to eq("Task 1")
+      expect(target.gets.rstrip).to eq("Task 2")
+    end
+
+    it 'should write each task in the list to a line in the file' do
+      list = Todo::List.new([Todo::Task.new('Task 1'), Todo::Task.new('Task 2')])
+      Todo::File.write(path, list)
+
+      target = File.open(path)
+      expect(target.gets.rstrip).to eq("Task 1")
+      expect(target.gets.rstrip).to eq("Task 2")
+    end
+
+    after do
+      File.delete(path)
+    end
+  end
+end

data/spec/todo-txt/list_spec.rb

@@ -7,17 +7,17 @@ describe Todo::List 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)
+      items = []
+      items << "(A) A string task!"
+      items << Todo::Task.new("(A) An actual task!")
+      expect(Todo::List.new(items).length).to eq(2)
     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)
+      items = []
+      items << "(A) A string task!"
+      items << Todo::Task.new("(A) An actual task!")
+      expect(Todo::List.new(items).path).to eq(nil)
     end
   end
 
@@ -38,12 +38,9 @@ describe Todo::List do
   end
 
   it 'accepts a mix of tasks and strings' do
-    l = Todo::List.new([
-      "A task!",
-      Todo::Task.new("Another task!"),
-    ])
+    mixed = Todo::List.new(["A task!", Todo::Task.new("Another task!")])
 
-    expect(l.length).to eq(2)
+    expect(mixed.length).to eq(2)
   end
 
   it 'has the correct path' do
@@ -97,9 +94,7 @@ describe Todo::List do
   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

data/spec/todo-txt/syntax_spec.rb

@@ -115,17 +115,25 @@ describe Todo::Syntax do
     end
   end
 
-  describe '#extract_due_on_date' do
+  describe '#extract_tags' do
     specify 'empty task' do
-      expect(extract_due_on_date('')).to be nil
+      expect(extract_tags('')).to eq({})
     end
 
-    specify 'task without due date' do
-      expect(extract_due_on_date('something to do')).to be nil
+    specify 'task without tag' do
+      expect(extract_tags('something to do')).to be {}
     end
 
     specify 'task with due date' do
-      expect(extract_due_on_date('something to do due:2016-03-30')).to eq(Date.new(2016, 03, 30))
+      expect(extract_tags('something to do due:2016-03-30')).to eq(:due => '2016-03-30')
+    end
+
+    specify 'task with case-insensitive due date' do
+      expect(extract_tags('something to do DUE:2016-03-30')).to eq(:due => '2016-03-30')
+    end
+
+    specify 'task with multiple tags' do
+      expect(extract_tags('something to do hello:world and foo:bar')).to eq(:hello => 'world', :foo => 'bar')
     end
   end
 

data/spec/todo-txt/task_spec.rb

@@ -11,7 +11,7 @@ describe Todo::Task do
       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.raw).to eq('(A) 2012-12-08 My task @test +test2')
       end
     end
 
@@ -32,7 +32,7 @@ describe Todo::Task do
 
     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')
+      expect(task.raw).to eq('(A) This is an awesome task, yo. +winning')
     end
 
     it 'should be able to get just the text, no contexts etc.' do
@@ -411,11 +411,22 @@ 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'
-      error_message = 'Task#date is deprecated, use created_on instead.'
+      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 `Task#created_on` instead.'
 
       expect(logger).to receive(:warn).with(error_message)
       task.date
     end
+
+    it 'should call @logger.warn if #orig called as deprecated method' 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')
+      error_message = '`Task#orig` is deprecated, use `Task#raw` instead.'
+
+      expect(logger).to receive(:warn).with(error_message)
+      task.orig
+    end
   end
 end

data/todo-txt.gemspec

@@ -1,11 +1,11 @@
 Gem::Specification.new do |s|
   s.name = 'todo-txt'
-  s.version = '0.9'
-  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.version = '0.10'
+  s.authors = ['Sam Rose']
+  s.email = 'samwho@lbak.co.uk'
+  s.summary = 'A client library for parsing todo.txt files.'
+  s.homepage = 'http://github.com/samwho/todo-txt-gem'
+  s.description = 'Allows for simple parsing of todo.txt files, as per Gina Trapani\'s todo.txt project.'
   s.required_ruby_version = '>= 2.0'
   s.license = 'GPL-2'
   s.files = `git ls-files`.split(/\n/)

data/todo.txt

@@ -1,13 +1,19 @@
 x 2016-04-21 modify list#save! to work with windows line separators +bug
 determine correct/expected behaviour for missing file paths +feature +api
 dirty flag on lists that have modifications after loading +feature
-extract file handling into separate IO-like module +refactor +api
+x 2016-04-27 extract file handling into separate IO-like module +refactor +api
 implement enumerable API on list rather than inherit from array +api
 list operations should be algebraically closed +api
 include rubocop in travis builds +build
 use << operation to move tasks between lists +api +feature
 create github issue with roadmap for 1.0 release +feature +api
 consider rewriting file write tests with mocking and stringio +refactor +build
-remove deprecated date method from task +api
+remove deprecated date and orig methods from task +api
 pass in options as an instance rather than make it always global +refactor +api
 save a backup of an existing todo file when the IO object is read in +feature
+x 2016-06-16 extract `due:` formatting into a more general syntax for adding tags +feature +refactor +api
+x rename lib path to match standard gem conventions +refactor
+x 2016-04-23 tidy up code examples in doc comments to match ruby styleguide conventions +refactor +docs
+consider renaming or aliasing `#done?` to `#complete?` +api +refactor
+add complementary method returning opposite of `#done?` to provide symmetry +api
+restructure test specs to reflect different core concerns and areas of functionality +refactor

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: todo-txt
 version: !ruby/object:Gem::Version
-  version: '0.9'
+  version: '0.10'
 platform: ruby
 authors:
 - Sam Rose
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-20 00:00:00.000000000 Z
+date: 2016-07-02 00:00:00.000000000 Z
 dependencies: []
 description: Allows for simple parsing of todo.txt files, as per Gina Trapani's todo.txt
   project.
@@ -26,14 +26,17 @@ files:
 - README.md
 - Rakefile
 - lib/todo-txt.rb
-- lib/todo-txt/list.rb
-- lib/todo-txt/logger.rb
-- lib/todo-txt/options.rb
-- lib/todo-txt/syntax.rb
-- lib/todo-txt/task.rb
+- lib/todo.rb
+- lib/todo/file.rb
+- lib/todo/list.rb
+- lib/todo/logger.rb
+- lib/todo/options.rb
+- lib/todo/syntax.rb
+- lib/todo/task.rb
 - spec/data/tasks.txt
 - spec/data/todo.txt
 - spec/spec_helper.rb
+- spec/todo-txt/file_spec.rb
 - spec/todo-txt/list_spec.rb
 - spec/todo-txt/options/require_completed_on_spec.rb
 - spec/todo-txt/options_spec.rb
@@ -61,9 +64,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A client library for parsing todo.txt files.
 test_files: []
-has_rdoc: 

data/lib/todo-txt/list.rb

@@ -1,122 +0,0 @@
-module Todo
-  # Initializes a Todo List object with a path to the corresponding todo.txt
-  # file. For example, if your todo.txt file is located at:
-  #
-  #   /home/sam/Dropbox/todo/todo.txt
-  #
-  # You would initialize this object like:
-  #
-  #   list = Todo::List.new "/home/sam/Dropbox/todo/todo-txt"
-  #
-  # Alternately, you can initialize this object with an array of strings or
-  # tasks. If the array is of strings, the strings will be converted into
-  # tasks. You can supply a mixed list of string and tasks if you wish.
-  #
-  # Example:
-  #
-  #   array = Array.new
-  #   array.push "(A) A string task!"
-  #   array.push Todo::Task.new("(A) An actual task!")
-  #
-  #   list = Todo::List.new array
-  class List < Array
-    def initialize(list)
-      if list.is_a? Array
-        # No file path was given.
-        @path = nil
-
-        # If path is an array, loop over it, adding to self.
-        list.each do |task|
-          # If it's a string, make a new task out of it.
-          if task.is_a? String
-            push Task.new task
-          # If it's a task, just add it.
-          elsif task.is_a? Todo::Task
-            push task
-          end
-        end
-      elsif list.is_a? String
-        @path = list
-
-        # Read in lines from file, create Todo::Tasks out of them and push them
-        # onto self.
-        File.open(list) do |file|
-          file.each_line { |line| push Task.new(line) }
-        end
-      end
-    end
-
-    # The path to the todo.txt file that you supplied when you created the
-    # Todo::List object.
-    attr_reader :path
-
-    # Filters the list by priority and returns a new list.
-    #
-    # Example:
-    #
-    #   list = Todo::List.new "/path/to/list"
-    #   list.by_priority "A" #=> Will be a new list with only priority A tasks
-    def by_priority(priority)
-      List.new(select { |task| task.priority == priority })
-    end
-
-    # Filters the list by context and returns a new list.
-    #
-    # Example:
-    #
-    #   list = Todo::List.new "/path/to/list"
-    #   list.by_context "@context" #=> Will be a new list with only tasks
-    #                                  containing "@context"
-    def by_context(context)
-      List.new(select { |task| task.contexts.include? context })
-    end
-
-    # Filters the list by project and returns a new list.
-    #
-    # Example:
-    #
-    #   list = Todo::List.new "/path/to/list"
-    #   list.by_project "+project" #=> Will be a new list with only tasks
-    #                                  containing "+project"
-    def by_project(project)
-      List.new(select { |task| task.projects.include? project })
-    end
-
-    # Filters the list by completed tasks and returns a new list.
-    #
-    # Example:
-    #
-    #   list = Todo::List.new "/path/to/list"
-    #   list.by_done #=> Will be a new list with only tasks marked with
-    #                    an [x]
-    def by_done
-      List.new(select(&:done?))
-    end
-
-    # Filters the list by incomplete tasks and returns a new list.
-    #
-    # Example:
-    #
-    #   list = Todo::List.new "/path/to/list"
-    #   list.by_not_done #=> Will be a new list with only incomplete tasks
-    def by_not_done
-      List.new(select { |task| task.done? == false })
-    end
-
-    # Saves the list to the original file location.
-    #
-    # Warning: This is a destructive operation and will overwrite what is
-    # currently there.
-    #
-    # If no `path` is specified in the constructor then an error is raised.
-    def save!
-      raise "No path specified." unless path
-
-      File.open(path, 'w') do |outfile|
-        each do |task|
-          outfile.puts(task.to_s)
-        end
-      end
-    end
-  end
-end