lazy_names 0.2.0 → 2.0.0

data/README.md

@@ -1,6 +1,13 @@
+[![rake](https://github.com/zhisme/lazy_names/actions/workflows/rake.yml/badge.svg)](https://github.com/zhisme/lazy_names/actions/workflows/rake.yml)
+[![Gem Version](https://badge.fury.io/rb/lazy_names.svg?icon=si%3Arubygems)](https://badge.fury.io/rb/lazy_names)
+![Gem Total Downloads](https://img.shields.io/gem/dt/lazy_names)
+[![Hits-of-Code](https://hitsofcode.com/github/zhisme/lazy_names?branch=master)](https://hitsofcode.com/github/zhisme/lazy_names/view?branch=master)
+[![codecov](https://codecov.io/gh/zhisme/lazy_names/graph/badge.svg?token=ZQXGBALJSK)](https://codecov.io/gh/zhisme/lazy_names)
+![GitHub License](https://img.shields.io/github/license/zhisme/lazy_names)
+
 # lazy_names
 
-LazyNames helps programmer to type faster very-long class names, constants by defining them on a shorter version.
+lazy_names helps programmer to type faster very-long class names constants by defining them on a shorter version.
 If you are lazy like me typing many times a day in console long constants then this gem will ease your development process.
 
 ## Why
@@ -8,6 +15,18 @@ If you are lazy like me typing many times a day in console long constants then t
 Consider this example from pry terminal session.
 ![Lazy names in action](https://media.giphy.com/media/7CtRJfp2yocsOu9zEA/source.gif)
 
+The idea is to reduce typing of long namespaced constants to shorter versions. It's very useful when you have a lot of nested namespaces and you need to access them frequently. This gem will take your responsibility to redefine constants to shorter versions and making constant/classes validations.
+
+## Why Plain Ruby? (v2.0+)
+
+LazyNames v2.0 uses plain Ruby instead of YAML because:
+
+- ✅ **Intuitive**: Same syntax you'd write in `.irbrc`/`.pryrc`
+- ✅ **IDE Support**: Syntax highlighting and autocomplete work out of the box
+- ✅ **Validation**: Constants are validated at load time
+- ✅ **Simpler**: No YAML parsing, no extra abstraction
+- ✅ **Ruby-native**: Write Ruby to configure Ruby
+
 ## Installation
 
 1. Add this line to your application's Gemfile:
@@ -44,7 +63,9 @@ bundle
 
 4. Create your own lazy_names config where you define constants
 ```bash
-cp .lazy_names.tt.yml ~/.lazy_names.yml
+touch ~/.lazy_names.rb
+# or for project-specific config
+touch .lazy_names.rb
 ```
 
 5. Login into your rails or non-rails console
@@ -55,67 +76,105 @@ $ bundle exec rails c # or bin/console
 
 ## Configuration
 
-### Global definition
+Create a `.lazy_names.rb` file in your project root or home directory:
+
+```ruby
+# .lazy_names.rb
+MUCC = Models::Users::CreditCard
+SPP = Services::PaymentProcessor
+CAVUC = Controllers::API::V1::UsersController
+```
+
+### File Lookup Priority
+
+LazyNames looks for configuration in this order:
+
+1. `./.lazy_names.rb` (project-specific) — **recommended**
+2. `~/.lazy_names.rb` (global fallback)
+
+### Project-Specific Configuration (Recommended)
 
-Take a look onto `lazy_names.tt.yml` it has very basic template for you to start.
+**This is the preferred approach.** Create `.lazy_names.rb` in your project root:
 
-```yml
----
-my_awesome_project:
-  definitions:
-    'Models::Users::CreditCard': 'MUCC'
+```ruby
+# myproject/.lazy_names.rb
+MUCC = Models::Users::CreditCard
+SPP = Services::PaymentProcessor
 ```
-`my_awesome_project` should be you project/folder name
 
-So consider this example:
+Why project-specific files are better:
+- Version controlled with your project (or gitignored for personal shortcuts)
+- Explicit about what's loaded — no surprises
+- Each project has exactly the shortcuts it needs
+- No conflicts between projects
+
+Don't forget to add it to `.gitignore` if you don't want to share:
 ```sh
-$ pwd
-/Users/name/my_awesome_project
-```
-The last folder name of you ruby project must match the same one in your configuration.
-After **definitions** sections you can actually redefine your long constants.
-So in this example `Models::Users::CreditCard` is your real project constant and
-`MUCC` will be your short variant of it, so you can access `Models::Users::CreditCard`
-from `MUCC`. `MUCC` and any other right hand side can be any value, you define the best-suitable names.
-
-You can define as many constants as you want. The same rule applies for projects.
-Your config can have multiple constant definitions per namespace.
-```yml
----
-my_awesome_project:
-  definitions:
-    'Models::Users::CreditCard': 'MUCC'
-my_another_project:
-  definitions:
-    'OtherLongConst': 'Short'
+echo '.lazy_names.rb' >> .gitignore
 ```
 
-### Project definitions
+### Global Configuration
 
-In the meantime you can put your `.lazy_names.yml` config directly to project folder, it will be looked up firstly from project.
-Just do not forget to put in your `.gitignore`. I believe every developer defines shorter versions of constants by his own opinion.
-```sh
-echo '.lazy_names.yml' >> .gitignore
+For shortcuts that work across multiple projects, create `~/.lazy_names.rb` in your home directory.
+
+**Important:** Use `if defined?()` guards since constants vary between projects:
+
+```ruby
+# ~/.lazy_names.rb
+# Generic Rails shortcuts (usually available)
+AR = ActiveRecord if defined?(ActiveRecord)
+AM = ActionMailer if defined?(ActionMailer)
+
+# Only defined if these exist in the current project
+MU = Models::User if defined?(Models::User)
 ```
-If project folder doesn't contain any `.lazy_names.yml`, it will fallback to home directory.
 
-Configuration per project a bit different: you don't need to specify global scope `my_awesome_project`, you can skip forward to definitions
-```yml
----
-definitions:
-  'Models::Users::CreditCard: 'MUCC'
+**Note:** v2.0 intentionally removed namespace/project scoping that existed in v1.x YAML configs. The `if defined?()` pattern is simpler and achieves the same result without magic.
+
+### Validation
+
+LazyNames validates each line:
+
+- ✅ Must be a constant assignment: `SHORT = Full::Constant::Path`
+- ✅ Constant must exist in your application
+- ⚠️ Invalid lines are skipped with a warning
+
+### Examples
+
+```ruby
+# Comments are allowed
+MUCC = Models::Users::CreditCard
+
+# Blank lines are fine
+
+SPP = Services::PaymentProcessor
+
+# Underscores and numbers in short names
+API_V1 = API::V1
+CACHE2 = Cache::RedisCache
 ```
-Example config can be found in `.lazy_names.tt.project.yml`
+
+## Migrating from v1.x to v2.0
+
+LazyNames v2.0 removes YAML support in favor of plain Ruby configuration.
+
+**Upgrading from v1.x?** See the complete [Migration Guide](MIGRATION_FROM_V1.md) for:
+- Automated conversion script
+- Step-by-step instructions
+- Troubleshooting tips
+- New features in v2.0
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After you make changes ensure to run `rake rubocop` to check if your code meets linter standards.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/zhisme/lazy_names.
+Ensure the CI build is green by validating tests are passing and coverage is not decreased.
 
 ## License
 

data/Rakefile

@@ -1,6 +1,12 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+task default: %i[clean rubocop spec]
 
-task default: :spec
+desc 'Run RuboCop'
+RuboCop::RakeTask.new(:rubocop)
+
+RSpec::Core::RakeTask.new(:spec)

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'lazy_names'

data/bin/convert_to_v2

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'yaml'
+
+# rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+def convert_yaml_to_ruby
+  yaml_file = '.lazy_names.yml'
+  ruby_file = '.lazy_names.rb'
+
+  unless File.exist?(yaml_file)
+    puts "No #{yaml_file} found in current directory"
+    exit 1
+  end
+
+  if File.exist?(ruby_file)
+    puts "#{ruby_file} already exists. Remove it first or merge manually."
+    exit 1
+  end
+
+  begin
+    yaml = YAML.load_file(yaml_file)
+    definitions = extract_definitions(yaml)
+
+    if definitions.empty?
+      puts "No definitions found in #{yaml_file}"
+      exit 1
+    end
+
+    File.open(ruby_file, 'w') do |f|
+      f.puts '# Converted from .lazy_names.yml'
+      f.puts ''
+      definitions.each do |full, short|
+        f.puts "#{short} = #{full}"
+      end
+    end
+
+    puts "✓ Converted #{definitions.size} definitions to #{ruby_file}"
+    puts ''
+    puts 'Next steps:'
+    puts "  1. Review #{ruby_file}"
+    puts "  2. Delete #{yaml_file}"
+    puts '  3. Update lazy_names gem to v2.0'
+  rescue StandardError => e
+    puts "Error: #{e.message}"
+    exit 1
+  end
+end
+# rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+def extract_definitions(yaml)
+  if yaml['definitions']
+    yaml['definitions']
+  elsif yaml.is_a?(Hash) && yaml.values.first.is_a?(Hash)
+    yaml.values.first['definitions'] || {}
+  else
+    {}
+  end
+end
+
+convert_yaml_to_ruby

data/lazy_names.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'lazy_names/version'
@@ -9,10 +11,10 @@ Gem::Specification.new do |spec|
   spec.email = ['evdev34@gmail.com']
 
   spec.description = <<~DESC
-    lazy_names is ruby programmer friend. You can save your time not typing long
-    error-phone constants/classes but defining short and nice versions of them.
+    lazy_names is ruby programmer friend. Define short aliases for long constant names using plain Ruby.
+    Save your time not typing long constants/classes by defining short and intuitive versions of them.
   DESC
-  spec.summary = 'Define short constants to frequently used classes/constants'
+  spec.summary = 'Define short aliases for long constant names using plain Ruby'
   spec.homepage = 'https://github.com/zhisme/lazy_names'
   spec.license = 'MIT'
 
@@ -23,9 +25,6 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'pry', '~> 0.13'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.required_ruby_version = '>= 2.3.3'
+  spec.required_ruby_version = '>= 2.7'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/lazy_names/line_validator.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module LazyNames
+  class LineValidator
+    ASSIGNMENT_PATTERN = /\A\s*([A-Z][A-Z0-9_]*)\s*=\s*([A-Z][A-Za-z0-9_:]*)\s*\z/.freeze
+
+    class ValidationResult
+      attr_reader :valid, :short_name, :full_constant, :error
+
+      def initialize(valid:, short_name: nil, full_constant: nil, error: nil)
+        @valid = valid
+        @short_name = short_name
+        @full_constant = full_constant
+        @error = error
+      end
+
+      def valid?
+        @valid
+      end
+    end
+
+    def self.validate(line)
+      return skip_result if skip_line?(line)
+
+      match = line.match(ASSIGNMENT_PATTERN)
+      return invalid_result('Invalid syntax') unless match
+
+      short_name = match[1]
+      full_constant = match[2]
+
+      return invalid_result("Constant #{full_constant} not found") unless constant_exists?(full_constant)
+
+      ValidationResult.new(
+        valid: true,
+        short_name: short_name,
+        full_constant: full_constant
+      )
+    end
+
+    def self.skip_line?(line)
+      line.strip.empty? || line.strip.start_with?('#')
+    end
+
+    def self.constant_exists?(constant_path)
+      Object.const_get(constant_path)
+      true
+    rescue NameError
+      false
+    end
+
+    def self.skip_result
+      ValidationResult.new(valid: false)
+    end
+
+    def self.invalid_result(error)
+      ValidationResult.new(valid: false, error: error)
+    end
+
+    private_class_method :skip_line?, :constant_exists?, :skip_result, :invalid_result
+  end
+end

data/lib/lazy_names/ruby_loader.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module LazyNames
+  class RubyLoader
+    CONFIG_FILE = '.lazy_names.rb'
+
+    def self.load!(binding)
+      new.load!(binding)
+    end
+
+    def initialize
+      @loaded_count = 0
+      @skipped_count = 0
+      @error_count = 0
+    end
+
+    def load!(binding)
+      path = find_config_file
+      unless path
+        Kernel.warn("No #{CONFIG_FILE} found")
+        return
+      end
+
+      puts "Loading definitions from #{path}"
+
+      File.readlines(path).each_with_index do |line, index|
+        line_number = index + 1
+        process_line(line, line_number, binding)
+      end
+
+      log_summary
+    end
+
+    private
+
+    def find_config_file
+      project_config = File.join(Dir.pwd, CONFIG_FILE)
+      return project_config if File.exist?(project_config)
+
+      home_config = File.join(Dir.home, CONFIG_FILE)
+      return home_config if File.exist?(home_config)
+
+      nil
+    end
+
+    def process_line(line, line_number, binding)
+      result = LineValidator.validate(line)
+
+      if result.valid?
+        eval_line(line, binding)
+        @loaded_count += 1
+      elsif result.error
+        Kernel.warn("Line #{line_number}: #{result.error} - #{line.strip}")
+        @error_count += 1
+      else
+        # Blank line or comment - skip silently
+        @skipped_count += 1
+      end
+    rescue StandardError => e
+      Kernel.warn("Line #{line_number}: #{e.message}")
+      @error_count += 1
+    end
+
+    def eval_line(line, binding)
+      binding.eval(line)
+    end
+
+    def log_summary
+      puts "Loaded #{@loaded_count} definitions" if @loaded_count.positive?
+      Kernel.warn("Skipped #{@error_count} invalid lines") if @error_count.positive?
+    end
+  end
+end

data/lib/lazy_names/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LazyNames
-  VERSION = '0.2.0'.freeze
+  VERSION = '2.0.0'
 end

data/lib/lazy_names.rb

@@ -1,21 +1,11 @@
-require 'lazy_names/version'
-require 'lazy_names/find_namespace'
-require 'lazy_names/config_loader'
-require 'lazy_names/config'
-require 'lazy_names/config_validator'
-require 'lazy_names/definer'
-require 'lazy_names/logger'
+# frozen_string_literal: true
+
+require_relative 'lazy_names/version'
+require_relative 'lazy_names/line_validator'
+require_relative 'lazy_names/ruby_loader'
 
 module LazyNames
   def self.load_definitions!(top_level_binding = TOPLEVEL_BINDING)
-    basic_config = LazyNames::ConfigLoader
-      .(namespace: LazyNames::FindNamespace.())
-    config = LazyNames::Config.new(basic_config.definitions, basic_config.path)
-    config.validate!
-    LazyNames::Definer.(config, top_level_binding)
-
-    LazyNames::Logger.warn_undefined(config.errors.undefined, config.path)
-    LazyNames::Logger.warn_duplicate_definition(config.errors.already_defined, config.path)
-    LazyNames::Logger.warn_empty_definitions(config.constants.to_a.empty?, config.path)
+    RubyLoader.load!(top_level_binding)
   end
 end

metadata

@@ -1,107 +1,52 @@
 --- !ruby/object:Gem::Specification
 name: lazy_names
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - zhisme
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-19 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+date: 2026-01-12 00:00:00.000000000 Z
+dependencies: []
 description: |
-  lazy_names is ruby programmer friend. You can save your time not typing long
-  error-phone constants/classes but defining short and nice versions of them.
+  lazy_names is ruby programmer friend. Define short aliases for long constant names using plain Ruby.
+  Save your time not typing long constants/classes by defining short and intuitive versions of them.
 email:
 - evdev34@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/codecov.yml"
+- ".github/workflows/codeql.yml"
+- ".github/workflows/rake.yml"
 - ".gitignore"
-- ".lazy_names.tt.project.yml"
-- ".lazy_names.tt.yml"
+- ".lazy_names.tt.rb"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
+- MIGRATION_FROM_V1.md
 - README.md
 - Rakefile
 - bin/console
+- bin/convert_to_v2
 - bin/setup
 - lazy_names.gemspec
 - lib/lazy_names.rb
-- lib/lazy_names/config.rb
-- lib/lazy_names/config_loader.rb
-- lib/lazy_names/config_validator.rb
-- lib/lazy_names/definer.rb
-- lib/lazy_names/find_namespace.rb
-- lib/lazy_names/logger.rb
+- lib/lazy_names/line_validator.rb
+- lib/lazy_names/ruby_loader.rb
 - lib/lazy_names/version.rb
 homepage: https://github.com/zhisme/lazy_names
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -110,16 +55,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.3
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.5.2
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
-summary: Define short constants to frequently used classes/constants
+summary: Define short aliases for long constant names using plain Ruby
 test_files: []

data/.lazy_names.tt.project.yml

@@ -1,3 +0,0 @@
----
-definitions:
-  'Models::Users::CreditCard': 'MUCC'

data/.lazy_names.tt.yml

@@ -1,4 +0,0 @@
----
-my_awesome_project:
-  definitions:
-    'Models::Users::CreditCard': 'MUCC'

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.3.3
-before_install: gem install bundler -v 1.16.3

data/lib/lazy_names/config.rb

@@ -1,40 +0,0 @@
-module LazyNames
-  class Config
-    extend Forwardable
-
-    attr_reader :path, :validator
-
-    def_delegator :@validator, :errors
-
-    def initialize(definitions, path)
-      @definitions = definitions
-      @path = path
-      @validator = ConfigValidator.new(definitions.values, definitions.keys)
-    end
-
-    def constants
-      definitions.keys
-    end
-
-    def lazy_names
-      definitions.values
-    end
-
-    def lazy_name(name)
-      definitions[name]
-    end
-
-    def validate!
-      validator.()
-      remove_invalid_definitions!
-    end
-
-    private
-
-    def remove_invalid_definitions!
-      errors.undefined.each { |name| definitions.delete(name) }
-    end
-
-    attr_reader :definitions
-  end
-end