varslist 0.0.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1d7241a9064fedd4345223ba66adc0ba6623ea8f576f2dae0e4c53700ef9013
-  data.tar.gz: 6f404ccc9867a09a00015d51f6d61d76bb27456852084e68648c1f9586db881a
+  metadata.gz: 834c1a4f7da0c33c32d7eb4adcd9d890ec192ac7a5c2343a6acdcea299ff5474
+  data.tar.gz: 757f408ac7d53073050f450de9af924379499f077bfaba1ca7c7c0389c699622
 SHA512:
-  metadata.gz: dca53197bf5fca8e3b569b94736c252c21441780684e329adae94be13acda4d80f5370be02f56e18bab7a2c92432806a5f08c291d9cf6e8d75e5f90e4ef686df
-  data.tar.gz: 368199a27f4ed8b1306a490cf978d591fb345db76dcdb9950dfe7cbaa778ef70684ea5050dcb1c4e7ab5b5e6668136b762d01f34a14e682d03bce7dfa6a10f95
+  metadata.gz: d67cac3ef0c6b6705ba7eb4c8beab7ed522d61b2522f9d0ffe86a87f44a301a03470529d7d9e2d39a5867b408b2492516ca28c3d7fe636b70819fdedbe4b2c34
+  data.tar.gz: 0dcffe31dc38e3f4f8f5c3990656104e1fa0270339f8f3d3d97071331d5226d3e3d103e17ac81e8ed29e988d4a75c58bcbddc393aee48d814fdeeb4051d08461

data/Gemfile

@@ -3,3 +3,11 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'colorize'
+
+gem 'dotenv'
+
+group :development do
+  gem 'rubocop', '~> 1.60'
+  gem 'rubocop-performance'
+  gem 'pry'
+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
 

data/lib/varslist.rb

@@ -1,90 +1,110 @@
 # frozen_string_literal: true
 
 require 'colorize'
-rails_root = Dir.pwd
-require_relative "#{rails_root}/config/environment"
+require_relative 'varslist/errors'
 
 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
+    def env_vars
+      @env_vars ||= list_env_variables
+    end
+    
+    def 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)&.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)
+              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
-    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)
+      if match = line.scan(/ENV\[['"]([^'"]+)['"]\]|ENV\.fetch\(['"]([^'"]+)['"]/)
+        vars=match.flatten.compact.each do |env_var|
+          env_var
+        end
+        vars.join
+      else
+        nil
       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)
+    
+    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"])
-    end
-    used_vars.each do |var|
-      puts "\t#{var}".colorize(:green)
+    
+    def 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
-  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"])
-      else
-        invalid_env << found_env["var_name"] unless invalid_env.include?(found_env["var_name"])
+    def verify_var_list
+      valid_env, invalid_env = get_used_and_unused_vars
+      if !valid_env.empty?
+        puts "\n\nThe valid envs are:".colorize(:magenta)
+        valid_env.each do |valid|
+          puts "\t#{valid}".colorize(:green)
+        end
       end
-    end
-    if !valid_env.empty?
-      puts "\n\nThe valid envs are:".colorize(:magenta)
-      valid_env.each do |valid|
-        puts "\t#{valid}".colorize(:green)
+      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
-    if !invalid_env.empty?
-      puts "\n\nThe invalid envs are:".colorize(:magenta)
-      invalid_env.each do |valid|
-        puts "\t#{valid}".colorize(:red)
+
+    def verify!
+      invalid_env = get_used_and_unused_vars[1]
+      if invalid_env.empty?
+        puts "\n\nThe envs are valid".colorize(:green)
+      else
+        message = "The envs are invalid"
+        puts "\n\nThe envs are invalid".colorize(:red)
+        raise Varslist::MissingEnvError, message
       end
     end
-  end
 
-  # private_class_method :check_environment
+    private
+
+    def get_used_and_unused_vars
+      valid_env = []
+      invalid_env = []
+      env_vars.each do |found_env|
+        if ENV[found_env["var_name"]].nil?
+          invalid_env << found_env["var_name"] unless invalid_env.include?(found_env["var_name"])
+        else
+          valid_env << found_env["var_name"] unless valid_env.include?(found_env["var_name"])
+        end
+      end
+      return valid_env, invalid_env
+    end
+  end 
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: varslist
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Sumit Pati
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -30,42 +29,20 @@ 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
 executables:
 - varslist
-- vars
 extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- bin/vars
 - bin/varslist
 - lib/varslist.rb
-homepage: https://rubygems.org/gems/varslist
+homepage: https://github.com/sumitpati7/varslist
 licenses: []
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -80,8 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
-signing_key: 
+rubygems_version: 3.6.9
 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