varslist 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56ddd614869539081b7a61d3002ad4ce618874367f74335bbf2175cabdf0ab12
-  data.tar.gz: b4558236f55cf480b7d9a9dd3546f038d321e579c72608a7575fbdb8d37d592f
+  metadata.gz: 834c1a4f7da0c33c32d7eb4adcd9d890ec192ac7a5c2343a6acdcea299ff5474
+  data.tar.gz: 757f408ac7d53073050f450de9af924379499f077bfaba1ca7c7c0389c699622
 SHA512:
-  metadata.gz: 540f5ba64e65909b8e9dc687be8b41b2998529b8a4e31f1d0aac682157ca0aac966b34b679cfca8918f0d3d8f5d9765161570523f9bd87cef0ebaf96fffcd20c
-  data.tar.gz: f9be254681bc329368bd057b120ceec665a77896df3ae4f3d632d0858c90f2b213bb5a2af9f1d2f9d7581450c4757229fe060ab8e1a45f1ee83ac284d378c57c
+  metadata.gz: d67cac3ef0c6b6705ba7eb4c8beab7ed522d61b2522f9d0ffe86a87f44a301a03470529d7d9e2d39a5867b408b2492516ca28c3d7fe636b70819fdedbe4b2c34
+  data.tar.gz: 0dcffe31dc38e3f4f8f5c3990656104e1fa0270339f8f3d3d97071331d5226d3e3d103e17ac81e8ed29e988d4a75c58bcbddc393aee48d814fdeeb4051d08461

data/Gemfile

@@ -9,4 +9,5 @@ gem 'dotenv'
 group :development do
   gem 'rubocop', '~> 1.60'
   gem 'rubocop-performance'
+  gem 'pry'
 end

data/lib/varslist.rb

@@ -1,88 +1,110 @@
 # frozen_string_literal: true
 
 require 'colorize'
+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)&.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)}
+  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?
-        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"])
+    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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: varslist
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sumit Pati