howzit 2.0.34 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c2e8aec0ff890ed7c44ef8408de0661815ecc9de2af2c7b2a1a792186d00a02
-  data.tar.gz: b9564b552071749654a60087304b8c8ccc3ac70452434de8de8502267b7b79d9
+  metadata.gz: 28505fefd411902ebd75d786f31e6967822aaff975dbb1f55bb13994e583b792
+  data.tar.gz: 105e760d5595f4b8664969b6258240d17fb16ede995d3698e2d7bb4a36276824
 SHA512:
-  metadata.gz: 214bbba16b9e9a2fcc4b5ee4f4331448e09fcc0a4101fea02d69433a22e1edf8bec348d5022c7a38b95b7af25000ac4a111b65202b1bdc45a766f9d17a2d4337
-  data.tar.gz: 4364000c0df9ebeb7415034847e25e5aa90ac9c81ca94b86a877f7e781ef8227bc001ee76340e39d06763035be244fa8b79e81ceca066e5735a1c73ee7b98f16
+  metadata.gz: 338ad20ebae27dc9d504671df84789be608fd73b123b1a7966ae5cd6c160c7543d21596df6c6b4268fb827f732d80f581d8cb15520f02b19cb27014f4903ff51
+  data.tar.gz: 6283e6c567425ea667e399ca338ccdea86023157b9b58709d1f006fd94f8b71286eba18f6c170a25d2cae4bbc571f79b0a667936ec162967115b7cdb8b374684

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+### 2.1.1
+
+2023-03-07 09:47
+
+#### FIXED
+
+- Allow variables names to contain numbers and underscores
+
+### 2.1.0
+
+2023-03-07 09:24
+
+#### NEW
+
+- Use TOPIC_TITLE (var1, var2) to have access to ${var1} ${var2} in text and scripts, populated with positional variables on the command line
+- Add a default (fallback) value to any variable placeholder with ${var_name:default value}
+
 ### 2.0.34
 
 2023-01-15 13:32

data/README.md

@@ -21,6 +21,7 @@ Howzit is a tool that allows you to keep Markdown-formatted notes about a projec
 - Inside of git repositories, howzit will work from subdirectories, assuming build notes are in top level of repo
 - Templates for easily including repeat tasks
 - Grep topics for pattern and choose from matches
+- Use positional and named variables when executing tasks
 
 ## Getting Started
 

data/Rakefile

@@ -75,3 +75,5 @@ task :dockertest, :version, :login do |_, args|
   puts res
   # puts commit&.empty? ? "Error commiting Docker tag #{img}" : "Committed Docker tag #{img}"
 end
+
+task package: :build

data/bin/howzit

@@ -9,6 +9,7 @@ Howzit::Color.coloring = $stdout.isatty
 parts = Shellwords.shelljoin(ARGV).split(/ -- /)
 args = parts[0] ? Shellwords.shellsplit(parts[0]) : []
 Howzit.arguments = parts[1] ? Shellwords.shellsplit(parts[1]) : []
+Howzit.named_arguments = {}
 
 OptionParser.new do |opts|
   opts.banner = "Usage: #{File.basename(__FILE__)} [OPTIONS] [TOPIC]"

data/lib/howzit/buildnote.rb

@@ -69,10 +69,9 @@ module Howzit
     ##
     def find_topic(term = nil)
       return @topics if term.nil?
-
       @topics.filter do |topic|
         rx = term.to_rx
-        topic.title.downcase =~ rx
+        topic.title.downcase.sub(/ *\(.*?\) *$/, '') =~ rx
       end
     end
 
@@ -109,7 +108,6 @@ module Howzit
       output.join("\n")
     end
 
-
     ##
     ## Return an array of topic titles
     ##
@@ -218,7 +216,7 @@ module Howzit
       end
 
       if File.exist?(file) && !default && Prompt.yn("{bg}Do you want to open {bw}#{file} {bg}for editing?{x}".c,
-                                                     default: false)
+                                                    default: false)
         edit_template_file(file)
       end
 
@@ -364,6 +362,7 @@ module Howzit
       t_leader = Util.read_file(template).split(/^#/)[0].strip
       if t_leader.length > 0
         t_meta = t_leader.get_metadata
+
         if t_meta.key?('required')
           required = t_meta['required'].strip.split(/\s*,\s*/)
           required.each do |req|
@@ -699,14 +698,12 @@ module Howzit
     def process_topic(topic, run, single: false)
       new_topic = topic.is_a?(String) ? find_topic(topic)[0] : topic.dup
 
-      # Handle variable replacement
-      new_topic.content = new_topic.content.render_arguments
-
       output = if run
                  new_topic.run
                else
                  new_topic.print_out({ single: single })
                end
+
       output.nil? ? '' : output.join("\n")
     end
 
@@ -755,6 +752,7 @@ module Howzit
       end
 
       topic_matches = []
+
       if Howzit.options[:grep]
         matches = grep(Howzit.options[:grep])
         case Howzit.options[:multiple_matches]

data/lib/howzit/stringutils.rb

@@ -95,7 +95,7 @@ module Howzit
       when 'beginswith'
         /^#{self}/i
       when 'fuzzy'
-        /#{split(//).join('.*?')}/i
+        /#{split(//).join('.{0,3}?')}/i
       else
         /#{self}/i
       end
@@ -241,13 +241,26 @@ module Howzit
     ## @return     [String] rendered string
     ##
     def render_arguments
-      return self if Howzit.arguments.nil? || Howzit.arguments.empty?
+      str = dup
+      str.gsub!(/\$\{(?<name>[A-Z0-9_]+(?::.*?)?)\}/i) do |mtch|
+        m = Regexp.last_match
+        arg, default = m['name'].split(/:/).map(&:strip)
+        Howzit.named_arguments.key?(arg) && !Howzit.named_arguments[arg].nil? ? Howzit.named_arguments[arg] : default
+      end
 
-      gsub!(/\$(\d+)/) do |m|
-        idx = m[1].to_i - 1
-        Howzit.arguments.length > idx ? Howzit.arguments[idx] : m
+      str.gsub!(/\$\{?(\d+)\}?/) do
+        m = Regexp.last_match
+        arg, default = m[1].split(/:/)
+        idx = arg.to_i - 1
+        if Howzit.arguments.length > idx
+          Howzit.arguments[idx]
+        elsif default
+          default
+        else
+          m[0]
+        end
       end
-      gsub(/\$[@*]/, Shellwords.join(Howzit.arguments))
+      Howzit.arguments.nil? ? str : str.gsub(/\$[@*]/, Shellwords.join(Howzit.arguments))
     end
 
     ##

data/lib/howzit/task.rb

@@ -3,7 +3,7 @@
 module Howzit
   # Task object
   class Task
-    attr_reader :type, :title, :action, :parent, :optional, :default
+    attr_reader :type, :title, :action, :arguments, :parent, :optional, :default
 
     ##
     ## Initialize a Task object
@@ -21,11 +21,14 @@ module Howzit
     def initialize(attributes, optional: false, default: true)
       @prefix = "{bw}\u{25B7}\u{25B7} {x}"
       # arrow = "{bw}\u{279F}{x}"
+      @arguments = attributes[:arguments] || []
 
       @type = attributes[:type] || :run
       @title = attributes[:title] || nil
-      @action = attributes[:action].render_arguments || nil
       @parent = attributes[:parent] || nil
+
+      @action = attributes[:action].render_arguments || nil
+
       @optional = optional
       @default = default
     end
@@ -36,7 +39,7 @@ module Howzit
     ## @return     [String] description
     ##
     def inspect
-      %(<#Howzit::Task @type=:#{@type} @title="#{@title}" @block?=#{@action.split(/\n/).count > 1}>)
+      %(<#Howzit::Task @type=:#{@type} @title="#{@title}" @arguments=#{@arguments} @block?=#{@action.split(/\n/).count > 1}>)
     end
 
     ##
@@ -75,8 +78,10 @@ module Howzit
     ##
     def run_include
       output = []
-      matches = Howzit.buildnote.find_topic(@action)
-      raise "Topic not found: #{@action}" if matches.empty?
+      action = @action
+
+      matches = Howzit.buildnote.find_topic(action)
+      raise "Topic not found: #{action}" if matches.empty?
 
       Howzit.console.info("#{@prefix}{by}Running tasks from {bw}#{matches[0].title}{x}".c)
       output.concat(matches[0].run(nested: true))

data/lib/howzit/topic.rb

@@ -7,7 +7,7 @@ module Howzit
 
     attr_accessor :content
 
-    attr_reader :title, :tasks, :prereqs, :postreqs, :results
+    attr_reader :title, :tasks, :prereqs, :postreqs, :results, :named_args
 
     ##
     ## Initialize a topic object
@@ -20,10 +20,33 @@ module Howzit
       @content = content
       @parent = nil
       @nest_level = 0
+      @named_args = {}
+      arguments
+
       @tasks = gather_tasks
       @results = { total: 0, success: 0, errors: 0, message: ''.c }
     end
 
+    # Get named arguments from title
+    def arguments
+      return unless @title =~ /\(.*?\) *$/
+
+      a = @title.match(/\((?<args>.*?)\) *$/)
+      args = a['args'].split(/ *, */).each(&:strip)
+
+      args.each_with_index do |arg, idx|
+        arg_name, default = arg.split(/:/).map(&:strip)
+
+        @named_args[arg_name] = if Howzit.arguments.count >= idx + 1
+                                  Howzit.arguments[idx]
+                                else
+                                  default
+                                end
+      end
+
+      @title = @title.sub(/\(.*?\) *$/, '').strip
+    end
+
     ##
     ## Search title and contents for a pattern
     ##
@@ -121,11 +144,19 @@ module Howzit
         case l
         when /@(before|after|prereq|end)/
           next
-        when /@include(?<optional>[!?]{1,2})?\((?<action>.*?)\)/
+        when /@include(?<optional>[!?]{1,2})?\((?<action>[^\)]+)\)/
           m = Regexp.last_match.named_captures.symbolize_keys
-          matches = Howzit.buildnote.find_topic(m[:action])
+
+          if m[:action] =~ / *\[(.*?)\] *$/
+            Howzit.named_arguments = @named_args
+            Howzit.arguments = Regexp.last_match(1).split(/ *, */).map!(&:render_arguments)
+          end
+
+          matches = Howzit.buildnote.find_topic(m[:action].sub(/ *\[.*?\] *$/, ''))
+
           unless matches.empty?
             i_topic = matches[0]
+
             rule = '{kKd}'
             color = '{Kyd}'
             option = if i_topic.tasks.empty?
@@ -149,13 +180,14 @@ module Howzit
               output.push("#{'> ' * @nest_level}#{title} included above".format_header(options))
             elsif opt[:single]
               @nest_level += 1
+
               output.concat(i_topic.print_out({ single: true, header: false }))
               output.push("#{'> ' * @nest_level}...".format_header(options))
               @nest_level -= 1
             end
             Howzit.inclusions.push(i_topic)
           end
-        when /@(?<cmd>run|copy|open|url|include)(?<optional>[?!]{1,2})?\((?<action>.*?)\) *(?<title>.*?)$/
+        when /@(?<cmd>run|copy|open|url)(?<optional>[?!]{1,2})?\((?<action>.*?)\) *(?<title>.*?)$/
           m = Regexp.last_match.named_captures.symbolize_keys
           cmd = m[:cmd]
           obj = m[:action]
@@ -205,7 +237,8 @@ module Howzit
           output.push(l)
         end
       end
-      output.push('')
+      Howzit.named_arguments = @named_args
+      output.push('').map(&:render_arguments)
     end
 
     private
@@ -228,6 +261,7 @@ module Howzit
       @content.scan(rx) { matches << Regexp.last_match }
       matches.each do |m|
         c = m.named_captures.symbolize_keys
+        Howzit.named_arguments = @named_args
 
         if c[:cmd].nil?
           optional = c[:optional2] =~ /[?!]{1,2}/ ? true : false
@@ -237,7 +271,7 @@ module Howzit
           runnable << Howzit::Task.new({ type: :block,
                                          title: title,
                                          action: block,
-                                         parent: nil },
+                                         parent: self },
                                        optional: optional,
                                        default: default)
         else
@@ -258,10 +292,20 @@ module Howzit
             #   end
             #   runnable.concat(tasks)
             # end
+            args = []
+            if title =~ /\[(.*?)\] *$/
+              Howzit.named_arguments = @named_args
+              args = Regexp.last_match(1).split(/ *, */).map(&:render_arguments)
+              Howzit.arguments = args
+              arguments
+              title.sub!(/ *\[.*?\] *$/, '')
+            end
+
             runnable << Howzit::Task.new({ type: :include,
+                                           arguments: Howzit.named_arguments,
                                            title: title,
                                            action: obj,
-                                           parent: nil },
+                                           parent: self },
                                          optional: optional,
                                          default: default)
           when /run/i
@@ -269,7 +313,7 @@ module Howzit
             runnable << Howzit::Task.new({ type: :run,
                                            title: title,
                                            action: obj,
-                                           parent: nil },
+                                           parent: self },
                                          optional: optional,
                                          default: default)
           when /copy/i
@@ -277,14 +321,14 @@ module Howzit
             runnable << Howzit::Task.new({ type: :copy,
                                            title: title,
                                            action: Shellwords.escape(obj),
-                                           parent: nil },
+                                           parent: self },
                                          optional: optional,
                                          default: default)
           when /open|url/i
             runnable << Howzit::Task.new({ type: :open,
                                            title: title,
                                            action: obj,
-                                           parent: nil },
+                                           parent: self },
                                          optional: optional,
                                          default: default)
           end

data/lib/howzit/version.rb

@@ -3,5 +3,5 @@
 # Primary module for this gem.
 module Howzit
   # Current Howzit version.
-  VERSION = '2.0.34'
+  VERSION = '2.1.1'
 end

data/lib/howzit.rb

@@ -45,7 +45,7 @@ HEADER_FORMAT_OPTIONS = %w[border block].freeze
 # Main module for howzit
 module Howzit
   class << self
-    attr_accessor :arguments, :cli_args
+    attr_accessor :arguments, :named_arguments, :cli_args
     ##
     ## Holds a Configuration object with methods and a @settings hash
     ##

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 2.0.34
+  version: 2.1.1
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-15 00:00:00.000000000 Z
+date: 2023-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler