githug 0.1.5 → 0.1.6

data/Gemfile

@@ -1,4 +1,4 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in gitscrub.gemspec
+# Specify your gem's dependencies in githug.gemspec
 gemspec

data/README.md

@@ -9,7 +9,7 @@ To install Githug
 
     gem install githug
 
-After the gem is installed, you can run `githug` where you will be prompted to create a directory.
+After the gem is installed, you can run `githug` where you will be prompted to create a directory.  Githug should work on Linux and OS X.
 
 ##Commands
 

data/levels/branch_at.rb

@@ -0,0 +1,25 @@
+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" 
+
+setup do
+  repo.init
+  FileUtils.touch("file1")
+  repo.add("file1")
+  repo.commit_all("Adding file1")
+  File.open("file1", 'w') { |f| f.write("content") }
+  repo.add("file1")
+  repo.commit_all("Updating file1")
+  File.open("file1", 'a') { |f| f.write("\nAdding some more text") }
+  repo.add("file1")
+  repo.commit_all("Updating file1 again")
+end
+
+solution do
+  solved = false
+  solved = true if repo.branches.map(&:name).include?("test_branch") and (repo.commits("test_branch").last.message ==  "Updating file1")
+  solved
+end
+
+hint do
+  puts "Just like creating a branch, but you have to pass an extra argument"
+end

data/levels/contribute.rb

@@ -1,5 +1,5 @@
 difficulty 3
-description "Contribute to this repository by making a pull request on Github"
+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/tag.rb

@@ -0,0 +1,18 @@
+difficulty 2
+
+description "We have a git repo and we want to tag the current commit with new_tag."
+
+setup do
+    repo.init
+    FileUtils.touch("somefile.txt")
+    repo.add("somefile.txt")
+    repo.commit_all("Added some file to the repo")
+end
+
+solution do
+    repo.tags.first.name == "new_tag"
+end
+
+hint do
+    puts "Take a look at `git tag`"
+end

data/lib/githug/cli.rb

@@ -15,6 +15,17 @@ module Githug
       game.play_level
     end
 
+    desc :test, "Test a level from a file path"
+    method_option :errors, :type => :boolean, :default => false
+
+    def test(path)
+      UI.word_box("Githug")
+      make_directory
+      level = Level.load_from_file(path)  
+      game = Game.new
+      game.test_level(level, options[:errors])
+    end
+
     desc :hint, "Get a hint for the current level"
 
     def hint
@@ -25,12 +36,19 @@ module Githug
 
     desc :reset, "Reset the current level"
 
-    def reset
-      if level = load_level
-        UI.word_box("Githug")
+    def reset(path = nil)
+      if path
+        level = Level.load_from_file(path)
+      else
+        level = load_level
+      end
+      UI.word_box("Githug")
+      if level
         UI.puts("resetting level")
         level.setup_level
         level.full_description
+      else
+        UI.error("Level does not exist")
       end
     end
 

data/lib/githug/game.rb

@@ -34,9 +34,15 @@ module Githug
       end
     end
 
-    def dry_run(level)
-      level = Level.load(level)
-
+    def test_level(level, errors = nil)
+      UI.puts level.full_description
+      method = :solve
+      method = :test if errors
+      if level.send(method)
+        UI.success "Valid solution"
+      else
+        UI.error "Invalid solution"
+      end
     end
 
     def level_bump

data/lib/githug/level.rb

@@ -4,21 +4,31 @@ module Githug
 
     LEVELS = [nil, "init", "add", "commit", "config", "clone",
               "clone_to_folder", "ignore", "status", "rm", "rm_cached", "rename",
-              "log", "commit_ammend", "reset", "checkout_file", "remote",
+              "log", "tag",  "commit_ammend", "reset", "checkout_file", "remote",
               "remote_url", "remote_add", "diff", "blame", "branch", "checkout",
-              "merge", "squash", "contribute"]
+              "branch_at", "merge", "squash", "contribute"]
 
     attr_accessor :level_no, :level_path
     
     class << self
       
       def load(level_name)
+        path = "#{File.dirname(__FILE__)}/../../levels/#{level_name}.rb"
+        setup(path)
+      end
+
+      def load_from_file(path)
+        setup(path)
+      end
+
+      def setup(path)
+        level_name = File.basename(path, File.extname(path))
+        #Remove .rb extension, WTB a better way to do this
+        level_path = path[0..-4]
         level = new
-        level_path = "#{File.dirname(__FILE__)}/../../levels/#{level_name}"
-        location = "#{level_path}.rb"
-        return false unless File.exists?(location)
-        level.instance_eval(File.read(location))
-        level.level_no = LEVELS.index(level_name)
+        return false unless File.exists?(path)
+        level.instance_eval(File.read(path))
+        level.level_no = LEVELS.index(level_name) || 1
         level.level_path = level_path
         level
       end
@@ -78,6 +88,10 @@ module Githug
       false
     end
 
+    def test
+      @solution.call
+    end
+
     def show_hint
       UI.word_box("Githug")
       profile = Profile.load

data/lib/githug/level.rb.orig

@@ -0,0 +1,120 @@
+module Githug
+  class Level
+    include UI
+
+    LEVELS = [nil, "init", "add", "commit", "config", "clone",
+              "clone_to_folder", "ignore", "status", "rm", "rm_cached", "rename",
+<<<<<<< HEAD
+              "log", "tag",  "commit_ammend", "reset", "checkout_file", "remote",
+              "remote_url", "remote_add", "diff", "blame", "branch", "checkout",
+=======
+              "log", "commit_ammend", "reset", "checkout_file", "remote",
+              "remote_url", "remote_add", "diff", "blame", "branch", "checkout", "branch_at",
+>>>>>>> manojlds/master
+              "merge", "squash", "contribute"]
+
+    attr_accessor :level_no, :level_path
+    
+    class << self
+      
+      def load(level_name)
+        path = "#{File.dirname(__FILE__)}/../../levels/#{level_name}.rb"
+        setup(path)
+      end
+
+      def load_from_file(path)
+        setup(path)
+      end
+
+      def setup(path)
+        level_name = File.basename(path, File.extname(path))
+        #Remove .rb extension, WTB a better way to do this
+        level_path = path[0..-4]
+        level = new
+        return false unless File.exists?(path)
+        level.instance_eval(File.read(path))
+        level.level_no = LEVELS.index(level_name) || 1
+        level.level_path = level_path
+        level
+      end
+
+    end
+
+    def init_from_level
+      FileUtils.cp_r("#{level_path}/.", ".")
+      FileUtils.mv(".githug", ".git")
+    end
+
+    def difficulty(num)
+      @difficulty = num
+    end
+
+    def description(description)
+      @description = description
+    end
+
+    def solution(&block)
+      @solution = block
+    end
+
+    def setup(&block)
+      @setup = block 
+    end
+
+    def hint(&hint)
+      @hint = hint
+    end
+
+    def hints(hints)
+      @hints = hints
+    end
+
+    def full_description
+      UI.puts
+      UI.puts "Level: #{level_no}"
+      UI.puts "Difficulty: #{"*"*@difficulty}"
+      UI.puts
+      UI.puts @description
+      UI.puts
+    end
+
+    def setup_level
+      repo.reset
+      @setup.call if @setup
+    end
+
+    def repo(location = "")
+      @repo ||= Repository.new(location)
+    end
+
+    def solve
+      @solution.call
+    rescue
+      false
+    end
+
+    def test
+      @solution.call
+    end
+
+    def show_hint
+      UI.word_box("Githug")
+      profile = Profile.load
+      current_hint_index = profile.current_hint_index
+      if @hints
+        puts @hints[current_hint_index]
+        if current_hint_index < @hints.size - 1
+          profile.current_hint_index += 1
+          profile.save
+        else
+          profile.current_hint_index = 0
+          profile.save
+        end
+      elsif @hint
+        @hint.call
+      else
+        UI.puts("No hints available for this level")
+      end
+    end
+  end
+end

data/lib/githug/version.rb

@@ -1,3 +1,3 @@
 module Githug
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/spec/githug/cli_spec.rb

@@ -40,6 +40,18 @@ describe Githug::CLI do
     lambda {@cli.make_directory}.should raise_error(SystemExit)
   end
 
+  describe "test" do
+    it "should perform a test run of the level" do
+      level = mock
+      game = mock
+      @cli.stub(:make_directory)
+      Githug::Level.should_receive(:load_from_file).with("/foo/bar/test/level.rb").and_return(level)  
+      Githug::Game.stub(:new).and_return(game)
+      game.should_receive(:test_level).with(level, anything)
+      @cli.test("/foo/bar/test/level.rb")
+    end
+  end
+
   describe "level methods" do
     before(:each) do
       @level = mock
@@ -47,6 +59,7 @@ describe Githug::CLI do
       @profile.stub(:level).and_return(1)
       Githug::Profile.stub(:load).and_return(@profile)
       Githug::Level.stub(:load).and_return(@level)
+      Githug::Level.stub(:load_from_file).with("/foo/bar/level.rb").and_return(@level)
     end
 
     it "should call the hint method on the level" do
@@ -69,10 +82,17 @@ describe Githug::CLI do
         Githug::Level.stub(:load).and_return(false)
         @level.should_not_receive(:setup_level)
         @level.should_not_receive(:full_description)
-        Githug::UI.should_not_receive(:word_box).with("Githug")
-        Githug::UI.should_not_receive(:puts).with("resetting level")
+        Githug::UI.should_receive(:error).with("Level does not exist")
         @cli.reset
       end
+
+      it "should reset the level with a path" do
+        @level.should_receive(:setup_level)
+        @level.should_receive(:full_description)
+        Githug::UI.should_receive(:word_box).with("Githug")
+        Githug::UI.should_receive(:puts).with("resetting level")
+        @cli.reset("/foo/bar/level.rb")
+      end
     end  
 
   end

data/spec/githug/game_spec.rb

@@ -29,7 +29,7 @@ describe Githug::Game do
     @game.play_level
   end
 
-  describe "solve" do
+  describe "play_level" do
 
     it "should echo congratulations if the level is solved" do
       @level.stub(:solve).and_return(true)
@@ -62,10 +62,22 @@ describe Githug::Game do
   end
 
 
-  describe "dry run" do
-    it "should play the game without altering the profile" do
-      Level.should_receive(:load)
-      @level.dry_run  
+  describe "test_level" do
+    it "Should output Valid solution if the solution is valid" do
+      @level.stub(:solve).and_return(true) 
+      Githug::UI.should_receive(:success).with("Valid solution")
+      @game.test_level(@level)
+    end
+   
+    it "Should output Invalid solution if the solution is invalid" do
+      @level.stub(:solve).and_return(false) 
+      Githug::UI.should_receive(:error).with("Invalid solution")
+      @game.test_level(@level)
+    end
+
+    it "should call test when errors is true" do
+      @level.should_receive(:test)
+      @game.test_level(@level, true)
     end
   end
 

data/spec/githug/level_spec.rb

@@ -54,6 +54,30 @@ end
 
   end
 
+  describe "load_from_file" do
+    it "should load the level" do
+      File.stub(:dirname).and_return("")
+      File.should_receive(:read).with('/foo/bar/test/level.rb').and_return(@file)
+      level = Githug::Level.load_from_file("/foo/bar/test/level.rb")
+      level.instance_variable_get("@difficulty").should eql(1)
+      level.instance_variable_get("@description").should eql("A test description")
+    end
+
+    it "should return false if the level does not exist" do
+      File.stub(:exists?).and_return(false)
+      Githug::Level.load_from_file("/foo/bar/test/level.rb").should eql(false)
+    end
+  end
+
+  describe "setup" do
+
+    it "should return false if the level does not exist" do
+      File.stub(:exists?).and_return(false)
+      Githug::Level.setup("/foo/bar/test/level.rb").should eql(false)
+    end
+
+  end
+
 
   describe "solve" do
     
@@ -68,6 +92,13 @@ end
 
   end
 
+  describe "test" do
+    it "should call solve" do
+      @level.instance_variable_get("@solution").should_receive(:call) 
+      @level.test
+    end  
+  end
+
 
   describe "full_description" do
 
@@ -148,4 +179,4 @@ end
       @level.init_from_level
     end  
   end
-end
+end

metadata

@@ -2,7 +2,7 @@
 name: githug
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors: 
 - Gary Rennie
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-16 00:00:00 +00:00
+date: 2012-03-18 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -113,6 +113,7 @@ files:
 - levels/blame/.githug/refs/heads/master
 - levels/blame/config.rb
 - levels/branch.rb
+- levels/branch_at.rb
 - levels/checkout.rb
 - levels/checkout_file.rb
 - levels/clone.rb
@@ -185,10 +186,12 @@ files:
 - levels/rm_cached.rb
 - levels/squash.rb
 - levels/status.rb
+- levels/tag.rb
 - lib/githug.rb
 - lib/githug/cli.rb
 - lib/githug/game.rb
 - lib/githug/level.rb
+- lib/githug/level.rb.orig
 - lib/githug/profile.rb
 - lib/githug/repository.rb
 - lib/githug/ui.rb