inplace 1.2.2

data/lib/inplace/version.rb

@@ -0,0 +1 @@
+require File.expand_path('../../inplace', __FILE__)

data/man/inplace.1

@@ -0,0 +1,254 @@
+.\" $Idaemons: /home/cvs/inplace/inplace.1,v 1.8 2004/04/21 13:25:51 knu Exp $
+.\" $Id$
+.\"
+.Dd April 7, 2004
+.Dt INPLACE 1
+.Os FreeBSD
+.Sh NAME
+.Nm inplace
+.Nd edits files in-place through given filter commands
+.Sh SYNOPSIS
+.Nm
+.Op Fl DLfinstvz
+.Op Fl b Ar suffix
+.Fl e Ar commandline
+.Op Oo Fl e Ar commandline Oc ...
+.Op Ar file ...
+.Nm
+.Op Fl DLfinstvz
+.Op Fl b Ar suffix
+.Ar commandline
+.Op Ar file ...
+.Sh DESCRIPTION
+The
+.Nm
+command is a utility to edit files in-place through given filter
+commands preserving the original file attributes.  Mode and ownership
+(user and group) are preserved by default, and time (access and
+modification) by choice.
+.Pp
+Inode numbers will change by default, but there is a
+.Fl i
+option with which given the inode number of each edited file will be
+preserved.
+.Pp
+As for filter commands, a single command may be specified as the first
+argument to
+.Nm .
+To pass many filter commands, specify each followed by the
+.Fl e
+option.
+.Pp
+There are some cases where
+.Nm
+does not replace a file, such as when:
+.Bl -enum -offset indent
+.It
+The original file is not writable (use
+.Fl f
+to force editing against read-only files)
+.It
+A filter command fails and exits with a non-zero return code
+.It
+The resulted output is identical to the original file
+.It
+The resulted output is empty (use
+.Fl z
+to accept empty output)
+.El 
+.Pp
+.Sh OPTIONS
+The following command line arguments are supported:
+.Pp
+.Bl -tag -width "--preserve-timestamp" -compact
+.It Fl h
+.It Fl -help
+Show help and exit.
+.Pp
+.It Fl D
+.It Fl -debug
+Turn on debug output.
+.Pp
+.It Fl L
+.It Fl -dereference
+By default,
+.Nm
+ignores non-regular files including symlinks, but this switch makes it
+resolve (dereference) each symlink using realpath(3) and edit the
+original file.
+.Pp
+.It Fl b Ar SUFFIX
+.It Fl -backup-suffix Ar SUFFIX
+Create a backup file with the given suffix for each file.  Note that
+backup files will be written over existing files, if any.
+.Pp
+.It Fl e Ar COMMANDLINE
+.It Fl -execute Ar COMMANDLINE
+Specify a filter command line to run for each file in which the following placeholders can be used:
+.Bl -tag -offset indent -nested
+.It Cm %0
+replaced by the original file path, shell escaped with
+.Pf \e 's
+as necessary
+.It Cm %1
+replaced by the source file path, shell escaped with
+.Pf \e 's
+as necessary
+.It Cm %2
+replaced by the destination file path, shell escaped with
+.Pf \e 's
+as necessary
+.It Cm %%
+replaced by
+.Ql %
+.El
+.Pp
+Omission of %2 indicates %1 should be modified destructively, and
+omission of both %1 and %2 implies
+.Dq Li "(...) < %1 > %2"
+around the command line.
+.Pp
+When the filter command is run, the destination file is always an
+empty temporary file, and the source file is either the original file
+or a temporary copy file.
+.Pp
+Every temporary file has the same suffix as the original file, so that
+file name aware programs can play nicely with it.
+.Pp
+Instead of specifying a whole command line, you can use a command
+alias defined in a configuration file,
+.Pa ~/.inplace .
+See the FILES section for the file format.
+.Pp
+This option can be specified many times, and they will be executed in
+sequence.  A file is only replaced if all of them succeeds.
+.Pp
+See the EXAMPLES section below for details.
+.Pp
+.It Fl f
+.It Fl -force
+By default,
+.Nm
+does not perform editing if a file is not writable.  This switch makes
+it force editing even if a file to process is read-only.
+.Pp
+.It Fl i
+.It Fl -preserve-inode
+Make sure to preserve the inode number of each file.
+.Pp
+.It Fl n
+.It Fl -dry-run
+Do not perform any destructive operation and just show what would have
+been done.  This switch implies
+.Fl v .
+.Pp
+.It Fl s
+.It Fl -same-directory
+Create a temporary file in the same directory as each replaced file.
+This may speed up the performance when the directory in question is on
+a partition that is fast enough and the system temporary directory is
+slow.
+.Pp
+This switch can be effectively used when the temporary directory does
+not have sufficient disk space for a resulted file.
+.Pp
+If this option is specified, edited files will have newly assigned
+inode numbers.  To prevent this, use the
+.Fl i
+option.
+.Pp
+.It Fl t
+.It Fl -preserve-timestamp
+Preserve the access and modification times of each file.
+.Pp
+.It Fl v
+.It Fl -verbose
+Turn on verbose mode.
+.Pp
+.It Fl z
+.It Fl -accept-empty
+By default,
+.Nm
+does not replace the original file when a resulted file is empty in
+size because it is likely that there is a mistake in the filter
+command.  This switch makes it accept empty (zero-sized) output and
+replace the original file with it.
+.El
+.Sh EXAMPLES
+.Bl -bullet
+.It
+Sort files in-place using
+.Xr sort 1 :
+.Pp
+.Dl inplace sort file1 file2 file3
+.Pp
+Below works the same as above, passing each input file via the command
+line argument:
+.Pp
+.Dl inplace 'sort %1 > %2' file1 file2 file3
+.Pp
+.It
+Perform in-place charset conversion and newline code conversion:
+.Pp
+.Dl inplace -e 'iconv -f EUC-JP -t UTF-8' -e 'perl -pe \&"s/$/\e\er/\&"' file1 file2 file3
+.Pp
+.It
+Process image files taking backup files:
+.Pp
+.Dl inplace -b.orig 'convert -rotate 270 -resize 50%% %1 %2' *.jpg
+.Pp
+.It
+Perform a mass MP3 tag modification without changing timestamps:
+.Pp
+.Dl find mp3/Some_Artist -name '*.mp3' -print0 | xargs -0 inplace -te 'mp3info -a \&"Some Artist\&" -g \&"Progressive Rock\&" %1'
+.Pp
+As you see above,
+.Nm
+makes a nice combo with
+.Xr find 1
+and
+.Xr xargs 1 .
+.Pp
+.El
+.Sh FILES
+.Bl -tag -width "~/.inplace"
+.It Pa ~/.inplace
+The configuration file, which syntax is described as follows:
+.Bl -bullet
+.It
+Each alias definition is a name/value pair separated with an
+.Dq = ,
+one per line.
+.It
+White spaces at the beginning or the end of a line, and around
+assignment separators
+.Pf ( Dq = )
+are stripped off.
+.It
+Lines starting with a
+.Dq #
+are ignored.
+.El
+.El
+.Sh ENVIRONMENT
+.Bl -tag -width "TMPDIR" -compact
+.It Ev TMPDIR
+.It Ev TMP
+.It Ev TEMP
+Temporary directory candidates where
+.Nm
+attempts to create intermediate output files, in that order.  If none
+is available and writable,
+.Pa /tmp
+is used.  If
+.Fl s
+is specified, they will not be used.
+.El
+.Sh SEE ALSO
+.Xr find 1 ,
+.Xr xargs 1 ,
+.Xr realpath 3
+.Sh AUTHORS
+.An Akinori MUSHA Aq knu@iDaemons.org
+.Sh BUGS
+There may always be some bugs.  Use at your own risk.

data/test/test.sh

@@ -0,0 +1,292 @@
+#!/bin/sh
+#
+# $Id$
+
+flunk () {
+    echo "$0: $@" >&2
+    exit 1
+}
+
+srcdir="$(cd "$(dirname "$0")"/.. && pwd)" || exit 1
+testdir=$srcdir/test/t
+ruby=${RUBY:-$(which ruby)}
+
+while getopts d opt; do
+    case "$opt" in
+	d)
+	    debug=1
+	    ;;
+    esac
+done
+
+shift $(($OPTIND - 1))
+
+initialize () {
+    mkdir -p $testdir || flunk "mkdir failed"
+    cd $testdir || flunk "cd failed"
+    [ $(ls | wc -l) -eq 0 ] || rm -i *
+}
+
+setup () {
+    (echo aaa; echo bbb; echo ccc) > abc.txt
+    (echo AAA; echo BBB; echo CCC) > _ABC_.txt
+    (echo aaa; echo bbb; echo bbb) > abb.txt
+    (echo AAA; echo BBB; echo BBB) > _ABB_.txt
+    (echo ccc; echo bbb; echo aaa) > cba.txt
+    (echo CCC; echo BBB; echo AAA) > _CBA_.txt
+    (echo a b c) > "a b c.txt"
+    (echo c b a) > "c b a.txt"
+
+    ln -s _ABC_.txt _ABC_l.txt
+    ln -s _ABC_l.txt _ABC_ll.txt
+
+    for f in *.txt; do
+	cp -p "$f" "$f.orig"
+    done
+
+    sleep 1
+}
+
+teardown () {
+    rm *.txt*
+}
+
+debug () {
+    if [ "$debug" = 1 ]; then
+        echo "debug: $@" >&2
+    fi
+}
+
+terminate () {
+    cd $srcdir
+    rm -rf $testdir
+}
+
+inplace_flags=
+
+inplace () {
+    local file i1 i2 has_i
+    has_i=0
+
+    file="$($ruby -e 'puts ARGV.last' -- "$@")"
+    i1="$(inode_of "$file")"
+    $srcdir/lib/inplace.rb $inplace_flags "$@" >/dev/null 2>&1
+    i2="$(inode_of "$file")"
+
+    if echo " $inplace_flags" | fgrep -qe " -i"; then
+        has_i=1
+    fi
+
+    if [ $has_i = 1 -a "$i1" != "$i2" ]; then
+        echo "inode changed!" >&2
+    fi
+}
+
+inode_of () {
+    expr "$(ls -i "$@")" : '\([0-9]*\)'
+}
+
+cmp_file () {
+    if cmp -s "$1" "$2"; then
+        debug "$1 == $2"
+        return 0
+    else
+        debug "$1 != $2"
+        return 1
+    fi
+}
+
+cmp_time () {
+    # Since Ruby's File.stat() does not obtain nanosec for the moment,
+    # inplace(1) cannot preserve nanosec values and test(1)'s strict
+    # nanosec-wise check does not pass..
+    #test ! "$1" -nt "$2" -a ! "$2" -nt "$1"
+
+    if $ruby -e 'File.mtime(ARGV[0]) == File.mtime(ARGV[1]) or exit 1' "$1" "$2"; then
+        debug "mtime($1) == mtime($2)"
+        return 0
+    else
+        debug "mtime($1) != mtime($2)"
+        return 1
+    fi
+}
+
+test1 () {
+    # simple feature test 1 - no argument
+    inplace 'sort -r' _CBA_.txt
+    test -e _CBA_.txt.bak && return 1
+    cmp_file _CBA_.txt _CBA_.txt.orig || return 1
+    cmp_time _CBA_.txt _CBA_.txt.orig || return 1
+
+    inplace 'sort -r' abc.txt
+    cmp_file abc.txt cba.txt.orig || return 1
+    cmp_time abc.txt abc.txt.orig && return 1
+
+    inplace 'tr a-z A-Z' abb.txt
+    cmp_file abb.txt _ABB_.txt.orig || return 1
+    cmp_time abb.txt abb.txt.orig && return 1
+
+    inplace 'rev' 'a b c.txt'
+    cmp_file 'a b c.txt' 'c b a.txt.orig' || return 1
+    cmp_time 'a b c.txt' 'a b c.txt.orig' && return 1
+
+    inplace -e 'sort -r' -e 'tr A-Z a-z' _ABC_.txt
+    cmp_file _ABC_.txt cba.txt.orig || return 1
+    cmp_time _ABC_.txt cba.txt.orig && return 1
+
+    inplace -t 'sort' cba.txt
+    cmp_file cba.txt abc.txt.orig || return 1
+    cmp_time cba.txt cba.txt.orig || return 1
+
+    return 0
+}
+
+test2 () {
+    # simple feature test 2 - 2 arguments
+    inplace 'sort -r %1 > %2' _CBA_.txt
+    test -e _CBA_.txt.bak && return 1
+    cmp_file _CBA_.txt _CBA_.txt.orig || return 1
+    cmp_time _CBA_.txt _CBA_.txt.orig || return 1
+
+    inplace 'sort -r %1 > %2' abc.txt
+    cmp_file abc.txt cba.txt.orig || return 1
+    cmp_time abc.txt abc.txt.orig && return 1
+
+    inplace 'tr a-z A-Z < %1 > %2' abb.txt
+    cmp_file abb.txt _ABB_.txt.orig || return 1
+    cmp_time abb.txt abb.txt.orig && return 1
+
+    inplace 'rev %1 > %2' 'a b c.txt'
+    cmp_file 'a b c.txt' 'c b a.txt.orig' || return 1
+    cmp_time 'a b c.txt' 'a b c.txt.orig' && return 1
+
+    inplace -e 'sort -r %1 > %2' -e 'tr A-Z a-z' _ABC_.txt
+    cmp_file _ABC_.txt cba.txt.orig || return 1
+    cmp_time _ABC_.txt cba.txt.orig && return 1
+
+    inplace -t 'sort %1 > %2' cba.txt
+    cmp_file cba.txt abc.txt.orig || return 1
+    cmp_time cba.txt cba.txt.orig || return 1
+
+    return 0
+}
+
+test3 () {
+    # simple feature test 3 - 1 argument
+    inplace "$ruby -i -pe '\$_.upcase!' %1" _CBA_.txt
+    test -e _CBA_.txt.bak && return 1
+    cmp_file _CBA_.txt _CBA_.txt.orig || return 1
+    cmp_time _CBA_.txt _CBA_.txt.orig || return 1
+
+    inplace "$ruby -i -pe '\$_.upcase!' %1" abb.txt
+    cmp_file abb.txt _ABB_.txt.orig || return 1
+    cmp_time abb.txt abb.txt.orig && return 1
+
+    inplace "$ruby -i -pe '\$_.chomp!; \$_ = \$_.reverse + \"\\n\"' %1" 'a b c.txt'
+    cmp_file 'a b c.txt' 'c b a.txt' || return 1
+    cmp_time 'a b c.txt' 'a b c.txt.orig' && return 1
+
+    inplace -e "$ruby -i -pe '\$_.tr!(\"a\", \"A\")' %1" -e "$ruby -i -pe '\$_.tr!(\"bc\", \"BC\")' %1" abc.txt
+    cmp_file abc.txt _ABC_.txt.orig || return 1
+    cmp_time abc.txt _ABC_.txt.orig && return 1
+
+    return 0
+}
+
+test4 () {
+    # backup test
+    inplace -b.bak 'sort -r' abc.txt
+    cmp_file abc.txt cba.txt.orig || return 1
+    cmp_file abc.txt.bak abc.txt.orig || return 1
+    cmp_time abc.txt abc.txt.orig && return 1
+    cmp_time abc.txt.bak abc.txt.orig || return 1
+
+    inplace -b.bak -t 'sort' cba.txt
+    cmp_file cba.txt abc.txt.orig || return 1
+    cmp_file cba.txt.bak cba.txt.orig || return 1
+    cmp_time cba.txt cba.txt.orig || return 1
+    cmp_time cba.txt.bak cba.txt.orig || return 1
+
+    return 0
+}
+
+test5 () {
+    # error test
+    inplace -b.bak 'sort -r; exit 1' abc.txt
+    test -e abc.txt.bak && return 1
+    cmp_file abc.txt abc.txt.orig || return 1
+    cmp_time abc.txt abc.txt.orig || return 1
+
+    inplace -b.bak -e 'sort' -e 'exit 1' -e 'tr a-z A-Z' cba.txt
+    test -e cba.txt.bak && return 1
+    cmp_file cba.txt cba.txt.orig || return 1
+    cmp_time cba.txt cba.txt.orig || return 1
+}
+
+test6 () {
+    # zero-sized output test
+    inplace -b.bak 'cat /dev/null' abb.txt
+    test -e abb.txt.bak && return 1
+    cmp_file abb.txt abb.txt.orig || return 1
+    cmp_time abb.txt abb.txt.orig || return 1
+
+    inplace -z -b.bak 'cat /dev/null' abb.txt
+    test -s abb.txt && return 1
+    cmp_file abb.txt.bak abb.txt.orig || return 1
+    cmp_time abb.txt.bak abb.txt.orig || return 1
+
+    return 0
+}
+
+test7 () {
+    # symlink test
+    inplace -b.bak 'sort -r' _ABC_ll.txt
+    test -e _ABC_ll.txt.bak && return 1
+    test -e _ABC_l.txt.bak && return 1
+    test -e _ABC_.txt.bak && return 1
+    cmp_file _ABC_.txt _ABC_.txt.orig || return 1
+    cmp_time _ABC_.txt _ABC_.txt.orig || return 1
+
+    inplace -L -b.bak 'sort -r' _ABC_ll.txt
+    test -e _ABC_ll.txt.bak && return 1
+    test -e _ABC_l.txt.bak && return 1
+    test -e _ABC_.txt.bak || return 1
+    cmp_file _ABC_.txt _CBA_.txt.orig || return 1
+    cmp_file _ABC_.txt.bak _ABC_.txt.orig || return 1
+
+    return 0
+}
+
+main () {
+    initialize
+
+    n=7
+    error=0
+
+    for inplace_flags in '' '-s' '-i' '-i -s'; do
+        for i in $(jot $n 1 $n); do
+	    if [ X"$inplace_flags" != X"" ]; then
+                printf "%s with %s..." "test$i" "$inplace_flags"
+            else
+	        printf "%s..." "test$i"
+            fi
+
+	    setup
+
+	    if eval test$i; then
+	        echo "ok"
+	    else
+	        echo "failed!"
+                error=1
+	    fi
+
+	    teardown
+        done
+    done
+
+    terminate
+
+    return $error
+}
+
+main