howzit 2.1.13 → 2.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0fc931036b21c7bb13c805751a146432d14c40a9a910fd9999aa42fb34658cb
-  data.tar.gz: 31b927c85e4c7ba6938eff929e7670c1a997d79f21053ce230da3a1a5ca4b246
+  metadata.gz: 801a2edf83210d0abd3cf17ab9c9259469429478c48b8245df7475bde19c6676
+  data.tar.gz: c47dd24e16f255fcbbd0ac5acadb3c57f423bda0237bbbb85b43f8c82e08b0db
 SHA512:
-  metadata.gz: 6382fd78151da4a021d605276121fc48f0b1cb7692ee3a4657fd4dee820577f0f5357aa98be565dd120e440619906b1881da2269fe0e53c2321160a34dee26ac
-  data.tar.gz: d402a1dcf7715f04ed32fc282450c4132bf13cd3a43830eb464c298f79dc86fa4c47f30a6bd8d3698e588468f107b0b4eae6ad90c89195d878ef1f610846ab78
+  metadata.gz: f8ea4385da70cb5cf7e8d66b5352f164d7cee71b050cf47a544539bf61d0ffd95b4c46f77347b8cf016fd50bd9edf6f7fe1b088fb4f8d324af9343c833334204
+  data.tar.gz: 7bc8190df842331c74ab4dc0146262b886c1174d3fcf2faef35dc536d0622fe29c2868c4db6e2067e1198c801116d8b67bb0272214cfe8a75dd210a86ec8db66

data/.gitignore

@@ -42,3 +42,4 @@ Gemfile.lock
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
 results.log
+html

data/.irbrc

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+`gem rdoc binbundle --ri`
+
+# rubocop:disable Style/MixinUsage
+include Howzit # standard:disable all
+# rubocop:enable Style/MixinUsage

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+### 2.1.15
+
+2024-08-07 13:10
+
+#### FIXED
+
+- Prompt for editor when $EDITOR is not defined
+- Use exec for CLI editors provide a separate process
+- Remove tests for editor in main executable
+
+### 2.1.14
+
+2024-08-06 16:36
+
+#### IMPROVED
+
+- Better algorithm for best match when `multiple_matches: best` is set
+
 ### 2.1.13
 
 2024-08-05 12:04

data/README.md

@@ -2,13 +2,13 @@
 # Howzit
 
 [![Gem](https://img.shields.io/gem/v/howzit.svg)](https://rubygems.org/gems/howzit)
-[![Travis](https://api.travis-ci.com/ttscoff/howzit.svg?branch=main)](https://travis-ci.org/makenew/ruby-gem)
 [![GitHub license](https://img.shields.io/github/license/ttscoff/howzit.svg)](./LICENSE.txt)
 
 A command-line reference tool for tracking project build systems
 
 Howzit is a tool that allows you to keep Markdown-formatted notes about a project's tools and procedures. It functions as an easy lookup for notes about a particular task, as well as a task runner to automatically execute appropriate commands.
 
+
 ## Features
 
 - Match topic titles with any portion of title

data/README.rdoc

@@ -0,0 +1,6 @@
+= Howzit
+
+A command-line reference tool for tracking project build systems
+
+
+

data/Rakefile

@@ -6,6 +6,13 @@ require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 require 'yard'
 require 'tty-spinner'
+require 'rdoc/task'
+
+Rake::RDocTask.new do |rd|
+  rd.main = 'README.rdoc'
+  rd.rdoc_files.include('README.rdoc', 'lib/**/*.rb', 'bin/**/*')
+  rd.title = 'Howzit'
+end
 
 task default: %i[test yard]
 
@@ -41,17 +48,20 @@ task :dockertest, :version, :login do |_, args|
   args.with_defaults(version: 'all', login: false)
   case args[:version]
   when /^a/
-    %w[6 7 3].each do |v|
+    %w[2 3 32].each do |v|
       Rake::Task['dockertest'].reenable
       Rake::Task['dockertest'].invoke(v, false)
     end
     Process.exit 0
+  when /^32/
+    img = 'howzittest32'
+    file = 'docker/Dockerfile-3.2'
   when /^3/
     img = 'howzittest3'
     file = 'docker/Dockerfile-3.0'
-  when /6$/
-    img = 'howzittest26'
-    file = 'docker/Dockerfile-2.6'
+  # when /6$/
+  #   img = 'howzittest26'
+  #   file = 'docker/Dockerfile-2.6'
   when /(^2|7$)/
     img = 'howzittest27'
     file = 'docker/Dockerfile-2.7'
@@ -64,7 +74,7 @@ task :dockertest, :version, :login do |_, args|
 
   exec "docker run -v #{File.dirname(__FILE__)}:/howzit -it #{img} /bin/bash -l" if args[:login]
 
-  spinner = TTY::Spinner.new('[:spinner] Running tests ...', hide_cursor: true)
+  spinner = TTY::Spinner.new("[:spinner] Running tests #{img}", hide_cursor: true)
 
   spinner.auto_spin
   res = `docker run --rm -v #{File.dirname(__FILE__)}:/howzit -it #{img}`

data/bin/howzit

@@ -159,15 +159,13 @@ OptionParser.new do |opts|
     Process.exit 0
   end
 
-  editor = File.basename(Howzit.options[:editor])
-  desc = %(Edit buildnotes file in current working directory using editor (#{editor}))
+  desc = %(Edit buildnotes file in current working directory using default editor)
   opts.on('-e', '--edit', desc) do
     Howzit.buildnote.edit
     Process.exit 0
   end
 
-  config_editor = File.basename(Howzit.options[:config_editor])
-  opts.on('--edit-config', "Edit configuration file using editor (#{config_editor})") do
+  opts.on('--edit-config', "Edit configuration file using default editor") do
     Howzit.config.editor
     Process.exit 0
   end

data/docker/Dockerfile-2.6

@@ -3,7 +3,7 @@ FROM ruby:2.6
 RUN mkdir /howzit
 WORKDIR /howzit
 # COPY ./ /howzit/
-RUN gem install bundler:2.2.17
+RUN gem install bundler:2.2.29
 RUN apt-get update -y
 RUN apt-get install -y less vim
 COPY ./docker/inputrc /root/.inputrc

data/docker/Dockerfile-2.7

@@ -3,7 +3,7 @@ FROM ruby:2.7
 RUN mkdir /howzit
 WORKDIR /howzit
 # COPY ./ /howzit/
-RUN gem install bundler:2.2.17
+RUN gem install bundler:2.2.29
 RUN apt-get update -y
 RUN apt-get install -y less vim
 COPY ./docker/inputrc /root/.inputrc

data/docker/Dockerfile-3.0

@@ -3,7 +3,7 @@ FROM ruby:3.0.0
 RUN mkdir /howzit
 WORKDIR /howzit
 # COPY ./ /howzit/
-RUN gem install bundler:2.2.17
+RUN gem install bundler:2.2.29
 RUN apt-get update -y
 RUN apt-get install -y less vim
 COPY ./docker/inputrc /root/.inputrc

data/docker/Dockerfile-3.2

@@ -0,0 +1,11 @@
+FROM ruby:3.2.0
+# RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
+RUN mkdir /howzit
+WORKDIR /howzit
+# COPY ./ /howzit/
+RUN gem install bundler:2.2.29
+RUN apt-get update -y
+RUN apt-get install -y less vim
+COPY ./docker/inputrc /root/.inputrc
+COPY ./docker/bash_profile /root/.bash_profile
+CMD ["scripts/runtests.sh"]

data/docker/bash_profile

@@ -1,6 +1,7 @@
 #!/bin/bash
 export GLI_DEBUG=true
 export EDITOR="/usr/bin/vim"
+export PATH=$PATH:$GEM_HOME/bin
 alias b="bundle exec bin/howzit"
 
 shopt -s nocaseglob

data/lib/howzit/buildnote.rb

@@ -499,7 +499,7 @@ module Howzit
     ## @return     [String] file path
     ##
     def glob_note
-      Dir.glob('*.{txt,md,markdown}').select(&:build_note?)[0]
+      Dir.glob('*.{txt,md,markdown}').select(&:build_note?).sort[0]
     end
 
     ##
@@ -655,12 +655,14 @@ module Howzit
     def edit_note
       editor = Howzit.options.fetch(:editor, ENV['EDITOR'])
 
+      editor = Howzit.config.update_editor if editor.nil?
+
       raise 'No editor defined' if editor.nil?
 
       raise "Invalid editor (#{editor})" unless Util.valid_command?(editor)
 
       create_note(prompt: true) if note_file.nil?
-      `#{editor} "#{note_file}"`
+      exec %(#{editor} "#{note_file}")
     end
 
     ##
@@ -680,6 +682,8 @@ module Howzit
     def edit_template_file(file)
       editor = Howzit.options.fetch(:editor, ENV['EDITOR'])
 
+      editor = Howzit.config.update_editor if editor.nil?
+
       raise 'No editor defined' if editor.nil?
 
       raise "Invalid editor (#{editor})" unless Util.valid_command?(editor)
@@ -780,7 +784,7 @@ module Howzit
             when :first
               topic_matches.push(matches[0])
             when :best
-              topic_matches.push(matches.sort.min_by { |t| t.title.length })
+              topic_matches.push(matches.sort_by { |a| [a.title.comp_distance(s), a.title.length] })
             when :all
               topic_matches.concat(matches)
             else

data/lib/howzit/config.rb

@@ -127,6 +127,31 @@ module Howzit
       edit_config
     end
 
+    ## Update editor config
+    def update_editor
+      puts 'No $EDITOR defined, no value in config'
+      editor = Prompt.read_editor
+      if editor.nil?
+        'Cancelled, no editor stored.'
+        Process.exit 1
+      end
+      update_config_option({ config_editor: editor, editor: editor })
+      puts "Default editor set to #{editor}, modify in config file"
+      editor
+    end
+
+    ##
+    ## Update a config option and resave config file
+    ##
+    ## @param      options    [Hash] key value pairs
+    ##
+    def update_config_option(options)
+      options.each do |key, value|
+        Howzit.options[key] = value
+      end
+      write_config(Howzit.options)
+    end
+
     private
 
     ##
@@ -263,13 +288,15 @@ module Howzit
     def edit_config
       editor = Howzit.options.fetch(:config_editor, ENV['EDITOR'])
 
+      editor = update_editor if editor.nil?
+
       raise 'No config_editor defined' if editor.nil?
 
       # raise "Invalid editor (#{editor})" unless Util.valid_command?(editor)
 
       load_config
       if Util.valid_command?(editor.split(/ /).first)
-        system %(#{editor} "#{config_file}")
+        exec %(#{editor} "#{config_file}")
       else
         `open -a "#{editor}" "#{config_file}"`
       end

data/lib/howzit/prompt.rb

@@ -159,6 +159,22 @@ module Howzit
         system('stty', @stty_save)
       end
 
+      ##
+      ## Request editor
+      ##
+      def read_editor(default = nil)
+        @stty_save = `stty -g`.chomp
+
+        default ||= 'vim'
+        prompt = "Define a default editor command (default #{default}): "
+        res = Readline.readline(prompt, true).squeeze(' ').strip
+        res = default if res.empty?
+
+        Util.valid_command?(res) ? res : default
+      ensure
+        system('stty', @stty_save)
+      end
+
       ##
       ## Convert a response to an Integer
       ##

data/lib/howzit/stringutils.rb

@@ -3,6 +3,86 @@
 module Howzit
   # String Extensions
   module StringUtils
+    ## Compare strings and return a distance
+    ##
+    ## @param      other  [String] The string to compare
+    ## @param      term   [String] The search term
+    ##
+    ## @return [Float] distance
+    def comp_distance(term)
+      chars = term.split(//)
+      contains_count(chars) + distance(chars)
+    end
+
+    ##
+    ## Number of matching characters the string contains
+    ##
+    ## @param      chars [String|Array]  The characters
+    ##
+    def contains_count(chars)
+      chars = chars.split(//) if chars.is_a?(String)
+      count = 0
+      chars.each { |char| count += 1 if self =~ /#{char}/i }
+      count
+    end
+
+    ##
+    ## Determine if characters are in order
+    ##
+    ## @param      chars  [String|Array] The characters
+    ##
+    ## @return [Boolean] characters are in order
+    ##
+    def in_order(chars)
+      chars = chars.split(//) if chars.is_a?(String)
+      position = 0
+      in_order = 0
+      chars.each do |char|
+        new_pos = self[position..] =~ /#{char}/i
+        if new_pos
+          position += new_pos
+          in_order += 1
+        end
+      end
+      in_order
+    end
+
+    ##
+    ## Determine if a series of characters are all within a given distance of
+    ## each other in the String
+    ##
+    ## @param      chars     [String|Array] The characters
+    ## @param      distance  [Number] The distance
+    ##
+    ## @return     [Boolean] true if within distance
+    ##
+    def in_distance?(chars, distance)
+      chars = chars.split(//) if chars.is_a?(String)
+      rx = Regexp.new(chars.join(".{,#{distance}}"), 'i')
+      self =~ rx ? true : false
+    end
+
+    ##
+    ## Determine the minimum distance between characters that they all still
+    ## fall within
+    ##
+    ## @param      chars  [Array] The characters
+    ##
+    ## @return     [Number] distance
+    ##
+    def distance(chars)
+      distance = 0
+      max = self.length - chars.length
+      return max unless in_order(chars) == chars.length
+
+      while distance < max
+        return distance if in_distance?(chars, distance)
+
+        distance += 1
+      end
+      distance
+    end
+
     ##
     ## Test if the filename matches the conditions to be a build note
     ##

data/lib/howzit/version.rb

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

data/lib/howzit.rb

@@ -77,8 +77,8 @@ module Howzit
     ##
     ## Module storage for buildnote
     ##
-    def buildnote
-      @buildnote ||= BuildNote.new
+    def buildnote(file = nil)
+      @buildnote ||= BuildNote.new(file: file)
     end
 
     ##

data/scripts/runtests.sh

@@ -1,4 +1,6 @@
 #!/bin/bash
 
 bundle install
-rake test
+export EDITOR="/usr/bin/vim"
+export PATH=$PATH:$GEM_HOME/bin
+rake spec

data/spec/buildnote_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 describe Howzit::BuildNote do
-  subject(:how) { @hz }
+  subject(:how) { Howzit.buildnote('builda.md') }
 
   describe ".note_file" do
     it "locates a build note file" do
@@ -27,43 +27,55 @@ describe Howzit::BuildNote do
       expect(matches.count).to eq 1
       expect(matches[0].title).to eq 'Topic Tropic'
     end
+
     it "fuzzy matches" do
       Howzit.options[:matching] = 'fuzzy'
       matches = how.find_topic('trpc')
       expect(matches.count).to eq 1
       expect(matches[0].title).to eq 'Topic Tropic'
     end
+
     it "succeeds with partial match" do
       Howzit.options[:matching] = 'partial'
       matches = how.find_topic('trop')
       expect(matches.count).to eq 1
       expect(matches[0].title).to eq 'Topic Tropic'
     end
+
     it "succeeds with beginswith match" do
       Howzit.options[:matching] = 'beginswith'
       matches = how.find_topic('topic')
       expect(matches.count).to eq 3
       expect(matches[0].title).to eq 'Topic Balogna'
     end
+
     it "succeeds with exact match" do
       Howzit.options[:matching] = 'exact'
       matches = how.find_topic('topic tropic')
       expect(matches.count).to eq 1
       expect(matches[0].title).to eq 'Topic Tropic'
     end
+
     it "fails with incomplete exact match" do
       Howzit.options[:matching] = 'exact'
       matches = how.find_topic('topic trop')
       expect(matches.count).to eq 0
     end
+
+    it "Handles multiple matches with best match" do
+      Howzit.options[:matching] = 'fuzzy'
+      Howzit.options[:multiple_matches] = :best
+      matches = how.find_topic('banana')
+      expect(matches.first.title).to match(/banana/i)
+    end
   end
 
   describe ".topics" do
     it "contains 4 topics" do
-      expect(how.list_topics.count).to eq 3
+      expect(how.list_topics.count).to eq 4
     end
     it "outputs a newline-separated string for completion" do
-      expect(how.list_completions.scan(/\n/).count).to eq 2
+      expect(how.list_completions.scan(/\n/).count).to eq 3
     end
   end
 end

data/spec/cli_spec.rb

@@ -15,7 +15,7 @@ describe 'CLI' do
     execute_script('bin/howzit', use_bundler: true, args: %w[-L])
     expect(last_execution).to be_successful
     expect(last_execution.stdout).to match(/Topic Balogna/)
-    expect(last_execution.stdout.split(/\n/).count).to eq 3
+    expect(last_execution.stdout.split(/\n/).count).to eq 4
   end
 
   it 'lists available tasks' do

data/spec/spec_helper.rb

@@ -63,8 +63,13 @@ def save_buildnote
 
     Bermuda, Bahama, something something wanna.
     @copy(Balogna) Just some balogna
+
+    ## Happy Bgagngagnga
+
+    This one is just to throw things off
   EONOTE
   File.open('builda.md', 'w') { |f| f.puts note }
+  # puts "Saved to builda.md: #{File.exist?('builda.md')}"
 end
 
 def delete_buildnote

data/spec/topic_spec.rb

@@ -21,7 +21,10 @@ describe Howzit::Topic do
 end
 
 describe Howzit::Topic do
-  subject(:topic) { @hz.find_topic('Topic Balogna')[0] }
+  subject(:topic) {
+    bn = Howzit.buildnote
+    bn.find_topic('Topic Balogna')[0]
+  }
 
   describe '.title' do
     it 'has the correct title' do

data/src/_README.md

@@ -2,12 +2,12 @@
 # Howzit
 
 [![Gem](https://img.shields.io/gem/v/howzit.svg)](https://rubygems.org/gems/howzit)
-[![Travis](https://api.travis-ci.com/ttscoff/howzit.svg?branch=main)](https://travis-ci.org/makenew/ruby-gem)
 [![GitHub license](https://img.shields.io/github/license/ttscoff/howzit.svg)](./LICENSE.txt)
-<!--END GITHUB-->
+
 A command-line reference tool for tracking project build systems
 
 Howzit is a tool that allows you to keep Markdown-formatted notes about a project's tools and procedures. It functions as an easy lookup for notes about a particular task, as well as a task runner to automatically execute appropriate commands.
+<!--END GITHUB-->
 
 ## Features
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 2.1.13
+  version: 2.1.15
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-05 00:00:00.000000000 Z
+date: 2024-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -294,6 +294,7 @@ files:
 - ".github/FUNDING.yml"
 - ".gitignore"
 - ".howzit.taskpaper.bak"
+- ".irbrc"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -303,12 +304,14 @@ files:
 - Guardfile
 - LICENSE.txt
 - README.md
+- README.rdoc
 - Rakefile
 - bin/howzit
 - docker/Dockerfile
 - docker/Dockerfile-2.6
 - docker/Dockerfile-2.7
 - docker/Dockerfile-3.0
+- docker/Dockerfile-3.2
 - docker/bash_profile
 - docker/inputrc
 - fish/completions/bld.fish