svnutils 0.1.0

data/lib/LICENSE

@@ -0,0 +1,10 @@
+Copyright (c) 2006, Christopher Maujean and project contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+    * Neither the name of the NGSLib nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/svnutils.rb

@@ -0,0 +1,90 @@
+# $Id: svnutils.rb 45 2006-08-13 23:58:26Z cmaujean $
+# See LICENSE for copyright information
+
+require 'ostruct'
+
+#
+# use the svn Id Keyword expansion to report svn file information
+# revision, developer, filename, date and time of last revision.
+# 
+
+class SVNUtils
+	@@files = Hash.new
+
+	# get the svn version of a file
+	def SVNUtils.revision(target_file)
+		if not @@files[target_file]
+			parse_file(target_file)
+		end
+		return @@files[target_file].revision
+	end
+
+	# get the last developer who checked in the file
+	def SVNUtils.developer(target_file)
+		if not @@files[target_file]
+			parse_file(target_file)
+		end
+		return @@files[target_file].developer
+	end
+
+	# get the svn filename of the file
+	def SVNUtils.filename(target_file)
+		if not @@files[target_file]
+			parse_file(target_file)
+		end
+		return @@files[target_file].filename
+	end
+
+ # get the date the last revision was made to the file 
+ def SVNUtils.date(target_file)
+		if not @@files[target_file]
+			parse_file(target_file)
+		end
+		return @@files[target_file].date
+	end
+
+	# get the time the last revision was made to the file
+	def SVNUtils.time(target_file)
+		if not @@files[target_file]
+			parse_file(target_file)
+		end
+		return @@files[target_file].time
+	end
+
+
+	# parse the file, so we can get its values
+	def SVNUtils.parse_file(target_file)
+		if not File.exist?(target_file)
+			raise SVNUtils::FileNotFound, target_file
+		end
+
+		# get first id from the file
+		File.readlines(target_file).each do |line|
+			match = []
+			match = line.scan(/\$Id:(.+)\$/)  
+			if not match[0].nil?
+				matchset = match[0][0].strip.split(" ")
+				@@files[target_file] = OpenStruct.new 
+				m = @@files[target_file]
+				m.filename, m.revision, m.date, m.time, m.developer = matchset 
+				break
+			end
+		end
+    
+    # what if there is no Id tag in the given file?
+    if @@files[target_file].nil?
+      @@files[target_file]           = OpenStruct.new
+      @@files[target_file].filename  = "No ID tag found"
+      @@files[target_file].revision  = "No ID tag found"
+      @@files[target_file].date      = "No ID tag found"
+      @@files[target_file].time      = "No ID tag found"
+      @@files[target_file].developer = "No ID tag found"
+      
+    end
+  end
+end
+
+class SVNUtils::FileNotFound < RuntimeError
+end
+
+# vi:sw=2 ts=2

data/test/tc_svnutils.rb

@@ -0,0 +1,64 @@
+require 'test/unit'
+require 'svnutils'
+require 'fileutils'
+
+class TestSVNUtils < Test::Unit::TestCase
+  def setup
+   # put the testfile down.
+   f = File.new('svnutils/test/data/testfile', "w+")
+   f.puts
+   f.puts("$Id: testfile 42 2006-08-13 23:18:33Z cmaujean $")
+   f.puts
+   f.close
+
+   # put the empty file down
+   f = File.new('svnutils/test/data/noidfile', "w+")
+   f.puts;f.puts;f.puts;f.puts "This ain't no disco";f.puts
+  end
+  
+  # utility method for testing 
+  def kill_file
+    # clean up the test/data/testfile file 
+    FileUtils.rm("svnutils/test/data/testfile")
+  end
+
+  def teardown
+    FileUtils.rm('svnutils/test/data/noidfile')
+  end
+
+
+  def test_id_functions
+    testfile = 'svnutils/test/data/testfile'
+
+    # test exception throwing
+    assert_raise SVNUtils::FileNotFound do
+      version = SVNUtils::revision('test/data/thisfileisnothere')
+    end
+    
+    assert_nothing_raised do 
+      version = SVNUtils::revision(testfile)
+    end
+    
+    # test no id tag in file
+    noidversion = SVNUtils::revision('svnutils/test/data/noidfile')
+    assert_equal "No ID tag found", noidversion, "No ID Version should be: No ID tag found"
+
+    # test individual data
+    version = SVNUtils::revision(testfile)
+    assert_equal "42", version, "Version extracted: #{version}"
+    
+    # lets see if we kept the file data
+    kill_file()
+    version   = SVNUtils::revision(testfile)
+    developer = SVNUtils::developer(testfile)
+    date      = SVNUtils::date(testfile)
+    time      = SVNUtils::time(testfile)
+    filename  = SVNUtils::filename(testfile)
+    
+    assert_equal "42",         version,   "Version extracted: #{version}"
+    assert_equal "cmaujean",   developer, "Developer extracted: #{developer}"
+    assert_equal "2006-08-13", date,      "Date extracted: #{date}"
+    assert_equal "23:18:33Z",  time,      "Time extracted: #{time}"
+    assert_equal "testfile",   filename,  "Filename extracted: #{filename}"
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: svnutils
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2006-08-13 00:00:00 -07:00
+summary: a read only, line oriented, sparse file class
+require_paths: 
+- lib
+email: cmaujean@gmail.com
+homepage: http://rubyforge.org/projects/ngslib
+rubyforge_project: 
+description: 
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Christopher Maujean
+files: 
+- lib/svnutils.rb
+- lib/LICENSE
+- test/data
+- test/tc_svnutils.rb
+test_files: 
+- test/tc_svnutils.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+