strict_ivars 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fdc65115a894c678d04614ece5855c2089003d320fe6bf22cb9c9ef0aa5de50
-  data.tar.gz: cb51570cf483f8a952daf0eb4798ac430c699f5357474c80d37cf4c75cc8b073
+  metadata.gz: 6e1244d297abc3e3ade0882ca3a8767b63701c42721a7199803ad75b46c566ed
+  data.tar.gz: c141c19397e2942a40bb049ca77790ca9b29a6de9e0cd30e218162b1e51c4ee7
 SHA512:
-  metadata.gz: 669e9cd076e7be979fa8d145cf9c0413794eeddd650dc0c183a67f2341809217dcd41059050fd63143311b9afc8c0c44dae82ade79e94967929c080d55da9bc0
-  data.tar.gz: 901f1b60e232b8dccc0fbd6bf36f50b906b702e7396fffec47fa8e180e3390629ef0e7733e736e341f2ea482fc255d0870a96cbbccaf74cbfe0988a2d6df0cc0
+  metadata.gz: 8cd2d471ca00c86a910843da2cacf803d71f30d48c946f469a5f18ef34c23b54d99d20897501a769695ff37114b677b8ce25c927a135876d99f1202324ad2e8f
+  data.tar.gz: ab6d3154078514bb0bd9615bae2cecdda743cb7a3dcd5f55d8571fae1f5201f94d090ebffd582881876f3b66bdcfd2035e4d600b77b7fa3350759f33deb4850a

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,30 @@ 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`.
 
+**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 +65,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/base_processor.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "securerandom"
+
+class StrictIvars::BaseProcessor < Prism::Visitor
+	EVAL_METHODS = Set[:class_eval, :module_eval, :instance_eval, :eval].freeze
+
+	#: (String) -> String
+	def self.call(source)
+		visitor = new
+		visitor.visit(Prism.parse(source).value)
+		buffer = source.dup
+		annotations = visitor.annotations
+		annotations.sort_by!(&:first)
+
+		annotations.reverse_each do |offset, string|
+			buffer.insert(offset, string)
+		end
+
+		buffer
+	end
+
+	def initialize
+		@context = Set[]
+		@annotations = []
+	end
+
+	#: Array[[Integer, :start_ivar_read | :end_ivar_read, Symbol]]
+	attr_reader :annotations
+
+	def visit_call_node(node)
+		name = node.name
+
+		if EVAL_METHODS.include?(name) && (arguments = node.arguments)
+			location = arguments.location
+
+			if node.receiver
+				receiver_local = "__eval_receiver_#{SecureRandom.hex(8)}__"
+				receiver_location = node.receiver.location
+
+				@annotations.push(
+					[receiver_location.start_character_offset, "(#{receiver_local} = "],
+					[receiver_location.end_character_offset, ")"],
+					[location.start_character_offset, "*(::StrictIvars.process_eval_args(#{receiver_local}, :#{name}, "],
+					[location.end_character_offset, "))"]
+				)
+			else
+				@annotations.push(
+					[location.start_character_offset, "*(::StrictIvars.process_eval_args(self, :#{name}, "],
+					[location.end_character_offset, "))"]
+				)
+			end
+		end
+
+		super
+	end
+end

data/lib/strict_ivars/configuration.rb

@@ -0,0 +1,32 @@
+# 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)
+		return false unless String === 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/processor.rb

@@ -1,36 +1,6 @@
 # frozen_string_literal: true
 
-class StrictIvars::Processor < Prism::Visitor
-	#: (String) -> String
-	def self.call(source)
-		visitor = new
-		visitor.visit(Prism.parse(source).value)
-		buffer = source.dup
-		annotations = visitor.annotations
-		annotations.sort_by!(&:first)
-
-		annotations.reverse_each do |offset, action, name|
-			case action
-			when :start
-				buffer.insert(offset, "(defined?(#{name}) ? ")
-			when :end
-				buffer.insert(offset, " : (::Kernel.raise(::StrictIvars::NameError.new('Undefined instance variable #{name}'))))")
-			else
-				raise "Invalid annotation"
-			end
-		end
-
-		buffer
-	end
-
-	def initialize
-		@context = Set[]
-		@annotations = []
-	end
-
-	#: Array[[Integer, :start | :end, Symbol]]
-	attr_reader :annotations
-
+class StrictIvars::Processor < StrictIvars::BaseProcessor
 	#: (Prism::ClassNode) -> void
 	def visit_class_node(node)
 		new_context { super }
@@ -51,17 +21,6 @@ class StrictIvars::Processor < Prism::Visitor
 		new_context { super }
 	end
 
-	#: (Prism::DefinedNode) -> void
-	def visit_defined_node(node)
-		value = node.value
-
-		if Prism::InstanceVariableReadNode === value
-			@context << value.name
-		end
-
-		super
-	end
-
 	#: (Prism::DefNode) -> void
 	def visit_def_node(node)
 		new_context { super }
@@ -95,9 +54,10 @@ class StrictIvars::Processor < Prism::Visitor
 
 			@context << name
 
-			@annotations <<
-				[location.start_character_offset, :start, name] <<
-				[location.end_character_offset, :end, name]
+			@annotations.push(
+				[location.start_character_offset, "(defined?(#{name}) ? "],
+				[location.end_character_offset, " : (::Kernel.raise(::StrictIvars::NameError.new('Undefined instance variable #{name}'))))"]
+			)
 		end
 
 		super

data/lib/strict_ivars/version.rb

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

data/lib/strict_ivars.rb

@@ -2,20 +2,72 @@
 
 require "prism"
 require "require-hooks/setup"
+require "strict_ivars/version"
+require "strict_ivars/base_processor"
+require "strict_ivars/processor"
+require "strict_ivars/configuration"
 
 module StrictIvars
 	NameError = Class.new(::NameError)
 
+	EMPTY_ARRAY = [].freeze
+	EVERYTHING = ["**/*"].freeze
+	METHOD_METHOD = Module.instance_method(:method)
+
+	CONFIG = Configuration.new
+
 	#: (include: Array[String], exclude: Array[String]) -> void
-	def self.init(include: [], exclude: [])
+	def self.init(include: EMPTY_ARRAY, exclude: EMPTY_ARRAY)
+		CONFIG.include(*include) unless include.length == 0
+		CONFIG.exclude(*exclude) unless exclude.length == 0
+
 		RequireHooks.source_transform(
-			patterns: include,
-			exclude_patterns: exclude
+			patterns: EVERYTHING,
+			exclude_patterns: EMPTY_ARRAY
 		) do |path, source|
 			source ||= File.read(path)
-			Processor.call(source)
+
+			if CONFIG.match?(path)
+				Processor.call(source)
+			else
+				BaseProcessor.call(source)
+			end
 		end
 	end
-end
 
-require "strict_ivars/processor"
+	def self.process_eval_args(receiver, method_name, *args)
+		method = METHOD_METHOD.bind_call(receiver, method_name)
+		owner = method.owner
+
+		source, file = nil
+
+		case method_name
+		when :class_eval, :module_eval
+			if Module == owner
+				source, file = args
+			end
+		when :instance_eval
+			if BasicObject == owner
+				source, file = args
+			end
+		when :eval
+			if Kernel == owner
+				source, binding, file = args
+			elsif Binding == owner
+				source, file = args
+			end
+		end
+
+		if String === source
+			file ||= caller_locations(1, 1).first&.path
+
+			if CONFIG.match?(file)
+				args[0] = Processor.call(source)
+			else
+				args[0] = BaseProcessor.call(source)
+			end
+		end
+
+		args
+	end
+end

metadata

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