ivar 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f9a15e9e7bb48429652a717400a82480167376802939f68873b575b3fca766f
-  data.tar.gz: f57d59b780e126287966c116fd83be4848bbbb05268591a3938262fb25395a08
+  metadata.gz: fab4b673955331785324df9526d8c6cbefc2fb2bfd5268364fabea167842deaa
+  data.tar.gz: 4a39dc2f3530e7292e613b9140cb668ee1755a55cf4da8676c6bc74da159a20d
 SHA512:
-  metadata.gz: acc557b2df216279c16bfa299a13017eae33f52622a8f5ef75729b253f00a414f37b8a2e44ae935f3d761a1a02477b3978297751f1e94d39b90a2005fbe6d5fd
-  data.tar.gz: 8acf31444752ee0ef75ac3a4d197448b37cac3f193e8844c57545d6d222e9899586129df849ea3a5e29628608d07a0390591455c82bdbfea60e5bf8826c347dc
+  metadata.gz: e15519f99aa5c24bec436bc1365d5640eb64f31b91c901442105cd62da045b44d55a6537b73b8c8d405318afc430ce9cfa9060e99beb72368643f25933043327
+  data.tar.gz: 7f717746c49f99ee91757429bc0dfe0c568c9e4684bcb219a11224457b06fc3aac4dc59d40e3109b600b4bd0729c58c070bee874a25787f5802afdbb13cb5cf8

data/.augment-guidelines

@@ -2,9 +2,11 @@
 - use modern Ruby 3.4 style and features, including pattern-matching, endless methods, etc., where appropriate.
 - avoid over-engineering. Prefer basic Ruby data types to building new abstractions. (But extract abstractions when I tell you to.)
 - avoid inline comments. Prefer "explaining variables", intention-revealing method names, and the "composed method" pattern where appropriate. Class, module, and method-documenting comments are fine.
-- De-lint (with standardrb) before committing. Use auto-fix and manually fix the rest.
-- Run all tests and fix failures before committing. 
+- Code style is managed with standardrb. Run it (with script/de-lint) before committing. Manually fix the rest. script/lint can be used to check for issues without updating the code.
+- Run all tests and fix failures before committing.
 - Never "cheat" by making implementation code test-aware. But it is fine to make interactions with the world dependency-injectable for testing purposes.
 - Include a quote of my instruction that led to the commit in the commit message
 - Sign your commit messages with "-- Auggie".
-- Commit and push after making successful changes. 
+- Update the CHANGELOG.md unreleased section as appropriate
+- Commit and push after making successful changes.
+- In methods that get information and where mutation is not the goal, prefer a concise, functional-transformation style leveraging Enumerable methods over imperative approaches.

data/.devcontainer/devcontainer.json

@@ -1,22 +1,30 @@
 // See https://containers.dev/implementors/json_reference/ for configuration reference
 {
-	"name": "ivar",
-	"build": {
-		"dockerfile": "Dockerfile"
-	},
-	"remoteUser": "devcontainer",
-	"features": {
-		"ghcr.io/devcontainers/features/github-cli:1": {},
-		"ghcr.io/jungaretti/features/ripgrep:1": {}
-	},
-	"customizations": {
-		"vscode": {
-			"extensions": [
-				"connorshea.vscode-ruby-test-adapter",
-				"stripe.endsmart",
-				"testdouble.vscode-standard-ruby",
-				"castwide.solargraph",
-			]
-		}
-	}
-}
+  "name": "ivar",
+  "build": {
+    "dockerfile": "Dockerfile"
+  },
+  "remoteUser": "devcontainer",
+  "features": {
+    "ghcr.io/devcontainers/features/github-cli:1": {},
+    "ghcr.io/jungaretti/features/ripgrep:1": {}
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "connorshea.vscode-ruby-test-adapter",
+        "stripe.endsmart",
+        "testdouble.vscode-standard-ruby",
+        "castwide.solargraph",
+        "github.vscode-github-actions",
+        "Shopify.ruby-lsp",
+        "EditorConfig.EditorConfig"
+      ],
+      "settings": {
+        "standardRuby.commandPath": "/usr/local/bundle/bin/standardrb",
+        "solargraph.bundlerPath": "/usr/local/bin/bundle"
+      }
+    }
+  },
+  "postCreateCommand": "bash .devcontainer/post-create.sh"
+}

data/.devcontainer/post-create.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+set -e
+
+echo "Running post-create setup script..."
+
+# Install Ruby dependencies
+echo "Installing Ruby dependencies with bundle install..."
+bundle install
+
+# Install Git hooks
+echo "Installing Git hooks..."
+if [ -f "hooks/install.sh" ]; then
+  ./hooks/install.sh
+else
+  echo "Hooks installation script not found. Skipping."
+fi
+
+echo "Post-create setup completed successfully!"

data/.editorconfig

@@ -0,0 +1,35 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+
+# 2 space indentation for Ruby files
+[*.rb]
+indent_style = space
+indent_size = 2
+
+# 2 space indentation for YAML files
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2
+
+# 2 space indentation for JSON files
+[*.json]
+indent_style = space
+indent_size = 2
+
+# 2 space indentation for Gemfile and Rakefile
+[{Gemfile,Rakefile}]
+indent_style = space
+indent_size = 2
+
+# Markdown files
+[*.md]
+trim_trailing_whitespace = false

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_gem:
+  standard: config/base.yml
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false

data/.standard.yml

@@ -1,3 +1,3 @@
 # For available configuration options, see:
 #   https://github.com/testdouble/standard
-ruby_version: 3.4
+ruby_version: 3.3

data/.vscode/extensions.json

@@ -3,6 +3,8 @@
     "connorshea.vscode-ruby-test-adapter",
     "stripe.endsmart",
     "testdouble.vscode-standard-ruby",
-    "castwide.solargraph"
+    "castwide.solargraph",
+    "github.vscode-github-actions",
+    "qwtel.sqlite-viewer"
   ]
 }

data/.vscode/launch.json

@@ -0,0 +1,25 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "ruby_lsp",
+      "name": "Debug script",
+      "request": "launch",
+      "program": "ruby ${file}"
+    },
+    {
+      "type": "ruby_lsp",
+      "name": "Debug test",
+      "request": "launch",
+      "program": "ruby -Itest ${relativeFile}"
+    },
+    {
+      "type": "ruby_lsp",
+      "name": "Attach debugger",
+      "request": "attach"
+    }
+  ]
+}

data/.vscode/settings.json

@@ -2,13 +2,49 @@
   "rubyTestExplorer.testFramework": "minitest",
   "[ruby]": {
     "editor.formatOnType": true,
+    "editor.defaultFormatter": "Shopify.ruby-lsp",
+    "editor.formatOnSave": true
   },
   "editor.formatOnSave": true,
   "standardRuby.mode": "enableUnconditionally",
   "solargraph.diagnostics": true,
   "solargraph.formatting": true,
   "solargraph.useBundler": true,
-  "standardRuby.commandPath": "/usr/local/bundle/bin/standardrb",
   "rubyLsp.formatter": "standard",
   "standardRuby.autofix": true,
-}
+  "rubyLsp.enabledFeatures": {
+    "diagnostics": true,
+    "documentHighlights": true,
+    "documentLink": true,
+    "documentSymbols": true,
+    "foldingRanges": true,
+    "formatting": true,
+    "hover": true,
+    "inlayHint": true,
+    "onTypeFormatting": true,
+    "selectionRanges": true,
+    "semanticHighlighting": true,
+    "completion": true,
+    "codeLens": true,
+    "definition": true,
+    "workspaceSymbol": true,
+  },
+  "rubyLsp.rubyVersionManager": {
+    "identifier": "auto"
+  },
+  "rubyLsp.addonSettings": {
+    "rubocop": {
+      "command": "standardrb",
+      "except": []
+    }
+  },
+  "editor.detectIndentation": true,
+  "editor.insertFinalNewline": true,
+  "files.insertFinalNewline": true,
+  "files.trimTrailingWhitespace": true,
+  "editor.trimAutoWhitespace": true,
+  "files.eol": "\n",
+  "editor.codeActionsOnSave": {
+    "source.fixAll": "explicit"
+  }
+}

data/CHANGELOG.md

@@ -1,9 +1,91 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
 ## [Unreleased]
 
+### Fixed
+- Fixed GitHub Actions workflow to prevent "frozen Gemfile.lock" errors during gem publishing
+
+## [0.4.0] - 2025-05-07
+
+### Added
+- Support for initializing instance variables from keyword arguments using `ivar :@foo, init: :kwarg` or `ivar :@foo, init: :keyword`
+- Proper inheritance handling for keyword argument initialization, with child class declarations taking precedence over parent class declarations
+- Added Ivar::Manifest class to formalize tracking of instance variables
+- Added ExplicitDeclaration and ImplicitDeclaration classes to represent different types of variable declarations
+- Added callbacks for declarations: on_declare and before_init
+- Added CheckPolicy module to handle class-level check policy configuration
+- Added support for policy inheritance in subclasses
+- Added method stash abstraction with `stash_method`, `get_method_stash`, and `get_stashed_method` on the Ivar module
+- Added `get_or_create_manifest` method to make it clearer when a manifest may be created
+
+### Changed
+- Split declaration classes into separate files for better organization:
+  - `Declaration` → `lib/ivar/declaration.rb`
+  - `ExplicitDeclaration` → `lib/ivar/explicit_declaration.rb`
+  - `ExplicitKeywordDeclaration` → `lib/ivar/explicit_keyword_declaration.rb`
+  - `ExplicitPositionalDeclaration` → `lib/ivar/explicit_positional_declaration.rb`
+- Centralized handling of internal variables (those starting with `@__ivar_`) to avoid explicit declarations
+- Improved filtering of internal variables during analysis phase rather than validation phase
+- Refactored internal variable tracking to use the Manifest system
+- Removed backwards compatibility variables (@__ivar_declared_ivars, @__ivar_initial_values, @__ivar_init_methods)
+- Improved manifest ancestry handling to walk the entire ancestor chain instead of just the direct parent
+- Enhanced declaration inheritance to properly handle overrides from modules and included mixins
+- Optimized manifest ancestry to avoid creating unnecessary manifests for classes/modules that don't declare anything
+- Simplified Manifest class to use a single declarations hash instead of separate explicit and implicit declarations
+- Improved Manifest API with clearer separation between declarations (array of values) and declarations_by_name (hash)
+- Simplified initialization process by combining keyword argument handling into the before_init callback
+- Refactored Checked module to use the CheckPolicy module for policy configuration
+- Changed default policy for Checked module from :warn_once to :warn
+- Enhanced initialization process in Checked module to properly handle manifest processing
+- Simplified external-process tests to directly check for warnings in stderr instead of using custom capture logic
+- Updated TargetedPrismAnalysis and Checked::InstanceMethods to use the new method stash abstraction
+- Extracted modules from auto_check.rb into their own files and removed auto_check.rb
+- Removed PrismAnalysis class as it has been superseded by TargetedPrismAnalysis
+
+### Documentation
+- Improved documentation for the CheckPolicy module explaining its purpose and inheritance behavior
+- Enhanced documentation for the Checked module detailing its functionality and initialization process
+- Added comprehensive documentation for the Manifest#add_implicits method explaining its role in tracking instance variables
+- Added documentation for the new method stash abstraction methods
+
+## [0.3.2] - 2025-05-05
+
+## [0.3.1] - 2025-05-05
+
+## [0.3.0] - 2025-05-05
+
+### Added
+- Support for initializing multiple instance variables to the same value using `ivar :@foo, :@bar, value: 123`
+- Support for ivar declarations with a block that generates default values based on the variable name
+- Support for reader, writer, and accessor keyword arguments to automatically generate attr methods
+
+### Changed
+- Extracted check_all functionality to its own class (CheckAllManager) for better organization
+- Converted module instance variables to constants where appropriate
+- Moved scripts from bin/ to script/ directory for better organization
+- Improved development environment with consistent line endings and editor configuration
+
+### Fixed
+- Fixed missing trailing newlines in files
+- Fixed Gemfile.lock version synchronization
+- Fixed release script to use $stdin.gets instead of gets
+
+## [0.2.1] - 2025-05-05
+
+### Added
+- Release automation via GitHub Actions
+
 ## [0.2.0] - 2025-05-01
 
-- Added CheckDynamic module that overrides instance_variable_get/set to check against a list of allowed variables saved at the end of initialization
+### Added
+- CheckDynamic module that overrides instance_variable_get/set to check against a list of allowed variables saved at the end of initialization
 
 ## [0.1.0] - 2025-04-29
 
+### Added
 - Initial release