varslist 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a8c3114443cf7efda1643f90289e3038d03c45aecea7c4b14bdc05925884502
-  data.tar.gz: b4ca6618644f40ac629c29c2b945b7c0be3fad683270be70df08608205f7d598
+  metadata.gz: d1d7241a9064fedd4345223ba66adc0ba6623ea8f576f2dae0e4c53700ef9013
+  data.tar.gz: 6f404ccc9867a09a00015d51f6d61d76bb27456852084e68648c1f9586db881a
 SHA512:
-  metadata.gz: 78b30553cab6c299ea81e9cdf0f660349971446d61a35037246175b68ba765edacf381413f3830a4e47067b7989dd3a430ea426a3745e7774497f36aa2e8d071
-  data.tar.gz: efd868b487f58c74ab401e681b372c2af97403be3a5308261fadb5ce72c2a645ff7fc2097584495851d511ed4c6b2573fe51aca6b52a580f236a702debc05359
+  metadata.gz: dca53197bf5fca8e3b569b94736c252c21441780684e329adae94be13acda4d80f5370be02f56e18bab7a2c92432806a5f08c291d9cf6e8d75e5f90e4ef686df
+  data.tar.gz: 368199a27f4ed8b1306a490cf978d591fb345db76dcdb9950dfe7cbaa778ef70684ea5050dcb1c4e7ab5b5e6668136b762d01f34a14e682d03bce7dfa6a10f95

data/bin/vars

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

data/bin/varslist

@@ -1,2 +1,28 @@
+#!/usr/bin/env rails
+
+rails_root = Dir.pwd
+
+require 'rubygems'
+require_relative "#{rails_root}/config/environment"
+require_relative "#{rails_root}/config/application"
 require 'varslist'
-Varslist.list_env_variables
+env_vars = Varslist.list_env_variables
+
+if ARGV.empty?
+    Varslist.print_used_var_list(env_vars)
+    exit
+end
+
+if ARGV.include?('--file')
+    Varslist.print_env(env_vars)
+    exit
+end
+
+if ARGV.include?('--verify')
+    Varslist.verify_var_list(env_vars)
+    exit
+end
+
+if ARGV.include?('--help')
+    Varslist.print_help
+end

data/lib/varslist.rb

@@ -1,27 +1,90 @@
 # frozen_string_literal: true
 
 require 'colorize'
+rails_root = Dir.pwd
+require_relative "#{rails_root}/config/environment"
 
 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|
-      check_environment(file) if File.basename(file) =~ watch_list
+      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)}
+          end
+        end
+      end
     end
+    env_use_list
   end
 
-  def self.check_environment(file_name)
-    env_regex = /ENV\[['"]\w+['"]\]|ENV\.fetch/
-    File.foreach(file_name).with_index do |line, index|
-      next if line.strip.empty? || line.strip.start_with?('#')
+  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 self.check_var_name(line)
+    if match = line.scan(/ENV\[['"]([^'"]+)['"]\]|ENV\.fetch\(['"]([^'"]+)['"]/)
+      vars=match.flatten.compact.each do |env_var|
+        env_var
+      end
+      vars.join
+    else
+      nil
+    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)
+    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"])
+    end
+    used_vars.each do |var|
+      puts "\t#{var}".colorize(:green)
+    end
+  end
 
-      if line =~ env_regex
-        puts "#{file_name}:#{index + 1}".purple
-        puts "\n\t#{line}\n".green
+  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"])
+      else
+        invalid_env << found_env["var_name"] unless invalid_env.include?(found_env["var_name"])
+      end
+    end
+    if !valid_env.empty?
+      puts "\n\nThe valid envs are:".colorize(:magenta)
+      valid_env.each do |valid|
+        puts "\t#{valid}".colorize(:green)
+      end
+    end
+    if !invalid_env.empty?
+      puts "\n\nThe invalid envs are:".colorize(:magenta)
+      invalid_env.each do |valid|
+        puts "\t#{valid}".colorize(:red)
       end
     end
   end
 
-  private_class_method :check_environment
+  # private_class_method :check_environment
 end

metadata

@@ -1,23 +1,65 @@
 --- !ruby/object:Gem::Specification
 name: varslist
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - Sumit Pati
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-10 00:00:00.000000000 Z
-dependencies: []
+date: 2024-12-18 00:00:00.000000000 Z
+dependencies:
+- !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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !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: 
 executables:
 - varslist
+- vars
 extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- bin/vars
 - bin/varslist
 - lib/varslist.rb
 homepage: https://rubygems.org/gems/varslist
@@ -38,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.20
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Display the list of created Environment variables