File::Find::Rule::VCS - Exclude files/directories for Version Control Systems

File-Find-Rule-VCS documentation Contained in the File-Find-Rule-VCS distribution.

Index

Code Index:

NAME

Top

File::Find::Rule::VCS - Exclude files/directories for Version Control Systems

SYNOPSIS

Top

  use File::Find::Rule      ();
  use File::Find::Rule::VCS ();

  # Find all files smaller than 10k, ignoring version control files
  my @files = File::Find::Rule->ignore_vcs
                              ->file
                              ->size('<10Ki')
                              ->in( $dir );

DESCRIPTION

Top

Many tools need to be equally useful both on ordinary files, and on code that has been checked out from revision control systems.

File::Find::Rule::VCS provides quick and convenient methods to exclude the version control directories of several major Version Control Systems (currently CVS, subversion, and Bazaar).

File::Find::Rule::VCS implements methods to ignore the following:

CVS
Subversion
Bazaar

In addition, the following version control systems do not create directories in the checkout and do not require the use of any ignore methods

SVK
Git

METHODS

Top

ignore_vcs

  # Ignore all common version control systems
  $find->ignore_vcs;

  # Ignore a specific named version control systems
  $find->ignore_vcs($name);

  # Ignore nothing (silent pass-through)
  $find->ignore_vcs('');

The ignore_vcs method excludes the files for a named Version Control System from your File::Find::Rule search.

If passed, the name of the version control system is case in-sensitive. Names currently supported are 'cvs', 'svn', 'subversion', 'bzr', and 'bazaar'.

As a convenience for high-level APIs, if the VCS name is the defined null string '' then the call will be treated as a nullop.

If no params at all are passed, this method will ignore all supported version control systems. If ignoring every version control system, please note that any legitimate directories called "CVS" or files starting with .# will be ignored, which is not always desirable.

In widely-distributed code, you instead should try to detect the specific version control system used and call ignore_vcs with the specific name.

Passing undef, or an unsupported name, will throw an exception.

ignore_cvs

The ignore_cvs method excluding all CVS directories from your File::Find::Rule search.

It will also exclude all the files left around by CVS after an automated merge that start with '.#' (dot-hash).

ignore_rcs

The ignore_rcs method excluding all RCS directories from your File::Find::Rule search.

It will also exclude all the files used by RCS to store the revisions (end with ',v').

ignore_svn

The ignore_svn method excluding all Subversion (.svn) directories from your File::Find::Rule search.

ignore_bzr

The ignore_bzr method excluding all Bazaar (.bzr) directories from your File::Find::Rule search.

ignore_git

The ignore_git method excluding all Git (.git) directories from your File::Find::Rule search.

ignore_hg

The ignore_hg method excluding all Mercurial/Hg (.hg) directories from your File::Find::Rule search.

TO DO

Top

- Add support for other version control systems.

- Add other useful VCS-related methods

SUPPORT

Top

Bugs should always be submitted via the CPAN bug tracker

http://rt.cpan.org/NoAuth/ReportBug.html?Queue=File-Find-Rule-VCS

For other issues, contact the maintainer

AUTHOR

Top

Adam Kennedy <adamk@cpan.org>

SEE ALSO

Top

http://ali.as/, File::Find::Rule

COPYRIGHT

Top

Copyright 2005 - 2010 Adam Kennedy.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.

File-Find-Rule-VCS documentation Contained in the File-Find-Rule-VCS distribution. 
package File::Find::Rule::VCS;


use 5.00503;
use strict;
use Carp                  ();
use Text::Glob       0.08 ();
use File::Find::Rule 0.20 ();

use vars qw{$VERSION @ISA @EXPORT};
BEGIN {
	$VERSION = '1.08';
	@ISA     = 'File::Find::Rule';
	@EXPORT  = @File::Find::Rule::EXPORT;
}

use constant FFR => 'File::Find::Rule';

# In some Windows SVN implementations, it uses _svn instead of
# .svn, so use both on Win32.
my @svn = ($^O eq 'MSWin32') ? ('.svn', '_svn') : ('.svn');





#####################################################################
# File::Find::Rule Method Addition


sub File::Find::Rule::ignore_vcs {
	my $find = $_[0]->_force_object;

	# Handle special cases
	if( 1 == scalar( @_ ) ) {
		# Logically combine all the ignores. This will be much
		# faster than just calling them all one after the other.
		return $find->or(
			FFR->name(@svn, '.bzr', '.git', '.hg', 'CVS', 'RCS')
			    ->directory->prune->discard,
			FFR->name(qr/^\.\#/, qr/,v$/)->file->discard,
			FFR->new,
			);
	}
	unless ( defined $_[1] ) {
		Carp::croak("->ignore_vcs: No version control system name provided");
	}

        # As a convenience for higher-level APIs
        # we treat a defined null string as a nullop
	my $vcs = lc $_[1];
        return $find if $vcs eq '';

	# Hand off to the rules for each VCS
	return $find->ignore_cvs if $vcs eq 'cvs';
	return $find->ignore_rcs if $vcs eq 'rcs';
	return $find->ignore_svn if $vcs eq 'svn';
	return $find->ignore_svn if $vcs eq 'subversion';
	return $find->ignore_bzr if $vcs eq 'bzr';
	return $find->ignore_bzr if $vcs eq 'bazaar';
	return $find->ignore_git if $vcs eq 'git';
	return $find->ignore_hg  if $vcs eq 'hg';
	return $find->ignore_hg  if $vcs eq 'mercurial';
	Carp::croak("->ignore_vcs: '$vcs' is not supported");
}


sub File::Find::Rule::ignore_cvs {
	my $find = $_[0]->_force_object;
	return $find->or(
		FFR->name('CVS')->directory->prune->discard,
		FFR->name(qr/^\.\#/)->file->discard,
		FFR->new,
		);
}


sub File::Find::Rule::ignore_rcs {
	my $find = $_[0]->_force_object;
	return $find->or(
		FFR->name('RCS')->directory->prune->discard,
		FFR->name(qr/,v$/)->file->discard,
		FFR->new,
		);
}


sub File::Find::Rule::ignore_svn {
	my $find = $_[0]->_force_object;
	return $find->or(
		FFR->name(@svn)->directory->prune->discard,
		FFR->new,
		);
}


sub File::Find::Rule::ignore_bzr {
	my $find = $_[0]->_force_object;
	return $find->or(
		FFR->name('.bzr')->directory->prune->discard,
		FFR->new,
		);
}


sub File::Find::Rule::ignore_git {
	my $find = $_[0]->_force_object;
	return $find->or(
		FFR->name('.git')->directory->prune->discard,
		FFR->new,
		);
}


sub File::Find::Rule::ignore_hg {
	my $find = $_[0]->_force_object;
	return $find->or(
		FFR->name('.hg')->directory->prune->discard,
		FFR->new,
		);
}

1;