strict_ivars 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fdc65115a894c678d04614ece5855c2089003d320fe6bf22cb9c9ef0aa5de50
-  data.tar.gz: cb51570cf483f8a952daf0eb4798ac430c699f5357474c80d37cf4c75cc8b073
+  metadata.gz: 65516e69e17c893c02c57e0cc0be683c57c9dc3fd91b80f56942453d5df43649
+  data.tar.gz: 16d3c581474be1f5a7500eb24e442ac8bcd54f55ee5d7afef6cdea3ef986381f
 SHA512:
-  metadata.gz: 669e9cd076e7be979fa8d145cf9c0413794eeddd650dc0c183a67f2341809217dcd41059050fd63143311b9afc8c0c44dae82ade79e94967929c080d55da9bc0
-  data.tar.gz: 901f1b60e232b8dccc0fbd6bf36f50b906b702e7396fffec47fa8e180e3390629ef0e7733e736e341f2ea482fc255d0870a96cbbccaf74cbfe0988a2d6df0cc0
+  metadata.gz: b92fa82ca1acbcef116a5ab531bb1a4ec08301db0b17eb9d5f5a99af47c29face2c82a51d0f63b905eec0a7506e2453b040731848a69afff951f6f44b18e789e
+  data.tar.gz: b650231f2312548af22bd11ecc031dbdcbf178a5ce4f501b29f48687a59209a6533c12a4ef8fe78a351cc03e591bbd3e01c1edf67f03568620279b3990ab0e63

data/README.md

@@ -1,6 +1,6 @@
 # Strict Ivars
 
-Strict Ivars is a tiny pre-processor for Ruby that guards your instance variable reads, ensuring the instance variable is actually defined. This helps catch typos nice and early.
+Strict Ivars is a tiny pre-processor for Ruby that guards your instance variable reads, ensuring the instance variable is actually defined. This helps catch typos nice and early. It‘s especially good when used with [Literal](https://literal.fun).
 
 ## How does it work?
 
@@ -26,6 +26,50 @@ The replacement happens on load, so you never see this in your source code. It
 
 The real guard is a little uglier than this. It uses `::Kernel.raise` so it’s compatible with `BasicObject`. It also raises a `StrictIvars::NameError` with a helpful message mentioning the name of the instance variable, and that inherits from `NameError`, allowing you to rescue either `NameError` or `StrictIvars::NameError`.
 
+**When you check defined already**
+
+Within the same context (e.g. class definition, module definition, block, method), if you check `defined?`, Strict Ivars will not add a guard to reads of the checked instance variable.
+
+```ruby
+if defined?(@foo)
+  @foo
+end
+```
+
+This applies even if the read is not in one of the conditional’s branches since you’ve indicated local awareness of the potential for this instance variable not being defined.
+
+```ruby
+if defined?(@foo)
+  # anything
+end
+
+@foo
+```
+
+**Writes:**
+
+Strict Ivars doesn’t apply to writes, since these are considered the authoritative source of the instance variable definitions.
+
+```ruby
+@foo = 1
+```
+
+**Or-writes:**
+
+This is considered a definition and not guarded.
+
+```ruby
+@foo ||= 1
+```
+
+**And-writes:**
+
+This is considered a definition and not guarded.
+
+```ruby
+@foo &&= 1
+```
+
 ## Setup
 
 Install the gem by adding it to your `Gemfile` and running `bundle install`.
@@ -41,7 +85,7 @@ Now the gem is installed, you should require and initialize the gem as early as
 ```ruby
 require "strict_ivars"
 
-StrictIvars.init(include: ["#{Dir.pwd}/**/*"])
+StrictIvars.init(include: ["#{Dir.pwd}/**/*"], exclude: ["#{Dir.pwd}/vendor/**/*"])
 ```
 
 You can pass an array of globs to `include:` and `exclude:`.

data/lib/strict_ivars/configuration.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class StrictIvars::Configuration
+	def initialize
+		@mutex = Mutex.new
+		@include = []
+		@exclude = []
+	end
+
+	#: (*String) -> void
+	def include(*patterns)
+		@mutex.synchronize do
+			@include.concat(patterns)
+		end
+	end
+
+	#: (*String) -> void
+	def exclude(*patterns)
+		@mutex.synchronize do
+			@exclude.concat(patterns)
+		end
+	end
+
+	#: (String) -> bool
+	def match(path)
+		path = File.absolute_path(path)
+		return false if @exclude.any? { |pattern| File.fnmatch?(pattern, path) }
+		return true if @include.any? { |pattern| File.fnmatch?(pattern, path) }
+		false
+	end
+end

data/lib/strict_ivars/patch_eval.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module StrictIvars
+	module ModuleEvalPatch
+		#: (String, ?String, ?Integer) -> void
+		#: () { () -> void } -> void
+		def class_eval(*args)
+			source, file, lineno = args
+
+			file ||= caller_locations(1, 1).first.path
+
+			if source && file && CONFIG.match(file)
+				args[0] = Processor.call(source)
+			end
+
+			super
+		end
+
+		#: (String, ?String, ?Integer) -> void
+		#: () { () -> void } -> void
+		def module_eval(*args)
+			source, file, lineno = args
+
+			file ||= caller_locations(1, 1).first.path
+
+			if source && file && CONFIG.match(file)
+				args[0] = Processor.call(source)
+			end
+
+			super
+		end
+	end
+
+	module InstanceEvalPatch
+		#: (String, ?String, ?Integer) -> void
+		#: () { () -> void } -> void
+		def instance_eval(*args)
+			source, file, lineno = args
+
+			file ||= caller_locations(1, 1).first.path
+
+			if source && file && CONFIG.match(file)
+				args[0] = Processor.call(source)
+			end
+
+			super
+		end
+	end
+
+	module KernelEvalPatch
+		#: (String, Binding, ?String, ?Integer) -> void
+		def eval(*args)
+			source, binding, file, lineno = args
+
+			file ||= caller_locations(1, 1).first.path
+
+			if source && file && CONFIG.match(file)
+				args[0] = Processor.call(source.to_s)
+			end
+
+			super
+		end
+	end
+
+	module BindingEvalPatch
+		#: (String, ?String, ?Integer) -> void
+		def eval(*args)
+			source, file, lineno = args
+
+			file ||= caller_locations(1, 1).first.path
+
+			if source && file && CONFIG.match(file)
+				args[0] = Processor.call(source.to_s)
+			end
+
+			super
+		end
+	end
+
+	Kernel.prepend(KernelEvalPatch)
+	Module.prepend(ModuleEvalPatch)
+	Binding.prepend(BindingEvalPatch)
+	BasicObject.prepend(InstanceEvalPatch)
+end

data/lib/strict_ivars/version.rb

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

data/lib/strict_ivars.rb

@@ -2,12 +2,21 @@
 
 require "prism"
 require "require-hooks/setup"
+require "strict_ivars/version"
+require "strict_ivars/configuration"
 
 module StrictIvars
 	NameError = Class.new(::NameError)
 
+	CONFIG = Configuration.new
+
 	#: (include: Array[String], exclude: Array[String]) -> void
 	def self.init(include: [], exclude: [])
+		require "strict_ivars/patch_eval"
+
+		CONFIG.include(*include)
+		CONFIG.exclude(*exclude)
+
 		RequireHooks.source_transform(
 			patterns: include,
 			exclude_patterns: exclude

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strict_ivars
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Joel Drapper
@@ -47,6 +47,8 @@ files:
 - LICENSE.txt
 - README.md
 - lib/strict_ivars.rb
+- lib/strict_ivars/configuration.rb
+- lib/strict_ivars/patch_eval.rb
 - lib/strict_ivars/processor.rb
 - lib/strict_ivars/version.rb
 homepage: https://github.com/joeldrapper/strict_ivars