dotenvx 0.0.2 → 4.0.4

data/Cargo.toml

@@ -0,0 +1,3 @@
+[workspace]
+members = ["ext/dotenvx"]
+resolver = "2"

data/README.md

@@ -1,31 +1,83 @@
->
-> Warning: work in progress. until complete, please use [github.com/dotenvx/dotenvx](https://github.com/dotenvx/dotenvx)
->
-
 [![dotenvx](https://dotenvx.com/better-banner.png)](https://dotenvx.com)
 
-*a better dotenv*–from the creator of [`dotenv`](https://github.com/motdotla/dotenv).
-
-* run anywhere (cross-platform)
-* multi-environment
-* encrypted envs
-
- 
+*a secure dotenv–from the creator of [`dotenv`](https://github.com/motdotla/dotenv).*
 
+`dotenvx` loads plaintext and encrypted dotenv files through the shared
+[`dotenvx-primitives`](https://crates.io/crates/dotenvx-primitives) Rust
+implementation. The native extension is bundled in the gem; users do not need
+Node.js, a dotenvx CLI, or a Rust toolchain.
 
-### Quickstart [![Gem Version](https://badge.fury.io/rb/dotenvx.svg)](https://badge.fury.io/rb/dotenvx)
-
-Install and use it in code just like ruby `dotenv`.
+## Install
 
 ```sh
 gem install dotenvx
 ```
+
+Or add it to a Gemfile:
+
+```ruby
+gem "dotenvx"
+```
+
+## Use
+
+Load `.env` from the current directory:
+
 ```ruby
-# index.rb
 require "dotenvx/load"
+```
+
+Or load explicitly:
+
+```ruby
+require "dotenvx"
+
+Dotenvx.load
+Dotenvx.load(".env.local", ".env")
+```
+
+Existing environment variables win by default:
+
+```ruby
+Dotenvx.load(".env")
+```
+
+To replace existing values:
+
+```ruby
+Dotenvx.load(".env", overwrite: true)
+Dotenvx.overwrite(".env")
+```
+
+Parse without changing `ENV`:
 
-puts "Hello #{ENV["HELLO"]}"
+```ruby
+values = Dotenvx.parse(".env")
 ```
 
- 
+Raise when a file is missing:
+
+```ruby
+Dotenvx.load!(".env")
+```
+
+Require configuration keys:
+
+```ruby
+Dotenvx.require_keys("DATABASE_URL", "SECRET_KEY")
+```
+
+Encrypted values are decrypted automatically when the matching private key is
+available through the process environment, `<filename>.keys`, or `.env.keys`.
+
+## Native platforms
+
+Tagged releases publish variants of the same `dotenvx` gem for:
+
+- Linux x86-64
+- Linux ARM64
+- macOS Intel
+- macOS Apple Silicon
+- Windows x64
 
+RubyGems selects the correct variant during `gem install dotenvx`.

data/ext/dotenvx/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "dotenvx_native"
+version = "4.0.4"
+edition = "2021"
+rust-version = "1.83"
+publish = false
+
+[lib]
+name = "dotenvx_native"
+crate-type = ["cdylib"]
+
+[dependencies]
+dotenvx-primitives = "=2.2.0"
+magnus = "0.8"
+rb-sys = { version = "0.9.128", default-features = false, features = ["stable-api-compiled-force"] }
+serde = { version = "1", features = ["derive"] }
+serde_json = "1"

data/ext/dotenvx/extconf.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "mkmf"
+require "rb_sys/mkmf"
+
+create_rust_makefile("dotenvx/dotenvx_native")

data/ext/dotenvx/src/lib.rs

@@ -0,0 +1,74 @@
+use dotenvx_primitives::{keyring, parse, KeyringOptions, ParseOptions, ParseResult, Value};
+use magnus::{function, prelude::*, Error, Ruby};
+use serde::Deserialize;
+use std::collections::HashMap;
+use std::path::PathBuf;
+
+type StringPairs = Vec<(String, String)>;
+
+fn runtime_error(message: impl Into<String>) -> Error {
+    let ruby = Ruby::get().expect("Ruby VM is not available");
+    Error::new(ruby.exception_runtime_error(), message.into())
+}
+
+fn scalar_values(values: HashMap<String, Value>) -> StringPairs {
+    values
+        .into_iter()
+        .filter_map(|(key, value)| match value {
+            Value::Scalar(value) => Some((key, value)),
+            Value::Array(_) => None,
+        })
+        .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)))
+}
+
+#[derive(Deserialize)]
+struct ParseInput {
+    source: String,
+    process_env: HashMap<String, String>,
+    overwrite: bool,
+    key_files: Vec<String>,
+}
+
+fn parse_dotenv(input_json: String) -> Result<(StringPairs, StringPairs), Error> {
+    let input = serde_json::from_str::<ParseInput>(&input_json)
+        .map_err(|error| runtime_error(error.to_string()))?;
+    let process_env = input.process_env;
+    let ring = keyring(&KeyringOptions {
+        process_env: process_env.clone(),
+        key_files: input.key_files.into_iter().map(PathBuf::from).collect(),
+        ..Default::default()
+    })
+    .map_err(|error| runtime_error(error.to_string()))?;
+
+    parse_result(parse(
+        &input.source,
+        &ParseOptions {
+            process_env,
+            overload: input.overwrite,
+            ring,
+            ..Default::default()
+        },
+    ))
+}
+
+#[magnus::init]
+fn init(ruby: &Ruby) -> Result<(), Error> {
+    let dotenvx = ruby.define_module("Dotenvx")?;
+    let native = dotenvx.define_module("Native")?;
+    native.define_singleton_method("parse_dotenv", function!(parse_dotenv, 1))?;
+    Ok(())
+}

data/lib/dotenvx/load.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "dotenvx"
+
+Dotenvx.load

data/lib/dotenvx/rails.rb

@@ -1,4 +1,7 @@
 require "dotenvx"
+require "active_support/notifications"
+require "rails/railtie"
+require "pathname"
 
 # Fix for rake tasks loading in development
 #
@@ -30,9 +33,33 @@ rescue LoadError, ArgumentError
 end
 
 module Dotenvx
-  class Railtie
+  class Railtie < Rails::Railtie
+    config.before_configuration { Dotenvx::Railtie.instance.load }
+
     def load
+      return if @loaded
+
       Dotenvx.load(*dotenvx_files)
+      @loaded = true
+    end
+
+    private
+
+    def dotenvx_files
+      environment = Rails.env
+      files = [
+        root.join(".env.#{environment}.local")
+      ]
+      files << root.join(".env.local") unless environment == "test"
+      files.concat([
+        root.join(".env.#{environment}"),
+        root.join(".env")
+      ])
+      files
+    end
+
+    def root
+      Pathname.new(Rails.root || ENV["RAILS_ROOT"] || Dir.pwd)
     end
   end
 end

data/lib/dotenvx/version.rb

@@ -1,3 +1,3 @@
 module Dotenvx
-  VERSION = "0.0.2"
+  VERSION = "4.0.4"
 end

data/lib/dotenvx.rb

@@ -1,7 +1,141 @@
 require "dotenvx/version"
+require "dotenvx/dotenvx_native"
+require "json"
+require "pathname"
 
 module Dotenvx
-  def load(*filenames)
-    raise "go to [github.com/dotenvx/dotenvx] and follow ruby directions there"
+  class MissingKeys < RuntimeError
+    attr_reader :keys
+
+    def initialize(keys)
+      @keys = keys
+      super("Missing required configuration keys: #{keys.join(", ")}")
+    end
+  end
+
+  class << self
+    attr_accessor :instrumenter
+
+    def load(*filenames, overwrite: false, ignore: true)
+      env, injected_keys, loaded_paths = parse_files(
+        *filenames,
+        overwrite: overwrite,
+        ignore: ignore
+      )
+      changed = update(env, overwrite: overwrite)
+      log_injected(injected_keys, loaded_paths)
+      changed
+    end
+
+    def load!(*filenames)
+      load(*filenames, ignore: false)
+    end
+
+    def overwrite(*filenames)
+      load(*filenames, overwrite: true)
+    end
+    alias overload overwrite
+
+    def overwrite!(*filenames)
+      load(*filenames, overwrite: true, ignore: false)
+    end
+    alias overload! overwrite!
+
+    def parse(*filenames, overwrite: false, ignore: true)
+      parse_files(*filenames, overwrite: overwrite, ignore: ignore).first
+    end
+
+    def update(env = {}, overwrite: false)
+      changed = {}
+      env.each do |key, value|
+        key = key.to_s
+        next if ENV.key?(key) && overwrite == false
+
+        if ENV.key?(key) && overwrite == :warn
+          warn "Warning: dotenvx not overwriting ENV[#{key.inspect}]"
+          next
+        end
+        unless [true, false, :warn].include?(overwrite)
+          raise ArgumentError, "Invalid value for overwrite: #{overwrite.inspect}"
+        end
+
+        ENV[key] = value.to_s
+        changed[key] = value.to_s
+      end
+      changed
+    end
+
+    def require_keys(*keys)
+      missing = keys.flatten.map(&:to_s) - ENV.keys
+      raise MissingKeys, missing unless missing.empty?
+    end
+
+    private
+
+    def parse_files(*filenames, overwrite: false, ignore: true)
+      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
+          next accumulator
+        end
+
+        parsed, injected = Native.parse_dotenv(JSON.generate(
+          source: source,
+          process_env: process_env,
+          overwrite: overwrite == true,
+          key_files: key_files(path)
+        ))
+        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 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) }
+        .uniq
+    end
+  end
+
+  class Environment < Hash
+    attr_reader :filename
+
+    def initialize(filename, values)
+      @filename = filename
+      super()
+      update(values)
+    end
   end
 end

metadata

@@ -1,29 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: dotenvx
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 4.0.4
 platform: ruby
 authors:
 - motdotla
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rb_sys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -56,22 +83,20 @@ description: "[dotenvx.com] a better dotenv–from the creator of `dotenv`"
 email:
 - mot@mot.la
 executables: []
-extensions: []
+extensions:
+- ext/dotenvx/extconf.rb
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
 - CHANGELOG.md
-- DEVELOPMENT.md
-- Gemfile
-- Gemfile.lock
+- Cargo.lock
+- Cargo.toml
 - LICENSE
 - README.md
-- Rakefile
-- dotenvx-rails.gemspec
-- dotenvx.gemspec
-- lib/dotenvx-rails.rb
+- ext/dotenvx/Cargo.toml
+- ext/dotenvx/extconf.rb
+- ext/dotenvx/src/lib.rs
 - lib/dotenvx.rb
+- lib/dotenvx/load.rb
 - lib/dotenvx/rails.rb
 - lib/dotenvx/version.rb
 homepage: https://github.com/dotenvx/dotenvx-ruby
@@ -81,7 +106,6 @@ metadata:
   homepage_uri: https://github.com/dotenvx/dotenvx-ruby
   source_code_uri: https://github.com/dotenvx/dotenvx-ruby
   changelog_uri: https://github.com/dotenvx/dotenvx-ruby
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -89,15 +113,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.3.11
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: "[dotenvx.com] a better dotenv–from the creator of `dotenv`"
 test_files: []

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-.DS_Store
-.byebug_history

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/DEVELOPMENT.md

@@ -1,4 +0,0 @@
-## Development
-
-1. Bump `dotenvx/version.rb` and tag version
-2. rake release

data/Gemfile

@@ -1,8 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in dotenvx.gemspec
-gemspec name: "dotenvx"
-gemspec name: "dotenvx-rails"
-
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -1,42 +0,0 @@
-PATH
-  remote: .
-  specs:
-    dotenvx (0.0.1)
-    dotenvx-rails (0.0.1)
-      dotenvx (= 0.0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    byebug (11.1.3)
-    diff-lcs (1.5.1)
-    rake (12.3.3)
-    rspec (3.13.0)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.1)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    spring (4.2.1)
-
-PLATFORMS
-  arm64-darwin-23
-  ruby
-
-DEPENDENCIES
-  byebug
-  dotenvx!
-  dotenvx-rails!
-  rake (~> 12.0)
-  rspec (~> 3.0)
-  spring
-
-BUNDLED WITH
-   2.5.11

data/Rakefile

@@ -1,35 +0,0 @@
-#!/usr/bin/env rake
-
-require "bundler/gem_helper"
-
-namespace "dotenvx" do
-  Bundler::GemHelper.install_tasks name: "dotenvx"
-end
-
-class DotenvxRailsGemHelper < Bundler::GemHelper
-  def guard_already_tagged
-    # noop
-  end
-
-  def tag_version
-    # noop
-  end
-end
-
-namespace "dotenvx-rails" do
-  DotenvxRailsGemHelper.install_tasks name: "dotenvx-rails"
-end
-
-task build: ["dotenvx:build", "dotenvx-rails:build"]
-task install: ["dotenvx:install", "dotenvx-rails:install"]
-task release: ["dotenvx:release", "dotenvx-rails:release"]
-
-require "rspec/core/rake_task"
-
-desc "Run all specs"
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = %w[--color]
-  t.verbose = false
-end
-
-task :default => :spec

data/dotenvx-rails.gemspec

@@ -1,32 +0,0 @@
-require_relative 'lib/dotenvx/version'
-
-Gem::Specification.new "dotenvx-rails" do |spec|
-  spec.name          = "dotenvx-rails"
-  spec.version       = Dotenvx::VERSION
-  spec.authors       = ["motdotla"]
-  spec.email         = ["mot@mot.la"]
-
-  spec.summary       = %q{[dotenvx.com] a better dotenv–from the creator of `dotenv`}
-  spec.description   = %q{[dotenvx.com] a better dotenv–from the creator of `dotenv`}
-  spec.homepage      = "https://github.com/dotenvx/dotenvx-ruby"
-  spec.license       = "BSD-3-Clause"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/dotenvx/dotenvx-ruby"
-  spec.metadata["changelog_uri"] = "https://github.com/dotenvx/dotenvx-ruby"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-	spec.add_dependency "dotenvx", Dotenvx::VERSION
-
-	spec.add_development_dependency "spring"
-	spec.add_development_dependency "byebug"
-end