diff-lcs 1.5.0 → 1.6.0

data/History.md

@@ -1,400 +0,0 @@
-# History
-
-## 1.5.0 / 2021-12-23
-
-- Updated the CI configuration and monkey-patch Hoe.
-
-- Kenichi Kamiya fixed a test configuration deprecation in SimpleCov. [#69]
-
-- Tien introduced several corrections and code improvements:
-
-  - Removed an off-by-one error when calculating an index value by embracing
-    Ruby iteration properly. This had a side-effect of fixing a long-standing
-    bug in `#traverse_sequences` where the traversal would not be transitive.
-    That is, `LCS(s2, s1)` should produce a sequence that is transitive with
-    `LCS(s1, s2)` on traversal, and applying the diff computed from those
-    results would result in equivalent changes that could be played forward or
-    backward as appropriate. [#71], [#75]
-
-  - The above fix resulted in a changed order of the longest common subsequence
-    when callbacks were applied. After analysis, it was determined that the
-    computed subsequence was _equivalent_ to the prior version, so the test was
-    updated. This also resulted in the clarification of documentation when
-    traversing the subsequences. [#79]
-
-  - An infinite loop case in the case where Diff::LCS would be included into an
-    enumerable class has been fixed. [#73]
-
-  - Clarified the purpose of a threshold test in calculation of LCS. [#72],
-    [#80]
-
-- Removed autotest directory
-
-## 1.4.4 / 2020-07-01
-
-- Fixed an issue reported by Jun Aruga in the Diff::LCS::Ldiff binary text
-  detection. [#44]
-
-- Fixed a theoretical issue reported by Jun Aruga in Diff::LCS::Hunk to raise
-  a more useful exception. [#43]
-
-- Added documentation that should address custom object issues as reported in
-  [#35].
-
-- Fixed more diff errors, in part reported in [#65].
-
-  - The use of `Numeric#abs` is incorrect in `Diff::LCS::Block#diff_size`. The
-    diff size _must_ be accurate for correct change placement.
-
-  - When selecting @max_diff_size in Diff::LCS::Hunk, choose it based on
-    `block.diff_size.abs`.
-
-  - Made a number of changes that will, unfortunately, increase allocations at
-    the cost of being safe with frozen strings.
-
-  - Add some knowledge that when `Diff::LCS::Hunk#diff` is called, that we are
-    processing the _last_ hunk, so some changes will be made to how the output
-    is generated.
-
-    - `old`, `ed`, and `reverse_ed` formats have no differences.
-
-    - `unified` format will report `` given the
-      correct conditions, at most once. Unified range reporting also differs for
-      the last hunk such that the `length` of the range is reduced by one.
-
-    - `context` format will report `\No newline at end of file` given the
-      correct conditions, up to once per "file". Context range reporting also
-      differs for the last hunk such that the `end` part of the range is reduced
-      by one to a minimum of one.
-
-- Added a bunch more tests for the cases above, and fixed `hunk_spec.rb` so that
-  the phrase being compared isn't nonsense French.
-
-- Updated formatting.
-
-- Added a Rake task to assist with manual testing on Ruby 1.8.
-
-## 1.4.3 / 2020-06-29
-
-- Fixed several issues with the 1.4 on Rubies older than 2.0. Some of this was
-  providing useful shim functions to Hoe 3.x (which dropped these older Rubies
-  a while ago). Specifically:
-
-  - Removed Array#lazy from a method in Diff::LCS::Hunk.
-
-  - Changed some unit tests to use old-style Symbol-keyed hashes.
-
-  - Changed some unit test helper functions to no longer use keyword parameters,
-    but only a trailing options hash.
-
-  - Made the use of `psych` dependent on `RUBY_VERSION >= 1.9`.
-
-  Resolves [#63].
-
-## 1.4.2 / 2020-06-23
-
-- Camille Drapier fixed a small issue with RuboCop configuration. [#59]
-
-- Applied another fix (and unit test) to fix an issue for the Chef team.
-  [#60], [#61]
-
-## 1.4.1 / 2020-06-23
-
-- Fix an issue where diff sizes could be negative, and they should be. [#57],
-  [#58]
-
-## 1.4 / 2020-06-23
-
-- Ruby versions lower than 2.4 are soft-deprecated and will not be run as part
-  of the CI process any longer.
-
-- Akinora MUSHA (knu) added the ability for Diff::LCS::Change objects to be
-  implicitly treated arrays. Originally provided as pull request [#47], but it
-  introduced a number of test failures as documented in [#48], and remediation
-  of Diff::LCS itself was introduced in [#49].
-
-- Resolved [#5] with some tests comparing output from `system` calls to
-  `bin/ldiff` with some pre-generated output. Resolved [#6] with these tests.
-
-- Resolved a previously undetected `bin/ldiff` issue with `--context` output not
-  matching `diff --context` output.
-
-- Resolved an issue with later versions of Ruby not working with an `OptParse`
-  specification of `Numeric`; this has been changed to `Integer`.
-
-- Brandon Fish added truffleruby in [#52].
-
-- Fixed two missing classes as reported in [#53].
-
-## 1.3 / 2017-01-18
-
-- Bugs fixed:
-
-  - Fixed an error for bin/ldiff --version. Fixes issue [#21].
-
-  - Force Diff::LCS::Change and Diff::LCS::ContextChange to only perform
-    equality comparisons against themselves. Provided by Kevin Mook in pull
-    request [#29].
-
-  - Fix tab expansion in htmldiff, provided by Mark Friedgan in pull request
-    [#25].
-
-  - Silence Ruby 2.4 Fixnum deprecation warnings. Fixes issue [#38] and pull
-    request [#36].
-
-  - Ensure that test dependencies are loaded properly. Fixes issue [#33] and
-    pull request [#34].
-
-  - Fix issue [#1] with incorrect intuition of patch direction. Tentative fix,
-    but the previous failure cases pass now.
-
-- Tooling changes:
-
-  - Added SimpleCov and Coveralls support.
-
-  - Change the homepage (temporarily) to the GitHub repo.
-
-  - Updated testing and gem infrastructure.
-
-  - Modernized the specs.
-
-- Cleaned up documentation.
-
-- Added a Code of Conduct.
-
-## 1.2.5 / 2013-11-08
-
-- Bugs fixed:
-
-  - Comparing arrays flattened them too far, especially with Diff::LCS.sdiff.
-    Fixed by Josh Bronson in pull request [#23].
-
-## 1.2.4 / 2013-04-20
-
-- Bugs fixed:
-
-  - A bug was introduced after 1.1.3 when pruning common sequences at the start
-    of comparison. Paul Kunysch (@pck) fixed this in pull request [#18]. Thanks!
-
-  - The Rubinius (1.9 mode) bug in [rubinius/rubinius#2268] has been fixed by
-    the Rubinius team two days after it was filed. Thanks for fixing this so
-    quickly!
-
-- Switching to Raggi's hoe-gemspec2 for gemspec generation.
-
-## 1.2.3 / 2013-04-11
-
-- Bugs Fixed:
-
-  - The new encoding detection for diff output generation (added in 1.2.2)
-    introduced a bug if the left side of the comparison was the empty set.
-    Originally found in [rspec/rspec-expectations#238] and
-    [rspec/rspec-expectations#239]. Jon Rowe developed a reasonable heuristic
-    (left side, right side, empty string literal) to avoid this bug.
-
-  - There is a known issue with Rubinius in 1.9 mode reported in
-    [rubinius/rubinius#2268] and demonstrated in the Travis CI builds. For all
-    other tested platforms, diff-lcs is considered stable. As soon as a suitably
-    small test-case can be created for the Rubinius team to examine, this will
-    be added to the Rubinius issue around this.
-
-## 1.2.2 / 2013-03-30
-
-- Bugs Fixed:
-
-  - Diff::LCS::Hunk could not properly generate a difference for comparison sets
-    that are not US-ASCII-compatible because of the use of literal regular
-    expressions and strings. Jon Rowe found this in
-    [rspec/rspec-expectations#219] and provided a first pass implementation in
-    pull request [#15]. I've reworked it because of test failures in Rubinius
-    when running in Ruby 1.9 mode. This coerces the added values to the encoding
-    of the old dataset (as determined by the first piece of the old dataset).
-
-  - Adding Travis CI testing for Ruby 2.0.
-
-## 1.2.1 / 2013-02-09
-
-- Bugs Fixed:
-
-  - As seen in [rspec/rspec-expectations#200], the release of Diff::LCS 1.2
-    introduced an unnecessary public API change to Diff::LCS::Hunk (see the
-    change at [rspec/rspec-expectations@3d6fc82c] for details). The new method
-    name (and behaviour) is more correct, but I should not have renamed the
-    function or should have at least provided an alias. This release restores
-    Diff::LCS::Hunk#unshift as an alias to #merge. Note that the old #unshift
-    behaviour was incorrect and will not be restored.
-
-## 1.2.0 / 2013-01-21
-
-- Minor Enhancements:
-
-  - Added special case handling for Diff::LCS.patch so that it handles patches
-    that are empty or contain no changes.
-
-  - Added two new methods (#patch_me and #unpatch_me) to the includable module.
-
-- Bugs Fixed:
-
-  - Fixed issue [#1] patch direction detection.
-
-  - Resolved issue [#2] by handling `string[string.size, 1]` properly (it
-    returns `""` not `nil`).
-
-  - Michael Granger (ged) fixed an implementation error in Diff::LCS::Change and
-    added specs in pull request [#8]. Thanks!
-
-  - Made the code auto-testable.
-
-  - Vít Ondruch (voxik) provided the latest version of the GPL2 license file in
-    pull request [#10]. Thanks!
-
-  - Fixed a documentation issue with the includable versions of #patch! and
-    #unpatch! where they implied that they would replace the original value.
-    Given that Diff::LCS.patch always returns a copy, the documentation was
-    incorrect and has been corrected. To provide the behaviour that was
-    originally documented, two new methods were added to provide this behaviour.
-    Found by scooter-dangle in issue [#12]. Thanks!
-
-- Code Style Changes:
-
-  - Removed trailing spaces.
-
-  - Calling class methods using `.` instead of `::`.
-
-  - Vít Ondruch (voxik) removed unnecessary shebangs in pull request [#9].
-    Thanks!
-
-  - Kenichi Kamiya (kachick) removed some warnings of an unused variable in
-    lucky pull request [#13]. Thanks!
-
-  - Embarked on a major refactoring to make the files a little more manageable
-    and understand the code on a deeper level.
-
-  - Adding to http://travis-ci.org.
-
-## 1.1.3 / 2011-08-27
-
-- Converted to 'hoe' for release.
-
-- Converted tests to RSpec 2.
-
-- Extracted the body of htmldiff into a class available from diff/lcs/htmldiff.
-
-- Migrated development and issue tracking to GitHub.
-
-- Bugs fixed:
-
-  - Eliminated the explicit use of RubyGems in both bin/htmldiff and bin/ldiff.
-    Resolves issue [#4].
-
-  - Eliminated Ruby warnings. Resolves issue [#3].
-
-## 1.1.2 / 2004-10-20
-
-- Fixed a problem reported by Mauricio Fernandez in htmldiff.
-
-## 1.1.1 / 2004-09-25
-
-- Fixed bug #891 (Set returned from patch command does not contain last equal
-  part).
-
-- Fixed a problem with callback initialisation code (it assumed that all
-  callbacks passed as classes can be initialised; now, it rescues NoMethodError
-  in the event of private :new being called).
-
-- Modified the non-initialisable callbacks to have a private #new method.
-
-- Moved ldiff core code to Diff::LCS::Ldiff (diff/lcs/ldiff.rb).
-
-## 1.1.0
-
-- Eliminated the need for Diff::LCS::Event and removed it.
-
-- Added a contextual diff callback, Diff::LCS::ContextDiffCallback.
-
-- Implemented patching/unpatching for standard Diff callback output formats with
-  both #diff and #sdiff.
-
-- Extensive documentation changes.
-
-## 1.0.4
-
-- Fixed a problem with bin/ldiff output, especially for unified format. Newlines
-  that should have been present weren't.
-
-- Changed the .tar.gz installer to generate Windows batch files if ones do not
-  exist already. Removed the existing batch files as they didn't work.
-
-## 1.0.3
-
-- Fixed a problem with #traverse_sequences where the first difference from the
-  left sequence might not be appropriately captured.
-
-## 1.0.2
-
-- Fixed an issue with ldiff not working because actions were changed from
-  symbols to strings.
-
-## 1.0.1
-
-- Minor modifications to the gemspec, the README.
-
-- Renamed the diff program to ldiff (as well as the companion batch file) so as
-  to not collide with the standard diff program.
-
-- Fixed issues with RubyGems. Requires RubyGems > 0.6.1 or >= 0.6.1 with the
-  latest CVS version.
-
-## 1.0
-
-- Initial release based mostly on Perl's Algorithm::Diff.
-
-[rubinius/rubinius#2268]: https://github.com/rubinius/rubinius/issues/2268
-[rspec/rspec-expectations#239]: https://github.com/rspec/rspec-expectations/issues/239
-[rspec/rspec-expectations#238]: https://github.com/rspec/rspec-expectations/issues/238
-[rspec/rspec-expectations#219]: https://github.com/rspec/rspec-expectations/issues/219
-[rspec/rspec-expectations@3d6fc82c]: https://github.com/rspec/rspec-expectations/commit/3d6fc82c
-[rspec/rspec-expectations#200]: https://github.com/rspec/rspec-expectations/pull/200
-[#1]: https://github.com/halostatue/diff-lcs/issues/1
-[#2]: https://github.com/halostatue/diff-lcs/issues/2
-[#3]: https://github.com/halostatue/diff-lcs/issues/3
-[#4]: https://github.com/halostatue/diff-lcs/issues/4
-[#5]: https://github.com/halostatue/diff-lcs/issues/5
-[#6]: https://github.com/halostatue/diff-lcs/issues/6
-[#8]: https://github.com/halostatue/diff-lcs/pull/8
-[#9]: https://github.com/halostatue/diff-lcs/pull/9
-[#10]: https://github.com/halostatue/diff-lcs/pull/10
-[#12]: https://github.com/halostatue/diff-lcs/issues/12
-[#13]: https://github.com/halostatue/diff-lcs/pull/13
-[#15]: https://github.com/halostatue/diff-lcs/pull/15
-[#18]: https://github.com/halostatue/diff-lcs/pull/18
-[#21]: https://github.com/halostatue/diff-lcs/issues/21
-[#23]: https://github.com/halostatue/diff-lcs/pull/23
-[#25]: https://github.com/halostatue/diff-lcs/pull/25
-[#29]: https://github.com/halostatue/diff-lcs/pull/29
-[#33]: https://github.com/halostatue/diff-lcs/issues/33
-[#34]: https://github.com/halostatue/diff-lcs/pull/34
-[#35]: https://github.com/halostatue/diff-lcs/issues/35
-[#36]: https://github.com/halostatue/diff-lcs/pull/36
-[#38]: https://github.com/halostatue/diff-lcs/issues/38
-[#43]: https://github.com/halostatue/diff-lcs/issues/43
-[#44]: https://github.com/halostatue/diff-lcs/issues/44
-[#47]: https://github.com/halostatue/diff-lcs/pull/47
-[#48]: https://github.com/halostatue/diff-lcs/issues/48
-[#49]: https://github.com/halostatue/diff-lcs/pull/49
-[#52]: https://github.com/halostatue/diff-lcs/pull/52
-[#53]: https://github.com/halostatue/diff-lcs/issues/53
-[#57]: https://github.com/halostatue/diff-lcs/issues/57
-[#58]: https://github.com/halostatue/diff-lcs/pull/58
-[#59]: https://github.com/halostatue/diff-lcs/pull/59
-[#60]: https://github.com/halostatue/diff-lcs/issues/60
-[#61]: https://github.com/halostatue/diff-lcs/pull/61
-[#63]: https://github.com/halostatue/diff-lcs/issues/63
-[#65]: https://github.com/halostatue/diff-lcs/issues/65
-[#69]: https://github.com/halostatue/diff-lcs/issues/69
-[#71]: https://github.com/halostatue/diff-lcs/issues/71
-[#72]: https://github.com/halostatue/diff-lcs/issues/72
-[#73]: https://github.com/halostatue/diff-lcs/issues/73
-[#75]: https://github.com/halostatue/diff-lcs/issues/75
-[#79]: https://github.com/halostatue/diff-lcs/issues/79
-[#80]: https://github.com/halostatue/diff-lcs/issues/80

data/README.rdoc

@@ -1,84 +0,0 @@
-= Diff::LCS
-
-home :: https://github.com/halostatue/diff-lcs
-code :: https://github.com/halostatue/diff-lcs
-bugs :: https://github.com/halostatue/diff-lcs/issues
-rdoc :: http://rubydoc.info/github/halostatue/diff-lcs
-continuous integration :: {<img src="https://github.com/halostatue/diff-lcs/workflows/CI/badge.svg" />}[https://github.com/halostatue/diff-lcs/actions]
-
-== 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:
-
-  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:
-
-  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}[ftp://st.cs.uiuc.edu/pub/Smalltalk/MANCHESTER/manchester/4.0/diff.st]
-(1993) and Ned Konz's Perl version
-{Algorithm::Diff 1.15}[http://search.cpan.org/~nedkonz/Algorithm-Diff-1.15/].
-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.