intent 0.5.5 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63f5433d3a5bff8c95271194b5bc5df740274ae9d42f405f16a1bf11a5f11cc3
-  data.tar.gz: a7fc46a07d03ce70c2339d3cc535038a040fb60847ad224997e57316642e1ec8
+  metadata.gz: a80e9d9082642b1f2325b40629ff95ffb096cdba644d0f2d5aa2af25541c2d2b
+  data.tar.gz: 90ed06f5afbf84636fbeb70e6fab66a4868dc0d485b751178b2ff31568315237
 SHA512:
-  metadata.gz: a314b0917a17bce8e386964fcdfaa4c791f2ed36168428fd9412ddace6c4e847efc1a831519c8d095ee1721bd4e60e4c2a5265a895ef202d2cbdc8d8ec507247
-  data.tar.gz: 82607a04b4d1d3f8a91f78a3dc1cba8e2c0dd4e82348fb1dc98b1270e76d32de543d9977a88643495c019529b2fed317cd6e68481009bd9376fbeef1e956390a
+  metadata.gz: a4a23b8d4882af953e2d330c26388c91bb86513c1881192952998f6f74b5f49b682f4b609566ea18b0b6f0ad7517020ac15ccc22ce8756edc001ac5fc25c455b
+  data.tar.gz: cfc14324613fc505a6ec0a591e73f667dd3360b4ec1d8ee7f05d86813fcbaf5e645f12b917579adc6b046223dbc251f665f65b0cd70087dac39d59cc7adfdccf

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

@@ -1,41 +1,23 @@
 # Intent
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/intent`. To experiment with that code, run `bin/console` for an interactive prompt.
+Automation engine with todo.txt
 
-TODO: Delete this and the text above, and describe your gem
+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
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'intent'
 ```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install intent
+gem install intent
+```
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/intent. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
-
+```
+intent help
+```
 
-## License
+## Copyright & License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+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/project_doc

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+require "tty-markdown"
+require "tty-pager"
+
+PROJECTS_PATH = File.dirname(ENV['TODO_TXT'])
+
+class ProjectDocCommand
+  def self.print_help(output)
+    output.puts "Pass in a project name to read its main document."
+    output.puts "Future iterations could display a list of available documents."
+    # Command idea: Add milestone to document
+  end
+
+  def self.run(args, output=STDOUT)
+    if args.empty?
+      print_help(output)
+    else
+      project_name = args.first.delete("^0–9a-z\-")
+      project_path = "#{PROJECTS_PATH}/#{project_name}"
+
+      if Dir.exists?(project_path)
+        pager = TTY::Pager.new
+        intent = File.read("#{project_path}/#{project_name}.md")
+        pager.page(TTY::Markdown.parse(intent))
+      end
+    end
+  end
+end
+
+ProjectDocCommand.run(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/projects_active

@@ -0,0 +1,123 @@
+#!/usr/bin/env ruby
+require "tty-box"
+require "tty-screen"
+require "tty-reader"
+require "tty-cursor"
+require "tty-pager"
+require "pastel"
+require "todo-txt"
+
+list = Todo::List.new(ENV['TODO_TXT'])
+
+box = TTY::Box.frame(
+  width: TTY::Screen.width,
+  height: TTY::Screen.height-1,
+  align: :center,
+  border: :thick,
+  style: {
+    fg: :bright_yellow,
+    border: {
+      fg: :white,
+    }
+  }
+)
+
+focus_index = 0
+
+def truncate(str, width)
+  return str unless str.length >= width
+
+  "#{str.slice(0, width-3)}..."
+end
+
+def draw_card(top, item, focus)
+
+  style = unless top == focus
+    { fg: :white, border: { fg: :white } }
+  else
+    { fg: :bright_white, border: { fg: :bright_magenta, bg: :black } }
+  end
+
+  title = if top == focus
+    {bottom_right: "[x: close][enter: launch]"}
+  else
+    {}
+  end
+
+  #pastel = Pastel.new
+  width = 90
+
+  TTY::Box.frame(width: width, height: 4, left: 4, title: title, border: :thick, style: style) do
+    "\s#{truncate(item[:title], 88)}"
+  end
+end
+
+projects = [
+  { title: "maetl", index: File.read(File.expand_path("~/Documents/Projects/maetl/maetl.md")) },
+  { title: "calyx", index: File.read(File.expand_path("~/Documents/Projects/calyx/calyx.md")) },
+  { title: "yarrow", index: File.read(File.expand_path("~/Documents/Projects/yarrow/yarrow.md")) }
+]
+
+items_per_page = (TTY::Screen.height-1) / 4
+
+# items = list.by_not_done.by_context("@reading").slice(0, items_per_page).map do |item|
+#   { title: item.text, href: item.text }
+# end
+
+$cursor = TTY::Cursor
+#print $cursor.hide
+
+def draw_list(items, focus)
+  buffer = []
+  items.each_with_index do |item, i|
+    buffer << draw_card(i, item, focus)
+  end
+  result = buffer.join("")
+
+  print $cursor.clear_screen + $cursor.move_to(0,0)
+  print result
+end
+
+draw_list(projects, focus_index)
+
+reader = TTY::Reader.new(interrupt: :exit)
+
+reader.on(:keyctrl_x, :keyescape) do
+  print $cursor.clear_screen + $cursor.move_to(0,0)
+  print $cursor.show
+  exit
+end
+
+reader.on(:keytab, :keydown) do
+  if focus_index == projects.count - 1
+    focus_index = 0
+  else
+    focus_index += 1
+  end
+  draw_list(projects, focus_index)
+end
+
+reader.on(:keyup) do
+  if focus_index == 0
+    focus_index = projects.count - 1
+  else
+    focus_index -= 1
+  end
+  draw_list(projects, focus_index)
+end
+
+reader.on(:keypress) do |key|
+  # if key.value == "x"
+  #   items.delete_at(focus_index)
+  #   focus_index -= 1 if focus_index >= items.count
+  #   draw_list(items, focus_index)
+  # end
+end
+
+reader.on(:keyenter) do
+  `chrome-cli open #{items[focus_index][:href]}`
+end
+
+loop do
+  reader.read_line(echo: false)
+end

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/bin/todo_review

@@ -0,0 +1,123 @@
+#!/usr/bin/env ruby
+require "tty-box"
+require "tty-screen"
+require "tty-reader"
+require "tty-cursor"
+require "tty-pager"
+require "pastel"
+require "todo-txt"
+
+list = Todo::List.new(ENV['TODO_TXT'])
+
+box = TTY::Box.frame(
+  width: TTY::Screen.width,
+  height: TTY::Screen.height-1,
+  align: :center,
+  border: :thick,
+  style: {
+    fg: :bright_yellow,
+    border: {
+      fg: :white,
+    }
+  }
+)
+
+focus_index = 0
+
+def truncate(str, width)
+  return str unless str.length >= width
+
+  "#{str.slice(0, width-3)}..."
+end
+
+def draw_card(top, item, focus)
+
+  style = unless top == focus
+    { fg: :white, border: { fg: :white } }
+  else
+    { fg: :bright_white, border: { fg: :bright_magenta, bg: :black } }
+  end
+
+  title = if top == focus
+    {bottom_right: "[x: close][enter: launch]"}
+  else
+    {}
+  end
+
+  #pastel = Pastel.new
+  width = 90
+
+  TTY::Box.frame(width: width, height: 4, left: 4, title: title, border: :thick, style: style) do
+    "\s#{truncate(item[:title], 88)}\n\s#{truncate(item[:href], 88)}"
+  end
+end
+
+items = [
+  { title: "maetl website", href: "https://maetl.net/" },
+  { title: "tty-cursor on Github", href: "https://github.com/piotrmurach/tty-cursor" },
+  { title: "Tangram Design", href: "https://tangram.co.nz" },
+]
+
+items_per_page = (TTY::Screen.height-1) / 4
+
+items = list.by_not_done.by_context("@reading").slice(0, items_per_page).map do |item|
+  { title: item.text, href: item.text }
+end
+
+$cursor = TTY::Cursor
+print $cursor.hide
+
+def draw_list(items, focus)
+  buffer = []
+  items.each_with_index do |item, i|
+    buffer << draw_card(i, item, focus)
+  end
+  result = buffer.join("")
+
+  print $cursor.clear_screen + $cursor.move_to(0,0)
+  print result
+end
+
+draw_list(items, focus_index)
+
+reader = TTY::Reader.new(interrupt: :exit)
+
+reader.on(:keyctrl_x, :keyescape) do
+  print $cursor.clear_screen + $cursor.move_to(0,0)
+  print $cursor.show
+  exit
+end
+
+reader.on(:keytab, :keydown) do
+  if focus_index == items.count - 1
+    focus_index = 0
+  else
+    focus_index += 1
+  end
+  draw_list(items, focus_index)
+end
+
+reader.on(:keyup) do
+  if focus_index == 0
+    focus_index = items.count - 1
+  else
+    focus_index -= 1
+  end
+  draw_list(items, focus_index)
+end
+
+reader.on(:keypress) do |key|
+  if key.value == "x"
+    items.delete_at(focus_index)
+    focus_index -= 1 if focus_index >= items.count
+    draw_list(items, focus_index)
+  end
+end
+
+reader.on(:keyenter) do
+  `chrome-cli open #{items[focus_index][:href]}`
+end
+
+loop do
+  reader.read_line(echo: false)
+end

data/intent.gemspec

@@ -18,14 +18,22 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "todo-txt", "~> 0.11"
-  spec.add_runtime_dependency "pastel", "~> 0.6"
-  spec.add_runtime_dependency "git", "~> 1.3.0"
-  spec.add_runtime_dependency "terminal-notifier", "~> 1.8.0"
+  spec.add_runtime_dependency "todo-txt", "~> 0.12"
+  spec.add_runtime_dependency "pastel", "~> 0.8"
+  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_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 end

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