philiprehberger-differ 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 96c88d008a0fb8168a7038993cc1f189f2a8aa62088945665d24e7b37737d761
+  data.tar.gz: a79dd26f9cad34c542d8676b280788ae05b92f1e1a5f20d1dc82658b0d551890
+SHA512:
+  metadata.gz: bd3744a25e0395061247952151faafbd37559ca515e2bef30ad0a248cfa06ca3bed731027681eccec1fc6d9d53b20c4774ddd68d414082696dfde83dd3536040
+  data.tar.gz: '014894c94e4bb8409eb6badcb157c43bdbdc4878fe0c9521e882fd4bc44ef721e099821aa087623e06de83e201fb79ec0c84e163066db2c003ef5787c5490d48'

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# 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.0] - 2026-03-15
+
+### Added
+- Initial release
+- Deep comparison of hashes arrays and nested structures
+- Path-based change descriptions
+- Patch and unpatch support
+- Serializable changeset output

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,86 @@
+# philiprehberger-differ
+
+[![Gem Version](https://badge.fury.io/rb/philiprehberger-differ.svg)](https://rubygems.org/gems/philiprehberger-differ)
+
+Deep structural diff for hashes, arrays, and nested objects in Ruby.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'philiprehberger-differ'
+```
+
+Or install directly:
+
+```sh
+gem install philiprehberger-differ
+```
+
+## Usage
+
+```ruby
+require 'philiprehberger/differ'
+
+old_data = { name: 'Alice', age: 30, address: { city: 'Berlin' } }
+new_data = { name: 'Alice', age: 31, address: { city: 'Vienna' }, email: 'alice@example.com' }
+
+changeset = Philiprehberger::Differ.diff(old_data, new_data)
+
+changeset.changed?   # => true
+changeset.changes    # => [Change, Change, ...]
+changeset.added      # => changes where type == :added
+changeset.removed    # => changes where type == :removed
+changeset.changed    # => changes where type == :changed
+
+# Apply changes to produce new version from old
+result = changeset.apply(old_data)
+
+# Revert changes to produce old version from new
+original = changeset.revert(new_data)
+
+# Ignore specific paths
+changeset = Philiprehberger::Differ.diff(old_data, new_data, ignore: ['age'])
+```
+
+## API
+
+### `Philiprehberger::Differ.diff(old_val, new_val, ignore: [])`
+
+Returns a `Changeset` representing all structural differences.
+
+### `Changeset`
+
+| Method | Description |
+|---|---|
+| `changed?` | Returns `true` if any differences exist |
+| `changes` | All `Change` objects |
+| `added` | Changes where `type == :added` |
+| `removed` | Changes where `type == :removed` |
+| `changed` | Changes where `type == :changed` |
+| `apply(hash)` | Applies changes to produce the new version |
+| `revert(hash)` | Reverts changes to produce the old version |
+| `to_h` | Serializable hash representation |
+
+### `Change`
+
+| Attribute | Description |
+|---|---|
+| `path` | Dot-notation path to the changed value |
+| `type` | `:added`, `:removed`, or `:changed` |
+| `old_value` | Previous value (`nil` for additions) |
+| `new_value` | New value (`nil` for removals) |
+| `to_s` | Human-readable string |
+| `to_h` | Serializable hash |
+
+## Development
+
+```sh
+bundle install
+bundle exec rspec
+```
+
+## License
+
+MIT

data/lib/philiprehberger/differ/change.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module Differ
+    class Change
+      attr_reader :path, :type, :old_value, :new_value
+
+      def initialize(path:, type:, old_value: nil, new_value: nil)
+        @path = path
+        @type = type
+        @old_value = old_value
+        @new_value = new_value
+      end
+
+      def to_s
+        case type
+        when :added   then "Added #{path}: #{new_value.inspect}"
+        when :removed then "Removed #{path}: #{old_value.inspect}"
+        when :changed then "Changed #{path}: #{old_value.inspect} -> #{new_value.inspect}"
+        end
+      end
+
+      def to_h
+        { path: path, type: type, old_value: old_value, new_value: new_value }
+      end
+    end
+  end
+end

data/lib/philiprehberger/differ/changeset.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module Differ
+    class Changeset
+      attr_reader :changes
+
+      def initialize(changes = [])
+        @changes = changes
+      end
+
+      def changed?
+        !@changes.empty?
+      end
+
+      def added
+        @changes.select { |c| c.type == :added }
+      end
+
+      def removed
+        @changes.select { |c| c.type == :removed }
+      end
+
+      def changed
+        @changes.select { |c| c.type == :changed }
+      end
+
+      def apply(hash)
+        result = deep_dup(hash)
+        @changes.each { |c| apply_change(result, c) }
+        result
+      end
+
+      def revert(hash)
+        result = deep_dup(hash)
+        @changes.each { |c| revert_change(result, c) }
+        result
+      end
+
+      def to_h
+        { changes: @changes.map(&:to_h) }
+      end
+
+      private
+
+      def apply_change(hash, change)
+        keys = parse_path(change.path)
+        target = dig_to_parent(hash, keys)
+        key = coerce_key(target, keys.last)
+
+        case change.type
+        when :added, :changed then target[key] = change.new_value
+        when :removed         then target.is_a?(Hash) ? target.delete(key) : target.delete_at(key)
+        end
+      end
+
+      def revert_change(hash, change)
+        keys = parse_path(change.path)
+        target = dig_to_parent(hash, keys)
+        key = coerce_key(target, keys.last)
+
+        case change.type
+        when :added then target.is_a?(Hash) ? target.delete(key) : target.delete_at(key)
+        when :removed, :changed then target[key] = change.old_value
+        end
+      end
+
+      def parse_path(path)
+        path.to_s.split('.')
+      end
+
+      def dig_to_parent(hash, keys)
+        parent = hash
+        keys[0..-2].each { |k| parent = parent[coerce_key(parent, k)] }
+        parent
+      end
+
+      def coerce_key(target, key)
+        return key.to_i if target.is_a?(Array)
+        return key.to_sym if target.is_a?(Hash) && (target.key?(key.to_sym) || symbol_keys?(target))
+
+        key
+      end
+
+      def symbol_keys?(hash)
+        hash.keys.any?(Symbol)
+      end
+
+      def deep_dup(obj)
+        case obj
+        when Hash  then obj.each_with_object({}) { |(k, v), h| h[k] = deep_dup(v) }
+        when Array then obj.map { |v| deep_dup(v) }
+        else obj
+        end
+      end
+    end
+  end
+end

data/lib/philiprehberger/differ/comparator.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module Differ
+    class Comparator
+      def self.call(old_val, new_val, path: '', ignore: [])
+        return [] if ignore.include?(path)
+
+        case [old_val, new_val]
+        in [Hash, Hash] then compare_hashes(old_val, new_val, path, ignore)
+        in [Array, Array] then compare_arrays(old_val, new_val, path, ignore)
+        else compare_scalars(old_val, new_val, path)
+        end
+      end
+
+      def self.compare_hashes(old_hash, new_hash, path, ignore)
+        (old_hash.keys + new_hash.keys).uniq.each_with_object([]) do |key, changes|
+          full_path = path.empty? ? key.to_s : "#{path}.#{key}"
+          next if ignore.include?(full_path)
+
+          changes.concat(hash_key_diff(old_hash, new_hash, key, full_path, ignore))
+        end
+      end
+
+      def self.hash_key_diff(old_hash, new_hash, key, full_path, ignore)
+        if !old_hash.key?(key)
+          [Change.new(path: full_path, type: :added, new_value: new_hash[key])]
+        elsif !new_hash.key?(key)
+          [Change.new(path: full_path, type: :removed, old_value: old_hash[key])]
+        else
+          call(old_hash[key], new_hash[key], path: full_path, ignore: ignore)
+        end
+      end
+
+      def self.compare_arrays(old_arr, new_arr, path, ignore)
+        [old_arr.length, new_arr.length].max.times.each_with_object([]) do |idx, changes|
+          full_path = "#{path}.#{idx}"
+          next if ignore.include?(full_path)
+
+          changes.concat(array_idx_diff(old_arr, new_arr, idx, full_path, ignore))
+        end
+      end
+
+      def self.array_idx_diff(old_arr, new_arr, idx, full_path, ignore)
+        if idx >= old_arr.length
+          [Change.new(path: full_path, type: :added, new_value: new_arr[idx])]
+        elsif idx >= new_arr.length
+          [Change.new(path: full_path, type: :removed, old_value: old_arr[idx])]
+        else
+          call(old_arr[idx], new_arr[idx], path: full_path, ignore: ignore)
+        end
+      end
+
+      def self.compare_scalars(old_val, new_val, path)
+        return [] if old_val == new_val
+
+        [Change.new(path: path, type: :changed, old_value: old_val, new_value: new_val)]
+      end
+
+      private_class_method :compare_hashes, :compare_arrays, :compare_scalars,
+                           :hash_key_diff, :array_idx_diff
+    end
+  end
+end

data/lib/philiprehberger/differ/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module Differ
+    VERSION = '0.1.1'
+  end
+end

data/lib/philiprehberger/differ.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'differ/version'
+require_relative 'differ/change'
+require_relative 'differ/changeset'
+require_relative 'differ/comparator'
+
+module Philiprehberger
+  module Differ
+    class Error < StandardError; end
+
+    def self.diff(old_val, new_val, ignore: [])
+      changes = Comparator.call(old_val, new_val, ignore: ignore)
+      Changeset.new(changes)
+    end
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: philiprehberger-differ
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Philip Rehberger
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-15 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- philiprehberger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/philiprehberger/differ.rb
+- lib/philiprehberger/differ/change.rb
+- lib/philiprehberger/differ/changeset.rb
+- lib/philiprehberger/differ/comparator.rb
+- lib/philiprehberger/differ/version.rb
+homepage: https://github.com/philiprehberger/rb-differ
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/philiprehberger/rb-differ
+  source_code_uri: https://github.com/philiprehberger/rb-differ
+  changelog_uri: https://github.com/philiprehberger/rb-differ/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: Deep structural diff for hashes, arrays, and nested objects
+test_files: []