Rename to ydiff (version 1.1)

CHANGES.rst

@@ -2,6 +2,12 @@
 Change log
 ==========
 
+Version 1.1 (2018-06-05)
+
+  - Rename from ``cdiff`` to ``ydiff`` to avoid binary name conflict on major
+    distributions, ``CDIFF_OPTIONS`` still works but will be deprepated soon
+  - New option ``--wrap`` to wrap long lines in side-by-side view
+
 Version 1.0 (2016-12-31)
 
   - Use environment variable ``CDIFF_OPTIONS`` to hold default options

LICENSE

@@ -1,6 +1,6 @@
 Software License Agreement (BSD-3 License)
 
-Copyright (c) 2013, Matthew Wang <mattwyl(@)gmail(.)com>
+Copyright (c) 2013-2018, Matt Wang <mattwyl(@)gmail(.)com>
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,
@@ -8,12 +8,12 @@ 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 cdiff nor the names of its contributors may be used
+    3. Neither the name of ydiff nor the names of its contributors may be used
        to endorse or promote products derived from this software without
        specific prior written permission.
 

Makefile

@@ -7,8 +7,8 @@ PYPI = pypi
 	test test3 cov cov3 html reg reg3 profile profile3
 
 dogfood:
-	./cdiff.py
-	git diff | ./cdiff.py -s
+	./ydiff.py
+	git diff | ./ydiff.py -s
 
 lint:
 	pep8 --ignore=E203 *.py tests/*.py
@@ -27,11 +27,11 @@ test: lint doc-check cov reg
 test3: lint doc-check cov3 reg3
 
 cov:
-	coverage run tests/test_cdiff.py
+	coverage run tests/test_ydiff.py
 	coverage report --show-missing
 
 cov3:
-	python3 `which coverage` run tests/test_cdiff.py
+	python3 `which coverage` run tests/test_ydiff.py
 	python3 `which coverage` report --show-missing
 
 html:
@@ -52,17 +52,17 @@ profile3:
 
 clean:
 	rm -f MANIFEST profile*.tmp* .coverage
-	rm -rf build/ cdiff.egg-info/ dist/ __pycache__/ htmlcov/
+	rm -rf build/ ydiff.egg-info/ dist/ __pycache__/ htmlcov/
 
 build:
 	./setup.py build sdist
 
-dist-test:
-	./setup.py build sdist register upload -r $(TESTPYPI)
+dist-test: clean build
+	twine upload --repository-url https://test.pypi.org/legacy/ dist/*
 	rm -f ~/.pypirc
 
-dist:
-	./setup.py build sdist register upload -r $(PYPI)
+dist: clean build
+	twine upload dist/*
 	rm -f ~/.pypirc
 
 # vim:set noet ts=8 sw=8:

README.rst

@@ -1,19 +1,19 @@
-Cdiff
+Ydiff
 =====
 
-.. image:: https://travis-ci.org/ymattw/cdiff.png?branch=master
-   :target: https://travis-ci.org/ymattw/cdiff
+.. image:: https://travis-ci.org/ymattw/ydiff.png?branch=master
+   :target: https://travis-ci.org/ymattw/ydiff
    :alt: Build status
 
 Term based tool to view *colored*, *incremental* diff in a *Git/Mercurial/Svn*
-workspace or from stdin, with *side by side* and *auto pager* support. Requires
-python (>= 2.5.0) and ``less``.
+workspace or from stdin, with *side by side* (similar to ``diff -y``) and *auto
+pager* support. Requires python (>= 2.5.0) and ``less``.
 
-.. image:: https://raw.github.com/ymattw/cdiff/gh-pages/img/default.png
+.. image:: https://raw.github.com/ymattw/ydiff/gh-pages/img/default.png
    :alt: default
    :align: center
 
-.. image:: https://raw.github.com/ymattw/cdiff/gh-pages/img/side-by-side.png
+.. image:: https://raw.github.com/ymattw/ydiff/gh-pages/img/side-by-side.png
    :alt: side by side
    :align: center
    :width: 900 px
@@ -24,14 +24,14 @@ Installation
 Install with pip
 ~~~~~~~~~~~~~~~~
 
-Cdiff is already listed on `PyPI`_, you can install with ``pip`` if you have
+Ydiff is already listed on `PyPI`_, you can install with ``pip`` if you have
 the tool.
 
-.. _PyPI: http://pypi.python.org/pypi/cdiff
+.. _PyPI: http://pypi.python.org/pypi/ydiff
 
 .. code-block:: bash
 
-    pip install --upgrade cdiff
+    pip install --upgrade ydiff
 
 Install with setup.py
 ~~~~~~~~~~~~~~~~~~~~~
@@ -40,8 +40,8 @@ You can also run the setup.py from the source if you don't have ``pip``.
 
 .. code-block:: bash
 
-    git clone https://github.com/ymattw/cdiff.git
-    cd cdiff
+    git clone https://github.com/ymattw/ydiff.git
+    cd ydiff
     ./setup.py install
 
 Install with Homebrew
@@ -55,33 +55,33 @@ You can also install with Homebrew on Mac. (Thanks to `@josa42`_,
 .. _`@bfontaine`: https://github.com/bfontaine
 .. _`@hivehand`: https://github.com/hivehand
 .. _`@nijikon`: https://github.com/nijikon
-.. _`Formula`: https://github.com/Homebrew/homebrew-core/blob/master/Formula/cdiff.rb
+.. _`Formula`: https://github.com/Homebrew/homebrew-core/blob/master/Formula/ydiff.rb
 
 .. code-block:: bash
 
-    brew install cdiff
+    brew install ydiff
 
 Download directly
 ~~~~~~~~~~~~~~~~~
 
-Just save `cdiff.py`_ to whatever directory which is in your ``$PATH``, for
+Just save `ydiff.py`_ to whatever directory which is in your ``$PATH``, for
 example, ``$HOME/bin`` is in my ``$PATH``, so I save the script there and name
-as ``cdiff``.
+as ``ydiff``.
 
-.. _`cdiff.py`: https://raw.github.com/ymattw/cdiff/master/cdiff.py
+.. _`ydiff.py`: https://raw.github.com/ymattw/ydiff/master/ydiff.py
 
 .. code-block:: bash
 
-    curl -ksSL https://raw.github.com/ymattw/cdiff/master/cdiff.py > ~/bin/cdiff
-    chmod +x ~/bin/cdiff
+    curl -ksSL https://raw.github.com/ymattw/ydiff/master/ydiff.py > ~/bin/ydiff
+    chmod +x ~/bin/ydiff
 
 Usage
 -----
 
-Type ``cdiff -h`` to show usage::
+Type ``ydiff -h`` to show usage::
 
-    $ cdiff -h
-    Usage: cdiff [options] [file|dir ...]
+    $ ydiff -h
+    Usage: ydiff [options] [file|dir ...]
 
     View colored, incremental diff in a workspace or from stdin, with side by side
     and auto pager support
@@ -99,7 +99,7 @@ Type ``cdiff -h`` to show usage::
 
       Note:
         Option parser will stop on first unknown option and pass them down to
-        underneath revision control. Environment variable CDIFF_OPTIONS may be
+        underneath revision control. Environment variable YDIFF_OPTIONS may be
         used to specify default options that will be placed at the beginning
         of the argument list.
 
@@ -109,16 +109,16 @@ from e.g. ``git diff``, ``svn diff``):
 .. code-block:: bash
 
     cd proj-workspace
-    cdiff                         # view colored incremental diff
-    cdiff -s                      # view side by side, use default text width 80
-    cdiff -s -w 90                # use text width 90 other than default 80
-    cdiff -s -w 0                 # auto set text width based on terminal size
-    cdiff -s -w 0 --wrap          # same as before, but also wrap long lines
-    cdiff -s file1 dir2           # view modification of given files/dirs only
-    cdiff -s -w90 --wrap -- -U10  # pass '-U10' to underneath revision diff tool
-    cdiff -s -w90 --wrap -U10     # '--' is optional as it's unknown to cdiff
-    cdiff -s --cached             # show git staged diff (git diff --cached)
-    cdiff -s -r1234               # show svn diff to revision 1234
+    ydiff                         # view colored incremental diff
+    ydiff -s                      # view side by side, use default text width 80
+    ydiff -s -w 90                # use text width 90 other than default 80
+    ydiff -s -w 0                 # auto set text width based on terminal size
+    ydiff -s -w 0 --wrap          # same as before, but also wrap long lines
+    ydiff -s file1 dir2           # view modification of given files/dirs only
+    ydiff -s -w90 --wrap -- -U10  # pass '-U10' to underneath revision diff tool
+    ydiff -s -w90 --wrap -U10     # '--' is optional as it's unknown to ydiff
+    ydiff -s --cached             # show git staged diff (git diff --cached)
+    ydiff -s -r1234               # show svn diff to revision 1234
 
 Read log with changes in a *Git/Mercurial/Svn* workspace (output from e.g.
 ``git log -p``, ``svn log --diff``), note *--diff* option is new in svn 1.7.0:
@@ -126,57 +126,57 @@ Read log with changes in a *Git/Mercurial/Svn* workspace (output from e.g.
 .. code-block:: bash
 
     cd proj-workspace
-    cdiff -l                    # read log along with changes
-    cdiff -ls                   # equivalent to cdiff -l -s, view side by side
-    cdiff -ls -w90 --wrap       # set text width 90 and enable wrapping as well
-    cdiff -ls file1 dir2        # see log with changes of given files/dirs only
+    ydiff -l                    # read log along with changes
+    ydiff -ls                   # equivalent to ydiff -l -s, view side by side
+    ydiff -ls -w90 --wrap       # set text width 90 and enable wrapping as well
+    ydiff -ls file1 dir2        # see log with changes of given files/dirs only
 
-Environment variable ``CDIFF_OPTIONS`` may be used to specify default options
+Environment variable ``YDIFF_OPTIONS`` may be used to specify default options
 that will be placed at the beginning of the argument list, for example:
 
 .. code-block:: bash
 
-    export CDIFF_OPTIONS='-s -w0 --wrap'
-    cdiff foo                   # equivalent to "cdiff -s -w0 --wrap foo"
+    export YDIFF_OPTIONS='-s -w0 --wrap'
+    ydiff foo                   # equivalent to "ydiff -s -w0 --wrap foo"
 
-If you feel more comfortable with a command such as ``git cdiff`` to trigger
-the cdiff command, you may symlink the executable to one named ``git-cdiff``
+If you feel more comfortable with a command such as ``git ydiff`` to trigger
+the ydiff command, you may symlink the executable to one named ``git-ydiff``
 as follows:
 
 .. code-block:: bash
 
-    cdiff_dir=$(dirname $(which cdiff))
-    ln -s "${cdiff_dir}/cdiff" "${cdiff_dir}/git-cdiff"
+    ydiff_dir=$(dirname $(which ydiff))
+    ln -s "${ydiff_dir}/ydiff" "${ydiff_dir}/git-ydiff"
 
 Pipe in a diff:
 
 .. code-block:: bash
 
-    git log -p -2 | cdiff       # view git log with changes of last 2 commits
-    git show 15bfa | cdiff -s   # view a given git commit, side by side
-    svn diff -r1234 | cdiff -s  # view svn diff comparing to given revision
-    diff -u file1 file2 | cdiff # view diff between two files (note the '-u')
-    diff -ur dir1 dir2 | cdiff  # view diff between two dirs
+    git log -p -2 | ydiff       # view git log with changes of last 2 commits
+    git show 15bfa | ydiff -s   # view a given git commit, side by side
+    svn diff -r1234 | ydiff -s  # view svn diff comparing to given revision
+    diff -u file1 file2 | ydiff # view diff between two files (note the '-u')
+    diff -ur dir1 dir2 | ydiff  # view diff between two dirs
 
     # View diff in a GitHub pull request, side by side
-    curl https://github.com/ymattw/cdiff/pull/11.diff | cdiff -s
+    curl https://github.com/ymattw/ydiff/pull/11.diff | ydiff -s
 
     # View a patch file in unified or context format, the latter depends on
     # command `filterdiff` from package `patchutils` which is available in
     # major Linux distros and MacPorts.
     #
-    cdiff -s < foo.patch
+    ydiff -s < foo.patch
 
 Redirect output to another patch file is safe:
 
 .. code-block:: bash
 
-    svn diff -r PREV | cdiff -s > my.patch
+    svn diff -r PREV | ydiff -s > my.patch
 
 Notes
 -----
 
-Cdiff has following known issues:
+Ydiff has following known issues:
 
 - Does not recognize `normal` diff, and depends on ``filterdiff`` (patchutils)
   to read `context` diff
@@ -188,14 +188,14 @@ tests and regression tests by run ``make test`` (required tool *coverage* can
 be installed with ``pip install coverage``).  Also watch out `travis build`_
 after push, make sure it passes as well.
 
-.. _`travis build`: https://travis-ci.org/ymattw/cdiff/pull_requests
+.. _`travis build`: https://travis-ci.org/ymattw/ydiff/pull_requests
 
 See also
 --------
 
 I have another tool `coderev`_ which generates side-by-side diff pages for code
 review from two given files or directories, I found it's not easy to extend to
-support git so invented `cdiff`.  Idea of ansi color markup is also from
+support git so invented `ydiff`.  Idea of ansi color markup is also from
 project `colordiff`_.
 
 .. _coderev: https://github.com/ymattw/coderev

setup.py

@@ -4,7 +4,7 @@
 from __future__ import with_statement
 import sys
 from distutils.core import setup
-from cdiff import META_INFO as _meta
+from ydiff import META_INFO as _meta
 
 if sys.hexversion < 0x02050000:
     raise SystemExit("*** Requires python >= 2.5.0")
@@ -15,10 +15,10 @@ with open('CHANGES.rst') as changes:
     long_description += changes.read()
 
 setup(
-    name='cdiff',
+    name='ydiff',
     version=_meta['version'],
     author=_meta['author'],
-    author_email=_meta['email'],
+    author_email=_meta['email'].replace('(', '').replace(')', ''),
     license=_meta['license'],
     description=_meta['description'],
     long_description=long_description,
@@ -38,8 +38,8 @@ setup(
         'Programming Language :: Python :: 2',
         'Programming Language :: Python :: 3',
     ],
-    py_modules=['cdiff'],
-    scripts=['cdiff'],
+    py_modules=['ydiff'],
+    scripts=['ydiff'],
 )
 
 # vim:set et sts=4 sw=4 tw=79:

tests/README

@@ -1,7 +1,7 @@
 # To generate expected output, chdir to a subdir and use following command, then
 # review with `less -R`
 #
-../../cdiff.py -c always < in.diff > out.normal
-../../cdiff.py -c always -s < in.diff > out.side-by-side
-../../cdiff.py -c always -s < in.diff -w70 > out.w70
-../../cdiff.py -c always -s < in.diff -w70 --wrap > out.w70.wrap
+../../ydiff.py -c always < in.diff > out.normal
+../../ydiff.py -c always -s < in.diff > out.side-by-side
+../../ydiff.py -c always -s < in.diff -w70 > out.w70
+../../ydiff.py -c always -s < in.diff -w70 --wrap > out.w70.wrap

tests/profile.sh

@@ -3,7 +3,7 @@
 OUTPUT=${1:?"output file required"}
 
 SELF_DIR=$(cd $(dirname $0) && pwd) || exit 1
-CDIFF_PY=$SELF_DIR/../cdiff.py
+YDIFF_PY=$SELF_DIR/../ydiff.py
 
 # To test with py3k: PYTHON=python3 make test
 PYTHON=${PYTHON:-python}
@@ -12,11 +12,11 @@ set -o errexit
 STATS="stats.$$.tmp"
 
 for i in {1..100}; do cat "tests/svn/in.diff"; done \
-    | $PYTHON -m cProfile -o $STATS $CDIFF_PY -c always -s -w 60 \
+    | $PYTHON -m cProfile -o $STATS $YDIFF_PY -c always -s -w 60 \
     > /dev/null
 
 $PYTHON -c "import pstats;  p = pstats.Stats('$STATS'); \
-    p.strip_dirs().sort_stats('time').print_stats('cdiff')" \
+    p.strip_dirs().sort_stats('time').print_stats('ydiff')" \
     | tee $OUTPUT
 
 rm -f $STATS

tests/regression.sh

@@ -3,7 +3,7 @@
 TOP_DIR=$(cd $(dirname $0)/.. && pwd) || exit 1
 cd $TOP_DIR || exit 1
 
-CDIFF=./cdiff
+YDIFF=./ydiff
 
 # To test with py3k: PYTHON=python3 make test
 PYTHON=${PYTHON:-python}
@@ -30,10 +30,10 @@ function cmp_output()
 {
     local input=${1:?}
     local expected_out=${2:?}
-    local cdiff_opt=${3:-""}
+    local ydiff_opt=${3:-""}
     local cmd
 
-    cmd=$(printf "%-7s $CDIFF %-24s < %-30s " $PYTHON "$cdiff_opt" "$input")
+    cmd=$(printf "%-7s $YDIFF %-24s < %-30s " $PYTHON "$ydiff_opt" "$input")
     printf "$cmd"
     if eval $cmd 2>/dev/null | cmp --silent $expected_out -; then
         pass

tests/test_cdiff.py → tests/test_ydiff.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-"""Unit test for cdiff"""
+"""Unit test for ydiff"""
 
 import sys
 import unittest
@@ -10,7 +10,7 @@ import subprocess
 import os
 
 sys.path.insert(0, '')
-import cdiff  # nopep8
+import ydiff  # nopep8
 
 
 class Sequential(object):
@@ -41,27 +41,27 @@ class Sequential(object):
 class PatchStreamTest(unittest.TestCase):
 
     def test_is_empty(self):
-        stream = cdiff.PatchStream(Sequential([]))
+        stream = ydiff.PatchStream(Sequential([]))
         self.assertTrue(stream.is_empty())
 
-        stream = cdiff.PatchStream(Sequential(['hello', 'world']))
+        stream = ydiff.PatchStream(Sequential(['hello', 'world']))
         self.assertFalse(stream.is_empty())
 
     def test_read_stream_header(self):
-        stream = cdiff.PatchStream(Sequential([]))
+        stream = ydiff.PatchStream(Sequential([]))
         self.assertEqual(stream.read_stream_header(1), [])
 
         items = ['hello', 'world', 'again']
 
-        stream = cdiff.PatchStream(Sequential(items))
+        stream = ydiff.PatchStream(Sequential(items))
         self.assertEqual(stream.read_stream_header(2), items[:2])
 
-        stream = cdiff.PatchStream(Sequential(items))
+        stream = ydiff.PatchStream(Sequential(items))
         self.assertEqual(stream.read_stream_header(4), items[:])
 
     def test_iter_after_read_stream_header(self):
         items = ['hello', 'world', 'again', 'and', 'again']
-        stream = cdiff.PatchStream(Sequential(items))
+        stream = ydiff.PatchStream(Sequential(items))
 
         _ = stream.read_stream_header(2)
         out = list(stream)
@@ -72,7 +72,7 @@ class DecodeTest(unittest.TestCase):
 
     def test_normal(self):
         utext = 'hello'.encode('utf-8')
-        self.assertEqual('hello', cdiff.decode(utext))
+        self.assertEqual('hello', ydiff.decode(utext))
 
     def test_latin_1(self):
         text = '\x80\x02q\x01(U'
@@ -80,20 +80,20 @@ class DecodeTest(unittest.TestCase):
             decoded_text = text.decode('latin-1')
         else:
             decoded_text = text
-        self.assertEqual(decoded_text, cdiff.decode(text))
+        self.assertEqual(decoded_text, ydiff.decode(text))
 
 
 class HunkTest(unittest.TestCase):
 
     def test_get_old_text(self):
-        hunk = cdiff.Hunk([], '@@ -1,2 +1,2 @@', (1, 2), (1, 2))
+        hunk = ydiff.Hunk([], '@@ -1,2 +1,2 @@', (1, 2), (1, 2))
         hunk.append(('-', 'foo\n'))
         hunk.append(('+', 'bar\n'))
         hunk.append((' ', 'common\n'))
         self.assertEqual(hunk._get_old_text(), ['foo\n', 'common\n'])
 
     def test_get_new_text(self):
-        hunk = cdiff.Hunk([], '@@ -1,2 +1,2 @@', (1, 2), (1, 2))
+        hunk = ydiff.Hunk([], '@@ -1,2 +1,2 @@', (1, 2), (1, 2))
         hunk.append(('-', 'foo\n'))
         hunk.append(('+', 'bar\n'))
         hunk.append((' ', 'common\n'))
@@ -120,7 +120,7 @@ class DiffMarkupTest(unittest.TestCase):
             + spaced
         """
 
-        hunk = cdiff.Hunk(['hunk header\n'], '@@ -1,5 +1,5 @@\n',
+        hunk = ydiff.Hunk(['hunk header\n'], '@@ -1,5 +1,5 @@\n',
                           (1, 5), (1, 5))
         hunk.append(('-', 'hhello\n'))
         hunk.append(('+', 'helloo\n'))
@@ -131,14 +131,14 @@ class DiffMarkupTest(unittest.TestCase):
         hunk.append(('-', '	tabbed\n'))
         hunk.append(('+', 'again\n'))
         hunk.append(('+', ' spaced\n'))
-        diff = cdiff.UnifiedDiff(
+        diff = ydiff.UnifiedDiff(
             ['header\n'], '--- old\n', '+++ new\n', [hunk])
         return diff
 
     def test_markup_traditional_hunk_header(self):
-        hunk = cdiff.Hunk(['hunk header\n'], '@@ -0 +0 @@\n', (0, 0), (0, 0))
-        diff = cdiff.UnifiedDiff([], '--- old\n', '+++ new\n', [hunk])
-        marker = cdiff.DiffMarker()
+        hunk = ydiff.Hunk(['hunk header\n'], '@@ -0 +0 @@\n', (0, 0), (0, 0))
+        diff = ydiff.UnifiedDiff([], '--- old\n', '+++ new\n', [hunk])
+        marker = ydiff.DiffMarker()
 
         out = list(marker.markup(diff))
         self.assertEqual(len(out), 4)
@@ -149,10 +149,10 @@ class DiffMarkupTest(unittest.TestCase):
         self.assertEqual(out[3], '\x1b[1;34m@@ -0 +0 @@\n\x1b[0m')
 
     def test_markup_traditional_old_changed(self):
-        hunk = cdiff.Hunk([], '@@ -1 +0,0 @@\n', (1, 0), (0, 0))
+        hunk = ydiff.Hunk([], '@@ -1 +0,0 @@\n', (1, 0), (0, 0))
         hunk.append(('-', 'spam\n'))
-        diff = cdiff.UnifiedDiff([], '--- old\n', '+++ new\n', [hunk])
-        marker = cdiff.DiffMarker()
+        diff = ydiff.UnifiedDiff([], '--- old\n', '+++ new\n', [hunk])
+        marker = ydiff.DiffMarker()
 
         out = list(marker.markup(diff))
         self.assertEqual(len(out), 4)
@@ -163,10 +163,10 @@ class DiffMarkupTest(unittest.TestCase):
         self.assertEqual(out[3], '\x1b[1;31m-spam\n\x1b[0m')
 
     def test_markup_traditional_new_changed(self):
-        hunk = cdiff.Hunk([], '@@ -0,0 +1 @@\n', (0, 0), (1, 0))
+        hunk = ydiff.Hunk([], '@@ -0,0 +1 @@\n', (0, 0), (1, 0))
         hunk.append(('+', 'spam\n'))
-        diff = cdiff.UnifiedDiff([], '--- old\n', '+++ new\n', [hunk])
-        marker = cdiff.DiffMarker()
+        diff = ydiff.UnifiedDiff([], '--- old\n', '+++ new\n', [hunk])
+        marker = ydiff.DiffMarker()
 
         out = list(marker.markup(diff))
         self.assertEqual(len(out), 4)
@@ -177,12 +177,12 @@ class DiffMarkupTest(unittest.TestCase):
         self.assertEqual(out[3], '\x1b[32m+spam\n\x1b[0m')
 
     def test_markup_traditional_both_changed(self):
-        hunk = cdiff.Hunk([], '@@ -1,2 +1,2 @@\n', (1, 2), (1, 2))
+        hunk = ydiff.Hunk([], '@@ -1,2 +1,2 @@\n', (1, 2), (1, 2))
         hunk.append(('-', 'hella\n'))
         hunk.append(('+', 'hello\n'))
         hunk.append((' ', 'common\n'))
-        diff = cdiff.UnifiedDiff([], '--- old\n', '+++ new\n', [hunk])
-        marker = cdiff.DiffMarker()
+        diff = ydiff.UnifiedDiff([], '--- old\n', '+++ new\n', [hunk])
+        marker = ydiff.DiffMarker()
 
         out = list(marker.markup(diff))
         self.assertEqual(len(out), 6)
@@ -202,7 +202,7 @@ class DiffMarkupTest(unittest.TestCase):
 
     def test_markup_side_by_side_padded(self):
         diff = self._init_diff()
-        marker = cdiff.DiffMarker(side_by_side=True, width=7)
+        marker = ydiff.DiffMarker(side_by_side=True, width=7)
 
         out = list(marker.markup(diff))
         self.assertEqual(len(out), 11)
@@ -256,7 +256,7 @@ class DiffMarkupTest(unittest.TestCase):
     # This test is not valid anymore
     def __test_markup_side_by_side_neg_width(self):
         diff = self._init_diff()
-        marker = cdiff.DiffMarker(side_by_side=True, width=-1)
+        marker = ydiff.DiffMarker(side_by_side=True, width=-1)
         out = list(marker.markup(diff))
         self.assertEqual(len(out), 11)
 
@@ -300,7 +300,7 @@ class DiffMarkupTest(unittest.TestCase):
 
     def test_markup_side_by_side_off_by_one(self):
         diff = self._init_diff()
-        marker = cdiff.DiffMarker(side_by_side=True, width=6)
+        marker = ydiff.DiffMarker(side_by_side=True, width=6)
         out = list(marker.markup(diff))
         self.assertEqual(len(out), 11)
 
@@ -351,7 +351,7 @@ class DiffMarkupTest(unittest.TestCase):
 
     def test_markup_side_by_side_wrapped(self):
         diff = self._init_diff()
-        marker = cdiff.DiffMarker(side_by_side=True, width=5)
+        marker = ydiff.DiffMarker(side_by_side=True, width=5)
         out = list(marker.markup(diff))
         self.assertEqual(len(out), 11)
 
@@ -403,7 +403,7 @@ class DiffMarkupTest(unittest.TestCase):
 
     def test_markup_side_by_side_tabbed(self):
         diff = self._init_diff()
-        marker = cdiff.DiffMarker(side_by_side=True, width=8, tab_width=2)
+        marker = ydiff.DiffMarker(side_by_side=True, width=8, tab_width=2)
         out = list(marker.markup(diff))
         self.assertEqual(len(out), 11)
 
@@ -456,7 +456,7 @@ class DiffMarkupTest(unittest.TestCase):
 
 class UnifiedDiffTest(unittest.TestCase):
 
-    diff = cdiff.UnifiedDiff(None, None, None, None)
+    diff = ydiff.UnifiedDiff(None, None, None, None)
 
     def test_is_hunk_meta_normal(self):
         self.assertTrue(self.diff.is_hunk_meta('@@ -1 +1 @@'))
@@ -518,8 +518,8 @@ spam
 @@ -1,2 +1,2 @@
 """
         items = patch.splitlines(True)
-        stream = cdiff.PatchStream(Sequential(items))
-        parser = cdiff.DiffParser(stream)
+        stream = ydiff.PatchStream(Sequential(items))
+        parser = ydiff.DiffParser(stream)
         self.assertEqual(parser._type, 'unified')
 
     def test_type_detect_context(self):
@@ -533,8 +533,8 @@ spam
   This part of the
 """
         items = patch.splitlines(True)
-        stream = cdiff.PatchStream(Sequential(items))
-        parser = cdiff.DiffParser(stream)
+        stream = ydiff.PatchStream(Sequential(items))
+        parser = ydiff.DiffParser(stream)
         self.assertEqual(parser._type, 'context')
 
     def test_type_detect_neg(self):
@@ -546,8 +546,8 @@ spam
 
 """
         items = patch.splitlines(True)
-        stream = cdiff.PatchStream(Sequential(items))
-        parser = cdiff.DiffParser(stream)
+        stream = ydiff.PatchStream(Sequential(items))
+        parser = ydiff.DiffParser(stream)
         self.assertEqual(parser._type, 'unified')
 
     def test_parse_invalid_hunk_meta(self):
@@ -559,8 +559,8 @@ spam
 @@ -a,a +0 @@
 """
         items = patch.splitlines(True)
-        stream = cdiff.PatchStream(Sequential(items))
-        parser = cdiff.DiffParser(stream)
+        stream = ydiff.PatchStream(Sequential(items))
+        parser = ydiff.DiffParser(stream)
         self.assertRaises(RuntimeError, list, parser.get_diff_generator())
 
     def test_parse_dangling_header(self):
@@ -574,8 +574,8 @@ spam
 spam
 """
         items = patch.splitlines(True)
-        stream = cdiff.PatchStream(Sequential(items))
-        parser = cdiff.DiffParser(stream)
+        stream = ydiff.PatchStream(Sequential(items))
+        parser = ydiff.DiffParser(stream)
 
         out = list(parser.get_diff_generator())
         self.assertEqual(len(out), 2)
@@ -596,8 +596,8 @@ spam
 --- c
 """
         items = patch.splitlines(True)
-        stream = cdiff.PatchStream(Sequential(items))
-        parser = cdiff.DiffParser(stream)
+        stream = ydiff.PatchStream(Sequential(items))
+        parser = ydiff.DiffParser(stream)
         self.assertRaises(AssertionError, list, parser.get_diff_generator())
 
     def test_parse_missing_hunk_meta(self):
@@ -612,8 +612,8 @@ spam
 +++ d
 """
         items = patch.splitlines(True)
-        stream = cdiff.PatchStream(Sequential(items))
-        parser = cdiff.DiffParser(stream)
+        stream = ydiff.PatchStream(Sequential(items))
+        parser = ydiff.DiffParser(stream)
 
         out = list(parser.get_diff_generator())
         self.assertEqual(len(out), 2)
@@ -635,8 +635,8 @@ spam
 @@ -1,2 +1,2 @@
 """
         items = patch.splitlines(True)
-        stream = cdiff.PatchStream(Sequential(items))
-        parser = cdiff.DiffParser(stream)
+        stream = ydiff.PatchStream(Sequential(items))
+        parser = ydiff.DiffParser(stream)
         self.assertRaises(AssertionError, list, parser.get_diff_generator())
 
     def test_parse_only_in_dir(self):
@@ -656,8 +656,8 @@ Only in foo: foo
  common
 """
         items = patch.splitlines(True)
-        stream = cdiff.PatchStream(Sequential(items))
-        parser = cdiff.DiffParser(stream)
+        stream = ydiff.PatchStream(Sequential(items))
+        parser = ydiff.DiffParser(stream)
 
         out = list(parser.get_diff_generator())
         self.assertEqual(len(out), 3)
@@ -677,8 +677,8 @@ Only in foo: foo
 Only in foo: foo
 """
         items = patch.splitlines(True)
-        stream = cdiff.PatchStream(Sequential(items))
-        parser = cdiff.DiffParser(stream)
+        stream = ydiff.PatchStream(Sequential(items))
+        parser = ydiff.DiffParser(stream)
 
         out = list(parser.get_diff_generator())
         self.assertEqual(len(out), 2)
@@ -702,8 +702,8 @@ Binary files a/1.pdf and b/1.pdf differ
  common
 """
         items = patch.splitlines(True)
-        stream = cdiff.PatchStream(Sequential(items))
-        parser = cdiff.DiffParser(stream)
+        stream = ydiff.PatchStream(Sequential(items))
+        parser = ydiff.DiffParser(stream)
 
         out = list(parser.get_diff_generator())
         self.assertEqual(len(out), 3)
@@ -738,8 +738,8 @@ index 529e8a3..ad71921 100755
  common
 """
         items = patch.splitlines(True)
-        stream = cdiff.PatchStream(Sequential(items))
-        parser = cdiff.DiffParser(stream)
+        stream = ydiff.PatchStream(Sequential(items))
+        parser = ydiff.DiffParser(stream)
 
         out = list(parser.get_diff_generator())
         self.assertEqual(len(out), 3)
@@ -764,8 +764,8 @@ Added: svn:keywords
 +Id
 """
         items = patch.splitlines(True)
-        stream = cdiff.PatchStream(Sequential(items))
-        parser = cdiff.DiffParser(stream)
+        stream = ydiff.PatchStream(Sequential(items))
+        parser = ydiff.DiffParser(stream)
         out = list(parser.get_diff_generator())
         self.assertEqual(len(out), 1)
         self.assertEqual(len(out[0]._hunks), 2)
@@ -779,8 +779,8 @@ class MainTest(unittest.TestCase):
 
     def setUp(self):
         self._cwd = os.getcwd()
-        self._ws = tempfile.mkdtemp(prefix='test_cdiff')
-        self._non_ws = tempfile.mkdtemp(prefix='test_cdiff')
+        self._ws = tempfile.mkdtemp(prefix='test_ydiff')
+        self._non_ws = tempfile.mkdtemp(prefix='test_ydiff')
         cmd = ('cd %s; git init; git config user.name me; '
                'git config user.email me@example.org') % self._ws
         subprocess.call(cmd, shell=True, stdout=subprocess.PIPE)
@@ -802,16 +802,16 @@ class MainTest(unittest.TestCase):
         subprocess.call(cmd, stdout=subprocess.PIPE)
 
     def test_preset_options(self):
-        os.environ['CDIFF_OPTIONS'] = '--help'
-        self.assertRaises(SystemExit, cdiff.main)
-        os.environ.pop('CDIFF_OPTIONS', None)
+        os.environ['YDIFF_OPTIONS'] = '--help'
+        self.assertRaises(SystemExit, ydiff.main)
+        os.environ.pop('YDIFF_OPTIONS', None)
 
     def test_read_diff(self):
         sys.argv = sys.argv[:1]
         self._change_file('read_diff')
 
         os.chdir(self._ws)
-        ret = cdiff.main()
+        ret = ydiff.main()
         os.chdir(self._cwd)
         self.assertEqual(ret, 0)
 
@@ -823,21 +823,21 @@ class MainTest(unittest.TestCase):
         self._commit_file()
 
         os.chdir(self._ws)
-        ret = cdiff.main()
+        ret = ydiff.main()
         os.chdir(self._cwd)
         self.assertEqual(ret, 0)
 
     def _test_read_diff_neg(self):
         sys.argv = sys.argv[:1]
         os.chdir(self._non_ws)
-        ret = cdiff.main()
+        ret = ydiff.main()
         os.chdir(self._cwd)
         self.assertNotEqual(ret, 0)
 
     def _test_read_log_neg(self):
         sys.argv = [sys.argv[0], '--log']
         os.chdir(self._non_ws)
-        ret = cdiff.main()
+        ret = ydiff.main()
         os.chdir(self._cwd)
         self.assertNotEqual(ret, 0)
 

cdiff → ydiff

@@ -2,8 +2,8 @@
 # -*- coding: utf-8 -*-
 
 import sys
-import cdiff
+import ydiff
 
-sys.exit(cdiff.main())
+sys.exit(ydiff.main())
 
 # vim:set et sts=4 sw=4 tw=79:

cdiff.py → ydiff.py

@@ -16,11 +16,11 @@ import select
 import difflib
 
 META_INFO = {
-    'version'     : '1.0',
+    'version'     : '1.1',
     'license'     : 'BSD-3',
     'author'      : 'Matthew Wang',
     'email'       : 'mattwyl(@)gmail(.)com',
-    'url'         : 'https://github.com/ymattw/cdiff',
+    'url'         : 'https://github.com/ymattw/ydiff',
     'keywords'    : 'colored incremental side-by-side diff',
     'description' : ('View colored, incremental diff in a workspace or from '
                      'stdin, with side by side and auto pager support')
@@ -372,7 +372,7 @@ class DiffParser(object):
                 break
         else:
             # `filterdiff` translates unknown diff to nothing, fall through to
-            # unified diff give cdiff a chance to show everything as headers
+            # unified diff give ydiff a chance to show everything as headers
             #
             sys.stderr.write("*** unknown format, fall through to 'unified'\n")
             self._type = 'unified'
@@ -712,7 +712,7 @@ def markup_to_pager(stream, opts):
     ended), most likely python bug 12607 (http://bugs.python.org/issue12607)
     which was fixed in python 2.7.3.
 
-    See issue #30 (https://github.com/ymattw/cdiff/issues/30) for more
+    See issue #30 (https://github.com/ymattw/ydiff/issues/30) for more
     information.
     """
     pager_cmd = ['less']
@@ -770,7 +770,7 @@ def decode(line):
         except UnicodeDecodeError:
             pass
 
-    return '*** cdiff: undecodable bytes ***\n'
+    return '*** ydiff: undecodable bytes ***\n'
 
 
 def terminal_size():
@@ -845,14 +845,24 @@ def main():
     option_group = OptionGroup(
         parser, 'Note', ('Option parser will stop on first unknown option '
                          'and pass them down to underneath revision control. '
-                         'Environment variable CDIFF_OPTIONS may be used to '
+                         'Environment variable YDIFF_OPTIONS may be used to '
                          'specify default options that will be placed at the '
                          'beginning of the argument list.'))
     parser.add_option_group(option_group)
 
-    # Place possible options defined in CDIFF_OPTIONS at the beginning of argv
-    cdiff_opts = [x for x in os.getenv('CDIFF_OPTIONS', '').split(' ') if x]
-    opts, args = parser.parse_args(cdiff_opts + sys.argv[1:])
+    # Place possible options defined in YDIFF_OPTIONS at the beginning of argv
+    ydiff_opts = [x for x in os.getenv('YDIFF_OPTIONS', '').split(' ') if x]
+
+    # TODO: Deprecate CDIFF_OPTIONS. Fall back to it and warn (for now).
+    if not ydiff_opts:
+        cdiff_opts = [x for x in os.getenv('CDIFF_OPTIONS', '').split(' ')
+                      if x]
+        if cdiff_opts:
+            sys.stderr.write('*** CDIFF_OPTIONS will be depreated soon, '
+                             'please use YDIFF_OPTIONS instead\n')
+            ydiff_opts = cdiff_opts
+
+    opts, args = parser.parse_args(ydiff_opts + sys.argv[1:])
 
     if opts.log:
         diff_hdl = revision_control_log(args)