todotxt 0.1.0 → 0.2.0

data/lib/todotxt/clihelpers.rb

@@ -1,55 +1,52 @@
 module Todotxt
   module CLIHelpers
-
-    def format_todo(todo, number_padding=nil)
+    def format_todo(todo, number_padding = nil)
       line = todo.line.to_s
-      if number_padding
-        line = line.rjust number_padding
-      end
+      line = line.rjust number_padding if number_padding
 
       text = todo.to_s
 
-      unless todo.done
+      if todo.done
+        text = text.color(:black).bright
+      else
         text.gsub! PRIORITY_REGEX do |p|
-          case p[1]
-          when "A"
-            color = :red
-          when "B"
-            color = :yellow
-          when "C"
-            color = :green
-          else
-            color = :white
-          end
+          color = case p[1]
+                  when 'A'
+                    :red
+                  when 'B'
+                    :yellow
+                  when 'C'
+                    :green
+                  else
+                    :white
+                  end
 
           p.to_s.color(color)
         end
 
         text.gsub! PROJECT_REGEX, '\1'.color(:green)
         text.gsub! CONTEXT_REGEX, '\1'.color(:blue)
-      else
-        text = text.color(:black).bright
       end
 
-      ret = ""
+      ret = ''
 
       ret << "#{line}. ".color(:black).bright
-      ret << "#{text}"
+      ret << text.to_s
     end
 
-    def warn message=""
+    def warn(message = '')
       puts "WARN: #{message}".color(:yellow)
     end
 
-    def notice message=""
+    def notice(message = '')
       puts "=> #{message}".color(:green)
     end
 
-    def error message=""
+    def error(message = '')
       puts "ERROR: #{message}".color(:red)
     end
 
-    def error_and_exit message =""
+    def error_and_exit(message = '')
       error message
       exit
     end

data/lib/todotxt/config.rb

@@ -1,35 +1,63 @@
-require "parseconfig"
-require "fileutils"
+require 'parseconfig'
+require 'fileutils'
 
 module Todotxt
+  # Todotxt relies on a configuration file (`.todotxt.cfg`) in your home directory,
+  # which points to the location of your todo.txt. You can run:
+  #
+  #    $ todotxt generate_cfg
+  #
+  # to generate this file, which will then point to `~/todo.txt`.
   class Config < ParseConfig
-    def initialize config_file = ""
-      if config_file.empty?
-        @config_file = Config.config_path
-      else
-        @config_file = config_file
-      end
+    def initialize(options = {})
+      @options = options
+
+      @config_file = options[:config_file] || Config.config_path
 
       if file_exists?
         super @config_file
         validate
       else
+        # Initialize mandatory values for `ParseConfig`
         @params = {}
         @groups = []
+        @splitRegex = '\s*=\s*'
+        @comments = [';']
       end
     end
 
     def file_exists?
-      File.exists? @config_file
+      File.exist? @config_file
     end
 
     def files
-      params["files"] || {"todo" => params["todo_txt_path"] }
+      files = {}
+      (params['files'] || { 'todo' => params['todo_txt_path'] }).each do |k, p|
+        files[k] = TodoFile.new(p)
+      end
+
+      files
+    end
+
+    def file
+      if @options[:file].nil?
+        files['todo'] || raise("Bad configuration file: 'todo' is a required file.")
+      elsif files[@options[:file]]
+        files[@options[:file]]
+      elsif File.exist?(File.expand_path(@options[:file]))
+        TodoFile.new(File.expand_path(@options[:file]))
+      else
+        raise("\"#{@options[:file]}\" is not defined in the config and not a valid filename.")
+      end
+    end
+
+    def editor
+      params['editor'] || ENV['EDITOR']
     end
 
     def generate!
-     FileUtils.copy File.join(File.dirname(File.expand_path(__FILE__)), "..", "..", "conf", "todotxt.cfg"), @config_file
-     import_config
+      FileUtils.copy File.join(File.dirname(File.expand_path(__FILE__)), '..', '..', 'conf', 'todotxt.cfg'), @config_file
+      import_config
     end
 
     def path
@@ -41,17 +69,18 @@ module Todotxt
     end
 
     def self.config_path
-      File.join ENV["HOME"], ".todotxt.cfg"
+      File.join ENV['HOME'], '.todotxt.cfg'
     end
 
     def deprecated?
-      params["files"].nil?
+      params['files'].nil?
     end
 
     private
+
     def validate
-      if params["files"] && params["todo_txt_path"]
-        raise "Bad configuration file: use either files or todo_txt_path"
+      if params['files'] && params['todo_txt_path']
+        raise 'Bad configuration file: use either files or todo_txt_path'
       end
     end
   end

data/lib/todotxt/regex.rb

@@ -1,7 +1,7 @@
 module Todotxt
-  PRIORITY_REGEX = /^\(([A-Z])\) /
-  PROJECT_REGEX  = /(\+\w+)/
-  CONTEXT_REGEX  = /(@\w+)/
-  DATE_REGEX     = /^(\([A-Z]\) )?(x )?((\d{4}-)(\d{1,2}-)(\d{1,2}))\s?/
-  DONE_REGEX     = /^(\([A-Z]\) )?x /
+  PRIORITY_REGEX = /^\(([A-Z])\) /.freeze
+  PROJECT_REGEX  = /(\+\w+)/.freeze
+  CONTEXT_REGEX  = /(@\w+)/.freeze
+  DATE_REGEX     = /^(\([A-Z]\) )?(x )?((\d{4}-)(\d{1,2}-)(\d{1,2}))\s?/.freeze
+  DONE_REGEX     = /^(\([A-Z]\) )?x /.freeze
 end

data/lib/todotxt/todo.rb

@@ -1,8 +1,16 @@
-require "todotxt/regex"
+require 'todotxt/regex'
 
 module Todotxt
+  # Represent a task formatted according to
+  # [todo.txt format rules](https://github.com/todotxt/todo.txt#todotxt-format-rules)
+  #
+  # @attr [String] the complete text definition of this task
+  # @attr [Integer] line the line number of this task
+  # @attr [Char] the character which defines the task's priority
+  # @attr [Array] projects list of linked projects
+  # @attr [Array] contexts list of linked contexts
+  # @attr [Boolean] done `true` if task is done
   class Todo
-
     attr_accessor :text
     attr_accessor :line
     attr_accessor :priority
@@ -10,25 +18,21 @@ module Todotxt
     attr_accessor :contexts
     attr_accessor :done
 
-    def initialize text, line=nil
+    # @param[String] text
+    def initialize(text, line = nil)
       @line = line
 
       create_from_text text
     end
 
-    def create_from_text text
-      @text = text
-      @priority = text.scan(PRIORITY_REGEX).flatten.first || nil
-      @projects = text.scan(PROJECT_REGEX).flatten.uniq   || []
-      @contexts = text.scan(CONTEXT_REGEX).flatten.uniq   || []
-      @done = !text.scan(DONE_REGEX).empty?
-    end
-
+    # Get due date if set
+    # @return [Date|Nil]
     def due
       date = Chronic.parse(text.scan(DATE_REGEX).flatten[2])
       date.nil? ? nil : date.to_date
     end
 
+    # Mark this task as done
     def do
       unless done
         @text = "x #{text}".strip
@@ -36,23 +40,20 @@ module Todotxt
       end
     end
 
+    # Mark this task as not done
     def undo
       if done
-        @text = text.sub(DONE_REGEX, "").strip
+        @text = text.sub(DONE_REGEX, '').strip
         @done = false
       end
     end
 
-    def prioritize new_priority=nil, opts={}
-      if new_priority && !new_priority.match(/^[A-Z]$/i)
-        return
-      end
+    def prioritize(new_priority = nil, opts = {})
+      return if new_priority && !new_priority.match(/^[A-Z]$/i)
 
-      if new_priority
-        new_priority = new_priority.upcase
-      end
+      new_priority = new_priority.upcase if new_priority
 
-      priority_string = new_priority ? "(#{new_priority}) " : ""
+      priority_string = new_priority ? "(#{new_priority}) " : ''
 
       if priority && !opts[:force]
         @text.gsub! PRIORITY_REGEX, priority_string
@@ -63,33 +64,46 @@ module Todotxt
       @priority = new_priority
     end
 
-    def append appended_text=""
-      @text << " " << appended_text
+    # Add some text to the end of this task definition
+    def append(appended_text = '')
+      @text << ' ' << appended_text
     end
 
-    def prepend prepended_text=""
+    # Add some text to the beginning of this task definition
+    def prepend(prepended_text = '')
       @text = "#{prepended_text} #{text.gsub(PRIORITY_REGEX, '')}"
-      prioritize priority, :force => true
+      prioritize priority, force: true
     end
 
-    def replace text
+    def replace(text)
       create_from_text text
     end
 
+    # @return [String]
     def to_s
       text.clone
     end
 
-    def <=> b
-      if priority.nil? && b.priority.nil?
-        return line <=> b.line
-      end
+    # Compare with another `Todo` based on `line` and `priority` attributes
+    # @param [Todo] b
+    def <=>(b)
+      return 1 unless b.is_a? Todo
+      return line <=> b.line if priority.nil? && b.priority.nil?
 
       return 1 if priority.nil?
       return -1 if b.priority.nil?
 
-      return priority <=> b.priority
+      priority <=> b.priority
     end
 
+    private
+
+    def create_from_text(text)
+      @text = text
+      @priority = text.scan(PRIORITY_REGEX).flatten.first || nil
+      @projects = text.scan(PROJECT_REGEX).flatten.uniq   || []
+      @contexts = text.scan(CONTEXT_REGEX).flatten.uniq   || []
+      @done = !text.scan(DONE_REGEX).empty?
+    end
   end
 end

data/lib/todotxt/todofile.rb

@@ -1,40 +1,40 @@
 module Todotxt
   class TodoFile
-
-    def initialize path
+    def initialize(path)
       @path = File.expand_path(path)
     end
 
     # Generate a file from template
     def generate!
-      FileUtils.copy File.join(File.dirname(File.expand_path(__FILE__)), "..", "..", "conf", "todo.txt"), @path
+      FileUtils.copy File.join(File.dirname(File.expand_path(__FILE__)), '..', '..', 'conf', 'todo.txt'), @path
     end
 
-    def path
-      @path
-    end
+    attr_reader :path
 
     def basename
       File.basename @path
     end
 
     def exists?
-      File.exists? File.expand_path(@path)
+      File.exist? File.expand_path(@path)
     end
 
     def self.from_key(key)
       config = Todotxt::Config.new
-      if config.files.has_key? key
+      if config.files.key? key
         path = config.files[key]
-        self.new path
+        new path
       else
-        raise "Key not found in config"
+        raise 'Key not found in config'
       end
     end
 
-
     def to_s
       @path
     end
+
+    def ==(other)
+      @path == other.path
+    end
   end
 end

data/lib/todotxt/todolist.rb

@@ -1,13 +1,19 @@
-require "todotxt/todo"
+require 'todotxt/todo'
 
 module Todotxt
-  #@TODO merge with TodoFile, both overlap too much
+  # Represent a collection of `Todo` items
+  # TODO merge with TodoFile, both overlap too much
   class TodoList
     include Enumerable
 
-    attr_accessor :todos
+    attr_reader :todos
 
-    def initialize file
+    # @INK: refactor TodoList and TodoFile
+    #   So that TodoFile contains all IO ad List is no longer dependent on file.
+    #   That way, todolist lsa|listall can use multiple TodoFiles to generate one TodoList
+
+    def initialize(file, line = nil)
+      @line  = line || 0
       @todos = []
       @file  = file
 
@@ -16,44 +22,51 @@ module Todotxt
       end
     end
 
-    def add str
-      todo = Todo.new str, (@todos.count + 1)
+    # @param [String] str add the given todo string definition to the list
+    # TODO also support `Todo` object
+    def add(str)
+      todo = Todo.new str, (@line += 1)
       @todos.push todo
       @todos.sort!
 
-      return todo
+      todo
     end
 
-    def remove line
+    # @param [Todo|String] line remove the given todo to the list
+    def remove(line)
       @todos.reject! { |t| t.line.to_s == line.to_s }
     end
 
-    def move line, other_list
+    def move(line, other_list)
       other_list.add find_by_line(line).to_s
       remove line
     end
 
+    # Get all projects from todo definitions
+    # @return[Array<String>]
     def projects
-      map { |t| t.projects }.flatten.uniq.sort
+      map(&:projects).flatten.uniq.sort
     end
 
+    # Get all contexts from todo definitions
+    # @return[Array<String>]
     def contexts
-      map { |t| t.contexts }.flatten.uniq.sort
+      map(&:contexts).flatten.uniq.sort
     end
 
-    def find_by_line line
+    def find_by_line(line)
       @todos.find { |t| t.line.to_s == line.to_s }
     end
 
     def save
-      File.open(@file.path, "w") { |f| f.write to_txt }
+      File.open(@file.path, 'w') { |f| f.write to_txt }
     end
 
-    def each &block
+    def each(&block)
       @todos.each &block
     end
 
-    def filter search="", opts={}
+    def filter(search = '', opts = {})
       @todos.select! do |t|
         select = false
 
@@ -77,16 +90,16 @@ module Todotxt
       self
     end
 
-    def on_date date
+    def on_date(date)
       @todos.select { |t| t.due == date }
     end
 
-    def before_date date
+    def before_date(date)
       @todos.reject { |t| t.due.nil? || t.due >= date }
     end
 
     def to_txt
-      @todos.sort { |a,b| a.line <=> b.line }.map { |t| t.to_s.strip }.join("\n")
+      @todos.sort_by(&:line).map { |t| t.to_s.strip }.join("\n")
     end
 
     def to_s
@@ -96,6 +109,5 @@ module Todotxt
     def to_a
       map { |t| ["#{t.line}. ", t.to_s] }
     end
-
   end
 end