rscm 0.3.4 → 0.3.5

data/CHANGES

@@ -1,11 +1,21 @@
 = RSCM Changelog
 
+== Version 0.3.5
+
+This release adds new API methods for accessing files and their revisions and contents.
+
+* Added new scm.history_file method (returning RSCM::HistoryFile).
+* Added RSCM::HistoryFile.revision_files methods to get all revisions of a file.
+* Added RSCM::RevisionFile.open to get the contents of a specific revision of a file.
+* Set defaults for Subversion username/password
+* Removed logging code (may reintroduce later if I come up with a better way to configure it)
+
 == Version 0.3.4
 
 This release fixes some bugs on windows.
 
 * Removed redirection to dev/null for CVS commands. 2>nul didn't seem to work on windows.
-* Fixed a the path to touch.exe
+* Fixed the path to touch.exe (needed in tests)
 
 == Version 0.3.3
 

data/README

@@ -1,4 +1,4 @@
-= RSCM - Ruby Source Control Management (0.3.4)
+= RSCM - Ruby Source Control Management (0.3.5)
 
 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.4' + PKG_BUILD
+PKG_VERSION   = '0.3.5' + PKG_BUILD
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 
 desc "Default Task"
@@ -134,7 +134,8 @@ task :release_files => [:gem] do
   end
 end
 
-task :publish_doc => [:rdoc] do
+desc "Publish docs/website"
+task :publish_doc  do
   publisher = Rake::RubyForgePublisher.new(PKG_NAME, ENV['RUBYFORGE_USER'])
   publisher.upload
 end

data/lib/rscm/base.rb

@@ -20,6 +20,7 @@ module RSCM
   # * move
   # * revisions
   # * uptodate?
+  # * file
   #
   # In addition to operations related to working copies, the same instance should provide
   # methods to administer the working copy's associated 'central' repository. These are:
@@ -77,8 +78,14 @@ module RSCM
 
   public
   
-    attr_accessor :checkout_dir
+    def checkout_dir=(dir)
+      @checkout_dir = PathConverter.filepath_to_nativepath(dir, false)
+    end
   
+    def checkout_dir
+      @checkout_dir
+    end
+
     def to_yaml_properties
       props = instance_variables
       props.delete("@checkout_dir")
@@ -144,7 +151,7 @@ module RSCM
     # Commit (check in) modified files.
     def commit(message)
     end
-
+    
     # Checks out or updates contents from a central SCM to +checkout_dir+ - a local working copy.
     # If this is a distributed SCM, this method should create a 'working copy' repository
     # if one doesn't already exist. Then the contents of the central SCM should be pulled into
@@ -186,9 +193,10 @@ module RSCM
     end
   
     # Returns a Revisions object for the period specified by +from_identifier+ (exclusive, i.e. after)
-    # and +to_identifier+ (inclusive).
+    # and +to_identifier+ (inclusive). If +relative_path+ is specified, the result will only contain
+    # revisions pertaining to that path.
     #
-    def revisions(from_identifier, to_identifier=Time.infinity)
+    def revisions(from_identifier, to_identifier=Time.infinity, relative_path=nil)
       # Should be overridden by subclasses
       revisions = Revisions.new
       revisions.add(
@@ -206,6 +214,11 @@ module RSCM
       )
       revisions
     end
+    
+    # Returns a HistoricFile for +relative_path+
+    def file(relative_path)
+      HistoricFile.new(relative_path, self)
+    end
 
     # Whether the working copy is in synch with the central
     # repository's revision/time identified by +identifier+. 

data/lib/rscm/better.rb

@@ -1,10 +1,6 @@
 module RSCM
   class Better
-    @@logger = nil
-    @@logger = RSCM_DEFAULT_LOGGER
-    
     def self.popen(cmd, mode="r", expected_exit=0, &proc)
-      @@logger.info "Executing command: '#{cmd}'" if @@logger
       ret = IO.popen(cmd, mode) do |io|
         proc.call(io)
       end

data/lib/rscm/historic_file.rb

@@ -0,0 +1,22 @@
+module RSCM
+  # Represents the full history of a single file
+  class HistoricFile
+    def initialize(relative_path, scm)
+      @relative_path, @scm = relative_path, scm
+    end
+    
+    # Returns an Array of RevisionFile - from Time.epoch until Time.infinity (now)
+    def revision_files
+      @scm.revisions(Time.epoch, Time.infinity, @relative_path).collect do |revision|
+        if revision.files.length != 1
+          files_s = revision.files.collect{|f| f.to_s}.join("\n")
+          raise "The file-specific revision didn't have exactly one file, but #{revision.files.length}:\n#{files_s}"
+        end
+        if(revision.files[0].path != @relative_path)
+          raise "The file-specific revision didn't have expected path #{@relative_path}, but #{revision.files[0].path}"
+        end
+        revision.files[0]
+      end
+    end
+  end
+end

data/lib/rscm/logging.rb

@@ -6,14 +6,3 @@ if(WINDOWS)
 else
   HOMEDIR = ENV['HOME']
 end
-
-begin
-  RSCM_DEFAULT_LOGGER = Logger.new("#{HOMEDIR}/.rscm.log")
-rescue StandardError
-  RSCM_DEFAULT_LOGGER = Logger.new(STDERR)
-  RSCM_DEFAULT_LOGGER.level = Logger::WARN
-  RSCM_DEFAULT_LOGGER.warn(
-    "RSCM Error: Unable to access log file. Please ensure that #{HOMEDIR}/.rscm.log exists and is chmod 0666. " +
-    "The log level has been raised to WARN and the output directed to STDERR until the problem is fixed."
-  )
-end

data/lib/rscm/revision_file.rb

@@ -20,10 +20,17 @@ module RSCM
     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
     end
+    
+    # Returns/yields an IO containing the contents of this file, using +scm+ this
+    # file lives in.
+    def open(scm, &block)
+      scm.open(self, &block)
+    end
   
     def accept(visitor)
       visitor.visit_file(self)

data/lib/rscm/scm/cvs.rb

@@ -1,3 +1,4 @@
+require 'stringio'
 require 'rscm/base'
 require 'rscm/path_converter'
 require 'rscm/line_editor'
@@ -91,9 +92,9 @@ module RSCM
       files.empty?
     end
 
-    def revisions(from_identifier, to_identifier=Time.infinity)
+    def revisions(from_identifier, to_identifier=Time.infinity, relative_path=nil)
       checkout(to_identifier) unless uptodate?(to_identifier) # must checkout to get revisions
-      parse_log(changes_command(from_identifier, to_identifier))
+      parse_log(changes_command(from_identifier, to_identifier, relative_path))
     end
     
     def diff(change)
@@ -112,6 +113,15 @@ module RSCM
       end
     end
     
+    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|
+          block.call io
+        end
+      end
+    end
+
     def apply_label(label)
       cvs(@checkout_dir, "tag -c #{label}")
     end
@@ -241,10 +251,10 @@ module RSCM
       revisions
     end
 
-    def changes_command(from_identifier, to_identifier)
+    def changes_command(from_identifier, to_identifier, relative_path)
       # https://www.cvshome.org/docs/manual/cvs-1.11.17/cvs_16.html#SEC144
       # -N => Suppress the header if no RevisionFiles are selected.
-      "log #{branch_option} -N #{period_option(from_identifier, to_identifier)}"
+      "log #{branch_option} -N #{period_option(from_identifier, to_identifier)} #{relative_path}"
     end
 
     def branch_specified?

data/lib/rscm/scm/subversion.rb

@@ -20,6 +20,10 @@ module RSCM
     ann :tip => "If you use ssh, specify the URL as svn+ssh://username@server/path/to/repo"
     attr_accessor :url
 
+    ann :description => "Path"
+    ann :tip => "You only need to specify this if you want to be able to automatically create the repository. This should be the relative path from the start of the repository <br>to the end of the URL. For example, if your URL is <br>svn://your.server/path/to/repository/path/within/repository <br>then this value should be path/within/repository."
+    attr_accessor :path
+
     ann :description => "Username"
     ann :tip => "This only applies to svn:// URLs."
     attr_accessor :username
@@ -28,12 +32,14 @@ module RSCM
     ann :tip => "This only applies to svn:// URLs."
     attr_accessor :password
 
-    ann :description => "Path"
-    ann :tip => "You only need to specify this if you want to be able to automatically create the repository. This should be the relative path from the start of the repository <br>to the end of the URL. For example, if your URL is <br>svn://your.server/path/to/repository/path/within/repository <br>then this value should be path/within/repository."
-    attr_accessor :path
-
     def initialize(url="", path="")
       @url, @path = url, path
+      @username = ""
+      @password = ""
+    end
+    
+    def to_yaml_properties
+      ["@url", "@password", "@username", "@password"]
     end
 
     def add(relative_filename)
@@ -70,10 +76,13 @@ 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 = native_absolute_path[native_checkout_dir.length+1..-1].chomp
-# not sure about this old code - this seems to work. keep it here till it's verified on win32
-              relative_path = absolute_path
-              relative_path = relative_path.gsub(/\\/, "/") if WINDOWS
+              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
               checked_out_files << relative_path
               yield relative_path if block_given?
             end
@@ -83,14 +92,6 @@ module RSCM
       checked_out_files
     end
 
-    def checkout_commandline
-      "svn checkout #{revision_option(nil)}"
-    end
-
-    def update_commandline
-      "svn update #{url} #{checkout_dir}"
-    end
-
     def uptodate?(identifier)
       if(!checked_out?)
         false
@@ -112,12 +113,18 @@ module RSCM
 
     def diff(file, &block)
       with_working_dir(@checkout_dir) do
-        cmd = "svn diff -r #{file.previous_native_revision_identifier}:#{file.native_revision_identifier} \"#{url}/#{file.path}\""
+        cmd = "svn diff --revision #{file.previous_native_revision_identifier}:#{file.native_revision_identifier} \"#{url}/#{file.path}\""
         Better.popen(cmd) do |io|
           return(yield(io))
         end
       end
     end
+    
+    def open(revision_file, &block)
+      Better.popen("svn cat --revision #{revision_file.native_revision_identifier} #{url}/#{revision_file.path}") do |io|
+        return(yield(io))
+      end
+    end
 
     def can_create_central?
       local?
@@ -190,13 +197,13 @@ module RSCM
       svn(dir, import_cmd)
     end
 
-    def revisions(from_identifier, to_identifier=Time.infinity)
+    def revisions(from_identifier, to_identifier=Time.infinity, relative_path="")
       # Return empty revision if the requested revision doesn't exist yet.
       return Revisions.new if(from_identifier.is_a?(Integer) && head_revision_identifier <= from_identifier)
 
       checkout_dir = PathConverter.filepath_to_nativepath(@checkout_dir, false)
       revisions = nil
-      command = "svn #{changes_command(from_identifier, to_identifier)}"
+      command = "svn #{changes_command(from_identifier, to_identifier, relative_path)}"
 
       with_working_dir(@checkout_dir) do
         Better.popen(command) do |stdout|
@@ -300,28 +307,29 @@ module RSCM
     end
     
     def checkout_command(to_identifier)
-      checkout_dir = "\"#{checkout_dir}\""
-      "checkout #{login_options} #{url} #{checkout_dir} #{revision_option(nil,to_identifier)}"
+      cd = "\"#{checkout_dir}\""
+      raise "checkout_dir not set" if cd == ""
+      "checkout #{login_options} #{url} #{cd} #{revision_option(nil,to_identifier)}"
     end
 
     def update_command(to_identifier)
       "update #{login_options} #{revision_option(nil,to_identifier)}"
     end
     
-    def changes_command(from_identifier, to_identifier)
+    def changes_command(from_identifier, to_identifier, relative_path)
       # http://svnbook.red-bean.com/svnbook-1.1/svn-book.html#svn-ch-3-sect-3.3
       # file_list = files.join('\n')
-# WEIRD cygwin bug garbles this!?!?!?!
-      cmd = "log --verbose #{login_options} #{revision_option(from_identifier, to_identifier)} #{url}"
+      full_url = relative_path ? "#{url}/#{relative_path}" : ""
+      cmd = "log --verbose #{login_options} #{revision_option(from_identifier, to_identifier)} #{full_url}"
       cmd
     end
 
     def login_options
       result = ""
-      u = @username ? @username.strip : nil
-      p = @password ? @password.strip : nil
-      result << "--username #{u} " if u
-      result << "--password #{p} " if p
+      u = @username ? @username.strip : ""
+      p = @password ? @password.strip : "
+      result << "--username #{u} " unless u == ""
+      result << "--password #{p} " unless p == ""
       result
     end
 

data/lib/rscm.rb

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

data/test/rscm/generic_scm_tests.rb

@@ -10,7 +10,12 @@ module RSCM
 
     def teardown
       if @scm
-#        @scm.destroy_central
+        begin
+          @scm.destroy_centra
+        rescue => e
+          # Fails on windows with TortoiseCVS' cvs because of resident cvslock.exe
+          STDERR.puts "Couldn't destroy central #{@scm.class.name}"
+        end
       end
     end
 
@@ -252,7 +257,7 @@ module RSCM
 +five six
 EOF
     
-    def test_diffs
+    def test_diffs_and_historic_file
       work_dir = RSCM.new_temp_dir("diff")
       checkout_dir = "#{work_dir}/checkout"
       repository_dir = "#{work_dir}/repository"
@@ -302,6 +307,14 @@ EOF
         assert_match(/^\+five six/, diff_string)
       end
       assert(got_diff)
+      
+      # TODO: make separate test. Make helper method for the cumbersome setup!
+      historic_afile = scm.file("afile.txt")
+      revision_files = historic_afile.revision_files
+      assert_equal(Array, revision_files.class)
+      assert(revision_files.length >= 2)
+      assert(revision_files.length <= 3)
+      assert_equal("one two three four\nfive six\n", revision_files[-1].open(scm){|io| io.read})
     end
 
   private

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: rscm
 version: !ruby/object:Gem::Version 
-  version: 0.3.4
-date: 2005-09-18 00:00:00 -04:00
+  version: 0.3.5
+date: 2005-10-05 00:00:00 -04:00
 summary: "RSCM - Ruby Source Control Management"
 require_paths: 
   - lib
@@ -39,6 +39,7 @@ files:
   - lib/rscm/base.rb
   - lib/rscm/better.rb
   - lib/rscm/difftool.rb
+  - lib/rscm/historic_file.rb
   - lib/rscm/line_editor.rb
   - lib/rscm/logging.rb
   - lib/rscm/mockit.rb