tbgit 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79c2967cde856714bce60cf664f8be7adc3e7812
+  data.tar.gz: b566769fe5d56253d6592c84675fa535bc2772ca
+SHA512:
+  metadata.gz: d85851c9450b364b65c35dc0428f28a83e4f493835796ad076bad72220340b2496eb731cbe0640ff378bd3fa87bef8c9b5e2b3d184d718f28a6eb0be53f9d3ba
+  data.tar.gz: 6295061e28c79499a9aa8510f769479671eda32b2a08aaaccd20246da276f1fdbeb43edc92b9c1dc128235a85b5e778c5107ba3fc4ae3298d7a40cd660a5bd34

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tbgit.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Charlie Proctor
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# Tbgit
+
+TBGit is a command-line utility to facilitate the management of multiple GitHub student repositories.
+- created by Charlie Proctor at 2014 YEI Tech Bootcamp
+
+## Installation
+
+    $ gem install tbgit
+
+## Usage
+
+	Commands:
+		- setup   	sets up a tbgit environment. See decription below
+		- push  	pushes all local student branches to their remote master branches
+		- pull   	pulls all remote master branches to local student branches
+		- merge   	merges a specified branch with each student branch and then commits the changes
+		- status 	runs `git status` on each students branch and displays the results
+		
+		- add-remotes  	adds each student's repository as a remote
+		- create-locals 	creates a local branch to track the students remote master branch
+			- these are both part of the setup process
+
+##TBGit Environment
+- it's a regular git repository -- with lots of fancy features!
+- there is a master branch for teachers to work off of (create hw files, etc..)
+	- teachers can obviously create and work off other branches if desired
+- each student's repository is a remote of the git repo
+- there is a local branch to track each student's remote master branches
+
+##Setup
+1. Teachers create the student repositories (https://github.com/education/teachers_pet works perfectly well for this)
+	- initialize these repos with a README or push out a starter file.
+	- create a file with a list of the students github usernames (one on each line)
+		- you will need this during the setup process
+2. Teachers create a repo for themselves. This will serve as the base for the tbgit environment.
+3. Change to that repo's directory, execute `tbgit setup`, and follow the instructions.
+
+##A Typical Workflow
+1. Teachers create the assignment (on the master branch) and make a final commit when they're ready to deploy it
+2. Teachers pull all the students' repos to make sure they're up to date.
+	- `tbgit pull`
+3. Teachers merge their master branch with each student's local branch
+	- `tbgit merge`
+4. At this point, teachers should check to make sure their were no merge conflicts. If there were, go in and fix them.
+	- feel free to `git checkout <username>` a few different branches
+4. Teachers push each students local branch to the student's remote master branch
+	- `tbgit push`
+5. Make sure it worked.  Do a victory lap.
+
+To view student solutions at any point, just `tbgit pull` and `git checkout <username>`
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/tbgit/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/tbgit

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+require 'tbgit'
+
+tbgit = Main::TBGit.new
+
+case ARGV[0] 
+when "setup"
+	tbgit.gather
+
+	tbgit.add_remotes
+	tbgit.spacer
+
+	tbgit.git_update
+	tbgit.spacer
+
+	tbgit.create_local_tracking_remotes
+	tbgit.switch_to_master
+	tbgit.spacer
+
+	tbgit.git_remote
+	tbgit.spacer
+
+	tbgit.git_branch
+	tbgit.spacer
+when "pull"
+	tbgit.update_repos(ARGV[0])	
+when "push"
+	tbgit.update_repos(ARGV[0])	
+when "merge"
+	tbgit.merge_and_commit
+when "status"
+	tbgit.git_status
+when "add-remotes"
+	tbgit.gather
+	tbgit.spacer
+
+	tbgit.add_remotes
+when "create-locals"
+	tbgit.gather
+	tbgit.spacer
+	
+	tbgit.create_local_tracking_remotes
+else
+	tbgit.help
+end

data/lib/tbgit/version.rb

@@ -0,0 +1,3 @@
+module Tbgit
+  VERSION = "1.0.0"
+end

data/lib/tbgit.rb

@@ -0,0 +1,240 @@
+require "tbgit/version"
+require "tempfile"
+
+module Main
+
+  class TBGit
+
+  	def spacer
+  		puts "********************************************************************************"
+  	end
+
+  	#confirms a given message
+  	def confirm(message)
+  		print message + " (y/n)  "
+  		response = $stdin.gets.chomp
+  		if response == 'y'
+  			#do nothing
+  		else
+  			exit
+  		end
+  	end
+
+  	#three simple git methods
+	def switch_to_master
+		puts "git checkout master"
+		system "git checkout master"
+	end
+	def git_remote
+		puts "git remote"
+		system "git remote"
+	end
+	def git_branch
+		puts "git branch"
+		system "git branch"
+	end
+
+	#gather necessary information
+    def gather
+    	puts 'Students file |../students|:'
+    	@students_file = $stdin.gets.chomp
+    	if @students_file == ""
+    		@students_file = "../students"
+    	end
+
+    	puts 'Organization name |yale-stc-developer-curriculum|:'
+    	@organization = $stdin.gets.chomp
+    	if @organization == ""
+    		@organization = "yale-stc-developer-curriculum"
+    	end
+
+    	puts 'Student Repo Name |TechBootcampHomework|:'
+    	@reponame = $stdin.gets.chomp
+    	if @reponame == ""
+    		@reponame = "TechBootcampHomework"
+    	end
+    end
+
+    #update remotes
+	def git_update
+		puts "git remote update"
+ 		system "git remote update"
+ 	end
+
+    #add each student repository as a remote
+    def add_remotes
+    	confirm("Each student repository will be added as a remote. Continue?")
+    	students = IO.readlines(@students_file)
+    	students.each do |username|
+			username.delete!("\n")
+			
+			puts "Adding Remote: " + username 
+			remote_command = "git remote add " + username + " https://github.com/"+@organization+"/" + username + "-"+@reponame+".git" 
+			puts remote_command
+			system 	remote_command
+		end
+	end
+
+	#create local branches to track remote student repositories
+ 	def create_local_tracking_remotes
+ 		confirm("Local branches will be created to track remote student repositories. Continue?")
+ 	    students = IO.readlines(@students_file)
+ 		students.each do |username|
+			username.delete!("\n")
+
+			puts "Creating Local Branch to Track Remote: " + username 
+			checkout_command = "git checkout --track -b " + username + " remotes/" + username + "/master"
+			puts checkout_command
+			system  checkout_command
+
+		end
+
+	end
+
+	#returns a list of students
+  	def all_remotes_list
+  		remote_file = Tempfile.new("remotes")
+  		system "git remote >> " + remote_file.path
+
+  		puts "git remote >> " + remote_file.path
+
+  		return IO.readlines(remote_file)
+	end
+
+	#used for push / pull
+  	def update_repos(pushpull)
+  		if pushpull == "push"
+  			confirm("Each local student branch will be pushed to their remote master branch. Continue?")
+  		else
+  			confirm("Each remote student master branch will be pulled to the local branch. Continue?")
+		end
+
+		all_remotes = all_remotes_list
+  		all_remotes.each do |branch|
+  			branch.delete!("\n")
+
+  			if branch != "origin"
+	  			checkout_command = "git checkout " + branch 
+	  			if pushpull == "push"
+	  				pushpull_command = "git push " + branch + " " + branch + ":master"
+	  			else
+	  				pushpull_command = "git pull " + branch + " master"
+	  			end
+
+	  			puts checkout_command
+	  			system checkout_command
+
+	  			puts pushpull_command
+	  			system pushpull_command
+	  		end
+
+  		end
+	
+	  		switch_to_master
+  	
+  	end
+
+  	#merges from master (or another branch) to each student branch and commits the changes
+  	def merge_and_commit
+
+  		confirm("A merge and commit will be performed on each local student branch (from the branch you specify). Continue?")
+  		puts "Merge from branch: "
+  		merge_branch = $stdin.gets.chomp
+
+  		puts "Commit Message: "
+  		message = $stdin.gets.chomp
+
+  		all_remotes = all_remotes_list
+  		all_remotes.each do |branch|
+  			branch.delete!("\n")
+
+  			if branch != "origin"
+	  			checkout_command = "git checkout " + branch 
+	  			merge_command = "git merge --no-commit " + merge_branch.to_s
+	  		  	stage_changes = "git add --all"		
+	  			commit_command = "git commit -am '" + message + "'"
+
+	  			puts checkout_command
+	  			system checkout_command
+
+	  			puts merge_command
+	  			system merge_command
+
+	  			puts stage_changes
+	  			system stage_changes
+
+	  			puts commit_command
+	  			system commit_command
+	  		end
+
+  		end
+
+	  		switch_to_master
+
+  	end
+
+  	def git_status
+  		all_remotes = all_remotes_list
+  		all_remotes.each do |branch|
+  			branch.delete!("\n")
+
+  			puts "git status " + branch
+  			system "git status " + branch
+
+  		end
+  	end
+
+  	def help
+  		puts ""
+  		puts "TBGit is a command-line utility to facilitate the management of multiple GitHub student repositories."
+  		puts "			~ created by Charlie Proctor at 2014 YEI Tech Bootcamp"
+  		puts "						~ partly based off of https://github.com/education/teachers_pet"
+  		puts "	Commands:"
+  		puts "		~ setup   	sets up a tbgit environment. See decription below"
+  		puts "		~ push  	pushes all local student branches to their remote master branches"
+  		puts "		~ pull   	pulls all remote master branches to local student branches"
+  		puts "		~ merge   	merges a specified branch with each student branch and then commits the changes"
+  		puts "		~ status 	runs `git status` on each students branch and displays the results"
+  		puts ""
+  		puts "		~ add-remotes  	adds each student's repository as a remote"
+  		puts "		~ create-locals 	creates a local branch to track the students remote master branch"
+  		puts "			^----> these are both part of the setup process"
+  		puts ""
+  		puts "	TBGit Environment"
+  		puts "		~ it's a regular git repository -- with lots of fancy features!"
+  		puts "		~ there is a master branch for teachers to work off of (create hw files, etc..)"
+  		puts "				--> teachers can obviously create and work off other branches if desired"
+  		puts "		~ each student's repository is a remote of the git repo"
+  		puts "		~ there is a local branch to track each student's remote master branches"
+  		puts ""
+  		puts "	Setup"
+  		puts "		1. Teachers create the student repositories (https://github.com/education/teachers_pet works perfectly well for this)"
+  		puts "				--> make sure the repos are all private, but that you have access to them!"
+  		puts "				--> initialize these repos with a README or push out a starter file."
+  		puts "				--> create a file with a list of the students github usernames (one on each line)" 
+  		puts "						--- you will need this during the setup process"
+  		puts "		2. Teachers create a repo for themselves. This will serve as the base for the tbgit environment."
+  		puts "		3. Change to that repo's directory, execute `tbgit setup`, and follow the instructions."
+  		puts ""
+  		puts "	A Typical Workflow"
+  		puts "		1. Teachers create the assignment (on the master branch) and make a final commit when they're ready to deploy it"
+  		puts "		2. Teachers pull all the students' repos to make sure they're up to date."
+  		puts "				--> `tbgit pull`"
+  		puts "		3. Teachers merge their master branch with each student's local branch"
+  		puts "				--> `tbgit merge`"
+  		puts "		4. At this point, teachers should check to make sure their were no merge conflicts. If there were, go in and fix them."
+  		puts "				--> feel free to `git checkout <username>` a few different branches"
+  		puts "		4. Teachers push each students local branch to the student's remote master branch"
+  		puts "				--> `tbgit push`"
+  		puts "		5. Make sure it worked.  Do a victory lap."
+  		puts ""
+  		puts "		To view student solutions at any point, just `tbgit pull` and `git checkout <username>`"
+  		puts ""
+  	end
+
+
+
+
+
+  end #class
+end #module

data/tbgit.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tbgit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tbgit"
+  spec.version       = Tbgit::VERSION
+  spec.authors       = ["Charlie Proctor"]
+  spec.email         = ["charlie@charlieproctor.com"]
+  spec.summary       = %q{TBGit is a command-line utility to facilitate the management of multiple GitHub student repositories.}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = ["tbgit"]
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: tbgit
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Charlie Proctor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- charlie@charlieproctor.com
+executables:
+- tbgit
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/tbgit
+- lib/tbgit.rb
+- lib/tbgit/version.rb
+- tbgit.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: TBGit is a command-line utility to facilitate the management of multiple
+  GitHub student repositories.
+test_files: []