invoca-utils 0.6.1 → 0.7.0.colin.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 443126af15b2537b1e27e80293dc05c81304f30ddd26a1af189dc132a46d033e
-  data.tar.gz: a0846a8f5c9d0b80b5204b08bdead40bb2730f2aa0addb926306cd9da51e50cf
+  metadata.gz: 97f9b98c54883da05a6cb68be4bfebd61b858d5f5da7f8374bec356ae38a23b3
+  data.tar.gz: a84b9901a7fe50a44036b5f4f4b24367f0530e632e580b91fc6ff0ecec93d3ac
 SHA512:
-  metadata.gz: a178753bf9f95c9ba7b5ce2620b987dfd36aa618d7f0ec7660245d242d056a9512b3e7b51b19e45fb790c4159ecfafc910e7b00e6dbe792f005611557d39e555
-  data.tar.gz: 84e20b7543da792234fe69b90046023d05e3fb24ca109717997b644a6075a05aada044b4f321347d6aa08ec0cd20b911bbb5e3eac5aabb2df90022f8fac95007
+  metadata.gz: b69462e99f162f2e22ea4444754ca04e8f42a34ac98aa60ba888d1bd4f6feec83b263ea6f2a0ffbd21f6384446625cf891aebcf191de32a9f34d556af9cd99d9
+  data.tar.gz: f6b637a19e6e0fa9ec3bd4ab20950d356a76e4cbae4d4251c2831d18fe718bd06c20e20fcbe7cc96fb6396b21d7ad7c3d21860f8fe42ae38887c45614c1d0c26

data/.ruby-version

@@ -1 +1 @@
-3.1.6
+3.3.8

data/.tool-versions

@@ -1 +1 @@
-ruby 3.1.6
+3.3.8

data/CHANGELOG.md

@@ -4,6 +4,11 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 **Note:** This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.7.0] - UNRELEASED
+### Removed
+- Global `Diff` and `Diffable` constants; use `Invoca::Utils::Diff` and `Invoca::Utils::Diffable` instead
+- Runtime dependency on `diff-lcs`; callers needing `Diff::LCS` should depend on and require `diff-lcs` directly
+
 ## [0.6.1] - 2025-03-27
 ### Fixed
 - Fixed a global namespace collision with diff-lcs over the `Diff` constant
@@ -49,10 +54,3 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Added
 - Enumerable::build_hash method ported from HoboSupport
 - Enumerable::* operator ported from HoboSupport
-
-[0.5.1]: https://github.com/Invoca/invoca-utils/compare/v0.5.0...v0.5.1
-[0.5.0]: https://github.com/Invoca/invoca-utils/compare/v0.4.1...v0.5.0
-[0.4.1]: https://github.com/Invoca/invoca-utils/compare/v0.4.0...v0.4.1
-[0.4.0]: https://github.com/Invoca/invoca-utils/compare/v0.3.0...v0.4.0
-[0.3.0]: https://github.com/Invoca/invoca-utils/compare/v0.2.0...v0.3.0
-[0.2.0]: https://github.com/Invoca/invoca-utils/compare/v0.1.1...v0.2.0

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    invoca-utils (0.6.1)
+    invoca-utils (0.7.0.colin.1)
       activesupport (>= 6.0)
-      diff-lcs (>= 1.6.1)
 
 GEM
   remote: https://rubygems.org/

data/invoca-utils.gemspec

@@ -29,7 +29,6 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 3.1"
 
   spec.add_dependency "activesupport", ">= 6.0"
-  spec.add_dependency "diff-lcs", ">= 1.6.1"
 
   # Specify this gem's development and test dependencies in Gemfile
 end

data/lib/invoca/utils/diff.rb

@@ -2,14 +2,10 @@
 
 # adapted from http://users.cybercity.dk/~dsl8950/ruby/diff-0.3.tar.gz
 
-require "diff/lcs"
-
 module Invoca
   module Utils
     class Diff
 
-      LCS = ::Diff::LCS
-
       VERSION = 0.3
 
       def self.lcs(a, b)

data/lib/invoca/utils/version.rb

@@ -2,6 +2,6 @@
 
 module Invoca
   module Utils
-    VERSION = "0.6.1"
+    VERSION = "0.7.0.colin.1"
   end
 end

data/lib/invoca/utils.rb

@@ -19,9 +19,3 @@ require "invoca/utils/time"
 require "invoca/utils/exceptions"
 require "invoca/utils/guaranteed_utf8_string"
 require "invoca/utils/version"
-
-Diff = Invoca::Utils::Diff
-
-unless defined?(Diffable)
-  Diffable = Invoca::Utils::Diffable
-end

data/spec/unit/diff_spec.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+
+describe Invoca::Utils::Diff do
+  describe ".compare" do
+    it "does nothing when identical" do
+      expect(described_class.compare(['a', 'b'], ['a', 'b'])).to eq('')
+    end
+
+    it "detects additions" do
+      expect(described_class.compare(['a', 'c'], ['a', 'b', 'c'])).to eq(
+        "  a\n+ b\n  c\n"
+      )
+    end
+
+    it "detects additions at the front" do
+      expect(described_class.compare(['b', 'c'], ['a', 'b', 'c'])).to eq(
+        "+ a\n  b\n  c\n"
+      )
+    end
+
+    it "detects additions at the end" do
+      expect(described_class.compare(['a', 'b'], ['a', 'b', 'c'])).to eq(
+        "  a\n  b\n+ c\n"
+      )
+    end
+
+    it "detects deletions" do
+      expect(described_class.compare(['a', 'b', 'c'], ['a', 'c'])).to eq(
+        "  a\n- b\n  c\n"
+      )
+    end
+
+    it "detects deletions at the front" do
+      expect(described_class.compare(['a', 'b', 'c'], ['b', 'c'])).to eq(
+        "- a\n  b\n  c\n"
+      )
+    end
+
+    it "detects deletions at the end" do
+      expect(described_class.compare(['a', 'b', 'c'], ['a', 'b'])).to eq(
+        "  a\n  b\n- c\n"
+      )
+    end
+
+    it "detects changes" do
+      expect(described_class.compare(['a', 'b1', 'c'], ['a', 'b2', 'c'])).to eq(
+        "  a\n- b1\n+ b2\n  c\n"
+      )
+    end
+
+    it "detects changes at the front" do
+      expect(described_class.compare(['a1', 'b', 'c'], ['a2', 'b', 'c'])).to eq(
+        "- a1\n+ a2\n  b\n  c\n"
+      )
+    end
+
+    it "detects changes at the end" do
+      expect(described_class.compare(['a', 'b', 'c1'], ['a', 'b', 'c2'])).to eq(
+        "  a\n  b\n- c1\n+ c2\n"
+      )
+    end
+
+    it "detects multi-line changes" do
+      expect(described_class.compare(['a', 'b1', 'b2', 'd'], ['a', 'c', 'd'])).to eq(
+        "  a\n- b1\n- b2\n+ c\n  d\n"
+      )
+    end
+
+    it "detects multi-line changes at the front" do
+      expect(described_class.compare(['a1', 'b1', 'd'], ['a2', 'b2', 'b3', 'd'])).to eq(
+        "- a1\n- b1\n+ a2\n+ b2\n+ b3\n  d\n"
+      )
+    end
+
+    it "detects multi-line changes at the end" do
+      expect(described_class.compare(['a', 'b', 'd1'], ['a', 'b', 'd2', 'd3'])).to eq(
+        "  a\n  b\n- d1\n+ d2\n+ d3\n"
+      )
+    end
+
+    it "uses inspect on complex data types and includes nested diff" do
+      expect(described_class.compare(['a', 'b', [1, 2]], ['a', 'b', [1, 2, 3], 'c'])).to eq(
+        "  a\n  b\n- [1, 2]\nNested array diff:\n  1\n  2\n+ 3\n\n+ [1, 2, 3]\n+ c\n"
+      )
+    end
+
+    it "includes nested diff on array of hashes" do
+      output = described_class.compare(
+        ['a', 'b', { a: 1, b: 2 }],
+        ['a', 'b', { a: 1, b: 5, c: 3 }]
+      )
+
+      expect(output).to match(/\- \{.*\}/)
+      expect(output).to include("Nested hash diff:")
+      expect(output).to include("[:b] expected 2, was 5")
+      expect(output).to include("[:c] not expected, was 3")
+      expect(output).to match(/\+ \{.*\}/)
+    end
+  end
+end

data/spec/unit/utils_spec.rb

@@ -1,55 +1,13 @@
 # frozen_string_literal: true
 
 require_relative '../spec_helper'
-require_relative '../helpers/constant_overrides'
 
 describe Invoca::Utils do
-  include ConstantOverrides
-
-  context "global namespace issues" do
-    before do
-      setup_constant_overrides
-    end
-
-    after do
-      cleanup_constant_overrides
-    end
-
-    it "define Diff as Invoca::Utils::Diff" do
-      expect(Invoca::Utils::Diff).to eq(::Diff)
-    end
-
-    it "define Diffable as Diffable" do
-      expect(Invoca::Utils::Diffable).to eq(::Diffable)
-    end
-
-    context "when Diff is defined in the global namespace" do
-      before do
-        @class = Class.new
-        set_test_const("Diff", @class)
-        load 'invoca/utils.rb'
-      end
-
-      it "define Diff as Invoca::Utils::Diff" do
-        expect(Invoca::Utils::Diff).to eq(::Diff)
-      end
-
-      it "still allows access to diff-lcs methods" do
-        expect(defined?(Diff::LCS)).to eq("constant")
-        expect(Diff::LCS).to respond_to(:diff)
-      end
-    end
-
-    context "when Diffable is defined in the global namespace" do
-      before do
-        @class = Class.new
-        set_test_const("Diffable", @class)
-        load 'invoca/utils.rb'
-      end
+  it "does not define Diff in the global namespace" do
+    expect(Object.const_defined?(:Diff)).to be(false)
+  end
 
-      it "define Diffable as Invoca::Utils::Diffable" do
-        expect(@class).to eq(::Diffable)
-      end
-    end
+  it "does not define Diffable in the global namespace" do
+    expect(Object.const_defined?(:Diffable)).to be(false)
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: invoca-utils
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0.colin.1
 platform: ruby
 authors:
 - Invoca development
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,20 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: diff-lcs
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.1
 description: A public collection of helpers used in multiple projects
 email:
 - development@invoca.com
@@ -81,9 +66,9 @@ files:
 - lib/invoca/utils/stable_sort.rb
 - lib/invoca/utils/time.rb
 - lib/invoca/utils/version.rb
-- spec/helpers/constant_overrides.rb
 - spec/spec_helper.rb
 - spec/unit/array_spec.rb
+- spec/unit/diff_spec.rb
 - spec/unit/enumerable_spec.rb
 - spec/unit/exceptions_spec.rb
 - spec/unit/guaranteed_utf8_string_spec.rb
@@ -100,7 +85,6 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -115,14 +99,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
-signing_key:
+rubygems_version: 3.6.8
 specification_version: 4
 summary: A public collection of helpers used in multiple projects
 test_files:
-- spec/helpers/constant_overrides.rb
 - spec/spec_helper.rb
 - spec/unit/array_spec.rb
+- spec/unit/diff_spec.rb
 - spec/unit/enumerable_spec.rb
 - spec/unit/exceptions_spec.rb
 - spec/unit/guaranteed_utf8_string_spec.rb

data/spec/helpers/constant_overrides.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-# The same as https://github.com/Invoca/test_overrides/blob/master/lib/constant_overrides.rb,
-# but less coupled to ExceptionHandling and Invoca microservices.
-
-module ConstantOverrides
-  def setup_constant_overrides
-    @constant_overrides = []
-  end
-
-  def cleanup_constant_overrides
-    @constant_overrides.reverse.each do |parent_module, k, v|
-      silence_warnings do
-        if v == :never_defined
-          parent_module.send(:remove_const, k)
-        else
-          parent_module.const_set(k, v)
-        end
-      end
-    end
-  end
-
-  def set_test_const(const_name, value)
-    const_name.is_a?(Symbol) and (const_name = const_name.to_s)
-    const_name.is_a?(String) or raise "Pass the constant name, not its value!"
-
-    final_parent_module = final_const_name = nil
-    original_value      =
-      const_name.split('::').reduce(Object) do |parent_module, nested_const_name|
-        parent_module == :never_defined and raise "You need to set each parent constant earlier! #{nested_const_name}"
-        final_parent_module = parent_module
-        final_const_name    = nested_const_name
-        begin
-          parent_module.const_get(nested_const_name)
-        rescue
-          :never_defined
-        end
-      end
-
-    @constant_overrides << [final_parent_module, final_const_name, original_value]
-
-    silence_warnings { final_parent_module.const_set(final_const_name, value) }
-  end
-end