githug 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a94e3f45e86a99703cd503e3fc9f7f7d8d0dc41f
-  data.tar.gz: bb3df4d8a23fc33c75b0b2d35bcdce7bfea96701
+  metadata.gz: 90475cdbf217159f69447674586c43346ec23bca
+  data.tar.gz: 3f6ae08fcf6e630fe0ff4e15734481660b5c3de0
 SHA512:
-  metadata.gz: 0135f1e9543ca8a4b47c055a9e60208944ded20cd857ddd357263fc2268820c20d72d3b275a0f9db8e40db6a00b3c358d6b352a754d9474984b75f4fd562f3ce
-  data.tar.gz: 8113e0f346dd092f6b3e056c51ec8941084b602573a156b881d79cde62a50cda03e36a9c1eb8f93d89bd8b8051832eb587873624c5f6833af8d92ce560b0a1e0
+  metadata.gz: 921a1e7f8e9bec2f4b26ae4a7530fac8e0e3cce43ba4dec7aae6dbf7ed593835e2b2c48ada93c3ed3dfda806d5388e8280fef4b999acb4715e0fc053d8443f80
+  data.tar.gz: 17b1d9dc8d7f5c2c82dfabdf946fc7664048f36a1c5049eddc2484e5a0631273ec209f2c3edbd7541a9a394d9198c61ae8a20889bd22d07818fca67bc2e5810e

data/.travis.yml

@@ -1,9 +1,17 @@
 language: ruby
+
 rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+
 before_install:
   - gem update --system 2.1.11
   - git config --global user.email 'user@example.com'

data/README.md

@@ -1,24 +1,24 @@
 # 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)
 ## About
-Githug 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.
+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
-To install Githug
+To install Githug, run
 
     gem install githug
 
-After the gem is installed, you can run `githug` where you will be prompted to create a directory.  Githug should work on Linux, OS X and Windows.
+After the gem is installed, run `githug`.  You will be prompted to create a directory. Githug should work on Linux, OS X and Windows.
 
 ## Commands
 
 Githug has 5 commands:
 
- * play - This is the default command and it will check your solution for the current level.
+ * 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 of the levels
- * test - Used to test levels in development, please see the Testing Levels section.
+ * levels - List all the levels
+ * test - Test levels in development (please see the "Testing Levels" section below)
 
 ## Change Log
 
@@ -27,7 +27,7 @@ The change log is available on the wiki.  [Change log](https://github.com/Gazler
 
 ## Contributing
 
-If you want to suggest a level or make a level that has been suggested, check out [the wiki](https://github.com/Gazler/githug/wiki).
+To suggest a level or create a level that has been suggested, check out [the wiki](https://github.com/Gazler/githug/wiki).
 
  Get yourself on the [contributors list](https://github.com/Gazler/githug/contributors) by doing the following:
 
@@ -39,14 +39,12 @@ If you want to suggest a level or make a level that has been suggested, check ou
 
 ## Todo List
 
- * A follow up to the level, more information on a specific command, etc.
+ * A follow-up to the level, more information on a specific command, etc.
  * More levels!
 
 ## Writing Levels
 
-Githug has a DSL for writing levels
-
-An example level:
+Githug has a DSL for writing levels. Here is an example:
 
 ```ruby
 difficulty 1
@@ -71,7 +69,7 @@ end
 
  `difficulty`, `description` and `solution` are required.
 
-You can also include multiple hints like this:
+You can include multiple hints like this:
 
 ```ruby
 hints [
@@ -83,8 +81,7 @@ hints [
 
  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.)
-
+ 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:
 
@@ -94,23 +91,23 @@ setup do
 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:
+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 perform the following steps:
 
  * mkdir "yourlevel"
  * cd "yourlevel"
  * git init
  * some git stuff
- * **important** rename ".git" to ".githug" so it does not get treated as a submodule
+ * **important** rename ".git" to ".githug" so that it isn't 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.
+After doing this, your level should be able to copy the contents from that git repository and use those for your level.  See the "blame" level for an example of this.
 
 ## Testing Levels
 
 The easiest way to test a level is:
 
- * change into your git_hug repository
+ * Change into your git_hug repository
  * Run `githug reset PATH_TO_YOUR_LEVEL`
  * Solve the level
  * Run `githug test PATH_TO_YOUR_LEVEL`

data/levels/fetch.rb

@@ -28,7 +28,7 @@ setup do
   Dir.chdir cwd
   `git remote add origin #{tmpdir}/.git`
   `git fetch origin --quiet`
-  `git branch -u origin/master master`
+  `git branch -u origin/master master 2> /dev/null`
 
   Dir.chdir tmpdir
   # create a new branch in the remote repo
@@ -67,4 +67,4 @@ end
 
 hint do
   puts "Look up the 'git fetch' command"
-end
+end

data/levels/push.rb

@@ -42,7 +42,7 @@ setup do
   Dir.chdir cwd
   `git remote add origin #{tmpdir}/.git`
   `git fetch origin`
-  `git branch -u origin/master master`
+  `git branch -u origin/master master 2> /dev/null`
 end
 
 solution do

data/levels/push_branch.rb

@@ -49,7 +49,7 @@ setup do
   Dir.chdir cwd
   `git remote add origin #{tmpdir}/.git`
   `git fetch --quiet origin`
-  `git branch -u origin/master master`
+  `git branch -u origin/master master 2> /dev/null`
 
   `git checkout master --quiet` #return to master branch
 end

data/levels/rebase.rb

@@ -0,0 +1,16 @@
+difficulty 2
+
+description "We are using a git rebase workflow and the feature branch is ready to go into master. Let's rebase the master branch into our feature branch."
+
+setup do
+  init_from_level
+end
+
+solution do
+  return repo.commits('feature').last.id_abbrev != "ed0fdcf" &&
+    repo.commits("feature").map(&:message) == ['add feature','add content','init commit']
+end
+
+hint do
+  puts "You want to research the `git rebase` command"
+end

data/levels/rebase/.githug/COMMIT_EDITMSG

@@ -0,0 +1 @@
+add content

data/levels/rebase/.githug/HEAD

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

data/levels/rebase/.githug/ORIG_HEAD

@@ -0,0 +1 @@
+4419b972c0cd1b346ac90332aa7c5cc949589f78

data/levels/rebase/.githug/config

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

data/levels/rebase/.githug/logs/HEAD

@@ -0,0 +1,13 @@
+0000000000000000000000000000000000000000 a78bcab6232e9382a86436cdfcb2ed0391b1f0ac ipmsteven <steven.lyl147@gmail.com> 1418373185 -0800	commit (initial): init commit
+a78bcab6232e9382a86436cdfcb2ed0391b1f0ac a78bcab6232e9382a86436cdfcb2ed0391b1f0ac ipmsteven <steven.lyl147@gmail.com> 1418373194 -0800	checkout: moving from master to feature
+a78bcab6232e9382a86436cdfcb2ed0391b1f0ac ed0fdcf366b21b8984fb37ea34106978a2e5c5ba ipmsteven <steven.lyl147@gmail.com> 1418373239 -0800	commit: add feature
+ed0fdcf366b21b8984fb37ea34106978a2e5c5ba a78bcab6232e9382a86436cdfcb2ed0391b1f0ac ipmsteven <steven.lyl147@gmail.com> 1418373246 -0800	checkout: moving from feature to master
+a78bcab6232e9382a86436cdfcb2ed0391b1f0ac 98205e9faf10cf33d2ef7c0f66e402540c62613a ipmsteven <steven.lyl147@gmail.com> 1418373270 -0800	commit: add content
+98205e9faf10cf33d2ef7c0f66e402540c62613a ed0fdcf366b21b8984fb37ea34106978a2e5c5ba ipmsteven <steven.lyl147@gmail.com> 1418373282 -0800	checkout: moving from master to feature
+ed0fdcf366b21b8984fb37ea34106978a2e5c5ba 98205e9faf10cf33d2ef7c0f66e402540c62613a ipmsteven <steven.lyl147@gmail.com> 1418373314 -0800	rebase: checkout master
+98205e9faf10cf33d2ef7c0f66e402540c62613a 4419b972c0cd1b346ac90332aa7c5cc949589f78 ipmsteven <steven.lyl147@gmail.com> 1418373314 -0800	rebase: add feature
+4419b972c0cd1b346ac90332aa7c5cc949589f78 4419b972c0cd1b346ac90332aa7c5cc949589f78 ipmsteven <steven.lyl147@gmail.com> 1418373314 -0800	rebase finished: returning to refs/heads/feature
+4419b972c0cd1b346ac90332aa7c5cc949589f78 98205e9faf10cf33d2ef7c0f66e402540c62613a ipmsteven <steven.lyl147@gmail.com> 1418373423 -0800	checkout: moving from feature to master
+98205e9faf10cf33d2ef7c0f66e402540c62613a 4419b972c0cd1b346ac90332aa7c5cc949589f78 ipmsteven <steven.lyl147@gmail.com> 1418373435 -0800	checkout: moving from master to feature
+4419b972c0cd1b346ac90332aa7c5cc949589f78 ed0fdcf366b21b8984fb37ea34106978a2e5c5ba ipmsteven <steven.lyl147@gmail.com> 1418373492 -0800	reset: moving to ed0fdcf
+ed0fdcf366b21b8984fb37ea34106978a2e5c5ba 98205e9faf10cf33d2ef7c0f66e402540c62613a ipmsteven <steven.lyl147@gmail.com> 1418373509 -0800	checkout: moving from feature to master

data/levels/rebase/.githug/logs/refs/heads/feature

@@ -0,0 +1,4 @@
+0000000000000000000000000000000000000000 a78bcab6232e9382a86436cdfcb2ed0391b1f0ac ipmsteven <steven.lyl147@gmail.com> 1418373194 -0800	branch: Created from HEAD
+a78bcab6232e9382a86436cdfcb2ed0391b1f0ac ed0fdcf366b21b8984fb37ea34106978a2e5c5ba ipmsteven <steven.lyl147@gmail.com> 1418373239 -0800	commit: add feature
+ed0fdcf366b21b8984fb37ea34106978a2e5c5ba 4419b972c0cd1b346ac90332aa7c5cc949589f78 ipmsteven <steven.lyl147@gmail.com> 1418373314 -0800	rebase finished: refs/heads/feature onto 98205e9faf10cf33d2ef7c0f66e402540c62613a
+4419b972c0cd1b346ac90332aa7c5cc949589f78 ed0fdcf366b21b8984fb37ea34106978a2e5c5ba ipmsteven <steven.lyl147@gmail.com> 1418373492 -0800	reset: moving to ed0fdcf

data/levels/rebase/.githug/logs/refs/heads/master

@@ -0,0 +1,2 @@
+0000000000000000000000000000000000000000 a78bcab6232e9382a86436cdfcb2ed0391b1f0ac ipmsteven <steven.lyl147@gmail.com> 1418373185 -0800	commit (initial): init commit
+a78bcab6232e9382a86436cdfcb2ed0391b1f0ac 98205e9faf10cf33d2ef7c0f66e402540c62613a ipmsteven <steven.lyl147@gmail.com> 1418373270 -0800	commit: add content

data/levels/rebase/.githug/objects/98/205e9faf10cf33d2ef7c0f66e402540c62613a

@@ -0,0 +1,2 @@
+x
��Q
+!@��^�P����2:c-��Y��[�}=x�����4�s��Έ`�1�Lbv�H�ce���a<�Zi�eh˜���I��(�p-�	H6�j�(z�G����琷,���i������h�O�����F@ph��Dc�n��!折u��؇�}�IY

data/levels/rebase/.githug/objects/a7/8bcab6232e9382a86436cdfcb2ed0391b1f0ac

@@ -0,0 +1,4 @@
+x
��Q
+!E�vo
+mE}R��1Y��f}]�p�V�S���FS�1GNkd�tT
+i���7���`,����;�g{���\�\귢��{�.��+�FG��8K'��픎�'.�6/#���;�

data/levels/rebase/.githug/refs/heads/feature

@@ -0,0 +1 @@
+ed0fdcf366b21b8984fb37ea34106978a2e5c5ba

data/levels/rebase/.githug/refs/heads/master

@@ -0,0 +1 @@
+98205e9faf10cf33d2ef7c0f66e402540c62613a

data/levels/rebase/README

@@ -0,0 +1 @@
+readme

data/levels/reorder.rb

@@ -22,10 +22,7 @@ setup do
 end
 
 solution do
-  return false unless repo.commits[2].message == "First commit"
-  return false unless repo.commits[1].message == "Second commit"
-  return false unless repo.commits[0].message == "Third commit"
-  true
+    `git log --format="%s"`.split.join("").match /Third.*Second.*First.*Initial/
 end
 
 hint do

data/levels/restructure.rb

@@ -1,6 +1,6 @@
 difficulty 3
 
-description "You added some files to your repository, but now realize that your project needs to be restructured.  Make a new folder named `src`, and move all of the .html files into this folder."
+description "You added some files to your repository, but now realize that your project needs to be restructured.  Make a new folder named `src` and using Git move all of the .html files into this folder."
 
 setup do
   repo.init

data/lib/githug/cli.rb

@@ -10,9 +10,8 @@ module Githug
 
     def play
       UI.word_box("Githug")
-      make_directory
-      game = Game.new
-      game.play_level
+      make_directory!
+      Game.new.play_level
     end
 
     desc :test, "Test a level from a file path"
@@ -20,10 +19,9 @@ module Githug
 
     def test(path)
       UI.word_box("Githug")
-      make_directory
+      make_directory!
       level = Level.load_from_file(path)
-      game = Game.new
-      game.test_level(level, options[:errors])
+      Game.new.test_level(level, options[:errors])
     end
 
     desc :hint, "Get a hint for the current level"
@@ -35,7 +33,15 @@ module Githug
     end
 
     desc :reset, "Reset the current level"
+    long_desc <<-LONGDESC
+      `githug reset` will reset the current level. You can optionally specify a
+      LEVEL parameter which will reset the game to a specific level. For
+      example:
 
+      > $ githug reset merge_squash
+
+      Will reset githug to level '#45: merge_squash'
+    LONGDESC
     def reset(path = nil)
       level = load_level(path)
       UI.word_box("Githug")
@@ -77,23 +83,32 @@ module Githug
       end
 
 
-      def make_directory
+      def make_directory!
+        return if File.basename(Dir.pwd) == "git_hug"
+        check_githug_directory!
+        prompt_githug_directory!
+        make_githug_directory!
+      end
+
+      def check_githug_directory!
         if File.exists?("./git_hug")
           UI.puts "Please change into the git_hug directory"
           exit
         end
+      end
 
-        unless File.basename(Dir.pwd) == "git_hug"
-          if UI.ask("No githug directory found, do you wish to create one?")
-            Dir.mkdir("./git_hug")
-            Dir.chdir("git_hug")
-          else
-            UI.puts("Exiting")
-            exit
-          end
+      def prompt_githug_directory!
+        unless UI.ask("No githug directory found, do you wish to create one?")
+          UI.puts("Exiting")
+          exit
         end
       end
 
+      def make_githug_directory!
+        Dir.mkdir("./git_hug")
+        Dir.chdir("git_hug")
+      end
+
     end
 
   end

data/lib/githug/level.rb

@@ -9,7 +9,7 @@ module Githug
               "commit_in_future", "reset", "reset_soft", "checkout_file", "remote",
               "remote_url", "pull", "remote_add", "push", "diff", "blame", "branch",
               "checkout", "checkout_tag", "checkout_tag_over_branch", "branch_at",
-              "delete_branch", "push_branch", "merge", "fetch", "repack", "cherry-pick",
+              "delete_branch", "push_branch", "merge", "fetch", "rebase", "repack", "cherry-pick",
               "grep", "rename_commit", "squash", "merge_squash", "reorder", "bisect",
               "stage_lines", "find_old_branch", "revert", "restore", "conflict", "contribute"]
 

data/lib/githug/profile.rb

@@ -7,18 +7,26 @@ module Githug
 
     class << self
       def load
-        settings = {
+        self.new(settings)
+      end
+
+      private
+
+      def settings
+        return defaults unless File.exists?(PROFILE_FILE)
+        defaults.merge(YAML::load(File.open(PROFILE_FILE)))
+      end
+
+      def defaults
+        {
           :level => nil,
           :current_attempts => 0,
           :current_hint_index => 0,
           :current_levels => [],
           :completed_levels => []
         }
-
-        settings.merge! YAML::load(File.open(PROFILE_FILE)) if File.exists?(PROFILE_FILE)
-
-        self.new(settings)
       end
+
     end
 
 
@@ -48,24 +56,25 @@ module Githug
     end
 
     def level_bump
-      levels = Level::LEVELS
-      level_no = levels.index(settings[:level])
-
       settings[:completed_levels] << level
       settings[:current_levels] = levels
-      next_level = (levels - settings[:completed_levels]).first || levels.last
-
       set_level(next_level)
-      next_level
     end
 
     private
 
+    def levels
+      Level::LEVELS
+    end
+
+    def next_level
+      (levels - settings[:completed_levels]).first || levels.last
+    end
+
     def reset!
       settings[:current_attempts] = 0
       settings[:current_hint_index] = 0
     end
 
-
   end
 end