blirb 0.0.1

data/.autotest

@@ -0,0 +1,13 @@
+require 'autotest/growl'
+require 'autotest/fsevent'
+
+Autotest.add_hook :initialize do |autotest|
+  %w{.git .DS_Store vendor}.each do |exception|
+    autotest.add_exception(exception)
+  end
+  false
+end
+
+Autotest.add_hook :green do
+  Kernel.system('find . -name "*.rb" | xargs grep -n "# DEBT"')
+end

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.rspec

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

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in lorem.gemspec
+gemspec
+
+
+
+
+
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 ian asaff
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# Blirb
+
+Blirb is a ruby teaching and practice tool that sits on top of IRB, also known 
+as the "Interactive Ruby Shell". It can be used in two different ways:
+
+## Using Blirb to learn
+
+As a student, Blirb can be used in tutorial mode by running `./bin/blirb`. 
+The student selects a task to complete that involves various ruby concepts. 
+He is then dropped into a special IRB session where several additional global 
+commands have been added.
+
+
+    The following commands are available during the tutorial (irb) session:
+    
+    	task - print the current task's description
+    	done - test to see if you've completed the current task
+    	help! - view this menu
+    
+    To exit from the tutorial menu, type 'q' or 'exit'.
+    
+    
+Below the command list appears a list of selectable tasks:
+    
+    Please choose a task by entering a task number:
+
+    0 - set a variable 'dude' with a value, any value
+    1 - set an instance variable 'dude' with a value... any value
+    
+    > 
+
+
+The student types the number of the task and hits enter to choose which task to 
+complete. Once in the IRB shell, the student simply completes the task and uses 
+the `done` command:
+
+    Please choose a task by entering task number:
+    
+    0 - set a variable 'dude' with a value, any value
+    1 - set an instance variable 'dude' with a value... any value
+    
+    > 0
+    Ok. set a variable 'dude' with a value, any value. Let's get started.
+    ruby-1.9.2-p180 :001 > dude = :hi_mom
+     => :hi_mom 
+    ruby-1.9.2-p180 :002 > done
+    nice. that worked.
+    =========================
+
+
+After completing a task, the student arrives back at the initial task menu. 
+Blirb remembers completed tasks and only lists those that haven't been 
+completed in the current session. In the case below, only task 1 is shown 
+because task 0 has already been completed.
+
+
+    To exit from the tutorial menu, type 'q' or 'exit'.
+    
+    Please choose a task by entering task number:
+    
+    1 - set an instance variable 'dude' with a value... any value
+    
+    >
+
+
+## Using Blirb to teach
+
+Blirb has a tiny DSL used to define tasks in `blirb_tasks/tasks.rb`. A custom 
+tasks file can also be passed in on the command line. Tasks can be defined as 
+follows:
+
+    task "description of task (this is what the student reads)", %{
+      code that will be eval'd to test if the task has been passed
+    }
+
+
+When Blirb is started up, it will read either the default task file located in 
+`blirb_tasks/tasks.rb` or the one passed in on the command line.
+
+## Final Thought
+
+I'm not Jerry Springer, so you're out of luck. But, if you think this project 
+is useful and would like to contribute, please fork it! I'd love for this to 
+become a standard tool in a new rubyist's toolbox.

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+# RSpec::Core::RakeTask.new(:rcov) do |spec|
+#   spec.pattern = 'spec/**/*_spec.rb'
+#   spec.rcov = true
+# end
+
+task :default => :spec

data/bin/blirb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/blirb'
+
+# # if a tasks file is passed in, parse the yml-based tasks and feed them to blirb
+
+if ARGV[0]
+  blirb = Blirb::Coordinator.new ARGV.shift
+else
+  blirb = Blirb::Coordinator.new
+end
+
+blirb.go

data/blirb.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "blirb/version"
+
+Gem::Specification.new do |s|
+  s.name        = "blirb"
+  s.version     = Blirb::VERSION
+  s.authors     = ["ian asaff"]
+  s.email       = ["ian.asaff@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{command line ruby tutorial adventure}
+  s.description = %q{ruby adventure awaits! also, you will learn stuff.}
+
+  s.rubyforge_project = "blirb"
+
+  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"
+  # s.add_development_dependency "rcov"
+  # s.add_runtime_dependency "rest-client"
+end

data/blirb_tasks/tasks.rb

@@ -0,0 +1,71 @@
+# Example tasks file
+# 
+# the format of a task is as follows:
+# 
+# task "description of task", %{
+#   test code -- code to test that task was completed
+# }, %{
+#   verification code -- code that performs the task to that the test will pass 
+# }
+
+task "Set a variable 'dude' with a value, any value", %{
+  defined?(dude)
+}, %{
+  dude = :dude
+}
+
+task "Set an instance variable 'dude' with a value... any value", %{
+  defined?(@dude)
+}, %{
+  @dude = :dude
+}
+
+task "Create a class 'Bro' that has an instance method 'fist_bump'. The method should return a symbol ':yeah_bro'", %{
+  Bro.new.fist_bump == :yeah_bro
+}, %{
+  class Bro
+    def fist_bump
+      :yeah_bro
+    end
+  end
+}
+
+task "Give 'Bro' a class method called 'protein_shake' that returns the string 'getting hyooge!'", %{
+  Bro.protein_shake == 'getting hyooge!'
+}, %{
+  class Bro
+    def self.protein_shake
+      "getting hyooge!"
+    end
+  end
+}
+
+task "Define 'Bro' so that he has a private method 'drink_natty_ice'. The method should return :yah_dude", %{
+  bro = Bro.new
+  bro.private_methods.include?(:drink_natty_ice) && bro.send(:drink_natty_ice) == :yah_dude
+}, %{
+  class Bro
+    private
+    def drink_natty_ice
+      :yah_dude
+    end
+  end
+}
+
+task "Create a 'Bro' object in the variable 'brah'. Give brah (and only brah) the ability to chug_chug_chug, which will return :full", %{
+  broo = Bro.new
+  (brah.chug_chug_chug == :full) && (brah.methods - broo.methods == [:chug_chug_chug]) && (brah.private_methods - broo.private_methods).empty?
+}, %{
+  brah = Bro.new
+  def brah.chug_chug_chug
+    :full
+  end
+}
+
+task "Create a new 'LittleBro' object that inherits from 'Bro'", %{
+  LittleBro.ancestors[1] == Bro
+}, %{
+  class Bro; end
+  class LittleBro < Bro; end
+}
+

data/lib/blirb.rb

@@ -0,0 +1,6 @@
+require 'irb'
+require_relative 'blirb/commands'
+require_relative 'blirb/task'
+require_relative 'blirb/behaviors'
+require_relative 'blirb/core_extensions'
+require_relative 'blirb/coordinator'

data/lib/blirb/behaviors.rb

@@ -0,0 +1,42 @@
+# adds blirb functionality
+module Blirb
+  module Behaviors
+    module ClassMethods
+    end
+
+    module InstanceMethods
+
+      def help!
+        puts 
+        Blirb::COMMANDS.each do |command|
+          puts %{\t\t#{command}}
+        end
+        puts 
+      end
+
+      def task
+        Object.class_eval do
+          puts @blirb.current_task.description if @blirb.current_task
+        end
+      end
+
+      def done
+        b = context.workspace.binding
+        Object.class_eval do
+          if @blirb.current_task.test!(b)
+            puts "Nice. That worked."
+            puts "========================="
+            @blirb.menu
+          else
+            puts "Test failed. Try again."
+          end
+        end
+      end
+    end
+
+    def self.included(receiver)
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+    end
+  end
+end

data/lib/blirb/commands.rb

@@ -0,0 +1,7 @@
+module Blirb
+  COMMANDS = [
+      "task - print the current task's description",
+      "done - test to see if you've completed the current task",
+      "help! - view this menu"
+    ]
+end

data/lib/blirb/coordinator.rb

@@ -0,0 +1,82 @@
+module Blirb
+  class Coordinator  
+    attr_reader :current_task, :tasks
+    DEFAULT_TASKS = 'blirb_tasks/tasks.rb'
+    
+    def initialize file_path = nil
+      @tasks = []
+      load_tasks file_path  || DEFAULT_TASKS
+      @current_task = nil
+      blirb = self
+      Object.class_eval do
+        @blirb = blirb
+      end
+    end
+
+    def go
+      menu
+      IRB.start
+    end
+
+    # displays menu, sets the current task
+    def menu
+      end_tutorial if remaining_tasks.empty?
+      list_commands
+      puts "\nPlease choose a task by entering task number (completed tasks will not appear):\n\n"
+      list_tasks
+
+      while true
+        print "\n> "
+        if integer?( (selection = gets.chomp) ) && @tasks[(selection = selection.to_i)]
+          select_task selection
+          break
+        elsif selection == 'q' || selection == 'exit' # variety is the spice of life
+          exit
+        end
+        puts "Sorry, I'm not sure what you're trying to do. Please do something different."
+      end
+    end
+
+    private
+    def list_commands
+      puts "\nThe following commands are available during the tutorial (irb) session:\n\n"
+      Blirb::COMMANDS.each do |command|
+        puts "\t#{command}\n"
+      end
+      puts "\nTo exit from the tutorial menu, type 'q' or 'exit'.\n"
+    end
+
+    def select_task selection
+      @current_task = @tasks[selection]
+      puts "Ok. #{@current_task.description}. Let's get started."
+    end
+
+    def list_tasks
+      @tasks.each_with_index do |task, index|
+        puts "#{index} - #{task.description}" unless task.passed?
+      end
+    end
+
+    def end_tutorial
+      puts "Thanks for completing the tutorial. FORK ME ON GITHUB!"
+      exit
+    end
+
+    def load_tasks file_path
+      eval File.read(file_path)
+    end
+
+    # used for task definitions in blirb_tasks/tasks.rb
+    def task description, test_code, validation_code
+      @tasks << Task.new(description, test_code, validation_code)
+    end
+
+    def remaining_tasks
+      @tasks.select {|task| !task.passed?}
+    end
+
+    def integer? n
+      n =~ /^\d+\Z/
+    end
+  end
+end

data/lib/blirb/core_extensions.rb

@@ -0,0 +1,3 @@
+class Object
+  include Blirb::Behaviors
+end

data/lib/blirb/task.rb

@@ -0,0 +1,30 @@
+# Represents a task that a user must complete
+module Blirb
+  class Task
+    attr_reader :test,:description
+
+    def initialize(description, test, verification_code)
+      @description = description
+      @passed = false
+      @test = test
+      @verification_code = verification_code
+    end
+
+    def test!(b)
+      @passed = !!eval(@test,b)
+    end
+
+    def passed?
+      @passed
+    end
+    
+    def verify!(b)
+      begin
+        eval(@verification_code, b)
+        test!(b)
+      rescue
+        false
+      end
+    end
+  end
+end

data/lib/blirb/version.rb

@@ -0,0 +1,3 @@
+module Blirb
+  VERSION = "0.0.1"
+end

data/spec/blirb_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Blirb" do
+  it "fails" do
+    # fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'blirb'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end
+
+class TaskTester
+  TASKS_TO_VERIFY = 'blirb_tasks/tasks.rb'
+  
+  attr_reader :tasks
+  def initialize(file_path=nil)
+    file_path ||= TASKS_TO_VERIFY
+    @tasks = []
+    eval File.read(file_path)
+  end
+  
+  # used for task definitions in blirb_tasks/tasks.rb
+  def task description, test_code, validation_code
+    @tasks << ::Blirb::Task.new(description, test_code, validation_code)
+  end
+end

data/spec/task_spec.rb

@@ -0,0 +1,9 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "each task" do
+  it "has verification code that allows it to pass" do
+    TaskTester.new.tasks.each do |task|
+      task.verify!(binding).should be_true
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: blirb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- ian asaff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-17 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70314144342360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70314144342360
+description: ruby adventure awaits! also, you will learn stuff.
+email:
+- ian.asaff@gmail.com
+executables:
+- blirb
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .autotest
+- .document
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/blirb
+- blirb.gemspec
+- blirb_tasks/tasks.rb
+- lib/blirb.rb
+- lib/blirb/behaviors.rb
+- lib/blirb/commands.rb
+- lib/blirb/coordinator.rb
+- lib/blirb/core_extensions.rb
+- lib/blirb/task.rb
+- lib/blirb/version.rb
+- pkg/blirb-0.0.1.gem
+- spec/blirb_spec.rb
+- spec/spec_helper.rb
+- spec/task_spec.rb
+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: blirb
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: command line ruby tutorial adventure
+test_files:
+- spec/blirb_spec.rb
+- spec/spec_helper.rb
+- spec/task_spec.rb