todo-jsonl 0.1.7 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aab10deef9e956db5b18eaed5938749e225e3fdb99764c119fabe7bfa16969f
-  data.tar.gz: 682cf59b330c12e2276e350dba4112e34a56edbf0274276eabb12be81c3b406d
+  metadata.gz: bb612ac4efe61a2da25f5438e4e158612ca1d1837484a5338d8768e527fd9e71
+  data.tar.gz: '079821ed0936b0a250133b18304a1110d59b3fa5f5e008c228ae4c9d01a98799'
 SHA512:
-  metadata.gz: 9f4e3193f34df98c4cc50b86722246724cb31dd3d54d754435db5d80a0ac0300a026d5e09c479061a1f8fd65f40773dff5d175184078c573c1d102344a5dd7f7
-  data.tar.gz: 824d0796aa292733ef672d2998377975b3b55a43021224213fa9b78af52fb3dc96842db1d7c00dfe727d6ea593d2bfb694e4072234932d5aff1a53919d48a615
+  metadata.gz: d6a531a29f85db3d3af7baa47f4b26485639db66eebbe028d3327375ff0ebf5d68958a6713a82bb6ae10c3e5beb305d374273ccc82529e4eccc4c0494bfec95f
+  data.tar.gz: 250acb20cb6edf8b5cfac5fc3b568f5cfc2f72245e0884618c7d8143c5a63e81bed6dfa699aa833d4fc96bff9ac62475e2f65647c3e3f9f342725b623d0101b5

data/bin/todo.rb

@@ -2,7 +2,7 @@
 
 # todo.rb - todo list manager inspired by todo.txt using the jsonl format.
 #
-# Copyright (c) 2020 Gabor Bata
+# Copyright (c) 2020-2021 Gabor Bata
 #
 # Permission is hereby granted, free of charge, to any person
 # obtaining a copy of this software and associated documentation files
@@ -27,8 +27,6 @@
 require 'json'
 require 'date'
 
-DATE_FORMAT = '%Y-%m-%d'
-
 COLOR_CODES = {
   black:   30,
   red:     31,
@@ -64,21 +62,27 @@ COLORS = {
   'default' => :magenta
 }
 
-QUERIES = {
-  ':active'  => 'state=(new|started|blocked)',
-  ':done'    => 'state=done',
-  ':blocked' => 'state=blocked',
-  ':started' => 'state=started',
-  ':new'     => 'state=new',
-  ':all'     => 'state=\w+'
-}
-
 TODAY = DateTime.now
+NEXT_7_DAYS = (0..6).map do |day| (TODAY.to_date + day) end
+DATE_FORMAT = '%Y-%m-%d'
+DUE_DATE_DAYS = NEXT_7_DAYS.map do |day| day.strftime('%A').downcase end
+DUE_DATES_FOR_QUERIES = NEXT_7_DAYS.map do |day| day.strftime(DATE_FORMAT) end
+DUE_DATE_DAYS_SIMPLE = ['today', 'tomorrow']
 
-DUE_DATE_DAYS = ['today', 'tomorrow']
-(2..6).each do |day|
-  DUE_DATE_DAYS.push((TODAY.to_date + day).strftime('%A').downcase)
-end
+DUE_DATE_TAG_PATTERN = /(^| )due:([a-zA-Z0-9-]+)/
+CONTEXT_TAG_PATTERN = /(^| )[@+][\w-]+/
+
+QUERIES = {
+  ':active'    => 'state=(new|started|blocked)',
+  ':done'      => 'state=done',
+  ':blocked'   => 'state=blocked',
+  ':started'   => 'state=started',
+  ':new'       => 'state=new',
+  ':all'       => 'state=\w+',
+  ':today'     => "due=#{DUE_DATES_FOR_QUERIES[0]}",
+  ':tomorrow'  => "due=#{DUE_DATES_FOR_QUERIES[1]}",
+  ':next7days' => "due=(#{DUE_DATES_FOR_QUERIES.join('|')})"
+}
 
 PRIORITY_FLAG = '*'
 
@@ -90,12 +94,12 @@ def usage
 
     Commands:
     * add <text>                     add new task
-    * start <tasknumber>             mark task as started
-    * done <tasknumber>              mark task as completed
-    * block <tasknumber>             mark task as blocked
-    * reset <tasknumber>             reset task to new state
+    * start <tasknumber> [text]      mark task as started, with optional note
+    * done <tasknumber> [text]       mark task as completed, with optional note
+    * block <tasknumber> [text]      mark task as blocked, with optional note
+    * reset <tasknumber> [text]      reset task to new state, with optional note
     * prio <tasknumber>              toggle high priority flag
-    * due <tasknumber> <date>        set due date (in YYYY-MM-DD format)
+    * due <tasknumber> [date]        set/unset due date (in YYYY-MM-DD format)
 
     * append <tasknumber> <text>     append text to task title
     * rename <tasknumber> <text>     rename task
@@ -111,8 +115,12 @@ def usage
     With list command the following pre-defined regex patterns can be also used:
     #{QUERIES.keys.join(', ')}
 
+    Due dates can be also added via tags in task title: "due:YYYY-MM-DD"
+
     Legend:
     #{STATES.select { |k, v| k != 'default' }.map { |k, v| "#{k} #{v}" }.join(', ') }, priority #{PRIORITY_FLAG}
+
+    Todo file: #{TODO_FILE}
   USAGE
 end
 
@@ -142,12 +150,22 @@ def write_tasks(tasks)
   end
 end
 
+def postprocess_tags(task)
+  title = task[:title]
+  match_data = title.match(DUE_DATE_TAG_PATTERN)
+  if match_data
+    task[:title] = title.gsub(DUE_DATE_TAG_PATTERN, '')
+    task[:due] = convert_due_date(match_data[2])
+  end
+end
+
 def add(text)
   task = {
     state: 'new',
     title: text,
     modified: Time.now.strftime(DATE_FORMAT)
   }
+  postprocess_tags(task)
   File.open(TODO_FILE, 'a:UTF-8') do |file|
     file.write(JSON.generate(task) + "\n")
   end
@@ -158,6 +176,7 @@ def append(item, text = '')
   tasks = load_tasks(item)
   tasks[item][:title] = [tasks[item][:title], text].join(' ')
   tasks[item][:modified] = Time.now.strftime(DATE_FORMAT)
+  postprocess_tags(tasks[item])
   write_tasks(tasks)
   list(tasks)
 end
@@ -166,6 +185,7 @@ def rename(item, text)
   tasks = load_tasks(item)
   tasks[item][:title] = text
   tasks[item][:modified] = Time.now.strftime(DATE_FORMAT)
+  postprocess_tags(tasks[item])
   write_tasks(tasks)
   list(tasks)
 end
@@ -177,10 +197,14 @@ def delete(item)
   list
 end
 
-def change_state(item, state)
+def change_state(item, state, note = nil)
   tasks = load_tasks(item)
   tasks[item][:state] = state
   tasks[item][:modified] = Time.now.strftime(DATE_FORMAT)
+  if !note.nil? && !note.empty?
+    tasks[item][:note] ||= []
+    tasks[item][:note].push(note)
+  end
   write_tasks(tasks)
   list(tasks)
 end
@@ -193,9 +217,9 @@ def set_priority(item)
   list(tasks)
 end
 
-def due_date(item, date = '')
+def due_date(item, date = '', task = nil)
   tasks = load_tasks(item)
-  tasks[item][:due] = date.nil? || date.empty? ? nil : Date.parse(date).strftime(DATE_FORMAT)
+  tasks[item][:due] = convert_due_date(date)
   tasks[item][:modified] = Time.now.strftime(DATE_FORMAT)
   write_tasks(tasks)
   list(tasks)
@@ -204,9 +228,10 @@ end
 def list(tasks = nil, patterns = nil)
   items = {}
   tasks = tasks || load_tasks
+  task_indent = [tasks.keys.max.to_s.size, 4].max
   patterns = patterns.nil? || patterns.empty? ? [QUERIES[':active']] : patterns
   tasks.each do |num, task|
-    normalized_task = "state=#{task[:state]} #{task[:title]}"
+    normalized_task = "state=#{task[:state]} due=#{task[:due]} #{task[:title]}"
     match = true
     patterns.each do |pattern|
       match = false unless /#{QUERIES[pattern] || pattern}/ix.match(normalized_task)
@@ -220,7 +245,9 @@ def list(tasks = nil, patterns = nil)
     state = task[:state] || 'default'
     color = COLORS[state]
     display_state = colorize(STATES[state], color)
-    title = task[:title].gsub(/@\w+/) { |tag| colorize(tag, :cyan) }
+    title = task[:title].gsub(CONTEXT_TAG_PATTERN) do |tag|
+      (tag.start_with?(' ') ? ' ' : '') + colorize(tag.strip, :cyan)
+    end
     priority_flag = task[:priority] ? colorize(PRIORITY_FLAG, :red) : ' '
     due_date = ''
     if task[:due] && state != 'done'
@@ -228,13 +255,13 @@ def list(tasks = nil, patterns = nil)
       if date_diff < 0
         due_date = colorize("(#{date_diff.abs}d overdue)", :red)
       elsif date_diff == 0 || date_diff == 1
-        due_date = colorize("(#{DUE_DATE_DAYS[date_diff]})", :yellow)
+        due_date = colorize("(#{DUE_DATE_DAYS_SIMPLE[date_diff]})", :yellow)
       else
         due_date = colorize("(#{DUE_DATE_DAYS[date_diff] || task[:due]})", :magenta) if date_diff > 1
       end
       due_date = ' ' + due_date
     end
-    puts "#{num.to_s.rjust(4, ' ')}:#{priority_flag}#{display_state} #{title}#{due_date}"
+    puts "#{num.to_s.rjust(task_indent, ' ')}:#{priority_flag}#{display_state} #{title}#{due_date}"
   end
   puts 'No todos found' if items.empty?
 end
@@ -281,6 +308,17 @@ def colorize(text, color)
   "\e[#{COLOR_CODES[color]}m#{text}\e[0m"
 end
 
+def convert_due_date(date = '')
+  due = nil
+  day_index = DUE_DATE_DAYS.index(date.to_s.downcase) || DUE_DATE_DAYS_SIMPLE.index(date.to_s.downcase)
+  if day_index
+    due = (TODAY.to_date + day_index).strftime(DATE_FORMAT)
+  else
+    due = date.nil? || date.empty? ? nil : Date.parse(date).strftime(DATE_FORMAT)
+  end
+  return due
+end
+
 def read(arguments)
   begin
     action = arguments.first
@@ -290,13 +328,13 @@ def read(arguments)
       raise action + ' command requires at least one parameter' if args.nil? || args.empty?
       add(args.join(' '))
     when 'start'
-      args.length == 1 ? change_state(args.first.to_i, 'started') : list(nil, [':started'])
+      args.length > 0 ? change_state(args.first.to_i, 'started', args[1..-1].join(' ')) : list(nil, [':started'])
     when 'done'
-      args.length == 1 ? change_state(args.first.to_i, 'done') : list(nil, [':done'])
+      args.length > 0 ? change_state(args.first.to_i, 'done', args[1..-1].join(' ')) : list(nil, [':done'])
     when 'block'
-      args.length == 1 ? change_state(args.first.to_i, 'blocked') : list(nil, [':blocked'])
+      args.length > 0 ? change_state(args.first.to_i, 'blocked', args[1..-1].join(' ')) : list(nil, [':blocked'])
     when 'reset'
-      args.length == 1 ? change_state(args.first.to_i, 'new') : list(nil, [':new'])
+      args.length > 0 ? change_state(args.first.to_i, 'new', args[1..-1].join(' ')) : list(nil, [':new'])
     when 'prio'
       raise action + ' command requires exactly one parameter' if args.length != 1
       set_priority(args.first.to_i)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: todo-jsonl
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.12
 platform: ruby
 authors:
 - Gabor Bata
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-05 00:00:00.000000000 Z
+date: 2021-02-25 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: