ivar 0.2.0

data/lib/ivar/validation.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "did_you_mean"
+
+module Ivar
+  # Provides validation for instance variables
+  module Validation
+    # Checks instance variables against class analysis
+    # @param add [Array<Symbol>] Additional instance variables to allow
+    # @param policy [Symbol, Policy] The policy to use for handling unknown variables
+    def check_ivars(add: [], policy: nil)
+      # Get the policy to use
+      policy ||= get_check_policy
+
+      # Get the class analysis from the cache
+      analysis = Ivar.get_analysis(self.class)
+
+      # Get all instance variables defined in the current object
+      # These are the ones the user has explicitly defined before calling check_ivars
+      defined_ivars = instance_variables.map(&:to_sym)
+
+      # Add any additional allowed variables
+      allowed_ivars = defined_ivars + add
+
+      # Get all instance variable references from the analysis
+      # This includes location information for each reference
+      references = analysis.ivar_references
+
+      # Find references to unknown variables (those not in allowed_ivars)
+      unknown_refs = references.reject { |ref| allowed_ivars.include?(ref[:name]) }
+
+      # Handle unknown variables according to the policy
+      policy_instance = Ivar.get_policy(policy)
+      policy_instance.handle_unknown_ivars(unknown_refs, self.class, allowed_ivars)
+    end
+
+    # For backward compatibility - delegates to check_ivars with warn_once policy
+    # @param add [Array<Symbol>] Additional instance variables to allow
+    def check_ivars_once(add: [])
+      check_ivars(add: add, policy: :warn_once)
+    end
+
+    private
+
+    # Get the check policy for this instance
+    # @return [Symbol, Policy] The check policy
+    def get_check_policy
+      # If the class has an ivar_check_policy method, use that
+      return self.class.ivar_check_policy if self.class.respond_to?(:ivar_check_policy)
+
+      # Otherwise, use the global default
+      Ivar.check_policy
+    end
+  end
+end

data/lib/ivar/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ivar
+  VERSION = "0.2.0"
+end

data/lib/ivar.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative "ivar/version"
+require_relative "ivar/prism_analysis"
+require_relative "ivar/policies"
+require_relative "ivar/validation"
+require_relative "ivar/macros"
+require_relative "ivar/auto_check"
+require "prism"
+require "did_you_mean"
+
+module Ivar
+  @analysis_cache = {}
+  @checked_classes = {}
+  @default_check_policy = :warn
+
+  # Returns a cached analysis for the given class or module
+  # Creates a new analysis if one doesn't exist in the cache
+  def self.get_analysis(klass)
+    @analysis_cache[klass] ||= PrismAnalysis.new(klass)
+  end
+
+  # Checks if a class has been validated already
+  # @param klass [Class] The class to check
+  # @return [Boolean] Whether the class has been validated
+  def self.class_checked?(klass)
+    @checked_classes.key?(klass)
+  end
+
+  # Marks a class as having been checked
+  # @param klass [Class] The class to mark as checked
+  def self.mark_class_checked(klass)
+    @checked_classes[klass] = true
+  end
+
+  # For testing purposes - allows clearing the cache
+  def self.clear_analysis_cache
+    @analysis_cache.clear
+    @checked_classes.clear
+  end
+
+  # Get the default check policy
+  # @return [Symbol] The default check policy
+  def self.check_policy
+    @default_check_policy
+  end
+
+  # Set the default check policy
+  # @param policy [Symbol, Policy] The default check policy
+  def self.check_policy=(policy)
+    @default_check_policy = policy
+  end
+end

data/sig/ivar.rbs

@@ -0,0 +1,4 @@
+module Ivar
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/test_file.rb

@@ -0,0 +1 @@
+class MockClass; end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: ivar
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Avdi Grimm
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: |
+  Ruby instance variables are so convenient - you don't even need to declare them!
+  But... they are also dangerous, because a mispelled variable name results in `nil`
+  instead of an error.
+
+  Why not have the best of both worlds? Ivar lets you use plain-old instance variables,
+  and automatically checks for typos.
+
+  Ivar waits until an instance is created to do the checking, then uses Prism to look
+  for variables that don't match what was set in initialization. So it's a little bit
+  dynamic, a little bit static. It doesn't encumber your instance variable reads and
+  writes with any extra checking. And with the `:warn_once` policy, it won't overwhelm
+  you with output.
+email:
+- avdi@avdi.codes
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".augment-guidelines"
+- ".devcontainer/Dockerfile"
+- ".devcontainer/devcontainer.json"
+- ".standard.yml"
+- ".vscode/extensions.json"
+- ".vscode/settings.json"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/sandwich_inheritance.rb
+- examples/sandwich_with_checked.rb
+- examples/sandwich_with_checked_once.rb
+- examples/sandwich_with_ivar_block.rb
+- examples/sandwich_with_ivar_macro.rb
+- examples/sandwich_with_kwarg.rb
+- ivar.gemspec
+- lib/ivar.rb
+- lib/ivar/auto_check.rb
+- lib/ivar/checked.rb
+- lib/ivar/macros.rb
+- lib/ivar/policies.rb
+- lib/ivar/prism_analysis.rb
+- lib/ivar/validation.rb
+- lib/ivar/version.rb
+- sig/ivar.rbs
+- test_file.rb
+homepage: https://github.com/avdi/ivar
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/avdi/ivar
+  source_code_uri: https://github.com/avdi/ivar
+  changelog_uri: https://github.com/avdi/ivar/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Automatically check instance variables for typos.
+test_files: []