todo-jsonl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 266e5f102d3397fcbe41fe5af932ca7e3245b3bca0f0c022eba7a08d42e58909
+  data.tar.gz: bd8425b2e83ec7dd8bea45e2e54adebc9e4aaf11e554b850d5dc6d3679dcb845
+SHA512:
+  metadata.gz: 478c00716781148b1fd9736dea4afbae040dd817ec5562f31db23eaa8d3069af2210f8e023ab52460723099f98e28cb87ed4694e82fdfd29c8e3a2c74f465a68
+  data.tar.gz: dcc56754c7a74b86e03411440ef9c8b5a703069dfb4e85b23a9b169a3727207ffe64caadcb74bc8c1ac2e7237ecbbd5e8389ff8eac1a26fc6f21a79539590603

data/bin/todo

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+require_relative 'todo.rb'

data/bin/todo.rb

@@ -0,0 +1,295 @@
+#!/usr/bin/env ruby
+
+# todo.rb - todo list manager inspired by todo.txt using the jsonl format.
+#
+# Copyright (c) 2020 Gabor Bata
+#
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation files
+# (the "Software"), to deal in the Software without restriction,
+# including without limitation the rights to use, copy, modify, merge,
+# publish, distribute, sublicense, and/or sell copies of the Software,
+# and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'json'
+
+DATE_FORMAT = '%Y-%m-%d'
+
+COLOR_CODES = {
+  black:   30,
+  red:     31,
+  green:   32,
+  yellow:  33,
+  blue:    34,
+  magenta: 35,
+  cyan:    36,
+  white:   37
+}
+
+STATES = {
+  'new'     => '[ ]',
+  'done'    => '[x]',
+  'started' => '[>]',
+  'blocked' => '[!]',
+  'default' => '[?]'
+}
+
+ORDER = {
+  'new'     => 3,
+  'done'    => 4,
+  'started' => 2,
+  'blocked' => 1,
+  'default' => 100
+}
+
+COLORS = {
+  'new'     => :white,
+  'done'    => :blue,
+  'started' => :green,
+  'blocked' => :yellow,
+  'default' => :magenta
+}
+
+QUERIES = {
+  ':active'  => 'state=(new|started|blocked)',
+  ':done'    => 'state=done',
+  ':blocked' => 'state=blocked',
+  ':started' => 'state=started',
+  ':new'     => 'state=new',
+  ':all'     => 'state=\w+'
+}
+
+PRIORITY_FLAG = '*'
+
+TODO_FILE = "#{ENV['HOME']}/todo.jsonl"
+
+def usage
+  <<~USAGE
+    Usage: todo <command> <arguments>
+
+    Commands:
+    * add <text>                     add new task
+    * start <tasknumber>             mark task as started
+    * done <tasknumber>              mark task as completed
+    * block <tasknumber>             mark task as blocked
+    * prio <tasknumber>              toggle high priority flag
+
+    * append <tasknumber> <text>     append text to task title
+    * rename <tasknumber> <text>     rename task
+    * del <tasknumber>               delete task
+    * note <tasknumber> <text>       add note to task
+    * delnote <tasknumber> <text>    delete all notes from task
+
+    * list <regex> [regex...]        list tasks (only active tasks by default)
+    * show <tasknumber>              show all task details
+    * repl                           enter read–eval–print loop mode
+    * help                           this help screen
+
+    With list command the following pre-defined regex patterns can be also used:
+    #{QUERIES.keys.join(', ')}
+
+    Legend:
+    #{STATES.select { |k, v| k != 'default' }.map { |k, v| "#{k} #{v}" }.join(', ') }, priority #{PRIORITY_FLAG}
+   USAGE
+end
+
+def load_tasks(item_to_check = nil)
+  count = 0
+  tasks = {}
+  if File.exist?(TODO_FILE)
+    File.open(TODO_FILE, 'r:UTF-8') do |file|
+      file.each_line do |line|
+        next if line.strip == ''
+        count += 1
+        tasks[count] = JSON.parse(line.chomp, :symbolize_names => true)
+      end
+    end
+  end
+  if item_to_check && !tasks.has_key?(item_to_check)
+    raise "#{item_to_check}: No such todo"
+  end
+  tasks
+end
+
+def write_tasks(tasks)
+  File.open(TODO_FILE, 'w:UTF-8') do |file|
+    tasks.keys.sort.each do |key|
+      file.write(JSON.generate(tasks[key]) + "\n")
+    end
+  end
+end
+
+def add(text)
+  task = {
+    state: 'new',
+    title: text,
+    modified: Time.now.strftime(DATE_FORMAT)
+  }
+  File.open(TODO_FILE, 'a:UTF-8') do |file|
+    file.write(JSON.generate(task) + "\n")
+  end
+  list
+end
+
+def append(item, text = '')
+  tasks = load_tasks(item)
+  tasks[item][:title] = [tasks[item][:title], text].join(' ')
+  tasks[item][:modified] = Time.now.strftime(DATE_FORMAT)
+  write_tasks(tasks)
+  list(tasks)
+end
+
+def rename(item, text)
+  tasks = load_tasks(item)
+  tasks[item][:title] = text
+  tasks[item][:modified] = Time.now.strftime(DATE_FORMAT)
+  write_tasks(tasks)
+  list(tasks)
+end
+
+def delete(item)
+  tasks = load_tasks(item)
+  tasks.delete(item)
+  write_tasks(tasks)
+  list
+end
+
+def change_state(item, state)
+  tasks = load_tasks(item)
+  tasks[item][:state] = state
+  tasks[item][:modified] = Time.now.strftime(DATE_FORMAT)
+  write_tasks(tasks)
+  list(tasks)
+end
+
+def set_priority(item)
+  tasks = load_tasks(item)
+  tasks[item][:priority] = !tasks[item][:priority]
+  tasks[item][:modified] = Time.now.strftime(DATE_FORMAT)
+  write_tasks(tasks)
+  list(tasks)
+end
+
+def list(tasks = nil, patterns = nil)
+  items = {}
+  tasks = tasks || load_tasks
+  patterns = patterns.nil? || patterns.empty? ? [QUERIES[':active']] : patterns
+  tasks.each do |num, task|
+    normalized_task = "state=#{task[:state]} #{task[:title]}"
+    match = true
+    patterns.each do |pattern|
+      match = false unless /#{QUERIES[pattern] || pattern}/ix.match(normalized_task)
+    end
+    items[num] = task if match
+  end
+  items = items.sort_by do |num, task|
+    [task[:priority] ? 0 : 1, ORDER[task[:state] || 'default'], num]
+  end
+  items.each do |num, task|
+    state = task[:state] || 'default'
+    color = COLORS[state]
+    display_state = colorize(STATES[state], color)
+    title = task[:title].gsub(/@\w+/) { |tag| colorize(tag, :cyan) }
+    priority_flag = task[:priority] ? colorize(PRIORITY_FLAG, :red) : ' '
+    puts "#{num.to_s.rjust(4, ' ')}:#{priority_flag}#{display_state} #{title}"
+  end
+  puts 'No todos found' if items.empty?
+end
+
+def add_note(item, text)
+  tasks = load_tasks(item)
+  tasks[item][:note] ||= []
+  tasks[item][:note].push(text)
+  tasks[item][:modified] = Time.now.strftime(DATE_FORMAT)
+  write_tasks(tasks)
+  show(item)
+end
+
+def delete_note(item)
+  tasks = load_tasks(item)
+  tasks[item][:note] = []
+  tasks[item][:modified] = Time.now.strftime(DATE_FORMAT)
+  write_tasks(tasks)
+  show(item)
+end
+
+def show(item)
+  tasks = load_tasks(item)
+  tasks[item].each do |key, value|
+    val = value.kind_of?(Array) ? "\n" + value.join("\n") : value
+    puts "#{colorize(key.to_s.rjust(10, ' ') + ':', :cyan)} #{val}"
+  end
+end
+
+def start_repl
+  command = ''
+  while !['exit', 'quit'].include?(command)
+    if ['clear', 'cls'].include?(command)
+      print "\e[H\e[2J"
+    else
+      read(command == 'repl' ? [] : command.split(/\s+/))
+    end
+    print "\ntodo> "
+    command = STDIN.gets.chomp
+  end
+end
+
+def colorize(text, color)
+  "\e[#{COLOR_CODES[color]}m#{text}\e[0m"
+end
+
+def read(arguments)
+  begin
+    action = arguments.first
+    args = arguments[1..-1]
+    case action
+    when 'add'
+      add(args.join(' ')) unless args.nil? || args.empty?
+    when 'start'
+      args.length == 1 ? change_state(args.first.to_i, 'started') : list(nil, [':started'])
+    when 'done'
+      args.length == 1 ? change_state(args.first.to_i, 'done') : list(nil, [':done'])
+    when 'block'
+      args.length == 1 ? change_state(args.first.to_i, 'blocked') : list(nil, [':blocked'])
+    when 'prio'
+      set_priority(args.first.to_i) if args.length == 1
+    when 'append'
+      append(args.first.to_i, args[1..-1].join(' ')) unless args.length < 1
+    when 'rename'
+      rename(args.first.to_i, args[1..-1].join(' ')) unless args.length < 1
+    when 'del'
+      delete(args.first.to_i) if args.length == 1
+    when 'note'
+      add_note(args.first.to_i, args[1..-1].join(' ')) unless args.length < 1
+    when 'delnote'
+      delete_note(args.first.to_i) if args.length == 1
+    when 'list'
+      list(nil, args)
+    when 'show'
+      show(args.first.to_i) if args.length == 1
+    when 'help'
+      puts usage
+    when 'repl'
+      start_repl
+    else
+      list(nil, arguments)
+    end
+  rescue => error
+    puts "#{colorize('ERROR:', :red)} #{error}"
+  end
+end
+
+read(ARGV)

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: todo-jsonl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gabor Bata
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-15 00:00:00.000000000 Z
+dependencies: []
+description: |2
+      Usage: todo <command> <arguments>
+
+      Commands:
+      * add <text>                     add new task
+      * start <tasknumber>             mark task as started
+      * done <tasknumber>              mark task as completed
+      * block <tasknumber>             mark task as blocked
+      * prio <tasknumber>              toggle high priority flag
+
+      * append <tasknumber> <text>     append text to task title
+      * rename <tasknumber> <text>     rename task
+      * del <tasknumber>               delete task
+      * note <tasknumber> <text>       add note to task
+      * delnote <tasknumber> <text>    delete all notes from task
+
+      * list <regex> [regex...]        list tasks (only active tasks by default)
+      * show <tasknumber>              show all task details
+      * repl                           enter read–eval–print loop mode
+      * help                           this help screen
+
+      With list command the following pre-defined regex patterns can be also used:
+      :active, :done, :blocked, :started, :new, :all
+
+      Legend:
+      new [ ], done [x], started [>], blocked [!], priority *
+email: 
+executables:
+- todo.rb
+- todo
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/todo
+- bin/todo.rb
+homepage: https://github.com/gaborbata/todo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: todo list manager inspired by todo.txt using the jsonl format
+test_files: []