docdiff 0.6.2 → 0.6.5

data/doc/man/docdiff.adoc

@@ -0,0 +1,146 @@
+= docdiff(1)
+
+== NAME
+
+docdiff - character/word-oriented diff
+
+== SYNOPSIS
+
+*docdiff* [_OPTIONS_] _FILE1_ _FILE2_
+
+== DESCRIPTION
+
+Compares two text files by word, by character, or by line
+
+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 (Windows-31J), CR, LF, and CRLF.
+
+== OPTIONS
+
+*--resolution*=RESOLUTION::
+  specify resolution (granularity)
+  _line_|_word_|_char_ (default: _word_)
+
+*--line*::
+  same as --resolution=_line_
+
+*--word*::
+  same as --resolution=_word_
+
+*--char*::
+  same as --resolution=_char_
+
+*--encoding*=ENCODING::
+  specify character encoding
+  _ASCII_|_EUC-JP_|_Shift_JIS_|_CP932_|_UTF-8_|_auto_ (default: _auto_)
+  (try _ASCII_ for single byte encodings such as ISO-8859-X)
+
+*--ascii*::
+  same as *--encoding*=_ASCII_
+
+*--iso8859*::
+  same as *--encoding*=_ASCII_
+
+*--iso8859x*::
+  same as *--encoding*=_ASCII_ (deprecated)
+
+*--eucjp*::
+  same as *--encoding*=_EUC-JP_
+
+*--sjis*::
+  same as *--encoding*=_Shift_JIS_
+
+*--cp932*::
+  same as *--encoding*=_CP932_
+
+*--utf8*::
+  same as *--encoding*=_UTF-8_
+
+*--eol*=EOL::
+  specify end-of-line character
+  _CR_|_LF_|_CRLF_|_auto_ (default: _auto_)
+
+*--cr*::
+  same as *--eol*=_CR_
+
+*--lf*::
+  same as *--eol*=_LF_
+
+*--crlf*::
+  same as *--eol*=_CRLF_
+
+*--format*=FORMAT::
+  specify output format
+  _tty_|_manued_|_html_|_wdiff_|_stat_|_user_ (default: _html_) (_stat_ is deprecated)
+  (user tags can be defined in config file)
+
+*--tty*::
+  same as *--format*=_tty_
+
+*--manued*::
+  same as *--format*=_manued_
+
+*--html*::
+  same as *--format*=_html_
+
+*--wdiff*::
+  same as *--format*=_wdiff_
+
+*--stat*::
+  same as *--format*=_stat_ (not implemented) (deprecated)
+
+*-L*, *--label* LABEL::
+  use label instead of file name (not implemented; exists for compatibility with diff)
+
+*--digest*::
+  digest output, do not show all
+
+*--summary*::
+  same as *--digest*
+
+*--display*=DISPLAY::
+  specify presentation type (effective only with digest; experimental feature)
+  _inline_|_block_|_multi_ (default: _inline_) (_multi_ is deprecated)
+
+*--cache*::
+  use file cache (not implemented) (deprecated)
+
+*--pager*=PAGER::
+  specify pager (if available, $_DOCDIFF_PAGER_ is used by default)
+
+*--no-pager*::
+  do not use pager
+
+*--config-file*=FILE::
+  specify config file to read
+
+*--no-config-file*::
+  do not read config files
+
+*--verbose*::
+  run verbosely (not well-supported) (deprecated)
+
+*--help*::
+  show this message
+
+*--version*::
+  show version
+
+*--license*::
+  show license (deprecated)
+
+*--author*::
+  show author(s) (deprecated)
+
+When invoked as *worddiff* or *chardiff*, resolution will be set accordingly.
+
+Config files: _/etc/docdiff/docdiff.conf_, _~/.config/docdiff/docdiff.conf_
+
+== SEE ALSO
+
+_/path/to/README.html_.
+
+== AUTHOR
+
+Hisashi Morita

data/doc/news.md

@@ -0,0 +1,189 @@
+# News
+
+### 0.6.5 (2025-12-29)
+
+* User-visible changes:
+  - Fixed label option not accumulating correctly.
+  - Fixed CRLF bug ([#57](https://github.com/hisashim/docdiff/issues/57)), where CRLFs in the input text are gobbled and not printed in the output when using `tty`, `wdiff`, and `user` formats. This problem seems to have existed since 0.3.
+* Developer-related changes:
+  - Moved CLI-related stuff from `bin/docdiff` to `lib/docdiff/cli.rb`.
+  - Miscellaneous fixes and refactoring.
+
+### 0.6.4 (2025-12-13)
+
+* User-visible changes:
+  - Removed ChangeLog.
+  - Reorganized and updated documents: most documents are moved to `doc/`.
+  - `$XDG_CONFIG_HOME`-style user configuration file name (`~/.config/docdiff/docdiff.conf`) is supported and encouraged to use.
+  - Added a manual page (`doc/man/docdiff.1` will be generated from `.adoc` by `make docs`).
+  - Added shell completion scripts for Zsh and Bash.
+  - Cleaned up CLI help message a bit.
+  - Added pager support with `--pager=` and `--no-pager` options. `$DOCDIFF_PAGER` is consulted as well.
+  - Added `--iso8859` to supersede `--iso8859x`; ditto for `--display=block` and `--display=multi`.
+  - Marked to-be-deprecated features as deprecated, e.g.: `--format=stat`, `--stat`, `--cache`, `--iso8859x`, `--display=multi`, `--verbose`, `--license`, `--author`, `~/etc/docdiff/docdiff.conf`, and `~/.docdiff/docdiff.conf`.
+* Developer-related changes:
+  - Removed test logging.
+  - Fixed erroneous tarball generation (`make dist`).
+  - Introduced additional development requirements: git, md2html, asciidoctor.
+  - Fixed irregular time stamps of gem members by setting `$SOURCE_DATE_EPOCH`.
+  - Converted EUC-JP code files to UTF-8.
+
+### 0.6.3 (2025-12-13)
+
+This version was revoked due to a mistake in the release procedure.
+
+### 0.6.2 (2025-11-28)
+
+* User-visible changes:
+  - Add support for stdin (`-`) in command line arguments (thanks to tamo)
+  - Add `--config-file` option (thanks to tamo)
+  - Fix incompatibility with Ruby 3.4 `Regexp` (thanks to yoshuki)
+  - Resolve frozen literal warnings introduced by Ruby 3.4.
+* Developer-related changes:
+  - Remove unused files: ViewDiff and its tests.
+  - Update email address in `.gemspec`.
+
+### 0.6.1 (2021-06-07)
+
+* User-visible changes:
+  - none
+* Developer-related changes:
+  - Update information in `.gemspec`. (Primary repository is now GitHub, etc.)
+  - Fix: Use `VERSION` from local library when building a gem.
+
+### 0.6.0 (2020-07-10)
+
+* User-visible changes:
+  - Drop support for Ruby 1.8 (thanks to takahashim).
+  - Fix various encoding problems (thanks to takahashim).
+  - Add CP932 (Windows-31J) support through a new option `--cp932` (thanks to emasaka).
+  - Introduce `readme.md`, which will obsolete `readme.html` eventually (thanks to takahashim).
+* Developer-related changes:
+  - Use Mutex#synchronize instead of Thread.exclusive (thanks to hsbt).
+  - Remove `JIS0208.TXT` to comply with its terms of use (thanks to kmuto).
+  - Introduce top-level class `DocDiff` to avoid name conflict (thanks to hibariya).
+
+### 0.5.0 (2011-08-12)
+
+* Gemify. Now you can download docdiff via rubygems.org.
+* Fix failing test on ruby1.9.2-p290.
+
+### 0.4.0 (2011-02-23)
+
+* Compatible with Ruby 1.9 (thanks to Kazuhiko).
+
+### 0.3.4 (2007-12-10)
+
+* Increased context length in digest mode from 16 to 32.
+* Added `--display=inline|multi` option. With inline, things before change and things after change are displayed inline. With multi, they are displayed in separate blocks. Default is inline.
+* Added `--iso8859x` option as an alias to `--encoding=ASCII`, so that users notice DocDiff can handle text in ISO-8859-* encoding.
+
+### 0.3.3 (2006-02-03)
+
+* Fixed arg test so that we can compare non-normal files, such as device files and named pipes (thanks to Shugo Maeda).
+* Added DocDiff Web UI sample (experimental).
+* Fixed HTML output to produce valid XHTML (thanks to Hiroshi OHKUBO).  Note that CSS in HTML output is slightly changed.
+* Replaced underscores(`_`) in CSS class names to hyphens(`-`) so that older UAs can understand them (thanks to Kazuhiro NISHIYAMA).
+
+### 0.3.2 (2005-01-03)
+
+* Readme is multilingualized (added partial Japanese translation).  Try switching CSS between en and ja.  Monolingual files are also available (`readme.en.html`, `readme.ja.html`).
+* Outputs better error messages when it failed to auto-detect the encoding and/or eol, though the accuracy is the same.
+* Switched revision control system from CVS to Subversion.
+
+### 0.3.1 (2004-08-29)
+
+* Added `-L` (`--label`) option place holder in order to be used as external diff program from Subversion.
+
+### 0.3.0 (2004-05-29)
+
+* Re-designed and re-written from scratch.
+* Supports multiple encodings (ASCII, EUC-JP, Shift_JIS, UTF-8) and multiple eols (CR, LF, CRLF).
+* Supports more output formats (tty, HTML, Manued, wdiff-like, user-defined markup text).
+* Supports configuration files (`/etc/docdiff/docdiff.conf`, `~/etc/docdiff/docdiff.conf` (or `~/.docdiff/docdiff.conf`)).
+* Introduced digest (summary) mode.
+* Approximately 200% faster than older versions, thanks to akr's diff library.
+* Better documentation and help message.
+* License changed from Ruby's to modified BSD style.
+* Pure Ruby.  Does not require external diff program such as GNU diff, or morphological analyzer such as ChaSen.
+* Runs on both Unix and Windows (tested on Debian GNU/Linux and Cygwin).
+* Unit tests introduced to decrease bugs and to encourage faster development.
+* Makefile introduced.
+
+### 0.1.8 (2003-12-14)
+
+* Displays warning when `--bymorpheme` is specified but ChaSen is not available (patch by Akira YAMADA: Debian bug #192258).
+* Supports system-wide configuration file (if `~/.chasenrc.docdiff` does not exist, reads `/etc/docdiff/chasenrc`) (patch by Akira YAMADA: Debian bug #192261).
+
+### 0.1.7 (2003-11-21)
+
+* HTML output retains spaces (` ` patch by Akira YAMADA).
+* Manued output is added.  Use `--manued` command line option to get result in Manued-like format.
+* Fixed `.chasenrc.docdiff` to be compatible with the latest ChaSen, so that it does not cause error.
+* Alphabet words in the output may look ugly, since ChaSen does not keep spaces between alphabetical words recently.
+* Other minor bug fixes and code cleanup.
+
+### 0.2.0b2 (2001-08-31)
+
+* Code cleanup.
+
+### 0.2.0b1 (2001-08-31)
+
+* A bit faster than 0.1.x, using file cache.
+* A bit cleaner code.
+
+### 0.1.6 (2001-05-16)
+
+* Increased diff option number from 100000 to 1000000 in order to support 900KB+ text files.
+
+### 0.1.5 (2001-01-17)
+
+* Erased useless old code which were already commented out.
+* Added documentation. (Updated README, more comments)
+* First public release.  Registered to RAA.
+
+### 0.1.4 (2001-01-16)
+
+* Output is like `<tag>ab</tag>`, instead of ugly `<tag>a</tag><tag>b</tag>` (thanks again to Masatoshi Seki for suggestion).
+* Fixed hidden bug (`puts` was used to output result).
+* Some code clean-up, though still hairy enough.
+
+### 0.1.3 (2001-01-09)
+
+* Tested with Ruby 1.6.2.
+* Fixed `meth(a,b,)` bug (thanks to Masatoshi Seki).
+* Switched development platform from Windows to Linux, but it should work fine on Windows too, except for ChaSen stuff.
+
+### 0.1.2 (2000-12-28)
+
+* Mostly bug fix.
+
+### 0.1.1 (2000-12-25)
+
+* Bug fix and some cleanup.
+* Quotes some of HTML special characters (`<>&`) when output in HTML.
+* Added support for tty output using escape sequence.
+
+### 0.1.0 (2000-12-19)
+
+* ChaSen works fine now.
+* GetOptLong was introduced to support command line options.
+
+### 0.1.0a1 (2000-12-16)
+
+* Added ChaSen support.  Japanese word by word comparison requires ChaSen.
+* Converted scripts from Shift_JIS/CRLF to EUC-JP/LF.
+
+### 0.0.2 (2000-12-10)
+
+* Rewritten to use class.
+
+### 0.0.1 (2000-12-09)
+
+* First version.  Proof-of-concept.
+* Supports ASCII, EUC-JP, LF only.
+* Supports HTML output only.
+* Requires GNU diff.
+* Distributed under the same license as Ruby's.
+
+See the source repository for detail.

data/doc/shell_completion/_docdiff.zsh

@@ -0,0 +1,51 @@
+#compdef docdiff
+
+# Zsh completion for DocDiff
+
+_docdiff() {
+    integer ret=1
+    local -a args
+    args+=(
+        '--resolution=[specify resolution (granularity)]:resolution:(line word char)'
+        '--line[same as --resolution=line]'
+        '--word[same as --resolution=word]'
+        '--char[same as --resolution=char]'
+        '--encoding=[specify character encoding]:encoding:(ASCII EUC-JP Shift_JIS CP932 UTF-8 auto)'
+        '--ascii[same as --encoding=ASCII]'
+        '--iso8859[same as --encoding=ASCII]'
+        '--iso8859x[same as --encoding=ASCII (deprecated)]'
+        '--eucjp[same as --encoding=EUC-JP]'
+        '--sjis[same as --encoding=Shift_JIS]'
+        '--cp932[same as --encoding=CP932]'
+        '--utf8[same as --encoding=UTF-8]'
+        '--eol=[specify end-of-line character]:eol:(CR LF CRLF auto)'
+        '--cr[same as --eol=CR]'
+        '--lf[same as --eol=LF]'
+        '--crlf[same as --eol=CRLF]'
+        '--format=[specify output format]:format:(tty manued html wdiff stat user)'
+        '--tty[same as --format=tty]'
+        '--manued[same as --format=manued]'
+        '--html[same as --format=html]'
+        '--wdiff[same as --format=wdiff]'
+        '--stat[same as --format=stat (not implemented) (deprecated)]'
+        '(--label= -L)'{--label=,-L}'[use label instead of file name (not implemented)]:label'
+        '--digest[digest output, do not show all]'
+        '--summary[same as --digest]'
+        '--display=[specify presentation type (effective only with digest)]:type:(inline block multi)'
+        '--cache[use file cache (not implemented) (deprecated)]'
+        '--pager=[specify pager]:pager:_command_names'
+        '--no-pager[do not use pager]'
+        '--config-file=[specify config file to read]:config_file:_files'
+        '--no-config-file[do not read config files]'
+        '--verbose[run verbosely (not well-supported) (deprecated)]'
+        '(- *)--help[show this message]'
+        '(- *)--version[show version]'
+        '(- *)--license[show license (deprecated)]'
+        '(- *)--author[show author(s) (deprecated)]'
+        '*:file:_files'
+    )
+    _arguments $args[@] && ret=0
+    return ret
+}
+
+_docdiff

data/doc/shell_completion/docdiff.bash

@@ -0,0 +1,68 @@
+# Bash completion for DocDiff
+
+_docdiff_completions()
+{
+  local cur prev opts
+  cur="${COMP_WORDS[COMP_CWORD]}"
+  prev="${COMP_WORDS[COMP_CWORD-1]}"
+  opts="\
+    --resolution \
+    --line --word --char \
+    --encoding \
+    --ascii --iso8859 --iso8859x --eucjp --sjis --cp932 --utf8 \
+    --eol \
+    --cr --lf --crlf \
+    --format \
+    --tty --manued --html --wdiff --stat \
+    -L --label \
+    --digest --summary \
+    --display \
+    --cache \
+    --pager \
+    --no-pager \
+    --config-file \
+    --no-config-file \
+    --verbose \
+    --help \
+    --version \
+    --license \
+    --author\
+    "
+  COMPREPLY=()
+
+  case ${prev} in
+    --resolution)
+      COMPREPLY=( $(compgen -W 'line word char' -- "${cur}") )
+      return 0
+      ;;
+    --encoding)
+      COMPREPLY=( $(compgen -W 'ASCII EUC-JP Shift_JIS CP932 UTF-8 auto' -- "${cur}") )
+      return 0
+      ;;
+    --eol)
+      COMPREPLY=( $(compgen -W 'CR LF CRLF auto' -- "${cur}") )
+      return 0
+      ;;
+    --format)
+      COMPREPLY=( $(compgen -W 'tty manued html wdiff stat user' -- "${cur}") )
+      return 0
+      ;;
+    --display)
+      COMPREPLY=( $(compgen -W 'inline block multi' -- "${cur}") )
+      return 0
+      ;;
+    --config-file)
+      COMPREPLY=( $(compgen -A file -- "${cur}") )
+      return 0
+      ;;
+    --help | --version | --license | --author)
+      return 0
+      ;;
+  esac
+
+  if [[ ${cur} == -* ]]; then
+    COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
+    return
+  fi
+} &&
+  complete -o bashdefault -o default -F _docdiff_completions docdiff

data/docdiff.gemspec

@@ -20,4 +20,6 @@ Gem::Specification.new do |s|
   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"]
+  s.required_ruby_version = '>= 3.0'
+  s.add_development_dependency "test-unit", "~> 3"
 end

data/lib/doc_diff.rb

@@ -4,10 +4,10 @@
 require 'docdiff/difference'
 require 'docdiff/document'
 require 'docdiff/view'
+require 'docdiff/cli'
 
 class DocDiff
 
-  AppVersion = Docdiff::VERSION
   Author = "Copyright (C) 2002-2011 Hisashi MORITA.\n" +
            "diff library originates from Ruby/CVS by TANAKA Akira.\n"
   License = "This software is licensed under so-called modified BSD license.\n" +
@@ -15,34 +15,28 @@ class DocDiff
   SystemConfigFileName = File.join(File::Separator, "etc", "docdiff", "docdiff.conf")
   UserConfigFileName = File.join(ENV['HOME'], "etc", "docdiff", "docdiff.conf")
   AltUserConfigFileName = File.join(ENV['HOME'], ".docdiff", "docdiff.conf")
+  XDGUserConfigFileName =
+    if xdg_config_home = ENV['XDG_CONFIG_HOME'] && !xdg_config_home.empty?
+      File.join(ENV['HOME'], xdg_config_home, "docdiff", "docdiff.conf")
+    else
+      File.join(ENV['HOME'], ".config", "docdiff", "docdiff.conf")
+    end
+  DEFAULT_CONFIG = {
+    :resolution    => "word",
+    :encoding      => "auto",
+    :eol           => "auto",
+    :format        => "html",
+    :cache         => true,
+    :digest        => false,
+    :pager         => nil,
+    :verbose       => false
+  }
 
-  def initialize()
-    @config = {}
+  def initialize(config: {})
+    @config = config
   end
   attr_accessor :config
 
-  def DocDiff.parse_config_file_content(content)
-    result = {}
-    return result if content.size <= 0
-    lines = content.dup.split(/\r\n|\r|\n/).compact
-    lines.collect!{|line| line.sub(/#.*$/, '')}
-    lines.collect!{|line| line.strip}
-    lines.delete_if{|line| line == ""}
-    lines.each{|line|
-      raise 'line does not include " = ".' unless /[\s]+=[\s]+/.match line
-      name_src, value_src = line.split(/[\s]+=[\s]+/)
-      raise "Invalid name: #{name_src.inspect}" if (/\s/.match name_src)
-      raise "Invalid value: #{value_src.inspect}" unless value_src.kind_of?(String)
-      name  = name_src.intern
-      value = value_src
-      value = true if ['on','yes','true'].include? value_src.downcase
-      value = false if ['off','no','false'].include? value_src.downcase
-      value = value_src.to_i if /^[0-9]+$/.match value_src
-      result[name] = value
-    }
-    result
-  end
-
   def compare_by_line(doc1, doc2)
     Difference.new(doc1.split_to_line, doc2.split_to_line)
   end
@@ -156,19 +150,4 @@ class DocDiff
     end
     result.join
   end
-
-  def process_config_file(filename)
-    file_content = nil
-    begin
-      File.open(filename, "r"){|f| file_content = f.read}
-    rescue Errno::ENOENT
-      message = "config file not found so not read."
-    ensure
-      if file_content != nil
-        self.config.update(DocDiff.parse_config_file_content(file_content))
-      end
-    end
-    message
-  end
-
 end  # class DocDiff