Bump version

[catagits/Gitalist.git] / lib / Gitalist.pm

diff --git a/lib/Gitalist.pm b/lib/Gitalist.pm
index 64329fa..01a36ad 100644 (file)
--- a/lib/Gitalist.pm
+++ b/lib/Gitalist.pm
@@ -1,54 +1,27 @@
 package Gitalist;
 use Moose;
-use namespace::autoclean;
-
+BEGIN { require 5.008006; }
 use Catalyst::Runtime 5.80;
+use namespace::autoclean;
 
 extends 'Catalyst';
 
 use Catalyst qw/
                 ConfigLoader
+                Unicode::Encoding
                 Static::Simple
-                StackTrace/;
+                StackTrace
+/;
 
-our $VERSION = '0.01';
-
-# Bring in the libified gitweb.cgi.
-use gitweb;
+our $VERSION = '0.000002';
+$VERSION = eval $VERSION;
 
 __PACKAGE__->config(
     name => 'Gitalist',
     default_view => 'Default',
     default_model => 'GitRepos',
-    # Set to 1 to make your fcgi die the request after you push :)
-    exit_at_end_of_request_if_updated => 0,
 );
 
-{
-    my $version;
-    my $get_version = sub {
-        my $gitdir = shift->path_to('.git');
-        my $version = qx{cat "$gitdir/`cut -d' ' -f2 .git/HEAD`"};
-        chomp $version;
-        return $version;
-    };
-
-    after setup_finalize => sub {
-        my $c = shift;
-        $version = $c->$get_version
-            if $c->config->{exit_at_end_of_request_if_updated};
-    };
-    after handle_request => sub {
-        my $c = shift;
-        if ($version) {
-            my $new = $c->$get_version;
-            exit 0 unless $new eq $version;
-        }
-    };
-}
-
-
-# Start the application
 __PACKAGE__->setup();
 
 around uri_for => sub {
@@ -65,34 +38,40 @@ around uri_for => sub {
   return $uri;
 };
 
+1;
+
+__END__
+
 =head1 NAME
 
-Gitalist - Transitional project to convert gitweb.cgi to a Catalyst app
+Gitalist - A modern git web viewer
 
 =head1 SYNOPSIS
 
-    script/gitalist_server.pl
-
+    script/gitalist_server.pl --repo_dir /home/me/code/git
 
 =head1 INSTALL
 
 As Gitalist follows the usual Perl module format the usual approach
-for installation should work e.g
+for installation should work e.g.
 
   perl Makefile.PL
   make
   make test
   make install
 
-If you're running a git checkout of Gitalist then you'll additionally
-need the author modules. I<NB: As no distribution exists one will
-presently need the author modules>.
+or
+
+  cpan -i Gitalist
+
+You can also check gitalist out from git and run it, in this case you'll additionally
+need the author modules, but no configuration will be needed as it will default to looking
+for repositories the directory above the checkout.
 
 =head1 DESCRIPTION
 
 Gitalist is a web frontend for git repositories based on gitweb.cgi
-and backed by Catalyst. It doesn't yet have the full functionality of
-gitweb.cgi but it does have a few small additions at this stage.
+and backed by Catalyst.
 
 =head2 History
 
@@ -101,6 +80,25 @@ Catalyst app in a piecemeal fashion. As it turns out, thanks largely
 to Florian Ragwitz's earlier effort, it was easier to use gitweb.cgi
 as a template for building a new Catalyst application.
 
+=head1 CONFIGURATION
+
+Gitalist can be supplied with a config file by setting the C<< GITALIST_CONFIG >>
+environment variable to point to a configuration file.
+
+A default configuration is installed along with gitalist, which is complete except
+for a repository directory. You can get a copy of this configuration by running:
+
+  cp `perl -Ilib -MGitalist -e'print Gitalist->path_to("gitalist.conf")'` gitalist.conf
+
+adding a repos_dir path and then setting C<< GITALIST_CONFIG >>.
+
+Alternatively, if you only want to set a repository directory and are otherwise happy with
+the default configuration, then you can set the C<< GITALIST_REPOS_DIR >> environment
+variable, or pass the C<< --repos_dir >> flag to any of the scripts.
+
+The C<< GITALIST_REPOS_DIR >> environment variable will override the repository directory set
+in configuration, and will itself be overridden by he C<< --repos_dir >> flag.
+
 =head1 SEE ALSO
 
 L<Gitalist::Controller::Root>
@@ -128,5 +126,3 @@ L<Catalyst>
 Licensed under GNU GPL v2
 
 =cut
-
-1;