technomancy-conspire 0.0.1 → 0.1.0

data/README.rdoc

@@ -28,17 +28,28 @@ conspire from there on the files with which you wish to collaborate.
 
 See lib/conspire/support to see which editors are supported. In Emacs,
 install conspire.el and then visit the file you want to edit and
-pressing M-x conspire-mode, though this is still very rough and should
-be done in its own Emacs instance.
+pressing M-x conspire-mode.
 
 Repository history is cleared in between conspiracy sessions.
 
-== Troubleshooting
+For testing purposes, you can run two or more conspiracies on the same
+machine; you just have to specify an alternate port and name for the
+others. Names should always include the string "conspiracy" to
+distinguish them from other gitjour repositories.
 
-When using Avahi for your ZeroConf implementation, you will not be
-able to do anything unless you have an active network connection. So
-disconnected conspirancy sessions are not possible without bringing up
-an ad-hoc network to trick Avahi into activating.
+  $ conspire repo -p 7457 -n conspiracy2
+
+Set the DEBUG environment variable to get more information on the console.
+
+== Bugs
+
+* Conflict resolution remains entirely unhandled.
+
+* When using Avahi for your ZeroConf implementation, you will not be
+  able to do anything unless you have an active network connection. So
+  disconnected conspirancy sessions are not possible without bringing
+  up an ad-hoc network to trick Avahi into activating. You'll also see
+  a big fat warning, which should be ignored.
 
 == Editor Support
 
@@ -46,11 +57,12 @@ Editors must support:
 
 * Saving on an interval
 * Committing files to the repo
-* Refreshing internal copies
+* Refreshing internal buffers
 
 Edits should not be allowed in between these steps.
 
-Editors may be able to support launching the +conspire+ executable.
+Editors may be able to support launching the +conspire+ executable for
+added convenience.
 
 That's about all there is to it. If your favourite editor is not
 supported, please fork and add support for it; it's really not a

data/lib/conspire/conspirator.rb

@@ -7,22 +7,21 @@ module Conspire
     end
 
     def sync(path)
-      if ENV['DEBUG']
-        puts "cd #{path} && git pull --rebase #{url}"
-        system "cd #{path} && git pull --rebase #{url}" or
-          raise "Could not rebase from #{url}"
-      else
-        system "cd #{path} && git pull --rebase #{url} > /dev/null" or
-          raise "Could not rebase from #{url}"
-      end
+      # TODO: figure out conflictless rebasing... evan?
+      success = if ENV['DEBUG']
+                  puts "cd #{path} && git pull --rebase #{url}"
+                  system "cd #{path} && git pull --rebase #{url}"
+                else
+                  system "cd #{path} && git pull --rebase #{url} &> /dev/null"
+                end
 
-      @last_synced = Time.now
+      raise "could not rebase from #{url}" if ! success
+      # @last_synced = Time.now # is this useful?
     end
 
     def url; "git://#{@host}:#{@port}/" end
 
     alias_method :to_s, :url
-    alias_method :inspect, :url
 
     # For set equality
     def eql?(other); self.url == other.url end

data/lib/conspire/gitjour_exts.rb

@@ -5,7 +5,7 @@ module Gitjour
 
       def init(path)
         abort "Repository already exists: #{path}" if File.exist? path + '/.git'
-        at_exit { FileUtils.rm_rf path + '/.git' }
+        at_exit { FileUtils.rm_rf path + '/.git' } unless ENV['KEEP']
         `mkdir -p #{path} && cd #{path} && git init`
         `touch #{path}/.git/git-daemon-export-ok`
       end

data/lib/conspire/support/conspire.el

@@ -3,8 +3,8 @@
 ;; Copyright (C) 2008 Phil Hagelberg
 
 ;; Author: Phil Hagelberg <technomancy@gmail.com>
-;; URL: http://www.emacswiki.org/cgi-bin/wiki/Conspire
-;; Version: 0.1
+;; URL: http://conspire.rubyforge.org
+;; Version: 0.2
 ;; Created: 2008-07-22
 ;; Keywords: collaboration
 
@@ -39,11 +39,8 @@
 
 ;;; TODO:
 
-;; In its current state, it's very dangerous to start a conspire
-;; session and then switch buffers, since the timer is not yet buffer
-;; local. Watch out!
-
 ;; Automatically launch conspire executable.
+;; Color lines based on which conspirator wrote them?
 
 ;;; Code:
 
@@ -53,20 +50,26 @@
 (defvar conspire-timer nil
   "A timer to activate conspire synchronizing.")
 
+(make-variable-buffer-local 'conspire-mode)
+
 ;;;###autoload
 (defun conspire-mode ()
   "Activate conspire-mode for real-time collaborative editing."
   (interactive)
-  (set (make-local-variable 'conspire-timer)
-       (run-with-idle-timer conspire-interval
-                            :repeat 'conspire-sync-buffer)))
+  (setq conspire-mode t)
+  (setq conspire-timer
+       (run-with-idle-timer conspire-interval :repeat 'conspire-sync-buffer)))
+                            
 
 (defun conspire-sync-buffer ()
   "Synchronize buffer with Conspire repository."
-  (when (buffer-modified-p)
-    (save-buffer)
-    (shell-command (format "git add %s && git commit -m \"conspire\""
-                           buffer-file-name)))
-  (revert-buffer nil t))
+  (when conspire-mode
+    (when (buffer-modified-p)
+      (save-buffer)
+      (shell-command (format "git add %s && git commit -m \"conspire\""
+                             buffer-file-name)))
+    (revert-buffer nil t)
+    ;; revert resets local variables; heh
+    (setq conspire-mode t)))
 
 ;;; conspire.el ends here

data/lib/conspire.rb

@@ -9,7 +9,7 @@ require 'conspire/gitjour_exts'
 require 'conspire/conspirator'
 
 module Conspire
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
   DEFAULTS = { :port => 7456, :name => 'conspiracy', :sync_interval => 0.5 }
   HOSTNAME = `hostname`.chomp
 
@@ -21,7 +21,6 @@ module Conspire
   def start(path, options)
     @options = options
     @path = path
-    puts "Starting with #{@options.inspect}" if ENV['DEBUG']
     Gitjour::Application.init @path
     @thread = Thread.new do
       Gitjour::Application.serve(@path, @options.name, @options.port)
@@ -58,9 +57,7 @@ module Conspire
   def discover_loop
     loop do
       Conspire.discover
-      p Conspire.conspirators if ENV['DEBUG']
+      puts Conspire.conspirators.map{ |c| c.to_s } if ENV['DEBUG']
     end
   end
-
-  def conspirators; @conspirators end
 end

data/test/test_conspire.rb

@@ -9,12 +9,16 @@ require File.dirname(__FILE__) + '/../lib/conspire'
 
 REMOTE_SPACE = File.dirname(__FILE__) + '/remote-space'
 LOCAL_SPACE = File.dirname(__FILE__) + '/local-space'
+FileUtils.rm_rf(REMOTE_SPACE)
+FileUtils.rm_rf(LOCAL_SPACE)
 
 module Conspire
   def self.reset!
     @conspirators = []
     @thread && @thread.kill
   end
+
+  def self.conspirators; @conspirators end
 end
 
 class TestConspire < Test::Unit::TestCase
@@ -27,15 +31,21 @@ class TestConspire < Test::Unit::TestCase
       Gitjour::Application.serve(REMOTE_SPACE, 'conspiracy-remote-test', 7458)
     end
 
-    Conspire.start(LOCAL_SPACE, OpenStruct.new(:port => 7457))
+    Conspire.start(LOCAL_SPACE, OpenStruct.new(:port => 7457,
+                                               :name => 'conspiracy',
+                                               :sync_interval => 0.5))
   end
 
   def teardown
     @remote_thread.kill
     `killall git-daemon` # workaround until gitjour handles this correctly
     Conspire.reset!
-    FileUtils.rm_rf(REMOTE_SPACE)
-    FileUtils.rm_rf(LOCAL_SPACE)
+    FileUtils.rm_rf(REMOTE_SPACE) unless ENV['KEEP']
+    FileUtils.rm_rf(LOCAL_SPACE) unless ENV['KEEP']
+  end
+
+  def test_start
+    assert File.exist?(LOCAL_SPACE + '/.git')
   end
 
   def test_discover
@@ -44,14 +54,13 @@ class TestConspire < Test::Unit::TestCase
   end
 
   def test_sync
+    # getting random unreproducible failings here
     Conspire.conspirators << Conspire::Conspirator.new('localhost.', '7458')
     Conspire.sync_all
     assert_equal ["#{LOCAL_SPACE}/file"], Dir.glob("#{LOCAL_SPACE}/*")
   end
 
   def test_conspirator_set
-    Conspire.conspirators << Conspire::Conspirator.new('dynabook.', '7458')
-    Conspire.conspirators << Conspire::Conspirator.new('dynabook.', '7458')
     Conspire.conspirators << Conspire::Conspirator.new('dynabook.', '7458')
     Conspire.conspirators << Conspire::Conspirator.new('dynabook.', '7458')
     assert_equal 1, Conspire.conspirators.size

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: technomancy-conspire
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Phil Hagelberg