dotenv_validator 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ee3d73f77ffe3a5d1a050afcd957d1cda68522963de3c4196f0e8fb22f0b9f3
-  data.tar.gz: b957b41bde61f0dd24e3ab4a896ea4bdd063804ede8417271ca40d3e0fa101b7
+  metadata.gz: '03040841959fe965027d57672d55726640199bb217b52a169c40b3bf465c7d69'
+  data.tar.gz: 80f1543f7719e2f3758bcf69b6294469c22033a56e96f03358d1627350e266b7
 SHA512:
-  metadata.gz: 9893692a6ecd009c7bc728cec6c0cd0f66f4d07dde10c32b5dffcb817675af3f5cba3cee750bf3b331f88e05d97db2ed4b417b6755d49e3e6ff50e36aa7e241f
-  data.tar.gz: 48821a901dd6ffc6d86081d0a72cc652a1d83659eb663ac71165c307eeff88b0af4bfcb76a1699dd9f8ddb2859843d15b26595f3ae8f6d94398df50657c595cd
+  metadata.gz: aee0d70d03f541d3d30171f1eafc5481df165a702b60bb0426b21db52af3c561100213765b0df20f80aeaa8b866b1fb47019b0bf5600aa8d181c825a64df63cf
+  data.tar.gz: a0e9a2bedb35d6cd82b5ebb3872544b009d849fa6de34044e060aeadbea12f77cf53a98b6a8ee7e95ef865bf7ecd40ab9e6583e7db99e6065434278090b67f59

data/lib/dotenv_validator/errors.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module DotenvValidator # :nodoc: all
+  class SampleFileNotFoundError < StandardError
+  end
+end

data/lib/dotenv_validator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DotenvValidator
-  VERSION = '1.1.0'
+  VERSION = "1.3.0"
 end

data/lib/dotenv_validator.rb

@@ -1,5 +1,8 @@
-require 'fast_blank'
-require 'pathname'
+# frozen_string_literal: true
+
+require "fast_blank"
+require "pathname"
+require "dotenv_validator/errors"
 
 # Knows how to check the environment variables and compares it to .env.sample
 # and the comments in every line of your .env.sample file.
@@ -15,8 +18,8 @@ module DotenvValidator
     invalid_format = []
 
     open_sample_file.each do |line|
-      variable, config = line.split(' #')
-      variable_name, _sample = variable.split('=')
+      variable, config = line.split(" #")
+      variable_name, _sample = variable.split("=")
       value = ENV[variable_name]
 
       if value.nil? || value.blank?
@@ -26,18 +29,22 @@ module DotenvValidator
 
       next unless config =~ /format=(.*)/
 
+      format = Regexp.last_match(1)
+
       valid =
-        case Regexp.last_match(1)
-        when 'int', 'integer' then integer?(value)
-        when 'float' then float?(value)
-        when 'str', 'string' then true
-        when 'email' then email?(value)
-        when 'url' then url?(value)
+        case format
+        when "int", "integer", "Integer" then integer?(value)
+        when "float", "Float" then float?(value)
+        when "str", "string", "String" then true
+        when "email" then email?(value)
+        when "url" then url?(value)
+        when "bool", "boolean", "Boolean" then boolean?(value)
+        when "uuid", "UUID" then uuid?(value)
         else
           value.match?(Regexp.new(Regexp.last_match(1)))
         end
 
-      invalid_format << variable_name unless valid
+      invalid_format << {name: variable_name, value: value, format: format} unless valid
     end
 
     [missing_variables, invalid_format]
@@ -51,12 +58,13 @@ module DotenvValidator
 
     missing_variables, invalid_format = analyze_variables
     if missing_variables.any?
-      puts("WARNING - Missing environment variables: #{missing_variables.join(', ')}")
+      puts("WARNING - Missing environment variables: #{missing_variables.join(", ")}")
       result = false
     end
 
     if invalid_format.any?
-      puts("WARNING - Environment variables with invalid format: #{invalid_format.join(', ')}")
+      puts "WARNING - Environment variables with invalid format:"
+      puts invalid_format_list(invalid_format)
       result = false
     end
 
@@ -69,53 +77,72 @@ module DotenvValidator
   def self.check!
     missing_variables, invalid_format = analyze_variables
 
-    raise("Missing environment variables: #{missing_variables.join(', ')}") if missing_variables.any?
+    raise("Missing environment variables: #{missing_variables.join(", ")}") if missing_variables.any?
 
-    raise("Environment variables with invalid format: #{invalid_format.join(', ')}") if invalid_format.any?
+    raise("Environment variables with invalid format:\n#{invalid_format_list(invalid_format)}") if invalid_format.any?
   end
 
-  # It checks the value to check if it is a float or not.
+  # It checks if the value is float or not.
   #
   # @param [String] A string
   # @return [Boolean] True if it is a float value. False otherwise.
   def self.float?(string)
     true if Float(string)
-  rescue StandardError
+  rescue
     false
   end
 
-  # It checks the value to check if it is an integer or not.
+  # It checks if the value is an integer or not.
   #
   # @param [String] A string
   # @return [Boolean] True if it is an integer value. False otherwise.
   def self.integer?(string)
     true if Integer(string)
-  rescue StandardError
+  rescue
     false
   end
 
-  # It checks the value to check if it is an email or not.
+  # It checks if the value is an email or not.
   #
   # @param [String] A string
   # @return [Boolean] True if it is an email value. False otherwise.
   def self.email?(string)
-    string.match?(/[\w@]+@[\w@]+\.[\w@]+/)
+    string.match?(URI::MailTo::EMAIL_REGEXP)
   end
 
-  # It checks the value to check if it is a URL or not.
+  # It checks if the value is a URL or not.
   #
   # @param [String] A string
   # @return [Boolean] True if it is an URL value. False otherwise.
   def self.url?(string)
-    string.match?(%r{https?://.+})
+    string.match?(/\A#{URI::DEFAULT_PARSER.make_regexp(%w[http https])}\z/)
+  end
+
+  # It checks if the value is a boolean or not.
+  #
+  # @param [String] A string
+  # @return [Boolean] True if it is a boolean value. False otherwise.
+  def self.boolean?(string)
+    string.match?(/(true|false)/)
+  end
+
+  # It checks if the value is a uuid or not.
+  #
+  # @param [String] A string
+  # @return [Boolean] True if it is a UUID value. False otherwise.
+  def self.uuid?(string)
+    string.match?(/\A[\da-f]{32}\z/i) ||
+      string.match?(/\A[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12}\z/i)
   end
 
   def self.open_sample_file
     File.open(sample_file)
+  rescue Errno::ENOENT
+    raise DotenvValidator::SampleFileNotFoundError, "#{sample_file} was not found!"
   end
 
   def self.sample_file
-    File.join(root, '.env.sample')
+    File.join(root, ".env.sample")
   end
 
   # Internal: `Rails.root` is nil in Rails 4.1 before the application is
@@ -132,4 +159,10 @@ module DotenvValidator
       root_or_pwd
     end
   end
+
+  def self.invalid_format_list(invalid_format)
+    invalid_format.map do |var|
+      %(- #{var[:name]}: expected "#{var[:value]}" to match "#{var[:format]}" format)
+    end.join("\n")
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dotenv_validator
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Ariel Juodziukynas
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-14 00:00:00.000000000 Z
+date: 2023-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fast_blank
@@ -176,6 +176,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/dotenv_validator.rb
+- lib/dotenv_validator/errors.rb
 - lib/dotenv_validator/version.rb
 homepage: https://github.com/fastruby/dotenv_validator
 licenses:
@@ -196,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Checks required env variables and its format using .env.sample