dotenvx 4.0.3 → 4.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbc11188493670e456723d7d984cb3118d3c9e3abaaba8652a5650f9b99c7d14
-  data.tar.gz: eaa5409b065a89f9105109f3b955f0ae68c43e137c7a35cd99103fe290572240
+  metadata.gz: 8b598e9f335c0ce4bcec51dd215f72e75c9735dc389b167139e29a60595aa696
+  data.tar.gz: d0d03d0e33828498a6ee322689a51856ded35b99cf2dfa68c7dcd5efd87e2230
 SHA512:
-  metadata.gz: 31b8875875fa83cdb13ff2ec5a3660ce9cf637c5eed17aa1cfa7ea3d66ab0ca451f5d8a9c1d31f6c7b0f739e0767b3e361e77b6e1b814660e4591886e931011c
-  data.tar.gz: 720420e1e1f2018215c47d9b1064449ca6699b277bcc3cdfc6f4506f69b45d2255dc433b4182118a398ecf5578d8b3c6fd68e93c0faaf426b4533bb95c38f7dd
+  metadata.gz: af0097282ab2fa863d4fc334ec92def248282b700dcfa679c0e8c7340c4a8c31655efd7be3c48b6675d0d6c8e317b5e55df84a70e7aea7693e4a1b44ee71eeb8
+  data.tar.gz: 11f12169e0788357b768ec967699eb14dce3fb78726b208a4d9ab58613fb61f63f45828e0776b49c15fed93f255df223cc1570ebf0a53708357abaf727ff24c1

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/Cargo.lock

@@ -222,7 +222,7 @@ dependencies = [
 
 [[package]]
 name = "dotenvx_native"
-version = "4.0.3"
+version = "4.0.5"
 dependencies = [
  "dotenvx-primitives",
  "magnus",

data/ext/dotenvx/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "dotenvx_native"
-version = "4.0.3"
+version = "4.0.5"
 edition = "2021"
 rust-version = "1.83"
 publish = false

data/ext/dotenvx/src/lib.rs

@@ -5,6 +5,7 @@ use std::collections::HashMap;
 use std::path::PathBuf;
 
 type StringPairs = Vec<(String, String)>;
+type ErrorPairs = Vec<(String, String)>;
 
 fn runtime_error(message: impl Into<String>) -> Error {
     let ruby = Ruby::get().expect("Ruby VM is not available");
@@ -21,18 +22,17 @@ fn scalar_values(values: HashMap<String, Value>) -> StringPairs {
         .collect()
 }
 
-fn parse_result(result: ParseResult) -> Result<(StringPairs, StringPairs), Error> {
-    if !result.errors.is_empty() {
-        let message = result
-            .errors
-            .iter()
-            .map(ToString::to_string)
-            .collect::<Vec<_>>()
-            .join("\n");
-        return Err(runtime_error(message));
-    }
-
-    Ok((scalar_values(result.parsed), scalar_values(result.injected)))
+fn parse_result(result: ParseResult) -> (StringPairs, StringPairs, ErrorPairs) {
+    let errors = result
+        .errors
+        .iter()
+        .map(|error| (error.code().to_owned(), error.to_string()))
+        .collect();
+    (
+        scalar_values(result.parsed),
+        scalar_values(result.injected),
+        errors,
+    )
 }
 
 #[derive(Deserialize)]
@@ -43,7 +43,7 @@ struct ParseInput {
     key_files: Vec<String>,
 }
 
-fn parse_dotenv(input_json: String) -> Result<(StringPairs, StringPairs), Error> {
+fn parse_dotenv(input_json: String) -> Result<(StringPairs, StringPairs, ErrorPairs), Error> {
     let input = serde_json::from_str::<ParseInput>(&input_json)
         .map_err(|error| runtime_error(error.to_string()))?;
     let process_env = input.process_env;
@@ -54,7 +54,7 @@ fn parse_dotenv(input_json: String) -> Result<(StringPairs, StringPairs), Error>
     })
     .map_err(|error| runtime_error(error.to_string()))?;
 
-    parse_result(parse(
+    Ok(parse_result(parse(
         &input.source,
         &ParseOptions {
             process_env,
@@ -62,7 +62,7 @@ fn parse_dotenv(input_json: String) -> Result<(StringPairs, StringPairs), Error>
             ring,
             ..Default::default()
         },
-    ))
+    )))
 }
 
 #[magnus::init]

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: ruby
 authors:
 - motdotla