abacaba

.travis.yml

@@ -1,18 +1,18 @@
 language: ruby
-
+dist: focal
 rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - 2.1
+  - 2.4.10
+  - 2.5.9
+  - 2.6.8
+  - 2.7.4
+  - 3.0.1
   - ruby-head
 
 matrix:
   allow_failures:
     - rvm: ruby-head
 
 before_install:
-  - gem update --system 2.1.11
+  - gem update --system
   - git config --global user.email 'user@example.com'
   - git config --global user.name 'Test User'

Dockerfile

@@ -0,0 +1,59 @@
+FROM ruby:slim
+
+LABEL org.opencontainers.image.authors="diraneyya@ip.rwth-aachen.de"
+
+# This is in order to have the man pages during exercises
+RUN sed -i '/path-exclude \/usr\/share\/man/d' /etc/dpkg/dpkg.cfg.d/docker
+RUN sed -i '/path-exclude \/usr\/share\/groff/d' /etc/dpkg/dpkg.cfg.d/docker
+RUN apt update && apt install -y man git && apt install --reinstall coreutils
+
+# The DATA_PATH is used for the deliverables, or the submissible
+# content for the classroom activity.
+ENV DATA_PATH="/data"
+# The REPO_PATH is where the original or the teacher's forked repo
+# resides inside the container.
+ENV REPO_PATH="/root/githug"
+# The LEVEL_PATH is where the current challenge resides and where
+# students should navigate prior to attemping to use the `githug`
+# commands.
+ENV LEVEL_PATH="/git_hug"
+ENV GITHUG_GITCONF="/root/.gitconfig"
+ENV GITHUG_PROFILE="$LEVEL_PATH/.profile.yml"
+ENV GITHUG_HISTORY_OUTPUT="$DATA_PATH/history.txt"
+ENV GITHUG_PROFILE_OUTPUT="$DATA_PATH/profile.yml"
+ENV GITHUG_GITCONF_OUTPUT="$DATA_PATH/gitconfig"
+
+RUN mkdir -p $DATA_PATH
+ADD . $REPO_PATH
+WORKDIR $REPO_PATH
+RUN gem build
+RUN gem install *.gem
+
+WORKDIR /
+RUN echo "y" | $GEM_HOME/bin/githug
+RUN cp $GITHUG_PROFILE $GITHUG_PROFILE_OUTPUT
+
+WORKDIR $LEVEL_PATH
+
+# The bash login script in below clears the history and restores
+# progress using the contents of the $GITHUG_PROFILE_OUTPUT file.
+RUN printf "history -c\nHISTSIZE= \nHISTFILESIZE= \n\
+echo '--- NEW SESSION ---' >> $GITHUG_HISTORY_OUTPUT \n\
+if ! [ -e $GITHUG_PROFILE_OUTPUT ]; then \n\
+    echo 'ERROR: Corrupt level progress data. Exiting.' \n\
+    echo '>>> CORRUPT DATA <<<' >> $GITHUG_HISTORY_OUTPUT \n\
+    exit 1; fi \n\
+cp $GITHUG_GITCONF_OUTPUT $GITHUG_GITCONF \n\
+mkdir -p $LEVEL_PATH && cp $GITHUG_PROFILE_OUTPUT $GITHUG_PROFILE \n\
+export PATH=\"\$GEM_HOME/bin:\$PATH\" \n\
+cd $LEVEL_PATH && githug reset \n\
+echo -e '\nIMPORTANT: everything you type in this container is \
+recorded to assist in the grading process.' \n" >> ~/.bash_profile
+
+RUN printf "history -a\ncat \$HISTFILE >> $GITHUG_HISTORY_OUTPUT \n\
+cp $GITHUG_PROFILE $GITHUG_PROFILE_OUTPUT \n\
+cp $GITHUG_GITCONF $GITHUG_GITCONF_OUTPUT 2>/dev/null \n\
+cp $GITHUG_PROFILE $GITHUG_PROFILE_OUTPUT \n" >> ~/.bash_logout 
+
+ENTRYPOINT ["/bin/bash", "--login"]
+VOLUME $DATA_PATH

README.md

@@ -1,30 +1,67 @@
 # Githug
-Git Your Game On [![Build Status](https://travis-ci.org/Gazler/githug.png?branch=master)](https://travis-ci.org/Gazler/githug) [![Code Climate](https://codeclimate.com/github/Gazler/githug.png)](https://codeclimate.com/github/Gazler/githug)
+Git Your Game On 
+
+[![Build Status](https://travis-ci.org/Gazler/githug.svg?branch=master)](https://travis-ci.org/Gazler/githug) [![Code Climate](https://codeclimate.com/github/Gazler/githug.svg)](https://codeclimate.com/github/Gazler/githug)
+
 ## About
 Githug is designed to give you a practical way of learning git.  It has a series of levels, each requiring you to use git commands to arrive at a correct answer.
 
-## Installation
+## Playing Githug
+
+Githug should work on Linux, OS X and Windows.
+
+### Prerequisites
+
+Githug requires Ruby 1.8.7 or higher.
+
+You can check which version of Ruby is installed with the following command:
+
+```
+ruby --version
+```
+
+If ruby is not installed, follow the installation instructions on [ruby-lang.org](https://www.ruby-lang.org/en/documentation/installation/).
+
+### Installation
+
 To install Githug, run
 
     gem install githug
 
-After the gem is installed, run `githug`.  You will be prompted to create a directory. Githug should work on Linux, OS X and Windows.
+If you get a complaint about permissions, you can rerun the command with `sudo`:
+
+    sudo gem install githug
+
+#### Usage with Docker
+
+An unofficial _Docker_ image for this project by [@odiraneyya](https://github.com/odiraneyya) is available on ([Docker Hub](https://hub.docker.com/r/orwa84/githug)).
+
+### Starting the Game
+
+After the gem is installed change directory to the location where you want the game-related assets to be stored.
+Then run `githug`:
+
+    githug
 
-## Commands
+You will be prompted to create a directory.
 
-Githug has 5 commands:
+    No githug directory found, do you wish to create one? [yn]
+
+Type `y` (yes) to continue, `n` (no) to cancel and quit Githug.
+
+### Commands
+
+Githug has 4 game commands:
 
  * play - The default command, checks your solution for the current level
  * hint - Gives you a hint (if available) for the current level
  * reset - Reset the current level or reset the level to a given name or path
  * levels - List all the levels
- * test - Test levels in development (please see the "Testing Levels" section below)
 
 ## Change Log
 
 The change log is available on the wiki.  [Change log](https://github.com/Gazler/githug/wiki/Change-Log)
 
-
 ## Contributing
 
 To suggest a level or create a level that has been suggested, check out [the wiki](https://github.com/Gazler/githug/wiki).
@@ -112,6 +149,39 @@ The easiest way to test a level is:
  * Solve the level
  * 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.
+Please note that the `githug test` command can be run as `githug test --errors` to get an error stack trace 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.
+
+## FAQs
+
+1. Answers are not being checked properly
+
+   *This is a common issue we are facing and we are actively working to fix it.*
+
+   For now, run the following commands to change the default branch name to master. This should fix most of the issues you may face.
+   ```
+   $ git config --global init.defaultBranch master
+   $ githug reset
+   ```
+
+   From the current level forward, the default branch will be `master`.
+
+2. `githug` command doesn't work
+
+    Githug currently isn't supported on ruby versions ^3.0.0. Use any ruby version below 3.0.0 (preferrably 2.7.1).
+
+    If you use rvm, execute the below commands
+
+    ```
+    $ rvm install 2.7.1
+    $ rvm use 2.7.1
+    ```
+
+    If you use rbenv, execute the below commands
+
+    ```
+    $ rbenv install 2.7.1
+    $ rbenv global 2.7.1
+    ```
+

githug.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
   s.name        = "githug"
   s.version     = Githug::VERSION
   s.authors     = ["Gary Rennie"]
-  s.email       = ["webmaster@gazler.com"]
-  s.homepage    = ""
+  s.email       = ["gazler@gmail.com"]
+  s.homepage    = "https://github.com/Gazler/githug"
   s.summary     = %q{An interactive way to learn git.}
   s.description = %q{An interactive way to learn git.}
 
@@ -23,6 +23,5 @@ Gem::Specification.new do |s|
 
   s.add_dependency "grit", "~>2.3.0"
   s.add_dependency "thor", "~>0.14.6"
-  s.add_dependency "rake"
-  # s.add_runtime_dependency "rest-client"
+  s.add_dependency "rake", "<11"
 end

levels/add.rb

@@ -1,10 +1,11 @@
 difficulty 1
-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."
+description "There is a file in your folder called `README`; add it to your staging area.
+Note: Each level starts with a new repo. Don't look for files of the previous one."
 
 setup do
   repo.init
   FileUtils.touch("README")
+  system "git branch -m master"
 end
 
 solution do

levels/bisect.rb

@@ -1,9 +1,10 @@
 difficulty 3
-description "A bug was introduced somewhere along the way.  You know that running `ruby prog.rb 5` should output 15.  You can also run `make test`.  What are the first 7 chars of the hash of the commit that introduced the bug."
+description "A bug was introduced somewhere along the way. You know that running `ruby prog.rb 5` should output 15. You can also run `make test`. What are the first 7 chars of the hash of the commit (the abbreviated hash) that introduced the bug?"
 
 setup do
   init_from_level
   repo.init
+  system "git branch -m master"
 end
 
 solution do

levels/blame.rb

@@ -1,13 +1,14 @@
 difficulty 2
-description "Someone has put a password inside the file `config.rb` find out who it was."
+description "Identify who put a password inside the file `config.rb`."
 
 setup do
   init_from_level
+  system "git branch -m master"
 end
 
 solution do
   offender = repo.commit("97bdd0cccf9f4b8730f78cb53a81a74f205dbcc2").author.name
-  request("Who made the commit with the password?").downcase == offender.downcase
+  request("Who made the commit with the password?").downcase.strip == offender.downcase
 end
 
 hint do

levels/branch.rb

@@ -1,11 +1,12 @@
 difficulty 1
-description "You want to work on a piece of code that has the potential to break things, create the branch test_code."
+description "To work on a piece of code that has the potential to break things, create the branch test_code."
 
 setup do
   repo.init
   FileUtils.touch("README")
   repo.add "README"
   repo.commit_all("Initial commit")
+  system "git branch -m master"
 end
 
 solution do

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 the branch test_branch at the commit before the last."
 
 setup do
   repo.init
@@ -12,11 +12,12 @@
   File.open("file1", 'a') { |f| f.write("\nAdding some more text") }
   repo.add("file1")
   repo.commit_all("Updating file1 again")
+  system "git branch -m master"
 end
 
 solution do
   return false unless repo.branches.map(&:name).include?("test_branch")
-  repo.commits("test_branch").each { |commit| return false if commit.message ==  "Updating file1 again" }
+  repo.commits("test_branch").each { |commit| return false if commit.message == "Updating file1 again" }
   true
 end
 

levels/checkout.rb

@@ -1,11 +1,12 @@
 difficulty 2
-description "Create and switch to a new branch called my_branch.  You will need to create a branch like you did in the previous level."
+description "Create and switch to a new branch called my_branch. You will need to create a branch like you did in the previous level."
 
 setup do
   repo.init
   FileUtils.touch("README")
   repo.add("README")
   repo.commit_all("initial commit")
+  system "git branch -m master"
 end
 
 solution do

levels/checkout_file.rb

@@ -1,6 +1,6 @@
 difficulty 3
 
-description "A file has been modified, but you don't want to keep the modification.  Checkout the `config.rb` file from the last commit."
+description "A file has been modified, but you don't want to keep the modification. Checkout the `config.rb` file from the last commit."
 
 setup do
   repo.init
@@ -14,6 +14,7 @@
   File.open("config.rb", "a") do |file|
     file.puts("These are changed you don't want to keep!")
   end
+  system "git branch -m master"
 end
 
 solution do

levels/checkout_tag.rb

@@ -26,11 +26,13 @@
   repo.add("app.rb")
   repo.commit_all("Changes galore")
   repo.git.tag( { 'f' => true }, "v1.5" )
+
+  system "git branch -m master"
 end
 
 solution do
   return false unless repo.commits.length == 5
-  return false unless `git show HEAD` =~ /Some more changes/
+  return false unless `git show HEAD --format=%s` =~ /Some more changes/
   true
 end
 

levels/checkout_tag_over_branch.rb

@@ -7,6 +7,7 @@
   FileUtils.touch("app.rb")
   repo.add("app.rb")
   repo.commit_all("Initial commit")
+  system "git branch -m master"
 
   `echo "Some code" >> app.rb`
   repo.add("app.rb")
@@ -37,7 +38,7 @@
 
 solution do
   return false unless repo.commits.length == 5
-  return false unless `git show HEAD` =~ /Some more changes/
+  return false unless `git show HEAD --format=%s` =~ /Some more changes/
   true
 end
 

levels/cherry-pick.rb

@@ -2,8 +2,9 @@
 description "Your new feature isn't worth the time and you're going to delete it. But it has one commit that fills in `README` file, and you want this commit to be on the master as well."
 
 setup do
-    init_from_level
-    `git stash` #fix for README.md being in githug root an the level
+  init_from_level
+  `git stash` # fix for README.md being in githug root an the level
+  system "git branch -m master"
 end
 
 solution do
@@ -13,5 +14,5 @@
 end
 
 hint do
-  puts "Sneak a peek at the `cherry-pick` command."
+  puts "Sneak a peek at the `git help cherry-pick` command."
 end

levels/clone_to_folder.rb

@@ -1,5 +1,5 @@
 difficulty 1
-description "Clone the repository at https://github.com/Gazler/cloneme to `my_cloned_repo`."
+description "Clone the repository at https://github.com/Gazler/cloneme into the folder `my_cloned_repo`."
 
 solution do
   repo("my_cloned_repo").commit("157b2b61f29ab9df45f31c7cd9cb5d8ff06ecde4")

levels/commit.rb

@@ -3,6 +3,7 @@
 
 setup do
   repo.init
+  system "git branch -m master"
   FileUtils.touch("README")
   repo.add("README")
 end