aye_var 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13bedf4da163ee9b20c83ed235f78825ced3e3a6547abc98af2de5e08d06401c
-  data.tar.gz: 4cbc787d135c70ea6c1b725ad01af3c2be374959fb1a52667f9db6271e458b32
+  metadata.gz: 2e1eb735e2846d27610ccd41568c9022de487d62ccbf2c9d212af0019c72e1c9
+  data.tar.gz: 0ceb88f7fe73970d8c7c47d15671ecc2fc8350a8c05e29eed55d4ce6935828bd
 SHA512:
-  metadata.gz: eb4d35e722d2f31d4953a03687421c18b1aea499e69e77ef614285622e41e8ab23c0422b6649dfad1e54066d77362ccad1a5851c3f2a9a1a7dafe6bf44fc877f
-  data.tar.gz: bd303daa537463d610e8b37b356e3bc44e8bd46e4e4734acc58b24ca3a262748ae39e2169cbe328b3daddf4bd84767d94514fd6ed7ebdd54aa1ad980da4a8a4a
+  metadata.gz: ac42f044cd02865cd63d7194b76bbe5111da98bbdf9286ebc1975ff460bad95c22a6070c29238a2c2fa6ffdca2597f8f28aad1e0dfd7a3235c6051e635d16fc1
+  data.tar.gz: 52673c9d24958003fc168ddf02075332aac4d3275c70e73d0d3d86aca54aa6bc17ae2226cbb0c75df8d5537f0f3f208b0ce980c49b3f23160cdab75440f56ee9

data/README.md

@@ -1,14 +1,22 @@
-## AyeVar
+# AyeVar 🏴‍☠️
 
-Note, this gem is very new and experimental. The API will probably change.
+Arrr, this gem be mighty fresh an’ experimental, me hearties! Th’ API be likely to shift with th’ tides.
 
-Add this gem to your gemfile.
+## What does it do?
+
+It prevents ye from usin’ undefined instance variables by transformin’ yer code as it be loaded, savvy?
+
+Instance variables must be declared in yer object’s initializer (even if they be initially set to `nil`). Only then can ye access ’em in th’ rest o’ yer code, ye scurvy dog!
+
+## Setup
+
+Add this treasure to yer gemfile, arr!
 
 ```ruby
 gem "aye_var", require: false
 ```
 
-Then require and initialize it in your app as early as possible. If you’re using Bootsnap, it should be right after Bootsnap.
+Then require an’ initialize it in yer vessel as early as possible, ye hear? If ye be usin’ Bootsnap, it should be right after Bootsnap, or I’ll make ye walk th’ plank!
 
 ```ruby
 require "aye_var"
@@ -16,4 +24,4 @@ require "aye_var"
 AyeVar.init(include: ["#{Dir.pwd}/**/*"])
 ```
 
-You can pass in an array of globs to `include:` and `exclude:`.
+Ye can pass in an array o’ globs to `include:` an’ `exclude:`, ye bilge rat!

data/lib/aye_var/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AyeVar
-	VERSION = "0.1.0"
+	VERSION = "0.1.1"
 end

data/lib/aye_var.rb

@@ -1,77 +1,165 @@
 # frozen_string_literal: true
 
 require "require-hooks/setup"
+require "prism"
 
 module AyeVar
+	METHODS_PERMITTED_FOR_DEFINITION = Set[:initialize, :setup].freeze
+
+	NameError = Class.new(::NameError)
+
+	def self.init(include: [], exclude: [])
+		RequireHooks.source_transform(patterns: include, exclude_patterns: exclude) do |path, source|
+			source ||= File.read(path)
+			Processor.call(source)
+		end
+	end
+
 	class Processor < Prism::Visitor
 		def self.call(source)
-			object = new(source)
-			object.visit(Prism.parse(source).value)
+			visitor = new
+			visitor.visit(Prism.parse(source).value)
 
 			buffer = source.dup
 
-			object.ivars.sort_by(&:first).reverse_each do |offset, action, name|
+			visitor.annotations.sort_by(&:first).reverse_each do |offset, action, name|
 				case action
 				when :start
 					buffer.insert(offset, "((raise ::AyeVar::NameError.new('Undefined instance variable #{name}') unless defined?(#{name}));")
 				when :end
 					buffer.insert(offset, ")")
+				else
+					raise "Invalid annotation"
 				end
 			end
 
 			buffer
 		end
 
-		def initialize(source)
-			@initializer = false
-			@ivars = []
+		def initialize
+			@definition_context = true
+			@this = nil
+			@context = nil
+			@annotations = []
+		end
+
+		attr_reader :annotations
+
+		def visit_class_node(node)
+			new_context(node) { super }
+		end
+
+		def visit_module_node(node)
+			new_context(node) { super }
 		end
 
-		attr_reader :ivars
+		def visit_block_node(node)
+			new_context(node) { super }
+		end
+
+		def visit_singleton_class_node(node)
+			new_context(node) { super }
+		end
 
 		def visit_def_node(node)
-			if node.name == :initialize
-				begin
-					@initializer = true
+			parent = @this
+
+			new_context(node) do
+				if METHODS_PERMITTED_FOR_DEFINITION.include?(node.name) || Prism::SelfNode === node.receiver || !(Prism::ClassNode === parent)
 					super
-				ensure
-					@initializer = false
+				else
+					prevent_definitions { super }
 				end
-			else
-				super
 			end
 		end
 
+		def visit_if_node(node)
+			visit(node.predicate)
+
+			branch { visit(node.statements) }
+			branch { visit(node.subsequent) }
+		end
+
+		def visit_case_node(node)
+			visit(node.predicate)
+
+			node.conditions.each do |condition|
+				branch { visit(condition) }
+			end
+
+			branch { visit(node.else_clause) }
+		end
+
 		def visit_instance_variable_read_node(node)
-			location = node.location
 			name = node.name
 
-			@ivars << [location.start_character_offset, :start, name]
-			@ivars << [location.end_character_offset, :end, name]
+			unless context.include?(name)
+				location = node.location
+
+				context << name
+
+				@annotations << [location.start_character_offset, :start, name]
+				@annotations << [location.end_character_offset, :end, name]
+			end
+
 			super
 		end
 
 		def visit_instance_variable_write_node(node)
-			unless @initializer
+			name = node.name
+
+			unless @definition_context || context.include?(name)
 				location = node.location
-				name = node.name
 
-				@ivars << [location.start_character_offset, :start, name]
-				@ivars << [location.end_character_offset, :end, name]
+				context << name
+
+				@annotations << [location.start_character_offset, :start, name]
+				@annotations << [location.end_character_offset, :end, name]
 			end
 
 			super
 		end
-	end
 
-	private_constant :Processor
+		private def new_context(this)
+			original_this = @this
+			original_context = @context
 
-	NameError = Class.new(::NameError)
+			@this = this
+			@context = Set[]
 
-	def self.init(include: [], exclude: [])
-		RequireHooks.source_transform(patterns: include, exclude_patterns: exclude) do |path, source|
-			source ||= File.read(path)
-			Processor.call(source)
+			begin
+				yield
+			ensure
+				@this = original_this
+				@context = original_context
+			end
+		end
+
+		private def branch
+			original_context = @context
+			@context = original_context.dup
+
+			begin
+				yield
+			ensure
+				@context = original_context
+			end
+		end
+
+		# The current context on the stack
+		private def context
+			@context
+		end
+
+		private def prevent_definitions
+			original_definition_context = @definition_context
+
+			begin
+				@definition_context = false
+				yield
+			ensure
+				@definition_context = original_definition_context
+			end
 		end
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aye_var
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Joel Drapper
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: prism
+  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'
 description: Raise an exception when using undefined instance variables.
 email:
 - joel@drapper.me