howzit 2.0.21 → 2.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7fce97cf829010799ce06890d925d1f7eaff647299398650baf9eb898eb56eb
-  data.tar.gz: 2fb9d03d33bd616c005b164fd4420d837fcb688882f7fe98d9779bfdf3abcb4c
+  metadata.gz: 4d5ddc7a4ec5cda133517d27dfef17d80299c17a68de2469e9dab66e81dffa33
+  data.tar.gz: 78fed9d51d054f4c39d3bb6b9daed3709e6a7f7644e5a6368bb924bb0b042665
 SHA512:
-  metadata.gz: 3af874f2a2d88af1235d803cdf547e5820f32c817f8dbdc566db7a372ae732593cfeab069ccc759a071e5216e3e62a0a9c63a3c4097255f598efeafcecb70123
-  data.tar.gz: 60a1fdf546e005d8b274269c3a7946017fecdc7adea5d028581bac6e044a03b0e0e8df313e82252c1c56b016984c803320e59bf873602aa1a4e3eabf278976f1
+  metadata.gz: 5427a3f6754462ae1311194407a3c6dfc71b084bb639afa29d961fad758ed554ce40ccdb21ec7b9175289343866da6d1ddb0f9db5fccb12f8224d206f9d53b98
+  data.tar.gz: 6222c4a34783c842fc342a27b2167588578afefa3f45a2fc16637b5d3f266d99d11bbefada5dd4a586902f914566a86efcef4262396133e573cf520923cd468a

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+### 2.0.24
+
+2022-08-09 09:04
+
+#### FIXED
+
+- Avoid reading upstream files multiple times
+
+### 2.0.23
+
+2022-08-09 05:51
+
+#### FIXED
+
+- --grep function regression
+
+### 2.0.22
+
+2022-08-08 13:49
+
+#### IMPROVED
+
+- Paginate output of --templates
+
+#### FIXED
+
+- --templates attempting to create new build note
+- Fix handling of paths when the same as note_file
+
 ### 2.0.21
 
 2022-08-08 13:16

data/bin/howzit

@@ -64,25 +64,27 @@ OptionParser.new do |opts|
   end
 
   opts.on('--templates', 'List available templates') do
+    out = []
     Dir.chdir(Howzit.config.template_folder)
     Dir.glob('*.md').each do |file|
       template = File.basename(file, '.md')
-      puts Howzit::Color.template("{Mk}template:{Yk}#{template}{x}")
-      puts Howzit::Color.template('{bk}[{bl}tasks{bk}]──────────────────────────────────────┐{x}')
+      out.push(Howzit::Color.template("{Mk}template:{Yk}#{template}{x}"))
+      out.push(Howzit::Color.template('{bk}[{bl}tasks{bk}]──────────────────────────────────────┐{x}'))
       metadata = file.extract_metadata
-      topics = Howzit.buildnote.read_file(file)
+      topics = Howzit::BuildNote.new(file: file).topics
       topics.each do |topic|
-        puts Howzit::Color.template(" {bk}│{bw}-{x} {bcK}#{template}:#{topic.title.sub(/^.*?:/, '')}{x}")
+        out.push(Howzit::Color.template(" {bk}│{bw}-{x} {bcK}#{template}:#{topic.title.sub(/^.*?:/, '')}{x}"))
       end
       unless metadata.empty?
         meta = []
         meta << metadata['required'].split(/\s*,\s*/).map { |m| "*{bw}#{m}{xw}" } if metadata.key?('required')
         meta << metadata['optional'].split(/\s*,\s*/).map(&:to_s) if metadata.key?('optional')
-        puts Howzit::Color.template('{bk}[{bl}meta{bk}]───────────────────────────────────────┤{x}')
-        puts Howzit::Color.template(" {bk}│ {xw}#{meta.join(', ')}{x}")
+        out.push(Howzit::Color.template('{bk}[{bl}meta{bk}]───────────────────────────────────────┤{x}'))
+        out.push(Howzit::Color.template(" {bk}│ {xw}#{meta.join(', ')}{x}"))
       end
-      puts Howzit::Color.template(' {bk}└───────────────────────────────────────────┘{x}')
+      out.push(Howzit::Color.template(' {bk}└───────────────────────────────────────────┘{x}'))
     end
+    Howzit::Util.page out.join("\n")
     Process.exit 0
   end
 

data/lib/howzit/buildnote.rb

@@ -13,11 +13,13 @@ module Howzit
     ## @param      file  [String] The path to the build note file
     ##
     def initialize(file: nil)
+      file ||= note_file
+
       @topics = []
-      create_note(prompt: true) if note_file.nil?
+      create_note(prompt: true) if file.nil?
 
-      content = Util.read_file(note_file)
-      raise "{br}No content found in build note (#{note_file}){x}".c if content.nil? || content.empty?
+      content = Util.read_file(file)
+      raise "{br}No content found in build note (#{file}){x}".c if content.nil? || content.empty?
 
       @metadata = content.split(/^#/)[0].strip.get_metadata
 
@@ -30,7 +32,7 @@ module Howzit
     ## @return     description
     ##
     def inspect
-      puts "#<Howzit::BuildNote @topics=[#{@topics.count}]>"
+      "#<Howzit::BuildNote @topics=[#{@topics.count}]>"
     end
 
     ##
@@ -203,14 +205,14 @@ module Howzit
       if File.exist?(file) && !default
         file = "{by}#{file}".c
         unless Prompt.yn("Are you sure you want to overwrite #{file}", default: false)
-          puts 'Cancelled'
+          Howzit.console.info('Cancelled')
           Process.exit 0
         end
       end
 
       File.open(file, 'w') do |f|
         f.puts note
-        puts "{by}Template {bw}#{title}{by} written to {bw}#{file}{x}".c
+        Howzit.console.info("{by}Template {bw}#{title}{by} written to {bw}#{file}{x}".c)
       end
 
       if File.exist?(file) && !default && Prompt.yn("{bg}Do you want to open {bw}#{file} {bg}for editing?{x}".c,
@@ -296,14 +298,14 @@ module Howzit
       if File.exist?(fname) && !default
         file = "{by}#{fname}".c
         unless Prompt.yn("Are you absolutely sure you want to overwrite #{file}", default: false)
-          puts 'Canceled'
+          Howzit.console.info('Canceled')
           Process.exit 0
         end
       end
 
       File.open(fname, 'w') do |f|
         f.puts note
-        puts "{by}Build notes for {bw}#{title}{by} written to {bw}#{fname}{x}".c
+        Howzit.console.info("{by}Build notes for {bw}#{title}{by} written to {bw}#{fname}{x}".c)
       end
 
       if File.exist?(fname) && !default && Prompt.yn("{bg}Do you want to open {bw}#{fname} {bg}for editing?{x}".c,
@@ -530,7 +532,6 @@ module Howzit
     ##
     def read_upstream
       buildnotes = glob_upstream
-
       topics_dict = []
       buildnotes.each do |path|
         topics_dict.concat(read_help_file(path))
@@ -596,7 +597,7 @@ module Howzit
         lines = sect.split(/\n/)
         title = lines.slice!(0).strip
         prefix = ''
-        if path
+        if path && path != note_file
           if path =~ /#{Howzit.config.template_folder}/
             short_path = File.basename(path, '.md')
           else
@@ -625,12 +626,15 @@ module Howzit
     ##
     def read_help(path = nil)
       @topics = read_help_file(path)
-      return unless path.nil? && Howzit.options[:include_upstream]
+      return unless Howzit.options[:include_upstream]
 
-      upstream_topics = read_upstream
+      unless Howzit.has_read_upstream
+        upstream_topics = read_upstream
 
-      upstream_topics.each do |topic|
-        @topics.push(topic) unless find_topic(title.sub(/^.+:/, '')).count.positive?
+        upstream_topics.each do |topic|
+          @topics.push(topic) unless find_topic(topic.title.sub(/^.+:/, '')).count.positive?
+        end
+        Howzit.has_read_upstream = true
       end
 
       if note_file && @topics.empty?
@@ -689,7 +693,7 @@ module Howzit
     ##                     single topic
     ##
     def process_topic(topic, run, single: false)
-      new_topic = topic.dup
+      new_topic = topic.is_a?(String) ? find_topic(topic)[0] : topic.dup
 
       # Handle variable replacement
       new_topic.content = new_topic.content.render_arguments
@@ -791,6 +795,7 @@ module Howzit
 
       if !topic_matches.empty?
         # If we found a match
+        topic_matches.map! { |topic| topic.is_a?(String) ? find_topic(topic)[0] : topic }
         topic_matches.each { |topic_match| output.push(process_topic(topic_match, Howzit.options[:run], single: true)) }
       else
         # If there's no argument or no match found, output all

data/lib/howzit/version.rb

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

data/lib/howzit.rb

@@ -82,5 +82,13 @@ module Howzit
     def console
       @console ||= Howzit::ConsoleLogger.new(options[:log_level])
     end
+
+    def has_read_upstream
+      @has_read_upstream ||= false
+    end
+
+    def has_read_upstream=(has_read)
+      @has_read_upstream = has_read
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 2.0.21
+  version: 2.0.24
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-08 00:00:00.000000000 Z
+date: 2022-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler