howzit 2.1.15 → 2.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 801a2edf83210d0abd3cf17ab9c9259469429478c48b8245df7475bde19c6676
-  data.tar.gz: c47dd24e16f255fcbbd0ac5acadb3c57f423bda0237bbbb85b43f8c82e08b0db
+  metadata.gz: 3bf24c1aae4ef114065b9138801a83f07777932a38a5894b4ae63be3c02960f4
+  data.tar.gz: 18a7bf1b8eb988b204479531618219fba11d49a70248cde01a1857b6bd9205ae
 SHA512:
-  metadata.gz: f8ea4385da70cb5cf7e8d66b5352f164d7cee71b050cf47a544539bf61d0ffd95b4c46f77347b8cf016fd50bd9edf6f7fe1b088fb4f8d324af9343c833334204
-  data.tar.gz: 7bc8190df842331c74ab4dc0146262b886c1174d3fcf2faef35dc536d0622fe29c2868c4db6e2067e1198c801116d8b67bb0272214cfe8a75dd210a86ec8db66
+  metadata.gz: 5b43837936520805796c48529de8a88af3ceeaa455259e0ffbba351f4d2bc98706c1381974c072953438db8a38a215d9b817907783f62fd0ac24301e9d05fe94
+  data.tar.gz: 9c2afbc1c49a902e65e9818ad6f8ce9df1b724c149307fe2d718abd1b9ef61405f1340403fde901c3cb8b67d877db793cedaaac752b2b974ba1881bde0efb21c

data/.rubocop.yml

@@ -22,10 +22,10 @@ Layout/LineLength:
   Max: 120
 
 Metrics/MethodLength:
-  Max: 40
+  Max: 45
 
 Metrics/BlockLength:
-  Max: 40
+  Max: 45
   Exclude:
     - Rakefile
     - bin/howzit
@@ -34,9 +34,6 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Max: 300
 
-Metrics/CyclomaticComplexity:
-  Max: 10
-
 Metrics/PerceivedComplexity:
   Max: 30
 
@@ -44,7 +41,7 @@ Metrics/AbcSize:
   Max: 45
 
 Metrics/CyclomaticComplexity:
-  Max: 15
+  Max: 20
 
 Style/RegexpLiteral:
   Exclude:

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 2.1.16
+
+2024-08-13 10:59
+
+#### IMPROVED
+
+- Add extra linebreak before @include headers
+
 ### 2.1.15
 
 2024-08-07 13:10

data/Rakefile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'bump/tasks'
+# require 'bump/tasks'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
@@ -8,6 +8,13 @@ require 'yard'
 require 'tty-spinner'
 require 'rdoc/task'
 
+module TempFixForRakeLastComment
+  def last_comment
+    last_description
+  end
+end
+Rake::Application.send :include, TempFixForRakeLastComment
+
 Rake::RDocTask.new do |rd|
   rd.main = 'README.rdoc'
   rd.rdoc_files.include('README.rdoc', 'lib/**/*.rb', 'bin/**/*')
@@ -70,20 +77,28 @@ task :dockertest, :version, :login do |_, args|
     file = 'docker/Dockerfile'
   end
 
-  puts `docker build . --file #{file} -t #{img}`
+  d_spinner = TTY::Spinner.new("[:spinner] Setting up Docker", hide_cursor: true, format: :dots)
+  d_spinner.auto_spin
+  `docker build . --file #{file} -t #{img} &> /dev/null`
+  d_spinner.success
+  d_spinner.stop
 
   exec "docker run -v #{File.dirname(__FILE__)}:/howzit -it #{img} /bin/bash -l" if args[:login]
 
-  spinner = TTY::Spinner.new("[:spinner] Running tests #{img}", hide_cursor: true)
+  spinner = TTY::Spinner.new("[:spinner] Running tests #{img}", hide_cursor: true, format: :dots)
 
   spinner.auto_spin
   res = `docker run --rm -v #{File.dirname(__FILE__)}:/howzit -it #{img}`
-  # commit = puts `bash -c "docker commit $(docker ps -a|grep #{img}|awk '{print $1}'|head -n 1) #{img}"`.strip
-  spinner.success
+  commit = `bash -c "docker commit $(docker ps -a|grep #{img}|awk '{print $1}'|head -n 1) #{img}"`.strip
+  if $?.exitstatus == 0
+    spinner.success
+  else
+    spinner.error
+    puts res
+  end
   spinner.stop
 
-  puts res
-  # puts commit&.empty? ? "Error commiting Docker tag #{img}" : "Committed Docker tag #{img}"
+  puts commit&.empty? ? "Error commiting Docker tag #{img}" : "Committed Docker tag #{img}"
 end
 
 desc 'Alias for build'

data/howzit.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path(File.join('..', 'lib'), __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'howzit/version'
@@ -8,7 +10,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Brett Terpstra']
   spec.email         = ['me@brettterpstra.com']
   spec.description   = 'Command line project documentation and task runner'
-  spec.summary       = 'Provides a way to access Markdown project notes by topic with query capabilities and the ability to execute the tasks it describes.'
+  spec.summary       = ['Provides a way to access Markdown project notes by topic',
+                        'with query capabilities and the ability to execute the',
+                        'tasks it describes.'].join(' ')
   spec.homepage      = 'https://github.com/ttscoff/howzit'
   spec.license       = 'MIT'
 
@@ -20,28 +24,27 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.6.0'
 
   spec.add_development_dependency 'bundler', '~> 2.2'
-  spec.add_development_dependency 'rake', '~> 11.2'
-  spec.add_development_dependency 'bump', '~> 0.5'
+  spec.add_development_dependency 'rake', '~> 13.0'
 
   spec.add_development_dependency 'guard', '~> 2.11'
-  spec.add_development_dependency 'guard-yard', '~> 2.1'
-  spec.add_development_dependency 'guard-rubocop', '~> 1.2'
   spec.add_development_dependency 'guard-rspec', '~> 4.5'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.2'
+  spec.add_development_dependency 'guard-yard', '~> 2.1'
 
-  spec.add_development_dependency 'rubocop', '~> 0.28'
-  spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'cli-test', '~> 1.0'
+  spec.add_development_dependency 'rspec', '~> 3.13'
+  spec.add_development_dependency 'rubocop', '~> 0.28'
   spec.add_development_dependency 'simplecov', '~> 0.9'
   # spec.add_development_dependency 'codecov', '~> 0.1'
   spec.add_development_dependency 'fuubar', '~> 2.0'
 
-  spec.add_development_dependency 'yard', '~> 0.9.5'
-  spec.add_development_dependency 'redcarpet', '~> 3.2'
   spec.add_development_dependency 'github-markup', '~> 1.3'
+  spec.add_development_dependency 'redcarpet', '~> 3.2'
   spec.add_development_dependency 'tty-spinner', '~> 0.9'
+  spec.add_development_dependency 'yard', '~> 0.9.5'
 
   spec.add_runtime_dependency 'mdless', '~> 1.0', '>= 1.0.28'
-  spec.add_runtime_dependency 'tty-screen', '~> 0.8'
   spec.add_runtime_dependency 'tty-box', '~> 0.7'
+  spec.add_runtime_dependency 'tty-screen', '~> 0.8'
   # spec.add_runtime_dependency 'tty-prompt', '~> 0.23'
 end

data/lib/howzit/buildnote.rb

@@ -21,7 +21,7 @@ module Howzit
       content = Util.read_file(file)
       raise "{br}No content found in build note (#{file}){x}".c if content.nil? || content.empty?
 
-      this_meta = content.split(/^#/)[0].strip.get_metadata
+      this_meta = content.split(/^#/)[0].strip.metadata
 
       @metadata = meta.nil? ? this_meta : meta.merge(this_meta)
 
@@ -363,7 +363,7 @@ module Howzit
       t_leader = Util.read_file(template).split(/^#/)[0].strip
       return unless t_leader.length.positive?
 
-      t_meta = t_leader.get_metadata
+      t_meta = t_leader.metadata
 
       return unless t_meta.key?('required')
 
@@ -556,7 +556,7 @@ module Howzit
 
       return template_topics if leader.empty?
 
-      data = leader.get_metadata
+      data = leader.metadata
 
       if data.key?('template')
         templates = data['template'].strip.split(/\s*,\s*/)

data/lib/howzit/colors.rb

@@ -5,7 +5,7 @@ module Howzit
   # Terminal output color functions.
   module Color
     # Regexp to match excape sequences
-    ESCAPE_REGEX = /(?<=\[)(?:(?:(?:[349]|10)[0-9]|[0-9])?;?)+(?=m)/
+    ESCAPE_REGEX = /(?<=\[)(?:(?:(?:[349]|10)[0-9]|[0-9])?;?)+(?=m)/.freeze
 
     # All available color names. Available as methods and string extensions.
     #
@@ -361,7 +361,7 @@ module Howzit
 
     # Regular expression that is used to scan for ANSI-sequences while
     # uncoloring strings.
-    COLORED_REGEXP = /\e\[(?:(?:[349]|10)[0-7]|[0-9])?m/
+    COLORED_REGEXP = /\e\[(?:(?:[349]|10)[0-7]|[0-9])?m/.freeze
 
     # Returns an uncolored version of the string, that is all
     # ANSI-sequences are stripped from the string.

data/lib/howzit/config.rb

@@ -132,7 +132,7 @@ module Howzit
       puts 'No $EDITOR defined, no value in config'
       editor = Prompt.read_editor
       if editor.nil?
-        'Cancelled, no editor stored.'
+        puts 'Cancelled, no editor stored.'
         Process.exit 1
       end
       update_config_option({ config_editor: editor, editor: editor })

data/lib/howzit/stringutils.rb

@@ -38,7 +38,7 @@ module Howzit
       position = 0
       in_order = 0
       chars.each do |char|
-        new_pos = self[position..] =~ /#{char}/i
+        new_pos = self[position..-1] =~ /#{char}/i
         if new_pos
           position += new_pos
           in_order += 1
@@ -350,14 +350,14 @@ module Howzit
     ##
     ## Split the content at the first top-level header and
     ## assume everything before it is metadata. Passes to
-    ## #get_metadata for processing
+    ## #metadata for processing
     ##
     ## @return     [Hash] key/value pairs
     ##
     def extract_metadata
       if File.exist?(self)
         leader = Util.read_file(self).split(/^#/)[0].strip
-        leader.length.positive? ? leader.get_metadata : {}
+        leader.length.positive? ? leader.metadata : {}
       else
         {}
       end
@@ -368,7 +368,7 @@ module Howzit
     ##
     ## @return     [Hash] The metadata as key/value pairs
     ##
-    def get_metadata
+    def metadata
       data = {}
       scan(/(?mi)^(\S[\s\S]+?): ([\s\S]*?)(?=\n\S[\s\S]*?:|\Z)/).each do |m|
         data[m[0].strip.downcase] = m[1]
@@ -453,7 +453,7 @@ module Howzit
                else
                  options[:hr] * (cols - title.uncolor.length)
                end
-        Color.template("\n\n#{title}#{tail}{x}")
+        Color.template("\n\n#{title}#{tail}{x}\n\n")
       end
     end
   end

data/lib/howzit/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 2.1.15
+  version: 2.1.16
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-07 00:00:00.000000000 Z
+date: 2024-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,28 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
-- !ruby/object:Gem::Dependency
-  name: bump
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -67,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.11'
 - !ruby/object:Gem::Dependency
-  name: guard-yard
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '4.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '4.5'
 - !ruby/object:Gem::Dependency
   name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -95,61 +81,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: guard-yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: cli-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.28'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.28'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
-  name: cli-test
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.28'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.28'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -179,19 +165,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: github-markup
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -207,33 +193,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: github-markup
+  name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: tty-spinner
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.5
 - !ruby/object:Gem::Dependency
   name: mdless
   requirement: !ruby/object:Gem::Requirement
@@ -255,33 +241,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.28
 - !ruby/object:Gem::Dependency
-  name: tty-screen
+  name: tty-box
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: tty-box
+  name: tty-screen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
 description: Command line project documentation and task runner
 email:
 - me@brettterpstra.com