howzit 2.1.13 → 2.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0fc931036b21c7bb13c805751a146432d14c40a9a910fd9999aa42fb34658cb
-  data.tar.gz: 31b927c85e4c7ba6938eff929e7670c1a997d79f21053ce230da3a1a5ca4b246
+  metadata.gz: 1fa016c0fa681b1f07238f643dcdffd1fe9679a0362dd18a99ad5c9280282a66
+  data.tar.gz: 2e171f199e644a56046121b4a2b7bc803196bee9b026f619939c51f70828ec13
 SHA512:
-  metadata.gz: 6382fd78151da4a021d605276121fc48f0b1cb7692ee3a4657fd4dee820577f0f5357aa98be565dd120e440619906b1881da2269fe0e53c2321160a34dee26ac
-  data.tar.gz: d402a1dcf7715f04ed32fc282450c4132bf13cd3a43830eb464c298f79dc86fa4c47f30a6bd8d3698e588468f107b0b4eae6ad90c89195d878ef1f610846ab78
+  metadata.gz: 5178be93f700a6d51ddee37f1ea239d65eab8c79f60773d4a8faa9f6dc191a195d43e725cb9980532b2ab177a332c86fe0b914d64051c1eb67c80df0f1c61104
+  data.tar.gz: 58490e3f05c46aba51248dc857f1835b8146f9bfcd7b76fa0640175140046676825a4d1e25f1824bac5415875857da0078a95d2f4dbc783e0bf69d90e42c3c05

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,11 @@
+### 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/lib/howzit/buildnote.rb

@@ -780,7 +780,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/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.14'
 end

data/spec/buildnote_spec.rb

@@ -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,6 +63,10 @@ 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 }
 end

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.14
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-05 00:00:00.000000000 Z
+date: 2024-08-06 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"