githug 0.4.8 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0669db6aa142549b3fc2ef14253d22be30dd8a26
-  data.tar.gz: a72898cba48c26849715f2ae2a8774fe7760757b
+SHA256:
+  metadata.gz: 1a61d7135f677a3cf9505492d8ec9914fd1fb245accf70e2a16b11f6164a53ea
+  data.tar.gz: be924975c33f0d6695586e495747cdc49ecedb77ae25ea89de91d386a8a925dc
 SHA512:
-  metadata.gz: 221cd4042f23132f2dc79126a5f555f97664560314e83f1374d450840104fc7de7072c7b641c16dc54771236073e6772a6abbbe3dbe770158d5f3262bd666144
-  data.tar.gz: eb7c00c6ceab4ee18609153d84234b7876e9fc3302f57ede7877561eec0eb346223847884080146a96d52cd19327e299369e64610929a336ebb5b77820324a3a
+  metadata.gz: 3b3f4971ab4e041195e23ff567213c10765d518c1eb0886484d708e92761741bd7974b905f4660604e4fca4dfedfbf1b159381e64c3f8d9b1bc0e0198601c66b
+  data.tar.gz: 87d1f7b45360770818033c51ef243954d19a02266bcf0834d98688deed263586d426b0f6f4015d96c1e20f3111a1474f56f3500ce1cc830c858ef6a731e0ea76

data/.travis.yml

@@ -1,11 +1,11 @@
 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:
@@ -13,6 +13,6 @@ matrix:
     - 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'

data/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

data/README.md

@@ -1,5 +1,8 @@
 # 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.
 
@@ -28,6 +31,10 @@ To install Githug, run
 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
 
@@ -142,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
+    ```
+

data/githug.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.name        = "githug"
   s.version     = Githug::VERSION
   s.authors     = ["Gary Rennie"]
-  s.email       = ["webmaster@gazler.com"]
+  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

data/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

data/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

data/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

data/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

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 the branch test_branch at the commit before the last."
 
 setup do
   repo.init
@@ -12,11 +12,12 @@ setup do
   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
 

data/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

data/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 @@ setup do
   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

data/levels/checkout_tag.rb

@@ -26,6 +26,8 @@ setup do
   repo.add("app.rb")
   repo.commit_all("Changes galore")
   repo.git.tag( { 'f' => true }, "v1.5" )
+
+  system "git branch -m master"
 end
 
 solution do

data/levels/checkout_tag_over_branch.rb

@@ -7,6 +7,7 @@ setup do
   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")

data/levels/cherry-pick.rb

@@ -2,8 +2,9 @@ difficulty 3
 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 @@ solution do
 end
 
 hint do
-  puts "Sneak a peek at the `cherry-pick` command."
+  puts "Sneak a peek at the `git help cherry-pick` command."
 end

data/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")

data/levels/commit.rb

@@ -3,6 +3,7 @@ description "The `README` file has been added to your staging area, now commit i
 
 setup do
   repo.init
+  system "git branch -m master"
   FileUtils.touch("README")
   repo.add("README")
 end

data/levels/commit_amend.rb

@@ -1,5 +1,5 @@
 difficulty 2
-description "The `README` file has been committed, but it looks like the file `forgotten_file.rb` was missing from the commit.  Add the file and amend your previous commit to include it."
+description "The `README` file has been committed, but it looks like the file `forgotten_file.rb` was missing from the commit. Add the file and amend your previous commit to include it."
 
 setup do
   repo.init
@@ -7,6 +7,7 @@ setup do
   repo.add("README")
   repo.commit_all("Initial commit")
   FileUtils.touch("forgotten_file.rb")
+  system "git branch -m master"
 end
 
 solution do

data/levels/commit_in_future.rb

@@ -8,6 +8,7 @@ setup do
 
   FileUtils.touch("README")
   repo.add("README")
+  system "git branch -m master"
 end
 
 solution do
@@ -15,5 +16,5 @@ solution do
 end
 
 hint do
-  puts "Build a time machine, move to the future and commit your changes, then go back and verify results ;)."
+  puts "Build a time format, and commit your code using --date parameter for \"future\"."
 end

data/levels/config.rb

@@ -1,5 +1,5 @@
 difficulty 1
-description "Set up your git name and email, this is important so that your commits can be identified."
+description "Set up your git name and email; this is important so that your commits can be identified."
 
 setup do
   repo.init
@@ -29,5 +29,5 @@ solution do
 end
 
 hint do
-  puts "These settings are config settings.  You should run `git help config` if you are stuck."
+  puts "These settings are config settings. You should run `git help config` if you are stuck."
 end

data/levels/conflict.rb

@@ -3,6 +3,7 @@ description "You need to merge mybranch into the current branch (master). But th
 
 setup do
   init_from_level
+  system "git branch -m master"
 end
 
 solution do

data/levels/contribute.rb

@@ -1,5 +1,5 @@
 difficulty 3
-description "This is the final level, the goal is to contribute to this repository by making a pull request on GitHub.  Please note that this level is designed to encourage you to add a valid contribution to Githug, not testing your ability to create a pull request.  Contributions that are likely to be accepted are levels, bug fixes and improved documentation."
+description "This is the final level, the goal is to contribute to this repository by making a pull request on GitHub. Please note that this level is designed to encourage you to add a valid contribution to Githug, not testing your ability to create a pull request. Contributions that are likely to be accepted are levels, bug fixes and improved documentation."
 
 solution do
   location = "/tmp/githug"

data/levels/delete_branch.rb

@@ -3,7 +3,8 @@ difficulty 2
 description "You have created too many branches for your project. There is an old branch in your repo called 'delete_me', you should delete it."
 
 setup do
-    init_from_level
+  init_from_level
+  system "git branch -m master"
 end
 
 solution do
@@ -12,4 +13,4 @@ end
 
 hint do
   puts "Running 'git --help branch' will give you a list of branch commands."
-end
+end

data/levels/diff.rb

@@ -1,8 +1,9 @@
 difficulty 2
-description "There have been modifications to the `app.rb` file since your last commit.  Find out which line has changed."
+description "Since your last commit, file `app.rb` was modified. Find out which line has changed."
 
 setup do
   init_from_level
+  system "git branch -m master"
 end
 
 solution do
@@ -12,5 +13,5 @@ solution do
 end
 
 hint do
-  puts "You are looking for the difference since your last commit.  Don't forget that running `git` on its own will list the possible commands."
+  puts "You are looking for the difference since your last commit. Don't forget that running `git` on its own will list the possible commands."
 end

data/levels/fetch.rb

@@ -9,8 +9,9 @@ setup do
 
   # local repo
   repo.init
+  system "git branch -m master"
 
-    #adds a file to origin/master
+  # adds a file to origin/master
   FileUtils.touch "master_file"
   repo.add        "master_file"
   repo.commit_all 'Commits master_file'
@@ -19,12 +20,12 @@ setup do
   Dir.chdir tmpdir
   repo.init
 
-  #adds a file to origin/master
+  # adds a file to origin/master
   FileUtils.touch "master_file"
   repo.add        "master_file"
   repo.commit_all 'Commits master_file'
-  
-  #adds remote repo
+
+  # adds remote repo
   Dir.chdir cwd
   `git remote add origin #{tmpdir}/.git`
   `git fetch origin --quiet`
@@ -38,31 +39,30 @@ setup do
   FileUtils.touch "file1"
   repo.add        "file1"
   repo.commit_all 'Commits file 1'
-  
+
 end
 
 solution do
   repo.init
   result = true
 
-
   # counts the number of local branches. Should equal 1
   local_branches = repo.branches.size
 
   # after a git fetch command, each branch will be stored in in the .git/FETCH_HEAD file. Each branch is on its own line
-  # This command will count the number of lines, which will give the number of branches 
-  if File.file?('.git/FETCH_HEAD') #checks for file existance
-  	num_remote = File.read(".git/FETCH_HEAD").split("\n").count
+  # This command will count the number of lines, which will give the number of branches
+  if File.file?('.git/FETCH_HEAD') # checks for file existence
+    num_remote = File.read(".git/FETCH_HEAD").split("\n").count
   else
-  	num_remote = 0
+    num_remote = 0
   end
 
   # there should be 1 local branch and 2 remote branches for a success condition
   if local_branches == 1 and num_remote == 2
-  	result = true
+    result = true
   else
-  	result = false
-  end 
+    result = false
+  end
 end
 
 hint do

data/levels/find_old_branch.rb

@@ -1,8 +1,9 @@
 difficulty 4
-description "You have been working on a branch but got distracted by a major issue and forgot the name of it. Switch back to that branch."
+description "You have been working on a branch but got distracted by a major issue. Switch back to that branch even though you forgot the name of it."
 
 setup do
   init_from_level
+  system "git branch -m master"
 end
 
 solution do

data/levels/grep.rb

@@ -3,6 +3,7 @@ description "Your project's deadline approaches, you should evaluate how many TO
 
 setup do
   init_from_level
+  system "git branch -m master"
 end
 
 solution do

data/levels/ignore.rb

@@ -1,9 +1,10 @@
 difficulty 2
-description "The text editor 'vim' creates files ending in `.swp` (swap files) for all files that are currently open.  We don't want them creeping into the repository.  Make this repository ignore `.swp` files."
+description "The text editor 'vim' creates files ending in `.swp` (swap files) for all files that are currently open. We don't want them creeping into the repository. Make this repository ignore those swap files which are ending in `.swp`."
 
 setup do
   repo.init
   FileUtils.touch("README.swp")
+  system "git branch -m master"
   file = File.open(".git/config", "w") do |file|
     file.puts "[core]\nexcludesfile="
   end

data/levels/include.rb

@@ -1,11 +1,12 @@
 difficulty 2
-description "Notice a few files with the '.a' extension.  We want git to ignore all but the 'lib.a' file."
+description "Notice a few files with the '.a' extension. We want git to ignore all the files except the 'lib.a' file."
 
 setup do
   repo.init
   FileUtils.touch("first.a")
   FileUtils.touch("second.a")
   FileUtils.touch("lib.a")
+  system "git branch -m master"
   file = File.open(".git/config", "w") do |file|
     file.puts "[core]\nexcludesfile="
   end
@@ -17,5 +18,5 @@ solution do
 end
 
 hint do
-  puts "Using `git gitignore --help`, read about the optional prefix to negate a pattern."
+  puts "Using `git help ignore`, read about the optional prefix to negate a pattern."
 end

data/levels/init.rb

@@ -6,5 +6,5 @@ solution do
 end
 
 hint do
-  puts "You can type `git` in your shell to get a list of available git commands."
+  puts "You can type `git --help` or  `git` in your shell to get a list of available git commands."
 end

data/levels/log.rb

@@ -1,12 +1,13 @@
 difficulty 2
 
-description "You will be asked for the hash of most recent commit.  You will need to investigate the logs of the repository for this."
+description "Identify the hash of the latest commit."
 
 setup do
   repo.init
   file = File.new("newfile.rb", "w")
   repo.add("newfile.rb")
   repo.commit_all("THIS IS THE COMMIT YOU ARE LOOKING FOR!")
+  system "git branch -m master"
 end
 
 solution do
@@ -14,5 +15,5 @@ solution do
 end
 
 hint do
-  puts "You need to investigate the logs.  There is probably a command for doing that!"
+  puts "You need to investigate the logs. There is probably a command for doing that!"
 end

data/levels/merge.rb

@@ -1,12 +1,13 @@
 difficulty 2
-description "We have a file in the branch 'feature'; Let's merge it to the master branch."
+description "We have a file in the branch 'feature'. Let's merge it with the master branch."
 
 setup do
-	init_from_level
+  init_from_level
+  system "git branch -m master"
 end
 
 solution do
-	File.exists?("file1")	&& File.exists?("file2")
+  File.exists?("file1")	&& File.exists?("file2")
 end
 
 hint do

data/levels/merge_squash.rb

@@ -7,6 +7,7 @@ setup do
   FileUtils.touch "file1"
   repo.add        "file1"
   repo.commit_all "First commit"
+  system "git branch -m master"
 
   repo.git.native :checkout, {"b" => true}, 'long-feature-branch'
   File.open("file3", 'w') { |f| f << "some feature\n" }