rscm 0.3.14 → 0.3.15

data/CHANGES

@@ -1,5 +1,12 @@
 = RSCM Changelog
 
+== Version 0.3.15
+
+This release adds support for directory listings and fixes some incompatibilities with CVS 1.12.x
+
+* Added support for directory listings.
+* Added support for parsing of revisions for CVS 1.12.x, which uses a slightly different time format.
+
 == Version 0.3.14
 
 Improved error messages

data/README

@@ -1,4 +1,4 @@
-= RSCM - Ruby Source Control Management (0.3.14)
+= RSCM - Ruby Source Control Management (0.3.15)
 
 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.14' + PKG_BUILD
+PKG_VERSION   = '0.3.15' + PKG_BUILD
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 
 desc "Default Task"

data/lib/rscm/abstract_log_parser.rb

@@ -7,22 +7,17 @@ module RSCM
   # TODO: make this a module and remove the attr_reader
   class AbstractLogParser
   
-    attr_reader :io
-  
     def initialize(io)
       @io = io
-      @current_line_number = 0
-      @had_error = false
     end
   
     def read_until_matching_line(regexp)
-      return nil if io.eof?
+      return nil if @io.eof?
       result = ""
-      io.each_line do |line|
-        @current_line_number += 1
+      @io.each_line do |line|
         line.gsub!(/\r\n$/, "\n")
-        break if line=~regexp
-        result<<line
+        break if line =~ regexp
+        result << line
       end
       if result.strip == ""
         read_until_matching_line(regexp) 
@@ -35,15 +30,6 @@ module RSCM
       file.gsub(/\\/, "/")
     end
     
-    def error(msg)
-      @had_error=true
-      $stderr.puts(msg + "\ncurrent line: #{@current_line}\nstack trace:\n")
-      $stderr.puts(caller.backtrace.join('\n\t'))
-    end
-    
-    def had_error?
-      @had_error
-    end
   end
 
 end

data/lib/rscm/base.rb

@@ -16,6 +16,7 @@ module RSCM
   # * checked_out?
   # * diff
   # * edit
+  # * ls
   # * move
   # * revisions
   # * uptodate?
@@ -108,13 +109,14 @@ module RSCM
     # example if the repository is 'remote' or if it already exists).
     #
     def create_central
-      raise "Not implemented"
+      raise NotImplementedError
     end
     
     # Destroys the central repository. Shuts down any server processes and deletes the repository.
     # WARNING: calling this may result in loss of data. Only call this if you really want to wipe 
     # it out for good!
     def destroy_central
+      raise NotImplementedError
     end
 
     # Whether a repository can be created.
@@ -124,12 +126,14 @@ module RSCM
 
     # Adds +relative_filename+ to the working copy.
     def add(relative_filename)
+      raise NotImplementedError
     end
 
     # Schedules a move of +relative_src+ to +relative_dest+
     # Should not take effect in the central repository until
     # +commit+ is invoked.
     def move(relative_src, relative_dest)
+      raise NotImplementedError
     end
 
     # Recursively imports files from a +dir+ into the central scm
@@ -143,6 +147,7 @@ module RSCM
     
     # Commit (check in) modified files.
     def commit(message)
+      raise NotImplementedError
     end
     
     # Checks out or updates contents from a central SCM to +checkout_dir+ - a local working copy.
@@ -190,27 +195,22 @@ module RSCM
     # revisions pertaining to that path.
     #
     def revisions(from_identifier, to_identifier=Time.infinity, relative_path=nil)
-      # Should be overridden by subclasses
-      revisions = Revisions.new
-      revisions.add(
-        Revision.new(
-          "up/the/chimney",
-          Revision::DELETED,
-          "DamageControl",
-          "The #{name} class doesn't\n" +
-            "correctly implement the revisions method. This is\n" +
-            "not a real revision, but a hint to the developer to go and implement it.\n\n" +
-            "Do It Now!",
-          "999",
-          Time.now.utc
-        )
-      )
-      revisions
+      raise NotImplementedError
+    end
+    
+    # Returns the HistoricFile representing the root of the repo
+    def rootdir
+      file("", true)
     end
     
     # Returns a HistoricFile for +relative_path+
-    def file(relative_path)
-      HistoricFile.new(relative_path, self)
+    def file(relative_path, dir)
+      HistoricFile.new(relative_path, dir, self)
+    end
+    
+    # Returns an Array of the children under +relative_path+
+    def ls(relative_path)
+      raise NotImplementedError
     end
 
     # Whether the working copy is in synch with the central
@@ -243,7 +243,7 @@ module RSCM
 
     # Descriptive name of the trigger mechanism
     def trigger_mechanism
-      "Unknown"
+      raise NotImplementedError
     end
 
     # Installs +trigger_command+ in the SCM.
@@ -253,37 +253,37 @@ module RSCM
     # Most implementations will ignore this parameter.
     #
     def install_trigger(trigger_command, install_dir)
-      raise "Not implemented"
+      raise NotImplementedError
     end
 
     # Uninstalls +trigger_command+ from the SCM.
     #
     def uninstall_trigger(trigger_command, install_dir)
-      raise "Not implemented"
+      raise NotImplementedError
     end
 
     # Whether the command denoted by +trigger_command+ is installed in the SCM.
     #
     def trigger_installed?(trigger_command, install_dir)
-      raise "Not implemented"
+      raise NotImplementedError
     end
 
     # The command line to run in order to check out a fresh working copy.
     #
     def checkout_commandline(to_identifier=Time.infinity)
-      raise "Not implemented"
+      raise NotImplementedError
     end
 
     # The command line to run in order to update a working copy.
     #
     def update_commandline(to_identifier=Time.infinity)
-      raise "Not implemented"
+      raise NotImplementedError
     end
 
     # Returns/yields an IO containing the unified diff of the change.
     # Also see RevisionFile#diff
     def diff(change, &block)
-      return(yield("Not implemented"))
+      raise NotImplementedError
     end
 
     def ==(other_scm)

data/lib/rscm/historic_file.rb

@@ -1,8 +1,14 @@
 module RSCM
-  # Represents the full history of a single file
+  # Represents the full history of a single file or directory.
   class HistoricFile
-    def initialize(relative_path, scm)
-      @relative_path, @scm = relative_path, scm
+    attr_reader :relative_path
+    
+    def initialize(relative_path, directory, scm)
+      @relative_path, @directory, @scm = relative_path, directory, scm
+    end
+    
+    def directory?
+      @directory
     end
     
     # Returns an Array of RevisionFile - from Time.epoch until Time.infinity (now)
@@ -18,5 +24,10 @@ module RSCM
         revision.files[0]
       end
     end
+    
+    def children
+      raise "Not a directory" unless directory?
+      @scm.ls(@relative_path)
+    end
   end
 end

data/lib/rscm/revision.rb

@@ -1,4 +1,3 @@
-require 'xmlrpc/utils'
 require 'rscm/time_ext'
 require 'rscm/revision_file'
 
@@ -7,7 +6,6 @@ module RSCM
   # A collection of Revision.
   class Revisions
     include Enumerable
-    include XMLRPC::Marshallable
 
     attr_accessor :revisions
 
@@ -115,7 +113,6 @@ module RSCM
   # same commit message, and within a "reasonably" small timespan.
   class Revision
     include Enumerable
-    include XMLRPC::Marshallable
 
     attr_reader :files
     attr_accessor :identifier
@@ -167,8 +164,7 @@ module RSCM
     end
     
     def ==(other)
-      return false if !other.is_a?(self.class)
-      @files == other.files
+      other.is_a?(self.class) && @files == other.files
     end
 
     def <=>(other)
@@ -177,7 +173,7 @@ module RSCM
 
     # Whether this instance can contain a File. Used
     # by non-transactional SCMs.
-    def can_contain?(file)
+    def can_contain?(file) #:nodoc:
       self.developer == file.developer &&
       self.message == file.message &&
       (self.time - file.time).abs < 60

data/lib/rscm/revision_file.rb

@@ -2,7 +2,6 @@ module RSCM
   # Represents a file within a Revision, and also information about how this file
   # was modified compared with the previous revision.
   class RevisionFile
-    include XMLRPC::Marshallable
 
     MODIFIED = "MODIFIED"
     DELETED = "DELETED"

data/lib/rscm/scm/cvs.rb

@@ -106,12 +106,36 @@ module RSCM
     
     def open(revision_file, &block)
       with_working_dir(@checkout_dir) do
-        diff_cmd = "cvs -Q update -p -r #{revision_file.native_revision_identifier} #{revision_file.path}"
-        Better.popen(diff_cmd) do |io|
+        cmd = "cvs -Q update -p -r #{revision_file.native_revision_identifier} #{revision_file.path}"
+        Better.popen(cmd) do |io|
           block.call io
         end
       end
     end
+    
+    def ls(relative_path)
+      prefix = relative_path == "" ? relative_path : "#{relative_path}/"
+      with_working_dir(@checkout_dir) do
+        cmd = "cvs -Q ls -l #{relative_path}"
+        Better.popen(cmd) do |io|
+          parse_ls_log(io, prefix)
+        end
+      end
+    end
+    
+    def parse_ls_log(io, prefix) #:nodoc:
+      io.collect do |line|
+        line.strip!
+        if(
+          (line =~ /(d)... \d\d\d\d\-\d\d\-\d\d \d\d:\d\d:\d\d \-\d\d\d\d (.*)/) ||
+          (line =~ /(.)... \d\d\d\d\-\d\d\-\d\d \d\d:\d\d:\d\d \-\d\d\d\d \d[\.\d]+ (.*)/) 
+        )
+          directory = $1 == "d"
+          name = $2.strip
+          HistoricFile.new("#{prefix}#{name}", directory, self)
+        end
+      end
+    end
 
     def apply_label(label)
       cvs(@checkout_dir, "tag -c #{label}")
@@ -236,9 +260,6 @@ module RSCM
     end
 
     def parse_log(cmd, &proc)
-      logged_command_line = command_line(cmd, hidden_password)
-      yield logged_command_line if block_given?
-
       execed_command_line = command_line(cmd, password)
       revisions = nil
       with_working_dir(@checkout_dir) do
@@ -274,14 +295,6 @@ module RSCM
       "checkout #{branch_option} -d #{target_dir} #{revision_option(to_identifier)} #{mod}"
     end
     
-    def hidden_password
-      if(password && password != "")
-        "********"
-      else
-        ""
-      end
-    end
-  
     def period_option(from_identifier, to_identifier)
       if(from_identifier.nil? && to_identifier.nil?)
         ""

data/lib/rscm/scm/cvs_log_parser.rb

@@ -1,7 +1,7 @@
 require 'rscm/revision'
 require 'rscm/abstract_log_parser'
-
 require 'ftools'
+require 'time'
 
 module RSCM
 
@@ -14,14 +14,11 @@ module RSCM
     
     def initialize(io)
       super(io)
-      @log = ""
     end
   
     def parse_revisions
       revisions = Revisions.new
       while(log_entry = next_log_entry)
-        @log<<log_entry
-        @log<<""
         begin
           parse_files(log_entry, revisions)
         rescue Exception => e
@@ -91,7 +88,13 @@ module RSCM
       file.native_revision_identifier =  extract_match(file_entry_lines[0], /revision (.*)$/)
       
       file.previous_native_revision_identifier = determine_previous_native_revision_identifier(file.native_revision_identifier)
-      file.time = parse_cvs_time(extract_required_match(file_entry_lines[1], /date: (.*?)(;|$)/))
+
+      time = extract_required_match(file_entry_lines[1], /date: (.*?)(;|$)/)
+      if(time.strip.length == 19)
+        # CVS 1.11.x doesn't specify timezone (but assumes UTC), so we'll add it here.
+        time += " +0000"
+      end
+      file.time = Time.parse(time).utc
       file.developer = extract_match(file_entry_lines[1], /author: (.*?);/)
       
       state = extract_match(file_entry_lines[1], /state: (.*?);/)
@@ -128,13 +131,8 @@ module RSCM
       end
     end
     
-    def parse_cvs_time(time)
-      # 2003/11/09 15:39:25
-      Time.utc(time[0..3], time[5..6], time[8..9], time[11..12], time[14..15], time[17..18])
-    end
-    
     def extract_required_match(string, regexp)
-      if string=~regexp
+      if(string =~ regexp)
         return($1)
       else
         $stderr.puts("can't parse: '#{string}'\nexpected to match regexp: #{regexp.to_s}")

data/lib/rscm/scm/subversion.rb

@@ -104,6 +104,22 @@ module RSCM
       end
     end
 
+    def ls(relative_path)
+      prefix = relative_path == "" ? relative_path : "#{relative_path}/"
+      cmd = "svn ls #{url}/#{relative_path}"
+      Better.popen(cmd) do |io|
+        io.collect do |line|
+          name = line.strip
+          dir = false
+          if(name =~ /(.*)\/$/)
+            name = $1
+            dir = true
+          end
+          HistoricFile.new("#{prefix}#{name}", dir, self)
+        end
+      end
+    end
+
     def can_create_central?
       local?
     end

data/test/rscm/generic_scm_tests.rb

@@ -11,8 +11,8 @@ module RSCM
     def teardown
       if @scm
         begin
-          @scm.destroy_working_copy
-          @scm.destroy_central
+#          @scm.destroy_working_copy
+#          @scm.destroy_central
         rescue => e
           # Fails on windows with TortoiseCVS' cvs because of resident cvslock.exe
           STDERR.puts "Couldn't destroy central #{@scm.class.name}: #{e.message}"
@@ -40,6 +40,7 @@ module RSCM
     # 16) Verify that OtherWorkingCopy is now uptodate
     # 17) Add and commit a file in WorkingCopy
     # 18) Verify that the revision (since last revision) for CheckoutHereToo contains only one file
+    # 19) Get directory listings
     def test_basics
       work_dir = RSCM.new_temp_dir("basics")
       checkout_dir = "#{work_dir}/WorkingCopy"
@@ -140,13 +141,29 @@ module RSCM
 
       # 16
       assert(other_scm.uptodate?(nil))
+
+      # 17
       add_or_edit_and_commit_file(scm, checkout_dir, "src/java/com/thoughtworks/damagecontrolled/Hello.txt", "Bla bla")
       assert(!other_scm.uptodate?(nil))
       revisions = other_scm.revisions(revisions.latest.identifier)
+
+      # 18
       assert_equal(1, revisions.length)
       assert_equal(1, revisions[0].length)
-      assert("src/java/com/thoughtworks/damagecontrolled/Hello.txt", revisions[0][0].path)
-      assert("src/java/com/thoughtworks/damagecontrolled/Hello.txt", other_scm.checkout.sort[0])
+      assert_equal("src/java/com/thoughtworks/damagecontrolled/Hello.txt", revisions[0][0].path)
+      
+      # 19
+      root_children = scm.rootdir.children
+      assert_equal "build.xml", root_children[0].relative_path
+      assert !root_children[0].directory?
+      assert_equal "project.xml", root_children[1].relative_path
+      assert !root_children[1].directory?
+      assert_equal "src", root_children[2].relative_path
+      assert root_children[2].directory?
+
+      src_children = root_children[2].children
+      assert_equal "src/java", src_children[0].relative_path
+      assert src_children[0].directory?
     end
 
     def test_create_destroy
@@ -310,7 +327,7 @@ EOF
       assert(got_diff)
       
       # TODO: make separate test. Make helper method for the cumbersome setup!
-      historic_afile = scm.file("afile.txt")
+      historic_afile = scm.file("afile.txt", false)
       revision_files = historic_afile.revision_files
       assert_equal(Array, revision_files.class)
       assert(revision_files.length >= 2)

data/test/rscm/scm/cvs_log_parser_test.rb

@@ -14,10 +14,6 @@ module RSCM
       @parser.cvsmodule = "damagecontrol"
     end
     
-    def teardown
-      assert(!@parser.had_error?, "parser had errors") unless @parser.nil?
-    end
-    
     def test_read_log_entry
       assert_equal(nil, CvsLogParser.new(StringIO.new("")).next_log_entry)
     end
@@ -330,8 +326,6 @@ EOF
       assert_equal("website/templates/logo.gif", @parser.parse_path(LOG_ENTRY_FROM_06_07_2004_19_25_2))
     end
 
-# stand in picocontainer's java folder
-# cvs log -d"2003/07/25 12:38:41<=2004/07/08 12:38:41" build.xml
 LOG_WITH_DELETIONS= <<EOF
 RCS file: /home/projects/picocontainer/scm/java/Attic/build.xml,v
 Working file: build.xml
@@ -348,7 +342,7 @@ total revisions: 11;    selected revisions: 2
 description:
 ----------------------------
 revision 1.11
-date: 2003/10/13 00:04:54;  author: rinkrank;  state: dead;  lines: +0 -0
+date: 2003/10/13 00:04:54 -0500;  author: rinkrank;  state: dead;  lines: +0 -0
 Obsolete
 ----------------------------
 revision 1.10
@@ -363,8 +357,7 @@ EOF
       assert_equal(2, revisions.length)
 
       revision_delete = revisions[1]
-#      assert_equal("MAIN:rinkrank:20031013000454", revision_delete.revision)
-      assert_equal(Time.utc(2003,10,13,00,04,54,0), revision_delete.time)
+      assert_equal(Time.utc(2003,10,13,05,04,54,0), revision_delete.time)
       assert_equal("Obsolete", revision_delete.message)
       assert_equal("rinkrank", revision_delete.developer)
       assert_equal(1, revision_delete.length)
@@ -374,7 +367,6 @@ EOF
       assert(RevisionFile::DELETED, revision_delete[0].status)
 
       revision_fix_url = revisions[0]
-#      assert_equal("MAIN:rinkrank:20030725163239", revision_fix_url.revision)
       assert_equal(Time.utc(2003,07,25,16,32,39,0), revision_fix_url.time)
       assert_equal("fixed broken url (NANO-8)", revision_fix_url.message)
       assert_equal("rinkrank", revision_fix_url.developer)
@@ -472,8 +464,8 @@ EOF
 # https://sitemesh.dev.java.net/source/browse/sitemesh/.cvsignore
 # The default commit message probably showed up in vi, and the committer
 # probably just left it there. Not sure why CVS kept it this way
-# (lines starting with CVS: should be ignored in commit message afik).
-# Anyway, the parser nw knows how to deal with this. (AH)
+# (lines starting with CVS: should be ignored in commit message afaik).
+# Anyway, the parser now knows how to deal with this. (AH)
 LOG_WITH_WEIRD_CVS_AND_MANY_DASHES = <<EOF
 ? log.txt
 

data/test/rscm/scm/cvs_test.rb

@@ -2,6 +2,7 @@ require 'test/unit'
 require 'rscm/path_converter'
 require 'rscm'
 require 'rscm/generic_scm_tests'
+require 'stringio'
 
 module RSCM
 
@@ -28,5 +29,24 @@ module RSCM
       end
     end
     
+    LS_LOG = <<-EOF
+---- 2005-11-22 21:24:40 -0500 1.1        afile
+---- 2005-11-22 22:04:20 -0500 1.2        build.xml
+---- 2005-11-22 22:12:43 -0500 1.1        foo bar
+---- 2005-11-22 21:24:37 -0500 1.1.1.1    1.1 project.xml
+d--- 2005-11-22 22:12:43 -0500            1.1 src
+d--- 2005-11-22 22:12:43 -0500            togo
+EOF
+    def test_should_parse_ls_log
+      history_files = Cvs.new.parse_ls_log(StringIO.new(LS_LOG), "")
+      assert_equal("afile", history_files[0].relative_path)
+      assert_equal("foo bar", history_files[2].relative_path)
+      assert_equal("1.1 project.xml", history_files[3].relative_path)
+      assert(!history_files[3].directory?)
+      assert_equal("1.1 src", history_files[4].relative_path)
+      assert(history_files[4].directory?)
+      assert_equal("togo", history_files[5].relative_path)
+      assert(history_files[5].directory?)
+    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.14
-date: 2005-11-16
+  version: 0.3.15
+date: 2005-11-23
 summary: "RSCM - Ruby Source Control Management"
 require_paths: 
   - lib