gitscrub 0.0.5 → 0.0.6

data/README.md

@@ -0,0 +1,82 @@
+#Gitscrub
+Git Your Game On
+
+##About
+Gitscrub is designed to give you a practical way of learning git.  It has a series of levels, each utilizing git commands to ensure a correct answer.
+
+##Installation
+To install Gitscrub
+
+    gem install gitscrub
+
+After the gem is installed, you can run `gitscrub` where you will be prompted to create a directory.
+
+##Commands
+
+Gitscrub has 3 commands:
+ * play - This is the default command and it will check your solution for the current level.
+ * hint - Gives you a hint (if available) for the current level
+ * reset - Reset the current level
+
+
+ ##Contributing
+ Get yourself on the [contributors list](https://github.com/Gazler/gitscrub/contributors) by doing the following:
+
+  * Fork the repository
+  * Make a level using the DSL (covered below)
+  * Add your level to the LEVELS array inside `lib/gitscrub/level.rb` in a position that makes sense (the "commit" level after the "add" and "init" levels for example)
+  * Make sure your level works (covered below)
+  * Submit a pull request
+
+##DSL
+
+Gitscrub has a DSL for writing levels
+
+An example level:
+
+    difficulty 1
+    description "There is a file in your folder called README, you should add it to your staging area"
+
+    setup do
+      repo.init
+      FileUtils.touch("README")
+    end
+
+    solution do
+      return false unless repo.status.files.keys.include?("README")
+      return false if repo.status.files["README"].untracked
+      true
+    end
+
+    hint do
+      puts "You can type `git` in your shell to get a list of available git commands"
+    end
+
+ `difficulty`, `description` and `solution` are required.
+
+ By default, `setup` will remove all files from the game folder.  You do not need to include a setup method if you don't want an initial git repository (if you are testing `git init` or only checking an answer.)
+ 
+ You can call `repo.init` to initialize an empty repository with a .gitignore file. It takes a single parameter of false if you want to skip the initial commit of the .gitignore file.
+
+ All methods called on `repo` are sent to the grit gem if the method does not existyou want to skip the initial commit of the .gitignore file.
+
+ All methods called on `repo` are sent to the [grit gem](https://github.com/mojombo/grit) if the method does not exist, and you can use that for most git related commands (`repo.add`, `repo.commit`, etc.)
+
+
+Another method exists called `init_from_level` and it is used like so:
+
+    setup do
+      init_from_level
+    end
+
+This will copy the contents of a repository specified in the levels folder for your level.  For example, if your level is called "merge" then it will copy the contents of the "merge" folder.  it is recommended that you do the following steps:
+
+ * mkdir "yourlevel"
+ * cd "yourlevel"
+ * git init
+ * some git stuff
+ * **important** rename ".git" to ".gitscrub" so it does not get treated as a submodule
+ * cd "../"
+ * git add "yourlevel"
+
+After doing this, your level should be able to copy the contents from that git repository and use those for your level.  You can see the "blame" level for an example of this.

data/levels/add.rb

@@ -2,13 +2,16 @@ difficulty 1
 description "There is a file in your folder called README, you should add it to your staging area"
 
 setup do
-  `git init`
-  `touch README`
+  repo.init
+  FileUtils.touch("README")
 end
 
 solution do
-  repo = Grit::Repo.new(".")
-  return false unless repo.status.files.keys == ["README"]
+  return false unless repo.status.files.keys.include?("README")
   return false if repo.status.files["README"].untracked
   true
 end
+
+hint do
+  puts "You can type `git` in your shell to get a list of available git commands"
+end

data/levels/blame.rb

@@ -0,0 +1,20 @@
+difficulty 2
+description "Someone has put a password inside the file 'config.rb' find out who it was"
+
+setup do
+  init_from_level
+end
+
+solution do
+
+  solved = false
+
+  offender = repo.commit("97bdd0cccf9f4b8730f78cb53a81a74f205dbcc2").author.name
+  solved = true if request("Who made the commit with the password?") == offender
+    
+  solved
+end
+
+hint do
+  puts "You want to research the `git blame` command"
+end

data/levels/blame/.gitscrub/COMMIT_EDITMSG

@@ -0,0 +1 @@
+added more options (no really)

data/levels/blame/.gitscrub/HEAD

@@ -0,0 +1 @@
+ref: refs/heads/master

data/levels/blame/.gitscrub/config

@@ -0,0 +1,5 @@
+[core]
+	repositoryformatversion = 0
+	filemode = true
+	bare = false
+	logallrefupdates = true

data/levels/blame/.gitscrub/description

@@ -0,0 +1 @@
+Unnamed repository; edit this file 'description' to name the repository.

data/levels/blame/.gitscrub/hooks/applypatch-msg.sample

@@ -0,0 +1,15 @@
+#!/bin/sh
+#
+# An example hook script to check the commit log message taken by
+# applypatch from an e-mail message.
+#
+# The hook should exit with non-zero status after issuing an
+# appropriate message if it wants to stop the commit.  The hook is
+# allowed to edit the commit message file.
+#
+# To enable this hook, rename this file to "applypatch-msg".
+
+. git-sh-setup
+test -x "$GIT_DIR/hooks/commit-msg" &&
+	exec "$GIT_DIR/hooks/commit-msg" ${1+"$@"}
+:

data/levels/blame/.gitscrub/hooks/commit-msg.sample

@@ -0,0 +1,24 @@
+#!/bin/sh
+#
+# An example hook script to check the commit log message.
+# Called by "git commit" with one argument, the name of the file
+# that has the commit message.  The hook should exit with non-zero
+# status after issuing an appropriate message if it wants to stop the
+# commit.  The hook is allowed to edit the commit message file.
+#
+# To enable this hook, rename this file to "commit-msg".
+
+# Uncomment the below to add a Signed-off-by line to the message.
+# Doing this in a hook is a bad idea in general, but the prepare-commit-msg
+# hook is more suited to it.
+#
+# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
+# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
+
+# This example catches duplicate Signed-off-by lines.
+
+test "" = "$(grep '^Signed-off-by: ' "$1" |
+	 sort | uniq -c | sed -e '/^[ 	]*1[ 	]/d')" || {
+	echo >&2 Duplicate Signed-off-by lines.
+	exit 1
+}

data/levels/blame/.gitscrub/hooks/post-commit.sample

@@ -0,0 +1,8 @@
+#!/bin/sh
+#
+# An example hook script that is called after a successful
+# commit is made.
+#
+# To enable this hook, rename this file to "post-commit".
+
+: Nothing

data/levels/blame/.gitscrub/hooks/post-receive.sample

@@ -0,0 +1,15 @@
+#!/bin/sh
+#
+# An example hook script for the "post-receive" event.
+#
+# The "post-receive" script is run after receive-pack has accepted a pack
+# and the repository has been updated.  It is passed arguments in through
+# stdin in the form
+#  <oldrev> <newrev> <refname>
+# For example:
+#  aa453216d1b3e49e7f6f98441fa56946ddcd6a20 68f7abf4e6f922807889f52bc043ecd31b79f814 refs/heads/master
+#
+# see contrib/hooks/ for a sample, or uncomment the next line and
+# rename the file to "post-receive".
+
+#. /usr/share/doc/git-core/contrib/hooks/post-receive-email

data/levels/blame/.gitscrub/hooks/post-update.sample

@@ -0,0 +1,8 @@
+#!/bin/sh
+#
+# An example hook script to prepare a packed repository for use over
+# dumb transports.
+#
+# To enable this hook, rename this file to "post-update".
+
+exec git update-server-info

data/levels/blame/.gitscrub/hooks/pre-applypatch.sample

@@ -0,0 +1,14 @@
+#!/bin/sh
+#
+# An example hook script to verify what is about to be committed
+# by applypatch from an e-mail message.
+#
+# The hook should exit with non-zero status after issuing an
+# appropriate message if it wants to stop the commit.
+#
+# To enable this hook, rename this file to "pre-applypatch".
+
+. git-sh-setup
+test -x "$GIT_DIR/hooks/pre-commit" &&
+	exec "$GIT_DIR/hooks/pre-commit" ${1+"$@"}
+:

data/levels/blame/.gitscrub/hooks/pre-commit.sample

@@ -0,0 +1,46 @@
+#!/bin/sh
+#
+# An example hook script to verify what is about to be committed.
+# Called by "git commit" with no arguments.  The hook should
+# exit with non-zero status after issuing an appropriate message if
+# it wants to stop the commit.
+#
+# To enable this hook, rename this file to "pre-commit".
+
+if git rev-parse --verify HEAD >/dev/null 2>&1
+then
+	against=HEAD
+else
+	# Initial commit: diff against an empty tree object
+	against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
+fi
+
+# If you want to allow non-ascii filenames set this variable to true.
+allownonascii=$(git config hooks.allownonascii)
+
+# Cross platform projects tend to avoid non-ascii filenames; prevent
+# them from being added to the repository. We exploit the fact that the
+# printable range starts at the space character and ends with tilde.
+if [ "$allownonascii" != "true" ] &&
+	# Note that the use of brackets around a tr range is ok here, (it's
+	# even required, for portability to Solaris 10's /usr/bin/tr), since
+	# the square bracket bytes happen to fall in the designated range.
+	test "$(git diff --cached --name-only --diff-filter=A -z $against |
+	  LC_ALL=C tr -d '[ -~]\0')"
+then
+	echo "Error: Attempt to add a non-ascii file name."
+	echo
+	echo "This can cause problems if you want to work"
+	echo "with people on other platforms."
+	echo
+	echo "To be portable it is advisable to rename the file ..."
+	echo
+	echo "If you know what you are doing you can disable this"
+	echo "check using:"
+	echo
+	echo "  git config hooks.allownonascii true"
+	echo
+	exit 1
+fi
+
+exec git diff-index --check --cached $against --

data/levels/blame/.gitscrub/hooks/pre-rebase.sample

@@ -0,0 +1,169 @@
+#!/bin/sh
+#
+# Copyright (c) 2006, 2008 Junio C Hamano
+#
+# The "pre-rebase" hook is run just before "git rebase" starts doing
+# its job, and can prevent the command from running by exiting with
+# non-zero status.
+#
+# The hook is called with the following parameters:
+#
+# $1 -- the upstream the series was forked from.
+# $2 -- the branch being rebased (or empty when rebasing the current branch).
+#
+# This sample shows how to prevent topic branches that are already
+# merged to 'next' branch from getting rebased, because allowing it
+# would result in rebasing already published history.
+
+publish=next
+basebranch="$1"
+if test "$#" = 2
+then
+	topic="refs/heads/$2"
+else
+	topic=`git symbolic-ref HEAD` ||
+	exit 0 ;# we do not interrupt rebasing detached HEAD
+fi
+
+case "$topic" in
+refs/heads/??/*)
+	;;
+*)
+	exit 0 ;# we do not interrupt others.
+	;;
+esac
+
+# Now we are dealing with a topic branch being rebased
+# on top of master.  Is it OK to rebase it?
+
+# Does the topic really exist?
+git show-ref -q "$topic" || {
+	echo >&2 "No such branch $topic"
+	exit 1
+}
+
+# Is topic fully merged to master?
+not_in_master=`git rev-list --pretty=oneline ^master "$topic"`
+if test -z "$not_in_master"
+then
+	echo >&2 "$topic is fully merged to master; better remove it."
+	exit 1 ;# we could allow it, but there is no point.
+fi
+
+# Is topic ever merged to next?  If so you should not be rebasing it.
+only_next_1=`git rev-list ^master "^$topic" ${publish} | sort`
+only_next_2=`git rev-list ^master           ${publish} | sort`
+if test "$only_next_1" = "$only_next_2"
+then
+	not_in_topic=`git rev-list "^$topic" master`
+	if test -z "$not_in_topic"
+	then
+		echo >&2 "$topic is already up-to-date with master"
+		exit 1 ;# we could allow it, but there is no point.
+	else
+		exit 0
+	fi
+else
+	not_in_next=`git rev-list --pretty=oneline ^${publish} "$topic"`
+	/usr/bin/perl -e '
+		my $topic = $ARGV[0];
+		my $msg = "* $topic has commits already merged to public branch:\n";
+		my (%not_in_next) = map {
+			/^([0-9a-f]+) /;
+			($1 => 1);
+		} split(/\n/, $ARGV[1]);
+		for my $elem (map {
+				/^([0-9a-f]+) (.*)$/;
+				[$1 => $2];
+			} split(/\n/, $ARGV[2])) {
+			if (!exists $not_in_next{$elem->[0]}) {
+				if ($msg) {
+					print STDERR $msg;
+					undef $msg;
+				}
+				print STDERR " $elem->[1]\n";
+			}
+		}
+	' "$topic" "$not_in_next" "$not_in_master"
+	exit 1
+fi
+
+exit 0
+
+################################################################
+
+This sample hook safeguards topic branches that have been
+published from being rewound.
+
+The workflow assumed here is:
+
+ * Once a topic branch forks from "master", "master" is never
+   merged into it again (either directly or indirectly).
+
+ * Once a topic branch is fully cooked and merged into "master",
+   it is deleted.  If you need to build on top of it to correct
+   earlier mistakes, a new topic branch is created by forking at
+   the tip of the "master".  This is not strictly necessary, but
+   it makes it easier to keep your history simple.
+
+ * Whenever you need to test or publish your changes to topic
+   branches, merge them into "next" branch.
+
+The script, being an example, hardcodes the publish branch name
+to be "next", but it is trivial to make it configurable via
+$GIT_DIR/config mechanism.
+
+With this workflow, you would want to know:
+
+(1) ... if a topic branch has ever been merged to "next".  Young
+    topic branches can have stupid mistakes you would rather
+    clean up before publishing, and things that have not been
+    merged into other branches can be easily rebased without
+    affecting other people.  But once it is published, you would
+    not want to rewind it.
+
+(2) ... if a topic branch has been fully merged to "master".
+    Then you can delete it.  More importantly, you should not
+    build on top of it -- other people may already want to
+    change things related to the topic as patches against your
+    "master", so if you need further changes, it is better to
+    fork the topic (perhaps with the same name) afresh from the
+    tip of "master".
+
+Let's look at this example:
+
+		   o---o---o---o---o---o---o---o---o---o "next"
+		  /       /           /           /
+		 /   a---a---b A     /           /
+		/   /               /           /
+	       /   /   c---c---c---c B         /
+	      /   /   /             \         /
+	     /   /   /   b---b C     \       /
+	    /   /   /   /             \     /
+    ---o---o---o---o---o---o---o---o---o---o---o "master"
+
+
+A, B and C are topic branches.
+
+ * A has one fix since it was merged up to "next".
+
+ * B has finished.  It has been fully merged up to "master" and "next",
+   and is ready to be deleted.
+
+ * C has not merged to "next" at all.
+
+We would want to allow C to be rebased, refuse A, and encourage
+B to be deleted.
+
+To compute (1):
+
+	git rev-list ^master ^topic next
+	git rev-list ^master        next
+
+	if these match, topic has not merged in next at all.
+
+To compute (2):
+
+	git rev-list master..topic
+
+	if this is empty, it is fully merged to "master".

data/levels/blame/.gitscrub/hooks/prepare-commit-msg.sample

@@ -0,0 +1,36 @@
+#!/bin/sh
+#
+# An example hook script to prepare the commit log message.
+# Called by "git commit" with the name of the file that has the
+# commit message, followed by the description of the commit
+# message's source.  The hook's purpose is to edit the commit
+# message file.  If the hook fails with a non-zero status,
+# the commit is aborted.
+#
+# To enable this hook, rename this file to "prepare-commit-msg".
+
+# This hook includes three examples.  The first comments out the
+# "Conflicts:" part of a merge commit.
+#
+# The second includes the output of "git diff --name-status -r"
+# into the message, just before the "git status" output.  It is
+# commented because it doesn't cope with --amend or with squashed
+# commits.
+#
+# The third example adds a Signed-off-by line to the message, that can
+# still be edited.  This is rarely a good idea.
+
+case "$2,$3" in
+  merge,)
+    /usr/bin/perl -i.bak -ne 's/^/# /, s/^# #/#/ if /^Conflicts/ .. /#/; print' "$1" ;;
+
+# ,|template,)
+#   /usr/bin/perl -i.bak -pe '
+#      print "\n" . `git diff --cached --name-status -r`
+#	 if /^#/ && $first++ == 0' "$1" ;;
+
+  *) ;;
+esac
+
+# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
+# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"

data/levels/blame/.gitscrub/hooks/update.sample

@@ -0,0 +1,128 @@
+#!/bin/sh
+#
+# An example hook script to blocks unannotated tags from entering.
+# Called by "git receive-pack" with arguments: refname sha1-old sha1-new
+#
+# To enable this hook, rename this file to "update".
+#
+# Config
+# ------
+# hooks.allowunannotated
+#   This boolean sets whether unannotated tags will be allowed into the
+#   repository.  By default they won't be.
+# hooks.allowdeletetag
+#   This boolean sets whether deleting tags will be allowed in the
+#   repository.  By default they won't be.
+# hooks.allowmodifytag
+#   This boolean sets whether a tag may be modified after creation. By default
+#   it won't be.
+# hooks.allowdeletebranch
+#   This boolean sets whether deleting branches will be allowed in the
+#   repository.  By default they won't be.
+# hooks.denycreatebranch
+#   This boolean sets whether remotely creating branches will be denied
+#   in the repository.  By default this is allowed.
+#
+
+# --- Command line
+refname="$1"
+oldrev="$2"
+newrev="$3"
+
+# --- Safety check
+if [ -z "$GIT_DIR" ]; then
+	echo "Don't run this script from the command line." >&2
+	echo " (if you want, you could supply GIT_DIR then run" >&2
+	echo "  $0 <ref> <oldrev> <newrev>)" >&2
+	exit 1
+fi
+
+if [ -z "$refname" -o -z "$oldrev" -o -z "$newrev" ]; then
+	echo "Usage: $0 <ref> <oldrev> <newrev>" >&2
+	exit 1
+fi
+
+# --- Config
+allowunannotated=$(git config --bool hooks.allowunannotated)
+allowdeletebranch=$(git config --bool hooks.allowdeletebranch)
+denycreatebranch=$(git config --bool hooks.denycreatebranch)
+allowdeletetag=$(git config --bool hooks.allowdeletetag)
+allowmodifytag=$(git config --bool hooks.allowmodifytag)
+
+# check for no description
+projectdesc=$(sed -e '1q' "$GIT_DIR/description")
+case "$projectdesc" in
+"Unnamed repository"* | "")
+	echo "*** Project description file hasn't been set" >&2
+	exit 1
+	;;
+esac
+
+# --- Check types
+# if $newrev is 0000...0000, it's a commit to delete a ref.
+zero="0000000000000000000000000000000000000000"
+if [ "$newrev" = "$zero" ]; then
+	newrev_type=delete
+else
+	newrev_type=$(git cat-file -t $newrev)
+fi
+
+case "$refname","$newrev_type" in
+	refs/tags/*,commit)
+		# un-annotated tag
+		short_refname=${refname##refs/tags/}
+		if [ "$allowunannotated" != "true" ]; then
+			echo "*** The un-annotated tag, $short_refname, is not allowed in this repository" >&2
+			echo "*** Use 'git tag [ -a | -s ]' for tags you want to propagate." >&2
+			exit 1
+		fi
+		;;
+	refs/tags/*,delete)
+		# delete tag
+		if [ "$allowdeletetag" != "true" ]; then
+			echo "*** Deleting a tag is not allowed in this repository" >&2
+			exit 1
+		fi
+		;;
+	refs/tags/*,tag)
+		# annotated tag
+		if [ "$allowmodifytag" != "true" ] && git rev-parse $refname > /dev/null 2>&1
+		then
+			echo "*** Tag '$refname' already exists." >&2
+			echo "*** Modifying a tag is not allowed in this repository." >&2
+			exit 1
+		fi
+		;;
+	refs/heads/*,commit)
+		# branch
+		if [ "$oldrev" = "$zero" -a "$denycreatebranch" = "true" ]; then
+			echo "*** Creating a branch is not allowed in this repository" >&2
+			exit 1
+		fi
+		;;
+	refs/heads/*,delete)
+		# delete branch
+		if [ "$allowdeletebranch" != "true" ]; then
+			echo "*** Deleting a branch is not allowed in this repository" >&2
+			exit 1
+		fi
+		;;
+	refs/remotes/*,commit)
+		# tracking branch
+		;;
+	refs/remotes/*,delete)
+		# delete tracking branch
+		if [ "$allowdeletebranch" != "true" ]; then
+			echo "*** Deleting a tracking branch is not allowed in this repository" >&2
+			exit 1
+		fi
+		;;
+	*)
+		# Anything else (is there anything else?)
+		echo "*** Update hook: unknown type of update to ref $refname of type $newrev_type" >&2
+		exit 1
+		;;
+esac
+
+# --- Finished
+exit 0

data/levels/blame/.gitscrub/info/exclude

@@ -0,0 +1,6 @@
+# git ls-files --others --exclude-from=.git/info/exclude
+# Lines that start with '#' are comments.
+# For a project mostly in C, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~

data/levels/blame/.gitscrub/logs/HEAD

@@ -0,0 +1,5 @@
+0000000000000000000000000000000000000000 5e8863df752e3b7f2150df7c78f12bef6f1ff00e Gary Rennie <webmaster@gazler.com> 1331247924 +0000	commit (initial): added config with name
+5e8863df752e3b7f2150df7c78f12bef6f1ff00e 094094808dc6dc336c93c8602190a9e5f7bd6a11 Spider Man <spidey-sense@tingling.com> 1331247978 +0000	commit: added options
+094094808dc6dc336c93c8602190a9e5f7bd6a11 70d00535a3a25b0ac1736dd3d306d6271e5427ed Bruce Banner <hulk@smash.com> 1331248061 +0000	commit: added password
+70d00535a3a25b0ac1736dd3d306d6271e5427ed 97bdd0cccf9f4b8730f78cb53a81a74f205dbcc2 Spider Man <spidey-sense@tingling.com> 1331248095 +0000	commit: added more options
+97bdd0cccf9f4b8730f78cb53a81a74f205dbcc2 ffd39c2dbfd94bdbca06d48686e0cbda642f3de7 Gary Rennie <webmaster@gazler.com> 1331248138 +0000	commit: added more options (no really)

data/levels/blame/.gitscrub/logs/refs/heads/master

@@ -0,0 +1,5 @@
+0000000000000000000000000000000000000000 5e8863df752e3b7f2150df7c78f12bef6f1ff00e Gary Rennie <webmaster@gazler.com> 1331247924 +0000	commit (initial): added config with name
+5e8863df752e3b7f2150df7c78f12bef6f1ff00e 094094808dc6dc336c93c8602190a9e5f7bd6a11 Spider Man <spidey-sense@tingling.com> 1331247978 +0000	commit: added options
+094094808dc6dc336c93c8602190a9e5f7bd6a11 70d00535a3a25b0ac1736dd3d306d6271e5427ed Bruce Banner <hulk@smash.com> 1331248061 +0000	commit: added password
+70d00535a3a25b0ac1736dd3d306d6271e5427ed 97bdd0cccf9f4b8730f78cb53a81a74f205dbcc2 Spider Man <spidey-sense@tingling.com> 1331248095 +0000	commit: added more options
+97bdd0cccf9f4b8730f78cb53a81a74f205dbcc2 ffd39c2dbfd94bdbca06d48686e0cbda642f3de7 Gary Rennie <webmaster@gazler.com> 1331248138 +0000	commit: added more options (no really)

data/levels/blame/.gitscrub/objects/09/4094808dc6dc336c93c8602190a9e5f7bd6a11

@@ -0,0 +1,2 @@
+x
�NK�1t�S�^���
/��d���N2$q��W�����.*�m����a��j��jK6�褧���H�D���а0�U����VGR>]t��\�,	"Α����
+\�W�OK�����9y�u��PJH����'�L��1_m`!%LP��k���dM�

data/levels/blame/.gitscrub/objects/31/11dda1f5b08d50ac44b99acabfa54f1e6e72b0

@@ -0,0 +1,2 @@
+x
5��
+1D=��MAD/���l7�@MdS�ݶ�&C����z��EH䎋i�����;���6�Szr�G�JJ��u�[�+����oSJ���V@���쭁�o-����e��[��#3�

data/levels/blame/.gitscrub/objects/97/bdd0cccf9f4b8730f78cb53a81a74f205dbcc2

@@ -0,0 +1 @@
+x
��Kj1D��S��$t��`L.�UN����i�(�>��((���-u��lͩ7U`"'!Fo�{�1p�4�uL?	)U��ܴt(�θl2��B�x#�x��r��������6�����_��C��Z�ϡϥnW c�m���<@p���c�߇)���V�B��Z�1�
n�K�

data/levels/blame/.gitscrub/objects/dd/df1d8ebd60eec169c15a5b23cb49a58d2ed5a0

@@ -0,0 +1,4 @@
+x
e�A
+�0E]�cW
+Ņ.Ģ xI�T�LI��w7I�(]$����T�+X�7i�sp`��
��YH��c%��.�lӲU
P�$�(>���v@h
+��#���k$�}c�>�q�c�A�ە����.����RqKR8}J�g�bH�)դ��xk�Z��Iэ�

data/levels/blame/.gitscrub/objects/ff/d39c2dbfd94bdbca06d48686e0cbda642f3de7

@@ -0,0 +1 @@
+x
��MJD1�]��t$�t`ܹ��NG�$C&"�������Ž�}���ix
�|�ڠ�!搲���ٸ����1��Ґ6!.�53�X|��t	�is���/Vo91[E?���q�Oim8�J�t�2޿���ʽ^�8g�G�^�Z���fيr���~�{o7xn��q�O�dbO[

data/levels/blame/.gitscrub/refs/heads/master

@@ -0,0 +1 @@
+ffd39c2dbfd94bdbca06d48686e0cbda642f3de7

data/levels/blame/config.rb

@@ -0,0 +1,16 @@
+class Config
+  attr_accessor :name, :password
+  def initialize(name, password = nil, options = {})
+    @name = name
+    @password = password || "i<3evil"
+    
+    if options[:downcase]
+      @name.downcase!
+    end
+
+    if options[:upcase]
+      @name.upcase!
+    end
+
+  end
+end

data/levels/commit.rb

@@ -1,14 +1,17 @@
 difficulty 1
-description "Make a commit"
+description "The README file has been added to your staging area, now commit it."
 
 setup do
-  `git init`
-  `touch README`
-  `git add README`
+  repo.init
+  FileUtils.touch("README")
+  repo.add("README")
 end
 
 solution do
-  repo = Grit::Repo.new(".")
   return false if repo.commits.empty?
   true
 end
+
+hint do
+  puts "You must include a message when you commit."
+end

data/levels/config.rb

@@ -0,0 +1,28 @@
+difficulty 1
+description "Set up your git name and email, this is important so that your commits can be identified"
+
+setup do
+  repo.init
+end
+
+solution do
+
+  valid = false
+ 
+  name = request("What is your name?")  
+  email = request("What is your email?")
+  config_name = repo.config["user.name"]
+  config_email = repo.config["user.email"]
+  if name == config_name && email == config_email
+    valid = true
+  end
+
+  puts "Your config has the following name: #{config_name}"
+  puts "Your config has the following email: #{config_email}"
+
+  valid
+end
+
+hint do
+  puts "These settings are config settings.  You should run `git help config` if you are stuck"
+end

data/levels/contribute.rb

@@ -19,3 +19,7 @@ solution do
   end
   contributor
 end
+
+hint do
+  puts "Forking the repository would be a good start!"
+end

data/levels/init.rb

@@ -2,5 +2,9 @@ difficulty 1
 description "Initialize an empty repository"
 
 solution do
-  Grit::Repo.new(".")
+  repo.valid?
+end
+
+hint do
+  puts "You can type `git` in your shell to get a list of available git commands"
 end

data/lib/gitscrub/cli.rb

@@ -4,29 +4,29 @@ module Gitscrub
   class CLI < Thor
 
 
-    default_task :setup
+    default_task :play
 
-    desc :setup, "Initialize the game"
+    desc :play, "Initialize the game"
 
-    def setup
+    def play
       UI.word_box("Gitscrub")
       make_directory
       game = Game.new
       game.play_level
     end
 
-    desc :check, "check your current solution"
+    desc :hint, "Get a hint for the current level"
 
-    def check
-      true
+    def hint
+      if level = load_level
+        level.show_hint
+      end
     end
 
-    desc :reset, "reset the current level"
+    desc :reset, "Reset the current level"
 
     def reset
-      profile = Profile.load
-      level = Level.load(profile.level)
-      if level
+      if level = load_level
         UI.word_box("Gitscrub")
         UI.puts("resetting level")
         level.setup_level
@@ -36,6 +36,12 @@ module Gitscrub
 
     no_tasks do
 
+      def load_level
+        profile = Profile.load
+        Level.load(profile.level)
+      end
+
+
       def make_directory
         if File.exists?("./git_scrub") 
           UI.puts "Please change into the git_scrub directory"

data/lib/gitscrub/level.rb

@@ -2,23 +2,30 @@ module Gitscrub
   class Level
     include UI
 
-    LEVELS = [nil, "init", "add", "commit", "contribute"]
+    LEVELS = [nil, "init", "add", "commit", "config", "blame",  "contribute"]
 
-    attr_accessor :level_no
+    attr_accessor :level_no, :level_path
     
     class << self
       
       def load(level_no)
         level = new
-        location = "#{File.dirname(__FILE__)}/../../levels/#{LEVELS[level_no]}.rb"
+        level_path = "#{File.dirname(__FILE__)}/../../levels/#{LEVELS[level_no]}"
+        location = "#{level_path}.rb"
         return false unless File.exists?(location)
         level.instance_eval(File.read(location))
         level.level_no = level_no
+        level.level_path = level_path
         level
       end
 
     end
 
+    def init_from_level
+      FileUtils.cp_r("#{level_path}/.", ".")
+      FileUtils.mv(".gitscrub", ".git")
+    end
+
     def difficulty(num)
       @difficulty = num
     end
@@ -35,6 +42,10 @@ module Gitscrub
       @setup = block 
     end
 
+    def hint(&hint)
+      @hint = hint
+    end
+
     def full_description
       UI.puts
       UI.puts "Level: #{level_no}"
@@ -59,5 +70,14 @@ module Gitscrub
       false
     end
 
+
+    def show_hint
+      UI.word_box("Gitscrub")
+      if @hint
+        @hint.call
+      else
+        UI.puts("No hints available for this level")
+      end
+    end
   end
 end

data/lib/gitscrub/repository.rb

@@ -18,6 +18,25 @@ module Gitscrub
       end
     end
 
+    def valid?
+      !@grit.nil?
+    end
+
+    def init(gitignore = true)
+      @grit = Grit::Repo.init(".")
+      if gitignore
+        @grit.add(".gitignore")
+        @grit.commit("added .gitignore")
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      if @grit && @grit.respond_to?(method) 
+        return @grit.send(method, *args, &block)
+      end
+      super
+    end
+
 
   end
 end

data/lib/gitscrub/ui.rb

@@ -42,7 +42,7 @@ module Gitscrub
       end
 
       def request(msg)
-        print(msg)
+        print("#{msg} ")
         gets.chomp
       end
       

data/lib/gitscrub/version.rb

@@ -1,3 +1,3 @@
 module Gitscrub
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/gitscrub/cli_spec.rb

@@ -12,7 +12,7 @@ describe Gitscrub::CLI do
   it "should print the logo" do
     Gitscrub::UI.should_receive(:word_box).with("Gitscrub")
     @cli.stub(:make_directory) 
-    @cli.setup
+    @cli.play
   end
 
   it "should create a directory if one does not exist" do
@@ -40,12 +40,7 @@ describe Gitscrub::CLI do
     lambda {@cli.make_directory}.should raise_error(SystemExit)
   end
 
-  it "should check the current solution" do
-    @cli.check.should eql(true) 
-  end
-
-  describe "reset" do
-    
+  describe "level methods" do
     before(:each) do
       @level = mock
       @profile = mock
@@ -53,23 +48,33 @@ describe Gitscrub::CLI do
       Gitscrub::Profile.stub(:load).and_return(@profile)
       Gitscrub::Level.stub(:load).and_return(@level)
     end
-    
-    it "should reset the current level" do
-      @level.should_receive(:setup_level)
-      @level.should_receive(:full_description)
-      Gitscrub::UI.should_receive(:word_box).with("Gitscrub")
-      Gitscrub::UI.should_receive(:puts).with("resetting level")
-      @cli.reset
-    end
 
-    it "should not reset if the level cannot be loaded" do
-      Gitscrub::Level.stub(:load).and_return(false)
-      @level.should_not_receive(:setup_level)
-      @level.should_not_receive(:full_description)
-      Gitscrub::UI.should_not_receive(:word_box).with("Gitscrub")
-      Gitscrub::UI.should_not_receive(:puts).with("resetting level")
-      @cli.reset
+    it "should call the hint method on the level" do
+      @level.should_receive(:show_hint)
+      @cli.hint
     end
-  end  
+
+    describe "reset" do
+      
+      
+      it "should reset the current level" do
+        @level.should_receive(:setup_level)
+        @level.should_receive(:full_description)
+        Gitscrub::UI.should_receive(:word_box).with("Gitscrub")
+        Gitscrub::UI.should_receive(:puts).with("resetting level")
+        @cli.reset
+      end
+
+      it "should not reset if the level cannot be loaded" do
+        Gitscrub::Level.stub(:load).and_return(false)
+        @level.should_not_receive(:setup_level)
+        @level.should_not_receive(:full_description)
+        Gitscrub::UI.should_not_receive(:word_box).with("Gitscrub")
+        Gitscrub::UI.should_not_receive(:puts).with("resetting level")
+        @cli.reset
+      end
+    end  
+
+  end
   
 end

data/spec/gitscrub/level_spec.rb

@@ -13,6 +13,10 @@ end
 solution do
   Grit::Repo.new("gitscrub/notadir")
 end
+
+hint do
+  puts "this is a hint"
+end
     eof
     File.stub(:exists?).and_return(true)
     File.stub(:read).and_return(@file)
@@ -20,6 +24,8 @@ end
     @repo = mock
     @repo.stub(:reset) 
     Gitscrub::Repository.stub(:new).and_return(@repo)
+    Gitscrub::UI.stub(:puts)
+    Gitscrub::UI.stub(:print)
   end
 
   it "should mixin UI" do
@@ -100,6 +106,26 @@ end
 
   end
 
+  describe "hint" do
+    it "should display a hint" do
+      @level.should_receive(:puts).with("this is a hint")
+      @level.show_hint 
+    end
+
+    it "should not call the hint if none exist" do
+      @level.instance_variable_set("@hint", nil)
+      lambda {@level.show_hint}.should_not raise_error(NoMethodError)
+    end
+  end
+
+  describe "init_from_level" do
+    it "should copy the files from the level folder" do
+      FileUtils.should_receive(:cp_r).with("#{@level.level_path}/.", ".") 
+      FileUtils.should_receive(:mv).with(".gitscrub", ".git")
+      @level.init_from_level
+    end  
+  end
+
 
   
 end

data/spec/gitscrub/repository_spec.rb

@@ -45,5 +45,48 @@ describe Gitscrub::Repository do
     end
   end
 
+  describe "valid?" do
+    it "should be valid if grit exists" do
+      @repository.should be_valid  
+    end
+
+    it "should not be valid if grit does not exist" do
+      @repository.instance_variable_set("@grit", nil) 
+      @repository.should_not be_valid
+    end
+  end
+
+  describe "init" do
+    before(:each) do
+      @repo = mock 
+      Grit::Repo.should_receive(:init).with(".").and_return(@repo)
+    end
+
+    it "should initialize an empty repository and add .gitignore" do
+      @repo.should_receive(:add).with(".gitignore")
+      @repo.should_receive(:commit).with("added .gitignore")
+      @repository.init
+    end
+
+    it "should not add and commit gitignore if prompted" do
+      @repo.should_not_receive(:add).with(".gitignore")
+      @repo.should_not_receive(:commit).with("added .gitignore")
+      @repository.init(false)
+    end
+  end
+
+  describe "method_missing" do
+    it "should deletegate to grit if the method exists" do
+      @grit.should_receive(:respond_to?).with(:valid_method).and_return(true)      
+      @grit.should_receive(:valid_method)
+      @repository.valid_method
+    end
+
+    it "should not deletegate to grit if the method does not exist" do
+      @grit.should_receive(:respond_to?).with(:invalid_method).and_return(false)      
+      lambda { @repository.invalid_method }.should raise_error(NoMethodError)
+    end
+  end
+
 
 end

data/spec/gitscrub/ui_spec.rb

@@ -53,7 +53,7 @@ describe Gitscrub::UI do
     @in.puts "bar"
     @in.rewind
     @ui.request("foo").should == "bar"
-    @out.string.should == "foo"
+    @out.string.should == "foo "
   end
 
   it "should ask for yes/no and return true when yes" do

metadata

@@ -2,7 +2,7 @@
 name: gitscrub
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Gary Rennie
@@ -59,11 +59,49 @@ files:
 - .gitignore
 - .rspec
 - Gemfile
+- README.md
 - Rakefile
 - bin/gitscrub
 - gitscrub.gemspec
 - levels/add.rb
+- levels/blame.rb
+- levels/blame/.gitscrub/COMMIT_EDITMSG
+- levels/blame/.gitscrub/HEAD
+- levels/blame/.gitscrub/config
+- levels/blame/.gitscrub/description
+- levels/blame/.gitscrub/hooks/applypatch-msg.sample
+- levels/blame/.gitscrub/hooks/commit-msg.sample
+- levels/blame/.gitscrub/hooks/post-commit.sample
+- levels/blame/.gitscrub/hooks/post-receive.sample
+- levels/blame/.gitscrub/hooks/post-update.sample
+- levels/blame/.gitscrub/hooks/pre-applypatch.sample
+- levels/blame/.gitscrub/hooks/pre-commit.sample
+- levels/blame/.gitscrub/hooks/pre-rebase.sample
+- levels/blame/.gitscrub/hooks/prepare-commit-msg.sample
+- levels/blame/.gitscrub/hooks/update.sample
+- levels/blame/.gitscrub/index
+- levels/blame/.gitscrub/info/exclude
+- levels/blame/.gitscrub/logs/HEAD
+- levels/blame/.gitscrub/logs/refs/heads/master
+- levels/blame/.gitscrub/objects/00/d6bf5341b263ccaf32e7973be55126eb30a343
+- levels/blame/.gitscrub/objects/05/07c26fed4d111a8344763be9af68af90f0ecf2
+- levels/blame/.gitscrub/objects/09/4094808dc6dc336c93c8602190a9e5f7bd6a11
+- levels/blame/.gitscrub/objects/21/15d78864000292628872941b14521f90187eed
+- levels/blame/.gitscrub/objects/31/11dda1f5b08d50ac44b99acabfa54f1e6e72b0
+- levels/blame/.gitscrub/objects/50/8db115ba34a0e4e8667653aebe0265bb4f7e80
+- levels/blame/.gitscrub/objects/5e/8863df752e3b7f2150df7c78f12bef6f1ff00e
+- levels/blame/.gitscrub/objects/67/788a4b90180c7588d7bd0ad8032957b0f429ba
+- levels/blame/.gitscrub/objects/70/d00535a3a25b0ac1736dd3d306d6271e5427ed
+- levels/blame/.gitscrub/objects/97/bdd0cccf9f4b8730f78cb53a81a74f205dbcc2
+- levels/blame/.gitscrub/objects/ab/08819ba3ffaeba17d4f870dc3a458a904519f4
+- levels/blame/.gitscrub/objects/be/96fe46de646f6a5c728f90cc884aef96fa1d6f
+- levels/blame/.gitscrub/objects/cd/9c6b9ab1a6f56cccc69b6aa661f1d67ba5fb46
+- levels/blame/.gitscrub/objects/dd/df1d8ebd60eec169c15a5b23cb49a58d2ed5a0
+- levels/blame/.gitscrub/objects/ff/d39c2dbfd94bdbca06d48686e0cbda642f3de7
+- levels/blame/.gitscrub/refs/heads/master
+- levels/blame/config.rb
 - levels/commit.rb
+- levels/config.rb
 - levels/contribute.rb
 - levels/init.rb
 - lib/gitscrub.rb