githug 0.2.11 → 0.2.12

data/LICENCE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013  Gary 'Gazler' Rennie
+
+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

@@ -49,43 +49,48 @@ Githug 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
+```ruby
+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.
 
 You can also include multiple hints like this:
 
-    hints [
-      "You can type `git` in your shell to get a list of available git commands",
-      "Check the man for `git add`"]
+```ruby
+hints [
+  "You can type `git` in your shell to get a list of available git commands",
+  "Check the man for `git add`"]
+```
 
  **note** Because `solution` is a Proc, you cannot prematurely return out of it and as a result, must put an explicit return on the last line of the solution block.
 
-
-    solution do
-      solved = false
-      solved = true if repo.valid?
-      solved
-    end
+```ruby
+solution do
+  solved = false
+  solved = true if repo.valid?
+  solved
+end
+```
 
  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.
 
  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.)
@@ -93,9 +98,11 @@ You can also include multiple hints like this:
 
 Another method exists called `init_from_level` and it is used like so:
 
-    setup do
-      init_from_level
-    end
+```ruby
+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:
 
@@ -119,3 +126,5 @@ The easiest way to test a level is:
  * Run `githug test PATH_TO_YOUR_LEVEL
 
 Please note that the `githug test` command can be run as `githug test --errors` to get an error stacktrace from your solve method.
+
+It would be ideal if you add an integration test for your level.  These tests live in `spec/githug_spec` and **must** be run in order.  If you add a level but do not add a test, please add a simple `skip_level` test case similar to the `contribute` level.

data/levels/add.rb

@@ -1,5 +1,6 @@
 difficulty 1
-description "There is a file in your folder called README, you should add it to your staging area"
+description "There is a file in your folder called README, you should add it to your staging area
+Note: You start each level with a new repo. Don't look for files from the previous one"
 
 setup do
   repo.init

data/levels/bisect.rb

@@ -11,5 +11,5 @@ solution do
 end
 
 hint do
-  puts ["The fastest way to find the bug is with bisect.", "Start bisect with a good and bad commit, then run git bisect run make test."]
+  puts ["The fastest way to find the bug is with bisect.", "Don't forget to start bisect first, identify a good or bad commit, then run git bisect run make test."]
 end

data/levels/blame/config.rb

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

data/levels/branch_at.rb

@@ -1,5 +1,5 @@
 difficulty 3
-description "You forgot to branch at the previous commit and made a commit on top of it. Create branch 'test_branch' at the commit before the last" 
+description "You forgot to branch at the previous commit and made a commit on top of it. Create branch 'test_branch' at the commit before the last"
 
 setup do
   repo.init

data/levels/commit_amend.rb

@@ -13,7 +13,7 @@ solution do
   # Reset config - see issue #74
   file = File.open(".git/config", "w") do |file|
     file.puts("[format]")
-    file.puts(" pretty = medium") 
+    file.puts(" pretty = medium")
   end
   repo.commits.length == 1 && Grit::CommitStats.find_all(repo, repo.commits.first.sha).first[1].files.length == 2
 end

data/levels/config.rb

@@ -8,8 +8,8 @@ end
 solution do
 
   valid = false
- 
-  name = request("What is your name?")  
+
+  name = request("What is your name?")
   email = request("What is your email?")
   config_name = repo.config["user.name"]
   config_email = repo.config["user.email"]

data/levels/ignore.rb

@@ -3,12 +3,16 @@ description "The text editor 'vim' creates files ending in .swp (swap files) for
 
 setup do
   repo.init
+  FileUtils.touch("README.swp")
+  file = File.open(".git/config", "w") do |file|
+    file.puts "[core]\nexcludesfile="
+  end
 end
 
 solution do
 
   valid = false
- 
+
 
   File.open(".gitignore", "r") do |file|
     while line = file.gets

data/levels/log.rb

@@ -4,13 +4,13 @@ description "You will be asked for the first 7 chars of the hash of most recent
 
 setup do
   repo.init
-  file = File.new("newfile.rb", "w") 
+  file = File.new("newfile.rb", "w")
   repo.add("newfile.rb")
   repo.commit_all("THIS IS THE COMMIT YOU ARE LOOKING FOR!")
 end
 
 solution do
-  repo.commits.last.id_abbrev == request("What are the first 7 characters of the hash of the most recent commit?") 
+  repo.commits.last.id_abbrev == request("What are the first 7 characters of the hash of the most recent commit?")
 end
 
 hint do

data/levels/merge.rb

@@ -6,7 +6,7 @@ setup do
 end
 
 solution do
-	File.exists?("file1")	&& File.exists?("file2") 
+	File.exists?("file1")	&& File.exists?("file2")
 end
 
 hint do

data/levels/merge_squash.rb

@@ -20,9 +20,9 @@ setup do
   File.open("file3", 'a') { |f| f << "and awesomer!\n" }
   repo.add        "file3"
   repo.commit_all "Time"
-  
+
   repo.git.native :checkout, {}, 'master'
-  
+
   FileUtils.touch "file2"
   repo.add        "file2"
   repo.commit_all "Second commit"
@@ -33,13 +33,13 @@ solution do
 
   # Check the number of commits in the repo (should be 4 - including initial .gitignore).
   result = false unless repo.commits.size == 3
-  
+
   # Check if changes from all the commits from long-feature-branch are included.
   file = File.open('file3')
   result = false unless file.readline =~ /some feature/
   result = false unless file.readline =~ /getting awesomer/
   result = false unless file.readline =~ /and awesomer!/
-  
+
   result
 end
 

data/levels/rm.rb

@@ -4,7 +4,7 @@ description "A file has been removed from the working tree, however the file was
 
 setup do
   repo.init
-  file = File.new("deleteme.rb", "w") 
+  file = File.new("deleteme.rb", "w")
 	file.close
   repo.add("deleteme.rb")
   repo.commit_all("Added a temp file")

data/levels/stash/.githug/COMMIT_EDITMSG

@@ -0,0 +1 @@
+Add some lyrics

data/levels/stash/.githug/HEAD

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

data/levels/stash/.githug/config

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

data/levels/stash/.githug/description

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

data/levels/stash/.githug/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/stash/.githug/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/stash/.githug/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/stash/.githug/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/stash/.githug/hooks/pre-commit.sample

@@ -0,0 +1,50 @@
+#!/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)
+
+# Redirect output to stderr.
+exec 1>&2
+
+# 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' | wc -c) != 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
+
+# If there are whitespace errors, print the offending file names and fail.
+exec git diff-index --check --cached $against --

data/levels/stash/.githug/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/stash/.githug/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"