rscm 0.3.6 → 0.3.7

data/CHANGES

@@ -1,5 +1,12 @@
 = RSCM Changelog
 
+== Version 0.3.7
+
+This release improves polling of revisions (changesets) and improves ClearCase support
+
+* Added RSCM.Base.poll_new_revisions (moved from DamageControl)
+* Rewrote the ClearCase adapter. There are no tests for ClearCase yet - tested manually.
+
 == Version 0.3.6
 
 Bugfix release

data/README

@@ -1,4 +1,4 @@
-= RSCM - Ruby Source Control Management (0.3.6)
+= RSCM - Ruby Source Control Management (0.3.7)
 
 RSCM is to SCM what DBI/JDBC/ODBC are to databases - an SCM-independent API for accessing different SCMs. The 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.6' + PKG_BUILD
+PKG_VERSION   = '0.3.7' + PKG_BUILD
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 
 desc "Default Task"

data/lib/rscm/revision_poller.rb

@@ -0,0 +1,77 @@
+module RSCM
+  class Base
+    attr_accessor :logger
+  
+    TWO_WEEKS_AGO = 2*7*24*60*60
+    THIRTY_TWO_WEEKS_AGO = TWO_WEEKS_AGO * 16
+
+    # Polls new revisions for since +last_revision+,
+    # or if +last_revision+ is nil, polls since 'now' - +seconds_before_now+.
+    # If no revisions are found AND the poll was using +seconds_before_now+
+    # (i.e. it's the first poll, and no revisions were found),
+    # calls itself recursively with twice the +seconds_before_now+.
+    # This happens until revisions are found, ot until the +seconds_before_now+
+    # Exceeds 32 weeks, which means it's probably not worth looking further in
+    # the past, the scm is either completely idle or not yet active.
+    def poll_new_revisions(latest_revision=nil, seconds_before_now=TWO_WEEKS_AGO, max_time_before_now=THIRTY_TWO_WEEKS_AGO)
+      max_past = Time.new.utc - max_time_before_now
+  
+      if(!central_exists?)
+        logger.info "Not polling for revisions - central scm repo doesn't seem to exist" if logger
+        return []
+      end
+      
+      # Default value for start time (in case there are no detected revisions yet)
+      from = Time.new.utc - seconds_before_now
+      if(latest_revision)
+        from = latest_revision.identifier
+      else
+        if(from < max_past)
+          logger.info "Checked for revisions as far back as #{max_past}. There were none, so we give up." if logger
+          return []
+        else
+          logger.info "Latest revision is not known. Checking for revisions since: #{from}" if logger
+        end
+      end
+
+      logger.info "Polling revisions after #{from} (#{from.class.name})" if logger
+      
+      revisions = revisions(from)
+      if(revisions.empty?)
+        logger.info "No new revisions after #{from}" if logger
+        unless(latest_revision)
+          double_seconds_before_now = 2*seconds_before_now
+          logger.info "Last revision still not found, checking since #{double_seconds_before_now.ago}" if logger
+          return poll_new_revisions(project, double_seconds_before_now, max_time_before_now)
+        end
+      else
+        logger.info "There were #{revisions.length} new revision(s) after #{from}" if logger
+      end
+
+      if(!revisions.empty? && !transactional?)
+        # We're dealing with a non-transactional SCM (like CVS/StarTeam/ClearCase,
+        # unlike Subversion/Monotone). Sleep a little, get the revisions again.
+        # When the revisions are not changing, we can consider the last commit done
+        # and the quiet period elapsed. This is not 100% failsafe, but will work
+        # under most circumstances. In the worst case, we'll miss some files in
+        # the revisions for really slow commits, but they will be part of the next 
+        # revision (on next poll).
+        commit_in_progress = true
+        quiet_period = project.quiet_period || DEFAULT_QUIET_PERIOD
+        while(commit_in_progress)
+          logger.info "Sleeping for #{quiet_period} seconds because #{visual_name} is not transactional." if logger
+          
+          sleep(quiet_period)
+          previous_revisions = revisions
+          revisions = revisions(from)
+          commit_in_progress = revisions != previous_revisions
+          if(commit_in_progress)
+            logger.info "Commit still in progress." if logger
+          end
+        end
+        logger.info "Quiet period elapsed" if logger
+      end
+      return revisions
+    end
+  end
+end

data/lib/rscm/scm/clearcase.rb

@@ -1,81 +1,159 @@
 require 'rscm/base'
 require 'rscm/path_converter'
 require 'fileutils'
+require 'tempfile'
 
 module RSCM
-  class ClearCase < Base
-  
-    LOG_FORMAT = "Developer:%u\\nTime:%Nd\\nExtendedName:%Xn\\nVersionId:%Vn\\nPreviousVersionId:%PVn\\nElementName:%En\\nOID:%On\\nO:%o\\nMessage:%Nc\\n------------------------------------------\\n"
-  
-    def revisions(checkout_dir, from_identifier, to_identifier=Time.infinity)
-      result = Revisions.new
-      with_working_dir(checkout_dir) do
-        since = from_identifier.strftime("%d-%b-%Y.%H:%M:%S")
-        cleartool("lshistory -recurse -nco -since #{since} -fmt #{LOG_FORMAT}") do |io|
-          io.each_line {|l| puts l}
-          revisions << Revision.new()
-        end
-      end
-      result
-    end
-    
-    def diff(checkout_dir, change)
-      with_working_dir(checkout_dir) do
-        cleartool("diff -diff_format #{change.path}@@#{change.previous_native_revision_identifier} #{change.path}@@#{change.revision}")
-      end
-    end
-
-    def checked_out?(checkout_dir)
-      File.exists?("#{checkout_dir}")
-    end
-
-    def uptodate?(checkout_dir, from_identifier)
-      if (!checked_out?(checkout_dir))
-        false
-      else
-        with_working_dir(checkout_dir) do
-          false
-        end
-      end
-    end
-
-    def commit(checkout_dir, message)
-
-    end
-    
-    def import
-      # clearfsimport -preview -recurse -nsetevent <from> <to>
-    end
-
-  protected
-
-    # Checks out silently. Called by superclass' checkout.
-    def checkout_silent(checkout_dir, to_identifier)
-      with_working_dir(checkout_dir) do
-        cleartool("update .") { |io|
-          #io.each_line {|l| puts l}
-        }
-      end
-    end
-
-    # Administrative files that should be ignored when counting files.
-    def ignore_paths
-      return [/.*\.updt/]
-    end
-
-  private
-  
-    def cleartool(cleartool_cmd)
-      cmd = "cleartool #{cleartool_cmd}"
-      Better.popen(cmd, "r+") do |io|
-        if(block_given?)
-          return(yield(io))
-        else
-          # just read stdout so we can exit
-          io.read
-        end
-      end
-    end
-  
-  end
-end
+ class ClearCase < Base
+   register self
+
+   LOG_FORMAT = "- !ruby/object:RSCM::RevisionFile\\n  developer: %u\\n  time: \\\"%Nd\\\"\\n  native_revision_identifier: %Vn\\n  previous_native_revision_identifier: %PVn\\n  path: %En\\n  status: %o\\n  message: \\\"%Nc\\\"\\n\\n"
+   TIME_FORMAT = "%d-%b-%Y.%H:%M:%S"
+   MAGIC = "9q8w7e6r5t4y"
+   STATUSES = {
+     "checkin" => RevisionFile::MODIFIED,
+     "mkelem" => RevisionFile::ADDED,
+     "rmelem" => RevisionFile::DELETED,
+   }
+
+   attr_accessor :stream, :stgloc, :tag, :config_spec
+
+   def initialize(stream, stgloc, tag, config_spec)
+     @stream, @stgloc, @tag, @config_spec = stream, stgloc, tag, config_spec
+   end
+
+   def revisions(from_identifier, to_identifier=Time.infinity, relative_path=nil)
+     checkout unless checked_out?
+
+     rules = load_rules
+     vob = vob(rules[0])
+
+     result = Revisions.new
+     with_working_dir(checkout_dir) do
+       since = (from_identifier + 1).strftime(TIME_FORMAT)
+       cmd = "cleartool lshistory -recurse -nco -since #{since} -fmt \"#{LOG_FORMAT}\" -pname #{vob}"
+       Better.popen(cmd) do |io|
+         # escape all quotes, except the one at the beginning and end. this is a bit ugly...
+         raw_yaml = io.read
+         fixed_yaml = raw_yaml.gsub(/^  message: \"/, "  message: #{MAGIC}")
+         fixed_yaml = fixed_yaml.gsub(/\"\n\n/, "#{MAGIC}\n\n")
+         fixed_yaml = fixed_yaml.gsub(/\"/, "\\\"")
+         fixed_yaml = fixed_yaml.gsub(MAGIC, "\"")
+
+         files = YAML.load(fixed_yaml)
+         files.each do |file|
+           file.path.gsub!(/\\/, "/")
+           file.status = STATUSES[file.status]
+           rev = revision(file.native_revision_identifier)
+           if(rev && matches_load_rules?(rules, file.path))
+             file.native_revision_identifier = rev
+             file.previous_native_revision_identifier = revision(file.previous_native_revision_identifier)
+             t = file.time
+             # the time now has escaped quotes..
+             file.time = Time.utc(t[2..5],t[6..7],t[8..9],t[11..12],t[13..14],t[15..16])
+             file.message.strip!
+             result.add(file)
+           end
+         end
+       end
+     end
+     result
+   end
+
+   def checked_out?
+     File.exist?(checkout_dir)
+   end
+
+   def destroy_working_copy
+     Better.popen("cleartool rmview #{checkout_dir}") do |io|
+       io.read
+     end
+   end
+
+ protected
+
+   def checkout_silent(to_identifier=nil)
+     if(checked_out?)
+       with_working_dir(checkout_dir) do
+         Better.popen("cleartool update .") do |io|
+           io.read
+         end
+       end
+     else
+       # Create view (working copy)
+       mkview_cmd = "cleartool mkview -snapshot -stream #{@stream} -stgloc #{@stgloc} -tag #{@tag} #{@checkout_dir}"
+       Better.popen(mkview_cmd) do |io|
+         puts io.read
+       end
+
+       # Set load rules (by setting config spec)
+       Dir.chdir(checkout_dir) do
+         # tempfile is broken on windows (!!)
+         cfg_spec_file = "__rscm.cfgspec"
+         config_spec_file = File.open(cfg_spec_file, "w") do |io|
+           io.write(@config_spec)
+         end
+
+         setcs_cmd = "cleartool setcs #{cfg_spec_file}"
+         Better.popen(setcs_cmd, "w") do |io|
+           io.write "yes\n"
+         end
+       end
+     end
+   end
+
+   # Administrative files that should be ignored when counting files.
+   def ignore_paths
+     return [/.*\.updt/]
+   end
+
+ private
+
+   def vob(rule)
+     if(rule =~ /[\\\/]*([\w]*)/)
+       $1
+     else
+       nil
+     end
+   end
+
+   # What's loaded into view
+   def load_rules
+     result = []
+     config_spec do |io|
+       io.each_line do |line|
+         if(line =~ /^load[\s]*(.*)$/)
+           return result << $1
+         end
+       end
+     end
+     result
+   end
+
+   def config_spec
+     Dir.chdir(checkout_dir) do
+       catcs_cmd = "cleartool catcs"
+       Better.popen(catcs_cmd) do |io|
+         yield io
+       end
+     end
+   end
+
+   def revision(s)
+     if(s =~ /.*\\([\d]*)/)
+       $1.to_i
+     else
+       nil
+     end
+   end
+
+   def matches_load_rules?(rules, path)
+     rules.each do |rule|
+       rule.gsub!(/\\/, "/")
+       return true if path =~ /#{rule[1..-1]}/
+     end
+     false
+   end
+
+ end
+end

data/lib/rscm/scm/monotone.rb

@@ -4,7 +4,7 @@ require 'rscm'
 
 module RSCM
   class Monotone < Base
-    register self
+    # register self
 
     ann :description => "Database file"
     attr_accessor :db_file

data/lib/rscm/scm/subversion.rb

@@ -76,13 +76,8 @@ module RSCM
             absolute_path = PathConverter.nativepath_to_filepath(native_absolute_path)
             if(File.exist?(absolute_path) && !File.directory?(absolute_path))
               native_checkout_dir = PathConverter.filepath_to_nativepath(@checkout_dir, false)
-              relative_path = nil
-              if WINDOWS
-                relative_path = native_absolute_path[native_checkout_dir.length+1..-1].chomp
-                relative_path = relative_path.gsub(/\\/, "/")
-              else
-                relative_path = absolute_path
-              end
+              relative_path = native_absolute_path[native_checkout_dir.length+1..-1].chomp
+              relative_path = relative_path.gsub(/\\/, "/")
               checked_out_files << relative_path
               yield relative_path if block_given?
             end

data/lib/rscm.rb

@@ -5,6 +5,7 @@ require 'rscm/logging'
 require 'rscm/better'
 require 'rscm/base'
 require 'rscm/revision'
+require 'rscm/revision_poller'
 require 'rscm/revision_file'
 require 'rscm/historic_file'
 require 'rscm/time_ext'

data/test/rscm/base_test.rb

@@ -5,9 +5,10 @@ module RSCM
   class BaseTest < Test::Unit::TestCase
     def test_should_load_all_scm_classes
       expected_scms_classes = [
+        ClearCase,
         Cvs,
 #        Darcs,
-        Monotone,
+#        Monotone,
 #        Mooky,
         Perforce,
 #        StarTeam,

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: rscm
 version: !ruby/object:Gem::Version 
-  version: 0.3.6
-date: 2005-10-05 00:00:00 -04:00
+  version: 0.3.7
+date: 2005-10-11 00:00:00 -04:00
 summary: "RSCM - Ruby Source Control Management"
 require_paths: 
   - lib
@@ -47,6 +47,7 @@ files:
   - lib/rscm/path_converter.rb
   - lib/rscm/revision.rb
   - lib/rscm/revision_file.rb
+  - lib/rscm/revision_poller.rb
   - lib/rscm/scm
   - lib/rscm/tempdir.rb
   - lib/rscm/time_ext.rb
@@ -78,9 +79,9 @@ files:
   - test/rscm/mockit_test.rb
   - test/rscm/parser_test.rb
   - test/rscm/path_converter_test.rb
-  - test/rscm/revisions.yaml
   - test/rscm/revision_fixture.rb
   - test/rscm/revision_test.rb
+  - test/rscm/revisions.yaml
   - test/rscm/scm
   - test/rscm/scm/clearcase.log
   - test/rscm/scm/clearcase_test.rb