env_check 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76261979114cfd50eff2593a9d62633313d2f4e2e3c01bb891768f3b7c535cf1
-  data.tar.gz: 2517760bfbc532e75c0508de1c12cc4a1ed382cfaa27758cfa9f4f0c36dc86e8
+  metadata.gz: 6b4d3df17098660e64b172c7b5727fb651146d317a29d73e9650463daa4f86f0
+  data.tar.gz: 7a113d7a265ecad73607cb90fd04c436ab90537b593cf00e8ff65142b097946e
 SHA512:
-  metadata.gz: 34d26caaacf2100c9389c94a87ebc17b332001fc705f7051adb752b96920178f68c2e873ff401bf50045daf48b9e67df508d0c92a3f4ad7137e976c6a25b83e4
-  data.tar.gz: 13c03e66845d8afe48d1e62c400b35d89b25a6f01ce2f8b62c701a6359f91c19deceae59ebdef84e07bd8e2efc42204faa87238699e68fdbfbb9a06fd7a1a073
+  metadata.gz: ac6b965ae3604b9760a57a007c7b07361ab7f1f55ba272a2d21e2694ff0fea64099f4475ac0995327ac663637bf91a232aa0a5730e231bce979f510cee6aa5d4
+  data.tar.gz: 12002c21fceb4f7e7637214a38212b46ddfa64e06765a8b29623bcd5542625a0f542f969e712a22a1a9648476550de36f5b8c2edae72c043e782d142e16fb8b5

data/CHANGELOG.md

@@ -6,6 +6,29 @@ This project adheres to [Semantic Versioning](https://semver.org).
 
 ---
 
+## [0.1.2] - 2025-07-29
+
+### Fixed
+
+- 🐛 **CLI Architecture Redesign** - Completely fixed `bundle exec env_check` compatibility
+  - Moved CLI logic from executable to `lib/env_check/cli.rb` as `EnvCheck::CLI` class
+  - Simplified executable to just load gem and call CLI class
+  - Fixed shebang line and file corruption issues
+  - Now works reliably with both `bundle exec` and direct gem installation
+
+---
+
+## [0.1.1] - 2025-07-29
+
+### Fixed
+
+- 🐛 **CLI Executable Loading** - Fixed `bundle exec env_check` command not working properly
+  - Improved require statement to work in both development and installed gem environments
+  - Added fallback loading mechanism for better compatibility
+  - Executable now works correctly with bundler in Rails applications
+
+---
+
 ## [0.1.0] - 2025-01-29
 
 ### Added

data/README.md

@@ -1,7 +1,7 @@
 # 🔍 EnvCheck
 
 [![Ruby](https://img.shields.io/badge/ruby-%3E%3D%203.0-red.svg)](https://ruby-lang.org)
-[![Gem Version](https://badge.fury.io/rb/env_check.svg)](https://badge.fury.io/rb/env_check)
+[![Gem Version](https://img.shields.io/gem/v/env_check.svg?style=flat)](https://rubygems.org/gems/env_check)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 `env_check` is a lightweight Ruby gem to validate and document your environment variables.  

data/bin/env_check

@@ -3,263 +3,15 @@
 
 # bin/env_check - CLI for EnvCheck gem
 
-require "optparse"
-require "fileutils"
-require_relative "../lib/env_check"
-
-# Module for CLI output helpers
-module CLIHelpers
-  def success(message)
-    puts message unless @options[:quiet]
-  end
-
-  def info(message)
-    puts message unless @options[:quiet]
-  end
-
-  def warning(message)
-    puts "⚠️  #{message}" unless @options[:quiet]
-  end
-
-  def error(message)
-    warn message
-  end
-
-  def error_exit(message, code = 1)
-    warn "Error: #{message}"
-    exit code
-  end
-
-  def default_config_path
-    Dir.exist?("config") ? "config/env_check.yml" : ".env_check.yml"
-  end
-end
-
-# CLI class for better organization
-class EnvCheckCLI
-  include CLIHelpers
-  def initialize(args = ARGV)
-    @args = args
-    @options = {
-      config: nil, # Will be auto-discovered if not specified
-      quiet: false,
-      verbose: false
-    }
-    @command = nil
-  end
-
-  def run
-    parse_arguments
-    execute_command
-  rescue StandardError => e
-    error_exit(e.message.to_s)
-  end
-
-  private
-
-  def parse_arguments
-    parser = create_option_parser
-    parser.parse!(@args)
-    @command = @args.shift
-  end
-
-  def create_option_parser
-    OptionParser.new do |opts|
-      configure_banner_and_commands(opts)
-      configure_options(opts)
-    end
-  end
-
-  def configure_banner_and_commands(opts)
-    opts.banner = "Usage: env_check [options] <command>"
-    opts.separator ""
-    opts.separator "Commands:"
-    opts.separator "  init     Create a new env_check.yml configuration file"
-    opts.separator "  check    Validate environment variables against configuration"
-    opts.separator "  version  Show version number"
-    opts.separator ""
-    opts.separator "Options:"
-  end
-
-  def configure_options(opts)
-    opts.on("-c", "--config PATH",
-            "Configuration file path (auto-discovered: .env_check.yml or config/env_check.yml)") do |path|
-      @options[:config] = path
-    end
-
-    opts.on("-q", "--quiet", "Suppress output (only show errors)") do
-      @options[:quiet] = true
-    end
-
-    opts.on("-v", "--verbose", "Show detailed output") do
-      @options[:verbose] = true
-    end
-
-    opts.on("-h", "--help", "Show this help message") do
-      puts opts
-      exit 0
-    end
-  end
-
-  def execute_command
-    case @command
-    when "init"
-      init_command
-    when "check"
-      check_command
-    when "version"
-      version_command
-    when nil
-      show_help_and_exit
-    else
-      error_exit("Unknown command: #{@command}")
-    end
-  end
-
-  def init_command
-    path = @options[:config] || determine_init_path
-
-    begin
-      # Create directory if it doesn't exist
-      dir = File.dirname(path)
-      FileUtils.mkdir_p(dir) unless dir == "."
-
-      if File.exist?(path)
-        warning("Configuration file already exists: #{path}")
-        return
-      end
-
-      create_config_file(path)
-      success("Created configuration file: #{path}")
-
-      unless @options[:quiet]
-        puts "\nNext steps:"
-        puts "1. Edit #{path} to define your required environment variables"
-        puts "2. Run 'env_check check' to validate your environment"
-      end
-    rescue StandardError => e
-      error_exit("Failed to create configuration file: #{e.message}")
-    end
-  end
-
-  def check_command
-    path = @options[:config] || EnvCheck::Config.discover_config_path
-    validate_config_exists(path)
-
-    info("Checking environment variables using: #{path}") if @options[:verbose]
-
-    result = perform_validation(path)
-    handle_validation_result(result)
-  end
-
-  def validate_config_exists(path)
-    return if File.exist?(path)
-
-    error_exit("Configuration file not found: #{path}. Run 'env_check init' first.")
-  end
-
-  def perform_validation(path)
-    EnvCheck.verify(path)
-  rescue EnvCheck::Error => e
-    error_exit("Validation failed: #{e.message}")
-  rescue StandardError => e
-    error_exit("Unexpected error: #{e.message}")
-  end
-
-  def handle_validation_result(result)
-    if result.success?
-      handle_success_result(result)
-    else
-      handle_failure_result(result)
-    end
-  end
-
-  def handle_success_result(result)
-    success("✅ All environment variables are valid!")
-
-    if @options[:verbose] && !result.valid_vars.empty?
-      puts "\nValid variables:"
-      result.valid_vars.each { |var| puts "  ✅ #{var}" }
-    end
-
-    display_warnings(result.warnings) unless result.warnings.empty?
-  end
-
-  def handle_failure_result(result)
-    error("❌ Environment validation failed!")
-
-    display_errors(result.errors) unless result.errors.empty?
-    display_warnings(result.warnings) unless result.warnings.empty?
-
-    exit 1
-  end
-
-  def display_errors(errors)
-    puts "\nErrors:"
-    errors.each { |error| puts "  ❌ #{error}" }
-  end
-
-  def display_warnings(warnings)
-    puts "\nWarnings:"
-    warnings.each { |warning| puts "  ⚠️  #{warning}" }
-  end
-
-  def version_command
-    puts EnvCheck::VERSION
-  end
-
-  def create_config_file(path)
-    File.write(path, config_template)
-  end
-
-  def config_template
-    <<~YAML
-      # EnvCheck Configuration
-      # Configure required and optional environment variables for your application
-
-      # Required environment variables (must be present and non-empty)
-      required:
-        - DATABASE_URL
-        - SECRET_KEY_BASE
-
-      # Optional environment variables with type validation
-      optional:
-        DEBUG: boolean          # true, false, 1, 0, yes, no, on, off (case-insensitive)
-        PORT: port             # valid port number (1-65535)
-        API_URL: url           # must start with http:// or https://
-        ADMIN_EMAIL: email     # valid email format
-        LOG_LEVEL: string      # any string value
-        RATE_LIMIT: float      # floating point number
-        CONFIG_PATH: path      # file or directory path
-        SETTINGS: json         # valid JSON string
-      #{"  "}
-      # You can also configure per-environment settings:
-      # development:
-      #   required:
-      #     - DATABASE_URL
-      #   optional:
-      #     DEBUG: boolean
-      ##{" "}
-      # production:
-      #   required:
-      #     - DATABASE_URL
-      #     - SECRET_KEY_BASE
-      #     - RAILS_MASTER_KEY
-      #   optional:
-      #     REDIS_URL: url
-    YAML
-  end
-
-  def show_help_and_exit
-    puts create_option_parser.help
-    exit 1
-  end
-
-  # Determine the best path for init command
-  def determine_init_path
-    default_config_path
-  end
+# Ensure we can load the gem whether it's installed or in development
+begin
+  require "env_check"
+rescue LoadError
+  # If we can't load the gem, try to add lib to load path (for development)
+  lib_path = File.expand_path("../lib", __dir__)
+  $LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+  require "env_check"
 end
 
 # Run the CLI
-EnvCheckCLI.new.run if __FILE__ == $PROGRAM_NAME
+EnvCheck::CLI.new(ARGV).run

data/lib/env_check/cli.rb

@@ -0,0 +1,239 @@
+# frozen_string_literal: true
+
+require "optparse"
+require "fileutils"
+
+module EnvCheck
+  # Module for CLI output helpers
+  module CLIHelpers
+    def success(message)
+      puts message unless @options[:quiet]
+    end
+
+    def info(message)
+      puts message unless @options[:quiet]
+    end
+
+    def warning(message)
+      puts "⚠️  #{message}" unless @options[:quiet]
+    end
+
+    def error(message)
+      warn message
+    end
+
+    def error_exit(message, code = 1)
+      warn "Error: #{message}"
+      exit code
+    end
+
+    def default_config_path
+      Dir.exist?("config") ? "config/env_check.yml" : ".env_check.yml"
+    end
+  end
+
+  # CLI class for better organization
+  class CLI
+    include CLIHelpers
+
+    def initialize(args = ARGV)
+      @args = args
+      @options = {
+        config: nil, # Will be auto-discovered if not specified
+        quiet: false,
+        verbose: false
+      }
+      @command = nil
+    end
+
+    def run
+      parse_arguments
+      execute_command
+    rescue StandardError => e
+      error_exit(e.message.to_s)
+    end
+
+    private
+
+    def parse_arguments
+      parser = create_option_parser
+      parser.parse!(@args)
+      @command = @args.shift
+    end
+
+    def create_option_parser
+      OptionParser.new do |opts|
+        configure_banner_and_commands(opts)
+        configure_options(opts)
+      end
+    end
+
+    def configure_banner_and_commands(opts)
+      opts.banner = "Usage: env_check [options] <command>"
+      opts.separator ""
+      opts.separator "Commands:"
+      opts.separator "  init     Create a new env_check.yml configuration file"
+      opts.separator "  check    Validate environment variables against configuration"
+      opts.separator "  version  Show version number"
+      opts.separator ""
+      opts.separator "Options:"
+    end
+
+    def configure_options(opts)
+      opts.on("-c", "--config PATH",
+              "Configuration file path (auto-discovered: .env_check.yml or config/env_check.yml)") do |path|
+        @options[:config] = path
+      end
+
+      opts.on("-q", "--quiet", "Suppress output (only show errors)") do
+        @options[:quiet] = true
+      end
+
+      opts.on("-v", "--verbose", "Show detailed output") do
+        @options[:verbose] = true
+      end
+
+      opts.on("-h", "--help", "Show this help message") do
+        puts opts
+        exit 0
+      end
+    end
+
+    def execute_command
+      case @command
+      when "init"
+        init_command
+      when "check"
+        check_command
+      when "version"
+        version_command
+      when nil
+        show_help_and_exit
+      else
+        error_exit("Unknown command: #{@command}")
+      end
+    end
+
+    def init_command
+      path = @options[:config] || determine_init_path
+
+      begin
+        # Create directory if it doesn't exist
+        dir = File.dirname(path)
+        FileUtils.mkdir_p(dir) unless dir == "."
+
+        if File.exist?(path)
+          warning("Configuration file already exists: #{path}")
+          return
+        end
+
+        create_config_file(path)
+        success("Created configuration file: #{path}")
+
+        unless @options[:quiet]
+          puts "\nNext steps:"
+          puts "1. Edit #{path} to define your required environment variables"
+          puts "2. Run 'env_check check' to validate your environment"
+        end
+      rescue StandardError => e
+        error_exit("Failed to create configuration file: #{e.message}")
+      end
+    end
+
+    def check_command
+      config_path = find_config_file
+
+      error_exit("No configuration file found. Run 'env_check init' to create one.") if config_path.nil?
+
+      begin
+        result = EnvCheck.verify(config_path)
+        display_results(result)
+        exit 1 unless result.success?
+      rescue StandardError => e
+        error_exit("Validation failed: #{e.message}")
+      end
+    end
+
+    def version_command
+      puts EnvCheck::VERSION
+    end
+
+    def create_config_file(path)
+      File.write(path, config_template)
+    end
+
+    def config_template
+      <<~YAML
+        # EnvCheck Configuration#{Dir.exist?("config") ? " (Rails)" : " (Root Level)"}
+        # Configure required and optional environment variables for your application
+
+        # Required environment variables (must be present and non-empty)
+        required:
+          - DATABASE_URL
+          - SECRET_KEY_BASE
+
+        # Optional environment variables with type validation
+        optional:
+          DEBUG: boolean          # true, false, 1, 0, yes, no (case-insensitive)
+          PORT: integer          # numeric values only
+          API_URL: url           # must start with http:// or https://
+          ADMIN_EMAIL: email     # valid email format
+          LOG_LEVEL: string      # any string value
+      YAML
+    end
+
+    def find_config_file
+      return @options[:config] if @options[:config]
+
+      # Check ENV variable first
+      return ENV["ENV_CHECK_CONFIG"] if ENV["ENV_CHECK_CONFIG"]
+
+      # Smart discovery
+      candidates = [".env_check.yml", "config/env_check.yml"]
+      candidates.find { |path| File.exist?(path) }
+    end
+
+    def display_results(result)
+      # Show valid variables
+      result.valid_vars.each do |var|
+        success("✅ #{var} is set")
+      end
+
+      # Show warnings for optional variables
+      result.warnings.each do |warning|
+        warning(warning)
+      end
+
+      # Show errors for required variables
+      result.errors.each do |error|
+        error("❌ #{error}")
+      end
+
+      # Summary
+      if result.success?
+        success("\n✅ Environment validation passed!")
+        info("Valid variables: #{result.valid_vars.count}")
+        info("Warnings: #{result.warnings.count}") if result.warnings.any?
+      else
+        error("\n❌ Environment validation failed!")
+        error("\nErrors:")
+        result.errors.each { |err| error("  ❌ #{err}") }
+
+        if result.warnings.any?
+          info("\nWarnings:")
+          result.warnings.each { |warn| info("  ⚠️  #{warn}") }
+        end
+      end
+    end
+
+    def show_help_and_exit
+      puts create_option_parser.help
+      exit 1
+    end
+
+    # Determine the best path for init command
+    def determine_init_path
+      default_config_path
+    end
+  end
+end

data/lib/env_check/version.rb

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

data/lib/env_check.rb

@@ -15,6 +15,7 @@ require "yaml"
 require_relative "env_check/version"
 require_relative "env_check/config"
 require_relative "env_check/validators"
+require_relative "env_check/cli"
 require_relative "env_check/rake_task" if defined?(Rake)
 
 # Load .env automatically (if present)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: env_check
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Mohammad Nadeem
@@ -174,6 +174,7 @@ files:
 - bin/env_check
 - bin/setup
 - lib/env_check.rb
+- lib/env_check/cli.rb
 - lib/env_check/config.rb
 - lib/env_check/rake_task.rb
 - lib/env_check/validators.rb