technomancy-conspire 0.1.0 → 0.1.2

data/History.txt

@@ -1,6 +1,14 @@
-=== 0.0.1 / 2008-07-22
+=== 0.1.1 / 2008-07-25
 
-* 1 major enhancement
+* Fixed a bug where empty repositories would not sync.
+* Lower sync intervals by default.
+* Emacs support works on a per-buffer basis.
 
-  * Birthday!
+=== 0.1.0 / 2008-07-24
+
+* Nearly usable! Sorta-works!
+
+=== 0.0.1 / 2008-07-23
+
+* Birthday!
 

data/Manifest.txt

@@ -4,6 +4,7 @@ Manifest.txt
 README.rdoc
 Rakefile
 bin/conspire
+conspire.gemspec
 lib/conspire.rb
 lib/conspire/conspirator.rb
 lib/conspire/gitjour_exts.rb

data/README.rdoc

@@ -1,6 +1,7 @@
 = conspire
-  by Phil Hagelberg (C) 2008
-  http://conspire.rubyforge.org
+
+(c) 2008 Phil Hagelberg
+http://github.com/technomancy/conspire
 
 Conspire is a real-time collaborative editing platform using Git as a
 transport layer.
@@ -21,17 +22,18 @@ Once prerequisites are met:
 == Usage
 
 Conspiracy sessions operate around repositories rather than single
-files like other collaborative editors. So launch +conspire+ with a
-directory as its first argument to have it initialize a repository in
-that directory. From there you should open up your editor and invoke
-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.
+files like other collaborative editors. See lib/conspire/support to
+see which editors are supported. In Emacs, first install conspire.el,
+then visit the file you want to edit and invoke M-x conspire-mode.
 
 Repository history is cleared in between conspiracy sessions.
 
+You can manually use conspire if you want to try it out without an
+editor. Just launch +conspire+ with a directory as its only argument,
+and it will initialize a new git repository in there and launch a
+conspiracy session. You will have to manually "git add" new files you
+want to introduce to the session.
+
 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
@@ -45,13 +47,19 @@ Set the DEBUG environment variable to get more information on the console.
 
 * Conflict resolution remains entirely unhandled.
 
+* Emacs is the only supported editor; see below.
+
 * 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
+== Contributing
+
+Patches are welcome via github or email. Adding support for more
+editors would probably be the most useful contributions, though
+anything is appreciated.
 
 Editors must support:
 
@@ -59,11 +67,6 @@ Editors must support:
 * Committing files to the repo
 * Refreshing internal buffers
 
-Edits should not be allowed in between these steps.
-
-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
-difficult task.
+Edits should not be allowed in between these steps. Editors may be
+able to support launching the +conspire+ executable for added
+convenience.

data/Rakefile

@@ -7,17 +7,13 @@ require './lib/conspire.rb'
 Hoe.new('conspire', Conspire::VERSION) do |p|
   p.developer('Phil Hagelberg', 'technomancy@gmail.com')
 
+  # TODO: tell flog about README.rdoc instead of README.txt
   p.summary = 'Conspire is a real-time collaborative editing platform using Git as a transport layer.'
-  p.url = 'http://conspire.rubyforge.org'
+  p.url = 'http://github.com/technomancy/conspire'
 
+  # TODO: release on rubyforge once all our required dependency versions make it to rubyforge
   p.extra_deps << ['technomancy-gitjour', '6.3.0']
-  p.extra_deps << 'clip'
-end
-
-desc "Code statistics"
-task :stats do
-  require 'code_statistics'
-  CodeStatistics.new(['lib'], ['Unit tests', 'test']).to_s
+  p.extra_deps << 'alexvollmer-clip'
 end
 
 # vim: syntax=Ruby

data/bin/conspire

@@ -9,6 +9,17 @@ options = Clip do |c|
              :default => Conspire::DEFAULTS[:sync_interval])
   c.optional('n', 'name', :desc => "Session name; must include 'conspiracy'",
              :default => Conspire::DEFAULTS[:name])
+  c.flag('v', 'version', :desc => 'Print version number and exit')
+end
+
+# TODO: show usage message on --help
+if !options.valid?
+  puts "Conspire is a git-based collaboration platform."
+  puts "  You generally interact use it via an editor; see README for details."
+  abort options.to_s
+elsif options.version?
+  puts "conspire #{Conspire::VERSION}"
+  exit 0
 end
 
 Conspire.start ARGV.first, options

data/conspire.gemspec

@@ -0,0 +1,40 @@
+Gem::Specification.new do |s|
+  s.name = %q{conspire}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Phil Hagelberg"]
+  s.date = %q{2008-08-12}
+  s.default_executable = %q{conspire}
+  s.email = ["technomancy@gmail.com"]
+  s.executables = ["conspire"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt"]
+  s.files = ["COPYING", "History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "bin/conspire", "conspire.gemspec", "lib/conspire.rb", "lib/conspire/conspirator.rb", "lib/conspire/gitjour_exts.rb", "lib/conspire/support/conspire.el", "test/perf.rb", "test/test_conspire.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/technomancy/conspire}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{conspire}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{Conspire is a real-time collaborative editing platform using Git as a transport layer.}
+  s.test_files = ["test/test_conspire.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<technomancy-gitjour>, ["= 6.3.0"])
+      s.add_runtime_dependency(%q<alexvollmer-clip>, [">= 0"])
+      s.add_development_dependency(%q<hoe>, [">= 1.7.0"])
+    else
+      s.add_dependency(%q<technomancy-gitjour>, ["= 6.3.0"])
+      s.add_dependency(%q<alexvollmer-clip>, [">= 0"])
+      s.add_dependency(%q<hoe>, [">= 1.7.0"])
+    end
+  else
+    s.add_dependency(%q<technomancy-gitjour>, ["= 6.3.0"])
+    s.add_dependency(%q<alexvollmer-clip>, [">= 0"])
+    s.add_dependency(%q<hoe>, [">= 1.7.0"])
+  end
+end

data/lib/conspire.rb

@@ -1,17 +1,17 @@
-$LOAD_PATH << File.dirname(__FILE__)
 require 'set'
 require 'fileutils'
 
 require 'rubygems'
 require 'gitjour' # TODO: can we get rid of the avahi compatibility warning?
 
-require 'conspire/gitjour_exts'
-require 'conspire/conspirator'
+require File.dirname(__FILE__) + '/conspire/gitjour_exts'
+require File.dirname(__FILE__) + '/conspire/conspirator'
 
 module Conspire
-  VERSION = '0.1.0'
-  DEFAULTS = { :port => 7456, :name => 'conspiracy', :sync_interval => 0.5 }
-  HOSTNAME = `hostname`.chomp
+  VERSION = '0.1.2'
+  # TODO: play with optimal intervals; perhaps auto-adjust based on latency?
+  DEFAULTS = { :port => 7456, :name => 'conspiracy', :sync_interval => 0.25 }
+  HOSTNAME = `hostname`.chomp # TODO: is there a better way?
 
   @conspirators = Set.new
 
@@ -19,9 +19,10 @@ module Conspire
 
   # Begin a conspiracy session
   def start(path, options)
-    @options = options
-    @path = path
+    @path, @options = path, options
+
     Gitjour::Application.init @path
+
     @thread = Thread.new do
       Gitjour::Application.serve(@path, @options.name, @options.port)
     end
@@ -39,6 +40,7 @@ module Conspire
     end
   end
 
+  # Sync with all conspirators, dropping the problematic ones
   def sync_all
     @conspirators.map do |c|
       begin
@@ -55,9 +57,6 @@ module Conspire
   end
 
   def discover_loop
-    loop do
-      Conspire.discover
-      puts Conspire.conspirators.map{ |c| c.to_s } if ENV['DEBUG']
-    end
+    loop { discover and (p @conspirators if ENV['DEBUG']) }
   end
 end

data/lib/conspire/conspirator.rb

@@ -1,27 +1,25 @@
 module Conspire
   class Conspirator
-    attr_accessor :last_synced, :host, :port, :name
+    attr_accessor :host, :port, :name
 
-    def initialize(host, port, name = DEFAULTS[:name])
-      @host, @port, @name = host[0 .. -2], port || DEFAULTS[:port], name
+    def initialize(host, port, name)
+      # host has a trailing dot; remove it
+      @host, @port, @name = host[0 .. -2], port, name
     end
 
     def sync(path)
-      # 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
-
-      raise "could not rebase from #{url}" if ! success
-      # @last_synced = Time.now # is this useful?
+      # TODO: figure out conflictless rebasing; new content always wins. evan?
+      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 or raise "could not rebase from #{url}" if ! success
     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,9 +5,12 @@ module Gitjour
 
       def init(path)
         abort "Repository already exists: #{path}" if File.exist? 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`
+        FileUtils.touch ["#{path}/.git/git-daemon-export-ok", "#{path}/.conspire"]
+        `cd #{path}; git add .conspire; git commit -m "initial"`
+
+        at_exit { FileUtils.rm_rf [path + '/.git', path + '/.conspire'] } unless ENV['KEEP']
       end
 
       def puts(*args); end unless ENV['DEBUG']

data/lib/conspire/support/conspire.el

@@ -3,7 +3,7 @@
 ;; Copyright (C) 2008 Phil Hagelberg
 
 ;; Author: Phil Hagelberg <technomancy@gmail.com>
-;; URL: http://conspire.rubyforge.org
+;; URL: http://github.com/technomancy/conspire
 ;; Version: 0.2
 ;; Created: 2008-07-22
 ;; Keywords: collaboration
@@ -37,30 +37,22 @@
 ;;
 ;;   (autoload 'conspire-mode "conspire" "Collaborative editing" t)
 
-;;; TODO:
-
-;; Automatically launch conspire executable.
-;; Color lines based on which conspirator wrote them?
+;; TODO: For some reason conspire-sync-buffer only runs on cursor movement
+;; TODO: Gracefully kill shell process so it can clean up
+;; TODO: Don't bother with *Async Shell Command* output buffer
+;; TODO: Color lines based on which conspirator wrote them?
 
 ;;; Code:
 
-(defvar conspire-interval 0.33
+(defcustom conspire-interval 0.25
   "Number of seconds to wait before syncing with conspire.")
 
+(defcustom conspire-arguments ""
+  "Arguments to pass the `conspire' executable, like port, name, etc.")
+
 (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)
-  (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 conspire-mode
@@ -68,8 +60,27 @@
       (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)))
+    (revert-buffer nil t) ;; revert resets local variables; heh
+    (cancel-timer conspire-timer)
+    (conspire-mode t)))
+
+;;;###autoload
+(define-minor-mode conspire-mode
+  "Toggle conspire-mode for real-time collaborative editing.
+
+If the current buffer isn't part of a conspiracy session, a new
+session will be started."
+  :lighter "-conspire"
+  (unless (file-exists-p (concat (file-name-directory buffer-file-name)
+                                 ".conspire"))
+    (save-window-excursion
+      (shell-command (format "conspire %s %s >& /dev/null &"
+                             (file-name-directory buffer-file-name)
+                             conspire-arguments))))
+  (setq conspire-timer
+        (or conspire-timer
+            (run-with-idle-timer conspire-interval :repeat
+                                 'conspire-sync-buffer))))
 
+(provide 'conspire)
 ;;; conspire.el ends here

data/test/test_conspire.rb

@@ -25,12 +25,12 @@ class TestConspire < Test::Unit::TestCase
   def setup
     Gitjour::Application.init(REMOTE_SPACE)
     File.open(REMOTE_SPACE + '/file', 'w') { |f| f.puts "hello world." }
-    `cd #{REMOTE_SPACE}; git add file; git commit -m "init"`
+    `cd #{REMOTE_SPACE}; git add file; git commit -m "conspire"`
 
     @remote_thread = Thread.new do
       Gitjour::Application.serve(REMOTE_SPACE, 'conspiracy-remote-test', 7458)
     end
-
+    @remote = Conspire::Conspirator.new('localhost.', '7458', 'conspiracy')
     Conspire.start(LOCAL_SPACE, OpenStruct.new(:port => 7457,
                                                :name => 'conspiracy',
                                                :sync_interval => 0.5))
@@ -55,14 +55,25 @@ class TestConspire < Test::Unit::TestCase
 
   def test_sync
     # getting random unreproducible failings here
-    Conspire.conspirators << Conspire::Conspirator.new('localhost.', '7458')
+    Conspire.conspirators << @remote
     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', 'conspiracy')
+    Conspire.conspirators << Conspire::Conspirator.new('dynabook.', '7458', 'conspiracy')
     assert_equal 1, Conspire.conspirators.size
   end
+
+  def test_conflicts
+    @remote.sync(LOCAL_SPACE)
+    assert File.exist?(LOCAL_SPACE + '/file'), "Sync did not pull in file"
+    assert_equal 'hello world.\n', File.read(LOCAL_SPACE + '/file')
+
+    File.open("#{LOCAL_SPACE}/file", 'w') { |f| f.puts "hello conspirators!" }
+    `cd #{LOCAL_SPACE}; git add file; git commit -m "conspire"`
+    @remote.sync(LOCAL_SPACE)
+    assert_equal 'hello conspirators!\n', File.read(LOCAL_SPACE + '/file')
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: technomancy-conspire
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors: 
 - Phil Hagelberg
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-24 00:00:00 -07:00
+date: 2008-08-12 00:00:00 -07:00
 default_executable: conspire
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
         version: 6.3.0
     version: 
 - !ruby/object:Gem::Dependency 
-  name: clip
+  name: alexvollmer-clip
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -56,6 +56,7 @@ files:
 - README.rdoc
 - Rakefile
 - bin/conspire
+- conspire.gemspec
 - lib/conspire.rb
 - lib/conspire/conspirator.rb
 - lib/conspire/gitjour_exts.rb
@@ -63,7 +64,7 @@ files:
 - test/perf.rb
 - test/test_conspire.rb
 has_rdoc: true
-homepage: http://conspire.rubyforge.org
+homepage: http://github.com/technomancy/conspire
 post_install_message: 
 rdoc_options: 
 - --main