projmgr 0.0.2 → 0.0.3

data/NEWS.md

@@ -1,3 +1,16 @@
+0.0.3 (January 09, 2011)
+===
+	- Added rspec tests for the Scm class
+	- Remove unnessesary requires from the library and moved them to the binary
+	- Add support for checkout/clone for SVN and GIT
+	- Add checks to see if the paths exist for each call that uses @path
+	- Optimized most of the code
+	
+0.0.2 (January 04, 2011)
+===
+	- Minor bug fixes/typos
+
 0.0.1 (December 27, 2010)
 ===
-	- Initial development
+	- Initial development
+	

data/README.md

@@ -9,8 +9,6 @@ Requirements
 * ruby 
 * rubygems
 * choice
-* yaml 
-
 
 Installation
 ---
@@ -32,16 +30,19 @@ This will create a empty skeleton config file, ~/.projmgr, edit this file. The f
 	  name: ruby-virustotal
 	  path: ~/Projects/public/ruby-virustotal
 	  type: git
+		url: git@github.com:hammackj/ruby-virustotal.git
 
 	nessusdb:
 	  name: nessusdb
 	  path: ~/Projects/public/nessusdb
 	  type: git
+		url: git@github.com:hammackj/nessusdb.git
 
 	projectname: 
 		name: 
 		path: 
 		type: 
+		url:
 
 To configure ProjMgr just change projectname/name/path/type to fit your projects. 
 
@@ -49,6 +50,7 @@ To configure ProjMgr just change projectname/name/path/type to fit your projects
 	name - any string displayed during update/checks
 	path - the path to the repo to check/update
 	type - type of the repo either 'svn' or 'git'
+	url - the original url of the repo
 
 Once the config file is edited everything is ready to go. 
 

data/Rakefile

@@ -1,4 +1,8 @@
 $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+
+require 'rake'
+require 'spec/rake/spectask'
+
 require "projmgr"
  
 task :build do
@@ -11,4 +15,12 @@ end
 
 task :clean do
 	system "rm *.gem"
-end
+	system "rm -rf coverage"
+end
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('examples_with_rcov') do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec,rcov']
+end

data/TODO.md

@@ -1,7 +1,15 @@
 TODO
 ===
 
-0.0.2
+0.0.4
 ---
-	- Add support for other SCM's besides git and svn
-	- Create rSpec tests for everything
+	- Add a detect option, to find projects in a directory not managed
+	- Add support for other SCM's
+		- CVS
+		- Mercurial	
+	- Add more rspec tests		
+		- Git Class
+		- Svn Class
+		- Application class
+		- Cvs Class
+		

data/bin/projmgr

@@ -7,6 +7,7 @@
 # 
 # hammackj - 12-27-2010 - Version 0.0.1
 # hammackj - 01-05-2011 - Version 0.0.2
+# hammackj - 01-09-2011 - Version 0.0.3
 #
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '/../lib'))
@@ -15,6 +16,9 @@ $stdout.sync = true
 $stderr.sync = true
 
 require 'rubygems'
+require 'choice'
+require 'yaml'
+
 require 'projmgr'
 
 module ProjMgr
@@ -27,7 +31,7 @@ module ProjMgr
 		# Creates a ProjMgr instance
 		#
 		def initialize
-			@root = `pwd`
+			@root = `pwd`.chomp
 		end
 		
 		# Main class for the ProjMgr command line tool
@@ -37,7 +41,7 @@ module ProjMgr
 				banner "#{APP_NAME} - v#{VERSION}" 
 				header 'Jacob Hammack'
 				header 'http://hammackj.com'
-				header 'Usage: #{APP_NAME} [OPTIONS]'
+				header "Usage: #{APP_NAME} [OPTIONS]"
 				header ''
 
 				option :check_local_changes do
@@ -52,6 +56,11 @@ module ProjMgr
 					desc 'Updates each configured scm repository'
 				end
 				
+				option :checkout do
+					long '--checkout-repos'
+					desc "Checks out each repo if nothing exists at the 'path' variable"
+				end
+				
 				option :create_config do
           long '--create-config'
           desc 'Creates a skeleton config file to use'
@@ -59,7 +68,7 @@ module ProjMgr
 						if File.exists?(File.expand_path(CONFIG_FILE)) == false
 							File.open(File.expand_path(CONFIG_FILE), 'w+') do |f| 
 								3.times do
-									f.write("projectname: \n\tname: \n\tpath: \n\ttype: \n\n") 
+									f.write("projectname: \n\tname: \n\tpath: \n\ttype: \n\turl: \n\n") 
 								end
 							end
 
@@ -110,20 +119,30 @@ module ProjMgr
 					@repos.each_key do |key|
 						t = Thread.new do
 							if @repos[key]['type'] == "svn"
-								repo = Svn.new @repos[key]['name'], @repos[key]['path'], @repos[key]['root']
+								repo = Svn.new @repos[key]['name'], @repos[key]['path'], @root, @repos[key]['url']
 							elsif @repos[key]['type'] == "git"
-								repo = Git.new @repos[key]['name'], @repos[key]['path'], @repos[key]['root']
+								repo = Git.new @repos[key]['name'], @repos[key]['path'], @root, @repos[key]['url']
+							#elsif @repos[key]['type'] == "cvs"
+							#	repo = Cvs.new @repos[key]['name'], @repos[key]['path'], @repos[key]['root'], @repos[key]['url']
 							end
-					
+										
 							if repo == nil
-									puts "[!] #{key} is a malformed entry please correct it."
+									print "[!] #{key} is a malformed entry please correct it.\n"
 									next
 							end
 															
 							if Choice.choices[:check_local_changes] != nil
-								puts "[!] #{@repos[key]['name']} has local changes" if repo.has_local_changes?
+								status = repo.has_local_changes?
+																
+								if status[0] == true
+									print "[!] #{@repos[key]['name']} has local changes\n"
+								else
+									print "[!] #{@repos[key]['name']} #{status[1]}\n"
+								end
 							elsif Choice.choices[:update] != nil
-								puts "[*] Updating #{@repos[key]['name']}...\n #{repo.update}"
+								print "[*] Updating #{@repos[key]['name']}...\n #{repo.update}\n"
+							elsif Choice.choices[:checkout] != nil
+								print "[*] Checking out #{@repos[key]['name']}...#{repo.checkout}\n"
 							end
 						end
 						@threads << t
@@ -133,7 +152,8 @@ module ProjMgr
 						t.join 
 					end
 				rescue Exception => e
-					puts "[!] Caught Exception: #{e.inspect}"
+					puts "[!] Caught Exception, if you feel this is a error please report it at http://github.com/hammackj/projmgr/issues\n"
+					puts "#{e.inspect}\n #{e.backtrace}"
 				end
 			end
 		end

data/lib/projmgr.rb

@@ -1,13 +1,12 @@
+# encoding: utf-8
 
 module ProjMgr
 	APP_NAME = "projmgr"
-	VERSION = "0.0.2"
+	VERSION = "0.0.3"
 	CONFIG_FILE = "~/.projmgr"
 end
 
-require 'choice'
-require 'yaml'
-
+require 'projmgr/scm'
 require 'projmgr/git'
 require 'projmgr/svn'
-require 'projmgr/scm'
+require 'projmgr/cvs'

data/lib/projmgr/cvs.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'projmgr/scm'
+
+module ProjMgr
+	
+	# A wrapper class for interacting with a cvs repository
+	#
+	# @author Jacob Hammack <jacob.hammack@hammackj.com>
+	class Cvs < Scm
+		
+		# Checks out a cvs repo and places it, in the path specified by the @path variable
+		#
+		# @return [String] The results from the 'cvs co' command
+		def checkout
+			results = `cd #{@path} && cd .. && cvs co #{@url} && cd #{@root}`
+			
+			return results
+		end
+
+		# Checks for updates in the target repo
+		# 
+		# @return [String] the results of 'git pull' on the target repository
+		def update
+	  	results = `cd #{@path} && cvs update -dPA && cd #{@root}`
+
+	  	if results =~ /Already up-to-date./
+	  	  return "Already up-to-date!\n"
+	  	else
+	  	  return results  	  
+		  end
+		end
+		
+		# Checks for local changes in the target repository
+		#
+		# @return [Boolean] if there is local changes or not
+		def has_local_changes?
+		  results = `cd #{@path} && cvs status && cd #{@root}`
+
+		  #if results !~ /nothing to commit/ 
+			#	return true
+			#elsif results =~ /Your branch is ahead of/
+			#	return true
+			#elsif results =~ /Untracked files/
+			#	return true
+		  #else
+				return false
+			#end
+		end
+	end	
+end

data/lib/projmgr/git.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'projmgr/scm'
 
 module ProjMgr
@@ -6,34 +8,60 @@ module ProjMgr
 	#
 	# @author Jacob Hammack <jacob.hammack@hammackj.com>
 	class Git < Scm
+		alias :checkout :clone
 
-		# Checks for updates in the target repo
+		# Checks out a git repo and places it, in the path specified by the @path variable
+		#
+		# @return [String] The results from the 'git clone' command
+		def checkout
+			if path_exists? == true
+				return "path exists, cannot checkout onto an existing repo"
+			else
+				parent = project_parent_directory
+				
+				cmd = IO.popen "cd #{parent} && git clone #{@url} &> /dev/null && cd #{@root}"
+				results = cmd.readlines
+				cmd.close
+				
+				return "project checked out to #{parent}/#{@project}"
+			end
+		end
+
+		# Checks for updates in the target repository
 		# 
 		# @return [String] the results of 'git pull' on the target repository
 		def update
-	  	results = `cd #{@path} && git pull && cd #{@root}`
-
-	  	if results =~ /Already up-to-date./
-	  	  return "Already up-to-date!\n"
-	  	else
-	  	  return results  	  
-		  end
+			if path_exists? == false
+				return "path does not exists, cannot update repository"
+			else
+	  		results = `cd #{@path} && git pull && cd #{@root}`
+			
+		  	if results =~ /Already up-to-date./
+		  	  return "Already up-to-date!\n"
+		  	else
+		  	  return results  	  
+			  end
+			end
 		end
 		
 		# Checks for local changes in the target repository
 		#
 		# @return [Boolean] if there is local changes or not
 		def has_local_changes?
-		  results = `cd #{@path} && git status && cd #{@root}`
+			if path_exists? == false				
+				return false, "path does not exists, please check the path or check it out"
+			else
+			  results = `cd #{@path} && git status && cd #{@root}`
 
-		  if results !~ /nothing to commit/ 
-				return true
-			elsif results =~ /Your branch is ahead of/
-				return true
-			elsif results =~ /Untracked files/
-				return true
-		  else
-				return false
+			  if results !~ /nothing to commit/ 
+					return true, "has local changes"
+				elsif results =~ /Your branch is ahead of/
+					return true, "has local changes"
+				elsif results =~ /Untracked files/
+					return true, "has local changes"
+			  else
+					return false, "has no local changes"
+				end
 			end
 		end
 	end	

data/lib/projmgr/scm.rb

@@ -1,20 +1,50 @@
+# encoding: utf-8
+
+require 'pathname'
+
 module ProjMgr
 	
 	# A parent class for interacting with a source code repository
 	#
 	# @author Jacob Hammack <jacob.hammack@hammackj.com>
 	class Scm
+		attr_accessor :project, :path, :root, :url
 		
 		# Creates a instance of a SCM repository
 		#
 		# @param project name of the project
 		# @param path path to the project
 		# @param root path back to the root
+		# @param url url of the repo for checkout/etc
 		#
-		def initialize project, path, root
+		# @return [Scm] returns a new instance of the Scm class
+		def initialize project=nil, path=nil, root=nil, url=nil
 			@project = project
 			@path = path
 			@root = root
-		end	
+			@url = url
+		end
+		
+		# Checks to see if a path exists 
+		#
+		# @return [Boolean] True or False based on if the @path exists
+		def path_exists?
+			return File.exists?(File.expand_path(@path))
+		end
+		
+		# Retrieves the parent directory of a path
+		#
+		# @return [String] parent directory of the @path variable
+		def project_parent_directory
+			pn = Pathname.new @path	
+			return pn.parent.to_s
+		end
+		
+		# Overloaded inspect
+		#
+		# @return [String] A representation of the class as a string
+		def inspect
+			return "Project: #{@project}\n" + "Path: #{@path}\n" + "Root: #{@root}\n" + "Url: #{@url}\n"
+		end
 	end
 end

data/lib/projmgr/svn.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'projmgr/scm'
 
 module ProjMgr
@@ -7,24 +9,52 @@ module ProjMgr
 	# @author Jacob Hammack <jacob.hammack@hammackj.com>
 	class Svn < Scm
 		
+		# Checks out a svn repo and places it, in the path specified by the @path variable
+		#
+		# @return [String] The results from the 'svn checkout' command
+		def checkout
+			if path_exists? == true
+				return "path exists, cannot checkout onto an existing repo"
+			else		
+				parent = project_parent_directory	
+				
+				results = `cd #{parent} && svn checkout #{@url} #{@project} && cd #{@root}`
+				
+				if results =~ /Could not resolve hostname/
+					return "unable to resolve hostname"
+				else
+					return "project checked out to #{parent}/#{@project}"
+				end
+			end
+		end
+		
 		# Checks for updates in the target repo
 		# 
 		# @return [String] the results of 'git pull' on the target repository
 		def update
-		  results = `cd #{@path}  && svn stat && svn update && cd #{@root}`
-		  return results
+			if path_exists? == true
+		  	results = `cd #{@path} && svn stat && svn update && cd #{@root}`
+			else		
+				return "path does not exists, cannot update repository"
+		  end
+		
+			return results
 		end
 
 		# Checks for local changes in the target repository
 		#
 		# @return [Boolean] if there is local changes or not
 		def has_local_changes?
-			results = `cd #{@path} && svn stat && cd #{@root}`
-			
-			if results.length > 0
-				return true
-			else
-				return false
+			if path_exists? == false
+				return false, "Path does not exists, please check the path or check it out"
+			else 
+				results = `cd #{@path} && svn stat && cd #{@root}`
+								
+				if results.length > 0
+					return true, "has local changes"
+				else
+					return false, "has no local changes"
+				end
 			end
 		end
 	end

data/projmgr.gemspec

@@ -6,25 +6,26 @@ $:.unshift(File.join(File.dirname(base), 'lib'))
 require 'projmgr'
 
 Gem::Specification.new do |s|
-	s.name 									= 'projmgr'
+	s.name 									= ProjMgr::APP_NAME
 	s.version 							= ProjMgr::VERSION
 	s.homepage 							= "http://github.com/hammackj/projmgr/"
-	s.summary 							= "ProjMgr"
-	s.description 					= "ProjMgr is a source code managment tool for automating project managment"
+	s.summary 							= ProjMgr::APP_NAME
+	s.description 					= "#{ProjMgr::APP_NAME} is a source code managment tool for automating project managment"
 	s.license								= "BSD"
 	
 	s.author 								= "Jacob Hammack"
 	s.email 								= "jacob.hammack@hammackj.com"
 	
 	s.files 								= Dir['[A-Z]*'] + Dir['lib/**/*'] + ['projmgr.gemspec']
-	s.default_executable 		= 'projmgr'
-	s.executables 					= ['projmgr']
+	s.default_executable 		= ProjMgr::APP_NAME
+	s.executables 					= [ProjMgr::APP_NAME]
 	s.require_paths 				= ["lib"]
 	
 	s.required_rubygems_version = ">= 1.3.6"
-	s.rubyforge_project         = "projmgr"
+	s.rubyforge_project         = ProjMgr::APP_NAME
 	
 	s.add_development_dependency "rspec"
+	s.add_development_dependency "rcov"
 	
 	s.has_rdoc 							= 'yard'
 	s.extra_rdoc_files 			= ["README.md", "LICENSE", "NEWS.md", "TODO.md"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: projmgr
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Jacob Hammack
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-04 00:00:00 -06:00
+date: 2011-01-09 00:00:00 -06:00
 default_executable: projmgr
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,9 +33,23 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: choice
+  name: rcov
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: choice
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -47,8 +61,8 @@ dependencies:
         - 4
         version: 0.1.4
   type: :runtime
-  version_requirements: *id002
-description: ProjMgr is a source code managment tool for automating project managment
+  version_requirements: *id003
+description: projmgr is a source code managment tool for automating project managment
 email: jacob.hammack@hammackj.com
 executables: 
 - projmgr
@@ -65,6 +79,7 @@ files:
 - Rakefile
 - README.md
 - TODO.md
+- lib/projmgr/cvs.rb
 - lib/projmgr/git.rb
 - lib/projmgr/scm.rb
 - lib/projmgr/svn.rb
@@ -106,6 +121,6 @@ rubyforge_project: projmgr
 rubygems_version: 1.4.1
 signing_key: 
 specification_version: 3
-summary: ProjMgr
+summary: projmgr
 test_files: []