ivar 0.2.0 → 0.4.6

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ivar
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.6
 platform: ruby
 authors:
 - Avdi Grimm
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prism
@@ -45,29 +46,64 @@ files:
 - ".augment-guidelines"
 - ".devcontainer/Dockerfile"
 - ".devcontainer/devcontainer.json"
+- ".devcontainer/post-create.sh"
+- ".editorconfig"
+- ".rubocop.yml"
 - ".standard.yml"
 - ".vscode/extensions.json"
+- ".vscode/launch.json"
 - ".vscode/settings.json"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
 - Rakefile
+- VERSION.md
+- examples/check_all_block_example.rb
+- examples/check_all_example.rb
+- examples/inheritance_with_kwarg_init.rb
+- examples/inheritance_with_positional_init.rb
+- examples/mixed_positional_and_kwarg_init.rb
+- examples/require_check_all_example.rb
 - examples/sandwich_inheritance.rb
+- examples/sandwich_with_accessors.rb
+- examples/sandwich_with_block_values.rb
 - examples/sandwich_with_checked.rb
 - examples/sandwich_with_checked_once.rb
+- examples/sandwich_with_initial_values.rb
 - examples/sandwich_with_ivar_block.rb
 - examples/sandwich_with_ivar_macro.rb
-- examples/sandwich_with_kwarg.rb
-- ivar.gemspec
+- examples/sandwich_with_kwarg_init.rb
+- examples/sandwich_with_positional_init.rb
+- examples/sandwich_with_shared_values.rb
+- hooks/README.md
+- hooks/install.sh
+- hooks/pre-commit
 - lib/ivar.rb
-- lib/ivar/auto_check.rb
+- lib/ivar/check_all.rb
+- lib/ivar/check_all_manager.rb
+- lib/ivar/check_policy.rb
 - lib/ivar/checked.rb
+- lib/ivar/checked/class_methods.rb
+- lib/ivar/checked/instance_methods.rb
+- lib/ivar/declaration.rb
+- lib/ivar/explicit_declaration.rb
+- lib/ivar/explicit_keyword_declaration.rb
+- lib/ivar/explicit_positional_declaration.rb
 - lib/ivar/macros.rb
+- lib/ivar/manifest.rb
 - lib/ivar/policies.rb
-- lib/ivar/prism_analysis.rb
+- lib/ivar/project_root.rb
+- lib/ivar/targeted_prism_analysis.rb
 - lib/ivar/validation.rb
 - lib/ivar/version.rb
+- script/console
+- script/de-lint
+- script/de-lint-unsafe
+- script/lint
+- script/release
+- script/setup
+- script/test
 - sig/ivar.rbs
 - test_file.rb
 homepage: https://github.com/avdi/ivar
@@ -78,6 +114,7 @@ metadata:
   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
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -85,14 +122,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.4.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: Automatically check instance variables for typos.
 test_files: []

data/examples/sandwich_with_kwarg.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require "ivar"
-
-class SandwichWithKwarg
-  include Ivar::Checked
-
-  # Pre-declare instance variables to be initialized from keyword arguments
-  ivar kwarg: [:@bread, :@cheese, :@condiments]
-
-  def initialize(pickles: false, side: nil)
-    # Note: @bread, @cheese, and @condiments are already set from keyword arguments
-    # We only need to handle the remaining keyword arguments
-    @pickles = pickles
-    @side = side
-  end
-
-  def to_s
-    result = "A #{@bread} sandwich with #{@cheese}"
-    result += " and #{@condiments.join(", ")}" unless @condiments.empty?
-    result += " with pickles" if @pickles
-    result += " and a side of #{@side}" if @side
-    result
-  end
-end
-
-# Create a sandwich with keyword arguments
-sandwich = SandwichWithKwarg.new(
-  bread: "wheat",
-  cheese: "muenster",
-  condiments: ["mayo", "mustard"],
-  side: "chips"
-)
-
-puts sandwich  # Outputs: A wheat sandwich with muenster and mayo, mustard and a side of chips
-
-# Create another sandwich with different keyword arguments
-sandwich2 = SandwichWithKwarg.new(
-  bread: "rye",
-  cheese: "swiss",
-  condiments: ["mustard"],
-  pickles: true
-)
-
-puts sandwich2  # Outputs: A rye sandwich with swiss and mustard with pickles

data/ivar.gemspec

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/ivar/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "ivar"
-  spec.version = Ivar::VERSION
-  spec.authors = ["Avdi Grimm"]
-  spec.email = ["avdi@avdi.codes"]
-
-  spec.summary = "Automatically check instance variables for typos."
-  spec.description = <<~EOF
-    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.
-  EOF
-
-  spec.homepage = "https://github.com/avdi/ivar"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.4.0"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/avdi/ivar"
-  spec.metadata["changelog_uri"] = "https://github.com/avdi/ivar/blob/main/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
-    end
-  end
-  spec.require_paths = ["lib"]
-
-  # Dependencies
-  spec.add_dependency "prism", "~> 1.2"
-end

data/lib/ivar/auto_check.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "validation"
-require_relative "macros"
-
-module Ivar
-  # Module for adding ivar_check_policy to classes
-  module CheckPolicy
-    # Set the check policy for this class
-    # @param policy [Symbol, Policy] The check policy
-    # @return [Symbol, Policy] The check policy
-    def ivar_check_policy(policy = nil, **options)
-      if policy.nil?
-        # Getter - return the current policy
-        @__ivar_check_policy || Ivar.check_policy
-      else
-        # Setter - set the policy
-        @__ivar_check_policy = options.empty? ? policy : [policy, options]
-      end
-    end
-
-    # Hook method called when the module is included
-    def inherited(subclass)
-      super
-      # Copy the check policy to the subclass
-      subclass.instance_variable_set(:@__ivar_check_policy, @__ivar_check_policy)
-    end
-  end
-
-  # Provides automatic validation for instance variables
-  # When included, automatically calls check_ivars after initialization
-  module Checked
-    # When this module is included in a class, it extends the class
-    # with ClassMethods and includes the Validation module
-    def self.included(base)
-      base.include(Validation)
-      base.include(PreInitializeIvars)
-      base.extend(ClassMethods)
-      base.extend(CheckPolicy)
-      base.extend(Macros)
-      base.prepend(InstanceMethods)
-
-      # Set default policy for Checked to :warn
-      base.ivar_check_policy(:warn)
-    end
-
-    # Class methods added to the including class
-    module ClassMethods
-      # Hook method called when the module is included
-      def inherited(subclass)
-        super
-        # Ensure subclasses also get the initialize wrapper
-        subclass.prepend(Ivar::Checked::InstanceMethods)
-      end
-    end
-
-    # Instance methods that will be prepended to the including class
-    module InstanceMethods
-      # Wrap the initialize method to automatically call check_ivars
-      def initialize(*args, **kwargs, &block)
-        # Initialize pre-declared instance variables
-        initialize_pre_declared_ivars
-        # Execute the initialization block if provided
-        execute_ivar_init_block
-
-        # Process keyword arguments
-        remaining_kwargs = initialize_from_kwargs(kwargs)
-
-        # Call the original initialize method with remaining arguments
-        super(*args, **remaining_kwargs, &block)
-
-        # Automatically check instance variables
-        check_ivars
-      end
-    end
-  end
-end

data/lib/ivar/prism_analysis.rb

@@ -1,102 +0,0 @@
-# frozen_string_literal: true
-
-require "prism"
-
-module Ivar
-  # Analyzes a class to find all instance variables using Prism
-  class PrismAnalysis
-    attr_reader :ivars
-
-    def initialize(klass)
-      @klass = klass
-      @references = nil
-      collect_references
-      @ivars = unique_ivar_names
-    end
-
-    # Returns a list of hashes each representing a code reference to an ivar
-    # Each hash includes var name, path, line number, and column number
-    def ivar_references
-      @references
-    end
-
-    private
-
-    def collect_references
-      source_files = collect_source_files
-      @references = []
-
-      source_files.each do |file_path|
-        code = File.read(file_path)
-        result = Prism.parse(code)
-        visitor = IvarReferenceVisitor.new(file_path)
-        result.value.accept(visitor)
-        @references.concat(visitor.references)
-      end
-    end
-
-    def unique_ivar_names
-      @references.map { |ref| ref[:name] }.uniq.sort
-    end
-
-    def collect_source_files
-      # Get all instance methods
-      instance_methods = @klass.instance_methods(false) | @klass.private_instance_methods(false)
-
-      # Collect source files for all methods
-      source_files = Set.new
-      instance_methods.each do |method_name|
-        next unless @klass.instance_method(method_name).source_location
-
-        source_files << @klass.instance_method(method_name).source_location.first
-      end
-
-      source_files
-    end
-
-    # Visitor that collects instance variable references with location information
-    class IvarReferenceVisitor < Prism::Visitor
-      attr_reader :references
-
-      def initialize(file_path)
-        super()
-        @file_path = file_path
-        @references = []
-      end
-
-      def visit_instance_variable_read_node(node)
-        add_reference(node)
-        true
-      end
-
-      def visit_instance_variable_write_node(node)
-        add_reference(node)
-        true
-      end
-
-      def visit_instance_variable_operator_write_node(node)
-        add_reference(node)
-        true
-      end
-
-      def visit_instance_variable_target_node(node)
-        add_reference(node)
-        true
-      end
-
-      private
-
-      def add_reference(node)
-        location = node.location
-        reference = {
-          name: node.name.to_sym,
-          path: @file_path,
-          line: location.start_line,
-          column: location.start_column
-        }
-
-        @references << reference
-      end
-    end
-  end
-end