githug 0.0.10 → 0.1.0

data/README.md

@@ -23,13 +23,19 @@ Githug has 3 commands:
 
  Get yourself on the [contributors list](https://github.com/Gazler/githug/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/githug/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
+ * Fork the repository
+ * Make a level in the levels directory (covered below)
+ * Add your level to the LEVELS array inside `lib/githug/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
+##Todo List
+
+ * A better way of returning from the solution block
+ * A follow up to the level, more information on a specific command, etc.
+ * More levels!
+
+##Writing Levels
 
 Githug has a DSL for writing levels
 

data/levels/checkout_file.rb

@@ -0,0 +1,25 @@
+difficulty 3
+
+description "A file has been modified, but you don't want to keep the files.  Checkout the `config.rb` file from the last commit."
+
+setup do
+  repo.init
+  File.open("config.rb", "w") do |file|
+    file.puts("This is the initial config file")
+  end
+
+  repo.add("config.rb")
+  repo.commit_all("Added initial config file")
+
+  File.open("config.rb", "a") do |file|
+    file.puts("These are changed you don't want to keep!")
+  end
+end
+
+solution do
+  repo.status.files["config.rb"].type != "M" && repo.commits.length == 2
+end
+
+hint do
+  puts "You will need to do some research on the checkout command for this one."
+end

data/levels/commit_ammend.rb

@@ -0,0 +1,18 @@
+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 ammend your previous commit to include it."
+
+setup do
+  repo.init
+  FileUtils.touch("README")
+  repo.add("README")
+  repo.commit_all("Initial commit")
+  FileUtils.touch("forgotten_file.rb")
+end
+
+solution do
+  repo.commits.length == 2 && repo.commits.first.stats.files.length == 2
+end
+
+hint do
+  puts "Running `git commit --help` will display the man page and possible flags."
+end

data/levels/remote.rb

@@ -0,0 +1,16 @@
+difficulty 2
+
+description "This projects has a remote repository.  Identify it."
+
+setup do
+  repo.init
+  repo.remote_add("my_remote_repo", "https://github.com/Gazler/githug")
+end
+
+solution do
+  "my_remote_repo" == request("What is the name of the remote repository?")
+end
+
+hint do
+  puts "You are looking for a remote.  You can run `git` for a list of commands"
+end

data/levels/remote_add.rb

@@ -0,0 +1,16 @@
+difficulty 2
+
+description "Add a remote repository called `origin` with the url `https://github.com/githug/githug`"
+
+setup do
+  repo.init
+end
+
+solution do
+  result = `git remote -v`
+  result.include?("https://github.com/githug/githug")
+end
+
+hint do
+  puts "You can run `git remote --help` for the man pages"
+end

data/levels/remote_url.rb

@@ -0,0 +1,17 @@
+difficulty 2
+
+description "The remote repositories have a url associated to them.  Please enter the url of remote_location"
+
+setup do
+  repo.init
+  repo.remote_add("my_remote_repo", "https://github.com/Gazler/githug")
+  repo.remote_add("remote_location", "https://github.com/githug/not_a_repo")
+end
+
+solution do
+  "https://github.com/githug/not_a_repo" == request("What is the url of the remote repository?")
+end
+
+hint do
+  puts "You can run `git remote --help` for the man pages"
+end

data/levels/reset.rb

@@ -0,0 +1,22 @@
+difficulty 2
+description "There are two files to be committed.  The goal was to add each file as a separate commit, however both were added by accident.  Unstage the file `to_commit_second` using the reset command"
+
+setup do
+  repo.init
+  FileUtils.touch("README")
+  repo.add("README")
+  repo.commit_all("Initial commit")
+  FileUtils.touch("to_commit_first.rb")
+  FileUtils.touch("to_commit_second.rb")
+  repo.add(".")
+end
+
+solution do
+  return false unless (repo.status.files["to_commit_second.rb"].nil? || repo.status.files["to_commit_second.rb"].stage.nil?) && File.exists?("to_commit_second.rb")
+  return false if (repo.status.files["to_commit_first.rb"].nil? || repo.status.files["to_commit_first.rb"].stage.nil?)
+  true
+end
+
+hint do
+  puts "You can get some useful information for git status, it will tell you the command you need to run"
+end

data/levels/rm_cached.rb

@@ -1,10 +1,11 @@
 difficulty 2
 
-description "A file has accidentally been added to your staging area, find out which file and remove it from the staging area.  *NOTE* Do not remove the file system, only from git."
+description "A file (deleteme.rb) has accidentally been added to your staging area, find out which file and remove it from the staging area.  *NOTE* Do not remove the file system, only from git."
 
 setup do
-  repo.init
-  file = File.new("deleteme.rb", "w") 
+  repo.init(false)
+  FileUtils.touch("deleteme.rb")
+  repo.add(".gitignore")
   repo.add("deleteme.rb")
 end
 

data/lib/githug/game.rb

@@ -21,6 +21,13 @@ module Githug
             level_bump
           else
             UI.error "Sorry, this solution is not quite right!"
+            profile.current_attempts += 1
+            profile.save
+
+            if (profile.current_attempts > 2 && profile.current_attempts % 3 == 0)
+              UI.error "Don't forget you can type `githug hint` for a hint and `githug reset` to reset the current level"
+            end
+
             UI.puts level.full_description
           end
         end

data/lib/githug/level.rb

@@ -4,7 +4,8 @@ module Githug
 
     LEVELS = [nil, "init", "add", "commit", "config", "clone",
               "clone_to_folder", "ignore", "status", "rm", "rm_cached", "log",
-              "diff", "blame", "contribute"]
+              "commit_ammend", "reset", "checkout_file", "remote", "remote_url",
+              "remote_add", "diff", "blame", "contribute"]
 
     attr_accessor :level_no, :level_path
     

data/lib/githug/profile.rb

@@ -9,6 +9,7 @@ module Githug
       def load
         settings = {
           :level => nil,
+          :current_attempts => 0,
           :current_levels => [],
           :completed_levels => [] 
         }
@@ -47,6 +48,8 @@ module Githug
 
       settings[:current_levels] = levels
 
+      settings[:current_attempts] = 0
+
       next_level = (levels - settings[:completed_levels]).first || levels.last
 
       settings[:level] = next_level

data/lib/githug/version.rb

@@ -1,3 +1,3 @@
 module Githug
-  VERSION = "0.0.10"
+  VERSION = "0.1.0"
 end

data/spec/githug/game_spec.rb

@@ -3,12 +3,13 @@ require 'spec_helper'
 describe Githug::Game do
   
   before(:each) do
-    @profile = mock
+    @profile = mock.as_null_object
     Githug::Profile.stub(:new).and_return(@profile)
     @game = Githug::Game.new
     @profile.stub(:level).and_return(1)
     @profile.stub(:save)
     @profile.stub(:level_bump)
+    @profile.stub(:current_attempts).and_return(0)
     @level = mock
     @level.stub(:full_description)
     @level.stub(:setup_level)
@@ -28,17 +29,36 @@ describe Githug::Game do
     @game.play_level
   end
 
-  it "should echo congratulations if the level is solved" do
-    @level.stub(:solve).and_return(true)
-    @profile.should_receive(:level_bump)
-    Githug::UI.should_receive(:success).with("Congratulations, you have solved the level")
-    @game.play_level
-  end
+  describe "solve" do
+
+    it "should echo congratulations if the level is solved" do
+      @level.stub(:solve).and_return(true)
+      @profile.should_receive(:level_bump)
+      Githug::UI.should_receive(:success).with("Congratulations, you have solved the level")
+      @game.play_level
+    end
+
+    it "should echo the solution is not right" do
+      @level.stub(:solve).and_return(false)
+      Githug::UI.should_receive(:error).with("Sorry, this solution is not quite right!")
+      @game.play_level
+    end
+
+    it "should increment the number of failed attempts" do
+      @level.stub(:solve).and_return(false)
+      @profile.should_receive(:current_attempts=).with(1)
+      @profile.should_receive(:save)
+      @game.play_level
+    end
+
+    it "should prompt for a hint if the user has failed 3 times." do
+      @profile.stub(:current_attempts).and_return(3)
+      @level.stub(:solve).and_return(false)
+      Githug::UI.should_receive(:error).with("Sorry, this solution is not quite right!")
+      Githug::UI.should_receive(:error).with("Don't forget you can type `githug hint` for a hint and `githug reset` to reset the current level")
+      @game.play_level
+    end
 
-  it "should echo congratulations if the level is solved" do
-    @level.stub(:solve).and_return(false)
-    Githug::UI.should_receive(:error).with("Sorry, this solution is not quite right!")
-    @game.play_level
   end
 
   it "should output the description of the next level" do

data/spec/githug/profile_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Githug::Profile do
 
   it "should load the profile" do
-    settings = {:level => 1, :current_levels => [], :completed_levels => []}
+    settings = {:level => 1, :current_attempts => 0, :current_levels => [], :completed_levels => []}
     File.should_receive(:exists?).with(Githug::Profile::PROFILE_FILE).and_return(true)
     File.should_receive(:open).with(Githug::Profile::PROFILE_FILE).and_return("settings")
     YAML.should_receive(:load).with("settings").and_return(settings)
@@ -12,7 +12,7 @@ describe Githug::Profile do
   end
 
   it "should load the defaults if the file does not exist" do
-    defaults = {:level => nil, :current_levels => [], :completed_levels => []}
+    defaults = {:level => nil, :current_attempts => 0, :current_levels => [], :completed_levels => []}
     File.should_receive(:exists?).with(Githug::Profile::PROFILE_FILE).and_return(false)
     Githug::Profile.should_receive(:new).with(defaults)
     Githug::Profile.load
@@ -48,6 +48,12 @@ describe Githug::Profile do
       @profile.level_bump.should eql("add")
     end
 
+    it "should reset the current_attempts" do
+      @profile.current_attempts = 1
+      @profile.level_bump
+      @profile.current_attempts.should eql(0)
+    end
+
     it "should set the level to the first incomplete level" do
       @profile.settings.stub(:[]).with(:level).and_return("rm_cached")
       @profile.settings.stub(:[]).with(:completed_levels).and_return(["init", "add"])

metadata

@@ -2,7 +2,7 @@
 name: githug
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.10
+  version: 0.1.0
 platform: ruby
 authors: 
 - Gary Rennie
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-14 00:00:00 +00:00
+date: 2012-03-15 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -100,9 +100,11 @@ files:
 - levels/blame/.githug/objects/ff/d39c2dbfd94bdbca06d48686e0cbda642f3de7
 - levels/blame/.githug/refs/heads/master
 - levels/blame/config.rb
+- levels/checkout_file.rb
 - levels/clone.rb
 - levels/clone_to_folder.rb
 - levels/commit.rb
+- levels/commit_ammend.rb
 - levels/config.rb
 - levels/contribute.rb
 - levels/diff.rb
@@ -132,6 +134,10 @@ files:
 - levels/ignore.rb
 - levels/init.rb
 - levels/log.rb
+- levels/remote.rb
+- levels/remote_add.rb
+- levels/remote_url.rb
+- levels/reset.rb
 - levels/rm.rb
 - levels/rm_cached.rb
 - levels/status.rb