diff-lcs 1.5.1 → 1.6.1

data/CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Contributing
+
+Contribution to diff-lcs is encouraged in any form: a bug report, a feature
+request, or code contributions. There are a few DOs and DON'Ts for
+contributions.
+
+- DO:
+
+  - Keep the coding style that already exists for any updated Ruby code (support
+    or otherwise). I use [Standard Ruby][standardrb] for linting and formatting.
+
+  - Use thoughtfully-named topic branches for contributions. Rebase your commits
+    into logical chunks as necessary.
+
+  - Use [quality commit messages][qcm].
+
+  - Add your name or GitHub handle to `CONTRIBUTORS.md` and a record in the
+    `CHANGELOG.md` as a separate commit from your main change. (Follow the style
+    in the `CHANGELOG.md` and provide a link to your PR.)
+
+  - Add or update tests as appropriate for your change. The test suite is
+    written in [RSpec][rspec].
+
+  - Add or update documentation as appropriate for your change. The
+    documentation is RDoc; diff-lcs does not use extensions that may be present
+    in alternative documentation generators.
+
+- DO NOT:
+
+  - Modify `VERSION` in `lib/diff/lcs/version.rb`. When your patch is accepted
+    and a release is made, the version will be updated at that point.
+
+  - Modify `diff-lcs.gemspec`; it is a generated file. (You _may_ use
+    `rake gemspec` to regenerate it if your change involves metadata related to
+    gem itself).
+
+  - Modify the `Gemfile`.
+
+## Test Dependencies
+
+diff-lcs uses Ryan Davis's [Hoe][Hoe] to manage the release process, and it adds
+a number of rake tasks. You will mostly be interested in `rake`, which runs
+tests in the same way that `rake spec` does.
+
+To assist with the installation of the development dependencies for diff-lcs, I
+have provided a Gemfile pointing to the (generated) `diff-lcs.gemspec` file.
+`minitar.gemspec` file. This will permit you to use `bundle install` to install
+the dependencies.
+
+You can run tests with code coverage analysis by running `rake spec:coverage`.
+
+## Workflow
+
+Here's the most direct way to get your work merged into the project:
+
+- Fork the project.
+- Clone your fork (`git clone git://github.com/<username>/diff-lcs.git`).
+- Create a topic branch to contain your change
+  (`git checkout -b my_awesome_feature`).
+- Hack away, add tests. Not necessarily in that order.
+- Make sure everything still passes by running `rake`.
+- If necessary, rebase your commits into logical chunks, without errors.
+- Push the branch up (`git push origin my_awesome_feature`).
+- Create a pull request against halostatue/diff-lcs and describe what your
+  change does and the why you think it should be merged.
+
+[hoe]: https://github.com/seattlerb/hoe
+[qcm]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[release-gem]: https://github.com/rubygems/release-gem
+[rspec]: http://rspec.info/documentation/
+[standardrb]: https://github.com/standardrb/standard

data/CONTRIBUTORS.md

@@ -0,0 +1,48 @@
+# Contributors
+
+- Austin Ziegler (@halostatue) created diff-lcs.
+
+Thanks to everyone else who has contributed to diff-lcs over the years:
+
+- @ginriki
+- @joshbronson
+- @kevinmook
+- @mckaz
+- Akinori Musha
+- Artem Ignatyev
+- Brandon Fish
+- Baptiste Courtois (@annih)
+- Camille Drapier
+- Cédric Boutillier
+- Gregg Kellogg
+- Jagdeep Singh
+- Jason Gladish
+- Jon Rowe
+- Josef Strzibny
+- Josep (@apuratepp)
+- Josh Bronson
+- Jun Aruga
+- Justin Steele
+- Kenichi Kamiya
+- Kensuke Nagae
+- Kevin Ansfield
+- Koichi Ito
+- Mark Friedgan
+- Masato Nakamura
+- Mark Young
+- Michael Granger
+- Myron Marston
+- Nicolas Leger
+- Oleg Orlov
+- Patrick Linnane
+- Paul Kunysch
+- Pete Higgins
+- Peter Goldstein
+- Peter Wagenet
+- Philippe Lafoucrière
+- Ryan Lovelett
+- Scott Steele
+- Simon Courtois
+- Tien (@tiendo1011)
+- Tomas Jura
+- Vít Ondruch

data/{License.md → LICENCE.md}

@@ -1,15 +1,15 @@
-# License
+# Licence
 
 This software is available under three licenses: the GNU GPL version 2 (or at
 your option, a later version), the Perl Artistic license, or the MIT license.
 Note that my preference for licensing is the MIT license, but Algorithm::Diff
-was dually originally licensed with the Perl Artistic and the GNU GPL ("the
-same terms as Perl itself") and given that the Ruby implementation originally
-hewed pretty closely to the Perl version, I must maintain the additional
-licensing terms.
+was dually originally licensed with the Perl Artistic and the GNU GPL ("the same
+terms as Perl itself") and given that the Ruby implementation originally hewed
+pretty closely to the Perl version, I must maintain the additional licensing
+terms.
 
-* Copyright 2004–2013 Austin Ziegler.
-* Adapted from Algorithm::Diff (Perl) by Ned Konz and a Smalltalk version by
+- Copyright 2004–2025 Austin Ziegler and contributors.
+- Adapted from Algorithm::Diff (Perl) by Ned Konz and a Smalltalk version by
   Mario I. Wolczko.
 
 ## MIT License
@@ -17,20 +17,19 @@ licensing terms.
 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:
+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.
+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.
 
 ## Perl Artistic License
 

data/Manifest.txt

@@ -1,11 +1,13 @@
 .rspec
-Code-of-Conduct.md
-Contributing.md
-History.md
-License.md
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+CONTRIBUTING.md
+CONTRIBUTORS.md
+LICENCE.md
 Manifest.txt
-README.rdoc
+README.md
 Rakefile
+SECURITY.md
 bin/htmldiff
 bin/ldiff
 docs/COPYING.txt
@@ -22,17 +24,46 @@ lib/diff/lcs/hunk.rb
 lib/diff/lcs/internals.rb
 lib/diff/lcs/ldiff.rb
 lib/diff/lcs/string.rb
+lib/diff/lcs/version.rb
+mise.toml
 spec/change_spec.rb
 spec/diff_spec.rb
+spec/fixtures/123_x
+spec/fixtures/456_x
 spec/fixtures/aX
 spec/fixtures/bXaX
 spec/fixtures/ds1.csv
 spec/fixtures/ds2.csv
+spec/fixtures/empty
+spec/fixtures/file1.bin
+spec/fixtures/file2.bin
+spec/fixtures/four_lines
+spec/fixtures/four_lines_with_missing_new_line
+spec/fixtures/ldiff/diff.missing_new_line1-e
+spec/fixtures/ldiff/diff.missing_new_line1-f
+spec/fixtures/ldiff/diff.missing_new_line2-e
+spec/fixtures/ldiff/diff.missing_new_line2-f
+spec/fixtures/ldiff/error.diff.chef-e
+spec/fixtures/ldiff/error.diff.chef-f
+spec/fixtures/ldiff/error.diff.missing_new_line1-e
+spec/fixtures/ldiff/error.diff.missing_new_line1-f
+spec/fixtures/ldiff/error.diff.missing_new_line2-e
+spec/fixtures/ldiff/error.diff.missing_new_line2-f
 spec/fixtures/ldiff/output.diff
 spec/fixtures/ldiff/output.diff-c
 spec/fixtures/ldiff/output.diff-e
 spec/fixtures/ldiff/output.diff-f
 spec/fixtures/ldiff/output.diff-u
+spec/fixtures/ldiff/output.diff.bin1
+spec/fixtures/ldiff/output.diff.bin1-c
+spec/fixtures/ldiff/output.diff.bin1-e
+spec/fixtures/ldiff/output.diff.bin1-f
+spec/fixtures/ldiff/output.diff.bin1-u
+spec/fixtures/ldiff/output.diff.bin2
+spec/fixtures/ldiff/output.diff.bin2-c
+spec/fixtures/ldiff/output.diff.bin2-e
+spec/fixtures/ldiff/output.diff.bin2-f
+spec/fixtures/ldiff/output.diff.bin2-u
 spec/fixtures/ldiff/output.diff.chef
 spec/fixtures/ldiff/output.diff.chef-c
 spec/fixtures/ldiff/output.diff.chef-e
@@ -44,6 +75,31 @@ spec/fixtures/ldiff/output.diff.chef2-d
 spec/fixtures/ldiff/output.diff.chef2-e
 spec/fixtures/ldiff/output.diff.chef2-f
 spec/fixtures/ldiff/output.diff.chef2-u
+spec/fixtures/ldiff/output.diff.empty.vs.four_lines
+spec/fixtures/ldiff/output.diff.empty.vs.four_lines-c
+spec/fixtures/ldiff/output.diff.empty.vs.four_lines-e
+spec/fixtures/ldiff/output.diff.empty.vs.four_lines-f
+spec/fixtures/ldiff/output.diff.empty.vs.four_lines-u
+spec/fixtures/ldiff/output.diff.four_lines.vs.empty
+spec/fixtures/ldiff/output.diff.four_lines.vs.empty-c
+spec/fixtures/ldiff/output.diff.four_lines.vs.empty-e
+spec/fixtures/ldiff/output.diff.four_lines.vs.empty-f
+spec/fixtures/ldiff/output.diff.four_lines.vs.empty-u
+spec/fixtures/ldiff/output.diff.issue95_trailing_context
+spec/fixtures/ldiff/output.diff.issue95_trailing_context-c
+spec/fixtures/ldiff/output.diff.issue95_trailing_context-e
+spec/fixtures/ldiff/output.diff.issue95_trailing_context-f
+spec/fixtures/ldiff/output.diff.issue95_trailing_context-u
+spec/fixtures/ldiff/output.diff.missing_new_line1
+spec/fixtures/ldiff/output.diff.missing_new_line1-c
+spec/fixtures/ldiff/output.diff.missing_new_line1-e
+spec/fixtures/ldiff/output.diff.missing_new_line1-f
+spec/fixtures/ldiff/output.diff.missing_new_line1-u
+spec/fixtures/ldiff/output.diff.missing_new_line2
+spec/fixtures/ldiff/output.diff.missing_new_line2-c
+spec/fixtures/ldiff/output.diff.missing_new_line2-e
+spec/fixtures/ldiff/output.diff.missing_new_line2-f
+spec/fixtures/ldiff/output.diff.missing_new_line2-u
 spec/fixtures/new-chef
 spec/fixtures/new-chef2
 spec/fixtures/old-chef

data/README.md

@@ -0,0 +1,92 @@
+# Diff::LCS
+
+- home :: https://github.com/halostatue/diff-lcs
+- changelog :: https://github.com/halostatue/diff-lcs/blob/main/CHANGELOG.md
+- code :: https://github.com/halostatue/diff-lcs
+- bugs :: https://github.com/halostatue/diff-lcs/issues
+- rdoc :: http://rubydoc.info/github/halostatue/diff-lcs
+
+<a href="https://github.com/halostatue/diff-lcs/actions">
+  <img src="https://github.com/halostatue/diff-lcs/workflows/CI/badge.svg" />
+</a>
+
+## Description
+
+Diff::LCS computes the difference between two Enumerable sequences using the
+McIlroy-Hunt longest common subsequence (LCS) algorithm. It includes utilities
+to create a simple HTML diff output format and a standard diff-like tool.
+
+This is release 1.4.3, providing a simple extension that allows for
+Diff::LCS::Change objects to be treated implicitly as arrays and fixes a number
+of formatting issues.
+
+Ruby versions below 2.5 are soft-deprecated, which means that older versions are
+no longer part of the CI test suite. If any changes have been introduced that
+break those versions, bug reports and patches will be accepted, but it will be
+up to the reporter to verify any fixes prior to release. The next major release
+will completely break compatibility.
+
+## Synopsis
+
+Using this module is quite simple. By default, Diff::LCS does not extend objects
+with the Diff::LCS interface, but will be called as if it were a function:
+
+```ruby
+require 'diff/lcs'
+
+seq1 = %w(a b c e h j l m n p)
+seq2 = %w(b c d e f j k l m r s t)
+
+lcs = Diff::LCS.LCS(seq1, seq2)
+diffs = Diff::LCS.diff(seq1, seq2)
+sdiff = Diff::LCS.sdiff(seq1, seq2)
+seq = Diff::LCS.traverse_sequences(seq1, seq2, callback_obj)
+bal = Diff::LCS.traverse_balanced(seq1, seq2, callback_obj)
+seq2 == Diff::LCS.patch!(seq1, diffs)
+seq1 == Diff::LCS.unpatch!(seq2, diffs)
+seq2 == Diff::LCS.patch!(seq1, sdiff)
+seq1 == Diff::LCS.unpatch!(seq2, sdiff)
+```
+
+Objects can be extended with Diff::LCS:
+
+```ruby
+seq1.extend(Diff::LCS)
+lcs = seq1.lcs(seq2)
+diffs = seq1.diff(seq2)
+sdiff = seq1.sdiff(seq2)
+seq = seq1.traverse_sequences(seq2, callback_obj)
+bal = seq1.traverse_balanced(seq2, callback_obj)
+seq2 == seq1.patch!(diffs)
+seq1 == seq2.unpatch!(diffs)
+seq2 == seq1.patch!(sdiff)
+seq1 == seq2.unpatch!(sdiff)
+```
+
+By requiring 'diff/lcs/array' or 'diff/lcs/string', Array or String will be
+extended for use this way.
+
+Note that Diff::LCS requires a sequenced enumerable container, which means that
+the order of enumeration is both predictable and consistent for the same set of
+data. While it is theoretically possible to generate a diff for an unordered
+hash, it will only be meaningful if the enumeration of the hashes is consistent.
+In general, this will mean that containers that behave like String or Array will
+perform best.
+
+## History
+
+Diff::LCS is a port of Perl's Algorithm::Diff that uses the McIlroy-Hunt longest
+common subsequence (LCS) algorithm to compute intelligent differences between
+two sequenced enumerable containers. The implementation is based on Mario I.
+Wolczko's [Smalltalk version 1.2][smalltalk] (1993) and Ned Konz's Perl version
+[Algorithm::Diff 1.15][perl]. `Diff::LCS#sdiff` and
+`Diff::LCS#traverse_balanced` were originally written for the Perl version by
+Mike Schilli.
+
+The algorithm is described in <em>A Fast Algorithm for Computing Longest Common
+Subsequences</em>, CACM, vol.20, no.5, pp.350-353, May 1977, with a few minor
+improvements to improve the speed. A simplified description of the algorithm,
+originally written for the Perl version, was written by Mark-Jason Dominus.
+
+[smalltalk]: ftp://st.cs.uiuc.edu/pub/Smalltalk/MANCHESTER/manchester/4.0/diff.st
+[perl]: http://search.cpan.org/~nedkonz/Algorithm-Diff-1.15/

data/Rakefile

@@ -1,49 +1,16 @@
-# frozen_string_literal: true
-
 require "rubygems"
 require "rspec"
 require "rspec/core/rake_task"
 require "hoe"
+require "rake/clean"
 
-# This is required until https://github.com/seattlerb/hoe/issues/112 is fixed
-class Hoe
-  def with_config
-    config = Hoe::DEFAULT_CONFIG
-
-    rc = File.expand_path("~/.hoerc")
-    homeconfig = load_config(rc)
-    config = config.merge(homeconfig)
-
-    localconfig = load_config(File.expand_path(File.join(Dir.pwd, ".hoerc")))
-    config = config.merge(localconfig)
-
-    yield config, rc
-  end
-
-  def load_config(name)
-    File.exist?(name) ? safe_load_yaml(name) : {}
-  end
-
-  def safe_load_yaml(name)
-    return safe_load_yaml_file(name) if YAML.respond_to?(:safe_load_file)
+Hoe.plugin :halostatue
+Hoe.plugin :rubygems
 
-    data = IO.binread(name)
-    YAML.safe_load(data, permitted_classes: [Regexp])
-  rescue
-    YAML.safe_load(data, [Regexp])
-  end
-
-  def safe_load_yaml_file(name)
-    YAML.safe_load_file(name, permitted_classes: [Regexp])
-  rescue
-    YAML.safe_load_file(name, [Regexp])
-  end
-end
-
-Hoe.plugin :bundler
-Hoe.plugin :doofus
-Hoe.plugin :gemspec2
-Hoe.plugin :git
+Hoe.plugins.delete :debug
+Hoe.plugins.delete :newb
+Hoe.plugins.delete :publish
+Hoe.plugins.delete :signing
 
 if RUBY_VERSION < "1.9"
   class Array # :nodoc:
@@ -70,18 +37,20 @@ end
 _spec = Hoe.spec "diff-lcs" do
   developer("Austin Ziegler", "halostatue@gmail.com")
 
+  self.trusted_release = ENV["rubygems_release_gem"] == "true"
+
   require_ruby_version ">= 1.8"
 
-  self.history_file = "History.md"
-  self.readme_file = "README.rdoc"
-  self.licenses = ["MIT", "Artistic-2.0", "GPL-2.0-or-later"]
+  self.history_file = "CHANGELOG.md"
+  self.readme_file = "README.md"
+  self.licenses = ["MIT", "Artistic-1.0-Perl", "GPL-2.0-or-later"]
 
-  spec_extras[:metadata] = ->(val) { val["rubygems_mfa_required"] = "true" }
+  spec_extras[:metadata] = ->(val) {
+    val["rubygems_mfa_required"] = "true"
+  }
 
-  extra_dev_deps << ["hoe", ">= 3.0", "< 5"]
-  extra_dev_deps << ["hoe-doofus", "~> 1.0"]
-  extra_dev_deps << ["hoe-gemspec2", "~> 1.1"]
-  extra_dev_deps << ["hoe-git2", "~> 1.7"]
+  extra_dev_deps << ["hoe", "~> 4.0"]
+  extra_dev_deps << ["hoe-halostatue", "~> 2.0"]
   extra_dev_deps << ["hoe-rubygems", "~> 1.0"]
   extra_dev_deps << ["rspec", ">= 2.0", "< 4"]
   extra_dev_deps << ["rake", ">= 10.0", "< 14"]
@@ -101,11 +70,11 @@ task :default => :spec unless Rake::Task["default"].prereqs.include?("spec")
 task :test => :spec unless Rake::Task["test"].prereqs.include?("spec")
 # standard:enable Style/HashSyntax
 
-if RUBY_VERSION >= "2.0" && RUBY_ENGINE == "ruby"
+if RUBY_VERSION >= "3.0" && RUBY_ENGINE == "ruby"
   namespace :spec do
     desc "Runs test coverage. Only works Ruby 2.0+ and assumes 'simplecov' is installed."
     task :coverage do
-      ENV["COVERAGE"] = "yes"
+      ENV["COVERAGE"] = "true"
       Rake::Task["spec"].execute
     end
   end

data/SECURITY.md

@@ -0,0 +1,41 @@
+# diff-lcs Security
+
+## Supported Versions
+
+Security reports are accepted for the most recent major release and the previous
+version for a limited time after the initial major release version. After a
+major release, the previous version will receive full support for six months and
+security support for an additional six months (for a total of twelve months).
+
+Because diff-lcs 1.x supports a wide range of Ruby versions, security reports
+will only be accepted when they can be demonstrated on Ruby 3.1 or higher.
+
+> [!information]
+>
+> There will be a diff-lcs 2.0 released in 2025 which narrows support to modern
+> versions of Ruby only.
+>
+> | Release Date | Support Ends | Security Support Ends |
+> | ------------ | ------------ | --------------------- |
+> | 2025         | +6 months    | +12 months            |
+>
+> If the 2.0.0 release happens on 2025-07-01, regular support for diff-lcs 1.x
+> will end on 2026-12-31 and security support for diff-lcs 1.x will end on
+> 2026-06-30.
+
+## Reporting a Vulnerability
+
+By preference, use the [Tidelift security contact][tidelift]. Tidelift will
+coordinate the fix and disclosure.
+
+Alternatively, Send an email to [diff-lcs@halostatue.ca][email] with the text
+`Diff::LCS` in the subject. Emails sent to this address should be encrypted
+using [age][age] with the following public key:
+
+```
+age1fc6ngxmn02m62fej5cl30lrvwmxn4k3q2atqu53aatekmnqfwumqj4g93w
+```
+
+[tidelift]: https://tidelift.com/security
+[email]: mailto:diff-lcs@halostatue.ca
+[age]: https://github.com/FiloSottile/age

data/docs/artistic.txt

@@ -122,6 +122,6 @@ products derived from this software without specific prior written permission.
 
 10. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 
 				The End

data/lib/diff/lcs/change.rb

@@ -4,7 +4,7 @@
 # addition of an element from either the old or the new sequenced
 # enumerable.
 class Diff::LCS::Change
-  IntClass = 1.class # Fixnum is deprecated in Ruby 2.4 # rubocop:disable Naming/ConstantName
+  IntClass = 1.class # Fixnum is deprecated in Ruby 2.4 # standard:disable Naming/ConstantName
 
   # The only actions valid for changes are '+' (add), '-' (delete), '='
   # (no change), '!' (changed), '<' (tail changes from first sequence), or

data/lib/diff/lcs/htmldiff.rb

@@ -5,7 +5,9 @@ require "cgi"
 # Produce a simple HTML diff view.
 class Diff::LCS::HTMLDiff
   class << self
+    # standard:disable ThreadSafety/ClassAndModuleAttributes
     attr_accessor :can_expand_tabs # :nodoc:
+    # standard:enable ThreadSafety/ClassAndModuleAttributes
   end
   self.can_expand_tabs = true