dotenvx 4.0.0-x86_64-linux

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 44d08d55899e58515b0e39e447db6cb3d67c274869d8a7c30d8a4f982beca08c
+  data.tar.gz: 7f51dd64512d1ec4b3ca06480a45cf67efc0839b183d36e59b525dd6b5d42491
+SHA512:
+  metadata.gz: afb09d52f18138dd5669860727a7cbea047d30f390bb4bc7046a38510c2e21d14dc67d951e860e5d8ccdc25864ca5720d09411bf3fc8c65177456a76193e6764
+  data.tar.gz: b23da2b9b513d2dd9b1ddaee1e7bd07ff9957aeb3b36b65fc10fca07b4f8ba94a35ed0aa58c262ac037ceb9eafd50be4eb91ff25f225f7f4cfa1c6c0a66a00a5

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+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)
+
+## [4.0.0](https://github.com/dotenvx/dotenvx-ruby/compare/v0.0.2...v4.0.0)
+
+- Load plaintext and encrypted dotenv files through `dotenvx-primitives`.
+- Bundle the Rust implementation as a Magnus native extension.
+- Match the conventional Ruby dotenv loading, parsing, overwrite, and strict
+  missing-file APIs.
+- Publish native `dotenvx` gems for Linux, macOS, and Windows from one tag.
+
+## 0.1.0 and prior
+
+Please see commit history.

data/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Scott Motte
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,83 @@
+[![dotenvx](https://dotenvx.com/better-banner.png)](https://dotenvx.com)
+
+*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.
+
+## Install
+
+```sh
+gem install dotenvx
+```
+
+Or add it to a Gemfile:
+
+```ruby
+gem "dotenvx"
+```
+
+## Use
+
+Load `.env` from the current directory:
+
+```ruby
+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`:
+
+```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/lib/dotenvx/load.rb

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

data/lib/dotenvx/rails.rb

@@ -0,0 +1,62 @@
+require "dotenvx"
+require "active_support/notifications"
+require "rails/railtie"
+require "pathname"
+
+# Fix for rake tasks loading in development
+#
+# Dotenv loads environment variables when the Rails application is initialized.
+# When running `rake`, the Rails application is initialized in development.
+# Rails includes some hacks to set `RAILS_ENV=test` when running `rake test`,
+# but rspec does not include the same hacks.
+#
+# See https://github.com/bkeepers/dotenv/issues/219
+if defined?(Rake.application)
+  task_regular_expression = /^(default$|parallel:spec|spec(:|$))/
+  if Rake.application.top_level_tasks.grep(task_regular_expression).any?
+    environment = Rake.application.options.show_tasks ? "development" : "test"
+    Rails.env = ENV["RAILS_ENV"] ||= environment
+  end
+end
+
+Dotenvx.instrumenter = ActiveSupport::Notifications
+
+# Watch all loaded env files with Spring
+begin
+  require "spring/commands"
+  ActiveSupport::Notifications.subscribe(/^dotenv/) do |*args|
+    event = ActiveSupport::Notifications::Event.new(*args)
+    Spring.watch event.payload[:env].filename if Rails.application
+  end
+rescue LoadError, ArgumentError
+  # Spring is not available
+end
+
+module Dotenvx
+  class Railtie < Rails::Railtie
+    config.before_configuration { Dotenvx::Railtie.instance.load }
+
+    def load
+      Dotenvx.load(*dotenvx_files)
+    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

@@ -0,0 +1,3 @@
+module Dotenvx
+  VERSION = "4.0.0"
+end

data/lib/dotenvx.rb

@@ -0,0 +1,108 @@
+require "dotenvx/version"
+require "dotenvx/dotenvx_native"
+
+module Dotenvx
+  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 = parse(*filenames, overwrite: overwrite, ignore: ignore)
+      update(env, overwrite: overwrite)
+    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)
+      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(
+          source,
+          process_env.to_a,
+          overwrite == true,
+          key_files(path)
+        )
+        parsed = parsed.to_h
+        process_env.merge!(parsed)
+        values.merge!(parsed)
+        yield Environment.new(path, parsed) if block_given?
+        values
+      end
+    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 key_files(path)
+      basename = File.basename(path)
+      candidates = ["#{path}.keys"]
+      candidates << File.join(File.dirname(path), ".env.keys") unless basename == ".env"
+      candidates.select { |candidate| File.file?(candidate) }
+    end
+  end
+
+  class Environment < Hash
+    attr_reader :filename
+
+    def initialize(filename, values)
+      @filename = filename
+      super()
+      update(values)
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: dotenvx
+version: !ruby/object:Gem::Version
+  version: 4.0.0
+platform: x86_64-linux
+authors:
+- motdotla
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "[dotenvx.com] a better dotenv–from the creator of `dotenv`"
+email:
+- mot@mot.la
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/dotenvx.rb
+- lib/dotenvx/dotenvx_native.so
+- lib/dotenvx/load.rb
+- lib/dotenvx/rails.rb
+- lib/dotenvx/version.rb
+homepage: https://github.com/dotenvx/dotenvx-ruby
+licenses:
+- BSD-3-Clause
+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
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.11
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: "[dotenvx.com] a better dotenv–from the creator of `dotenv`"
+test_files: []