Moved script to bin/ directory and improved documentation

Author: Marco Campana

README.rdoc

@@ -0,0 +1,48 @@
+== git-notifier
+
+git-notifier is a gem that allows you to watch one or more git repositories and receive a growl notification when a change is committed
+
+== Usage
+
+Usage: git-notifier start|stop|add|clear|status
+
+Start the notifier:
+  git-notifier start
+
+Stop the notifier:
+  git-notifier stop
+
+Add a repository to the watch list:
+  git-notifier add <repo_uri> <branch>
+  Example: git-notifier add git@github.com:marcocampana/git-notifier.git master
+
+Remove all watched repositories from the watch list
+  git-notifier clear
+
+Show all the watched repositories
+  git-notifier status
+
+== Install
+
+From github:
+
+  gem sources -a http://gems.github.com
+  sudo gem install marcocampana-git-notifier
+
+== Warning
+
+To appear
+
+== Author
+
+Marco Campana <m.campana@gmail.com>
+http://xterm.it/blog
+
+== LICENSE:
+
+Released under the same license as Ruby. No Support. No Warranty.
+
+== Copyright
+
+Copyright (c) 2009 Marco Campana. Licensed under the MIT License:
+http://www.opensource.org/licenses/mit-license.php

lib/git-notifier/git-notifier.rb bin/git-notifierlib/git-notifier/git-notifier.rb renamed to bin/git-notifier

@@ -1,35 +1,4 @@
 #!/usr/bin/env ruby
-# == Synopsis
-#   This is a sample description of the application.
-#   Blah blah blah.
-#
-# == Usage
-#   git-notifier start|stop|add|clear|status
-#
-#   Start the notifier:
-#     git-notifier start
-# 
-#   Stop the notifier:
-#     git-notifier stop
-#
-#   Add a repository to the watch list:
-#     git-notifier add <repo_uri> <branch>
-#     Example: git-notifier add git@github.com:marcocampana/git-notifier.git master
-# 
-#   Remove all watched repositories from the watch list
-#     git-notifier clear
-# 
-#   Show all the watched repositories
-#     git-notifier status
-# 
-# == Author
-#   Marco Campana <m.campana@gmail.com>
-#   http://xterm.it/blog
-#
-# == Copyright
-#   Copyright (c) 2009 Marco Campana. Licensed under the MIT License:
-#   http://www.opensource.org/licenses/mit-license.php
-
 # TODO
 # 1) Error handling with notifications
 # 4) check dependencies at startup
@@ -39,13 +8,39 @@
 require 'daemons'
 require 'ruby-growl'
 require 'digest/sha1'
-require 'rdoc/usage'
 
-# TODO remove this
-require 'ruby-debug'
+def usage 
+  usage = <<END
+
+  Usage: 
+  ------
+
+  git-notifier start|stop|add|clear|status
+
+
+  Examples:
+  ---------
+
+  Start the notifier:
+    git-notifier start
+
+  Stop the notifier:
+    git-notifier stop
+
+  Add a repository to the watch list:
+    git-notifier add <repo_uri> <branch>
+    Example: git-notifier add git@github.com:marcocampana/git-notifier.git master
+
+  Remove all watched repositories from the watch list
+    git-notifier clear
+
+  Show all the watched repositories
+    git-notifier status
+END
+end
 
 def add_repo
-  (RDoc::usage('usage') and return) if ARGV.size < 2
+  (puts usage and return) if ARGV.size < 2
   repo_uri        = ARGV[1]
   branch          = ARGV[2] || 'master'
   repo_name       = repo_uri.split("/").last
@@ -89,7 +84,7 @@ def status
 def available_repos
   repos = []
   Dir.new('/var/tmp').each do |repo_dir|
-    repos << repo_dir if repo_dir =~ /^git-notifier/ 
+    repos << repo_dir if repo_dir =~ /^git-notifier_/
   end
   repos
 end
@@ -104,7 +99,7 @@ def clear_all
 end
 
 def demonize
-  Daemons.run_proc('git-notifier', :dir_mode => :normal, :dir => 'pids/', :monitor => false) do
+  Daemons.run_proc('git-notifier', :dir_mode => :normal, :dir => '/var/tmp/', :monitor => false) do
     g = Growl.new "localhost", "ruby-growl", ["git-notifier"]
     # g.notify "git-notifier", "GIT Notifier", "Start watching\nrepo: #{ARGV[0]}\nbranch: #{@@branch}"
     g.notify "git-notifier", "GIT Notifier", "Start notifier"
@@ -113,7 +108,7 @@ def demonize
       # TODO store available_repoes in a variable if adding while running doesn't work
       available_repos.each do |repo_dirname|
         prefix, repo_sha1, repo_name, repo_branch = repo_dirname.split('_')
-        
+
         git_pull_output = `cd /var/tmp/#{repo_dirname}; git checkout -b #{repo_branch} >/dev/null 2>&1; git pull origin #{repo_branch} 2>/dev/null`
 
         if git_pull_output =~ /Updating (.+)\.\.(.+)/
@@ -150,6 +145,6 @@ def demonize
   when 'status'
     status
   else
-    RDoc::usage('usage')
+    puts usage
 end
 

git-notifier.gemspec

@@ -9,13 +9,14 @@ Gem::Specification.new do |s|
   s.date = %q{2009-10-13}
   s.description = %q{ git-notifier is a gem that allows you to watch one or more git repositories and receive a growl notification when a change is committed}
   s.email = %q{m.campana@gmail.com}
-  s.has_rdoc = true
+  s.executables = ["git-notifier"]
   s.homepage = %q{http://github.com/marcocampana/git-notifier}
-  s.rdoc_options = ["--inline-source", "--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  # s.rubyforge_project = %q{git-notifier}
-  # s.rubygems_version = %q{1.3.3}
-  # s.summary = %q{ SUMMARY HERE }
+  # s.has_rdoc = false
+  # s.rdoc_options = ["--inline-source", "--charset=UTF-8"]
+  # s.require_paths = ["lib"]
+  s.rubyforge_project = %q{git-notifier}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{ git-notifier is a gem that allows you to watch one or more git repositories and receive a growl notification when a change is committed }
 
   # if s.respond_to? :specification_version then
   #   current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION