Item9238: Add suport for the git status command.

also Documentation updates. git-svn-id: http://svn.foswiki.org/trunk/RepositoryPlugin@10474 0b4bb1d4-4e5a-0410-9cc4-b2b747904278
foswiki · Jan 4, 2011 · 993af56 · 993af56
1 parent b8ed946
commit 993af56
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 55 deletions.
diff --git a/data/System/RepositoryPlugin.txt b/data/System/RepositoryPlugin.txt
@@ -25,30 +25,37 @@ Repository.  The following information is reported:
 
 | =%<nop>REPO{}%= | Provide a git report on the topic expanding the macro |
 | =%<nop>REPO{module="Foswiki::Module"}%= | Provide a git report on the specified Foswiki module. |
-| =%<nop>REPO{web="Someweb" topic="SomeTopic"}%= | Provide a git report on the specified Web.Topic |
+| =%<nop>REPO{[web="Someweb"] topic="[Someweb.]SomeTopic"}%= | Provide a git report on the specified Web.Topic |
+| =%<nop>REPO{["svninfo" [module=] [topic=]}%= | Provide a =git svn info= report on the repo containing the topic or module |
+| =%<nop>REPO{["status" [module=] [topic=]}%= | Provide a =git status= report on the repo containing the topic or module |
 
 ---++ Examples
 
----+++ Report for this topic
+---+++ Report git status for this topic file =%SYSTEMWEB%/%TOPIC%.txt=
 If installed, the ==%<nop>REPO{}%== macro will expand to the status of this topic file - =%WEB%/%TOPIC%.txt=.
 
 %REPO{}%
 
----+++ =git svn info= report for this topic's repository
+---+++ Report =git svn info= for this topic's repository
 If installed, the ==%<nop>REPO{"svninfo"}%== report will expand to the svn information about the repository that contains this topic.
 
 %REPO{"svninfo"}%
 
----+++ Report for Main.WebHome
-The ==%<nop>REPO{web="Main" topic="WebHome"}%== (or alternate form ==%<nop>REPO{topic="Main.WebHome"}%== ) expands to a report on the specified topic file.
+---+++ Report git status for the topic file =%USERSWEB%.WebHome.txt=
+The ==%<nop>REPO{web="%USERSWEB%" topic="WebHome"}%== (or alternate form ==%<nop>REPO{topic="Main.WebHome"}%== ) expands to a report on the specified topic file.
 
 %REPO{topic="Main.WebHome"}%
 
----+++ Report for =Foswiki::Plugins::RepositoryPlugin=
+---+++ Report git status for =Foswiki::Plugins::RepositoryPlugin=
 The ==%<nop>REPO{module="Foswiki::Plugins::RepositoryPlugin"}%== provides a report on the Plugin module implementing the %REPO macro. Note that an alternative to [[%SYSTEMWEB%.PerlDoc]] - [[%SYSTEMWEB%.RepoPerlDoc]] is provided with this plugin.
 
 %REPO{module="Foswiki::Plugins::RepositoryPlugin"}%
 
+---+++ Report =git status= for the repository contatining =Foswiki::Plugins::RepositoryPlugin=
+The ==%<nop>REPO{"status" module="Foswiki::Plugins::RepositoryPlugin"}%== provides a report on the Plugin module implementing the %REPO macro. Untracked files are not reported.
+
+%REPO{"status" module="Foswiki::Plugins::RepositoryPlugin"}%
+
 ---++ Installation Instructions
 
 %$INSTALL_INSTRUCTIONS%

diff --git a/lib/Foswiki/Plugins/RepositoryPlugin.pm b/lib/Foswiki/Plugins/RepositoryPlugin.pm
@@ -184,37 +184,54 @@ sub _REPO {
 
         return $report;
     }
+    elsif ( $default eq 'status' ) {
+        #my ($curdir) = getcwd =~ m/^(.*)$/;
+        #chdir($repoRoot);
+        ( my $repoInfo, $exit ) =
+          Foswiki::Sandbox->sysCommand( "$gitbin $repoLoc status -uno", );
+        #chdir($curdir);
+        my $report .= " " . '<verbatim>' . $repoInfo . '</verbatim>'
+          unless $exit;
 
-    ( my $topicStatus, $exit ) = Foswiki::Sandbox->sysCommand(
-        "$gitbin $repoLoc status --porcelain  $absfile ",
-    );
+        return $report;
+    }
+    else {
 
-    $topicStatus = substr( $topicStatus, 0, 2 );
+        ( my $fileStatus, $exit ) = Foswiki::Sandbox->sysCommand(
+            "$gitbin $repoLoc status --porcelain  $absfile ",
+        );
 
-    return "*File not known to git:* =$absfile= " if ( $topicStatus eq '??' );
+        $fileStatus = substr( $fileStatus, 0, 2 );
 
-    my $status =
-        $topicStatus =~ m/\ [MD]/  ? 'Modified, not updated in index'
-      : $topicStatus =~ m/M[\ MD]/ ? 'updated in index'
-      : $topicStatus =~ m/A[\ MD]/ ? 'added to index'
-      : $topicStatus =~ m/D[\ M]/  ? 'deleted from index'
-      : $topicStatus =~ m/R[\ MD]/ ? 'renamed in index'
-      : $topicStatus =~ m/C[\ MD]/ ? 'copied in index'
-      : $topicStatus eq '' ? 'up to date'
-      :                      'unknown';
+        return "*File not known to git:* =$absfile= " if ( $fileStatus eq '??' );
 
-    ( my $topicinfo, $exit ) =
-      Foswiki::Sandbox->sysCommand( "$gitbin $repoLoc log -1  $absfile ", );
+        my $status =
+            $fileStatus =~ m/\ [MD]/  ? 'Modified, not updated in index'
+          : $fileStatus =~ m/M[\ MD]/ ? 'updated in index'
+          : $fileStatus =~ m/A[\ MD]/ ? 'added to index'
+          : $fileStatus =~ m/D[\ M]/  ? 'deleted from index'
+          : $fileStatus =~ m/R[\ MD]/ ? 'renamed in index'
+          : $fileStatus =~ m/C[\ MD]/ ? 'copied in index'
+          : $fileStatus eq '' ? 'up to date'
+          :                      'unknown';
 
-    my $report = "*Repo file:* =$absfile= \n\n*Repo root:* $repoRoot\n\n";
+        ( my $topicinfo, $exit ) =
+          Foswiki::Sandbox->sysCommand( "$gitbin $repoLoc log -1  $absfile ", );
 
-    $report .= "*File Status:* ($topicStatus) - $status\n\n";
+        my $report = "*Repo file:* =$absfile= \n\n*Repo root:* $repoRoot\n\n";
 
-    $report .= "*Last Commit:* \n" . '<verbatim>' . $topicinfo . '</verbatim>'
-      unless $exit;
+        $report .= "*File Status:* ($fileStatus) - $status\n\n";
+
+        $report .= "*Last Commit:* \n" . '<verbatim>' . $topicinfo . '</verbatim>'
+          unless $exit;
+
+        return $report;
+    }
 
-    return $report;
 
+###
+### DEAD CODE 
+###
     my ( $gitinfo, $gexit ) =
       Foswiki::Sandbox->sysCommand( "$gitbin $repoLoc svn info ", );
 
@@ -226,34 +243,6 @@ sub _REPO {
     $repoInfo{type} = 'svn'
       unless ( $sexit || $svninfo =~ m/not a working copy/ );
 
- #    if ($repoInfo->{type} eq 'svn') {
- #        $svninfo =~ /Path: (
- #    Path: .
- #    URL: http://svn.twiki.org/svn/twiki/trunk/core
- #    Repository Root: http://svn.twiki.org/svn
- #    Repository UUID: a00a5322-12db-0310-a70b-8735589c885e
- #    Revision: 19150
- #    Node Kind: directory
- #    Schedule: normal
- #    Last Changed Author: PeterThoeny
- #    Last Changed Rev: 19140
- #    Last Changed Date: 2010-06-27 02:42:03 -0400 (Sun, 27 Jun 2010)
- #
- #    gac@cardinal: /data/gac/SVN/twiki/core $ cd -
- #    /data/gac/SVN/twiki
- #    gac@cardinal: /data/gac/SVN/twiki $ cd /var/www/foswiki/trunk/
- #    gac@cardinal: /var/www/foswiki/trunk (Item9238-BuildContrib)$ git svn info
- #    Path: .
- #    URL: http://svn.foswiki.org/trunk
- #    Repository Root: http://svn.foswiki.org
- #    Repository UUID: 0b4bb1d4-4e5a-0410-9cc4-b2b747904278
- #    Revision: 8030
- #    Node Kind: directory
- #    Schedule: normal
- #    Last Changed Author: CrawfordCurrie
- #    Last Changed Rev: 8030
- #    Last Changed Date: 2010-07-05 05:21:49 -0400 (Mon, 05 Jul 2010)
- #
 
     my $cmd = $params->{_DEFAULT} || '';