todo-txt 0.7 → 0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd4d9a9131316d54020bfc771727481a05a7694f
-  data.tar.gz: 98e9a7d6a3ba5070db9521140d7d2f340a59cc27
+  metadata.gz: 61f9189159159b6e65f5f74b988b2e10bce9ebdd
+  data.tar.gz: d4b2af334263168828b8c55907bb7cbd88d5e961
 SHA512:
-  metadata.gz: 5d7c8d30855037df15053d219e4051dbd2f93d29bca14fa2f7477b706d634a433a282f9e51d3a7239b92d63f5e47bf291463846c5f663ac19b31cff197e0772a
-  data.tar.gz: 1cd0e7eed6b6de21fc4e6d19b8addff687f0c513c1c823441696ff8dae4c9466ac9ca3283fa53290d6e2525f518c89ace94dafef66895b3b8fe24a1db978fd89
+  metadata.gz: e21f06a513c28f57ee49574a9cf433d3adaf84bd6ce7de7101263ddd414919cd83b6f2d3d73c7720a85bd3c028e6b22689b7208134d5727bd1ec6d55fa204619
+  data.tar.gz: bec7f7985f84d4d966936f454ebb21d7c820e67488e5fe98c2eceb013a2e5454686084377e4f924a6eaac5d56c47d69a7c50451972ea5d257475a1ff1e720b7d

data/.gitignore

@@ -2,3 +2,4 @@
 pkg/
 coverage/
 Gemfile.lock
+*.gem

data/lib/todo-txt.rb

@@ -3,6 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'logger'
 require 'todo-txt/logger'
+require 'todo-txt/options'
 require 'todo-txt/syntax'
 require 'todo-txt/list'
 require 'todo-txt/task'

data/lib/todo-txt/options.rb

@@ -0,0 +1,41 @@
+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
+
+  class Options
+    # Require all done tasks to have a `completed_on` date. True by default.
+    #
+    # - When `true`, tasks with invalid dates are considered not done.
+    # - When `false`, tasks starting with `x ` are considered done.
+    #
+    # @return [Boolean]
+    attr_accessor :require_completed_on
+
+    # PENDING
+    #
+    # Whether or not to preserve original field order for roundtripping.
+    #
+    # @return [Boolean]
+    attr_accessor :maintain_field_order
+
+    def initialize
+      reset
+    end
+
+    # Reset to defaults.
+    def reset
+      @require_completed_on = true
+      @maintain_field_order = false
+    end
+  end
+end

data/lib/todo-txt/syntax.rb

@@ -52,7 +52,7 @@ module Todo
     #
     # @param line [String] the todo item to be processed
     # @return [Date] the completed date of the line
-    def get_completed_date(line)
+    def extract_completed_date(line)
       date = COMPLETED_ON_PATTERN.match(line)
       begin
         Date.parse(date[1]) if date
@@ -61,6 +61,20 @@ module Todo
       end
     end
 
+    COMPLETED_FLAG = 'x'.freeze
+    SINGLE_SPACE = ' '.freeze
+
+    # 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.
+    #
+    # @param line [String] the todo item to be processed
+    # @return [Boolean]
+    def check_completed_flag(line)
+      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.
     #

data/lib/todo-txt/task.rb

@@ -14,11 +14,18 @@ module Todo
     #   task = Todo::Task.new("(A) A high priority task!")
     def initialize task
       @orig = task
-      @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)
+
+      if Todo.options.require_completed_on
+        @completed_on = extract_completed_date(orig)
+        @is_completed = !@completed_on.nil?
+      else
+        @completed_on = extract_completed_date(orig)
+        @is_completed = check_completed_flag(orig)
+      end
     end
 
     # Returns the original content of the task.
@@ -148,7 +155,7 @@ module Todo
     #   task.done?
     #   #=> false
     def done?
-      !@completed_on.nil?
+      @is_completed
     end
 
     # Completes the task on the current date.
@@ -168,6 +175,7 @@ module Todo
     #   #=> # the current date
     def do!
       @completed_on = Date.today
+      @is_completed = true
       @priority = nil
     end
 
@@ -188,6 +196,7 @@ module Todo
     #   #=> nil
     def undo!
       @completed_on = nil
+      @is_completed = false
       @priority = orig_priority(orig)
     end
 

data/spec/todo-txt/options/require_completed_on_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe '#require_completed_on' do
+  context 'set to true' do
+    it 'should treat tasks without the done flag as not done' do
+      task = Todo::Task.new('this task is treated as incomplete')
+      expect(task.done?).to be false
+    end
+
+    it 'should treat tasks with a the done flag and no date as not done' do
+      task = Todo::Task.new('x this task is treated as incomplete')
+      expect(task.done?).to be false
+    end
+
+    it 'should treat tasks with a the done flag and a completion date as done' do
+      task = Todo::Task.new('x 2016-04-08 this task is treated as complete')
+      expect(task.done?).to be true
+    end
+  end
+
+  context 'set to false' do
+    before(:all) do
+      Todo.customize do |options|
+        options.require_completed_on = false
+      end
+    end
+
+    it 'should treat tasks without the done flag as not done' do
+      task = Todo::Task.new('this task is treated as incomplete')
+      expect(task.done?).to be false
+    end
+
+    it 'should treat tasks with the done flag as done' do
+      task = Todo::Task.new('x this task is treated as complete')
+      expect(task.done?).to be true
+    end
+
+    after(:all) do
+      Todo.options.reset
+    end
+  end
+end

data/spec/todo-txt/options_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Todo::Options do
+  it 'should be available by default in the top-level module' do
+    expect(Todo.options).to be_a Todo::Options
+  end
+
+  it 'should provide require_completed_on as true by default' do
+    expect(Todo.options.require_completed_on).to be true
+  end
+
+  it 'should provide maintain_field_order as false by default' do
+    expect(Todo.options.maintain_field_order).to be false
+  end
+
+  it 'should support customization' do
+    Todo.customize do |options|
+      options.require_completed_on = false
+    end
+
+    expect(Todo.options.require_completed_on).to be false
+  end
+
+  after(:all) do
+    Todo.options.reset
+  end
+end

data/spec/todo-txt/syntax_spec.rb

@@ -79,21 +79,39 @@ describe Todo::Syntax do
     end
   end
 
-  describe '#get_completed_date' do
+  describe '#extract_completed_date' do
     specify 'empty task' do
-      expect(get_completed_date('')).to be nil
+      expect(extract_completed_date('')).to be nil
     end
 
     specify 'uncompleted task' do
-      expect(get_completed_date('2016-03-29 something to do')).to be nil
+      expect(extract_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
+      expect(extract_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
+      expect(extract_completed_date('2016-03-29 something to do')).to be nil
+    end
+  end
+
+  describe '#check_completed_flag' do
+    specify 'empty task' do
+      expect(check_completed_flag('')).to be false
+    end
+
+    specify 'uncompleted task' do
+      expect(check_completed_flag('2016-03-29 something to do')).to be false
+    end
+
+    specify 'completed task without date' do
+      expect(check_completed_flag('x something to do')).to be true
+    end
+
+    specify 'completed task with date' do
+      expect(check_completed_flag('x 2016-03-29 something to do')).to be true
     end
   end
 

data/todo-txt.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = %q{todo-txt}
-  s.version = '0.7'
+  s.version = '0.8'
   s.authors = ["Sam Rose"]
   s.email = %q{samwho@lbak.co.uk}
   s.summary = %q{A client library for parsing todo.txt files.}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: todo-txt
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: '0.8'
 platform: ruby
 authors:
 - Sam Rose
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-04 00:00:00.000000000 Z
+date: 2016-04-08 00:00:00.000000000 Z
 dependencies: []
 description: Allows for simple parsing of todo.txt files, as per Gina Trapani's todo.txt
   project.
@@ -27,11 +27,14 @@ files:
 - 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
 - spec/data/todo.txt
 - spec/spec_helper.rb
 - spec/todo-txt/list_spec.rb
+- spec/todo-txt/options/require_completed_on_spec.rb
+- spec/todo-txt/options_spec.rb
 - spec/todo-txt/syntax_spec.rb
 - spec/todo-txt/task_spec.rb
 - todo-txt.gemspec