gitscrub 0.0.2

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp
+.rvmrc
+git_scrub/*
+.profile.yml

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/gitscrub

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'gitscrub/cli'
+
+Gitscrub::CLI.start

data/gitscrub.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "gitscrub/version"
+
+Gem::Specification.new do |s|
+  s.name        = "gitscrub"
+  s.version     = Gitscrub::VERSION
+  s.authors     = ["Gary Rennie"]
+  s.email       = ["webmaster@gazler.com"]
+  s.homepage    = ""
+  s.summary     = %q{An interactive way to learn git.}
+  s.description = %q{An interactive way to learn git.}
+
+  s.rubyforge_project = "gitscrub"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec", "~>2.8.0"
+
+  s.add_dependency "grit", "~>2.4.1"
+  s.add_dependency "thor", "~>0.14.6"
+  # s.add_runtime_dependency "rest-client"
+end

data/levels/1.rb

@@ -0,0 +1,5 @@
+difficulty 1
+description "Initialize an empty repository"
+solution do
+  Grit::Repo.new(".")
+end

data/lib/gitscrub/cli.rb

@@ -0,0 +1,46 @@
+require 'thor'
+require 'gitscrub'
+module Gitscrub
+  class CLI < Thor
+
+
+    default_task :setup
+
+    desc :setup, "Initialize the game"
+
+    def setup
+      UI.word_box("Gitscrub")
+      make_directory
+      game = Game.new
+      game.play_level
+    end
+
+    desc :check, "check your current solution"
+
+    def check
+      true
+    end
+
+    desc :reset, "reset the current level"
+
+    def reset
+      true
+    end
+
+    no_tasks do
+
+      def make_directory
+        unless File.exists?("./git_scrub") || Dir.pwd.split("/").last == "git_scrub"
+          if UI.ask("No gitscrubber directory found, do you wish to create one?")
+            Dir.mkdir("./git_scrub")
+          else
+            UI.puts("Exiting")
+            exit
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/gitscrub/game.rb

@@ -0,0 +1,30 @@
+module Gitscrub
+  class Game
+
+    attr_accessor :profile
+
+    def initialize
+      @profile = Profile.load
+    end
+
+    def play_level
+      solve = true
+      if profile.level == 0
+        UI.puts("Welcome to Gitscrub")
+        profile.level = 1
+        profile.save
+        solve = false
+      else
+        level = Level.load(profile.level)
+        if solve
+          if level.solve  
+            UI.puts "Congratulations, you have solved the level"
+          else
+            UI.puts "Sorry, this solution is not quite right!"
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/gitscrub/level.rb

@@ -0,0 +1,37 @@
+module Gitscrub
+  class Level
+
+    attr_accessor :ldifficulty, :ldescription, :lsolution
+    
+    class << self
+      
+      def load(level_no)
+        level = new
+        location = "#{File.dirname(__FILE__)}/../../levels/#{level_no}.rb"
+        level.instance_eval(File.read(location))
+        level
+      end
+
+    end
+
+    def difficulty(num)
+      @ldifficulty = num
+    end
+
+    def description(description)
+      @ldescription = description
+    end
+
+    def solution(&block)
+      @lsolution = block
+    end
+
+    def solve
+      lsolution.call
+      true
+    rescue
+      false
+    end
+
+  end
+end

data/lib/gitscrub/profile.rb

@@ -0,0 +1,41 @@
+require 'yaml'
+module Gitscrub
+  class Profile
+    PROFILE_FILE = ".profile.yml"
+
+    attr_accessor :settings
+
+    class << self
+      def load
+        settings = {
+          :level => 0
+        }
+
+        settings.merge! YAML::load(File.open(PROFILE_FILE)) if File.exists?(PROFILE_FILE)
+        self.new(settings)
+      end
+    end
+
+
+    def method_missing(method, *args, &block)
+      if method.to_s.end_with?("=")
+        method = method.to_s.chop.to_sym
+        return settings[method] = args[0] if settings.include?(method)
+      end
+      return(settings[method]) if settings.include?(method)
+      super
+    end
+
+    def initialize(settings)
+      @settings = settings
+    end
+
+    def save
+      File.open(PROFILE_FILE, 'w') do |out|
+        YAML.dump(settings, out)
+      end
+    end
+
+
+  end
+end

data/lib/gitscrub/ui.rb

@@ -0,0 +1,56 @@
+module Gitscrub
+  class UI
+
+    @@out_stream
+    @@in_stream
+
+    class << self
+      
+      def out_stream=(out)
+        @@out_stream = out
+      end
+
+      def in_stream=(in_stream)
+        @@in_stream = in_stream
+      end
+
+      def puts(string)
+        @@out_stream.puts(string)
+      end
+
+      def print(string)
+        @@out_stream.print(string)
+      end
+
+      def gets
+        @@in_stream.gets
+      end
+
+      def line
+        puts("*"*80)
+      end
+
+      def word_box(string)
+        space_length = (80/2) - ((string.length/2)+1)
+        line
+        print "*"
+        print " "*space_length
+        print string
+        print " "*space_length
+        puts "*"
+        line
+      end
+
+      def request(msg)
+        print(msg)
+        gets.chomp
+      end
+      
+      def ask(msg)
+        request("#{msg} [yn] ") == 'y'
+      end
+
+    end
+
+  end
+end

data/lib/gitscrub/version.rb

@@ -0,0 +1,3 @@
+module Gitscrub
+  VERSION = "0.0.2"
+end

data/lib/gitscrub.rb

@@ -0,0 +1,10 @@
+require 'grit'
+require "gitscrub/version"
+
+require 'gitscrub/ui'
+require 'gitscrub/game'
+require 'gitscrub/profile'
+require 'gitscrub/level'
+
+Gitscrub::UI.in_stream = STDIN
+Gitscrub::UI.out_stream = STDOUT

data/spec/gitscrub/cli_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'gitscrub/cli'
+
+describe Gitscrub::CLI do
+  
+  before(:each) do
+    game = mock.as_null_object
+    @cli = Gitscrub::CLI.new
+    Gitscrub::Game.stub(:new).and_return(game)
+  end
+
+  it "should print the logo" do
+    Gitscrub::UI.should_receive(:word_box).with("Gitscrub")
+    @cli.stub(:make_directory) 
+    @cli.setup
+  end
+
+  it "should create a directory if one does not exist" do
+    Gitscrub::UI.stub(:ask).and_return(true) 
+    Dir.should_receive(:mkdir).with("./git_scrub")
+    @cli.make_directory
+  end
+
+  it "should not make a directory if you are in the game directory" do
+    Dir.stub(:pwd).and_return("/home/git_scrub")
+    Gitscrub::UI.should_not_receive(:ask)
+    @cli.make_directory 
+  end
+
+  it "should create a directory if one does not exist" do
+    Gitscrub::UI.stub(:ask).and_return(false) 
+    lambda {@cli.make_directory}.should raise_error(SystemExit)
+  end
+
+  it "should check the current solution" do
+    @cli.check.should eql(true) 
+  end
+
+  it "should reset the current level" do
+    @cli.check.should eql(true) 
+  end
+  
+end

data/spec/gitscrub/game_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Gitscrub::Game do
+  
+  before(:each) do
+    @profile = mock
+    Gitscrub::Profile.stub(:new).and_return(@profile)
+    @game = Gitscrub::Game.new
+    @profile.stub(:level).and_return(1)
+    @profile.stub(:save)
+    @level = mock
+    Gitscrub::UI.stub(:puts)
+    Gitscrub::Level.stub(:load).and_return(@level)
+  end
+
+  it "should have a profile" do
+    @game.profile.should eql(@profile)
+  end
+
+  it "should show a description if the level is 0" do
+    @level.should_not_receive(:solve)
+    @profile.stub(:level).and_return(0) 
+    @profile.should_receive(:save)
+    Gitscrub::UI.should_receive(:puts).with("Welcome to Gitscrub")
+    @profile.should_receive(:level=).with(1)
+    @game.play_level
+  end
+
+  it "should echo congratulations if the level is solved" do
+    @level.stub(:solve).and_return(true)
+    Gitscrub::UI.should_receive(:puts).with("Congratulations, you have solved the level")
+    @game.play_level
+  end
+
+  it "should echo congratulations if the level is solved" do
+    @level.stub(:solve).and_return(false)
+    Gitscrub::UI.should_receive(:puts).with("Sorry, this solution is not quite right!")
+    @game.play_level
+  end
+  
+end

data/spec/gitscrub/level_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'grit'
+
+describe Gitscrub::Level do
+  
+  before(:each) do
+    @file = <<-eof
+difficulty 1
+description "A test description"
+solution do
+  Grit::Repo.new("gitscrub/notadir")
+end
+    eof
+    File.stub(:read).and_return(@file)
+    @level = Gitscrub::Level.load(1)
+  end
+
+  it "should load the level" do
+    File.stub(:dirname).and_return("")
+    File.should_receive(:read).with('/../../levels/1.rb').and_return(@file)
+    level = Gitscrub::Level.load(1)
+    level.ldifficulty.should eql(1)
+    level.ldescription.should eql("A test description")
+  end
+
+  it "should solve the problem" do
+    @level.solve.should eql(false)
+  end
+
+  it "should return true if the requirements have been met" do
+    Grit::Repo.stub(:new).and_return(true) 
+    @level.solve.should eql(true)
+  end
+  
+end

data/spec/gitscrub/profile_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Gitscrub::Profile do
+  
+  before(:each) do
+  end
+
+  it "should load the profile" do
+    settings = {:level => 1}
+    File.should_receive(:exists?).with(Gitscrub::Profile::PROFILE_FILE).and_return(true)
+    File.should_receive(:open).with(Gitscrub::Profile::PROFILE_FILE).and_return("settings")
+    YAML.should_receive(:load).with("settings").and_return(settings)
+    Gitscrub::Profile.should_receive(:new).with(settings)
+    Gitscrub::Profile.load
+  end
+
+  it "should load the defaults if the file does not exist" do
+    defaults = {:level => 0}
+    Gitscrub::Profile.should_receive(:new).with(defaults)
+    Gitscrub::Profile.load
+  end
+
+  it "should allow method acces to getters and setters" do
+    profile = Gitscrub::Profile.load
+    profile.level.should eql(0)
+    profile.level = 1
+    profile.level.should eql(1)
+  end
+
+  it "should save the file" do
+    profile = Gitscrub::Profile.load
+    File.should_receive(:open).with(Gitscrub::Profile::PROFILE_FILE, "w")
+    profile.save
+  end
+  
+end

data/spec/gitscrub/ui_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+require 'spec_helper'
+
+describe Gitscrub::UI do
+
+  before(:each) do
+    @ui = Gitscrub::UI
+    @out = StringIO.new
+    @in = StringIO.new
+    @ui.out_stream = @out
+    @ui.in_stream = @in
+  end
+
+  it "should put to the stream" do
+    @ui.puts("hello") 
+    @out.string.should eql("hello\n")
+  end
+
+  it "should print without a new line" do
+    @ui.print("hello")
+    @out.string.should eql("hello")
+  end
+
+  it "should fetch gets from input stream" do
+    @in.puts "bar"
+    @in.rewind
+    @ui.gets.should == "bar\n"
+  end
+
+  it "should make a line" do
+    @ui.line
+    @out.string.should eql("*"*80+"\n")
+  end
+
+  it "should make a wordbox" do
+    word_box = <<-eof
+********************************************************************************
+*                                   Gitscrub                                   *
+********************************************************************************
+    eof
+    @ui.word_box("Gitscrub")
+    @out.string.should eql(word_box)
+  end
+
+
+  it "should request text input" do
+    @in.puts "bar"
+    @in.rewind
+    @ui.request("foo").should == "bar"
+    @out.string.should == "foo"
+  end
+
+  it "should ask for yes/no and return true when yes" do
+    @ui.should_receive(:request).with('foo? [yn] ').and_return('y')
+    @ui.ask("foo?").should be_true
+  end
+  
+  it "should ask for yes/no and return false when no" do
+    @ui.stub(:request).and_return('n')
+    @ui.ask("foo?").should be_false
+  end
+  
+  it "should ask for yes/no and return false for any input" do
+    @ui.stub(:request).and_return('aklhasdf')
+    @ui.ask("foo?").should be_false
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require './lib/gitscrub.rb'

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: gitscrub
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Gary Rennie
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-07 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.8.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: grit
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.4.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.14.6
+  type: :runtime
+  version_requirements: *id003
+description: An interactive way to learn git.
+email: 
+- webmaster@gazler.com
+executables: 
+- gitscrub
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- Rakefile
+- bin/gitscrub
+- gitscrub.gemspec
+- levels/1.rb
+- lib/gitscrub.rb
+- lib/gitscrub/cli.rb
+- lib/gitscrub/game.rb
+- lib/gitscrub/level.rb
+- lib/gitscrub/profile.rb
+- lib/gitscrub/ui.rb
+- lib/gitscrub/version.rb
+- spec/gitscrub/cli_spec.rb
+- spec/gitscrub/game_spec.rb
+- spec/gitscrub/level_spec.rb
+- spec/gitscrub/profile_spec.rb
+- spec/gitscrub/ui_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: gitscrub
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: An interactive way to learn git.
+test_files: []
+