docdiff 0.5.0

data/docdiff.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "docdiff/version"
+
+Gem::Specification.new do |s|
+  s.name        = "docdiff"
+  s.version     = Docdiff::VERSION
+  s.authors     = ["Hisashi Morita"]
+  s.email       = ["hisashim at users.sourceforge.net"]
+  s.homepage    = "http://docdiff.sourceforge.net"
+  s.summary     = %q{Word-by-word diff}
+  s.description = %q{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.}
+  s.rubyforge_project = "docdiff"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/docdiffwebui.cgi

@@ -0,0 +1,176 @@
+#!/usr/bin/ruby
+# DocDiff Web UI (CGI)
+# 2005-10-08.. Hisashi Morita
+# requirement: Ruby 1.8+ (for timeout.rb)
+
+require 'cgi'
+require 'tempfile'
+require 'open3'
+require 'timeout'
+
+docdiff = "/usr/bin/docdiff"
+
+def errmsg(bndg) # receive binding and return error anatomy
+  timeout_second = eval("timeout_second", bndg)
+  meth    = eval("meth", bndg)
+  cgierr  = eval("cgierr", bndg)
+  cmderr  = eval("cmderr", bndg)
+  cmdline = eval("cmdline", bndg)
+  file1   = eval("file1", bndg)
+  file2   = eval("file2", bndg)
+  msg = ["<h1>I am so sorry, but something went wrong and an error occured.</h1>",
+         "<h2>For users:</h2>",
+         "<p>#{cgierr}</p>",
+         "<p>#{'You may try again specifying encoding and eol explicitly.' if cmderr.size > 0}</p>",
+         "<p>If you are still in trouble after self-help effort, please consult your system administrator (or nearest geek) with the detail below.</p>",
+         "<hr />",
+         "<h2>For system administrators:</h2>",
+         "<p>Technical detail of the error:</p>",
+         "<p>",
+         "CGI error: #{CGI.escapeHTML(cgierr.inspect)}<br />",
+         "Command error: #{CGI.escapeHTML(cmderr.inspect)}<br />",
+         "Timeout: #{timeout_second}<br />",
+         "Method used: #{meth}<br />",
+         "Commandline used: #{CGI.escapeHTML(cmdline.inspect)}<br />",
+         "file1: #{CGI.escapeHTML(file1.inspect)}<br />",
+         "file1 stat: #{CGI.escapeHTML(File.stat(file1.path).inspect)}<br />",
+         "file2: #{CGI.escapeHTML(file2.inspect)}<br />",
+         "file2 stat: #{CGI.escapeHTML(File.stat(file2.path).inspect)}<br />",
+#          "file1 content: #{`head #{file1.path}`}<br />",
+#          "file2 content: #{`head #{file2.path}`}<br />",
+#          "#{`#{cmdline}`}",
+         "</p><hr />"].join
+  return msg
+end
+
+class InvalidUsageError < StandardError
+end
+class TimeoutErrorPopen < TimeoutError
+end
+class TimeoutErrorPopen3 < TimeoutError
+end
+
+cgi = CGI.new("html4")
+file1 = Tempfile.new("file1-")
+file1.print(cgi.params['file1'][0].read)
+file1.close
+file2 = Tempfile.new("file2-")
+file2.print(cgi.params['file2'][0].read)
+file2.close
+
+if resolution = cgi.params['resolution'][0]
+  case resolution.read
+  when "line" then resolution = "line"
+  when "word" then resolution = "word"
+  when "char" then resolution = "char"
+  else raise "Consult your system administrator.  Unsupported resolution."
+  end
+else
+  raise "param 'resolution' was not available."
+end
+
+if format = cgi.params['format'][0]
+  case format.read
+  when "html"   then format = "html"
+  when "tty"    then format = "tty"
+  when "wdiff"  then format = "wdiff"
+  when "manued" then format = "manued"
+  else raise "Consult your system administrator.  Unsupported format."
+  end
+else
+  raise "param 'format' was not available."
+end
+
+if encoding = cgi.params['encoding'][0]
+  case encoding.read
+  when "auto"  then encoding = "auto"
+  when "ascii" then encoding = "ASCII"
+  when "utf8"  then encoding = "UTF-8"
+  when "eucjp" then encoding = "EUC-JP"
+  when "sjis"  then encoding = "Shift_JIS"
+  else raise "Consult your system administrator.  Unsupported encoding."
+  end
+else
+  raise "param 'encoding' was not available."
+end
+
+if eol = cgi.params['eol'][0]
+  case eol.read
+  when "auto" then eol = "auto"
+  when "cr"   then eol = "CR"
+  when "lf"   then eol = "LF"
+  when "crlf" then eol = "CRLF"
+  else raise "Consult your system administrator.  Unsupported eol."
+  end
+else
+  raise "param 'eol' was not available."
+end
+
+digest = cgi.params['digest'][0]
+if digest && digest.read == "digest"
+  digest = "--digest"
+else
+  digest = ""
+end
+
+if timeout_second = cgi.params['timeout_second'][0]
+  case timeout_second.read
+  when "5"  then timeout_second = 5
+  when "15" then timeout_second = 15
+  when "30" then timeout_second = 30
+  when "60" then timeout_second = 60
+  else raise "Consult your system administrator.  Unsupported timeout period."
+  end
+else
+  raise "param 'timeout_second' was not available."
+end
+
+begin
+  cmderr = ""
+  cgierr = ""
+  output = ""
+  cmdline = "#{docdiff} " +
+            " --resolution=#{resolution} --format=#{format} " +
+            " --encoding=#{encoding} --eol=#{eol} #{digest} " +
+            " #{file1.path} #{file2.path} "
+  raise InvalidUsageError, "file1 is either empty (size 0) or not specified." if FileTest.zero?(file1.path)
+  raise InvalidUsageError, "file2 is either empty (size 0) or not specified." if FileTest.zero?(file2.path)
+  raise "file1 is unreadable." unless FileTest.readable?(file1.path)
+  raise "file2 is unreadable." unless FileTest.readable?(file2.path)
+  meth = "IO.popen"
+  timeout(timeout_second, TimeoutErrorPopen){
+    output = IO.popen(cmdline, "rb").read
+    raise "stdout from docdiff is nil." if output == nil
+    raise "stdout from docdiff is not nil, but empty." if output == ""
+  }
+rescue InvalidUsageError => cgierr
+  output = errmsg(binding())
+
+rescue TimeoutErrorPopen => cgierr
+  # popen failed, so falling back to open3, though open3 can fail too...
+  meth = "Open3.popen3"
+
+  timeout(timeout_second, TimeoutErrorPopen3){
+    stdin, stdout, stderr = Open3.popen3(cmdline)
+    raise "stdin to docdiff is nil." unless stdin
+    raise "stdout from docdiff is nil." unless stdout
+    raise "stderr from docdiff is nil." unless stderr
+    cmderr = stderr.read
+    raise cmderr if cmderr && cmderr.length > 0
+    output = stdout.read
+  }
+rescue TimeoutErrorPopen3  => cgierr
+  output = errmsg(binding())
+rescue => cgierr
+  output = errmsg(binding())
+ensure
+  cgi.out {
+    if output == nil then
+      errmsg(binding())
+    elsif output.size == 0 then
+      errmsg(binding())
+    else
+      output
+    end
+  }
+end

data/docdiffwebui.html

@@ -0,0 +1,123 @@
+<html>
+  <head>
+    <title>DocDiff Web UI</title>
+    <meta http-equiv="Content-Style-Type" content="text/css">
+    <style type="text/css">
+      body {
+        margin: 1em 2em 1em 2em;
+      }
+      h1 {
+        border-left-width: thick;
+        border-left-style: solid;
+        border-style: solid none solid none;
+      }
+      .form {
+        border-style: outset;
+        padding: 0.5em 1em 0.5em 1em;
+        width: 100%;
+        max-width: 50%;
+        min-width: 30em;
+      }
+      .buttons {
+        float: right;
+        min-width: 30%;
+      }
+      .buttons + * {
+        clear: both;
+      }
+      .form .options {
+        margin-left: 1em;
+      }
+      .form .options dt {
+        float: left;
+        width: 30%;
+        max-width: 20em;
+      }
+      .form .options dd {
+        width: 70%;
+      }
+    </style>
+  </head>
+  <body>
+  <h1>DocDiff Web UI</h1>
+  <p><a href="http://www.kt.rim.or.jp/~hisashim/docdiff/">DocDiff</a> is a word/char oriented text file comparison utility.</p>
+  <p><strong>Caution: This web ui is totally experimental and insecure!  Do not use it on public site.</strong></p>
+  <div class="form">
+  <form action="cgi-bin/docdiffwebui.cgi" method="post" enctype="multipart/form-data" target="_blank">
+    <fieldset>
+      <legend>Files to compare</legend>
+      <ol>
+        <li><input type="file" name="file1" size="72"></li>
+        <li><input type="file" name="file2" size="72"></li>
+      </ol>
+    </fieldset>
+    <fieldset>
+      <legend>Options</legend>
+    <dl class="options">
+      <dt>Resolution:</dt>
+      <dd>
+        <select name="resolution">
+          <option value="line">Line</option>
+          <option value="word" selected>Word (default)</option>
+          <option value="char">Character</option>
+        </select><br />
+      </dd>
+      <dt>Output Format:</dt>
+      <dd>
+        <select name="format">
+          <option value="html" selected>HTML (default)</option>
+          <option value="tty">tty</option>
+          <option value="wdiff">wdiff</option>
+          <option value="manued">Manued</option>
+        </select>
+      </dd>
+      <dt>Encoding:</dt>
+      <dd>
+        <select name="encoding">
+          <option value="auto" selected>Auto (default)</option>
+          <option value="ascii">ASCII</option>
+          <option value="utf8">UTF-8</option>
+          <option value="eucjp">EUC-JP (Japanese Unix)</option>
+          <option value="sjis">Shift-JIS (Japanese Windows, Mac)</option>
+        </select>
+      </dd>
+      <dt>End-of-line:</dt>
+      <dd>
+        <select name="eol">
+          <option value="auto" selected>Auto (default)</option>
+          <option value="crlf">CRLF (Windows)</option>
+          <option value="lf">LF (Unix, Mac OS X)</option>
+          <option value="cr">CR (Old Mac)</option>
+        </select>
+      </dd>
+      <dt>Digest?</dt>
+      <dd>
+        <input type="checkbox" name="digest" value="digest">
+      </dd>
+      <dt>Timeout:</dt>
+      <dd>
+        <select name="timeout_second">
+          <option value="5" selected>5 sec. (default)</option>
+          <option value="15">15 sec.</option>
+          <option value="30">30 sec.</option>
+          <option value="60">60 sec.</option>
+        </select>
+      </dd>
+    </dl>
+  </fieldset>
+    <div class="buttons">
+      <p>
+      <input type="reset">
+      <input type="submit">
+      </p>
+    </div>
+    <br />
+  </form>
+</div>
+  <p>Wait for a while untill you get the result.</p>
+  <p>If you get an error, try specifying encoding and eol explicitly.  If that does not help, ask your system administrator who installed this software.</p>
+
+  <hr />
+  2005-10-08..  Hisashi Morita
+</body>
+</html>

data/index.html

@@ -0,0 +1,181 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+<title>DocDiff</title>
+ <style type="text/css">
+  body {
+   margin-left: 5%;
+  }
+  h1, h2 {
+   margin-left: -5%;
+  }
+  h1 {
+   border: medium outset;
+   padding: 0.5em;
+  }
+  h2 {
+   border-top:    thin  solid;
+   border-right:  thin  solid;
+   border-left:   thick solid;
+   border-bottom: thin  solid;
+   padding-left:  0.3em;
+  }
+  h3 {
+   border-left:   thick solid;
+   padding-left:  0.3em;
+  }
+  .figure {
+   padding: 0.5em 0em;
+   clear: both;
+  }
+  .img {
+   margin-right: 0.5em;
+  }
+  .img:first-child {
+   float: left;
+  }
+  .img + .img {
+   float: left;
+  }
+  h1, h2, h3, hr {
+   clear: both;
+  }
+  .img > p {
+   margin-top: 0.5em;
+   margin-bottom: 0.25em;
+   font-size: small;
+  }
+ </style>
+ <style title="en" type="text/css">
+  * [lang="ja"] {display: none}
+  * [lang="en"] {display: inherit}
+ </style>
+ <style title="ja" type="text/css">
+  * [lang="en"] {display: none}
+  * [lang="ja"] {display: inherit}
+ </style>
+</head>
+<body>
+<h1>DocDiff</h1>
+<h2 id="toc">
+ <span lang="en">Table of Contents</span>
+ <span lang="ja">目次</span>
+</h2>
+<ul>
+<li><a href="#summary">Summary</a></li>
+<li><a href="#screenshot">Screenshot</a></li>
+<li><a href="#document">Document</a></li>
+<li><a href="#download">Download</a></li>
+</ul>
+</div>
+<div class="content">
+<h2 id="summary">
+ <span lang="en">Summary</span>
+ <span lang="ja">概要</span>
+</h2>
+<p>
+<span lang="en">
+ <a href="http://www.kt.rim.or.jp/~hisashim/docdiff/">DocDiff</a> compares two text files and shows the difference.  It can compare files by word, character, or line.  It has several output formats such as HTML, tty, Manued, or user-defined markup.
+</span>
+<span lang="ja">
+ <a href="http://www.kt.rim.or.jp/~hisashim/docdiff/">DocDiff</a>は2つのテキストファイルを比較してその違いを表示します。単語ごと、文字ごと、そして行ごとにファイルを比較できます。結果を出力する形式は、HTML, tty（文字 端末向けのエスケープシーケンス）, Manued（真鵺道という校正用のマークアップ形式）などが用意されており、ユーザ定義のタグを使うこともできます。
+</span>
+</p>
+<p>
+<span lang="en">
+ It supports several encodings and end-of-line characters, including ASCII (and ISO-8859-*), UTF-8, EUC-JP, Shift_JIS, CR, LF, and CRLF.
+</span>
+<span lang="ja">
+ 次のエンコーディング（文字コード）と行末コード（改行文字）をサポートしています: ASCII（およびISO-8859-*), UTF-8, EUC-JP, Shift_JIS、そしてCR, LF, CRLF.
+</span>
+</p>
+<hr />
+<h2 id="screenshot">
+ <span lang="en">Screenshot</span>
+ <span lang="ja">スクリーンショット</span>
+</h2>
+<p>
+<span lang="en">Screenshots as of version 0.3.2.  All shots are in the <a href="img/">img</a> directory.</span>
+<span lang="ja">バージョン0.3.2時点のスクリーンショットです。スクリーンショットは<a href="img/">img</a>ディレクトリにあります。</span>
+</p>
+<div class="figure">
+<span class="img">
+<p>HTML output in web browser</p>
+<img src="img/docdiff-screenshot-format-html-firefox.png" alt="screenshot" />
+</span>
+<span class="img">
+<p>HTML output in web browser (digest)</p>
+<img src="img/docdiff-screenshot-format-html-digest-firefox.png" alt="screenshot" />
+</span>
+</div>
+<div class="figure">
+<span class="img">
+<p>tty output in terminal</p>
+<img src="img/docdiff-screenshot-format-tty-rxvtunicode-en.png" alt="screenshot" />
+</span>
+<span class="img">
+<p>tty output in terminal (comparing Japanese text)</p>
+<img src="img/docdiff-screenshot-format-tty-rxvtunicode-ja.png" alt="screenshot" />
+</span>
+</div>
+<div class ="figure">
+<span class="img">
+<p>tty output in terminal</p>
+<img src="img/docdiff-screenshot-format-tty-xterm-en.png" alt="screenshot" />
+</span>
+<span class="img">
+<p>tty output in terminal (comparing Japanese text)</p>
+<img src="img/docdiff-screenshot-format-tty-xterm-ja.png" alt="screenshot" />
+</span>
+</div>
+<div class="figure">
+<span class="img">
+<p>Comparing English text (codepage 437) on Windows (Cygwin)</p>
+<img src="img/docdiff-screenshot-format-tty-cmdexe-en.png" alt="screenshot" />
+</span>
+<span class="img">
+<p>Comparing Japanese text (codepage 932) on Windows (Cygwin)</p>
+<img src="img/docdiff-screenshot-format-tty-cmdexe-ja.png" alt="screenshot" />
+</span>
+</div>
+<div class="figure">
+<span class="img">
+<p>You can compare text files by line, word, or character (format: tty)</p>
+<img src="img/docdiff-screenshot-resolution-linewordchar-xterm.png" alt="screenshot" />
+</span>
+</div>
+<hr />
+<h2 id="document">
+ <span lang="en">Document</span>
+ <span lang="ja">ドキュメント</span>
+</h2>
+<ul>
+<li><a href="readme.html">readme.html</a> (Multilingual)</li>
+<li><a href="readme.en.html">readme.en.html</a> (English)</li>
+<li><a href="readme.ja.html">readme.ja.html</a> (Japanese)</li>
+</ul>
+
+<h2 id="download">
+ <span lang="en">Download</span>
+ <span lang="ja">ダウンロード</span>
+</h2>
+<p>
+<span lang="en">Please read the readme before you download.</span>
+<span lang="ja">ダウンロードする前にreadmeをお読みください。</span>
+</p>
+<ul>
+<li><a href="http://sourceforge.net/projects/docdiff/files/">
+http://sourceforge.net/projects/docdiff/files/</a></li>
+</ul>
+</div>
+<hr>
+<a href ="../">Up</a>
+<hr>
+2011-02-23 +0900<br />
+2001-02-12 +0900<br />
+Copyright (C) 2001-2011 Hisashi MORITA<br />
+</body>
+</html>