gitjour 6.4.0 → 6.5.0

data/History.txt

@@ -1,3 +1,8 @@
+== 6.5.0 2009-03-17
+
+* Added web command to launch and announce instaweb
+* Added browse command to see all available instawebs
+
 == 6.4.0 2009-03-13
 
 * Add pull command

data/Manifest.txt

@@ -1,8 +1,9 @@
 History.txt
 Manifest.txt
-README.txt
+README.rdoc
 Rakefile
 bin/gitjour
 lib/gitjour.rb
+lib/gitjour/browser.rb
 test/test_gitjour.rb
 test/test_helper.rb

data/{README.txt → README.rdoc}

@@ -4,18 +4,28 @@
 
 == DESCRIPTION:
 
-Automates zeroconf-powered serving and cloning of git repositories.
+Automates ZeroConf-powered serving and cloning of git repositories.
 
 == SYNOPSIS:
 
+=== THE BASICS
+
+To serve a project, identified via ZeroConf:
+
   % gitjour serve [project_dir] [name_to_advertise_as]
   Registered phil-gitjour on port 9418. Starting service.
 
+To find advertised git projects:
+
   % gitjour list
   Gathering for up to 5 seconds...
   === phil-gitjour on pdp10.local.:9418 ===
     gitjour (clone|pull) phil-gitjour
 
+=== CLONING & PULLING
+
+To clone an advertised git repo:
+
   % gitjour clone phil-gitjour
   Gathering for up to 5 seconds...
   Connecting to pdp10.local.:9418
@@ -23,6 +33,9 @@ Automates zeroconf-powered serving and cloning of git repositories.
   [...]
   Resolving deltas: 100% (342/342), done.
 
+
+To pull from an advertised git repo:
+
   % gitjour pull phil-gitjour
   Gathering for up to 5 seconds...
   Connecting to pdp10.local.:9418
@@ -32,8 +45,24 @@ Automates zeroconf-powered serving and cloning of git repositories.
   [...]
   4 files changed, 35 insertions(+), 80 deletions(-)
 
+=== BROWSING GIT REPOS WITH YOUR BROWSER
+
+To serve up your repo via 'git instaweb':
+
+  % gitjour web phil-gitjour
+  [2009-03-17 19:27:20] INFO  WEBrick 1.3.1
+  [2009-03-17 19:27:20] INFO  ruby 1.8.6 (2008-03-03) [universal-darwin9.0]
+  # Starts git-instaweb in webrick, publishes ZeroConf DNS record
+
+To see all advertised git repos in your browser:
+
+  % gitjour browse
+  # Starts a small web-app to find all
+
+
 == REQUIREMENTS:
 
+* git
 * dnssd, which requires development headers to bonjour or avahi
   See dnssd documentation for details.
 

data/Rakefile

@@ -10,6 +10,8 @@ Hoe.new('gitjour', Gitjour::VERSION) do |p|
   p.developer('Evan Phoenix', 'evan@fallingsnow.net')
   p.developer('Rich Kilmer', 'rich@example.com')
   p.developer('Phil Hagelberg', 'technomancy@gmail.com')
+
+  p.readme_file = 'README.rdoc'
 end
 
 # vim: syntax=Ruby

data/lib/gitjour.rb

@@ -5,7 +5,7 @@ require 'set'
 Thread.abort_on_exception = true
 
 module Gitjour
-  VERSION = "6.4.0"
+  VERSION = "6.5.0"
   GitService = Struct.new(:name, :host, :port, :description)
 
   class Application
@@ -23,6 +23,10 @@ module Gitjour
           serve(*args)
         when "remote"
           remote(*args)
+        when "web"
+          web(*args)
+        when "browse"
+          browse(*args)
         else
           help
         end
@@ -30,6 +34,18 @@ module Gitjour
 
       private
 
+      def service_name(name)
+        # If the name starts with ^, then don't apply the prefix
+        if name[0] == ?^
+          name = name[1..-1]
+        else
+          prefix = `git config --get gitjour.prefix`.chomp
+          prefix = ENV["USER"] if prefix.empty?
+          name   = [prefix, name].compact.join("-")
+        end
+        name
+      end
+
       def list
         service_list.each do |service|
           puts "=== #{service.name} on #{service.host}:#{service.port} ==="
@@ -74,25 +90,16 @@ module Gitjour
 
       def serve(path=Dir.pwd, *rest)
         path = File.expand_path(path)
-        name = rest.shift || File.basename(path)
+        name = service_name(rest.shift || File.basename(path))
         port = rest.shift || 9418
 
-        # If the name starts with ^, then don't apply the prefix
-        if name[0] == ?^
-          name = name[1..-1]
-        else
-          prefix = `git config --get gitjour.prefix`.chomp
-          prefix = ENV["USER"] if prefix.empty?
-          name   = [prefix, name].compact.join("-")
-        end
-
         if File.exists?("#{path}/.git")
-          announce_repo(path, name, port.to_i)
+          announce_git(path, name, port.to_i)
         else
           Dir["#{path}/*"].each do |dir|
             if File.directory?(dir)
               name = File.basename(dir)
-              announce_repo(dir, name, 9418)
+              announce_git(dir, name, 9418)
             end
           end
         end
@@ -100,6 +107,26 @@ module Gitjour
         `git daemon --verbose --export-all --port=#{port} --base-path=#{path} --base-path-relaxed`
       end
 
+      def web(path=Dir.pwd, *rest)
+        path = File.expand_path(path)
+        name = service_name(rest.shift || File.basename(path))
+        port = rest.shift || 1234
+        httpd = rest.shift || "webrick"
+
+        system("git instaweb --httpd=#{httpd} --port=#{port}") or
+          abort "Unable to launch git instaweb."
+
+        announce_web(path, name, port.to_i)
+
+        trap("INT") do
+          puts "Stopping instaweb..."
+          system "git instaweb stop"
+          exit
+        end
+
+        Thread.stop
+      end
+
       def help
         puts "Gitjour #{Gitjour::VERSION}"
         puts "Serve up and use git repositories via ZeroConf."
@@ -127,6 +154,19 @@ module Gitjour
         puts "      Add a ZeroConf remote into your current repository."
         puts "      Optionally pass name to not use pwd."
         puts
+        puts "  web <path_to_project> [<name_of_project>] [<port>] [<httpd_daemon>]"
+        puts "      Serve up the current directory via git instaweb for browsers."
+        puts "      The default port is 1234 and the httpd_daemon is defaulted to"
+        puts "      webrick. Other options are 'lighttpd' and 'apache2' (See the"
+        puts "      git-instaweb man page for more details)"
+        puts
+        puts "  browse [<port>] [<browser>]"
+        puts "      Browse git repositories published with the 'web' command (see"
+        puts "      above). This command takes two optional arguments: the first"
+        puts "      is the port for the local web server (default 9850), the second"
+        puts "      is the path to your web browser (see man git-web--browse for"
+        puts "      details)."
+        puts
       end
 
       class Done < RuntimeError; end
@@ -173,16 +213,30 @@ module Gitjour
         return list
       end
 
-      def announce_repo(path, name, port)
+      def browse(*args)
+        require "gitjour/browser"
+        Browser.new(*args).start
+      end
+
+      def announce_repo(path, name, port, type)
         return unless File.exists?("#{path}/.git")
 
         tr = DNSSD::TextRecord.new
         tr['description'] = File.read("#{path}/.git/description") rescue "a git project"
+        tr['gitjour'] = 'true' # distinguish instaweb from other HTTP servers
 
-        DNSSD.register(name, "_git._tcp", 'local', port, tr.encode) do |rr|
+        DNSSD.register(name, type, 'local', port, tr.encode) do |rr|
           puts "Registered #{name} on port #{port}. Starting service."
         end
       end
+
+      def announce_git(path, name, port)
+        announce_repo(path, name, port, "_git._tcp")
+      end
+
+      def announce_web(path, name, port)
+        announce_repo(path, name, port, "_http._tcp")
+      end
     end
   end
 end

data/lib/gitjour/browser.rb

@@ -0,0 +1,111 @@
+require "webrick"
+require "erb"
+require "set"
+require "thread"
+
+module Gitjour
+  class Browser
+
+    def initialize(*args)
+      @port = args.shift || 9850
+      @browser = args.shift
+      @services = Set.new
+      @mutex = Mutex.new
+    end
+
+    def start
+      DNSSD.browse("_http._tcp") do |reply|
+        begin
+          DNSSD.resolve reply.name, reply.type, reply.domain do |resolve_reply|
+            next unless resolve_reply.text_record['gitjour']
+            service = GitService.new(reply.name,
+                                     resolve_reply.target,
+                                     resolve_reply.port,
+                                     resolve_reply.text_record['description'].to_s)
+
+            @mutex.synchronize do
+              if @services.member? service
+                @services.delete service
+              else
+                @services << service
+              end
+            end
+          end
+        rescue ArgumentError # usually a jacked DNS text record
+        end
+      end
+
+      http = WEBrick::HTTPServer.new(:Port => @port.to_i)
+      http.mount_proc("/") { |req, res| index(req, res) }
+      http.mount_proc("/style.css") { |req, res| stylesheet(req, res) }
+      trap("INT") { http.shutdown }
+      t = Thread.new { http.start }
+
+      url = "http://localhost:#{@port}"
+      if @browser
+        `git web--browse -b '#{@browser}' http://localhost:9850`
+      else
+        `git web--browse -c "instaweb.browser" http://localhost:9850`
+      end
+      t.join
+    end
+
+    def index(req, res)
+      res['Content-Type'] = 'text/html'
+      res.body = index_html.result(binding)
+    end
+
+    def index_html
+      @index_html ||= ERB.new(<<-HTML)
+        <html>
+          <body>
+            <head>
+              <link rel="stylesheet" href="/style.css" type="text/css" media="screen"/>
+              <title>Browseable Git Repositories</title>
+            </head>
+            <h1>Browseable Git Repositories</h1>
+            <ul>
+            <% @mutex.synchronize do %>
+              <% @services.map do |s| %>
+                <li>
+                  <a href='http://<%= s.host %>:<%= s.port %>' target="_new">
+                    <%= s.name %>
+                  </a>
+                  <%= s.description unless s.description =~ /^Unnamed repository/ %>
+                </li>
+              <% end %>
+            <% end %>
+            </ul>
+          </body>
+        </html>
+      HTML
+    end
+
+    def stylesheet(req, res)
+      res['Content-Type'] = 'text/css'
+      res.body = css
+    end
+
+    def css
+      @css ||= <<-CSS
+        body {
+          font-family: sans-serif;
+          font-size: 12px;
+          background-color: #fff;
+        }
+
+        h1 {
+          font-size: 20px;
+          font-weight: bold;
+        }
+
+        ul {
+          border: 1px dashed #999;
+          padding: 10 10 10 20;
+          background-color: #ccc;
+        }
+      CSS
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gitjour
 version: !ruby/object:Gem::Version 
-  version: 6.4.0
+  version: 6.5.0
 platform: ruby
 authors: 
 - Chad Fowler
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-16 00:00:00 -07:00
+date: 2009-03-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,7 +35,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.9.0
     version: 
-description: Automates zeroconf-powered serving and cloning of git repositories.
+description: Automates ZeroConf-powered serving and cloning of git repositories.
 email: 
 - chad@chadfowler.com
 - evan@fallingsnow.net
@@ -48,14 +48,14 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - Manifest.txt
-- README.txt
 files: 
 - History.txt
 - Manifest.txt
-- README.txt
+- README.rdoc
 - Rakefile
 - bin/gitjour
 - lib/gitjour.rb
+- lib/gitjour/browser.rb
 - test/test_gitjour.rb
 - test/test_helper.rb
 has_rdoc: true
@@ -65,7 +65,7 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --main
-- README.txt
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -83,10 +83,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: gitjour
-rubygems_version: 1.3.1.2403
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 3
-summary: Automates zeroconf-powered serving and cloning of git repositories.
+summary: Automates ZeroConf-powered serving and cloning of git repositories.
 test_files: 
-- test/test_helper.rb
 - test/test_gitjour.rb
+- test/test_helper.rb