spellr 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb3c19ba481190944dadf76bbc0d4953e4488aefedb8debfa6f153e752577831
-  data.tar.gz: acddcaf1433e9190ad4fdd61e1714fad9623acbd98f951c413ac7bab4ce484b3
+  metadata.gz: 80c20f8d5d6ff7fcbd959c8e416205a1501edf3f409ccc85ac99a4f559e66ef2
+  data.tar.gz: c2cf7e43338df821bb39f65a89f989ee68fc53468dfe97cbb40d56ea9ceb0a05
 SHA512:
-  metadata.gz: cbb4ef118126f6f04ffbf6316490bb8c6b382339fb34b948b11400ecc1edcf61ff7442e2b59711babcec67b69e56ffe826f64d0f91385ca720fe1139c30463e0
-  data.tar.gz: a47bf93a6e524282bd03b282e25cba90279066e045ec5b8a1ee269dc332722d70743b2cc0b95fafd38c4b16fff26ec46c74ea3c2c7a42b7c1e5dfd6e3b55e945
+  metadata.gz: 9c51d832b489465d99ebdd2990ff540c91bca34bf7c1e0d7912a9bb9037d5ffa6427c480441ad7394ed918db29e4577df489e7036eee61ec6f68f06f45fdb405
+  data.tar.gz: cc7bdff3f7741f3e9adf422a47181d9f376b85aa3a37a369c38478366c699170f48a191853b5fd1596b4f439566a509fd88f39ddeeab19e753e0d0f5dd515319

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# v0.12.0
+
+- Require stringio in the tokenizer (thanks @alexdeng-mp)
+- Remove implicit did_you_mean dependency, inline and tweak what of did_you_mean we were using
+- Test with recent rubies
+- Replace readline dependency with reline
+  - Drop support for ruby 2.5 because the reline that works supports 2.6 and up
+- Hints and run statistics are printed to stderr rather than stdout
+
 # v0.11.0
 - Remove explicit did_you_mean dependency
   (if you want the suggestions in ruby 2.5 & 2.6, you'll need to add did_you_mean to your Gemfile directly).

data/README.md

@@ -27,7 +27,7 @@ However, in a programming context spelling things _consistently_ is useful, wher
 
 ## Installation
 
-This is tested against ruby 2.5-3.0.
+This is tested against ruby 2.6-3.4.
 
 ### With Bundler
 

data/lib/spellr/autocorrect_reporter.rb

@@ -7,7 +7,7 @@ require_relative 'maybe_suggester'
 module Spellr
   class AutocorrectReporter < BaseReporter
     def finish
-      puts "\n"
+      warn "\n"
       print_count(:checked, 'file')
       print_value(total, 'error', 'found')
       print_count(:total_fixed, 'error', 'fixed', hide_zero: true)
@@ -27,7 +27,7 @@ module Spellr
     end
 
     def handle_replace(token)
-      replacement = ::Spellr::Suggester.suggestions(token).first
+      replacement = ::Spellr::Suggester.suggestions(token, 1).first
       return increment(:total_unfixed) unless replacement
 
       token.replace(replacement)

data/lib/spellr/base_reporter.rb

@@ -52,7 +52,7 @@ module Spellr
     end
 
     def print_value(value, noun, verb, hide_zero: false)
-      puts "#{pluralize noun, value} #{verb}" if !hide_zero || value.positive?
+      warn "#{pluralize noun, value} #{verb}" if !hide_zero || value.positive?
     end
   end
 end

data/lib/spellr/interactive.rb

@@ -10,7 +10,7 @@ require_relative 'maybe_suggester'
 module Spellr
   class Interactive < BaseReporter # rubocop:disable Metrics/ClassLength
     def finish
-      puts "\n"
+      warn "\n"
       print_count(:checked, 'file')
       print_value(total, 'error', 'found')
       print_count(:total_skipped, 'error', 'skipped', hide_zero: true)
@@ -34,7 +34,7 @@ module Spellr
 
       super(token) unless only_prompt
 
-      suggestions = ::Spellr::Suggester.fast_suggestions(token)
+      suggestions = ::Spellr::Suggester.fast_suggestions(token, 5)
       print_suggestions(suggestions) unless only_prompt
 
       prompt(token, suggestions)
@@ -107,7 +107,7 @@ module Spellr
       print "\r\e[K"
       (lines - 1).times do
         sleep 0.01
-        print "\r\e[1T\e[2K"
+        print "\r\e[0m\e[1T\e[2K"
       end
     end
 
@@ -165,7 +165,7 @@ module Spellr
     end
 
     def handle_replace_with_suggestion(token, suggestions, letter)
-      replacement = suggestions[letter.to_i - 1].chomp
+      replacement = suggestions[letter.to_i - 1]
 
       token.replace(replacement)
       increment(:total_fixed)

data/lib/spellr/interactive_replacement.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'readline'
+require 'reline'
 require_relative 'string_format'
 
 module Spellr
@@ -15,8 +15,8 @@ module Spellr
       @token = token
       @token_highlight = red(token)
       @reporter = reporter
-      Readline.input = reporter.output.stdin
-      Readline.output = reporter.output.stdout
+      Reline.input = reporter.output.stdin
+      Reline.output = reporter.output.stdout
     end
 
     def global_replace
@@ -44,9 +44,9 @@ module Spellr
     end
 
     def prompt_replacement
-      Readline.pre_input_hook = -> { pre_input_hook(token) }
-      prompt = "  Replace #{'all ' if global?}#{token_highlight} with: \e[32m"
-      Readline.readline(prompt)
+      Reline.pre_input_hook = -> { pre_input_hook(token) }
+      prompt = "  Replace #{'all ' if global?}#{token_highlight} with: "
+      Reline.readline(prompt)
     rescue Interrupt
       handle_ctrl_c
     end
@@ -70,19 +70,15 @@ module Spellr
 
     def handle_ctrl_c
       print "\e[0m"
-      reporter.clear_line(4)
+      reporter.clear_line(5)
       reporter.call(token, only_prompt: true)
     end
 
     private
 
     def pre_input_hook(value)
-      Readline.refresh_line
-      Readline.insert_text value.to_s
-      Readline.redisplay
-
-      # Remove the hook right away.
-      Readline.pre_input_hook = nil
+      Reline.insert_text value.to_s
+      Reline.pre_input_hook = nil
     end
 
     def puts(str)

data/lib/spellr/null_suggester.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 module Spellr
-  class NullSuggester
+  module NullSuggester
     class << self
-      def suggestions(_token)
+      def suggestions(_token, _limit = 0)
         []
       end
 
-      def fast_suggestions(_token)
+      def fast_suggestions(_token, _limit = 0)
         []
       end
 
@@ -15,11 +15,5 @@ module Spellr
         true
       end
     end
-
-    def initialize(_wordlist); end
-
-    def suggestions(_term)
-      []
-    end
   end
 end

data/lib/spellr/output_stubbed.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'stringio'
 require_relative 'output'
 
 module Spellr

data/lib/spellr/rake_task.rb

@@ -46,7 +46,7 @@ module Spellr
     end
 
     def write_cli_cmd(argv)
-      $stdout.puts("\e[2mspellr #{escaped_argv(argv)}\e[0m")
+      warn("\e[2mspellr #{escaped_argv(argv)}\e[0m")
     end
 
     def run(argv)

data/lib/spellr/reporter.rb

@@ -7,7 +7,7 @@ require 'set'
 module Spellr
   class Reporter < Spellr::BaseReporter
     def finish
-      puts "\n"
+      warn "\n"
       print_count(:checked, 'file')
       print_count(:total, 'error', 'found')
 
@@ -24,12 +24,12 @@ module Spellr
     private
 
     def interactive_command
-      puts "\nto add or replace words interactively, run:"
+      warn "\nto add or replace words interactively, run:"
       command = ['spellr', '--interactive']
       # sort is purely for repeatability for tests. so
       command.concat(counts[:filenames].to_a.sort) unless counts[:filenames].length > 20
 
-      puts "  #{Shellwords.join(command)}"
+      warn "  #{Shellwords.join(command)}"
     end
 
     def filenames

data/lib/spellr/suggester.rb

@@ -1,59 +1,88 @@
 # frozen_string_literal: true
 
-require 'did_you_mean'
 require 'jaro_winkler'
+require 'damerau-levenshtein'
+require_relative 'suggestion'
 
-::DidYouMean.send(:remove_const, :JaroWinkler)
-::DidYouMean::JaroWinkler = ::JaroWinkler
+# This is inspired by and uses parts of ruby's DidYouMean
 
 module Spellr
-  class Suggester
+  module Suggester
     class << self
-      def suggestions(token)
+      def suggestions(token, limit = 5) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         wordlists = token.location.file.wordlists
-        term = token.spellr_normalize.chomp
-        words = wordlists.flat_map { |wordlist| wordlist.suggestions(token) }.uniq
-        words = ::DidYouMean::SpellChecker.new(dictionary: words).correct(term)
-        words = reduce_suggestions(words, term)
+        term = token.spellr_normalize
+        jaro_winkler_similarity_threshold = term.length > 4 ? 0.834 : 0.77
+        suggestions = wordlists.flat_map do |wordlist|
+          all_suggestions(term, jaro_winkler_similarity_threshold, wordlist)
+        end
+        suggestions.uniq!(&:word)
+        suggestions.sort_by! { |suggestion| [-suggestion.jaro_winkler_similarity, suggestion.word] }
+
+        suggestions = reduce_suggestions(suggestions, term, limit)
 
-        words.map { |word| word.send(token.case_method) }
+        suggestions.map { |suggestion| suggestion.word.send(token.case_method) }
       end
 
       def slow?
         return @slow if defined?(@slow)
 
-        @slow = ::JaroWinkler.method(:distance).source_location
+        @slow = ::JaroWinkler.method(:similarity).source_location
       end
 
-      def fast_suggestions(token)
+      def fast_suggestions(token, limit = 5)
         if slow?
           []
         else
-          suggestions(token)
+          suggestions(token, limit)
         end
       end
 
       private
 
-      def reduce_suggestions(words, term)
-        return words unless words.length > 1
+      def all_suggestions(term, jaro_winkler_similarity_threshold, wordlist)
+        wordlist.reduce([]) do |acc, word|
+          similarity = ::JaroWinkler.similarity(word, term)
+          next acc unless similarity >= jaro_winkler_similarity_threshold
 
-        threshold = ::JaroWinkler.distance(term, words.first) * 0.98
-        words.select! { |word| ::JaroWinkler.distance(term, word) > threshold }
-        words.sort_by! { |word| [-::JaroWinkler.distance(term, word), word] }
-        words.take(5)
+          acc << Suggestion.new(word, similarity)
+        end
       end
-    end
 
-    def initialize(wordlist)
-      @did_you_mean = ::DidYouMean::SpellChecker.new(dictionary: wordlist.to_a)
-      @suggestions = {}
-    end
+      def reduce_suggestions(suggestions, term, limit = 5)
+        candidate_suggestions = reduce_to_mistypes(suggestions, term, limit)
+        if candidate_suggestions.empty?
+          candidate_suggestions = reduce_to_misspells(suggestions, term, limit)
+        end
+        reduce_wild_suggestions(candidate_suggestions)
+      end
 
-    def suggestions(term)
-      term = term.spellr_normalize
-      @suggestions.fetch(term) do
-        @suggestions[term] = @did_you_mean.correct(term).map(&:chomp)
+      def reduce_to_mistypes(suggestions, term, limit = 5)
+        # Correct mistypes
+        threshold = ((term.length - 1) * 0.25).ceil
+        suggestions.lazy.select do |suggestion|
+          suggestion.levenshtein_distance ||= DamerauLevenshtein.distance(suggestion.word, term)
+          suggestion.levenshtein_distance <= threshold
+        end.take(limit).to_a
+      end
+
+      def reduce_to_misspells(suggestions, term, limit = 1)
+        # Correct misspells
+        suggestions.lazy.select do |suggestion|
+          length = term.length < suggestion.word.length ? term.length : suggestion.word.length
+
+          suggestion.levenshtein_distance ||= DamerauLevenshtein.distance(suggestion.word, term)
+          suggestion.levenshtein_distance < length - 1
+        end.take(limit).to_a
+      end
+
+      def reduce_wild_suggestions(suggestions)
+        return suggestions unless suggestions.length > 1
+
+        threshold = suggestions.first.jaro_winkler_similarity * 0.98
+        suggestions.select do |suggestion|
+          suggestion.jaro_winkler_similarity > threshold
+        end
       end
     end
   end

data/lib/spellr/suggestion.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Suggestion
+  attr_accessor :levenshtein_distance
+  attr_reader :word, :jaro_winkler_similarity
+
+  def initialize(word, jaro_winkler_similarity)
+    @word = word
+    @jaro_winkler_similarity = jaro_winkler_similarity
+  end
+end

data/lib/spellr/token.rb

@@ -8,7 +8,7 @@ class String
 
   def spellr_normalize
     @@spellr_normalize.fetch(to_s) do |term|
-      @@spellr_normalize[term] = "#{term.strip.downcase.unicode_normalize.tr('’', "'")}\n"
+      @@spellr_normalize[term] = term.strip.downcase.unicode_normalize.tr('’', "'").to_s
     end
   end
 end

data/lib/spellr/tokenizer.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'stringio'
 require_relative 'token'
 require_relative 'column_location'
 require_relative 'line_location'

data/lib/spellr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spellr
-  VERSION = '0.11.0'
+  VERSION = '0.12.0'
 end

data/lib/spellr/wordlist.rb

@@ -41,23 +41,29 @@ module Spellr
       touch
       @include[term] = true
       insert_sorted(term)
-      @path.write(words.join) # we don't need to clear the cache
+      write(words, clear_cache: false)
     end
 
     def words
-      @words ||= (exist? ? @path.readlines : [])
+      @words ||= if exist?
+        @path.readlines(chomp: true)
+      else
+        []
+      end
     end
     alias_method :to_a, :words
 
     def clean(file = @path)
       require_relative 'tokenizer'
-      write(Spellr::Tokenizer.new(file, skip_key: false).normalized_terms.join)
+      write(Spellr::Tokenizer.new(file, skip_key: false).normalized_terms)
     end
 
-    def write(content)
+    def write(words, clear_cache: true)
+      content = words.join("\n")
+      content << "\n" unless words.empty?
       @path.write(content)
 
-      clear_cache
+      self.clear_cache if clear_cache
     end
 
     def exist?
@@ -70,28 +76,13 @@ module Spellr
       return if exist?
 
       @path.dirname.mkpath
-      @path.write('')
-      clear_cache
+      write([])
     end
 
     def length
       to_a.length
     end
 
-    def suggestions(term)
-      suggester.suggestions(term)
-    end
-
-    private
-
-    def suggester
-      @suggester ||= begin
-        require_relative 'maybe_suggester'
-
-        ::Spellr::Suggester.new(self)
-      end
-    end
-
     def insert_sorted(term)
       insert_at = words.bsearch_index { |value| value >= term }
       insert_at ? words.insert(insert_at, term) : words.push(term)
@@ -99,7 +90,6 @@ module Spellr
 
     def clear_cache
       @words = nil
-      @suggester = nil
       @include = {}
       remove_instance_variable(:@exist) if defined?(@exist)
     end

data/lib/spellr/wordlist_reporter.rb

@@ -6,7 +6,7 @@ require_relative 'base_reporter'
 module Spellr
   class WordlistReporter < Spellr::BaseReporter
     def finish
-      puts words.sort.join unless words.empty?
+      puts words.sort.join("\n") unless words.empty?
     end
 
     def call(token)

data/spellr.gemspec

@@ -33,8 +33,8 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_development_dependency 'base64'
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'did_you_mean' unless ENV['DID_YOU_MEAN'] == '0'
   spec.add_development_dependency 'leftovers', '>= 0.4.0'
   spec.add_development_dependency 'mime-types', '~> 3.3.1'
   spec.add_development_dependency 'nokogiri'
@@ -43,12 +43,14 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.93.1'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.44.1'
-  spec.add_development_dependency 'simplecov', '~> 0.18.5'
+  spec.add_development_dependency 'simplecov', '~> 0.22.0'
   spec.add_development_dependency 'simplecov-console'
-  spec.add_development_dependency 'tty_string', '>= 1.1.0'
+  spec.add_development_dependency 'tty_string', '>= 2.0.3'
   spec.add_development_dependency 'webmock', '~> 3.8'
 
+  spec.add_dependency 'damerau-levenshtein'
   spec.add_dependency 'fast_ignore', '>= 0.11.0'
-  spec.add_dependency 'jaro_winkler'
+  spec.add_dependency 'jaro_winkler', '>= 1.6.0'
   spec.add_dependency 'parallel', '~> 1.0'
+  spec.add_dependency 'reline'
 end

metadata

@@ -1,43 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: spellr
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Dana Sherson
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-15 00:00:00.000000000 Z
+date: 2025-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: did_you_mean
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: leftovers
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +155,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.5
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.5
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: simplecov-console
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +183,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 2.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 2.0.3
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +205,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: damerau-levenshtein
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: fast_ignore
   requirement: !ruby/object:Gem::Requirement
@@ -226,14 +239,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -248,7 +261,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description:
+- !ruby/object:Gem::Dependency
+  name: reline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 email:
 - robot@dana.sh
 executables:
@@ -296,6 +322,7 @@ files:
 - lib/spellr/reporter.rb
 - lib/spellr/string_format.rb
 - lib/spellr/suggester.rb
+- lib/spellr/suggestion.rb
 - lib/spellr/token.rb
 - lib/spellr/token_regexps.rb
 - lib/spellr/tokenizer.rb
@@ -333,7 +360,6 @@ metadata:
   homepage_uri: http://github.com/robotdana/spellr
   source_code_uri: http://github.com/robotdana/spellr
   changelog_uri: http://github.com/robotdana/spellr/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -348,8 +374,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Spell check your source code
 test_files: []