Mange-git-remote-monitor 0.1.1 → 0.1.2

data/lib/git_remote_monitor/notifiers/base.rb

@@ -0,0 +1,38 @@
+# The MIT License
+# Copyright © 2009 Magnus Bergmark
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+
+class GitRemoteMonitor::Notifiers::Base
+  class << self
+    def available?
+      raise NoMethodError, "available? has not been implemented in #{self.class} yet!"
+    end
+  end
+  
+  def initialize
+    raise NoMethodError, "initialize has not been implemented in #{self.class} yet!"
+  end
+  
+  def send_notification!(status)
+    raise NoMethodError, "send_notification! has not been implemented in #{self.class} yet!"
+  end
+  
+end

data/lib/git_remote_monitor/notifiers/meow.rb

@@ -0,0 +1,72 @@
+# The MIT License
+# Copyright © 2009 Magnus Bergmark
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+class GitRemoteMonitor::Notifiers::Meow < GitRemoteMonitor::Notifiers::Base
+  class << self
+    def available?
+      # Try to load the meow gem
+      require 'meow'
+      return true
+    rescue LoadError
+      return false
+    end
+  end
+  
+  def initialize
+    @meow = ::Meow.new('git-remote-monitor')
+  end
+  
+  def send_notification!(status)
+    message = get_message(status)
+    if message
+      @meow.notify(notification_title(status), message, :icon => notification_icon(status), :note_type => notification_type(status))
+    end
+  end
+  
+  protected
+    def notification_title(status)
+      "#{status.name} (#{status.branch_name})"
+    end
+    
+    def notification_icon(status)
+      # TODO: Different icons for each status type
+      "#{GitRemoteMonitor.root}/images/git-logo.png"
+    end
+    
+    def notification_type(status)
+      status.type.to_s.capitalize
+    end
+    
+    def get_message(status)
+      case status.type
+        when :local
+          # Don't bother notify on local changes only
+          nil
+        when :diverged
+          "Diverged! Remote has #{status.remote_commits} new commit(s), and you have #{status.local_commits} commit(s) to push."
+        when :remote
+          "Remote got updated! Now #{status.remote_commits} commit(s) in front of you."
+        else
+          raise "Unknown case. This is a bug! Please report it with the stack trace. Thank you."
+      end
+    end
+  
+end

data/lib/git_remote_monitor/status.rb

@@ -0,0 +1,58 @@
+# The MIT License
+# Copyright © 2009 Magnus Bergmark
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+#
+# Helps notifiers to build their messages by hinding the logic used to get certain information,
+# either from the repository and/or from the monitor itself. It will get constructed by Notifier and
+# sent to the approriate notifier plugin.
+#
+class GitRemoteMonitor::Status
+  
+  attr_reader :local_commits, :remote_commits, :branch_name
+  
+  def initialize(monitor, branch_name, local_commits, remote_commits)
+    @monitor        = monitor
+    @local_commits  = local_commits
+    @remote_commits = remote_commits
+    @branch_name    = branch_name
+  end
+  
+  # Returns either <tt>:local</tt>, <tt>:remote</tt> or <tt>:diverged</tt> depending
+  # on where the commits occured
+  def type
+    if remote_commits == 0
+      :local
+    elsif local_commits == 0
+      :remote
+    else
+      :diverged
+    end
+  end
+  
+  def directory
+    @monitor.directory
+  end
+  
+  def name
+    @monitor.name
+  end
+  
+end

data/spec/git_remote_monitor/git_wrapper_spec.rb

@@ -19,7 +19,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require File.dirname(__FILE__) + '/../../lib/git_remote_monitor'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe GitRemoteMonitor::GitWrapper do
   
@@ -27,8 +27,96 @@ describe GitRemoteMonitor::GitWrapper do
     # Shortcut :-D
     @wrapper = GitRemoteMonitor::GitWrapper
   end
-
+  
+  describe "system calls" do
+    
+    describe "to fetch" do
+      it "should raise error if git gets an error" do
+        lambda {
+          $?.stub!(:success? => false)
+          @wrapper.stub!(:`)
+          @wrapper.send(:call_fetch)
+        }.should raise_error
+      end
+      
+      it "should return output" do
+        $?.stub!(:success? => true)
+        @wrapper.should_receive(:`).with(/git fetch/).and_return("Downloading stuff...")
+        @wrapper.send(:call_fetch).should == "Downloading stuff..."
+      end
+    end
+    
+    it "should call git branch correctly" do
+      @wrapper.should_receive(:`).with(/git branch/).and_return("Output")
+      @wrapper.send(:call_get_local_branch).should == "Output"
+    end
+    
+    it "should call remote listing correctly" do
+      @wrapper.should_receive(:`).with(/git branch -r/).and_return("output")
+      @wrapper.send(:call_remotes_list).should == "output"
+    end
+    
+    it "should call command to discover git repo correctly and return exit status" do
+      # We test a "impossible" value here as a shortcut. If the method returns this, we know the status is returned unchanged
+      status = mock("Exit status")
+      $?.stub!(:success? => status)
+      
+      @wrapper.should_receive(:`).with(/git show-ref/).and_return("")
+      
+      @wrapper.send(:call_repo_discovery).should == status
+    end
+    
+    it "should call git config correctly to get remote branch" do
+      @wrapper.should_receive(:`).with(/git config branch\.foobar\.remote/).and_return("Output")
+      @wrapper.send(:call_get_remote, "foobar").should == "Output"
+    end
+    
+    it "should call git rev-list correctly to get tracking information" do
+      # This is a complex one... :-(
+      # Hard to test this without a copy-paste
+      @wrapper.should_receive(:`).
+          with("git rev-list --left-right foo...bar | cut -c 1 | sort | uniq -c").
+          and_return("Output")
+      @wrapper.send(:call_get_tracking_info, "foo", "bar").should == "Output"
+    end
+    
+  end
+  
+  describe "discovering remote branches" do
+    it "should return number of remotes when some are defined" do
+      @wrapper.should_receive(:call_remotes_list).and_return("  origin/master\n  friend/cool-branch\n")
+      @wrapper.has_remotes?.should == 2
+    end
+    
+    it "should return nil when no remotes are defined" do
+      @wrapper.should_receive(:call_remotes_list).and_return("\n")
+      @wrapper.has_remotes?.should be_nil
+    end
+  end
+  
+  describe "discovering git repo" do
+    it "should return true if inside repository" do
+      @wrapper.stub!(:call_repo_discovery => true)
+      @wrapper.in_repo?.should be_true
+    end
+    it "should return false if outside repository" do
+      @wrapper.stub!(:call_repo_discovery => false)
+      @wrapper.in_repo?.should be_false
+    end
+  end
+  
   describe "fetch" do
+    before(:each) do
+      @wrapper.stub!(:has_remotes? => 1, :call_fetch => "")
+    end
+    
+    it "should raise error if no remote repositories are defined" do
+      @wrapper.should_receive(:has_remotes?).and_return(nil)
+      lambda {
+        @wrapper.fetch!
+      }.should raise_error(/no remote/)
+    end
+    
     it "should know if a fetch didn't occur" do
       @wrapper.should_receive(:call_fetch).and_return "\n"
       @wrapper.fetch!.should == false
@@ -55,7 +143,7 @@ describe GitRemoteMonitor::GitWrapper do
   describe "branch discovery" do
     before(:each) do
       @wrapper.stub!(:call_get_remote).and_return ""
-
+      
       @wrapper.stub!(:call_get_local_branch).and_return " * master"
       @wrapper.stub!(:call_get_remote).with("master").and_return "upstream\n"
     end
@@ -78,32 +166,46 @@ describe GitRemoteMonitor::GitWrapper do
       @wrapper.remote_branch.should be_nil
     end
   end
-
-
+  
   describe "getting tracking information" do
     
+    def tracking_info_should_be(local_changes, remote_changes, options = {})
+      @wrapper.should_receive(:call_get_tracking_info).and_return(options[:for])
+      @wrapper.get_tracking_info("master", "origin/master").should == [local_changes, remote_changes]
+    end
+    
     before(:each) do
-      @wrapper.stub!(:call_get_tracking_info).and_return "         1 "
+      # Stub away the system command to be safe
+      @wrapper.stub!(:call_get_tracking_info => "")
+    end
+    
+    it "should raise error on unexpected output from command" do
+      lambda {
+        @wrapper.stub!(:call_get_tracking_info => nil)
+        @wrapper.get_tracking_info("master", "origin/master")
+      }.should raise_error
+      
+      lambda {
+        @wrapper.stub!(:call_get_tracking_info => "  1\n    2\n   3\n")
+        @wrapper.get_tracking_info("master", "origin/master")
+      }.should raise_error
     end
     
     it "should be able to get the correct number of commits when nothing has changed" do
-      @wrapper.get_tracking_info("me", "you").should == [0, 0]
+      tracking_info_should_be 0, 0, :for => "         1 "
     end
     
     it "should be able to get the correct number of commits when diverged" do
-      @wrapper.should_receive(:call_get_tracking_info).and_return("           1 <\n          7 >")
-      @wrapper.get_tracking_info("me", "you").should == [1, 7]
+      tracking_info_should_be 1, 7, :for => " 1 <\n 7 >"
     end
     
     it "should be able to get the correct number of commits when remote is ahead" do
-      @wrapper.should_receive(:call_get_tracking_info).and_return("          7 >")
-      @wrapper.get_tracking_info("me", "you").should == [0, 7]
+      tracking_info_should_be 0, 7, :for => " 7 >"
     end
     
     it "should be able to get the correct number of commits when remote is behind" do
-      @wrapper.should_receive(:call_get_tracking_info).and_return("           1 <")
-      @wrapper.get_tracking_info("me", "you").should == [1, 0]
+      tracking_info_should_be 132, 0, :for => "  132 <"
     end
-  end  
+  end
   
 end

data/spec/git_remote_monitor/monitor_spec.rb

@@ -0,0 +1,138 @@
+# The MIT License
+# Copyright © 2009 Magnus Bergmark
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe GitRemoteMonitor::Monitor do
+  before(:each) do
+    Dir.stub!(:chdir)
+    File.stub!(:exist? => true, :directory? => true)
+  end
+  
+  describe "initializing" do
+    before(:each) do
+      GitRemoteMonitor::Monitor.stub!(:move_to_directory!)
+    end
+    
+    it "should move to directory specified" do
+      GitRemoteMonitor::Monitor.should_receive(:move_to_directory!).with("foo")
+      GitRemoteMonitor::Monitor.new("foo", 120, mock("Notifier"), "Name")
+    end
+    
+    it "should auto-discover the name from the directory when no name given" do
+      instance = GitRemoteMonitor::Monitor.new("/complex/path/with_name", 120, mock("Notifier"))
+      instance.name.should == "with_name"
+    end
+    
+  end
+  
+  it "should notify the user with the correct information" do
+    GitRemoteMonitor::GitWrapper.stub!(:local_branch => 'local', :remote_branch => 'remote')
+    GitRemoteMonitor::GitWrapper.should_receive(:get_tracking_info).with('local', 'remote').and_return([4, 5])
+    
+    notifier = mock("Notifier")
+    instance = GitRemoteMonitor::Monitor.new("/", 120, notifier)
+    notifier.should_receive(:notify_commits).with(instance, 'local', 4, 5)
+    
+    instance.send(:notify!)
+  end
+  
+  describe "moving to a directory" do
+    def stub_io(options = {})
+      options = {:exist => false, :dir => false, :repo => false}.merge(options)
+      File.stub!(:exist?).with('foo').and_return(options[:exist])
+      File.stub!(:directory?).with('foo').and_return(options[:dir])
+      GitRemoteMonitor::GitWrapper.stub!(:in_repo?).and_return(options[:repo])
+      Dir.stub!(:chdir)
+    end
+    
+    it "should raise error if path does not exist" do
+      stub_io :exist => false
+      Dir.should_not_receive(:chdir)
+      lambda {
+        GitRemoteMonitor::Monitor.move_to_directory!('foo')
+      }.should raise_error
+    end
+    
+    it "should raise error if path exists but is not a directory" do
+      stub_io :exist => true, :dir => false
+      Dir.should_not_receive(:chdir)
+      lambda {
+        GitRemoteMonitor::Monitor.move_to_directory!('foo')
+      }.should raise_error
+    end
+    
+    it "should raise error if path is not part of a git repository" do
+      stub_io :exist => true, :dir => true, :repo => false
+      Dir.should_receive(:chdir).with('foo') # We still chdir, though. Raises come after
+      lambda {
+        GitRemoteMonitor::Monitor.move_to_directory!('foo')
+      }.should raise_error
+    end
+    
+    it "should try to move if directory exists" do
+      stub_io :exist => true, :dir => true, :repo => true
+      Dir.should_receive(:chdir).with('foo')
+      lambda {
+        GitRemoteMonitor::Monitor.move_to_directory!('foo')
+      }.should_not raise_error
+    end
+    
+  end
+  
+  it "should monitor forever" do
+    instance = GitRemoteMonitor::Monitor.new('dir', 180, mock("Notifier"))
+    instance.send(:should_loop_monitoring?).should be_true
+  end
+  
+  describe "monitoring" do
+    before(:each) do
+      GitRemoteMonitor::GitWrapper.stub!(:fetch!)
+      @instance = GitRemoteMonitor::Monitor.new('dir', 180, mock("Notifier"))
+      @instance.stub!(:sleep => true, :notify! => true, :should_loop_monitoring? => false)
+    end
+    
+    it "should loop" do
+      # Loop once and then abort it by changing th return of the method from true to false
+      @instance.should_receive(:should_loop_monitoring?).twice.and_return(true, false)
+      @instance.start_monitoring!
+    end
+    
+    it "should notify when changes are detected" do
+      GitRemoteMonitor::GitWrapper.should_receive(:fetch!).and_return(true)
+      @instance.should_receive(:notify!)
+      @instance.start_monitoring!
+    end
+    
+    it "should not notify when no changes are detected" do
+      GitRemoteMonitor::GitWrapper.should_receive(:fetch!).and_return(false)
+      @instance.should_not_receive(:notify!)
+      @instance.start_monitoring!
+    end
+    
+    it "should sleep the specified interval" do
+      @instance.should_receive(:sleep).with(180)
+      @instance.start_monitoring!
+    end
+    
+  end
+  
+end