rscm 0.3.13 → 0.3.14

data/CHANGES

@@ -1,5 +1,11 @@
 = RSCM Changelog
 
+== Version 0.3.14
+
+Improved error messages
+
+* Subversion and CVS now raise detailed instructions on how to install triggers in case of failure.
+
 == Version 0.3.13
 
 Improved trigger support

data/README

@@ -1,4 +1,4 @@
-= RSCM - Ruby Source Control Management (0.3.13)
+= RSCM - Ruby Source Control Management (0.3.14)
 
 RSCM is to SCM what DBI/JDBC/ODBC are to databases - an SCM-independent API for accessing different SCMs. The high level features are roughly:
 

data/Rakefile

@@ -10,7 +10,7 @@ require 'meta_project'
 
 PKG_BUILD     = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
 PKG_NAME      = 'rscm'
-PKG_VERSION   = '0.3.13' + PKG_BUILD
+PKG_VERSION   = '0.3.14' + PKG_BUILD
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 
 desc "Default Task"

data/lib/rscm/revision.rb

@@ -142,10 +142,11 @@ module RSCM
       self.message = file.message if file.message
     end
 
-    def [] (file)
-      @files[file]
+    def [] (index)
+      @files[index]
     end
 
+    # Iterates over all the RevisionFile objects
     def each(&block)
       @files.each(&block)
     end
@@ -157,6 +158,7 @@ module RSCM
     def length
       @files.length
     end
+    alias :size :length
 
     def time=(t)
       raise "time must be a Time object - it was a #{t.class.name} with the string value #{t}" unless t.is_a?(Time)
@@ -190,12 +192,6 @@ module RSCM
       result
     end
     
-    # Returns the identifier of the revision. This is the revision 
-    # (if defined) or an UTC time if it is not natively supported by the scm.
-    def identifierAA
-      @identifier || @time
-    end
-    
   end
 
 end

data/lib/rscm/revision_file.rb

@@ -9,18 +9,28 @@ module RSCM
     ADDED = "ADDED"
     MOVED = "MOVED"
     
+    # MODIFIED, DELETED, ADDED or MOVED
     attr_accessor :status
+    
+    # Relative path from the root of the RSCM::Base instance
     attr_accessor :path
+
+    # The native SCM's previous revision for this file. For non-transactional SCMs this is different from
+    # the parent Revision's 
     attr_accessor :previous_native_revision_identifier
+
     # The native SCM's revision for this file. For non-transactional SCMs this is different from
     # the parent Revision's 
     attr_accessor :native_revision_identifier
 
+    # The developer who modified this file
     attr_accessor :developer
+    
+    # The commit message for this file
     attr_accessor :message
+    
     # This is a UTC ruby time
     attr_accessor :time
-    attr_accessor :scm
     
     def initialize(path=nil, status=nil, developer=nil, message=nil, native_revision_identifier=nil, time=nil)
       @path, @developer, @message, @native_revision_identifier, @time, @status = path, developer, message, native_revision_identifier, time, status
@@ -32,43 +42,21 @@ module RSCM
       scm.open(self, &block)
     end
     
+    # Yields the diff as an IO for this file
     def diff(scm, &block)
       scm.diff(self, &block)
     end
   
+    # Accepts a visitor that must respond to +visit_file(revision_file)+ 
     def accept(visitor)
       visitor.visit_file(self)
     end
 
+    # A simple string representation. Useful for debugging.
     def to_s
       "#{path} | #{native_revision_identifier}"
     end
 
-    def developer=(developer)
-      raise "can't be null" if developer.nil?
-      @developer = developer
-    end
-    
-    def message=(message)
-      raise "can't be null" if message.nil?
-      @message = message
-    end
-
-    def path=(path)
-      raise "can't be null" if path.nil?
-      @path = path
-    end
-
-    def native_revision_identifier=(id)
-      raise "can't be null" if id.nil?
-      @native_revision_identifier = id
-    end
-
-    def time=(time)
-      raise "time must be a Time object" unless time.is_a?(Time)
-      @time = time
-    end
-
     def ==(other)
       return false if !other.is_a?(self.class)
       self.path == other.path &&

data/lib/rscm/scm/cvs.rb

@@ -121,25 +121,6 @@ module RSCM
       "CVSROOT/loginfo"
     end
     
-    def install_trigger(trigger_command, trigger_files_checkout_dir)
-      raise "mod can't be null or empty" if (mod.nil? || mod == "")
-
-      root_cvs = create_root_cvs(trigger_files_checkout_dir)
-      root_cvs.checkout
-      with_working_dir(trigger_files_checkout_dir) do
-        trigger_line = "#{mod} #{trigger_command}\n"
-        File.open("loginfo", File::WRONLY | File::APPEND) do |file|
-          file.puts(trigger_line)
-        end
-        begin
-          root_cvs.commit("Installed trigger for CVS module '#{mod}'")
-        rescue
-          raise "Couldn't commit the trigger back to CVS. Try to manually check out CVSROOT/loginfo, " +
-          "add the following line and commit it back:\n\n#{trigger_line}"
-        end
-      end
-    end
-    
     def trigger_installed?(trigger_command, trigger_files_checkout_dir)
       loginfo_line = "#{mod} #{trigger_command}"
       regex = Regexp.new(Regexp.escape(loginfo_line))
@@ -164,6 +145,27 @@ module RSCM
       end
     end
 
+    def install_trigger(trigger_command, trigger_files_checkout_dir)
+      raise "mod can't be null or empty" if (mod.nil? || mod == "")
+
+      root_cvs = create_root_cvs(trigger_files_checkout_dir)
+      root_cvs.checkout
+      with_working_dir(trigger_files_checkout_dir) do
+        trigger_line = "#{mod} #{trigger_command}\n"
+        File.open("loginfo", File::WRONLY | File::APPEND) do |file|
+          file.puts(trigger_line)
+        end
+        begin
+          root_cvs.commit("Installed trigger for CVS module '#{mod}'")
+        rescue
+          raise ["Didn't have permission to commit CVSROOT/loginfo.",
+                "Try to manually add the following line:",
+                trigger_command,
+                "Finally make commit the file to the repository"]
+        end
+      end
+    end
+    
     def uninstall_trigger(trigger_command, trigger_files_checkout_dir)
       loginfo_line = "#{mod} #{trigger_command}"
       regex = Regexp.new(Regexp.escape(loginfo_line))

data/lib/rscm/scm/subversion.rb

@@ -11,6 +11,7 @@ module RSCM
   #
   # NOTE: On Cygwin these have to be the win32 builds of svn/svnadmin and not the Cygwin ones.
   class Subversion < Base
+    
     include FileUtils
     include PathConverter
     
@@ -97,7 +98,8 @@ module RSCM
     end
     
     def open(revision_file, &block)
-      Better.popen("svn cat --revision #{revision_file.native_revision_identifier} #{url}/#{revision_file.path}") do |io|
+      cmd = "svn cat #{url}/#{revision_file.path}@#{revision_file.native_revision_identifier}"
+      Better.popen(cmd) do |io|
         return(yield(io))
       end
     end
@@ -242,17 +244,24 @@ module RSCM
         end
         File.chmod(0744, post_commit_file)
       rescue
-        raise "Didn't have permission to write to #{post_commit_file}. " +
-              "Try to manually add the following line:\n\n#{trigger_command}\n\n" +
-              "Finally make it executable with chmod g+x #{post_commit_file}\n\n"
+        raise ["Didn't have permission to write to #{post_commit_file}.",
+              "Try to manually add the following line:",
+              trigger_command,
+              "Finally make it executable with chmod g+x #{post_commit_file}"]
       end
     end
     
     def install_win_trigger(trigger_command, damagecontrol_install_dir)
       post_commit_exists = File.exists?(post_commit_file)
       mode = post_commit_exists ? File::APPEND|File::WRONLY : File::CREAT|File::WRONLY
-      File.open(post_commit_file, mode) do |file|
-        file.puts("#{trigger_command}\n" )
+      begin
+        File.open(post_commit_file, mode) do |file|
+          file.puts("#{trigger_command}\n" )
+        end
+      rescue
+        raise ["Didn't have permission to write to #{post_commit_file}.",
+              "Try to manually add the following line:",
+              trigger_command]
       end
     end
     
@@ -366,7 +375,11 @@ module RSCM
     def post_commit_file
       # We actualy need to use the .cmd when on cygwin. The cygwin svn post-commit
       # hook is hosed. We'll be relying on native windows
-      WINDOWS ? "#{svnrootdir}/hooks/post-commit.cmd" : "#{svnrootdir}/hooks/post-commit"
+      if(local?)
+        WINDOWS ? "#{svnrootdir}/hooks/post-commit.cmd" : "#{svnrootdir}/hooks/post-commit"
+      else
+        raise "The repository is not local. Cannot install or uninstall trigger."
+      end
     end
     
   end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: rscm
 version: !ruby/object:Gem::Version 
-  version: 0.3.13
-date: 2005-11-14
+  version: 0.3.14
+date: 2005-11-16
 summary: "RSCM - Ruby Source Control Management"
 require_paths: 
   - lib