githug 0.4.2 → 0.4.3

data/lib/githug/ui.rb

@@ -1,29 +1,23 @@
 module Githug
   module UI
 
-    @@out_stream = STDOUT
-    @@in_stream = STDIN
-
     class << self
 
-      def out_stream=(out)
-        @@out_stream = out
-      end
+      attr_accessor :out_stream, :in_stream
 
-      def in_stream=(in_stream)
-        @@in_stream = in_stream
-      end
+      @out_stream = STDOUT
+      @in_stream = STDIN
 
       def puts(string = "")
-        @@out_stream.puts(string)
+        out_stream.puts(string)
       end
 
       def print(string)
-        @@out_stream.print(string)
+        out_stream.print(string)
       end
 
       def gets
-        @@in_stream.gets
+        in_stream.gets
       end
 
       def word_box(string,width=80,char='*')

data/lib/githug/version.rb

@@ -1,3 +1,3 @@
 module Githug
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

data/spec/githug/cli_spec.rb

@@ -5,115 +5,116 @@ describe Githug::CLI do
 
   before(:each) do
     game = mock.as_null_object
-    @cli = Githug::CLI.new
     Githug::Game.stub(:new).and_return(game)
   end
 
-  it "should print the logo" do
+  it "prints the logo" do
     Githug::UI.should_receive(:word_box).with("Githug")
-    @cli.stub(:make_directory)
-    @cli.play
+    subject.stub(:make_directory!)
+    subject.play
   end
 
-  it "should create a directory if one does not exist" do
+  it "creates a directory if one does not exist" do
     Githug::UI.stub(:ask).and_return(true)
     Dir.should_receive(:mkdir).with("./git_hug")
     Dir.should_receive(:chdir).with("git_hug")
-    @cli.make_directory
+    subject.make_directory!
   end
 
-  it "should not make a directory if you are in the game directory" do
+  it "does not create a directory if you are in the game directory" do
     Dir.stub(:pwd).and_return("/home/git_hug")
     Githug::UI.should_not_receive(:ask)
-    @cli.make_directory
+    subject.make_directory!
   end
 
-  it "should exit if the user selects no" do
+  it "exits if the user selects no" do
     Githug::UI.stub(:ask).and_return(false)
-    lambda {@cli.make_directory}.should raise_error(SystemExit)
+    lambda {subject.prompt_githug_directory!}.should raise_error(SystemExit)
   end
 
-  it "should prompt to change into the directory if it exists" do
+  it "prompts to change into the directory if it exists" do
     File.stub(:exists?).and_return(true)
     Githug::UI.should_receive(:puts).with("Please change into the git_hug directory")
-    lambda {@cli.make_directory}.should raise_error(SystemExit)
+    lambda {subject.check_githug_directory!}.should raise_error(SystemExit)
   end
 
-  describe "test" do
-    it "should perform a test run of the level" do
+  describe "#test" do
+    it "performs a test run of the level" do
       level = mock
       game = mock
-      @cli.stub(:make_directory)
+      subject.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")
+      subject.test("/foo/bar/test/level.rb")
     end
   end
 
   describe "level methods" do
+
+    let(:level) { mock }
+    let(:profile) { mock }
+
     before(:each) do
-      @level = mock
-      @profile = mock
-      @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)
+      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
-      @level.should_receive(:show_hint)
-      @cli.hint
+    it "calls the hint method on the level" do
+      level.should_receive(:show_hint)
+      subject.hint
     end
 
-    describe "reset" do
+    describe "#reset" do
 
 
-      it "should reset the current level" do
-        @level.should_receive(:setup_level)
-        @level.should_receive(:full_description)
+      it "resets the current level" 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
+        subject.reset
       end
 
-      it "should not reset if the level cannot be loaded" do
+      it "does not reset if the level cannot be loaded" do
         Githug::Level.stub(:load).and_return(false)
-        @level.should_not_receive(:setup_level)
-        @level.should_not_receive(:full_description)
+        level.should_not_receive(:setup_level)
+        level.should_not_receive(:full_description)
         Githug::UI.should_receive(:error).with("Level does not exist")
-        @cli.reset
+        subject.reset
       end
 
-      it "should reset the level with a level name" do
-        @level.should_receive(:setup_level)
-        @level.should_receive(:full_description)
+      it "resets the level with a level name" do
+        level.should_receive(:setup_level)
+        level.should_receive(:full_description)
         profile = mock
         Githug::Profile.stub(:load).and_return(profile)
         profile.should_receive(:set_level).with("add")
-        Githug::Level.should_receive(:load).with("add").and_return(@level)
+        Githug::Level.should_receive(:load).with("add").and_return(level)
         Githug::UI.should_receive(:word_box).with("Githug")
         Githug::UI.should_receive(:puts).with("resetting level")
-        @cli.reset("add")
+        subject.reset("add")
       end
 
-      it "should reset the level with a path" do
-        @level.should_receive(:setup_level)
-        @level.should_receive(:full_description)
+      it "resets 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")
+        subject.reset("/foo/bar/level.rb")
       end
     end
 
   end
 
-  describe "levels" do
+  describe "#levels" do
 
-    it "should should print the levels and their numbers" do
+    it "prints the levels and their numbers" do
       Githug::Level.stub(:list).and_return(["commit", "add"])
       Githug::UI.should_receive(:puts).with(["#1: commit", "#2: add"])
-      @cli.levels
+      subject.levels
     end
   end
 

data/spec/githug/game_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Githug::Game do
 
-  let(:profile) { mock(:level => 1, 
+  let(:profile) { mock(:level => 1,
                        :current_attempts => 0).as_null_object }
   let(:game) { Githug::Game.new }
   let(:level) { mock(:full_description => nil, :setup_level => nil) }
@@ -17,11 +17,11 @@ describe Githug::Game do
     Githug::Level.stub(:load).and_return(level)
   end
 
-  it "should have a profile" do
+  it "has a profile" do
     game.profile.should eql(profile)
   end
 
-  it "should show a description if the level is 0" do
+  it "shows a description if the level is 0" do
     level.should_not_receive(:solve)
     profile.stub(:level).and_return(nil)
     profile.should_receive(:level_bump)
@@ -31,27 +31,27 @@ describe Githug::Game do
 
   describe "play_level" do
 
-    it "should echo congratulations if the level is solved" do
+    it "outputs 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
+    it "outputs a message if 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
+    it "increments 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
+    it "prompts 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!")
@@ -63,31 +63,31 @@ describe Githug::Game do
 
 
   describe "test_level" do
-    it "Should output Valid solution if the solution is valid" do
+    it "outputs 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
+    it "outputs 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
+    it "calls test when errors is true" do
       level.should_receive(:test)
       game.test_level(level, true)
     end
   end
 
-  it "should output the description of the next level" do
+  it "outputs the description of the next level" do
     level.should_receive(:full_description)
     profile.stub(:level=)
     game.level_bump
   end
 
-  it "should call setup_level for the next level" do
+  it "calls setup_level for the next level" do
     level.should_receive(:setup_level)
     profile.stub(:level=)
     game.level_bump

data/spec/githug/level_spec.rb

@@ -3,31 +3,11 @@ require 'grit'
 
 describe Githug::Level do
 
-  before(:each) do
-    @file = <<-eof
-difficulty 1
-description "A test description"
-setup do
-  "test"
-end
-solution do
-  Grit::Repo.new("githug/notadir")
-end
+  let(:subject) { Githug::Level.load_from_file(File.expand_path("spec/support/files/test_level.rb")) }
+  let(:repo) { mock(:reset) }
 
-hints [
-  "this is hint 1",
-  "this is hint 2"]
-
-hint do
-  puts "this is a hint"
-end
-    eof
-    File.stub(:exists?).and_return(true)
-    File.stub(:read).and_return(@file)
-    @level = Githug::Level.load("init")
-    @repo = mock
-    @repo.stub(:reset)
-    Githug::Repository.stub(:new).and_return(@repo)
+  before(:each) do
+    Githug::Repository.stub(:new).and_return(repo)
     Githug::UI.stub(:puts)
     Githug::UI.stub(:print)
   end
@@ -36,48 +16,42 @@ end
     Githug::Level.ancestors.should include(Githug::UI)
   end
 
+  describe ".load" do
 
-  describe "load" do
-
-    it "should load the level" do
+    it "loads the level" do
       File.stub(:dirname).and_return("")
-      File.should_receive(:read).with('/../../levels/init.rb').and_return(@file)
-      level = Githug::Level.load("init")
-      level.instance_variable_get("@difficulty").should eql(1)
-      level.instance_variable_get("@description").should eql("A test description")
+      Githug::Level.should_receive(:setup).with("/../../levels/init.rb")
+      Githug::Level.load("init")
     end
 
-    it "should return false if the level does not exist" do
+    it "returns false if the level does not exist" do
       File.stub(:exists?).and_return(false)
       Githug::Level.load(1).should eql(false)
     end
 
   end
 
-  describe "list" do
-    it "should list the levels without nil" do
+  describe ".list" do
+    it "lists the levels without nil" do
       Githug::Level.list.should eql(Githug::Level::LEVELS - [nil])
     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")
+  describe ".load_from_file" do
+    it "loads the level" do
+      subject.instance_variable_get("@difficulty").should eql(1)
+      subject.instance_variable_get("@description").should eql("A test description")
     end
 
-    it "should return false if the level does not exist" do
+    it "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
+  describe ".setup" do
 
-    it "should return false if the level does not exist" do
+    it "returns 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
@@ -85,104 +59,101 @@ end
   end
 
 
-  describe "solve" do
+  describe "#solve" do
 
-    it "should solve the problem" do
-      @level.solve.should eql(false)
+    it "returns false if the level requirements have not been met" do
+      subject.solve.should eql(false)
     end
 
-    it "should return true if the requirements have been met" do
+    it "returns true if the level requirements have been met" do
       Grit::Repo.stub(:new).and_return(true)
-      @level.solve.should eql(true)
+      subject.solve.should eql(true)
     end
 
   end
 
-  describe "test" do
-    it "should call solve" do
-      @level.should_receive(:_solution)
-      @level.test
+  describe "#test" do
+    it "calls solve" do
+      subject.should_receive(:_solution)
+      subject.test
     end
   end
 
 
-  describe "full_description" do
+  describe "#full_description" do
 
-    it "should display a full description" do
+    it "displays a full description" do
       Githug::UI.stub(:puts)
       Githug::UI.should_receive(:puts).with("Level: 1")
       Githug::UI.should_receive(:puts).with("Difficulty: *")
       Githug::UI.should_receive(:puts).with("A test description")
-      @level.full_description
+      subject.full_description
     end
 
   end
 
-  describe "setup" do
+  describe "#setup" do
 
-    it "should call setup" do
-      @level.setup_level.should eql("test")
+    it "calls setup" do
+      repo.should_receive(:reset)
+      subject.setup_level.should eql("test")
     end
 
-    it "should not call the setup if none exists" do
-      @level.instance_variable_set("@setup", nil)
-      lambda {@level.setup_level}.should_not raise_error(NoMethodError)
+    it "does not call the setup if none exists" do
+      subject.instance_variable_set("@setup", nil)
+      lambda {subject.setup_level}.should_not raise_error(NoMethodError)
     end
 
   end
 
 
-  describe "repo" do
+  describe "#repo" do
 
-    it "should initialize a repository when repo is called" do
-      @level.repo.should equal(@repo)
+    it "initializes a repository when repo is called" do
+      subject.repo.should equal(repo)
       Githug::Repository.should_not_receive(:new)
-      @level.repo.should equal(@repo)
-    end
-
-    it "should call reset on setup_level" do
-      @repo.should_receive(:reset)
-      @level.setup_level
+      subject.repo.should equal(repo)
     end
 
   end
 
-  describe "hint" do
+  describe "#hint" do
+
+    let(:profile) { mock.as_null_object }
 
     before(:each) do
-      @profile = mock.as_null_object
-      Githug::Profile.stub(:load).and_return(@profile)
-      @profile.stub(:current_hint_index).and_return(0,0,1,0)
+      profile.stub(:current_hint_index).and_return(0,0,1,0)
+      Githug::Profile.stub(:load).and_return(profile)
     end
 
-    it "should return sequential hint if there are multiple" do
-      @level.should_receive(:puts).ordered.with("this is hint 1")
-      @level.show_hint
+    it "returns sequential hint if there are multiple" do
+      subject.should_receive(:puts).ordered.with("this is hint 1")
+      subject.show_hint
 
-      @level.should_receive(:puts).ordered.with("this is hint 2")
-      @level.show_hint
+      subject.should_receive(:puts).ordered.with("this is hint 2")
+      subject.show_hint
 
-      @level.should_receive(:puts).ordered.with("this is hint 1")
-      @level.show_hint
+      subject.should_receive(:puts).ordered.with("this is hint 1")
+      subject.show_hint
     end
 
-    it "should display a hint if there are not multiple" do
-      @level.instance_variable_set("@hints", nil)
-      @level.should_receive(:puts).with("this is a hint")
-      @level.show_hint
+    it "displays a hint if there are not multiple" do
+      subject.instance_variable_set("@hints", nil)
+      subject.should_receive(:puts).with("this is a hint")
+      subject.show_hint
     end
 
-    it "should not call the hint if none exist" do
-      @level.instance_variable_set("@hint", nil)
-      lambda {@level.show_hint}.should_not raise_error(NoMethodError)
+    it "does not call the hint if none exist" do
+      subject.instance_variable_set("@hint", nil)
+      lambda {subject.show_hint}.should_not raise_error(NoMethodError)
     end
   end
 
-  describe "init_from_level" do
-    it "should copy the files from the level folder" do
-      FileUtils.should_receive(:cp_r).with("#{@level.level_path}/.", ".")
+  describe "#init_from_level" do
+    it "copies the files from the level folder" do
+      FileUtils.should_receive(:cp_r).with("#{subject.level_path}/.", ".")
       FileUtils.should_receive(:mv).with(".githug", ".git")
-      @level.init_from_level
+      subject.init_from_level
     end
   end
 end