strict_ivars 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfeb3ee6871a0bbc8ba42d3b713697b66afc3158894189cc8f1aa52d78acdee2
-  data.tar.gz: db9a7c4610f9d2514d29ce3340326a9135b93a5106ad5389733e758c7adac828
+  metadata.gz: 5a6e9c3b4af8b1558193b058b36ab883ecc8dbce111b13bafb0cedd54852faa9
+  data.tar.gz: 22858692a9849c8f1f3b33450fe78054a622216221d81edd7992868a530dfc3c
 SHA512:
-  metadata.gz: 731e53215db39bf6bcd9850eeb521fede63e2acad7b347f14702d921478a53adcc6635350ace7e646bd6f4dbd7416b0e38937dca70cea53624143150536924a3
-  data.tar.gz: b40c2da16f5179d9f15af2d39c3c506907dfc04116c66de6f1ffac9454f2fc8b52ec2a834c78fbd2a95ad1e8a36b8911e05e4b2a2270a4453bef0bcffa8b45b4
+  metadata.gz: b52c5c582936f6905a00b381846109d673b6ff8b9a6c7f568d4c8bab82b60c8158afbf3924628d93ee133e5d98583169462ac42887a8f50e0c96068c23a450ea
+  data.tar.gz: 0b0d00db3c3daf0dd7c72ad2c3702e57240dcd93a5965d7b0e18b97ba56f5ec53dffc42cf4a7d845adc03ff0cd09c8f9c777d25d2c711be1c26de357583de977

data/README.md

@@ -4,11 +4,11 @@ If you reference an undefined method, constant or local varaible, Ruby will help
 
 Strict Ivars solves this by making Ruby raise a `NameError` any time you read an undefined instance varaible. It’s enabled with two lines of code in your boot process, then it just works in the background and you’ll never have to think about it again. Strict Ivars has no known false-positives or false-negatives.
 
-It‘s especially good when used with [Literal](https://literal.fun) and [Phlex](https://www.phlex.fun), though it also works with regular Ruby objects and even ERB templates, which are actually pretty common spots for undefined instance variable reads to hide since that’s the main way of passing data to ERB.
+It’s especially good when used with [Literal](https://literal.fun) and [Phlex](https://www.phlex.fun), though it also works with regular Ruby objects and even ERB templates, which are actually pretty common spots for undefined instance variable reads to hide since that’s the main way of passing data to ERB.
 
-When combined with Literal, you can completely remove unexpected `nil`. Literal validates your inputs and Strict Ivars ensures you’re reading the right instance variables.
+When combined with Literal, you can essentially remove all unexpected `nil`s. Literal validates your inputs and Strict Ivars ensures you’re reading the right instance variables.
 
-> [!NOTE]  
+> [!NOTE]
 > JRuby and TruffleRuby are not currently supported.
 
 ## Setup
@@ -35,6 +35,19 @@ StrictIvars.init(include: ["#{Dir.pwd}/**/*"], exclude: ["#{Dir.pwd}/vendor/**/*
 
 This example include everything in the current directory apart from the `./vendor` folder (which is where GitHub Actions installs gems).
 
+If you’re setting this up in Rails, your `boot.rb` file should look something like this.
+
+```ruby
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+require "bundler/setup" # Set up gems listed in the Gemfile.
+require "bootsnap/setup" # Speed up boot time by caching expensive operations.
+
+require "strict_ivars"
+
+StrictIvars.init(include: ["#{Dir.pwd}/**/*"], exclude: ["#{Dir.pwd}/vendor/**/*"])
+```
+
 If you’re using Bootsnap, you should clear your bootsnap cache by deleting the folder `tmp/cache/bootsnap`.
 
 ## How does it work?

data/lib/strict_ivars/name_error.rb

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
+require "did_you_mean/spell_checker"
+
 class StrictIvars::NameError < ::NameError
 	INSTANCE_VARIABLE_METHOD = Kernel.instance_method(:instance_variables)
 
 	def initialize(object, name)
-		suggestion = INSTANCE_VARIABLE_METHOD.bind_call(object).max_by do |candidate|
-			n_common_trigrams(candidate, name) / Math.sqrt(candidate.length)
-		end
+		checker = DidYouMean::SpellChecker.new(
+			dictionary: INSTANCE_VARIABLE_METHOD.bind_call(object)
+		)
+
+		suggestion = checker.correct(name).first
 
 		message = [
 			"Undefined instance variable `#{name}`.",
@@ -15,43 +19,4 @@ class StrictIvars::NameError < ::NameError
 
 		super(message)
 	end
-
-	private def n_common_trigrams(left, right)
-		left = "\x03\x02#{left}"
-		right = "\x03\x02#{right}"
-
-		left_len = left.length
-		right_len = right.length
-
-		return 0 if left_len < 3 || right_len < 3
-
-		# Process shorter string first
-		if left_len > right_len
-			left, right = right, left
-			left_len, right_len = right_len, left_len
-		end
-
-		# Use a Set for lookup
-		trigrams = Set.new
-		count = 0
-
-		# Generate trigrams from shorter string
-		i = 0
-		left_max = left_len - 2
-		while i < left_max
-			trigram = left[i, 3]
-			trigrams.add(trigram)
-			i += 1
-		end
-
-		# Check trigrams from longer string
-		i = 0
-		right_max = right_len - 2
-		while i < right_max
-			count += 1 if trigrams.include?(right[i, 3])
-			i += 1
-		end
-
-		count
-	end
 end

data/lib/strict_ivars/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StrictIvars
-	VERSION = "1.0.0"
+	VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strict_ivars
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Joel Drapper
@@ -38,7 +38,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Strict Ivars is a tiny pre-processor that guards you against undefined
-  instance variable reads.
+  instance variable reads. If you do read an undefined instance variable, it will
+  raise a NameError.
 email:
 - joel@drapper.me
 executables: []