na 1.2.35 → 1.2.38

data/lib/na/pager.rb

@@ -44,7 +44,7 @@ module NA
           IO.select [input]
 
           begin
-            NA.notify("{dw}Pager #{pager}", debug: true)
+            NA.notify("#{NA.theme[:debug]}Pager #{pager}", debug: true)
             exec(pager)
           rescue SystemCallError => e
             raise Errors::DoingStandardError, "Pager error, #{e}"

data/lib/na/prompt.rb

@@ -14,7 +14,7 @@ module NA
                   when :tag
                     'na tagged $(basename "$PWD")'
                   else
-                    NA.notify('When using a global file, a prompt hook requires `--cwd_as [tag|project]`', exit_code: 1)
+                    NA.notify("#{NA.theme[:error]}When using a global file, a prompt hook requires `--cwd_as [tag|project]`", exit_code: 1)
                   end
                 else
                   'na next'
@@ -31,7 +31,7 @@ module NA
                   when :tag
                     'na tagged (basename "$PWD")'
                   else
-                    NA.notify('When using a global file, a prompt hook requires `--cwd_as [tag|project]`', exit_code: 1)
+                    NA.notify("#{NA.theme[:error]}When using a global file, a prompt hook requires `--cwd_as [tag|project]`", exit_code: 1)
                   end
                 else
                   'na next'
@@ -50,7 +50,7 @@ module NA
                   when :tag
                     'na tagged $(basename "$PWD")'
                   else
-                    NA.notify('When using a global file, a prompt hook requires `--cwd_as [tag|project]`', exit_code: 1)
+                    NA.notify("#{NA.theme[:error]}When using a global file, a prompt hook requires `--cwd_as [tag|project]`", exit_code: 1)
                   end
                 else
                   'na next'
@@ -83,7 +83,7 @@ module NA
       def show_prompt_hook(shell)
         file = prompt_file(shell)
 
-        NA.notify("{bw}# Add this to {y}#{file}{x}")
+        NA.notify("#{NA.theme[:warning]}# Add this to #{NA.theme[:filename]}#{file}")
         puts prompt_hook(shell)
       end
 
@@ -91,8 +91,8 @@ module NA
         file = prompt_file(shell)
 
         File.open(File.expand_path(file), 'a') { |f| f.puts prompt_hook(shell) }
-        NA.notify("{y}Added {bw}#{shell}{xy} prompt hook to {bw}#{file}{xy}.{x}")
-        NA.notify("{y}You may need to close the current terminal and open a new one to enable the script.{x}")
+        NA.notify("#{NA.theme[:success]}Added #{NA.theme[:filename]}#{shell}{x}#{NA.theme[:success]} prompt hook to #{NA.theme[:filename]}#{file}#{NA.theme[:success]}.")
+        NA.notify("#{NA.theme[:warning]}You may need to close the current terminal and open a new one to enable the script.")
       end
     end
   end

data/lib/na/string.rb

@@ -6,6 +6,15 @@ REGEX_TIME = /^#{REGEX_CLOCK}$/i.freeze
 
 # String helpers
 class ::String
+  ##
+  ## Insert a comment character at the start of every line
+  ##
+  ## @param      char  [String] The character to insert (default #)
+  ##
+  def comment(char = "#")
+    split(/\n/).map { |l| "# #{l}" }.join("\n")
+  end
+
   ##
   ## Tests if object is nil or empty
   ##
@@ -75,6 +84,17 @@ class ::String
     self =~ /@#{NA.na_tag}\b/
   end
 
+  ##
+  ## Colorize the dirname and filename of a path
+  ##
+  ## @return     Colorized string
+  ##
+  def highlight_filename
+    dir = File.dirname(self).shorten_path
+    file = File.basename(self, ".#{NA.extension}")
+    "#{NA.theme[:dirname]}#{dir}/#{NA.theme[:filename]}#{file}{x}"
+  end
+
   ##
   ## Colorize @tags with ANSI escapes
   ##
@@ -88,7 +108,7 @@ class ::String
   ##
   ## @return     [String] string with @tags highlighted
   ##
-  def highlight_tags(color: '{m}', value: '{y}', parens: '{m}', last_color: '{xg}')
+  def highlight_tags(color: NA.theme[:tags], value: NA.theme[:value], parens: NA.theme[:value_parens], last_color: NA.theme[:action])
     tag_color = NA::Color.template(color)
     paren_color = NA::Color.template(parens)
     value_color = NA::Color.template(value)
@@ -106,9 +126,9 @@ class ::String
   ## @param      last_color  [String] Color to restore after
   ##                         highlight
   ##
-  def highlight_search(regexes, color: '{y}', last_color: '{xg}')
+  def highlight_search(regexes, color: NA.theme[:search_highlight], last_color: NA.theme[:action])
     string = dup
-    color = NA::Color.template(color)
+    color = NA::Color.template(color.dup)
     regexes.each do |rx|
       next if rx.nil?
 

data/lib/na/theme.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module NA
+  module Theme
+    class << self
+      def template_help
+        <<~EOHELP
+          Use {X} placeholders to apply colors. Available colors are:
+
+          w: white, k: black, g: green, l: blue,
+          y: yellow, c: cyan, m: magenta, r: red,
+          W: bgwhite, K: bgblack, G: bggreen, L: bgblue,
+          Y: bgyellow, C: bgcyan, M: bgmagenta, R: bgred,
+          d: dark, b: bold, u: underline, i: italic, x: reset
+
+          Multiple placeholders can be combined in a single {} pair.
+
+          You can also use {#RGB} and {#RRGGBB} to specify hex colors.
+          Add a b before the # to make the hex a background color ({b#fa0}).
+
+
+        EOHELP
+      end
+
+      def load_theme(template: {})
+        # Default colorization, can be overridden with full or partial template variable
+        default_template = {
+          parent: '{c}',
+          bracket: '{dc}',
+          parent_divider: '{xw}/',
+          action: '{bg}',
+          project: '{xbk}',
+          tags: '{m}',
+          value_parens: '{m}',
+          values: '{c}',
+          search_highlight: '{y}',
+          note: '{dw}',
+          dirname: '{dw}',
+          filename: '{xb}{#eccc87}',
+          prompt: '{m}',
+          success: '{bg}',
+          error: '{b}{#b61d2a}',
+          warning: '{by}',
+          debug: '{dw}',
+          templates: {
+            output: '%filename%parents| %action',
+            default: '%parent%action',
+            single_file: '%parent%action',
+            multi_file: '%filename%parent%action'
+          }
+        }
+
+        # Load custom theme
+        theme_file = NA.database_path(file: 'theme.yaml')
+        theme = if File.exist?(theme_file)
+                  YAML.load(IO.read(theme_file)) || {}
+                else
+                  {}
+                end
+        theme = default_template.merge(theme)
+
+        File.open(theme_file, 'w') do |f|
+          f.puts template_help.comment
+          f.puts YAML.dump(theme)
+        end
+
+        theme.merge(template)
+      end
+    end
+  end
+end

data/lib/na/todo.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+module NA
+  class Todo
+    attr_accessor :actions, :projects, :files
+
+    def initialize(options = {})
+      @files, @actions, @projects = parse(options)
+    end
+
+    ##
+    ## Read a todo file and create a list of actions
+    ##
+    ## @param      options  The options
+    ##
+    ## @option      depth       [Number] The directory depth to
+    ##                         search for files
+    ## @option      done        [Boolean] include @done actions
+    ## @option      query       [Hash] The todo file query
+    ## @option      tag         [Array] Tags to search for
+    ## @option      search      [String] A search string
+    ## @option      negate      [Boolean] Invert results
+    ## @option      regex       [Boolean] Interpret as regular
+    ##                         expression
+    ## @option      project     [String] The project
+    ## @option      require_na  [Boolean] Require @na tag
+    ## @option      file_path   [String] file path to parse
+    ##
+    def parse(options)
+      defaults = {
+        depth: 1,
+        done: false,
+        file_path: nil,
+        negate: false,
+        project: nil,
+        query: nil,
+        regex: false,
+        require_na: true,
+        search: nil,
+        tag: nil
+      }
+
+      settings = defaults.merge(options)
+
+      actions = NA::Actions.new
+      required = []
+      optional = []
+      negated = []
+      required_tag = []
+      optional_tag = []
+      negated_tag = []
+      projects = []
+
+      NA.notify("Tags: #{settings[:tag]}", debug:true)
+      NA.notify("Search: #{settings[:search]}", debug:true)
+
+      settings[:tag]&.each do |t|
+        unless t[:tag].nil?
+          if settings[:negate]
+            optional_tag.push(t) if t[:negate]
+            required_tag.push(t) if t[:required] && t[:negate]
+            negated_tag.push(t) unless t[:negate]
+          else
+            optional_tag.push(t) unless t[:negate]
+            required_tag.push(t) if t[:required] && !t[:negate]
+            negated_tag.push(t) if t[:negate]
+          end
+        end
+      end
+
+      unless settings[:search].nil? || settings[:search].empty?
+        if settings[:regex] || settings[:search].is_a?(String)
+          if settings[:negate]
+            negated.push(settings[:search])
+          else
+            optional.push(settings[:search])
+            required.push(settings[:search])
+          end
+        else
+          settings[:search].each do |t|
+            opt, req, neg = parse_search(t, settings[:negate])
+            optional.concat(opt)
+            required.concat(req)
+            negated.concat(neg)
+          end
+        end
+      end
+
+      files = if !settings[:file_path].nil?
+                [settings[:file_path]]
+              elsif settings[:query].nil?
+                NA.find_files(depth: settings[:depth])
+              else
+                NA.match_working_dir(settings[:query])
+              end
+
+      files.each do |file|
+        NA.save_working_dir(File.expand_path(file))
+        content = file.read_file
+        indent_level = 0
+        parent = []
+        in_action = false
+        content.split(/\n/).each.with_index do |line, idx|
+          if line.project?
+            in_action = false
+            proj = line.project
+            indent = line.indent_level
+
+            if indent.zero? # top level project
+              parent = [proj]
+            elsif indent <= indent_level # if indent level is same or less, split parent before indent level and append
+              parent.slice!(indent, parent.count - indent)
+              parent.push(proj)
+            else # if indent level is greater, append project to parent
+              parent.push(proj)
+            end
+
+            projects.push(NA::Project.new(parent.join(':'), indent, idx, idx))
+
+            indent_level = indent
+          elsif line.blank?
+            in_action = false
+          elsif line.action?
+            in_action = false
+
+            action = line.action
+            new_action = NA::Action.new(file, File.basename(file, ".#{NA.extension}"), parent.dup, action, idx)
+
+            projects[-1].last_line = idx if projects.count.positive?
+
+            next if line.done? && !settings[:done]
+
+            next if settings[:require_na] && !line.na?
+
+            has_search = !optional.empty? || !required.empty? || !negated.empty?
+
+            next if has_search && !new_action.search_match?(any: optional,
+                                                            all: required,
+                                                            none: negated)
+
+            if settings[:project]
+              rx = settings[:project].split(%r{[/:]}).join('.*?/')
+              next unless parent.join('/') =~ Regexp.new("#{rx}.*?", Regexp::IGNORECASE)
+            end
+
+            has_tag = !optional_tag.empty? || !required_tag.empty? || !negated_tag.empty?
+            next if has_tag && !new_action.tags_match?(any: optional_tag,
+                                                       all: required_tag,
+                                                       none: negated_tag)
+
+            actions.push(new_action)
+            in_action = true
+          elsif in_action
+            actions[-1].note.push(line.strip) if actions.count.positive?
+            projects[-1].last_line = idx if projects.count.positive?
+          end
+        end
+        projects = projects.dup
+      end
+
+      [files, actions, projects]
+    end
+
+    def parse_search(tag, negate)
+      required = []
+      optional = []
+      negated = []
+      new_rx = tag[:token].to_s.wildcard_to_rx
+
+      if negate
+        optional.push(new_rx) if tag[:negate]
+        required.push(new_rx) if tag[:required] && tag[:negate]
+        negated.push(new_rx) unless tag[:negate]
+      else
+        optional.push(new_rx) unless tag[:negate]
+        required.push(new_rx) if tag[:required] && !tag[:negate]
+        negated.push(new_rx) if tag[:negate]
+      end
+
+      [optional, required, negated]
+    end
+  end
+end

data/lib/na/version.rb

@@ -1,3 +1,3 @@
 module Na
-  VERSION = '1.2.35'
+  VERSION = '1.2.38'
 end

data/lib/na.rb

@@ -13,7 +13,11 @@ require 'na/hash'
 require 'na/colors'
 require 'na/string'
 require 'na/array'
+require 'na/theme'
+require 'na/todo'
+require 'na/actions'
 require 'na/project'
 require 'na/action'
+require 'na/editor'
 require 'na/next_action'
 require 'na/prompt'

data/src/_README.md

@@ -9,7 +9,7 @@
 _If you're one of the rare people like me who find this useful, feel free to
 [buy me some coffee][donate]._
 
-The current version of `na` is <!--VER-->1.2.34<!--END VER-->.
+The current version of `na` is <!--VER-->1.2.37<!--END VER-->.
 
 `na` ("next action") is a command line tool designed to make it easy to see what your next actions are for any project, right from the command line. It works with TaskPaper-formatted files (but any plain text format will do), looking for `@na` tags (or whatever you specify) in todo files in your current folder. 
 
@@ -209,6 +209,50 @@ See the help output for a list of all available actions.
 @cli(bundle exec bin/na help update)
 ```
 
+##### changelog
+
+View recent changes with `na changelog` or `na changes`.
+
+```
+@cli(bundle exec bin/na help changelog)
+```
+
+##### complete
+
+Mark an action as complete, shortcut for `na update --finish`.
+
+```
+@cli(bundle exec bin/na help complete)
+```
+
+##### archive
+
+Mark an action as complete and move to archive, shortcut for `na update --archive`.
+
+```
+@cli(bundle exec bin/na help archive)
+```
+
+##### tag
+
+Add, remove, or modify tags.
+
+Use `na tag TAGNAME --[search|tagged] SEARCH_STRING` to add a tag to matching action (use `--all` to apply to all matching actions). If you use `!TAGNAME` it will remove that tag (regardless of value). To change the value of an existing tag (or add it if it doesn't exist), use `~TAGNAME(NEW VALUE)`.
+
+```
+@cli(bundle exec bin/na help tag)
+```
+
+##### undo
+
+Undoes the last file change resulting from an add or update command. If no argument is given, it undoes whatever the last change in history was. If an argument is provided, it's used to match against the change history, finding a specific file to restore from backup.
+
+Only the most recent change can be undone.
+
+```
+@cli(bundle exec bin/na help undo)
+```
+
 ### Configuration
 
 Global options such as todo extension and default next action tag can be stored permanently by using the `na initconfig` command. Run na with the global options you'd like to set, and add `initconfig` at the end of the command. A file will be written to `~/.na.rc`. You can edit this manually, or just update it using the `initconfig --force` command to overwrite it with new settings.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: na
 version: !ruby/object:Gem::Version
-  version: 1.2.35
+  version: 1.2.38
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-30 00:00:00.000000000 Z
+date: 2023-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -222,12 +222,15 @@ files:
 - bin/commands/saved.rb
 - bin/commands/tagged.rb
 - bin/commands/todos.rb
+- bin/commands/undo.rb
 - bin/commands/update.rb
 - bin/na
 - lib/na.rb
 - lib/na/action.rb
+- lib/na/actions.rb
 - lib/na/array.rb
 - lib/na/colors.rb
+- lib/na/editor.rb
 - lib/na/hash.rb
 - lib/na/help_monkey_patch.rb
 - lib/na/next_action.rb
@@ -235,6 +238,8 @@ files:
 - lib/na/project.rb
 - lib/na/prompt.rb
 - lib/na/string.rb
+- lib/na/theme.rb
+- lib/na/todo.rb
 - lib/na/version.rb
 - na.gemspec
 - na.rdoc