na 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2d4f45d14fddff26b88853edcac42f9d8250de1848f5d639138d757a0ce5bfe1
+  data.tar.gz: 73057d29cf56b1a3069973f5ea1ab4c06c4fcf76778997df12e51a56baf6ca0f
+SHA512:
+  metadata.gz: 1cfcd9dcf3543954f558ac25438bf84384f7c41fdde3f20ec7b6ce8970f971841e940d84b5eb003c5aa26dd17b77fde85901c10b9c30cb179a39a7ea1e26ac07
+  data.tar.gz: 824e2b356c805301fefd096bc851979e307268bb3ddc4f581c74cf03a4b8cf17de688e329a039c8754f646af99e6944f217d4cdd2e02a676fe7763ed08e93a26

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+### 1.0.0
+
+2022-09-27 10:45
+
+#### IMPROVED
+
+- Backwards compatibility with the Bash version of NA
+

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    na (1.0.0)
+      gli (~> 2.21.0)
+      tty-reader (~> 0.9, >= 0.9.0)
+      tty-which (~> 0.5, >= 0.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    gli (2.21.0)
+    minitest (5.16.3)
+    rake (0.9.6)
+    rdoc (4.3.0)
+    tty-cursor (0.7.1)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    tty-which (0.5.0)
+    wisper (2.0.1)
+
+PLATFORMS
+  arm64-darwin-20
+
+DEPENDENCIES
+  minitest (~> 5.14)
+  na!
+  rake (~> 0.9.2)
+  rdoc (~> 4.3)
+
+BUNDLED WITH
+   2.2.29

data/README.rdoc

@@ -0,0 +1,6 @@
+= na
+
+A command line tool for adding and listing project todos in TaskPaper format.
+
+:include:na.rdoc
+

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+ t.files = ['lib/doing/*.rb']
+ t.options = ['--markup-provider=redcarpet', '--markup=markdown', '--no-private', '-p', 'yard_templates']
+ # t.stats_options = ['--list-undoc']
+end
+
+task :doc, [*Rake.application[:yard].arg_names] => [:yard]
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'Your application title'
+end
+
+spec = eval(File.read('na.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => :test

data/bin/na

@@ -0,0 +1,285 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(__dir__, '..', 'lib')
+require 'gli'
+require 'na'
+
+class App
+  extend GLI::App
+
+  program_desc 'Add and list next actions for the current project'
+
+  version Na::VERSION
+  hide_commands_without_desc true
+  autocomplete_commands false
+  wrap_help_text :one_line unless $stdout.isatty
+
+  config_file '.na.rc'
+
+  desc 'File extension to consider a todo file'
+  default_value 'taskpaper'
+  arg_name 'FILE_EXTENSION'
+  flag :ext
+
+  desc 'Tag to consider a next action'
+  default_value 'na'
+  arg_name 'TAG'
+  flag :na_tag
+
+  default_command :next
+
+  NA::Color.coloring = $stdin.isatty
+
+  desc 'Add a next action (deprecated, for backwards compatibility)'
+  switch %i[a add]
+
+  desc 'Set a priority 0-5 (deprecated, for backwards compatibility)'
+  arg_name 'PRIORITY'
+  flag %i[p priority]
+
+  desc 'Prompt for additional notes (deprecated, for backwards compatibility)'
+  switch %i[n note]
+
+  desc 'Recurse 3 directories deep (deprecated, for backwards compatability)'
+  switch %i[r recurse], default_value: false, negatable: true
+
+  desc 'Recurse to depth'
+  arg_name 'DEPTH'
+  default_value 1
+  flag %i[d depth], type: :integer, must_match: /^\d+$/
+
+  desc 'Show next actions'
+  command %i[next show] do |c|
+    c.desc 'Recurse to depth'
+    c.arg_name 'DEPTH'
+    c.flag %i[d depth], type: :integer, must_match: /^\d+$/
+
+    c.desc 'Alternate tag to search for'
+    c.default_value 'na'
+    c.flag %i[t tag]
+
+    c.action do |global_options, options, _|
+      if global_options[:add]
+        cmd = ['add']
+        cmd.push('--note') if global_options[:note]
+        cmd.concat(['--priority', global_options[:priority]]) if global_options[:priority]
+        cmd.push(ARGV.unshift(@command))
+        p cmd
+        exit run(cmd)
+      end
+
+      depth = if global_options[:recurse] && options[:depth].nil? && global_options[:depth] == 1
+                3
+              else
+                options[:depth].nil? ? global_options[:depth].to_i : options[:depth].to_i
+              end
+      tag = options[:tag] == global_options[:na_tag] ? nil : options[:tag]
+      actions = NA.parse_actions(depth: depth,
+                                 extension: global_options[:ext],
+                                 na_tag: global_options[:na_tag],
+                                 tag: tag)
+      NA.output_actions(actions, depth, global_options[:ext])
+    end
+  end
+
+  desc 'Add a new next action'
+  arg_name 'TASK'
+  command :add do |c|
+    c.desc 'Prompt for additional notes'
+    c.switch %i[n note]
+
+    c.desc 'Add a priority level 1-5'
+    c.flag %i[p priority], must_match: /[1-5]/, type: :integer, default_value: 0
+
+    c.desc 'Use a tag other than the default next action tag'
+    c.arg_name 'TAG'
+    c.flag %i[t tag]
+
+    c.desc 'Specify the file to which the task should be added'
+    c.arg_name 'PATH'
+    c.flag %i[f file]
+
+    c.action do |global_options, options, args|
+      reader = TTY::Reader.new
+      action = if args.count.positive?
+                 args.join(' ').strip
+               elsif TTY::Which.exist?('gum')
+                 `gum input --placeholder "Enter a task"`.strip
+               else
+                 puts NA::Color.template('{bm}Enter task:{x}')
+                 reader.read_line(NA::Color.template('{by}> {bw}')).strip
+               end
+
+      if action.nil? || action.empty?
+        puts 'Empty input, cancelled'
+        Process.exit 1
+      end
+
+      if options[:priority]&.to_i&.positive?
+        action = "#{action.gsub(/@priority\(\d+\)/, '')} @priority(#{options[:priority]})"
+      end
+
+      na_tag = global_options[:na_tag]
+      na_tag = options[:tag] unless options[:tag].nil?
+
+      action = "#{action.gsub(/@#{na_tag}/, '')} @#{na_tag}"
+
+      note = if options[:note]
+               if TTY::Which.exist?('gum')
+                 `gum write --placeholder "Enter a note, CTRL-d to save" --width $(tput cols) --char-limit 0`.strip.split("\n")
+               else
+                 puts NA::Color.template('{bm}Enter a note, {bw}CTRL-d{bm} to end editing{bw}')
+                 reader.read_multiline
+               end
+             end
+      if options[:file]
+        target = File.expand_path(options[:file])
+        unless File.exist?(target)
+          print NA::Color.template('{by}Specified file not found, create it? {w}(y/{g}N{w}){x} ')
+          res = reader.read_char
+          if res =~ /y/i
+            basename = File.basename(target, ".#{global_options[:ext]}")
+            NA.create_todo(target, basename)
+          else
+            puts NA::Color.template('{r}Cancelled{x}')
+            Process.exit 1
+          end
+        end
+      else
+        files = NA.find_files(depth: 1, extension: global_options[:ext])
+        if files.count == 0
+          print NA::Color.template('{by}No todo file found, create one? {w}(y/{g}N{w}){x} ')
+          res = reader.read_char
+          if res =~ /y/i
+            basename = File.expand_path('.').split('/').last
+            target = "#{basename}.#{global_options[:ext]}"
+            NA.create_todo(target, basename)
+            files = NA.find_files(depth: 1, extension: global_options[:ext])
+          end
+        end
+        target = files.count > 1 ? NA.select_file(files) : files[0]
+        unless files.count.positive? && File.exist?(target)
+          puts NA::Color.template('{r}Cancelled{x}')
+          Process.exit 1
+        end
+      end
+
+      NA.add_action(target, action, note)
+    end
+  end
+
+  desc 'Find actions matching a search pattern'
+  long_desc 'Search tokens are separated by spaces. Actions matching any token in the pattern will be shown
+  (partial matches allowed). Add a + before a token to make it required, e.g. `na find +feature +maybe`'
+  arg_name 'PATTERN'
+  command %i[find] do |c|
+    c.desc 'Match pattern exactly'
+    c.switch %i[x exact]
+
+    c.desc 'Recurse to depth'
+    c.arg_name 'DEPTH'
+    c.default_value 1
+    c.flag %i[d depth], type: :integer, must_match: /^\d+$/
+
+    c.action do |global_options, options, args|
+      depth = if global_options[:recurse] && options[:depth].nil? && global_options[:depth] == 1
+                3
+              else
+                options[:depth].nil? ? global_options[:depth].to_i : options[:depth].to_i
+              end
+      tokens = nil
+      if options[:exact]
+        tokens = args.join(' ')
+      else
+        tokens = []
+        args.each do |arg|
+          m = arg.match(/^(?<req>\+)?(?<tok>.*?)$/)
+          tokens.push({
+                        token: m['tok'],
+                        required: !m['req'].nil?
+                      })
+        end
+      end
+
+      actions = NA.parse_actions(depth: depth,
+                                 extension: global_options[:ext],
+                                 na_tag: global_options[:na_tag],
+                                 search: tokens)
+      NA.output_actions(actions, depth, global_options[:ext])
+    end
+  end
+
+
+  desc 'Find actions matching a tag'
+  long_desc 'Finds actions with tags matching the arguments. An action is shown if it
+  contains any of the tags listed. Add a + before a tag to make it required,
+  e.g. `na tagged feature +maybe`'
+  arg_name 'TAG [VALUE]'
+  command %i[tagged] do |c|
+    c.desc 'Recurse to depth'
+    c.arg_name 'DEPTH'
+    c.default_value 1
+    c.flag %i[d depth], type: :integer, must_match: /^\d+$/
+
+    c.action do |global_options, options, args|
+      depth = if global_options[:recurse] && options[:depth].nil? && global_options[:depth] == 1
+                3
+              else
+                options[:depth].nil? ? global_options[:depth].to_i : options[:depth].to_i
+              end
+
+      tags = []
+      args.each do |arg|
+        # TODO: <> comparisons do nothing right now
+        m = arg.match(/^(?<req>\+)?(?<tag>[^ =<>]+)(?:(?<op>[=<>]+)(?<val>\S+))?$/)
+        tags.push({
+                    tag: m['tag'],
+                    comp: m['op'],
+                    value: m['val'],
+                    required: !m['req'].nil?
+                  })
+      end
+
+      actions = NA.parse_actions(depth: depth,
+                                 extension: global_options[:ext],
+                                 na_tag: global_options[:na_tag],
+                                 tag: tags)
+      NA.output_actions(actions, depth, global_options[:ext])
+    end
+  end
+
+  pre do |global,command,options,args|
+    # Pre logic here
+    # Return true to proceed; false to abort and not call the
+    # chosen command
+    # Use skips_pre before a command to skip this block
+    # on that command only
+    true
+  end
+
+  post do |global,command,options,args|
+    # Post logic here
+    # Use skips_post before a command to skip this
+    # block on that command only
+  end
+
+  on_error do |exception|
+    case exception
+    when GLI::UnknownCommand
+      cmd = ['add']
+      if ARGV.count.positive?
+        cmd.concat(ARGV.unshift($first_arg))
+      end
+      p cmd
+      exit run(cmd)
+    when SystemExit
+      false
+    else
+      true
+    end
+  end
+end
+
+@command = ARGV[0]
+$first_arg = ARGV[1]
+
+exit App.run(ARGV)

data/html/App.html

@@ -0,0 +1,105 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class App - Your application title</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+  var index_rel_prefix = "./";
+</script>
+
+<script src="./js/navigation.js" defer></script>
+<script src="./js/search.js" defer></script>
+<script src="./js/search_index.js" defer></script>
+<script src="./js/searcher.js" defer></script>
+<script src="./js/darkfish.js" defer></script>
+
+<link href="./css/fonts.css" rel="stylesheet">
+<link href="./css/rdoc.css" rel="stylesheet">
+
+
+<body id="top" role="document" class="class">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="./index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="./table_of_contents.html#pages">Pages</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+
+  <div id="class-metadata">
+    
+    
+<div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+
+  <p class="link">Object
+</div>
+
+    
+    
+<div id="extends-section" class="nav-section">
+  <h3>Extended With Modules</h3>
+
+  <ul class="link-list">
+    <li><span class="extend">GLI::App</span>
+  </ul>
+</div>
+
+    
+  </div>
+</nav>
+
+<main role="main" aria-labelledby="class-App">
+  <h1 id="class-App" class="class">
+    class App
+  </h1>
+
+  <section class="description">
+    
+  </section>
+
+  <section id="5Buntitled-5D" class="documentation-section">
+
+
+
+
+
+  </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.3.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+