dotenvx 4.0.3-x86_64-linux → 4.0.5-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56eedbc2902cc417c6a9fb43e358b4647752cf9741b66cf6d3a1ea924b8e6525
-  data.tar.gz: 4a2aec4387b046cc721c904bfdebc78a6828bc02440a029d3a8912042577a68b
+  metadata.gz: eed8288974a56e99bb64dc3c42e68a8e29b6fe7dfc28ac2509a6c34ec6c9cdfe
+  data.tar.gz: 248c383166ac9a268f2ea1724cf733eaf7bb71587e297662bf7fe518b558f8a5
 SHA512:
-  metadata.gz: 005170ca55c101a99961659726f4de44f69120fcfed663e43d2cd667832bcbace82f99f2e740a7d69aa45fbf17452c35114b8c577734935bb545d212c9e01c63
-  data.tar.gz: fcce36b5e4589a938a6f85fa1044edaa677d29d37cd5586e74bc82c338e947ca6da52b921fe33f1d6c5665807ab0bbe3595ea08f4b3fb5f1177c5bfcabcfd4f9
+  metadata.gz: d378737dbc885ce124e8072a846234a2c08f15be242b84aace2deabdd70c2818d47c31fb3eae4f2e8ba843fc86fba6628a5d6fac79d5ac423f458c2ee392b815
+  data.tar.gz: 0060ab3dc3fdc4c6ae2a61d8eaecd9bbdb355a76a0bff013634a667989bfd2652fb08437ab229b15a1a5dad16b71fb39c12acef00ee9fc34dc9fa9a39ca35803

data/CHANGELOG.md

@@ -2,7 +2,16 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-## [Unreleased](https://github.com/dotenvx/dotenvx-ruby/compare/v4.0.0...main)
+## [Unreleased](https://github.com/dotenvx/dotenvx-ruby/compare/v4.0.5...main)
+
+## [4.0.5](https://github.com/dotenvx/dotenvx-ruby/compare/v4.0.4...v4.0.5)
+
+- Continue after parse and decryption errors by default, with strict and
+  error-code ignore options for callers that need them.
+
+## [4.0.4](https://github.com/dotenvx/dotenvx-ruby/compare/v4.0.3...v4.0.4)
+
+- Report the unique variables injected from readable dotenv files.
 
 ## [4.0.0](https://github.com/dotenvx/dotenvx-ruby/compare/v0.0.2...v4.0.0)
 

data/lib/dotenvx/rails.rb

@@ -37,7 +37,10 @@ module Dotenvx
     config.before_configuration { Dotenvx::Railtie.instance.load }
 
     def load
+      return if @loaded
+
       Dotenvx.load(*dotenvx_files)
+      @loaded = true
     end
 
     private

data/lib/dotenvx/version.rb

@@ -1,3 +1,3 @@
 module Dotenvx
-  VERSION = "4.0.3"
+  VERSION = "4.0.5"
 end

data/lib/dotenvx.rb

@@ -1,6 +1,7 @@
 require "dotenvx/version"
 require "dotenvx/dotenvx_native"
 require "json"
+require "pathname"
 
 module Dotenvx
   class MissingKeys < RuntimeError
@@ -12,16 +13,32 @@ module Dotenvx
     end
   end
 
+  class ParseError < RuntimeError
+    attr_reader :code
+
+    def initialize(code, message)
+      @code = code
+      super(message)
+    end
+  end
+
   class << self
     attr_accessor :instrumenter
 
-    def load(*filenames, overwrite: false, ignore: true)
-      env = parse(*filenames, overwrite: overwrite, ignore: ignore)
-      update(env, overwrite: overwrite)
+    def load(*filenames, overwrite: false, ignore: true, strict: false)
+      env, injected_keys, loaded_paths = parse_files(
+        *filenames,
+        overwrite: overwrite,
+        ignore: ignore,
+        strict: strict
+      )
+      changed = update(env, overwrite: overwrite)
+      log_injected(injected_keys, loaded_paths)
+      changed
     end
 
     def load!(*filenames)
-      load(*filenames, ignore: false)
+      load(*filenames, ignore: false, strict: true)
     end
 
     def overwrite(*filenames)
@@ -30,36 +47,17 @@ module Dotenvx
     alias overload overwrite
 
     def overwrite!(*filenames)
-      load(*filenames, overwrite: true, ignore: false)
+      load(*filenames, overwrite: true, ignore: false, strict: true)
     end
     alias overload! overwrite!
 
-    def parse(*filenames, overwrite: false, ignore: true)
-      filenames = [".env"] if filenames.empty?
-      filenames = filenames.flatten.reverse if overwrite
-
-      process_env = ENV.to_h
-      filenames.reduce({}) do |values, filename|
-        path = File.expand_path(filename)
-        begin
-          source = File.binread(path).sub(/\A\xEF\xBB\xBF/, "").force_encoding(Encoding::UTF_8)
-        rescue Errno::ENOENT, Errno::EISDIR
-          raise unless ignore
-          next values
-        end
-
-        parsed, = Native.parse_dotenv(JSON.generate(
-          source: source,
-          process_env: process_env,
-          overwrite: overwrite == true,
-          key_files: key_files(path)
-        ))
-        parsed = parsed.to_h
-        process_env.merge!(parsed)
-        values.merge!(parsed)
-        yield Environment.new(path, parsed) if block_given?
-        values
-      end
+    def parse(*filenames, overwrite: false, ignore: true, strict: false)
+      parse_files(
+        *filenames,
+        overwrite: overwrite,
+        ignore: ignore,
+        strict: strict
+      ).first
     end
 
     def update(env = {}, overwrite: false)
@@ -89,6 +87,72 @@ module Dotenvx
 
     private
 
+    def parse_files(*filenames, overwrite: false, ignore: true, strict: false)
+      filenames = [".env"] if filenames.empty?
+      filenames = filenames.flatten.reverse if overwrite
+
+      process_env = ENV.to_h
+      injected_keys = {}
+      loaded_paths = []
+      values = filenames.reduce({}) do |accumulator, filename|
+        path = File.expand_path(filename)
+        begin
+          source = File.binread(path).sub(/\A\xEF\xBB\xBF/, "").force_encoding(Encoding::UTF_8)
+        rescue Errno::ENOENT, Errno::EISDIR
+          raise unless ignore_missing?(ignore)
+          next accumulator
+        end
+
+        parsed, injected, errors = Native.parse_dotenv(JSON.generate(
+          source: source,
+          process_env: process_env,
+          overwrite: overwrite == true,
+          key_files: key_files(path)
+        ))
+        handle_errors(errors, ignore: ignore, strict: strict)
+        parsed = parsed.to_h
+        injected.each { |key, _value| injected_keys[key] = true }
+        loaded_paths << path
+        process_env.merge!(parsed)
+        accumulator.merge!(parsed)
+        yield Environment.new(path, parsed) if block_given?
+        accumulator
+      end
+      [values, injected_keys.keys, loaded_paths]
+    end
+
+    def handle_errors(errors, ignore:, strict:)
+      ignored_codes = Array(ignore).grep(String)
+      errors.each do |code, message|
+        next if ignored_codes.include?(code)
+
+        raise ParseError.new(code, message) if strict
+
+        warn "☠ #{message}"
+      end
+    end
+
+    def ignore_missing?(ignore)
+      ignore == true || Array(ignore).map(&:to_s).include?("MISSING_ENV_FILE")
+    end
+
+    def log_injected(injected_keys, loaded_paths)
+      message = "⟐ injected env (#{injected_keys.length})"
+      unless loaded_paths.empty?
+        paths = loaded_paths.map { |path| readable_path(path) }
+        message = "#{message} from #{paths.join(", ")}"
+      end
+      warn message
+    end
+
+    def readable_path(path)
+      pathname = Pathname.new(path)
+      relative = pathname.relative_path_from(Pathname.pwd).to_s
+      relative.start_with?("../") ? pathname.to_s : relative
+    rescue ArgumentError
+      pathname.to_s
+    end
+
     def key_files(path)
       candidates = ["#{path}.keys", File.join(File.dirname(path), ".env.keys")]
       candidates.select { |candidate| File.file?(candidate) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dotenvx
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 4.0.5
 platform: x86_64-linux
 authors:
 - motdotla