envalit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a43f0111d8c9a7a9a472808e4e44ab866772c41459eb1779ed1dec6f945470a
+  data.tar.gz: faa3025386293f3e5a93ff189204353c15442a400bcc17c14fdce28e30ed8bf9
+SHA512:
+  metadata.gz: 95abf06a5c7e809dcb97a89a6efefd81095baa42e118a5ce0a0aa474a2bebd8a0eeaf94002c17b1de113dc3770c29dc3851701ddd1562aa357833efe8b6a6c0d
+  data.tar.gz: c2700ee464c75219a4f32831180742b642cda50cb5c875ace9afd24e055ab6c8643421de6349466a8f3d5fc87e628ca4c3e678fde00206b08d511b3bbef21e5b

data/.mise.toml

@@ -0,0 +1,2 @@
+[tools]
+ruby = "3.4.2"

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,50 @@
+# AllCops
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 3.0
+
+# Style/FrozenStringLiteralComment
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+
+# Layout/LineLength
+Layout/LineLength:
+  Max: 120
+
+# Naming/FileName
+Naming/FileName:
+  Enabled: true
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
+# Layout/IndentationWidth
+Layout/IndentationWidth:
+  Width: 2
+
+# Style/StringLiterals
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# Lint/UselessAssignment
+Lint/UselessAssignment:
+  Enabled: true
+
+# Metrics/AbcSize
+Metrics/AbcSize:
+  Max: 100
+
+# Metrics/BlockLength
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+# Metrics/MethodLength
+Metrics/MethodLength:
+  Max: 100
+
+# Naming/AccessorMethodName
+Naming/AccessorMethodName:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.4.2

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# 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]
+
+## [0.1.0] - 2024-04-08
+
+### Added
+- Initial release
+- Environment variable validation with type checking (string, integer, boolean, float)
+- Support for required/optional variables
+- Support for strict validation mode
+- Support for default values
+- Support for variable descriptions
+- Automatic .env file loading
+- Rails generator for easy setup
+- Colored error messages for better visibility
+- Helpful error messages with fix suggestions
+- Integration with dotenv for .env file handling
+
+[Unreleased]: https://github.com/bugloper/envalit/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/bugloper/envalit/releases/tag/v0.1.0

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "pry"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop"
+gem "ruby-lsp", "~> 0.23.6"
+gem "webmock"

data/Gemfile.lock

@@ -0,0 +1,117 @@
+PATH
+  remote: .
+  specs:
+    envalit (0.1.0)
+      dotenv (~> 3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.2)
+    bigdecimal (3.1.9)
+    coderay (1.1.3)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.6.0)
+    dotenv (3.1.7)
+    hashdiff (1.1.2)
+    json (2.10.2)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    logger (1.6.6)
+    method_source (1.1.0)
+    parallel (1.26.3)
+    parser (3.3.7.1)
+      ast (~> 2.4.1)
+      racc
+    prism (1.3.0)
+    pry (0.15.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rbs (3.8.1)
+      logger
+    regexp_parser (2.10.0)
+    rexml (3.4.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.74.0)
+      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.1)
+      parser (>= 3.3.1.0)
+    rubocop-capybara (2.22.1)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-factory_bot (2.27.1)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (2.31.0)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.29.1)
+      rubocop (~> 1.61)
+    ruby-lsp (0.23.11)
+      language_server-protocol (~> 3.17.0)
+      prism (>= 1.2, < 2.0)
+      rbs (>= 3, < 4)
+      sorbet-runtime (>= 0.5.10782)
+    ruby-progressbar (1.13.0)
+    sorbet-runtime (0.5.11930)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    webmock (3.25.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.37)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  envalit!
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 2.26)
+  ruby-lsp (~> 0.23.6)
+  webmock
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.6.5

data/README.md

@@ -0,0 +1,192 @@
+# Envalit
+
+[![Gem Version](https://badge.fury.io/rb/envalit.svg)](https://badge.fury.io/rb/envalit)
+[![Build Status](https://github.com/bugloper/envalit/workflows/Ruby%20Setup/badge.svg)](https://github.com/bugloper/envalit/actions)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+Envalit is a powerful Ruby gem for managing and validating environment variables in your applications. It provides a flexible way to ensure all required environment variables are present and correctly typed, with options for warnings or strict validation.
+
+## Features
+
+- 🔍 **Type Validation**: Support for string, integer, boolean, and float types
+- 🚨 **Validation Modes**: Choose between warning or strict error modes
+- 📝 **Default Values**: Set fallback values for optional variables
+- 📚 **Documentation**: Add descriptions to document your environment variables
+- 🌈 **Colored Output**: Clear, colorized error messages for better visibility
+- 🚀 **Rails Integration**: Easy setup with Rails generator
+- 📁 **Dotenv Integration**: Automatic loading of `.env` files
+- 💡 **Helpful Errors**: Clear error messages with fix suggestions
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'envalit'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install envalit
+```
+
+### Rails Setup
+
+If you're using Rails, you can use our generator to quickly set up your environment configuration:
+
+```bash
+$ rails generate envalit:install
+```
+
+This will:
+1. Create `config/initializers/envalit.rb` with example configurations
+2. Create `.env.example` with sample environment variables
+
+## Usage
+
+### Basic Configuration
+
+```ruby
+require 'envalit'
+
+Envalit.configure do |config|
+  # Required variable with type validation
+  config.register "DATABASE_URL",
+                 required: true,
+                 strict: true,
+                 description: "PostgreSQL connection URL"
+
+  # Optional variable with default value
+  config.register "PORT",
+                 type: :integer,
+                 default: 3000,
+                 description: "Application port number"
+
+  # Boolean flag
+  config.register "DEBUG_MODE",
+                 type: :boolean,
+                 default: false,
+                 description: "Enable debug mode"
+end
+
+# Normal validation (warns about missing variables)
+Envalit.validate
+
+# Strict validation (raises errors for missing variables)
+Envalit.validate!
+```
+
+### Validation Modes
+
+Envalit provides two validation modes:
+
+1. **Normal Mode** (`validate`):
+   - Warns about missing required variables
+   - Raises errors only for variables marked as `strict: true`
+   - Good for development environments
+
+```ruby
+Envalit.validate # Prints warnings but doesn't halt execution
+```
+
+2. **Strict Mode** (`validate!`):
+   - Raises errors for any missing required variables
+   - Ignores the `strict` setting
+   - Recommended for production environments
+
+```ruby
+Envalit.validate! # Raises ValidationError if any required variables are missing
+```
+
+### Type Validation
+
+Envalit supports multiple data types:
+
+```ruby
+Envalit.configure do |config|
+  # String (default)
+  config.register "API_KEY",
+                 required: true
+
+  # Integer
+  config.register "PORT",
+                 type: :integer,
+                 default: 3000
+
+  # Boolean
+  config.register "CACHE_ENABLED",
+                 type: :boolean,
+                 default: true
+
+  # Float
+  config.register "TIMEOUT",
+                 type: :float,
+                 required: true,
+                 default: 5.5
+end
+```
+
+### Rails Integration
+
+In your Rails application, create an initializer:
+
+```ruby
+# config/initializers/envalit.rb
+Envalit.configure do |config|
+  # Critical Variables
+  config.register "SECRET_KEY_BASE",
+                 required: true,
+                 strict: true
+
+  # Optional Settings
+  config.register "CACHE_TTL",
+                 type: :integer,
+                 default: 3600,
+                 description: "Cache time-to-live in seconds"
+end
+
+# Validate based on environment
+if Rails.env.production?
+  Envalit.validate! # Strict validation in production
+else
+  Envalit.validate  # Normal validation in development/test
+end
+```
+
+### Error Messages
+
+Envalit provides clear, colorized error messages:
+
+```
+Missing required environment variables:
+  - DATABASE_URL
+    Type: string
+    Description: PostgreSQL connection URL
+
+To fix this:
+1. Create a .env file in your project root if it doesn't exist
+2. Copy values from .env.example to your .env file:
+   cp .env.example .env
+3. Update the values in your .env file with your actual configuration
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bugloper/envalit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+desc "Run the test suite and code style checks"
+task default: %i[spec rubocop]
+
+desc "Prepare for release"
+task :prepare_release do
+  puts "\n== Checking git status =="
+  status = `git status --porcelain`
+  if status.empty?
+    puts "Working directory is clean"
+  else
+    abort "Error: There are uncommitted changes. Please commit or stash them first."
+  end
+
+  puts "\n== Running tests =="
+  Rake::Task["spec"].invoke
+
+  puts "\n== Running RuboCop =="
+  Rake::Task["rubocop"].invoke
+
+  puts "\n== Checking version =="
+  version = Envalit::VERSION
+  puts "Current version: #{version}"
+
+  puts "\n== Checking CHANGELOG.md =="
+  changelog = File.read("CHANGELOG.md")
+  abort "Error: Version #{version} not found in CHANGELOG.md" unless changelog.include?(version)
+  puts "CHANGELOG.md contains version #{version}"
+
+  puts "\nAll checks passed! You can now run 'rake release'"
+end
+
+# Override the release task to run checks first
+Rake::Task["release"].enhance(["prepare_release"])

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "envalid"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/envalit.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "lib/envalit/version"
+
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+  spec.name          = "envalit"
+  spec.version       = Envalit::VERSION
+  spec.authors       = ["bugloper"]
+  spec.email         = ["bugloper@gmail.com"]
+
+  spec.summary       = "A simple Ruby gem for validating environment variables"
+  spec.description   = "Envalit provides a straightforward way to ensure all required environment variables are present, with options to warn or crash when they're missing."
+  spec.homepage      = "https://github.com/bugloper/envalit"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/bugloper/envalit"
+  spec.metadata["changelog_uri"] = "https://github.com/bugloper/envalit/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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Dependencies
+  spec.add_dependency "dotenv", "~> 3.1"
+
+  # Development dependencies
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.12"
+  spec.add_development_dependency "rubocop", "~> 1.60"
+  spec.add_development_dependency "rubocop-rake", "~> 0.6"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.26"
+  spec.add_development_dependency "yard", "~> 0.9"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "false"
+end

data/lib/envalit/generators/install_generator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Envalit
+  module Generators
+    # Generator for installing Envalit configuration files in a Ruby/Rails application.
+    #
+    # This generator creates:
+    # - An initializer file with example environment variable configurations
+    # - A .env.example file with sample environment variable values
+    #
+    # @example Installing via Rails generator
+    #   rails generate envalit:install
+    #
+    # @example Installing via Rake task
+    #   rake envalit:install
+    #
+    # The generated files provide a starting point for:
+    # - Configuring required environment variables
+    # - Setting up type validations
+    # - Defining default values
+    # - Documenting environment requirements
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+      desc "Creates an Envalit initializer for your application"
+
+      # Copies the Envalit initializer template to the application.
+      #
+      # Creates a new initializer file at config/initializers/envalit.rb
+      # with example configurations for common environment variables.
+      #
+      # @return [void]
+      def copy_initializer
+        template "envalit.rb", "config/initializers/envalit.rb"
+      end
+
+      # Copies the example environment file template.
+      #
+      # Creates a .env.example file in the application root
+      # with sample values matching the initializer configuration.
+      #
+      # @return [void]
+      def copy_example_env
+        template "example.env", ".env.example"
+      end
+    end
+  end
+end

data/lib/envalit/generators/templates/envalit.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+# Envalit Configuration
+# This file contains the configuration for your environment variables.
+# You can specify requirements, types, and other validations for each variable.
+
+Envalit.configure do |config|
+  # # Database Configuration
+  # config.register "DATABASE_URL",
+  #                 required: true,
+  #                 strict: true, # Will raise an error if missing
+  #                 description: "PostgreSQL connection URL"
+
+  # # Application Settings
+  # config.register "APP_HOST",
+  #                 required: true,
+  #                 default: "localhost",
+  #                 description: "Application host name"
+
+  # config.register "PORT",
+  #                 required: true,
+  #                 type: :integer,
+  #                 default: 3000,
+  #                 description: "Port number for the application"
+
+  # # API Keys and Secrets
+  # config.register "SECRET_KEY_BASE",
+  #                 required: true,
+  #                 strict: true,
+  #                 description: "Rails secret key base"
+
+  # config.register "API_KEY",
+  #                 required: false, # Optional variable
+  #                 description: "External API key"
+
+  # # Feature Flags
+  # config.register "ENABLE_FEATURE_X",
+  #                 type: :boolean,
+  #                 default: false,
+  #                 description: "Enable experimental feature X"
+
+  # # Email Configuration
+  # config.register "SMTP_SERVER",
+  #                 required: true,
+  #                 description: "SMTP server hostname"
+
+  # config.register "SMTP_PORT",
+  #                 required: true,
+  #                 type: :integer,
+  #                 default: 587,
+  #                 description: "SMTP server port"
+
+  # # Cache Configuration
+  # config.register "REDIS_URL",
+  #                 required: false,
+  #                 default: "redis://localhost:6379/0",
+  #                 description: "Redis connection URL"
+
+  # Add your own environment variables here
+  # Example:
+  # config.register "YOUR_ENV_VAR",
+  #                required: true|false,
+  #                strict: true|false,
+  #                type: :string|:integer|:boolean|:float,
+  #                default: "default_value",
+  #                description: "Description of the variable"
+end
+
+# Validate environment variables based on environment
+if Rails.env.production?
+  # In production, use validate! to ensure all required variables are present
+  Envalit.validate!
+else
+  # In development and test, use validate to warn about missing variables
+  Envalit.validate
+end

data/lib/envalit/generators/templates/example.env

@@ -0,0 +1,23 @@
+# Database Configuration
+DATABASE_URL=postgres://username:password@localhost:5432/database_name
+
+# Application Settings
+APP_HOST=localhost
+PORT=3000
+
+# API Keys and Secrets
+SECRET_KEY_BASE=your_secret_key_base_here
+API_KEY=your_api_key_here
+
+# Feature Flags
+ENABLE_FEATURE_X=false
+
+# Email Configuration
+SMTP_SERVER=smtp.example.com
+SMTP_PORT=587
+
+# Cache Configuration
+REDIS_URL=redis://localhost:6379/0
+
+# Add your own environment variables here
+# YOUR_ENV_VAR=value 

data/lib/envalit/loader.rb

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+
+require "dotenv"
+
+module Envalit
+  # The Loader class handles environment variable registration, validation, and type checking.
+  #
+  # This class is responsible for:
+  # - Managing the schema of environment variables
+  # - Loading variables from .env files
+  # - Validating variable presence and types
+  # - Handling default values
+  # - Providing warnings or errors for missing variables
+  #
+  # @example Basic usage with type validation
+  #   loader = Loader.new(Rails.root)
+  #   loader.register("PORT", type: :integer, default: 3000)
+  #   loader.register("DEBUG", type: :boolean, default: false)
+  #   loader.validate
+  #
+  # @example Strict validation with required variables
+  #   loader = Loader.new(Dir.pwd)
+  #   loader.register("API_KEY", required: true, strict: true)
+  #   loader.register("API_URL", required: true)
+  #   # Will raise ValidationError if API_KEY is missing
+  #   # Will warn if API_URL is missing
+  #   loader.validate
+  #
+  # @api private
+  class Loader
+    # Valid types for environment variables
+    VALID_TYPES = %i[string integer boolean float].freeze
+
+    # ANSI color codes for error formatting
+    ERROR_COLOR = "\e[1;91m" # bright red and bold
+    RESET_COLOR = "\e[0m"
+    HIGHLIGHT_COLOR = "\e[1m" # bold
+
+    # Initializes a new Loader instance.
+    #
+    # @param app_root [String] The root directory path where .env files are located
+    # @param app_root [String, nil] The root directory path where .env files are located. Defaults to Dir.pwd
+    def initialize(app_root = Dir.pwd)
+      @app_root      = app_root
+      @schema        = {}
+      @dotenv_loaded = false
+    end
+
+    # Registers an environment variable with validation options.
+    #
+    # @param key [String] The environment variable name
+    # @param options [Hash] The validation options
+    # @option options [Boolean] :required Whether the variable is required
+    # @option options [Boolean] :strict Raise error instead of warning for missing required variables
+    # @option options [Symbol] :type The variable type (:string, :integer, :boolean, :float)
+    # @option options [Object] :default The default value if variable is not set
+    # @option options [String] :description Description of the variable's purpose
+    #
+    # @raise [ArgumentError] If an invalid type is specified
+    # @return [void]
+    def register(key, options = {})
+      validate_options(options)
+      set_default_value(key, options[:default]) if options.key?(:default)
+      @schema[key] = options
+    end
+
+    # Validates all registered environment variables.
+    #
+    # This method:
+    # - Loads variables from .env file if not already loaded
+    # - Checks for missing required variables
+    # - Validates variable types
+    # - Raises errors for strict violations
+    # - Warns about non-strict violations
+    #
+    # @param strict [Boolean] Whether to enforce strict mode for all required variables
+    # @raise [ValidationError] If a strict required variable is missing
+    # @raise [ValidationError] If a variable's value doesn't match its specified type
+    # @return [void]
+    def validate(strict: false)
+      load_dotenv unless @dotenv_loaded
+      check_missing_variables(strict)
+      check_invalid_types
+    end
+
+    # Validates all registered environment variables in strict mode.
+    # All missing required variables will raise an error, regardless of their strict setting.
+    #
+    # @raise [ValidationError] If any required variable is missing
+    # @return [void]
+    def validate!
+      validate(strict: true)
+    end
+
+    # Loads environment variables from a .env file.
+    #
+    # @return [void]
+    def load
+      load_dotenv
+    end
+
+    private
+
+    # Validates the options passed to register.
+    #
+    # @param options [Hash] The options to validate
+    # @raise [ArgumentError] If an invalid type is specified
+    # @return [void]
+    def validate_options(options)
+      type = options[:type]
+      return unless type && !VALID_TYPES.include?(type)
+
+      raise ArgumentError,
+            "#{ERROR_COLOR}Invalid type: #{type}. Valid types are: #{VALID_TYPES.join(', ')}#{RESET_COLOR}"
+    end
+
+    # Sets the default value for an environment variable if it's not already set.
+    #
+    # @param key [String] The environment variable name
+    # @param default [Object] The default value
+    # @return [void]
+    def set_default_value(key, default)
+      return if ENV.key?(key)
+
+      case default
+      when true, false
+        default.to_s
+      end
+      ENV[key] = default.to_s
+    end
+
+    # Checks for missing required variables and handles them according to their strict setting.
+    #
+    # @param strict [Boolean] Whether to enforce strict mode for all required variables
+    # @return [void]
+    def check_missing_variables(strict = false) # rubocop:disable Style/OptionalBooleanParameter
+      missing_vars = @schema.select { |key, opts| opts[:required] && ENV[key].nil? }
+      return if missing_vars.empty?
+
+      message = "#{ERROR_COLOR}Missing required environment variables:#{RESET_COLOR}\n"
+      missing_vars.each do |key, opts|
+        message += "#{HIGHLIGHT_COLOR}  - #{key}#{RESET_COLOR}\n"
+        message += "    Type: #{opts[:type]}\n" if opts[:type]
+        message += "    Description: #{opts[:description]}\n" if opts[:description]
+      end
+
+      message += "\n#{HIGHLIGHT_COLOR}To fix this:#{RESET_COLOR}\n"
+      message += "1. Create a .env file in your project root if it doesn't exist\n"
+
+      if File.exist?(".env.example")
+        message += "2. Copy values from .env.example to your .env file:\n"
+        message += "   #{HIGHLIGHT_COLOR}cp .env.example .env#{RESET_COLOR}\n"
+        message += "3. Update the values in your .env file with your actual configuration"
+      else
+        message += "2. Add the missing variables to your .env file:\n"
+        missing_vars.each_key do |key|
+          message += "   #{HIGHLIGHT_COLOR}#{key}=your_#{key.downcase}_here#{RESET_COLOR}\n"
+        end
+      end
+
+      raise ValidationError, message if strict || missing_vars.any? { |_, opts| opts[:strict] }
+
+      warn message
+    end
+
+    # Validates the types of all environment variables against their schema.
+    #
+    # @raise [ValidationError] If a variable's value doesn't match its specified type
+    # @return [void]
+    def check_invalid_types
+      invalid_vars = @schema.select do |key, opts|
+        next false if ENV[key].nil?
+
+        case opts[:type]
+        when :integer
+          !ENV[key].match?(/\A-?\d+\z/)
+        when :float
+          !ENV[key].match?(/\A-?\d*\.?\d+\z/)
+        when :boolean
+          !%w[true false].include?(ENV[key].downcase)
+        else
+          false
+        end
+      end
+
+      return if invalid_vars.empty?
+
+      key, opts = invalid_vars.first
+      raise ValidationError, "#{ERROR_COLOR}Invalid type for #{key}: expected #{opts[:type]}#{RESET_COLOR}"
+    end
+
+    # Loads environment variables from a .env file.
+    #
+    # @return [void]
+    def load_dotenv
+      dotenv_path = File.join(@app_root, ".env")
+      Dotenv.load(dotenv_path) if File.exist?(dotenv_path)
+      @dotenv_loaded = true
+    end
+  end
+
+  # Error raised when environment variable validation fails
+  class ValidationError < StandardError; end
+end

data/lib/envalit/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Envalit
+  class Railtie < Rails::Railtie # rubocop:disable Style/Documentation
+    generators do
+      require_relative "generators/install_generator"
+      Rails::Generators.hide_namespaces "envalit"
+      Rails::Generators::Base.include Envalit::Generators
+    end
+  end
+end

data/lib/envalit/version.rb

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

data/lib/envalit.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require_relative "envalit/version"
+require_relative "envalit/loader"
+require_relative "envalit/railtie" if defined?(Rails)
+
+# Envalit is a Ruby gem for managing and validating environment variables.
+#
+# It provides a simple and flexible way to:
+# - Register environment variables with validation rules
+# - Set default values for optional variables
+# - Validate variable types (string, integer, boolean, float)
+# - Control validation behavior (warnings vs. strict errors)
+# - Load variables from .env files
+#
+# @example Basic usage
+#   Envalit.configure do |config|
+#     config.register "DATABASE_URL",
+#                    required: true,
+#                    strict: true
+#
+#     config.register "PORT",
+#                    type: :integer,
+#                    default: 3000
+#   end
+#
+#   Envalit.validate # Validates all registered variables
+#
+# @example Type validation
+#   Envalit.configure do |config|
+#     config.register "DEBUG_MODE",
+#                    type: :boolean,
+#                    default: false
+#
+#     config.register "API_TIMEOUT",
+#                    type: :float,
+#                    required: true
+#   end
+#
+# @see Envalit::Loader for detailed implementation
+module Envalit
+  class << self
+    # Configures Envalit with the given block.
+    #
+    # @yield [self] Yields self for configuration
+    # @return [void]
+    def configure
+      @loader ||= Loader.new(Dir.pwd)
+      yield(self)
+    end
+
+    # Registers an environment variable with validation options.
+    #
+    # @param key [String] The environment variable name
+    # @param options [Hash] The validation options
+    # @option options [Boolean] :required Whether the variable is required
+    # @option options [Boolean] :strict Raise error instead of warning for missing required variables
+    # @option options [Symbol] :type The variable type (:string, :integer, :boolean, :float)
+    # @option options [Object] :default The default value if variable is not set
+    # @option options [String] :description Description of the variable's purpose
+    # @return [void]
+    def register(key, options = {})
+      @loader.register(key, options)
+    end
+
+    # Validates all registered environment variables.
+    # Missing required variables will trigger warnings unless they are marked as strict.
+    #
+    # @raise [ValidationError] If a strict required variable is missing
+    # @return [void]
+    def validate
+      @loader.validate
+    end
+
+    # Validates all registered environment variables in strict mode.
+    # All missing required variables will raise an error, regardless of their strict setting.
+    #
+    # @raise [ValidationError] If any required variable is missing
+    # @return [void]
+    def validate!
+      @loader.validate!
+    end
+  end
+end

data/pull_request_template.md

@@ -0,0 +1,26 @@
+## Describe your changes
+Please include a detailed summary of the changes and the related issue. Also include any relevant context. List any dependencies that are required for this change.
+
+## Related issue number
+Mention the related issue number (e.g., "Fixes #123").
+
+## Checklist before requesting a review
+- [ ] I have performed a self-review of my code
+- [ ] Ran code linter and addressed any issues.
+- [ ] My code follows the style guidelines of this project
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+
+## Type of change
+_You may remove the options that are no relevant._
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+- [ ] Code style update (formatting, local variables)
+- [ ] Refactoring (no functional changes, no API changes)
+- [ ] Build & CI Related Changes
+- [ ] Others (Please describe)

data/sig/envalid.rbs

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

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: envalit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- bugloper
+bindir: exe
+cert_chain: []
+date: 2025-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.26'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.26'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Envalit provides a straightforward way to ensure all required environment
+  variables are present, with options to warn or crash when they're missing.
+email:
+- bugloper@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".mise.toml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- envalit.gemspec
+- lib/envalit.rb
+- lib/envalit/generators/install_generator.rb
+- lib/envalit/generators/templates/envalit.rb
+- lib/envalit/generators/templates/example.env
+- lib/envalit/loader.rb
+- lib/envalit/railtie.rb
+- lib/envalit/version.rb
+- pull_request_template.md
+- sig/envalid.rbs
+homepage: https://github.com/bugloper/envalit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bugloper/envalit
+  source_code_uri: https://github.com/bugloper/envalit
+  changelog_uri: https://github.com/bugloper/envalit/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'false'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.6
+specification_version: 4
+summary: A simple Ruby gem for validating environment variables
+test_files: []