varslist 0.0.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1d7241a9064fedd4345223ba66adc0ba6623ea8f576f2dae0e4c53700ef9013
-  data.tar.gz: 6f404ccc9867a09a00015d51f6d61d76bb27456852084e68648c1f9586db881a
+  metadata.gz: abba4b6b17c6ee3060b2eaf7f8aba3db8904efdf095113a5db5ffd854287c8cc
+  data.tar.gz: bb731551f106ce196758676a81f256e3f2773090088d0fad08682fd53732840e
 SHA512:
-  metadata.gz: dca53197bf5fca8e3b569b94736c252c21441780684e329adae94be13acda4d80f5370be02f56e18bab7a2c92432806a5f08c291d9cf6e8d75e5f90e4ef686df
-  data.tar.gz: 368199a27f4ed8b1306a490cf978d591fb345db76dcdb9950dfe7cbaa778ef70684ea5050dcb1c4e7ab5b5e6668136b762d01f34a14e682d03bce7dfa6a10f95
+  metadata.gz: ffdcaa3e9ff3243c449bde4a880dbf59107f09124cdec1e45fa4a992c78b2f669f30599c80b3a2787c6519f917698253eefdeb8234097cec2558642f41141e8d
+  data.tar.gz: 4cefb456cfce202ba604b94126b0b9c266f8b36e53957e700ecb24fc06b611709b6b273aec3907e215095ef179d951bcdfb5947b0cfbfef5e5f810444f59077a

data/Gemfile

@@ -3,3 +3,11 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'colorize'
+
+gem 'dotenv'
+
+group :development do
+  gem 'pry'
+  gem 'rubocop', '~> 1.60'
+  gem 'rubocop-performance'
+end

data/bin/varslist

@@ -1,10 +1,6 @@
 #!/usr/bin/env rails
 
-rails_root = Dir.pwd
-
 require 'rubygems'
-require_relative "#{rails_root}/config/environment"
-require_relative "#{rails_root}/config/application"
 require 'varslist'
 env_vars = Varslist.list_env_variables
 
@@ -19,7 +15,7 @@ if ARGV.include?('--file')
 end
 
 if ARGV.include?('--verify')
-    Varslist.verify_var_list(env_vars)
+    Varslist.verify_var_list
     exit
 end
 

data/lib/generators/varslist/install/install_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Varslist
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../../templates', __dir__)
+
+      def create_initializer
+        template 'varslist.rb', 'config/initializers/varslist.rb'
+      end
+    end
+  end
+end

data/lib/templates/varslist.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+return unless defined?(Varslist)
+
+Varslist.configure do |config|
+  # If true, enable varslist
+  # Default value is true
+  # config.enabled = true
+
+  # List of files to be skipped
+  # Default value is []
+  # config.skip_files = []
+
+  # If true, only show missing envs when the server starts
+  # Default value is true
+  # config.only_show_missing = true
+end

data/lib/test.rb

@@ -0,0 +1,3 @@
+content = File.read("./lib/varslist.rb")
+FileUtils.mkdir_p("_plugin")
+File.write("./_plugin/creator.rb", content)

data/lib/varslist/configuration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Varslist
+  # Default configuration
+  class Configuration
+    attr_accessor :skip_files, :enabled, :only_show_missing
+
+    def initialize
+      @enabled = true
+      @skip_files = []
+      @only_show_missing = true
+    end
+  end
+end

data/lib/varslist/errors.rb

@@ -0,0 +1,3 @@
+module Varslist
+  class MissingEnvError < StandardError; end
+end

data/lib/varslist/railtie.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+# Varslist is a Rails gem that provides environment variable management and validation.
+# It ensures that all required environment variables are defined before the Rails server starts.
+module Varslist
+  # Railtie hooks into Rails initialization process to verify environment variables.
+  # It runs during Rails startup and validates that all required variables are configured.
+  class Railtie < Rails::Railtie
+    initializer 'varslist.verify_env', after: :load_config_initializers do
+      next unless defined?(Rails::Server)
+
+      Varslist.config ||= Varslist::Configuration.new
+      next unless Varslist.config.enabled
+
+      Varslist.verify_var_list
+    end
+  end
+end

data/lib/varslist/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Varslist
+  VERSION = '0.3.0'
+end

data/lib/varslist.rb

@@ -1,90 +1,160 @@
 # frozen_string_literal: true
 
 require 'colorize'
-rails_root = Dir.pwd
-require_relative "#{rails_root}/config/environment"
+require_relative 'varslist/errors'
+require_relative 'varslist/configuration'
+require_relative 'varslist/railtie' if defined?(Rails::Railtie)
 
 module Varslist
-  
-  def self.list_env_variables
-    env_use_list = []
-    watch_list = /\.rb$|\.html\.erb$/
-    env_regex = /ENV\[['"]\w+['"]\]|ENV\.fetch/
-    filelist = Dir['./**/**/*.*']
-    filelist.each do |file|
-      if File.basename(file) =~ watch_list
-        File.foreach(file).with_index do |line, index|
-          next if line.strip.empty? || line.strip.start_with?('#')
-          if line =~ env_regex
-            env_use_list << { "line" => line.strip, "file_name" => file, "line_number" => index + 1, "var_name" => check_var_name(line)}
+  class << self
+    attr_accessor :config
+
+    def env_vars
+      @env_vars ||= list_env_variables
+    end
+    
+    def list_env_variables
+      # Ensure config is initialized
+      @config ||= Configuration.new
+      
+      env_use_list = []
+      watch_list = /\.rb$|\.html\.erb$/
+      env_regex = /ENV\[['"]\w+['"]\]|ENV\.fetch/
+      filelist = Dir['./**/**/*.*']
+      filelist.each do |file|
+        next if @config.skip_files&.any? { |skip_item| matches_skip_item?(file, skip_item) }
+
+        if File.basename(file)&.match?(watch_list)
+          File.foreach(file).with_index do |line, index|
+            next if line.strip.empty? || line.strip.start_with?('#')
+            if line&.match?(env_regex)
+              check_var_name(line).each do |var_info|
+                env_use_list << { 
+                  "line" => line.strip, 
+                  "file_name" => file, 
+                  "line_number" => index + 1, 
+                  "var_name" => var_info[:name],
+                  "has_default" => var_info[:has_default]
+                }
+              end
+            end
           end
         end
       end
+      env_use_list
     end
-    env_use_list
-  end
 
-  def self.print_help
-    puts "Help for Varslist".colorize(:magenta)
-    puts "Use varslist to show all the ENV variables used in all .rb and .erb files"
-    puts "--file = to show file list where the ENV variables are used"
-    puts "--verify = to verify if all the ENV variable are valid"
-  end
-  
+    def print_help
+      puts "Help for Varslist".colorize(:magenta)
+      puts "Use varslist to show all the ENV variables used in all .rb and .erb files"
+      puts "--file = to show file list where the ENV variables are used"
+      puts "--verify = to verify if all the ENV variable are valid"
+    end
+    
 
-  def self.check_var_name(line)
-    if match = line.scan(/ENV\[['"]([^'"]+)['"]\]|ENV\.fetch\(['"]([^'"]+)['"]/)
-      vars=match.flatten.compact.each do |env_var|
-        env_var
+    def check_var_name(line)
+      results = []
+      
+      line.scan(/ENV\[['"]([^'"]+)['"]\]/) do |match|
+        results << { name: match[0], has_default: false }
+      end
+      
+      line.scan(/ENV\.fetch\(\s*['"]([^'"]+)['"]\s*(?:,\s*([^)]*))?\s*\)\s*(\{)?/) do |name, default_arg, block_start|
+        has_default = !default_arg.nil? || !block_start.nil?
+        results << { name: name, has_default: has_default }
       end
-      vars.join
-    else
-      nil
+      
+      results
     end
-  end
-  
-  def self.print_env(found_envs)
-    found_envs.each do |env_line|
-      puts "#{env_line["file_name"]}:#{env_line["line_number"]}\t#{env_line["var_name"]}".colorize(:magenta)
-      puts "\n\t#{env_line["line"]}\n".colorize(:green)
+    
+    def print_env(found_envs)
+      found_envs.each do |env_line|
+        puts "#{env_line["file_name"]}:#{env_line["line_number"]}\t#{env_line["var_name"]}".colorize(:magenta)
+        puts "\n\t#{env_line["line"]}\n".colorize(:green)
+      end
     end
-  end
 
-  
-  def self.print_used_var_list(found_envs)
-    puts "\n\nThe used ENV variables".colorize(:magenta)
-    used_vars=[]
-    found_envs.each do |found_env|
-      used_vars << found_env["var_name"] unless used_vars.include?(found_env["var_name"])
+    
+    def print_used_var_list(found_envs)
+      puts "\nThe used ENV variables".colorize(:magenta)
+      used_vars=[]
+      found_envs.each do |found_env|
+        used_vars << found_env["var_name"] unless used_vars.include?(found_env["var_name"])
+      end
+      used_vars.each do |var|
+        puts "\t#{var}".colorize(:green)
+      end
     end
-    used_vars.each do |var|
-      puts "\t#{var}".colorize(:green)
+
+    def verify_var_list
+      valid_env, invalid_env = fetch_used_and_unused_vars
+      if !valid_env.empty? && !config.only_show_missing
+        puts "\nThe valid envs are:".colorize(:magenta)
+        puts "#{valid_env.join(", ")}".colorize(:green)
+      end
+      if !invalid_env.empty?
+        puts "\nThe missing envs are:".colorize(:magenta)
+        puts "#{invalid_env.join(", ")}".colorize(:red)
+      end
     end
-  end
 
-  def self.verify_var_list(found_envs)
-    valid_env = []
-    invalid_env = []
-    found_envs.each do |found_env|
-      if ENV[found_env["var_name"]] != nil
-        valid_env << found_env["var_name"] unless valid_env.include?(found_env["var_name"])
+    def verify!
+      invalid_env = fetch_used_and_unused_vars[1]
+      if invalid_env.empty?
+        puts "\n\nThe envs are valid".colorize(:green)
       else
-        invalid_env << found_env["var_name"] unless invalid_env.include?(found_env["var_name"])
+        message = "The envs are invalid"
+        puts "\n\nThe envs are invalid".colorize(:red)
+        raise Varslist::MissingEnvError, message
       end
     end
-    if !valid_env.empty?
-      puts "\n\nThe valid envs are:".colorize(:magenta)
-      valid_env.each do |valid|
-        puts "\t#{valid}".colorize(:green)
+
+    def fetch_used_and_unused_vars
+      valid_env = []
+      invalid_env = []
+      
+      # Track status for each variable
+      # A variable is invalid only if it is missing AND required at least once (no default)
+      vars_status = {}
+      
+      env_vars.each do |found_env|
+        name = found_env["var_name"]
+        vars_status[name] ||= { required: false, present: !ENV[name].nil? }
+        vars_status[name][:required] = true unless found_env["has_default"]
       end
-    end
-    if !invalid_env.empty?
-      puts "\n\nThe invalid envs are:".colorize(:magenta)
-      invalid_env.each do |valid|
-        puts "\t#{valid}".colorize(:red)
+      
+      vars_status.each do |name, status|
+        if status[:present] || !status[:required]
+          valid_env << name
+        else
+          invalid_env << name
+        end
       end
+      
+      [valid_env, invalid_env]
+    end
+    private
+
+
+    def matches_skip_item?(file, skip_item)
+      pattern = skip_item.to_s
+      # Check for glob matches
+      return true if File.fnmatch?(pattern, file, File::FNM_PATHNAME | File::FNM_DOTMATCH)
+      return true if File.fnmatch?(pattern, file.delete_prefix('./'), File::FNM_PATHNAME | File::FNM_DOTMATCH)
+
+      # Check for absolute path matches or directory prefix matches
+      abs_file = File.expand_path(file)
+      abs_pattern = File.expand_path(pattern)
+
+      return true if abs_file == abs_pattern
+      return true if abs_file.start_with?(File.join(abs_pattern, ''))
+
+      false
     end
   end
 
-  # private_class_method :check_environment
+  def self.configure
+    self.config ||= Configuration.new
+    yield(config) if block_given?
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: varslist
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Sumit Pati
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-18 00:00:00.000000000 Z
+date: 2026-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -30,42 +30,29 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.4
-- !ruby/object:Gem::Dependency
-  name: colorize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.4
-description: 
-email: 
+description: Varslist is a ruby gem that helps to identify the env variables that
+  are being used in your project
+email:
 executables:
 - varslist
-- vars
 extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- bin/vars
 - bin/varslist
+- lib/generators/varslist/install/install_generator.rb
+- lib/templates/varslist.rb
+- lib/test.rb
 - lib/varslist.rb
-homepage: https://rubygems.org/gems/varslist
+- lib/varslist/configuration.rb
+- lib/varslist/errors.rb
+- lib/varslist/railtie.rb
+- lib/varslist/version.rb
+homepage: https://github.com/sumitpati7/varslist
 licenses: []
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -80,8 +67,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Display the list of created Environment variables
 test_files: []

data/bin/vars

@@ -1,3 +0,0 @@
-#!/usr/bin/env bash
-rails c
-Varslist.list_env_variables