battleroom 0.0.76 → 0.0.77

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 78134191850d5bf42304b7497bd5527c58cfd809
+  data.tar.gz: be9f91bfce496f06f2888eab9f8ef334df47a78f
+SHA512:
+  metadata.gz: 5074ee39cc786d5cddbd6c2503df1069dba6dfb22305b1b9ca7e66750ed7952ed1475edeb080adbaf7b3d9fd7a343620fab06f7f69fa52587901a346674ba07b
+  data.tar.gz: 05eda85829dbadd7996fc6f93d44fd175fcd5f2e9f83b9fd8356c8f727373f0edf0961c3296bbdbcd8612821cc3bf1aa04b3bf6f35352f1e564529d439e0cfb4

data/lib/battleroom/battleroom_machinery.rb

@@ -28,6 +28,7 @@ module BattleroomMachinery
     puts '2. Accessing values in arrays and hashes'
     puts '3. Adding values to arrays and hashes'
     puts '4. Accessing values from within nested data structures'
+    puts '5. Defining methods'
     puts "Q. Quit\r\n\n"
   end
 

data/lib/battleroom/data/array_questions.rb

@@ -1,3 +1,6 @@
+require_relative '../data_generation_machinery'
+include DataGenerationMachinery
+
 $random_names_array = gen_random_names_array
 
 ARRAY_QUESTIONS = [
@@ -30,8 +33,7 @@ ARRAY_QUESTIONS = [
     possible_variable_names: [
       'sci_fi_books',
       'sci_fi_novels',
-      'canonical_sci_fi_titles',
-      'science_fiction_titles',
+      'sci_fi_titles',
       'books',
       'paperback_titles',
     ].shuffle,
@@ -57,8 +59,8 @@ ARRAY_QUESTIONS = [
       'fav_nums',
       'lotto_nums',
       'ages_of_children',
-      'favorite_years_of_life',
-      'career_jersey_numbers',
+      'fav_ages',
+      'jersey_numbers',
       'lucky_numbers',
       'unlucky_numbers'
     ].shuffle,

data/lib/battleroom/data/hash_questions.rb

@@ -55,9 +55,4 @@ end
   HASH_QUESTIONS.push(location)
 end
 
-2.times do
-  app = gen_app
-  HASH_QUESTIONS.push(app)
-end
-
 HASH_QUESTIONS.shuffle!

data/lib/battleroom/data/variable_assignment_questions.rb

@@ -1,7 +1,9 @@
 VARIABLE_QUESTIONS = [
   # {
   #   possible_variable_names: [
-  #     "sampled_key"
+  #     "method_to_remove",
+  #     "callback_method",
+  #     "format_callback",
   #   ],
   #   possible_variable_values: [
   #     :username,

data/lib/battleroom/data_generation_machinery.rb

@@ -28,29 +28,6 @@ module DataGenerationMachinery
     possible_chars.shuffle[0, rand(6..8)].join
   end
 
-  def gen_app
-
-    author_or_creator = [:author, :creator].sample
-    release_or_stable_release = [:release, :stable_release].sample
-    name_or_title = [:name, :title, :app_name].sample
-    name = Faker::App.name
-    app = {
-      version: Faker::App.version,
-      author_or_creator => Faker::App.author,
-      name_or_title => name,
-      release_or_stable_release => rand(2004..2014),
-      open_source: [true, false].sample
-    }
-    data = {
-      data_structure: app,
-      possible_variable_names: [
-        snake_case(name),
-        'app',
-        'application'
-      ].shuffle
-    }
-  end
-
   def gen_user
     password_or_pw = [:password, :pw].sample
     admin_or_is_admin = [:admin, :is_admin].sample

data/lib/battleroom/models/array_assignment_question.rb

@@ -43,9 +43,7 @@ class ArrayAssignmentQuestion < DataStructureAssignmentQuestion
     else
       puts "Use an array method to add the #{assignment_value_class} value ".blue + "#{formatted_assignment_value}".yellow + " to the ".blue + "end".blue.underline + " of the Array below.\n".blue
     end
-    print "#{variable_name} = ".green
-    ap(data_structure, { indent: -2, index: false, multiline: true, plain: true })
-    puts ''
+    print_data_structure
   end
 
   def handle_replacement_of_array_value_input(user_input)

data/lib/battleroom/models/data_structure_access_question.rb

@@ -20,13 +20,13 @@ class DataStructureAccessQuestion < DataStructureQuestion
   end
 
   def evaluate_data_structure_access_input
-    enter_evaluation_loop do |user_input|
+    enter_evaluation_loop do |user_submission|
       begin
         # provides the evaluation scope with variable assignment necessary for answer eval
         evaluation_scope.eval("#{variable_name} = #{data_structure.to_s}")
-        if evaluation_scope.eval(user_input) == answer_value && user_input.include?(variable_name)
+        if evaluation_scope.eval(user_submission) == answer_value && user_submission.include?(variable_name)
           # this last returned value of 'true' within the block is vital;
-          # within the enter_evaluation_loop method, the return value of yield is used
+          # within the evaluation_loop method, the return value of yield is used
           true
         else
           puts "Remember, #{hint} Try again.\n".red

data/lib/battleroom/models/data_structure_assignment_question.rb

@@ -7,23 +7,30 @@ class DataStructureAssignmentQuestion < DataStructureQuestion
                 :value_to_replace_formatted, :replacement_index,
                 :replacement_value_class_formatted
 
+  POSSIBLE_INTRO_CONGRATULATIONS = [
+    'Brilliant',
+    'Wonderful',
+    'Jackpot',
+    'Impressive work',
+    'Bang-up job',
+    'Dynamite',
+    'Premier work',
+    'Quality work',
+    'Terrific'
+  ]
+
   def initialize(eval_scope)
     super(eval_scope)
   end
 
+  def print_data_structure
+    print "#{variable_name} = ".green
+    ap(data_structure, { indent: -2, index: false, multiline: true, plain: true })
+    puts ''
+  end
+
   def print_resulting_data_structure
-    possible_intro_congratulations = [
-      'Brilliant',
-      'Wonderful',
-      'Jackpot',
-      'Impressive work',
-      'Bang-up job',
-      'Dynamite',
-      'Premier work',
-      'Quality work',
-      'Terrific'
-    ]
-    intro_congrat = possible_intro_congratulations.sample
+    intro_congrat = POSSIBLE_INTRO_CONGRATULATIONS.sample
     puts "\n#{intro_congrat}. Here's the resulting data structure:\n".green
     sleep 1.0
     resulting_data_structure = evaluation_scope.eval(variable_name)
@@ -33,12 +40,12 @@ class DataStructureAssignmentQuestion < DataStructureQuestion
   end
 
   def evaluate_data_structure_assignment_input
-    enter_evaluation_loop do |user_input|
+    enter_evaluation_loop do |user_submission|
       begin
         # provides the evaluation scope with variable assignment necessary for answer eval
         evaluation_scope.eval("#{variable_name} = #{data_structure.to_s}")
-        evaluation_scope.eval(user_input)
-        evaluate_user_input(user_input)
+        evaluation_scope.eval(user_submission)
+        evaluate_user_input(user_submission)
       rescue NoMethodError, NameError => e
         print_colorized_error_prompt(e)
       rescue TypeError => e

data/lib/battleroom/models/hash_assignment_question.rb

@@ -21,9 +21,7 @@ class HashAssignmentQuestion < DataStructureAssignmentQuestion
 
   def print_data_structure_assignment_prompt
     puts 'Given the Hash below, add a key of '.blue + assignment_key.yellow + " that points to the #{assignment_value_class} value of ".blue + "#{formatted_assignment_value}".yellow + ".\n\n"
-    print "#{variable_name} = ".green
-    ap(data_structure, { indent: -2, index: false, multiline: true, plain: true })
-    puts ''
+    print_data_structure
   end
 
   def evaluate_user_input(user_input)

data/lib/battleroom/models/method_definition_question.rb

@@ -0,0 +1,106 @@
+require_relative '../data/method_questions'
+require_relative './question'
+
+class MethodDefinitionQuestion < Question
+
+  attr_accessor :method_name, :arg_count, :spec, :eval_string, :eval_answer,
+                :return_value
+
+  @questions = METHOD_QUESTONS.shuffle
+
+  def initialize(scope)
+    super(scope)
+    @method_name = data[:method_name]
+    @arg_count = data[:arg_count]
+    @spec = data[:spec]
+    @eval_string = data[:eval_string]
+    @eval_answer = data[:eval_answer]
+    @input_mechanism = 'pry'
+  end
+
+  def print_prompt
+    puts [
+      'Define a method called '.blue,
+      method_name.yellow,
+      ' that takes '.blue,
+      arg_count.to_s.yellow,
+      ' argument(s) and '.blue,
+      spec.blue,
+    ].join + "\n\n"
+  end
+
+  def handle_name_error_exceptions(error, user_submission)
+    if user_submission.include?('def') == false
+      print_no_method_error_prompt
+    else
+      print_colorized_error_prompt(error)
+    end
+  end
+
+  def handle_incorrect_method_definition(return_value)
+    puts 'When calling '.red + eval_string + ",  your method returned #{return_value || 'nil'}. It should have returned #{eval_answer}. Try again.\n".red
+  end
+
+  def print_puts_explanation
+    puts 'The last line of your method definition uses Ruby\'s "puts" method. The "puts" method is helpful for logging errors and statuses to the console, but its actual '.red + "return".red.underline + " value is always nil, and thus your method returns nil. Try again, this time without using \"puts\".\n".red
+  end
+
+  def print_no_method_error_prompt
+    puts "\nYou just trigged a common Ruby error that reads: \n".red
+    puts "\tundefined method \'WHATEVER_METHOD_YOU_TRIED_TO_INVOKE\'\n".green
+    puts "Basically, you tried to use a method before you defined it, and Ruby said, \"You haven't told me how to do that yet.\" To let Ruby know that you're defining a method, you'll use the the \"def\" keyword, and end your method definition with the \"end\" keyword.\n".red
+  end
+
+  def fresh_binding
+    binding
+  end
+
+  def print_wrong_method_error(error, user_submission)
+    definition_pattern = Regexp.new("def\s*#{method_name}")
+    if user_submission.match(definition_pattern)
+      handle_incorrect_method_definition(user_submission)
+    else
+      puts "\nYou defined the wrong method, probably as the result of a mispelling. Try again.\n".red
+    end
+  end
+
+  def print_argument_error_prompt(e)
+    e.message.match(/wrong number of arguments \((\d) for (\d)\)/)
+    passed_arg_count = $1.to_i
+    expected_arg_count = $2.to_i
+    puts "Looks like you defined #{method_name} to take #{expected_arg_count} argument(s), when it should take #{arg_count}. Try again.\n".red
+  end
+
+  def clean_eval_scope_of_method_definition
+    if evaluation_scope.eval "respond_to?(:#{method_name}, true)"
+      evaluation_scope.eval 'Object.class_eval("remove_method :' + method_name + '")'
+    end
+  end
+
+  def evaluate_method_definition_input
+    enter_evaluation_loop do |user_submission|
+      begin
+        clean_eval_scope_of_method_definition
+        # I want to make sure that the user's method isn't invoked if it uses the puts method
+        if user_submission.include?('puts')
+          print_puts_explanation
+        else
+          evaluation_scope.eval(user_submission)
+          return_value = evaluation_scope.eval(eval_string)
+          if (return_value == eval_answer)
+            true
+          else
+            handle_incorrect_method_definition(return_value)
+          end
+        end
+      rescue ArgumentError => e
+        print_argument_error_prompt(e)
+      rescue NoMethodError => e
+        print_wrong_method_error(e, user_submission)
+      rescue NameError => e
+        handle_name_error_exceptions(e, user_submission)
+      end
+    end
+  end
+
+end

data/lib/battleroom/models/question.rb

@@ -1,44 +1,62 @@
 class Question
-    attr_reader :type, :data
-    attr_accessor :variable_name, :variable_value, :data_structure,
-                  :data_structure_class, :answer_value, :explanation,
-                  :evaluation_scope
+  attr_reader   :data
+  attr_accessor :variable_name, :variable_value, :data_structure,
+                :data_structure_class, :answer_value, :explanation,
+                :evaluation_scope, :input_mechanism
 
-    def initialize(evaluation_scope)
-      @evaluation_scope = evaluation_scope
-      @data = self.class.generate_question
-      @variable_name = rotate_array(data[:possible_variable_names]).first
+  def initialize(evaluation_scope)
+    @evaluation_scope = evaluation_scope
+    @data = self.class.generate_question
+    @variable_name = rotate_array(data[:possible_variable_names] || []).first
+    @input_mechanism = 'readline'
+  end
+
+  # retrieves question from front of the array and rotates it to the back
+  # to avoid immediate re-sampling of questions
+  def self.generate_question
+    # calls upon *class instance* variable assigned in the subclasses
+    question = @questions.shift
+    @questions.push(question)
+    question
+  end
+
+  def congratulation_sequence(duration)
+    print_congratulation
+    sleep(duration)
+    clear_display
+  end
+
+  def handle_syntax_error_exceptions(error)
+    if error.message.match /unexpected end-of-input/
+      print_unexpected_end_of_input_explanation
+    elsif error.message.include?('unterminated string meets end of file')
+      puts 'Blurg! You neglected to provide closing quotes for your string. Try again!'.red
     end
+  end
 
-    # retrieves question from front of the array and rotates it to the back
-    # to avoid immediate re-sampling of questions
-    def self.generate_question
-      # calls upon *class instance* variable assigned in the subclasses
-      question = @questions.shift
-      @questions.push(question)
-      question
+  def get_input
+    if input_mechanism == 'readline'
+      Readline.readline('> '.blue, true)
+    else
+      Pry.start_without_pry_debugger(evaluation_scope)
+      $input
     end
+  end
 
-    def enter_evaluation_loop(&block)
-      answered_correctly = false
-      until answered_correctly
-        begin
-          user_input = Readline.readline('> '.blue, true)
-          abort('Goodbye!'.green) if user_input.match(/^(q|exit|!!!\s?)\z/i)
-          if (naughty_input?(user_input) == false) && yield(user_input)
-            print_congratulation
-            sleep 1.6
-            clear_display
-            answered_correctly = true
-          end
-        rescue SyntaxError => e
-          if e.message.match /unexpected end-of-input/
-            print_unexpected_end_of_input_explanation
-          elsif e.message.include?('unterminated string meets end of file')
-            puts 'Blurg! You neglected to provide closing quotes for your string. Try again!'.red
-          end
+  def enter_evaluation_loop(&block)
+    answered_correctly = false
+    until answered_correctly
+      begin
+        user_input = get_input
+        abort('Goodbye!'.green) if user_input.match(/^(q|exit|!!!\s?)\z/i)
+        if !naughty_input?(user_input) && yield(user_input)
+          congratulation_sequence(1.6)
+          answered_correctly = true
         end
+      rescue SyntaxError => e
+        handle_syntax_error_exceptions(e)
       end
     end
+  end
 
-  end # Question
+end # Question

data/lib/battleroom/models/variable_question.rb

@@ -39,9 +39,9 @@ class VariableQuestion < Question
   end
 
   def evaluate_variable_assignment_input
-    enter_evaluation_loop do |user_input|
+    enter_evaluation_loop do |user_submission|
       begin
-        evaluation_scope.eval(user_input)
+        evaluation_scope.eval(user_submission)
         if evaluation_scope.eval("#{variable_name} == #{formatted_value}")
           # this last returned value of 'true' is vital;
           # the return value of yield is used in a conditional
@@ -50,7 +50,7 @@ class VariableQuestion < Question
           puts "You mis-assigned #{variable_name}. Try again!".red
         end
       rescue NameError => e
-        reveal_name_error_follies_to_user(user_input)
+        reveal_name_error_follies_to_user(user_submission)
       rescue Exception => e
         if e.message.match(/unterminated string/)
           puts 'Blurg! You neglected to provide closing quotes for your string. Try again!'.red

data/lib/battleroom.rb

@@ -3,22 +3,14 @@
 require 'readline'
 require 'faker'
 require 'awesome_print'
-# require 'pry'
+require 'pry'
 require 'colorize'
-# eliminates deprecation warning
-I18n.config.enforce_available_locales = false
+require 'coderay'
 
-# the below takes forever to load(?), so resorting to multiline requiring
-  # path = File.expand_path("./battleroom/models/*.rb", File.dirname(__FILE__))
-  # Dir[path].each { |file| require file }
+require_relative './battleroom/config/pry_config'
 
-require_relative './battleroom/models/nested_data_structure_access_question'
-require_relative './battleroom/models/data_structure_assignment_question'
-require_relative './battleroom/models/hash_access_question'
-require_relative './battleroom/models/hash_assignment_question'
-require_relative './battleroom/models/array_access_question'
-require_relative './battleroom/models/array_assignment_question'
-require_relative './battleroom/models/variable_question'
+path = File.expand_path("./battleroom/models/*.rb", File.dirname(__FILE__))
+Dir[path].each { |file| require file }
 
 require_relative 'battleroom/battleroom_machinery'
 include BattleroomMachinery
@@ -60,6 +52,25 @@ loop do
       q.print_data_structure_access_prompt
       q.evaluate_data_structure_access_input
     end
+  when '5'
+    # 5.times do
+    #   q = MethodDefinitionQuestion.new(b)
+    #   q.print_prompt
+    #   q.evaluate_method_definition_input
+    # end
+
+    #========================================
+    # Method Defintiion Follow Up Development
+    #========================================
+    2.times do
+      q = MethodDefinitionQuestion.new(b)
+      q.print_prompt
+      q.evaluate_method_definition_input
+      follow_up_question = MethodDefinitionFollowUpQuestion.new(b, q)
+      follow_up_question.print_method_invocation_prompt
+      follow_up_question.evaluate_user_input
+    end
+
   else
     puts 'You entered a non-option. Try again.'.red
   end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: battleroom
 version: !ruby/object:Gem::Version
-  version: 0.0.76
-  prerelease: 
+  version: 0.0.77
 platform: ruby
 authors:
 - Travis Vander Hoop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-01 00:00:00.000000000 Z
+date: 2014-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -70,63 +62,90 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
         version: 4.1.6
-description: A simple command-line REPL designed to give Ruby newbies countless reps
-  doing simple tasks like assigning variables and accessing and assigning values within
-  nested data structures.
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: A command-line REPL designed to give novice Ruby programmers countless
+  reps doing simple tasks like assigning variables, working with data structures,
+  and defining and invoking methods.
 email: vanderhoop@me.com
 executables:
 - battleroom
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/battleroom
 - lib/battleroom.rb
 - lib/battleroom/battleroom_machinery.rb
-- lib/battleroom/data_generation_machinery.rb
 - lib/battleroom/data/array_questions.rb
 - lib/battleroom/data/hash_questions.rb
 - lib/battleroom/data/nested_data_structure_access_questions.rb
 - lib/battleroom/data/variable_assignment_questions.rb
-- lib/battleroom/models/question.rb
-- lib/battleroom/models/data_structure_question.rb
-- lib/battleroom/models/nested_data_structure_access_question.rb
+- lib/battleroom/data_generation_machinery.rb
+- lib/battleroom/models/array_access_question.rb
+- lib/battleroom/models/array_assignment_question.rb
 - lib/battleroom/models/data_structure_access_question.rb
 - lib/battleroom/models/data_structure_assignment_question.rb
+- lib/battleroom/models/data_structure_question.rb
 - lib/battleroom/models/hash_access_question.rb
 - lib/battleroom/models/hash_assignment_question.rb
-- lib/battleroom/models/array_access_question.rb
-- lib/battleroom/models/array_assignment_question.rb
+- lib/battleroom/models/method_definition_question.rb
+- lib/battleroom/models/nested_data_structure_access_question.rb
+- lib/battleroom/models/question.rb
 - lib/battleroom/models/variable_question.rb
-- bin/battleroom
 homepage: https://github.com/vanderhoop/battleroom
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: A simple command-line REPL designed to give Ruby newbies countless reps doing
-  simple tasks like assigning variables and accessing and assigning values within
-  nested data structures.
+specification_version: 4
+summary: A command-line REPL designed to give novice Ruby programmers countless reps
+  doing simple tasks like assigning variables, working with data structures, and defining
+  and invoking methods.
 test_files: []