philiprehberger-env_diff 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f899f72163df3e8b9123a330fe7318f4d0321af12ff8e09c775aac59ec2d1e2b
+  data.tar.gz: ecc0e0a18cb186726f5f3513ff0295ec75f524572aa3f34e69010de63b6823d1
+SHA512:
+  metadata.gz: 9fc0c09f9ef69d24068a860505f798d296b22c008d0fdd73fb16558de7484b738240fe85fc00df6baf4aaa585f4547340ad561681cf5c6a595673f3c5e148033
+  data.tar.gz: 5a51de272a472f5b59503ace4dc4db44de75fe996ea55aa4c4a91b0940bec471742f77c575e5cf0732702e15af34a457f5447869e4cbd4e90db2e6ee2b8a3be5

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this gem will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.2] - 2026-03-13
+
+### Fixed
+- Fix RuboCop ExtraSpacing offense in gemspec metadata
+
+## [0.1.0] - 2026-03-13
+
+### Added
+- Initial release
+- Compare two environment variable hashes and report added, removed, changed, and unchanged keys
+- Parse `.env` files with support for comments, blank lines, quoted values, and `export` prefix
+- `Diff` class with `changed?` predicate and human-readable `summary`
+- Module-level `compare`, `from_hash`, and `from_env_file` convenience methods

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 philiprehberger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,99 @@
+# philiprehberger-env_diff
+
+[![Tests](https://github.com/philiprehberger/rb-env-diff/actions/workflows/ci.yml/badge.svg)](https://github.com/philiprehberger/rb-env-diff/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/philiprehberger-env_diff.svg)](https://rubygems.org/gems/philiprehberger-env_diff)
+
+Compare environment variables across environments and report differences.
+
+## Requirements
+
+- Ruby >= 3.1
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "philiprehberger-env_diff"
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+Or install directly:
+
+```bash
+gem install philiprehberger-env_diff
+```
+
+## Usage
+
+```ruby
+require "philiprehberger/env_diff"
+
+# Compare two hashes
+source = { "DATABASE_URL" => "postgres://localhost/dev", "SECRET" => "abc", "OLD_KEY" => "remove_me" }
+target = { "DATABASE_URL" => "postgres://prod-host/app", "SECRET" => "abc", "NEW_KEY" => "added" }
+
+diff = Philiprehberger::EnvDiff.compare(source, target)
+
+diff.added     # => ["NEW_KEY"]
+diff.removed   # => ["OLD_KEY"]
+diff.changed   # => { "DATABASE_URL" => { source: "postgres://localhost/dev", target: "postgres://prod-host/app" } }
+diff.unchanged # => ["SECRET"]
+diff.changed?  # => true
+puts diff.summary
+# + NEW_KEY
+# - OLD_KEY
+# ~ DATABASE_URL: "postgres://localhost/dev" -> "postgres://prod-host/app"
+```
+
+### Compare .env files
+
+```ruby
+diff = Philiprehberger::EnvDiff.from_env_file(".env.development", ".env.production")
+puts diff.summary
+```
+
+### Parse .env files
+
+```ruby
+vars = Philiprehberger::EnvDiff::Parser.parse(<<~ENV)
+  # Database config
+  DATABASE_URL=postgres://localhost/dev
+  export SECRET_KEY="my-secret"
+  APP_NAME='my-app'
+ENV
+# => { "DATABASE_URL" => "postgres://localhost/dev", "SECRET_KEY" => "my-secret", "APP_NAME" => "my-app" }
+```
+
+## API
+
+| Method / Class | Description |
+|----------------|-------------|
+| `EnvDiff.compare(source, target)` | Compare two hashes and return a `Diff` |
+| `EnvDiff.from_hash(hash_a, hash_b)` | Alias for `compare` |
+| `EnvDiff.from_env_file(path_a, path_b)` | Parse two `.env` files and compare them |
+| `Diff#added` | Array of keys in target but not source |
+| `Diff#removed` | Array of keys in source but not target |
+| `Diff#changed` | Hash of keys with different values |
+| `Diff#unchanged` | Array of keys with identical values |
+| `Diff#changed?` | `true` if any differences exist |
+| `Diff#summary` | Human-readable multiline diff string |
+| `Parser.parse(content)` | Parse `.env` string into a hash |
+| `Parser.parse_file(path:)` | Read and parse a `.env` file |
+
+## Development
+
+```bash
+bundle install
+bundle exec rspec      # Run tests
+bundle exec rubocop    # Check code style
+```
+
+## License
+
+MIT

data/lib/philiprehberger/env_diff/diff.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module EnvDiff
+    # Represents the result of comparing two sets of environment variables.
+    class Diff
+      # @return [Array<String>] keys present in target but not source
+      attr_reader :added
+
+      # @return [Array<String>] keys present in source but not target
+      attr_reader :removed
+
+      # @return [Hash{String => Hash}] keys with different values ({ key => { source:, target: } })
+      attr_reader :changed
+
+      # @return [Array<String>] keys with identical values in both sets
+      attr_reader :unchanged
+
+      # Build a diff from two environment hashes.
+      #
+      # @param source [Hash] the baseline environment hash
+      # @param target [Hash] the environment hash to compare against
+      def initialize(source, target)
+        @added = (target.keys - source.keys).sort
+        @removed = (source.keys - target.keys).sort
+        @changed = build_changed(source, target)
+        @unchanged = build_unchanged(source, target)
+      end
+
+      # Whether there are any differences between source and target.
+      #
+      # @return [Boolean] true if added, removed, or changed are non-empty
+      def changed?
+        !@added.empty? || !@removed.empty? || !@changed.empty?
+      end
+
+      # Human-readable multiline summary of all differences.
+      #
+      # @return [String] formatted summary
+      def summary
+        lines = []
+        append_added(lines)
+        append_removed(lines)
+        append_changed(lines)
+        lines.empty? ? "No differences found." : lines.join("\n")
+      end
+
+      private
+
+      def build_changed(source, target)
+        common = source.keys & target.keys
+        common.each_with_object({}) do |key, hash|
+          next if source[key] == target[key]
+
+          hash[key] = { source: source[key], target: target[key] }
+        end
+      end
+
+      def build_unchanged(source, target)
+        common = source.keys & target.keys
+        common.select { |key| source[key] == target[key] }.sort
+      end
+
+      def append_added(lines)
+        @added.each { |key| lines << "+ #{key}" }
+      end
+
+      def append_removed(lines)
+        @removed.each { |key| lines << "- #{key}" }
+      end
+
+      def append_changed(lines)
+        @changed.each do |key, vals|
+          lines << "~ #{key}: #{vals[:source].inspect} -> #{vals[:target].inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/philiprehberger/env_diff/parser.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module EnvDiff
+    # Parses .env file content into a key-value hash.
+    module Parser
+      # Parse a string of env file content into a hash.
+      #
+      # @param content [String] the raw .env file content
+      # @return [Hash{String => String}] parsed key-value pairs
+      def self.parse(content)
+        result = {}
+        content.each_line do |line|
+          key, value = parse_line(line.strip)
+          result[key] = value if key
+        end
+        result
+      end
+
+      # Read a file and parse its content.
+      #
+      # @param path [String] path to the .env file
+      # @return [Hash{String => String}] parsed key-value pairs
+      # @raise [Errno::ENOENT] if the file does not exist
+      def self.parse_file(path:)
+        parse(File.read(path))
+      end
+
+      # Parse a single line from an env file.
+      #
+      # @param line [String] a stripped line
+      # @return [Array(String, String), nil] key-value pair or nil
+      def self.parse_line(line)
+        return nil if line.empty? || line.start_with?("#")
+
+        line = line.sub(/\Aexport\s+/, "")
+        key, _, value = line.partition("=")
+        return nil if key.empty? || value.nil?
+
+        [key.strip, unquote(value.strip)]
+      end
+      private_class_method :parse_line
+
+      # Remove surrounding quotes from a value.
+      #
+      # @param value [String] the raw value
+      # @return [String] the unquoted value
+      def self.unquote(value)
+        if (value.start_with?('"') && value.end_with?('"')) ||
+           (value.start_with?("'") && value.end_with?("'"))
+          return value[1..-2]
+        end
+
+        value
+      end
+      private_class_method :unquote
+    end
+  end
+end

data/lib/philiprehberger/env_diff/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module EnvDiff
+    VERSION = "0.1.2"
+  end
+end

data/lib/philiprehberger/env_diff.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "env_diff/version"
+require_relative "env_diff/diff"
+require_relative "env_diff/parser"
+
+module Philiprehberger
+  module EnvDiff
+    class Error < StandardError; end
+
+    # Compare two environment hashes and return a Diff.
+    #
+    # @param source [Hash] the baseline environment hash
+    # @param target [Hash] the environment hash to compare against
+    # @return [Diff] the computed differences
+    def self.compare(source, target)
+      Diff.new(source, target)
+    end
+
+    # Alias for compare — compare two hashes.
+    #
+    # @param hash_a [Hash] the baseline environment hash
+    # @param hash_b [Hash] the environment hash to compare against
+    # @return [Diff] the computed differences
+    def self.from_hash(hash_a, hash_b)
+      compare(hash_a, hash_b)
+    end
+
+    # Parse two .env files and compare them.
+    #
+    # @param path_a [String] path to the source .env file
+    # @param path_b [String] path to the target .env file
+    # @return [Diff] the computed differences
+    def self.from_env_file(path_a, path_b)
+      compare(Parser.parse_file(path: path_a), Parser.parse_file(path: path_b))
+    end
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: philiprehberger-env_diff
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Philip Rehberger
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-13 00:00:00.000000000 Z
+dependencies: []
+description: Parse .env files or environment hashes, compare them, and get a clear
+  report of added, removed, changed, and unchanged variables.
+email:
+- me@philiprehberger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/philiprehberger/env_diff.rb
+- lib/philiprehberger/env_diff/diff.rb
+- lib/philiprehberger/env_diff/parser.rb
+- lib/philiprehberger/env_diff/version.rb
+homepage: https://github.com/philiprehberger/rb-env-diff
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/philiprehberger/rb-env-diff
+  source_code_uri: https://github.com/philiprehberger/rb-env-diff
+  changelog_uri: https://github.com/philiprehberger/rb-env-diff/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Compare environment variables across environments and report differences
+test_files: []