docdiff 0.5.0 → 0.6.1

data/lib/docdiff/diff.rb

@@ -50,6 +50,7 @@ So, reduced input has following properties:
 * Any elemnt in B is also exist in A.
 
 =end
+class DocDiff
 class Diff
   def initialize(a, b)
     @original_a = a
@@ -215,3 +216,4 @@ class Diff
     end
   end
 end
+end  # class DocDiff

data/lib/docdiff/diff/contours.rb

@@ -46,6 +46,7 @@ Also in Nordic Journal of Computing (NJC), Vol. 2, No. 4, Winter 1995, 444 - 461
 http://web.informatik.uni-bonn.de/IV/Mitarbeiter/rick/lcs.dvi.Z
 =end
 
+class DocDiff
 class Diff
   class Contours
     def initialize(a, b)
@@ -379,4 +380,4 @@ class Diff
     end
   end
 end
-
+end  # class DocDiff

data/lib/docdiff/diff/editscript.rb

@@ -1,6 +1,7 @@
 require 'docdiff/diff/rcsdiff'
 require 'docdiff/diff/unidiff'
 
+class DocDiff
 class Diff
   class EditScript
     def initialize
@@ -146,3 +147,4 @@ class Diff
     end
   end
 end
+end  # class DocDiff

data/lib/docdiff/diff/rcsdiff.rb

@@ -1,3 +1,4 @@
+class DocDiff
 class Diff
   def Diff.rcsdiff(a, b)
     al = []
@@ -105,3 +106,4 @@ class Diff
     end
   end
 end
+end  # class DocDiff

data/lib/docdiff/diff/shortestpath.rb

@@ -6,6 +6,7 @@ An O(NP) Sequence Comparison Algorithm,
 Information Processing Letters 35, 1990, 317-323
 =end
 
+class DocDiff
 class Diff
   class ShortestPath
     def initialize(a, b)
@@ -91,3 +92,4 @@ class Diff
     end
   end
 end
+end  # class DocDiff

data/lib/docdiff/diff/speculative.rb

@@ -2,6 +2,7 @@ require 'docdiff/diff/shortestpath'
 require 'docdiff/diff/contours'
 require 'thread'
 
+class DocDiff
 class Diff
   class Speculative
     def initialize(a, b)
@@ -14,21 +15,22 @@ class Diff
       result = nil
 
       tg = ThreadGroup.new
+      m = Mutex.new
 
       # Since ShortestPath is faster than Contours if two sequences are very similar,
       # try it first.
       tg.add(Thread.new {
 	#print "ShortestPath start.\n"
 	result = ShortestPath.new(@a, @b).lcs
-	Thread.exclusive {tg.list.each {|t| t.kill if t != Thread.current}}
+	m.synchronize {tg.list.each {|t| t.kill if t != Thread.current}}
 	#print "ShortestPath win.\n"
       })
 
-      # start Contours unless ShortestPath is already ended with first quantum, 
+      # start Contours unless ShortestPath is already ended with first quantum,
       tg.add(Thread.new {
 	#print "Contours start.\n"
 	result = Contours.new(@a, @b).lcs
-	Thread.exclusive {tg.list.each {|t| t.kill if t != Thread.current}}
+	m.synchronize {tg.list.each {|t| t.kill if t != Thread.current}}
 	#print "Contours win.\n"
       }) unless tg.list.empty?
 
@@ -38,3 +40,4 @@ class Diff
     end
   end
 end
+end  # class DocDiff

data/lib/docdiff/diff/subsequence.rb

@@ -1,3 +1,4 @@
+class DocDiff
 class Diff
   class Subsequence
     def initialize
@@ -37,3 +38,4 @@ class Diff
     end
   end
 end
+end  # class DocDiff

data/lib/docdiff/diff/unidiff.rb

@@ -1,3 +1,4 @@
+class DocDiff
 class Diff
   def Diff.unidiff(a, b, algorithm=nil)
     al = []
@@ -122,3 +123,4 @@ class Diff
     end
   end
 end
+end  # class DocDiff

data/lib/docdiff/difference.rb

@@ -4,6 +4,7 @@
 
 require 'docdiff/diff'
 
+class DocDiff
 class Difference < Array
 
 #  @resolution = nil # char, word, phrase, sentence, line, paragraph..
@@ -90,3 +91,4 @@ class Difference < Array
   end
 
 end  # class Difference
+end  # class DocDiff

data/lib/docdiff/document.rb

@@ -8,6 +8,7 @@ end
 class EOLDetectionFailure < Exception
 end
 
+class DocDiff
 class Document
 
   def initialize(str, enc = nil, e = nil)
@@ -125,3 +126,4 @@ class Document
   end
 
 end  # class Document
+end  # class DocDiff

data/lib/docdiff/encoding/en_ascii.rb

@@ -1,6 +1,7 @@
 # English ASCII encoding module for CharString
 # 2003- Hisashi MORITA
 
+class DocDiff
 module CharString
   module ASCII
 
@@ -94,4 +95,5 @@ module CharString
     CharString.register_encoding(self)
 
   end  # module ASCII
-end
+end  # module CharString
+end  # class DocDiff

data/lib/docdiff/encoding/ja_eucjp.rb

@@ -1,6 +1,7 @@
 # Japanese EUC-JP encoding module for CharString
 # 2003- Hisashi MORITA
 
+class DocDiff
 module CharString
   module EUC_JP
 
@@ -266,4 +267,5 @@ module CharString
     CharString.register_encoding(self)
 
   end  # module EUCJP
-end
+end  # module CharString
+end  # class DocDiff

data/lib/docdiff/encoding/ja_sjis.rb

@@ -1,6 +1,7 @@
 # Japanese Shift_JIS encoding module for CharString
 # 2003- Hisashi MORITA
 
+class DocDiff
 module CharString
   module Shift_JIS
 
@@ -257,4 +258,5 @@ module CharString
     CharString.register_encoding(self)
 
   end  # module SJIS
-end
+end  # module CharString
+end  # class DocDiff

data/lib/docdiff/encoding/ja_utf8.rb

@@ -2,6 +2,7 @@
 # Japanese UTF-8 encoding module for CharString
 # 2003- Hisashi MORITA
 
+class DocDiff
 module CharString
   module UTF8
 
@@ -6971,4 +6972,5 @@ module CharString
     CharString.register_encoding(self)
 
   end  # module UTF8
-end
+end  # module CharString
+end  # class DocDiff

data/lib/docdiff/version.rb

@@ -1,3 +1,3 @@
 module Docdiff
-  VERSION = "0.5.0"
+  VERSION = "0.6.1"
 end

data/lib/docdiff/view.rb

@@ -21,6 +21,7 @@ class String
   end
 end
 
+class DocDiff
 class View
 
 #  EOL_CHARS_PAT = Regexp.new(/\r\n|\r(?!\n)|(?:\A|[^\r])\n/m)
@@ -84,16 +85,8 @@ class View
   end
 
   def encname_for_regexp(encname)
-    def ruby_m17n?
-      "".respond_to?(:force_encoding)
-    end
-    if ruby_m17n?
-      # in 1.9.x, encoding names are deprecated except for N (ASCII-8BIT (binary))
-      nil
-    else
-      # in 1.8.x, U|E|S|N are accepted
-      encname.sub(/US-ASCII/i, 'none')
-    end
+    # in 1.9.x, encoding names are deprecated except for N (ASCII-8BIT (binary))
+    nil
   end
 
   CONTEXT_PRE_LENGTH  = 32
@@ -474,3 +467,4 @@ class View
   end
 
 end
+end  # class DocDiff

data/lib/viewdiff.rb

@@ -16,6 +16,7 @@ class String
   end
 end
 
+class DocDiff
 def scan_text_for_diffs(src)
   eol = "(?:\r\n|\n|\r)"
   pats = {
@@ -333,6 +334,7 @@ def anatomize_unified_hunk(a_hunk, src_encoding, src_eol)
     body.scan(/(#{del}+)(#{add}+)|(#{del}+#{eol}?)|(#{add}+)|(#{common}+#{eol}?)|(.*#{eol}?)/m){|m|
       cf, cl, d, a, cmn, msc = m[0..5]
       [cf, cl, d, a, cmn, msc].collect{|e|
+        next if e.nil?
         e.extend(CharString)
         e.encoding, e.eol = src_encoding, src_eol
       }
@@ -358,17 +360,19 @@ def anatomize_unified_hunk(a_hunk, src_encoding, src_eol)
   }
   return diffed
 end
+end  # class DocDiff
 
 if $0 == __FILE__
 
   src = ARGF.read
-  enc, eol = CharString.guess_encoding(src), CharString.guess_eol(src)
-  scan_text_for_diffs(src).each{|fragment|
-    if DiffFile.new('').guess_diff_type(fragment) == "unknown"
+  enc, eol = DocDiff::CharString.guess_encoding(src),
+             DocDiff::CharString.guess_eol(src)
+  DocDiff.new.scan_text_for_diffs(src).each{|fragment|
+    if DocDiff::DiffFile.new('').guess_diff_type(fragment) == "unknown"
       print fragment
     else
-      diff = DiffFile.new(fragment).anatomize
-      print View.new(diff, enc, eol).to_tty
+      diff = DocDiff::DiffFile.new(fragment).anatomize
+      print DocDiff::View.new(diff, enc, eol).to_tty
     end
   }
 

data/readme.html

@@ -55,7 +55,7 @@
 <body>
 <h1>DocDiff Readme</h1>
 <p>
- 2000-12-09..2011-02-23 Hisashi MORITA
+ (C) 2000 Hisashi MORITA
 </p>
 
 <hr />
@@ -100,11 +100,31 @@
  <span lang="ja">ニュース</span>
 </h2>
 <ul>
-<!-- 
-<li>0.4.x (xxxx-xx-xx)<ul>
+<!--
+<li>x.y.z (xxxx-xx-xx)<ul>
  <li></li>
 </ul></li>
  -->
+<li>0.6.1 (2021-06-07)<ul>
+  <li>Update information in .gemspec.</li>
+</ul></li>
+<li>0.6.0 (2020-07-10)<ul>
+  <li>User-visible changes:<ul>
+    <li>Drop support for Ruby 1.8 (thanks to takahashim).</li>
+    <li>Fix various encoding problems (thanks to takahashim).</li>
+    <li>Add CP932 (Windows-31J) support through a new option <code>--cp932</code> (thanks to emasaka).</li>
+    <li>Introduce readme.md, which will obsolete readme.html eventually (thanks to takahashim).</li>
+  </ul></li>
+  <li>Developer-related changes:<ul>
+    <li>Use Mutex#synchronize instead of Thread.exclusive (thanks to hsbt).</li>
+    <li>Remove JIS0208.TXT to comply with its terms of use (thanks to kmuto).</li>
+    <li>Introduce top-level class DocDiff to avoid name conflict (thanks to hibariya).</li>
+  </ul></li>
+</ul></li>
+<li>0.5.0 (2011-08-12)<ul>
+<li>Gemify. Now you can download docdiff via rubygems.org.</li>
+<li>Fix failing test on ruby1.9.2-p290.</li>
+</ul></li>
 <li>0.4.0 (2011-02-23)<ul>
  <li>Compatible with Ruby 1.9 (thanks to Kazuhiko).</li>
 </ul></li>

data/readme.md

@@ -0,0 +1,184 @@
+# DocDiff
+
+(C) 2000 Hisashi MORITA
+
+## Todo
+
+* Incorporate ignore space patch.
+* Better auto-recognition of encodings and eols.
+* Make CSS and tty escape sequence customizable in config files.
+* Better multilingualization using Ruby 1.9 feature.
+* Write "DocPatch".
+
+
+## Description
+
+Compares two text files by word, by character, or by line
+
+## Summary
+
+DocDiff compares two text files and shows the difference.  It can compare files word by word, character by character, or line by line.  It has several output formats such as HTML, tty, Manued, or user-defined markup.
+
+It supports several encodings and end-of-line characters, including ASCII (and other single byte encodings such as ISO-8859-*), UTF-8, EUC-JP, Shift_JIS, CR, LF, and CRLF.
+
+
+## Requirement
+
+* Ruby (http://www.ruby-lang.org)
+  (Note that you may need additional ruby library such as iconv, if your OS's Ruby package does not include those.)
+
+## Installation
+
+Note that you need appropriate permission for proper installation (you may have to have a root/administrator privilege).
+
+* Place `docdiff/` directory and its contents to ruby library directory, so that ruby interpreter can load them.
+
+```
+# cp -r docdiff /usr/lib/ruby/1.9.1
+```
+
+* Place `docdiff.rb` in command binary directory.
+
+```
+# cp docdiff.rb /usr/bin/
+```
+
+* (Optional) You may want to rename it to `docdiff`.
+
+```
+# mv /usr/bin/docdiff.rb /usr/bin/docdiff
+```
+
+* (Optional) When invoked as `chardiff` or `worddiff`, docdiff runs with resolution set to `char` or `word`, respectively.
+
+```
+# ln -s /usr/bin/docdiff.rb /usr/bin/chardiff.rb
+# ln -s /usr/bin/docdiff.rb /usr/bin/worddiff.rb
+```
+
+* Set appropriate permission.
+
+```
+# chmod +x /usr/bin/docdiff.rb
+```
+
+* (Optional) If you want site-wide configuration file, place `docdiff.conf.example` as `/etc/docdiff/docdiff.conf` and edit it.
+
+```
+# cp docdiff.conf.example /etc/docdiff.conf
+# $EDITOR /etc/docdiff.conf
+```
+
+* (Optional) If you want per-user configuration file, place `docdiff.conf.example` as `~/etc/docdiff/docdiff.conf` and edit it.
+
+```
+% cp docdiff.conf.example ~/etc/docdiff.conf
+% $EDITOR ~/etc/docdiff.conf
+```
+
+## Usage
+
+### Synopsis
+
+    % docdiff [options] oldfile newfile
+
+e.g.
+
+    % docdiff old.txt new.txt > diff.html
+
+See the help message for detail (`docdiff --help`).
+
+## License
+
+This software is distributed under so-called modified BSD style license (http://www.opensource.org/licenses/bsd-license.php (without advertisement clause)).  By contributing to this software, you agree that your contribution may be incorporated under the same license.
+
+Copyright and condition of use of main portion of the source:
+
+```
+Copyright (C) Hisashi MORITA.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the name of the University nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.
+```
+
+diff library (`docdiff/diff.rb` and `docdiff/diff/*`) was originally a part of Ruby/CVS by Akira TANAKA.
+Ruby/CVS is licensed under modified BSD style license.
+See the following for detail.
+
+* http://raa.ruby-lang.org/list.rhtml?name=ruby-cvs
+* http://cvs.m17n.org/~akr/ruby-cvs/
+
+## Credits
+
+* Hisashi MORITA (primary author)
+
+## Acknowledgments
+
+* Akira TANAKA (diff library author)
+* Shin'ichiro HARA (initial idea and algorithm suggestion)
+* Masatoshi SEKI (patch)
+* Akira YAMADA (patch, Debian package)
+* Kenshi MUTO (testing, bug report, Debian package)
+* Kazuhiro NISHIYAMA (bug report)
+* Hiroshi OHKUBO (bug report)
+* Shugo MAEDA (bug report)
+* Kazuhiko (patch)
+* Shintaro Kakutani (patches)
+* Masayoshi Takahashi (patches)
+* Masakazu Takahashi (patch)
+* Hibariya (bug report)
+* Hiroshi SHIBATA (patch)
+
+Excuse us this list is far from complete and fails to acknowledge many
+more who have helped us somehow. We really appreciate it.
+
+## Resources
+
+### Format
+
+* HTML/XHTML http://www.w3.org
+* tty (Graphic rendition using VT100 / ANSI escape sequence)
+    * VT100: http://vt100.net/docs/tp83/appendixb.html
+    * ANSI: http://www.tldp.org/HOWTO/Bash-Prompt-HOWTO/x329.html
+* Manued (Manuscript Editing language: a proofreading method for text)
+    * http://www.archi.is.tohoku.ac.jp/~yamauchi/otherprojects/manued/index.shtml
+
+### Similar Software
+
+There are several other software that can compare text word by word and/or character by character.
+
+* GNU wdiff (Seems to support single byte characters only.)
+     http://www.gnu.org/directory/GNU/wdiff.html
+* cdif by Kazumasa UTASHIRO (Supports several Japanese encodings.)
+     http://srekcah.org/~utashiro/perl/scripts/cdif
+* ediff for Emacsen
+     http://www.xemacs.org/Documentation/packages/html/ediff.html
+* diff-detail for xyzzy, by Hiroshi OHKUBO
+     http://ohkubo.s53.xrea.com/xyzzy/index.html#diff-detail
+* Manuediff (Outputs difference in Manued format.)
+     http://hibiki.miyagi-ct.ac.jp/~suzuki/comp/export/manuediff.html
+* YASDiff (Yet Another Scheme powered diff) by Y. Fujisawa
+     http://nnri.dip.jp/~yf/cgi-bin/yaswiki2.cgi?name=YASDiff&parentid=0
+* WinMerge (GUI diff tool for Windows)
+     http://winmerge.org/