ruby_drills 0.1.0

data/lib/ruby_drills/cli.rb

@@ -0,0 +1,76 @@
+module RubyDrills
+
+  # Manage the processing of command line options
+  class CLI
+
+    class << self
+
+      # @return [Proc] The Proc defining the valid command line options.
+      attr_accessor :options
+
+      # @return [Array] The Procs that process the parsed options.
+      attr_accessor :option_processors
+
+      # @return [Array<String>] The input array of strings to process
+      #   as CLI options.
+      attr_accessor :input_args
+
+      # Add another set of CLI options (a Slop block)
+      def add_options(&block)
+        if options
+          old_options = options
+          self.options = proc do
+            instance_exec(&old_options)
+            instance_exec(&block)
+          end
+        else
+          self.options = block
+        end
+        self
+      end
+
+      # Add a block responsible for processing parsed options.
+      def process_options(&block)
+        self.option_processors ||= []
+        option_processors << block
+        self
+      end
+
+      # Clear `options` and `option_processors`
+      def reset
+        self.options = nil
+        self.option_processors = nil
+      end
+
+      def parse_options(args=ARGV.dup)
+        unless options
+          raise NoOptionsError, "No command line options defined! Use RubyDrills::CLI.add_options to add command line options."
+        end
+
+        self.input_args = args
+
+        opts = Slop.parse!(args, :help => true, :multiple_switches => false, &options)
+
+        # Option processors are optional.
+        if option_processors
+          option_processors.each { |processor| processor.call(opts) }
+        end
+
+        self
+      end
+
+    end
+
+    reset
+  end
+end
+
+RubyDrills::CLI.add_options do
+  on :v, :version, "Display the version" do
+    puts "RubyDrills version #{RubyDrills::VERSION} on Ruby #{RUBY_VERSION}"
+    exit
+  end
+end.process_options do |opts|
+  exit if opts.help?
+  Starter.new
+end

data/lib/ruby_drills/commands.rb

@@ -0,0 +1,106 @@
+module Commands
+  GAMBLER = File.read(File.join(File.dirname(__FILE__), 'data/gambler.ascii'))
+
+  # Each command returns a response indicating whether or not the drill is complete.
+  def continue
+    puts "\nPress any key to continue:"
+    Chomper.get_char
+    system('clear');
+    true
+  end
+
+  def fail(input, message=nil)
+    puts "\n\tnot yet...".yellow
+    RubyDrills::Config::SESSIONS.attempt(self.class.name, input, reference, 'fail')
+    puts message.yellow unless message.nil?
+    false
+  end
+
+  def win(input)
+    puts "\n\t!!! WIN !!!\n".green
+    RubyDrills::Config::SESSIONS.attempt(self.class.name, input, reference, 'pass')
+    if (reference != input.strip)
+      puts "How does your answer compare to the reference solution?"
+      puts reference
+    end
+    true
+  end
+
+  def skip
+    puts "\n\tskipping...for now...".yellow
+    true
+  end
+
+  def review
+    puts "\n\t#{reference}".green
+    puts "\n\ttry this one again soon...".yellow
+    true
+  end
+
+  def fold
+    puts GAMBLER
+    puts "\nYou got to know when to hold 'em, know when to fold 'em...\n".yellow
+    true
+  end
+
+  def hint
+    puts hints.rotate!.last
+    false
+  end
+
+  def back
+    puts "\tYou're already at the first drill".yellow if !previous
+    previous
+  end
+
+  def clear
+    system('clear')
+    false
+  end
+
+  def help
+      puts %{
+For each drill, type in some Ruby.
+Answer correctly and you'll get a 'WIN' on the board.
+Otherwise, you'll see 'not yet'.
+
+These commands are also available to you:
+
+    help:\tthis screen
+    show:\tshow the problem description
+    hint:\tget unstuck
+    back:\tback to the previous drill
+    skip:\ton to the next drill
+    review:\tsee the answer
+    clear:\tclear the screen
+    menu:\tback to the main menu
+    exit:\tend your session}
+    false
+  end
+
+  def welcome
+    puts %{
+Welcome to Ruby Drills!
+
+Drills are a way to engage in deliberate practice to master a language.
+Challenges in Ruby Drills focus on a specific method.
+Answers typically consist of a single line.
+Your objective is to complete the drill with ease and joy,
+without consulting any external documentation.
+
+-----------------------------------------------------------------------
+}
+  end
+
+  def quit
+    system('clear')
+    puts %{
+      Mastery...the mysterious process during which what is at first difficult
+      becomes progressively easier and more pleasurable through practice.
+
+                                                            --- George Leonard}
+    puts
+    exit
+  end
+
+end

data/lib/ruby_drills/config.rb

@@ -0,0 +1,19 @@
+module RubyDrills
+  class Config
+
+    SESSIONS = Sessions::CollectorClient.new
+
+    def self.pry_config
+      Pry.config.pager = false
+
+      Pry.config.prompt = [
+        proc { |target_self, nest_level, pry|
+          "#{":#{nest_level}" unless nest_level.zero?}>> "
+          },
+          proc { |target_self, nest_level, pry|
+            "#{":#{nest_level}" unless nest_level.zero?}* "
+          }
+        ]
+    end
+  end
+end

data/lib/ruby_drills/data/gambler.ascii

@@ -0,0 +1,65 @@
+7I,.:=,===~~,~~:~~:,~=~~:,:~~~,~::.....,..,,,,,~77:?+777I=I777?:+I?????????+,,~~
+III++?,~~:~~:~=::~~.~~~~~.:~~~:,............,?7?:,:,,777I=I77I?+~,..,~::~~~~~,~~
+III=?I::~~:~::~::~~.:~~~~.:~~~................,,.,,,,,,=?+?I7I???+I,~~~:~~~~:,~~
+I??..:~~~~:~~,~::~:,,~~:~.:~~..................,......,.?+?77??+++?,:~~:~~~~:,~~
+I??II,+=:~::~,:~:::,.~~:~.:~....................,,..,,...++I7I?++??,::~,~~::,,~~
+I???=.++,,~:~:,:,~,:.~~:~.,:...................,,,,,:::,.==II?+=?I+.::~:~~~~,,~~
+????~,.,~.~::~::~~::.,~::.:.....................,~=,~+,.,,~II++=??+.::::~~::.,::
+??????~++:,~~:~:~~::,,:::......................,.,~,,::,,.=II===?=?,::::~:::.,:~
+??????..:,~,~,::::::,.~~~,................,.....,,,,,,:,.,=II===?+=,::::::::.:~~
+???I???+,?:.~::::~~:,.:~:.......................,,..,...,.=II++=?+~,::~::~::.:~~
+???????+:?:,,:::::~::.,::......................,..,,..,:..+?I+=~=+=,::~~:~:,.::~
+??I????....?.:~,::::,..~.................,,..,:.,......,..?=I=~~:+:,::~::::,.:~~
+????I.....,:,,:::::::,.:...,....,...,,,,,.,......,..,.....?=I==~:+,,::~::::..:~~
+++I..............,:~::..,,..........,,,:,,:,,:,.,..,,,,...?~+~~~,+,,::~~~::..:::
+??....................:=:..,,,....,...,,::,~::,,,,.,,,,,:.?~+~~~,~.,:,:~:::.,::~
+??:........................,==,.......,:,,,:::::,,,,,:,,,,I,=::~,~.,:::~::,.,:::
+???............................,==:...,,,,,,,,.,,:,,,::,,,I,=::,,:.,::~~::,.,::~
++?+?................................:+==,,..........,::,:~I.~,,,.:.:::~:::,.,:::
++++++,.....................................~++=,:,...,~:,??.:,,,.,.::~~~::,.::~:
++++?++?....,.....................................:==+=~~~??.,,,,.:.::~:~::,,::~,
++?????+?,..,,,,:~~+++::.,:,,,,,...................................,=I?=::,..::~.
+???????=...,,,.::~~:,:::~~,:~~==~...~?+:................................~?..::~.
+?+???+=,.....,,:.,..~:::==+===,,,=?:~++??????:.............................=:::,
+++???+,...........,~:::~=+++++++??+=+=+???==~,,..............................:,,
+++??+~.......,,...:.~~,~=+?+?+??????==+??+++=,.+?+=~,~.......................:,:
++?++=:.......=,..::I=:,~=++???????+=+=+++=+++??~~.=:~=:.~:::................::,:
+++++~........,..:=+++::~=++??++++++====++++?+I?+??+++~~:~:~~,..............~::,:
+???+,...........:++II,:~=++++?????==~~=++????+???????+~=+~~+,+.......,~::.,~:,,:
++++~............~??I=,:~==+++?????===+?I????????????++~+:.~=+:.....::~~:,.:~:,::
+++:.........:..,~+I??::~~==+?????=~:~+++++??I??????+++=+.:..~~..:::,:~~:,,~~:::,
++~..............,??I?::~~==+?????+=,,.:,,~=??I????+++=I?,...,:..::=~,:~:,~~::::~
+=,..............~+???::~==+??=::,,::=:~~:,+++??+?+++II+?:,=:,..~~~~~:.....,:::~~
+...............,,????::~=+++,~.:,::::,::~::+?+?+++++??++:~=+.:++=~=~::,..,,..,~~
+.................+?I?~:~=++,=,::,~::==:==~::+?+++++???I=:==:....,+~,,::~~~~:,:~:
+................:=+?+~:~=+===~++=+I?.,,==~=:+++++++?II?::=......~,,..:::~:=~~=~:
+................,????+?==+,==+=+++=+==~~,,~+?+?+++I???~~~?.....==,,=,:,,,::::~~=
+..........,.....,~==+?:,,::==+===~=~=+++++:~+++++?I?II,,.......,,,,~:,.=~,:,:::~
+......,.....,....,~:::=~,:,=+=++++=++++=++=~++++??????..........,,,,:.,+~:,,=::~
+...,...............:~,,~~:+=,?:==++++=+?+++:+++??+I?I+......,......,:.:,::,.,=::
+....,.......,....?,::.~===,~=~~=??==?I?+~+?=,..~??+?~..................:,:.:,,::
+............,..,.II,.~,~::==?~~+?+I++?I?+~+??==~+??+.......................:,.::
+...........,..,,.III...=,,,,=????+?=I7?IIII+?==?+=~...........................:~
+...,.,.....,.,.,=I7II...,,:,+:?=++?I+=+???+I????II,...........................,:
+.,,........,,...IIIII7....,~:,+=?I?.,+~+?===,~IIII.............................:
+...,.,..........I=~.II=,,,,,::~::?:+=,=,=~+=IIIIII,............................,
+,,..,.,...,:.....7I..II::,,,,:,,,,,,:~~:++=?II?III=............................,
+,....,...,.,,,..,,,77777I====~:~~~~~==+++=+7III7II7.............................
+..,:,,,...:,,.,,,:I77777777I7==7==++++++=~+7I7I?77:,............................
+,,..,...::..?77777777777777777777?+=++=~~+II7I7,,.,.............................
+..,~..,,.77II77777777II77777777777777~~=:IIII,.,............................,...
+,,.,:,,,:I77777777III77777777777777777?,I7I+.,..............................,...
+,.,.,,....777II777I777777777I77777777I7III?=...................................,
+:,........77I7I77I7777777777777777777777II?I,...................................
+,,,,,.....+777I777777777777777777777777777??..............................,.....
+,:,,,......77IIII77I77777777I77777777777777I..................,.................
+..,,.,.....?777777II77I7I7777777777777777I7I,...................................
+,,,.,.......77I++???????????I777777777777777,,,...........................,,.,.,
+,,..::..:+???I???I??IIIIIII7II777777777777777.,..........,...............,..,,.,
+.,:,,=?I??IIIIII?I??I????????7777777777777777I.............................,.,,.
+.,,,=IIIIIIII???=~,,77I777777I7777777I7III7777,...........................,...,,
+:...+IIIIII?????I???IIIIIIII??III777II77I77I,,,........................,.......,
+...:??IIIIIIIIIII?IIIIIIIIIIIIII7II7I7I777II..............................,..,,,
+...:?IIIIIIIIIIII?+I??????+????I77I77777?III.,......................,.......,,,,
+,.,:?IIIIIIII?I?+++?IIIII??IIIIII7I77IIIII??...,.......................,..,,,,:,
+..:~?IIIIIIIIII7IIIIIIIIIIIIIII7777IIIIII+++.,,,,,....................,,,,,,,,,,

data/lib/ruby_drills/drill.rb

@@ -0,0 +1,66 @@
+class Drill
+  include Commands
+  attr_accessor :next, :previous, :hints
+
+  def initialize
+    setup
+    @context = Pry.binding_for(self)
+  end
+
+  def drills
+    # Composite pattern: Allow for drill.start to work in the REPL or in tests.
+    [self]
+  end
+
+  def expected
+    eval(reference)
+  end
+
+  def done?(input)
+    case input.to_sym
+    when :menu
+      RubyDrills::Config::SESSIONS.command(self.class.name, input)
+      clear
+      true
+    when :exit
+      RubyDrills::Config::SESSIONS.command(self.class.name, input)
+      quit
+    when :show
+      RubyDrills::Config::SESSIONS.command(self.class.name, input)
+      show
+    when lambda {|s| Commands.instance_methods.include?(s) }
+      RubyDrills::Config::SESSIONS.command(self.class.name, input)
+      self.send(input)
+    else
+      check_answer(input)
+    end
+  end
+
+private
+
+  def check_answer(input)
+    begin
+      Pry.run_command input, :context => @context, :output =>  answer = StringIO.new
+      Pry.run_command reference, :context => @context, :output => exp = StringIO.new
+
+      puts answer.string
+
+      return fail(input) if answer.string != exp.string
+      return false if !comparable_answer?(input)
+      win(input)
+    rescue SyntaxError => ex
+      puts "SyntaxError"
+      fail(input)
+    rescue StandardError => ex
+      puts "#{ex.inspect}"
+      fail(input)
+    end
+  end
+
+  def comparable_answer?(input)
+    valid?(input).tap do |pass|
+      fail(input, "\tyou have the right answer, but try a different method.") if !pass
+    end
+  end
+
+end

data/lib/ruby_drills/drills.rb

@@ -0,0 +1,52 @@
+class Drills
+  include Commands
+
+  def start
+    drill = linked_drills[0]
+    while drill do
+      drill.show
+
+      begin
+        input = Readline.readline("\n>> ", true)
+      end while (!drill.done?(input))
+
+      case input
+      when 'back'
+        drill = drill.previous
+        clear
+      when 'menu'
+        break
+      else
+        drill = drill.next
+        continue
+      end
+
+    end
+  end
+
+  # Creates a linked list from the array of drills
+  def linked_drills
+    ordered_drills.tap do |linked|
+      for i in 0..linked.size-1
+        linked[i].previous = linked[i-1] unless (i == 0)
+        linked[i].next = linked[i+1] unless (i == linked.size-1)
+      end
+    end
+  end
+
+  # deliver drills in random order
+  def ordered_drills
+    drills.shuffle
+  end
+
+  # Determines the list of drills in this directory
+  def drills
+    mod = self.class.name.gsub(/Drills/, '').downcase
+    Dir["#{File.dirname(__FILE__)}/#{mod}/*drill.rb"].map do |f|
+      require f
+      name = File.basename(f, '.rb')
+      clazz = name.split('_').map(&:capitalize).join
+      Module.const_get(clazz).new
+    end
+  end
+end

data/lib/ruby_drills/hash/hash_drills.rb

@@ -0,0 +1,17 @@
+class HashDrills < Drills
+
+  def banner
+    %{
+Ruby Drills: Hash
+
+A Hash is a dictionary-like collection of unique keys and their values.
+Also called associative arrays, they are similar to Arrays, but where an
+Array uses integers as its index, a Hash allows you to use any object type.
+
+COMING SOON
+
+------------------------------------------------------------------
+}
+  end
+
+end

data/lib/ruby_drills/sessions/collector_client.rb

@@ -0,0 +1,39 @@
+require 'securerandom'
+require 'httparty'
+
+module Sessions
+  class CollectorClient
+    include HTTParty
+    base_uri 'https://drill-collector.herokuapp.com'
+    # base_uri 'http://localhost:9091'
+    # debug_output $stderr
+
+    attr_reader :session_id
+
+    def initialize
+      @session_id = SecureRandom.urlsafe_base64
+    end
+
+    def command(name, input)
+      store({context: name, input: input, type: 'command'})
+    end
+
+    def attempt(name, input, reference, result)
+      store({context: name, input: input, reference: reference, result: result, type: 'attempt'})
+    end
+
+ private
+
+    def store(entry)
+      Thread.new do
+        begin
+          data = entry.merge(timestamp: Sessions::Timestamp.collector, session_id: @session_id)
+          self.class.post('/record', {:body => data})
+        rescue => e
+          # silent scream for now...
+        end
+      end
+    end
+
+  end
+end

data/lib/ruby_drills/sessions/local.rb

@@ -0,0 +1,45 @@
+require 'fileutils'
+require 'pstore'
+
+module Sessions
+  class Local
+    include FileUtils
+
+    DIR = '/usr/local/var/ruby_drills'
+
+    def initialize
+      ensure_directory_exists
+      @db = PStore.new(File.join(DIR, 'progress.pstore'))
+    end
+
+    def command(name, input)
+      store({context: name, input: input, type: 'command'})
+    end
+
+    def attempt(name, input, reference, result)
+      store({context: name, input: input, reference: reference, result: result, type: 'attempt'})
+    end
+
+    def stats
+      @db.transaction(true) do
+        @db.roots.each do |key|
+          puts @db[key].inspect
+        end
+      end
+    end
+
+  private
+
+    def ensure_directory_exists
+      FileUtils.mkdir_p(DIR) if !File.exists?(DIR)
+    end
+
+    def store(entry)
+      @db.transaction do
+        t = Sessions::Timestamp.collector
+        @db[t] = entry.merge({ time: t })
+      end
+    end
+
+  end
+end

data/lib/ruby_drills/sessions/timestamp.rb

@@ -0,0 +1,9 @@
+module Sessions
+  class Timestamp
+
+    def self.collector(t = Time.now)
+      t.strftime("%b %-d, %Y %-l:%M:%S %p %Z")
+    end
+
+  end
+end

data/lib/ruby_drills/string/string_drills.rb

@@ -0,0 +1,16 @@
+class StringDrills < Drills
+
+  def banner
+    %{
+Ruby Drills: String
+
+A String object holds and manipulates an arbitrary sequence of bytes,
+typically representing characters.
+
+COMING SOON
+
+------------------------------------------------------------------
+}
+  end
+
+end

data/lib/ruby_drills/version.rb

@@ -0,0 +1,3 @@
+module RubyDrills
+  VERSION = "0.1.0"
+end

data/lib/ruby_drills/welcome/welcome_drills.rb

@@ -0,0 +1,13 @@
+class WelcomeDrills
+  include Commands
+
+  def banner
+    welcome
+  end
+
+  def start
+    help
+    continue
+  end
+
+end

data/lib/starter.rb

@@ -0,0 +1,68 @@
+require 'slop'
+require 'pry'
+require 'colorize'
+require 'readline'
+
+require 'ruby_drills/version'
+require 'ruby_drills/cli'
+require 'ruby_drills/commands'
+require 'ruby_drills/drill'
+require 'ruby_drills/drills'
+require 'ruby_drills/chomper'
+require 'ruby_drills/sessions/collector_client'
+require 'ruby_drills/sessions/timestamp'
+require 'ruby_drills/config'
+
+class Starter
+  include Commands
+
+  def initialize
+    RubyDrills::Config.pry_config
+    clear
+    welcome
+    menu(drills)
+    clear
+    quit
+  end
+
+  def menu(options)
+    choice = nil
+    valid_choices = valid_number_to_drill_associations(options)
+
+    while (choice != 'q')
+      if valid_choices.include?(choice)
+        clear
+        run_drill(options[choice.to_i])
+      elsif (choice == 's')
+        RubyDrills::Config::SESSIONS.stats
+      end
+
+      puts "\nWhat would you like to learn next?\n\n"
+      options.each_with_index {|opt, i| puts "\t#{i}: #{opt.capitalize}"}
+      puts "\n\ts: see your stats"
+      puts "\tq: quit"
+
+      choice = Readline.readline("\n>> ", true)
+    end
+  end
+
+  def drills
+    %w[welcome array string hash]
+  end
+
+private
+
+  def valid_number_to_drill_associations(options)
+    (0...options.size).to_a.map {|x| x.to_s}
+  end
+
+  def run_drill(d)
+    require "ruby_drills/#{d}/#{d}_drills"
+    clazz = Module.const_get("#{d.capitalize}Drills")
+    drill = clazz.new
+    puts drill.banner
+    continue
+    drill.start
+  end
+
+end

data/ruby_drills.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_drills/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "ruby_drills"
+  gem.version       = RubyDrills::VERSION
+
+  gem.authors       = ["Bobby Norton"]
+  gem.email         = ["bobby@testedminds.com"]
+  gem.description   = "A deliberate practice tool for the core Ruby API's."
+  gem.summary       = gem.description
+  gem.homepage      = "http://rubydrills.com"
+  gem.license       = "Apache 2.0"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency("pry",  "0.9.12.1")
+  gem.add_dependency("colorize", "0.5.8")
+  gem.add_dependency("httparty", "0.11.0")
+
+  gem.add_development_dependency("rake", "10.0.4")
+  gem.add_development_dependency("rspec", "~> 2.14.0.rc1")
+  gem.add_development_dependency("wrong", "0.7.0")
+end

data/spec/commands_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Commands do
+  describe "#hint" do
+    it "returns hints in order" do
+      wrapper = Class.new do
+        include Commands
+        attr_accessor :hints
+        def setup
+          @hints = %w[first second third]
+        end
+      end.new
+      wrapper.setup
+      expect(wrapper).to receive(:puts).with("first").ordered
+      expect(wrapper).to receive(:puts).with("second").ordered
+      expect(wrapper).to receive(:puts).with("third").ordered
+      expect(wrapper).to receive(:puts).with("first").ordered
+      wrapper.hint
+      wrapper.hint
+      wrapper.hint
+      wrapper.hint
+    end
+  end
+end

data/spec/ruby_drills_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe "RubyDrills" do
+  it "should have a version number" do
+    assert { RubyDrills::VERSION }
+  end
+end

data/spec/sessions/timestamp_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Sessions::Timestamp do
+
+  specify "collector format" do
+    t = Time.parse("2011-10-17 22:38:00 +0600")
+    Sessions::Timestamp.collector(t).should == "Oct 17, 2011 11:38:00 AM CDT"
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'starter'
+require 'wrong/adapters/rspec'