intent 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86c9e5d7f4f81b1db6abe7c6fbd2ec7daebbfef06abaa05e3129697743648e63
-  data.tar.gz: ca5a9c91a8ee077bc018c0b5a2251d6e84dfbc4ab2ce371a1fff96dfc65596bc
+  metadata.gz: 1a78826427e690ed80d21f63d75c009a652d8f7e6152250a0259d21af5ec36d2
+  data.tar.gz: 04c84e824a0787fed413ca28155143e407d322a8a5dd4dac76e0a14ee569a790
 SHA512:
-  metadata.gz: de2d74dc9068848a13f5b85d6fd58aefb0381d908e9ff7e2f0d2d81c688afd715dc7bc3d50b584650c3acbc5596cb4ebcd010a5c3b37de4a4ea52f296a3a2ed1
-  data.tar.gz: f8b7273cb674c0cd9336a1d3acac3cc88a96e31d2a1cf9736ddf03f9d1c56bd5b8aa2ab7112c62655283b78a40d99f2ae70679cb101e3e02f509a66741c05834
+  metadata.gz: 61ed11963ba4317356bdfef7d2213fe1f1b2b29153697a34c2d6bd2ce5a09a7f61c12a296c50879909f7f650b556ee7d4f0bce0ce11fc5de891c4a140264f546
+  data.tar.gz: 79ba7a74906c8607edffeafc5d8555afe5853212d47b7253f8d2788567d13e4a843234a3d6934adfc1118315f3ac513e6567a5056aad1748497b73f74babe452

data/.gitignore

@@ -7,4 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem
 NOTES.md
+.DS_Store

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Mark Rickerby
+Copyright (c) 2016-2024 Mark Rickerby <https://maetl.net>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -0,0 +1,23 @@
+# Intent
+
+Automation engine with todo.txt
+
+This tool is mired deep in the obscurity and pedantry of the text-based computing culture that originated in the 1970s and still continues today. You probably don’t want to use this.
+
+## Installation
+
+```
+gem install intent
+```
+
+## Usage
+
+```
+intent help
+```
+
+## Copyright & License
+
+Copyright 2024 Mark Rickerby <https://maetl.net>.
+
+All documentation and modelling concepts are **CC BY-NC**. Source code and command line tools are MIT.

data/bin/{review → intent}

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-
 path = __FILE__
 while File.symlink?(path)
   path = File.expand_path(File.readlink(path), File.dirname(path))
@@ -8,4 +7,4 @@ $:.unshift(File.join(File.dirname(File.expand_path(path)), '..', 'lib'))
 
 require 'intent'
 
-Intent::Review::Manager.run(ARGV.dup)
+Intent::Dispatcher.exec_command(:intent, ARGV.dup)

data/bin/inventory

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+path = __FILE__
+
+while File.symlink?(path)
+  path = File.expand_path(File.readlink(path), File.dirname(path))
+end
+
+$:.unshift(File.join(File.dirname(File.expand_path(path)), '..', 'lib'))
+
+require 'intent'
+
+Intent::Dispatcher.exec_command(:inventory, ARGV.dup)

data/bin/projects

@@ -8,4 +8,4 @@ $:.unshift(File.join(File.dirname(File.expand_path(path)), '..', 'lib'))
 
 require 'intent'
 
-Intent::Projects::Manager.run(ARGV.dup)
+Intent::Dispatcher.exec_command(:projects, ARGV.dup)

data/bin/todo

@@ -8,4 +8,4 @@ $:.unshift(File.join(File.dirname(File.expand_path(path)), '..', 'lib'))
 
 require 'intent'
 
-Intent::Todo::Manager.run(ARGV.dup)
+Intent::Dispatcher.exec_command(:todo, ARGV.dup)

data/intent.gemspec

@@ -20,9 +20,19 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "todo-txt", "~> 0.12"
   spec.add_runtime_dependency "pastel", "~> 0.8"
-  spec.add_runtime_dependency "git", "~> 1.9.1"
+  spec.add_runtime_dependency "git", "~> 1.19.1"
   spec.add_runtime_dependency "terminal-notifier", "~> 2.0"
   spec.add_runtime_dependency "ghost", "~> 1.0.0"
+  spec.add_runtime_dependency "unicode_plot", "0.0.5"
+  spec.add_runtime_dependency "kdl", "1.0.3"
+  spec.add_runtime_dependency "sorted_set", "1.0.3"
+  spec.add_runtime_dependency "strings-ansi", "0.2.0"
+  spec.add_runtime_dependency "bibtex-ruby", "6.1.0"
+  spec.add_runtime_dependency "tty-prompt", "~> 0.23.1"
+  spec.add_runtime_dependency "tty-table", "~> 0.12.0"
+  spec.add_runtime_dependency "tty-tree", "~> 0.4.0"
+  spec.add_runtime_dependency "nanoid", "~> 2.0.0"
+  spec.add_runtime_dependency "paint", "~> 2.3.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

data/lib/gem_ext/todo-txt.rb

@@ -10,13 +10,37 @@ class Todo::Task
       # Completed tasks are rendered with a strikethrough
       pastel.strikethrough(to_s)
     else
-      # Open tasks delegate to the custom formatting function
-      print_open_task(pastel)
+      [
+        pastel.red(print_priority),
+        pastel.yellow(created_on.to_s),
+        text,
+        pastel.bold.magenta(print_contexts),
+        pastel.bold.blue(print_projects),
+        pastel.bold.cyan(print_tags)
+      ].reject { |item| !item || item.nil? || item.empty? }.join(' ')
     end
   end
 
+  def highlight_as_project
+    return to_s unless STDOUT.tty?
+
+    pastel = Pastel.new
+    [
+      pastel.bold.cyan(print_projects),
+      pastel.red(print_project_context)
+    ].reject { |item| !item || item.nil? || item.empty? }.join(' ')
+  end
+
+  def text=(label)
+    @text = label
+  end
+
   private
 
+  def print_project_context
+    'active' if contexts.include?('@active')
+  end
+
   def print_open_task(pastel)
     [
       pastel.red(print_priority),

data/lib/intent/commands/base.rb

@@ -0,0 +1,40 @@
+module Intent
+  module Commands
+    class Base
+      attr_reader :identity
+      attr_reader :documents
+  
+      def initialize
+        @identity = strip_classname
+        @documents = ::Intent::Core::Documents.new
+      end
+  
+      def print_help(output)
+        output.puts(File.read(help_txt_path))
+      end
+
+      def generate_id
+        Nanoid.generate(size: 8, alphabet: ID_ALPHABET)
+      end
+
+      private
+  
+      T_CLASS_PREFIX = 'Intent::Commands::'
+  
+      ID_ALPHABET = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
+
+      def strip_classname
+        self.class.to_s.sub(T_CLASS_PREFIX, '').downcase
+      end
+  
+      def help_txt_path
+        # TODO: does this work on Windows?
+        "#{__dir__}/../text/#{identity}.help.txt"
+      end
+
+      def create_noun(type, label, tags)
+        Intent::Core::Noun.new(type, label, tags)
+      end
+    end
+  end
+end

data/lib/intent/commands/errors.rb

@@ -0,0 +1,7 @@
+module Intent
+  module Commands
+    module Errors
+      COMMAND_NOT_FOUND = "Command not found"
+    end
+  end
+end

data/lib/intent/commands/intent.rb

@@ -0,0 +1,9 @@
+module Intent
+  module Commands
+    class Intent
+      def run(args, output)
+        output.puts args
+      end
+    end
+  end
+end

data/lib/intent/commands/inventory.rb

@@ -0,0 +1,210 @@
+require 'tty-reader'
+
+module Intent
+  module Commands
+    class Inventory < Base
+      def run(args, output)
+        if args.empty?
+          print_help(output)
+        else
+          case args.first.to_sym
+          when :help
+            print_help(output)
+          when :list
+            tree = TTY::Tree.new(inventory_tree)
+            output.puts(tree.render)
+          when :add
+            noun = args[1].to_sym
+            case noun
+            when :folder then add_folder(args, output)
+            when :box then add_box(args, output)
+            when :stock then add_stock(args, output)
+            else
+              raise "Noun not found"
+            end
+          when :assign
+            noun = args[1].to_sym
+            case noun
+            when :folder then assign_folder(args, output)
+            when :box then assign_box(args, output)
+            end
+          end
+        end
+      end
+
+      private
+
+      def inventory_tree
+        color = ::Intent::UI::TermColor.new
+        root = {}
+        documents.inventory.boxes.each do |box|
+          color_code = case box.tags[:id][0].downcase.to_sym
+          when :g then :green
+          when :y then :yellow
+          when :b then :blue
+          when :r then :red
+          else
+            :white
+          end
+          box_key = "#{color.bold.decorate(box.tags[:id], color_code)} #{box.text}"
+          child_items = documents.inventory.items_in(box.tags[:id]).map do |item|
+            "#{color.bold.decorate(item.tags[:id], color_code)} #{item.text}"
+          end
+          root[box_key] = child_items
+        end
+        root
+      end
+
+      # ui format reader
+      def inventory_units_of(type)
+        documents.inventory.units_of(type).map do |unit|
+          [unit.text, unit.tags[:sku]]
+        end.to_h
+      end
+
+      # ui format reader
+      def inventory_unassigned_folders
+        folder_types = documents.inventory.units_of(:folder)
+        documents.inventory.unassigned_folders.map do |folder|
+          unit_label = folder_types.find { |f| f.tags[:sku] == folder.tags[:sku] } 
+          ["#{folder.text} #{folder.tags[:id]} (#{unit_label.text})", folder.tags[:id]]
+        end.to_h
+      end
+
+      # ui format reader
+      def inventory_assigned_boxes
+        box_types = documents.inventory.units_of(:box)
+        documents.inventory.assigned_boxes.map do |box|
+          unit_label = box_types.find { |f| f.tags[:sku] == box.tags[:sku] } 
+          ["#{box.text} #{box.tags[:id]} (#{unit_label.text})", box.tags[:id]]
+        end.to_h
+      end
+
+      # ui format reader
+      def inventory_unassigned_boxes
+        box_types = documents.inventory.units_of(:box)
+        documents.inventory.unassigned_boxes.map do |box|
+          unit_label = box_types.find { |f| f.tags[:sku] == box.tags[:sku] } 
+          ["#{box.text} #{box.tags[:id]} (#{unit_label.text})", box.tags[:id]]
+        end.to_h
+      end
+
+      def add_stock(args, output)
+        prompt = TTY::Prompt.new
+        type = prompt.select('type of stock:', [:folder, :box])
+        ref = self
+
+        unit = prompt.collect do
+          key(:sku).ask('sku:', default: ref.generate_id)
+          key(:label).ask('label:', default: "[Undocumented #{type.capitalize}]")
+          key(:qty).ask('quantity:', default: 1, convert: :int)
+        end
+
+        documents.inventory.add_unit!(unit[:label], type, unit[:sku])
+
+        unit[:qty].times do
+          label = "[Unlabelled #{type.capitalize}]"
+          documents.inventory.add_item!(label, ref.generate_id, type, unit[:sku])
+        end
+      end
+
+      def add_folder(args, output)
+        skus = inventory_units_of(:folder)
+        projects = documents.projects.all_tokens
+        prompt = TTY::Prompt.new
+        ref = self
+        
+        item = prompt.collect do
+          key(:sku).select('sku:', skus, filter: true)
+          key(:id).ask('id:', default: ref.generate_id)
+          key(:label).ask('label:', default: '[Unlabelled Folder]')
+        end
+
+        should_assign_projects = prompt.yes?('assign to projects:')
+
+        if should_assign_projects
+          assigned_projects = prompt.multi_select('projects:', projects, filter: true)
+          label = "#{item[:label]} #{assigned_projects.join(' ')}"
+        else
+          label = item[:label]
+        end
+
+        should_file_in = prompt.select('file in:', {
+          "Active, not in box" => :active,
+          "Unassigned box" => :unassigned,
+          "Assigned project box" => :assigned
+        })
+
+        case should_file_in
+        when :active 
+          label << " @active"
+          in_box = nil
+        when :unassigned
+          in_box = prompt.select('box', inventory_unassigned_boxes)
+        when :assigned
+          # TODO: filter on selected projects only
+          in_box = prompt.select('box:', inventory_assigned_boxes)
+        end
+
+        documents.inventory.add_folder!(label, item[:id], item[:sku], in_box)
+      end
+
+      def add_box(args, output)
+        skus = inventory_units_of(:box)
+        prompt = TTY::Prompt.new
+        ref = self
+        
+        item = prompt.collect do
+          key(:sku).select('sku:', skus, filter: true)
+          key(:id).ask('id:', default: ref.generate_id)
+          key(:label).ask('label:', default: '[Unlabelled Box]')
+        end
+        
+        # Repository write pattern
+        documents.inventory.add_box!(item[:label], item[:id], item[:sku])
+
+        # Alternative design
+        # noun = create_noun(:box, label, tags)
+        # Add.invoke(:append, documents.inventory, noun)
+      end
+
+      def assign_folder(args, output)
+        projects = documents.projects.all_tokens
+        folders = inventory_unassigned_folders
+        prompt = TTY::Prompt.new
+
+        folder_id = prompt.select('folder:', folders)
+        folder = documents.inventory.folder_by_id(folder_id)
+        
+        details = prompt.collect do
+          key(:projects).multi_select('projects:', projects)
+          key(:label).ask('label:', default: folder.text)
+          # TODO: is active
+        end
+
+        folder.text = details[:label]
+        folder.projects.concat(details[:projects])
+        documents.inventory.save!
+      end
+
+      def assign_box(args, output)
+        projects = documents.projects.all_tokens
+        boxes = inventory_unassigned_boxes
+        prompt = TTY::Prompt.new
+
+        box_id = prompt.select('box:', boxes)
+        box = documents.inventory.box_by_id(box_id)
+        
+        details = prompt.collect do
+          key(:projects).multi_select('projects:', projects)
+          key(:label).ask('label:', default: box.text)
+          # TODO: is active
+        end
+
+        box.text = details[:label]
+        box.projects.concat(details[:projects])
+        documents.inventory.save!
+      end
+    end
+  end
+end

data/lib/intent/commands/projects.rb

@@ -0,0 +1,34 @@
+require 'readline'
+
+module Intent
+  module Commands
+    class Projects < Base
+      def run(args, output)
+        if args.empty?
+          print_help(output)
+        else
+          case args.first.to_sym
+          when :help
+            print_help(output)
+          when :list
+            documents.projects.all.each do |task|
+              output.puts task.highlight_as_project
+            end
+          when :add
+            add_project(args, output)
+          end
+        end
+      end
+
+      private
+
+      def add_project(args, output)
+        prompt = TTY::Prompt.new
+        name = prompt.ask('Project identifier: ')
+        name = name.downcase.gsub("_", "-").gsub(" ", "-").gsub(/[^0-9a-z\-]/i, '')
+        name = "+#{name}" unless name.start_with?('+')
+        output.puts name
+      end
+    end
+  end
+end

data/lib/intent/commands/todo.rb

@@ -0,0 +1,51 @@
+module Intent
+  module Commands
+    class Todo < Base
+      def run(args, output)
+        if args.empty?
+          print_help(output)
+        else
+          case args.first.to_sym
+          when :add then add_line(args, output)
+          when :list then list_draw(args, output)
+          when :focus then focus_draw(args, output)
+          else
+            raise "Verb not found"
+          end
+        end
+      end
+
+      private
+
+      def add_line(args, output)
+        reader = TTY::Reader.new
+        line = reader.read_line("task line: ")
+        documents.inbox.add_line!(line)
+      end
+
+      def focus_draw(args, output)
+        pastel = Pastel.new
+        documents.inbox.focused_projects.each do |project|
+          output.puts pastel.green(project)
+        end
+      end
+
+      def list_draw(args, output)
+        filtered_list = documents.inbox.all
+
+        unless args[1].nil?
+          case args[1][0]
+          when '@'
+            filtered_list = filtered_list.by_context(args[1]).by_not_done
+          when '+'
+            filtered_list = filtered_list.by_project(args[1])
+          end
+        end
+
+        filtered_list.by_not_done.each do |task|
+          output.puts task.to_s_highlighted
+        end
+      end
+    end
+  end
+end

data/lib/intent/commands.rb

@@ -0,0 +1,9 @@
+require 'intent/commands/base'
+require 'intent/commands/errors'
+require 'intent/commands/intent'
+require 'intent/commands/todo'
+require 'intent/commands/projects'
+#require 'intent/commands/project'
+#require 'intent/commands/ideas'
+#require 'intent/commands/idea'
+require 'intent/commands/inventory'