todo-txt 0.8 → 0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61f9189159159b6e65f5f74b988b2e10bce9ebdd
-  data.tar.gz: d4b2af334263168828b8c55907bb7cbd88d5e961
+  metadata.gz: 04e209879cbf8434759e4343c03bdbb2b48a7e3f
+  data.tar.gz: bad9b8396a6d32ef8eb8f647394de850d5c0a658
 SHA512:
-  metadata.gz: e21f06a513c28f57ee49574a9cf433d3adaf84bd6ce7de7101263ddd414919cd83b6f2d3d73c7720a85bd3c028e6b22689b7208134d5727bd1ec6d55fa204619
-  data.tar.gz: bec7f7985f84d4d966936f454ebb21d7c820e67488e5fe98c2eceb013a2e5454686084377e4f924a6eaac5d56c47d69a7c50451972ea5d257475a1ff1e720b7d
+  metadata.gz: 7d5599684ab23946adde905819a231f75d38029780c49e0771acd0258a6622fd88d5edd1c0e5ff2d6415b1e359047b7b6fbef8cd684c701ce94fdafa972d2b31
+  data.tar.gz: 9b7c601dad7b1a07541fea804b06a9c12490406501a7173b4e2e0dfaf26d5da320a7605960f4e8b9d5ba5f66d10dac3892c50bee9e2676d95fbb8df295f7c014

data/.rubocop.yml

@@ -0,0 +1,2 @@
+StringLiterals:
+  Enabled: false

data/lib/todo-txt.rb

@@ -1,6 +1,3 @@
-lib = File.dirname(__FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
 require 'logger'
 require 'todo-txt/logger'
 require 'todo-txt/options'

data/lib/todo-txt/list.rb

@@ -1,26 +1,26 @@
 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
-    # 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
-    def initialize list
+    def initialize(list)
       if list.is_a? Array
         # No file path was given.
         @path = nil
@@ -29,10 +29,10 @@ module Todo
         list.each do |task|
           # If it's a string, make a new task out of it.
           if task.is_a? String
-            self.push Todo::Task.new task
+            push Task.new task
           # If it's a task, just add it.
           elsif task.is_a? Todo::Task
-            self.push task
+            push task
           end
         end
       elsif list.is_a? String
@@ -41,16 +41,14 @@ module Todo
         # 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| self.push Todo::Task.new line }
+          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.
-    def path
-      @path
-    end
+    attr_reader :path
 
     # Filters the list by priority and returns a new list.
     #
@@ -58,8 +56,8 @@ module Todo
     #
     #   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
-      Todo::List.new self.select { |task| task.priority == priority }
+    def by_priority(priority)
+      List.new(select { |task| task.priority == priority })
     end
 
     # Filters the list by context and returns a new list.
@@ -69,8 +67,8 @@ module Todo
     #   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
-      Todo::List.new self.select { |task| task.contexts.include? context }
+    def by_context(context)
+      List.new(select { |task| task.contexts.include? context })
     end
 
     # Filters the list by project and returns a new list.
@@ -80,8 +78,8 @@ module Todo
     #   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
-      Todo::List.new self.select { |task| task.projects.include? 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.
@@ -92,7 +90,7 @@ module Todo
     #   list.by_done #=> Will be a new list with only tasks marked with
     #                    an [x]
     def by_done
-      Todo::List.new self.select { |task| task.done? }
+      List.new(select(&:done?))
     end
 
     # Filters the list by incomplete tasks and returns a new list.
@@ -102,7 +100,23 @@ module Todo
     #   list = Todo::List.new "/path/to/list"
     #   list.by_not_done #=> Will be a new list with only incomplete tasks
     def by_not_done
-      Todo::List.new self.select { |task| task.done? == false }
+      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

data/lib/todo-txt/options.rb

@@ -12,12 +12,23 @@ module Todo
     yield(options_instance)
   end
 
+  # Options for default preferences and library settings that can be customized
+  # by clients of the gem.
   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.
     #
+    # Example:
+    #
+    #   Todo.customize do |opts|
+    #     opts.require_completed_on = false
+    #   end
+    #
+    #   task = Todo::Task.new("x This is done!")
+    #   task.done? # => true
+    #
     # @return [Boolean]
     attr_accessor :require_completed_on
 

data/lib/todo-txt/syntax.rb

@@ -1,35 +1,45 @@
 module Todo
+  # Parsing and extraction of the core syntax fragments in todo.txt lines.
   module Syntax
-    # The regular expression used to match contexts.
-    CONTEXTS_PATTERN = /(?:\s+|^)@[^\s]+/.freeze
+    # The regex used to match contexts.
+    CONTEXTS_PATTERN = /(?:\s+|^)@[^\s]+/
 
     # The regex used to match projects.
-    PROJECTS_PATTERN = /(?:\s+|^)\+[^\s]+/.freeze
+    PROJECTS_PATTERN = /(?:\s+|^)\+[^\s]+/
 
     # The regex used to match priorities.
     PRIORITY_PATTERN = /(?:^|\s+)\(([A-Za-z])\)\s+/
 
     # The regex used to match creation date.
-    CREATED_ON_PATTERN = /(?:^|-\d{2}\s|\)\s)(\d{4}-\d{2}-\d{2})\s/.freeze
+    CREATED_ON_PATTERN = /(?:^|-\d{2}\s|\)\s)(\d{4}-\d{2}-\d{2})\s/
 
     # The regex used to match completion.
-    COMPLETED_ON_PATTERN = /^x\s+(\d{4}-\d{2}-\d{2})\s+/.freeze
+    COMPLETED_ON_PATTERN = /^x\s+(\d{4}-\d{2}-\d{2})\s+/
 
     # The regex used to match due date.
-    DUE_ON_PATTERN = /(?:due:)(\d{4}-\d{2}-\d{2})(?:\s+|$)/i.freeze
+    DUE_ON_PATTERN = /(?:due:)(\d{4}-\d{2}-\d{2})(?:\s+|$)/i
 
-    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
+    # Extracts the readable text content of a task line, stripping out all the
+    # discrete pieces of metadata (priority, dates, completion flag, projects,
+    # contexts, etc).
+    #
+    # @param line [String] the todo item to be processed
+    # @return [String] the text content of the item
+    def extract_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)
+    # Extracts the priority indicator from the task line.
+    #
+    # @param line [String] the todo item to be processed
+    # @return [String] the character (from A-Z) representing the priority
+    def extract_priority(line)
       line.match(PRIORITY_PATTERN)[1] if line =~ PRIORITY_PATTERN
     end
 
@@ -38,7 +48,7 @@ module Todo
     #
     # @param line [String] the todo item to be processed
     # @return [Date] the created date of the line
-    def orig_created_on(line)
+    def extract_created_on(line)
       date = line.match CREATED_ON_PATTERN
       begin
         Date.parse(date[1]) if date
@@ -80,7 +90,7 @@ module Todo
     #
     # @param line [String] the todo item to be processed
     # @return [Date] the due date of the line
-    def get_due_on_date(line)
+    def extract_due_on_date(line)
       date = DUE_ON_PATTERN.match(line)
       begin
         Date.parse(date[1]) if date
@@ -94,7 +104,7 @@ module Todo
     # @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 }
+      line.scan(CONTEXTS_PATTERN).map(&:strip)
     end
 
     # Extract the list of `+project` tags out of the task line.
@@ -102,7 +112,7 @@ module Todo
     # @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 }
+      line.scan(PROJECTS_PATTERN).map(&:strip)
     end
   end
 end

data/lib/todo-txt/task.rb

@@ -1,21 +1,22 @@
 require 'date'
 
 module Todo
+  # Creates a new task. The argument that you pass in must be the string
+  # representation of a task.
+  #
+  # Example:
+  #
+  #   task = Todo::Task.new("(A) A high priority task!")
   class Task
     include Comparable
     include Todo::Logger
     include Todo::Syntax
 
-    # Creates a new task. The argument that you pass in must be the string
-    # representation of a task.
-    #
-    # Example:
-    #
-    #   task = Todo::Task.new("(A) A high priority task!")
-    def initialize task
+    def initialize(task)
       @orig = task
-      @priority, @created_on = orig_priority(orig), orig_created_on(orig)
-      @due_on = get_due_on_date(orig)
+      @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)
 
@@ -110,7 +111,7 @@ module Todo
     #   task = Todo::Task.new "(A) @test Testing!"
     #   task.text #=> "Testing!"
     def text
-      @text ||= get_item_text(orig)
+      @text ||= extract_item_text(orig)
     end
 
     # Returns the task's creation date, if any.
@@ -197,7 +198,7 @@ module Todo
     def undo!
       @completed_on = nil
       @is_completed = false
-      @priority = orig_priority(orig)
+      @priority = extract_priority(orig)
     end
 
     # Increases the priority until A. If it's nil, it sets it to A.
@@ -271,15 +272,15 @@ module Todo
     #
     #   task2 > task1
     #   # => false
-    def <=> other_task
-      if self.priority.nil? and other_task.priority.nil?
+    def <=>(other)
+      if priority.nil? && other.priority.nil?
         0
-      elsif other_task.priority.nil?
+      elsif other.priority.nil?
         1
-      elsif self.priority.nil?
+      elsif priority.nil?
         -1
       else
-        other_task.priority <=> self.priority
+        other.priority <=> priority
       end
     end
   end

data/spec/data/tasks.txt

@@ -0,0 +1,3 @@
+Task 1
+Task 2
+Task 3

data/spec/todo-txt/list_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 
 describe Todo::List do
   let(:path) { File.dirname(__FILE__) + '/../data/todo.txt' }
+  let(:mutable_path) { File.dirname(__FILE__) + '/../data/tasks.txt' }
   let(:list) { Todo::List.new(path) }
 
   context 'create with an array' do
@@ -20,6 +21,22 @@ describe Todo::List do
     end
   end
 
+  context 'create and save from file' do
+    it 'successfully writes back changes' do
+      backup = Todo::List.new(mutable_path)
+
+      tasks = Todo::List.new(mutable_path)
+      tasks.each(&:do!)
+      tasks.save!
+
+      result = Todo::List.new(mutable_path)
+
+      expect(result.by_done.count).to eq(3)
+
+      backup.save!
+    end
+  end
+
   it 'accepts a mix of tasks and strings' do
     l = Todo::List.new([
       "A task!",

data/spec/todo-txt/syntax_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Todo::Syntax do
   include Todo::Syntax
 
-  describe '#get_context_tags' do
+  describe '#extract_contexts' do
     specify 'empty task' do
       expect(extract_contexts('')).to eq([])
     end
@@ -21,7 +21,7 @@ describe Todo::Syntax do
     end
   end
 
-  describe '#get_project_tags' do
+  describe '#extract_projects' do
     specify 'empty task' do
       expect(extract_projects('')).to eq([])
     end
@@ -39,43 +39,43 @@ describe Todo::Syntax do
     end
   end
 
-  describe '#orig_priority' do
+  describe '#extract_priority' do
     specify 'empty task' do
-      expect(orig_priority('')).to be nil
+      expect(extract_priority('')).to be nil
     end
 
     specify 'task without priority' do
-      expect(orig_priority('something to do')).to be nil
+      expect(extract_priority('something to do')).to be nil
     end
 
     specify 'task with priority A' do
-      expect(orig_priority('(A) something to do')).to eq('A')
+      expect(extract_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')
+      expect(extract_priority('(B) something to do')).to eq('B')
     end
   end
 
-  describe '#orig_created_on' do
+  describe '#extract_created_on' do
     specify 'empty task' do
-      expect(orig_created_on('')).to be nil
+      expect(extract_created_on('')).to be nil
     end
 
     specify 'task without date' do
-      expect(orig_created_on('something to do')).to be nil
+      expect(extract_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))
+      expect(extract_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))
+      expect(extract_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
+      expect(extract_created_on('(A) something to do on 2016-03-29')).to be nil
     end
   end
 
@@ -115,35 +115,35 @@ describe Todo::Syntax do
     end
   end
 
-  describe '#get_due_on_date' do
+  describe '#extract_due_on_date' do
     specify 'empty task' do
-      expect(get_due_on_date('')).to be nil
+      expect(extract_due_on_date('')).to be nil
     end
 
     specify 'task without due date' do
-      expect(get_due_on_date('something to do')).to be nil
+      expect(extract_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))
+      expect(extract_due_on_date('something to do due:2016-03-30')).to eq(Date.new(2016, 03, 30))
     end
   end
 
-  describe '#get_item_text' do
+  describe '#extract_item_text' do
     specify 'empty task' do
-      expect(get_item_text('')).to eq('')
+      expect(extract_item_text('')).to eq('')
     end
 
     specify 'task without markup' do
-      expect(get_item_text('something to do')).to eq('something to do')
+      expect(extract_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')
+      expect(extract_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')
+      expect(extract_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

@@ -289,6 +289,23 @@ describe Todo::Task do
         expect(task.completed_on).to eq(Date.parse('8th December 2013'))
       end
     end
+
+    context 'Options#require_completed_on' do
+      before do
+        Todo.customize do |options|
+          options.require_completed_on = false
+        end
+      end
+
+      it 'should allow completion without date when option is set' do
+        task = Todo::Task.new('x This is done!')
+        expect(task.done?).to be true
+      end
+
+      after do
+        Todo.options.reset
+      end
+    end
   end
 
   describe 'Due dates:' do

data/todo-txt.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
-  s.name = %q{todo-txt}
-  s.version = '0.8'
+  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.}
@@ -8,7 +8,5 @@ Gem::Specification.new do |s|
   s.description = %q{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'
-
-  # Add all files to the files parameter.
   s.files = `git ls-files`.split(/\n/)
 end

data/todo.txt

@@ -0,0 +1,13 @@
+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
+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
+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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: todo-txt
 version: !ruby/object:Gem::Version
-  version: '0.8'
+  version: '0.9'
 platform: ruby
 authors:
 - Sam Rose
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-08 00:00:00.000000000 Z
+date: 2016-04-20 00:00:00.000000000 Z
 dependencies: []
 description: Allows for simple parsing of todo.txt files, as per Gina Trapani's todo.txt
   project.
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - ".gemtest"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE
@@ -30,6 +31,7 @@ files:
 - lib/todo-txt/options.rb
 - lib/todo-txt/syntax.rb
 - lib/todo-txt/task.rb
+- spec/data/tasks.txt
 - spec/data/todo.txt
 - spec/spec_helper.rb
 - spec/todo-txt/list_spec.rb
@@ -38,6 +40,7 @@ files:
 - spec/todo-txt/syntax_spec.rb
 - spec/todo-txt/task_spec.rb
 - todo-txt.gemspec
+- todo.txt
 homepage: http://github.com/samwho/todo-txt-gem
 licenses:
 - GPL-2