lib/App/Rgit.pm

   1 package App::Rgit;
   2
   3 use strict;
   4 use warnings;
   5
   6 use Object::Tiny qw/config command/;
   7
   8 use App::Rgit::Command;
   9 use App::Rgit::Config;
  10 use App::Rgit::Utils qw/validate/;
  11
  12 =head1 NAME
  13
  14 App::Rgit - Backend that supports the rgit utility.
  15
  16 =head1 VERSION
  17
  18 Version 0.02
  19
  20 =cut
  21
  22 our $VERSION = '0.02';
  23
  24 =head1 DESCRIPTION
  25
  26 Backend that supports the L<rgit> utility.
  27
  28 This is an internal class to L<rgit>.
  29
  30 =head1 METHODS
  31
  32 =head2 C<< new root => $root, git => $git, cmd => $cmd, args => \@args >>
  33
  34 Creates a new L<App::Rgit> object that's bound to execute the command C<$cmd> on all the C<git> repositories inside C<$root> with C<@args> as arguments and C<$git> as C<git> executable.
  35
  36 =cut
  37
  38 sub new {
  39  my ($class, %args) = &validate;
  40  my $config = App::Rgit::Config->new(
  41   root => $args{root},
  42   git  => $args{git},
  43  );
  44  return unless defined $config;
  45  my $command = App::Rgit::Command->new(
  46   cmd  => $args{cmd},
  47   args => $args{args},
  48  );
  49  return unless defined $command;
  50  $class->SUPER::new(
  51   config  => $config,
  52   command => $command,
  53  );
  54 }
  55
  56 =head2 C<run>
  57
  58 Actually run the commands.
  59
  60 =cut
  61
  62 sub run {
  63  my $self = shift;
  64  $self->command->run($self->config);
  65 }
  66
  67 =head2 C<config>
  68
  69 =head2 C<command>
  70
  71 Accessors.
  72
  73 =head1 SEE ALSO
  74
  75 L<rgit>.
  76
  77 =head1 AUTHOR
  78
  79 Vincent Pit, C<< <perl at profvince.com> >>, L<http://profvince.com>.
  80
  81 You can contact me by mail or on C<irc.perl.org> (vincent).
  82
  83 =head1 BUGS
  84
  85 Please report any bugs or feature requests to C<bug-rgit at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=rgit>.  I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
  86
  87 =head1 SUPPORT
  88
  89 You can find documentation for this module with the perldoc command.
  90
  91     perldoc App::Rgit
  92
  93 =head1 COPYRIGHT & LICENSE
  94
  95 Copyright 2008 Vincent Pit, all rights reserved.
  96
  97 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
  98
  99 =cut
 100
 101 1; # End of App::Rgit