lazy_names 0.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7d0986ae45e667f52744c72afa5c79ed9adadd84
-  data.tar.gz: bfce318aab2ff6de0cf1a2147dc334011d03bab0
+SHA256:
+  metadata.gz: 4d4b509d7cf80a3a06d081c317071cd6fbe5108f86f4e5e3c73b6ad04919be47
+  data.tar.gz: c975ba3dba6e0c88ed1277e757284a1f98599b2387264285765451150efeb1b2
 SHA512:
-  metadata.gz: cfc61aaa924dbd3c67221000f7d38ac0445cc43fe8b14a3c16e9d8ea70dd5b40d95553d98e38777b5212ec7765c40d0155051dfc594347f8132f2f76091c2840
-  data.tar.gz: 5002c013d4d4537aeb12addace4a0c77001a655ca888e835e6344b0f5f1a5d1c946d122f333a7638cf5381d426b487f4031ee3fb8ba5948d2b182690970ac569
+  metadata.gz: 92841fbe989e3f7556d9dd1269f35bff70fc78b8f9b75762011f37d7510bda072f9d63e21fa23c427d968ae657acfb2241aeeef7cb29c8f0b7cc271447cb0ca6
+  data.tar.gz: d8d5b5031d35521f754bc9c27dd9db7af016a6a347bac8c0b777039094a33e6a9e76005879fb1806ae7e25c4c3a2cacccd2bdcfcd9b93c058ee523be31ca7dee

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

data/.github/workflows/codecov.yml

@@ -0,0 +1,24 @@
+---
+name: codecov
+'on':
+  push:
+    branches:
+      - master
+jobs:
+  codecov:
+    timeout-minutes: 15
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v6
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1
+          bundler-cache: true
+      - run: bundle config set --global path "$(pwd)/vendor/bundle"
+      - run: bundle install --no-color
+      - run: bundle exec rake
+      - uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage/.resultset.json
+          fail_ci_if_error: true

data/.github/workflows/codeql.yml

@@ -0,0 +1,98 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL Advanced"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+  schedule:
+    - cron: '40 18 * * 3'
+
+jobs:
+  analyze:
+    name: Analyze (${{ matrix.language }})
+    # Runner size impacts CodeQL analysis time. To learn more, please see:
+    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
+    #   - https://gh.io/supported-runners-and-hardware-resources
+    #   - https://gh.io/using-larger-runners (GitHub.com only)
+    # Consider using larger runners or machines with greater resources for possible analysis time improvements.
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    permissions:
+      # required for all workflows
+      security-events: write
+
+      # required to fetch internal or private CodeQL packs
+      packages: read
+
+      # only required for workflows in private repositories
+      actions: read
+      contents: read
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - language: ruby
+          build-mode: none
+        # CodeQL supports the following values keywords for 'language': 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'
+        # Use `c-cpp` to analyze code written in C, C++ or both
+        # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
+        # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
+        # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
+        # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
+        # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
+        # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v6
+
+    # Add any setup steps before running the `github/codeql-action/init` action.
+    # This includes steps like installing compilers or runtimes (`actions/setup-node`
+    # or others). This is typically only required for manual builds.
+    # - name: Setup runtime (example)
+    #   uses: actions/setup-example@v1
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v4
+      with:
+        languages: ${{ matrix.language }}
+        build-mode: ${{ matrix.build-mode }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+    # If the analyze step fails for one of the languages you are analyzing with
+    # "We were unable to automatically build your code", modify the matrix above
+    # to set the build mode to "manual" for that language. Then modify this step
+    # to build your code.
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+    - if: matrix.build-mode == 'manual'
+      shell: bash
+      run: |
+        echo 'If you are using a "manual" build mode for one or more of the' \
+          'languages you are analyzing, replace this with the commands to build' \
+          'your code, for example:'
+        echo '  make bootstrap'
+        echo '  make release'
+        exit 1
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v4
+      with:
+        category: "/language:${{matrix.language}}"

data/.github/workflows/rake.yml

@@ -0,0 +1,24 @@
+---
+name: rake
+'on':
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  rake:
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v6
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+          bundler-cache: true
+      - run: bundle config set --global path "$(pwd)/vendor/bundle"
+      - run: bundle install --no-color
+      - run: bundle exec rake

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+*.gem

data/.lazy_names.tt.rb

@@ -0,0 +1,5 @@
+# project specific
+MUCC = Models::Users::CreditCard
+
+# global
+ARBase = ActiveRecord::Base

data/.rubocop.yml

@@ -1,5 +1,10 @@
-Style/FrozenStringLiteralComment:
-  Enabled: false
+plugins:
+- rubocop-rake
+- rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
 
 # Good documentation welcome, but not required
 Style/Documentation:
@@ -17,9 +22,6 @@ Style/HashTransformKeys:
 Style/HashTransformValues:
   Enabled: false
 
-Security/Eval:
-  Enabled: false
-
 Style/LambdaCall:
   Enabled:
     EnforcedStyle: braces
@@ -27,10 +29,6 @@ Style/LambdaCall:
 Style/RedundantSelf:
   Enabled: false
 
-Style/MultilineMethodCallIndentation:
-  Enabled:
-    EnforcedStyle: indented
-
 Layout/LineLength:
   Enabled:
     max: 100
@@ -39,6 +37,43 @@ Metrics/BlockLength:
   Exclude:
     - spec/**/*.rb
 
+Metrics/MethodLength:
+  Max: 15
+
 Metrics/AbcSize:
+  Max: 20
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+RSpec/ExampleLength:
+  Max: 20
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/RemoveConst:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false
+
+Security/Eval:
+  Exclude:
+    - spec/**/*.rb
+
+Style/FrozenStringLiteralComment:
   Exclude:
-    - lib/lazy_names.rb
+    - .lazy_names.tt.rb

data/.ruby-version

@@ -1 +1 @@
-2.3.3
+3.1.4

data/Gemfile

@@ -1,6 +1,16 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-# Specify your gem's dependencies in lazy_names.gemspec
 gemspec
+
+gem 'bundler', '~> 2.1', require: false
+gem 'pry', '~> 0.13', require: false
+gem 'rake', '~> 12.3', require: false
+gem 'rspec', '~> 3.0', require: false
+gem 'rubocop', '~> 1.72', require: false
+gem 'rubocop-rake', require: false
+gem 'rubocop-rspec', require: false
+gem 'simplecov', '0.22.0', require: false

data/Gemfile.lock

@@ -1,41 +1,87 @@
 PATH
   remote: .
   specs:
-    lazy_names (0.2.0)
+    lazy_names (2.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.2)
     coderay (1.1.3)
-    diff-lcs (1.3)
-    method_source (1.0.0)
-    pry (0.13.1)
+    diff-lcs (1.5.1)
+    docile (1.4.1)
+    json (2.10.2)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    method_source (1.1.0)
+    parallel (1.26.3)
+    parser (3.3.7.1)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    regexp_parser (2.10.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.72.2)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
+      parser (>= 3.3.1.0)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.5.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.1)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
 
 PLATFORMS
+  arm64-darwin-23
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2.1)
   lazy_names!
   pry (~> 0.13)
-  rake (~> 10.0)
+  rake (~> 12.3)
   rspec (~> 3.0)
+  rubocop (~> 1.72)
+  rubocop-rake
+  rubocop-rspec
+  simplecov (= 0.22.0)
 
 BUNDLED WITH
-   1.16.3
+   2.6.5

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Zhdanov
+Copyright (c) 2020 Evgeny Zhdanov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/MIGRATION_FROM_V1.md

@@ -0,0 +1,276 @@
+# Migration Guide: v1.x to v2.0
+
+This guide will help you migrate from LazyNames v1.x (YAML configuration) to v2.0 (Ruby configuration).
+
+## Overview
+
+LazyNames v2.0 removes YAML support in favor of plain Ruby configuration files. This change makes the gem more intuitive and Ruby-native.
+
+## Why the Change?
+
+As discussed in the original issue, `.irbrc` and `.pryrc` already support plain Ruby. The YAML abstraction was unnecessary when you can simply write:
+
+```ruby
+MUCC = Models::Users::CreditCard
+```
+
+Instead of:
+
+```yaml
+---
+definitions:
+  'Models::Users::CreditCard': 'MUCC'
+```
+
+## Breaking Changes
+
+- ❌ `.lazy_names.yml` is no longer supported
+- ✅ You must use `.lazy_names.rb` instead
+- ✅ Constants are validated at load time (mandatory)
+
+## Quick Conversion
+
+### Before (v1.x)
+
+**.lazy_names.yml**:
+```yaml
+---
+definitions:
+  'Models::User': 'MU'
+  'Services::EmailSender': 'SES'
+  'Controllers::API::V1::UsersController': 'CAVUC'
+```
+
+### After (v2.0)
+
+**.lazy_names.rb**:
+```ruby
+MU = Models::User
+SES = Services::EmailSender
+CAVUC = Controllers::API::V1::UsersController
+```
+
+## Automated Conversion Script
+
+Save this as `convert_to_v2.rb` and run it in your project directory:
+
+```ruby
+#!/usr/bin/env ruby
+require 'yaml'
+
+yaml = YAML.load_file('.lazy_names.yml')
+definitions = yaml['definitions'] || yaml.values.first['definitions']
+
+File.open('.lazy_names.rb', 'w') do |f|
+  f.puts "# Converted from .lazy_names.yml"
+  definitions.each do |full, short|
+    f.puts "#{short} = #{full}"
+  end
+end
+
+puts "✓ Converted to .lazy_names.rb"
+```
+
+### Using the Conversion Script
+
+1. Run the script in your project directory:
+   ```bash
+   ruby convert_to_v2.rb
+   ```
+
+2. Review the generated `.lazy_names.rb`:
+   ```bash
+   cat .lazy_names.rb
+   ```
+
+3. Test it in your console:
+   ```bash
+   bundle exec rails c
+   # or
+   bin/console
+   ```
+
+4. Once verified, delete the old YAML file:
+   ```bash
+   rm .lazy_names.yml
+   ```
+
+## Global Configuration Migration
+
+If you have a global configuration in `~/.lazy_names.yml` with namespace/project scoping:
+
+### Before
+
+**~/.lazy_names.yml**:
+```yaml
+---
+my_project:
+  definitions:
+    'Models::User': 'MU'
+another_project:
+  definitions:
+    'API::Client': 'AC'
+```
+
+### Namespace Scoping Is Intentionally Removed
+
+v2.0 **does not support** namespace/project scoping in global config files. This was a deliberate decision:
+
+- **It was YAML-induced complexity.** YAML encourages nested structures, but Ruby doesn't need this abstraction.
+- **Project detection is fragile.** Matching project names to directories adds magic that can break.
+- **Project-specific files are better.** Each project having its own `.lazy_names.rb` is more explicit and maintainable.
+
+### After: Use Project-Specific Files (Recommended)
+
+**This is the preferred migration path.** Create `.lazy_names.rb` in each project directory:
+
+```ruby
+# my_project/.lazy_names.rb
+MU = Models::User
+```
+
+```ruby
+# another_project/.lazy_names.rb
+AC = API::Client
+```
+
+Benefits:
+- Version controlled with each project
+- Explicit about what's loaded
+- No surprises or magic detection
+- Easy to understand and maintain
+
+### Alternative: Global File with Guards
+
+If you prefer a single global file, use `if defined?()` guards:
+
+**~/.lazy_names.rb**:
+```ruby
+# Only defined if the constant exists in the current project
+MU = Models::User if defined?(Models::User)
+AC = API::Client if defined?(API::Client)
+```
+
+This achieves the same result as namespace scoping but is simpler and more transparent.
+
+## New Features in v2.0
+
+### Validation
+
+All constants are now validated before being defined:
+
+```ruby
+# Valid - will be defined
+MU = Models::User
+
+# Invalid - will show warning and skip
+INVALID = NonExistent::Class
+# Warning: Line 4: Constant NonExistent::Class not found - INVALID = NonExistent::Class
+```
+
+### Comments and Formatting
+
+```ruby
+# You can add comments to document your shortcuts
+MU = Models::User
+
+# Blank lines are allowed for organization
+
+SES = Services::EmailSender
+
+# Underscores and numbers work too
+API_V1 = API::V1
+CACHE2 = Cache::RedisCache
+```
+
+### Better Error Messages
+
+v2.0 provides detailed error messages with line numbers:
+
+```
+Loading definitions from /path/to/.lazy_names.rb
+Line 5: Constant Foo::Bar not found - FB = Foo::Bar
+Loaded 10 definitions
+Skipped 1 invalid lines
+```
+
+## Troubleshooting
+
+### "Constant not found" warnings
+
+If you see warnings about constants not being found:
+
+1. **Make sure the constant exists** in your application
+2. **Check the spelling** - constant names are case-sensitive
+3. **Ensure the constant is loaded** before LazyNames runs
+
+Example:
+```ruby
+# This will fail if Models isn't loaded yet
+MU = Models::User
+
+# This is safer - only define if it exists
+MU = Models::User if defined?(Models::User)
+```
+
+### Constants not defined in console
+
+If constants aren't showing up in your console:
+
+1. Check that `.lazy_names.rb` is in the right location:
+   - Project root: `./.lazy_names.rb`
+   - Home directory: `~/.lazy_names.rb`
+
+2. Verify your IRB/Pry configuration is correct:
+
+   **For Pry** (`~/.pryrc` or `.pryrc`):
+   ```ruby
+   if defined?(LazyNames)
+     Pry.config.hooks.add_hook(:when_started, :lazy_names) do
+       LazyNames.load_definitions!
+     end
+   end
+   ```
+
+   **For IRB** (`~/.irbrc` or `.irbrc`):
+   ```ruby
+   if defined?(LazyNames)
+     LazyNames.load_definitions!
+   end
+   ```
+
+3. Make sure you've updated to v2.0:
+   ```bash
+   bundle update lazy_names
+   ```
+
+### Migration script errors
+
+If the conversion script fails:
+
+**Error: No .lazy_names.yml found**
+- Make sure you're in the correct directory
+- Check if the file is named exactly `.lazy_names.yml`
+
+**Error: .lazy_names.rb already exists**
+- Review the existing file
+- Delete it if you want to regenerate: `rm .lazy_names.rb`
+- Or merge manually
+
+## Need Help?
+
+If you encounter issues during migration:
+
+1. Check the [README](README.md) for configuration examples
+2. Review the [implementation plan](MIGRATION_PLAN_V2.md) for technical details
+3. Open an issue on [GitHub](https://github.com/zhisme/lazy_names/issues)
+
+## Benefits of v2.0
+
+After migrating, you'll enjoy:
+
+- ✅ **More intuitive** - Same syntax as `.irbrc`/`.pryrc`
+- ✅ **Better IDE support** - Syntax highlighting and autocomplete
+- ✅ **Mandatory validation** - Know immediately if a constant doesn't exist
+- ✅ **Simpler** - No YAML parsing overhead
+- ✅ **Ruby-native** - Write Ruby to configure Ruby