battleroom 0.0.2x → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b95c630774eac85f4874d405bc1a6fd8b80f5ef
-  data.tar.gz: bf928ca6a161a73ebc9e6f72e8c488ef727b06d9
+  metadata.gz: c68abc679f13da1a621073aca8a602f5a9286308
+  data.tar.gz: 84726ceed2983a20e8b40c54f593695ac8eae42e
 SHA512:
-  metadata.gz: 5477c37f8c00484bde29ac86c9cd70fb956a3111ac1e0364e474d24d0ba9ce3a2094dcfd00e13144ad452fcdd45509093805cc9cc794269a8d06d44d1723a1c3
-  data.tar.gz: cb1ffc7deab34ed6947cbd7600562ace7ca6546e473ce08757d164bbbd736a3ef6fb22fc0e9a91158a6d8a883a8b5c5587132726d7c67d6144a8ccd84930c59d
+  metadata.gz: 5c334740b7e5c250e0307ee836ec9a4fe262ef55f41440e1cf683fbc235de128604c0c3769283bdebcdde02cb2a685af7b35095757da880f5576703e19ee3631
+  data.tar.gz: 06d615176abf29da1cd9243f861c0b6626fcc136bbf02a6b016643320f4e0be9aa57ac3277cbd1b013e0fd572717a4b8f6b1efe02afc9c52bc4aba3a1df4595d

data/lib/battleroom/data/{data_structure_questions.rb → array_questions.rb}

@@ -2,28 +2,9 @@ require 'pry'
 # eliminates deprecation warning
 I18n.config.enforce_available_locales = false
 
-require_relative '../data_generation_machinery'
-include DataGenerationMachinery
-require 'active_support/inflector'
-
 $random_names_array = gen_random_names_array
 
-DATA_STRUCTURE_QUESTIONS = [
-  {
-    data_structure: {
-      home_team: 'Green Bay Packers',
-      capacity: 72_928,
-      established: 1957,
-      publicly_owned: true,
-      real_grass: true,
-      price_of_beer: 5.5,
-      namesake: 'Curly Lambeau',
-      address: '1265 Lombardi',
-      suite_count: 168,
-      banners: true,
-    },
-    possible_variable_names: ['lambeau_field', 'the_frozen_tundra'],
-  },
+ARRAY_QUESTIONS = [
   {
     data_structure: [
       'Foundation',
@@ -202,27 +183,6 @@ DATA_STRUCTURE_QUESTIONS = [
       'fab_four_tunes',
     ].shuffle,
   },
-  {
-    data_structure: {
-      stars: ['Ryan Gosling', 'Rachel McAdams'],
-      released: 2004,
-      tearjerker: true,
-      director: 'Nick Cassavetes',
-      mtv_movie_award_count: 1,
-      box_office_millions: 81.5,
-      macho: false,
-    },
-    possible_variable_names: ['the_notebook'],
-  },
-  {
-    data_structure: {
-      stars: ['Nicholas Cage', 'Meryl Streep'],
-      rt_rating: 98.0,
-      released: 2002,
-      screenwriters: ['Charlie Kaufman', 'Donald Kaufman'],
-    },
-    possible_variable_names: ['adaptation'],
-  },
   {
     data_structure: [
       'When Harry Met Sally',
@@ -293,22 +253,3 @@ DATA_STRUCTURE_QUESTIONS = [
     ].shuffle
   },
 ]
-
-5.times do
-  user = gen_user
-  DATA_STRUCTURE_QUESTIONS.push(user)
-  business = gen_business
-  DATA_STRUCTURE_QUESTIONS.push(business)
-end
-
-4.times do
-  location = gen_location
-  DATA_STRUCTURE_QUESTIONS.push(location)
-end
-
-2.times do
-  app = gen_app
-  DATA_STRUCTURE_QUESTIONS.push(app)
-end
-
-DATA_STRUCTURE_QUESTIONS.shuffle!

data/lib/battleroom/data/hash_questions.rb

@@ -0,0 +1,63 @@
+require_relative '../data_generation_machinery'
+include DataGenerationMachinery
+require 'active_support/inflector'
+
+HASH_QUESTIONS = [
+  {
+    data_structure: {
+      home_team: 'Green Bay Packers',
+      capacity: 72_928,
+      established: 1957,
+      publicly_owned: true,
+      real_grass: true,
+      price_of_beer: 5.5,
+      namesake: 'Curly Lambeau',
+      address: '1265 Lombardi',
+      suite_count: 168,
+      banners: true,
+    },
+    possible_variable_names: ['lambeau_field', 'the_frozen_tundra'],
+  },
+  {
+    data_structure: {
+      stars: ['Ryan Gosling', 'Rachel McAdams'],
+      released: 2004,
+      tearjerker: true,
+      director: 'Nick Cassavetes',
+      mtv_movie_award_count: 1,
+      box_office_millions: 81.5,
+      macho: false,
+    },
+    possible_variable_names: ['the_notebook'],
+  },
+  {
+    data_structure: {
+      stars: ['Nicholas Cage', 'Meryl Streep'],
+      rt_rating: 98.0,
+      released: 2002,
+      screenwriters: ['Charlie Kaufman', 'Donald Kaufman'],
+    },
+    possible_variable_names: ['adaptation'],
+  },
+]
+
+HASH_QUESTIONS
+
+5.times do
+  user = gen_user
+  HASH_QUESTIONS.push(user)
+  business = gen_business
+  HASH_QUESTIONS.push(business)
+end
+
+4.times do
+  location = gen_location
+  HASH_QUESTIONS.push(location)
+end
+
+2.times do
+  app = gen_app
+  HASH_QUESTIONS.push(app)
+end
+
+HASH_QUESTIONS.shuffle!

data/lib/battleroom/data/nested_data_structure_access_questions.rb

@@ -0,0 +1,26 @@
+# things to consider
+  # some should start as arrays, others as hashes
+  # is awesome_print the best solution?
+  # I should keep whatever data structures I create brief
+  # I should keep the first key-value pair of a hash to simple datatypes. the second k-v pair should be the nested data structure
+  # key lengths should be close, for readability (keep in mind this is for absolute beginners)
+
+NESTED_DATA_STRUCTURE_ACCESS_QUESTIONS = [
+  {
+    data_structure: [
+      { title: 'The Stone Roses', released: 1989 },
+      { title: 'Second Coming', released: 1994 },
+    ],
+    possible_variable_names: ['stone_roses_albums']
+  },
+  {
+    data_structure: [
+      { song_title: 'Material Girl', billboard_peak: 2 },
+      { song_title: 'Borderline', billboard_peak: 10 },
+      { song_title: 'Lucky Star', billboard_peak: 4 },
+      { song_title: 'Holiday', billboard_peak: 16 },
+      { song_title: 'Vogue', billboard_peak: 1 },
+    ],
+    possible_variable_names: ['madonna_singles']
+  }
+]

data/lib/battleroom/models/array_access_question.rb

@@ -0,0 +1,19 @@
+require_relative '../data/array_questions'
+require_relative './data_structure_access_question'
+
+class ArrayAccessQuestion < DataStructureAccessQuestion
+
+  @questions = ARRAY_QUESTIONS.shuffle
+
+  def initialize(scope)
+    super(scope)
+    format_array_for_access
+  end
+
+  def format_array_for_access
+    self.data_structure = data_structure[0, rand(4..6)]
+    self.answer_value = data_structure.sample
+    self.hint = 'index values start at 0.'
+  end
+
+end

data/lib/battleroom/models/array_assignment_question.rb

@@ -0,0 +1,91 @@
+require_relative '../data/array_questions'
+require_relative './data_structure_assignment_question'
+
+class ArrayAssignmentQuestion < DataStructureAssignmentQuestion
+
+  @questions = ARRAY_QUESTIONS
+
+  def initialize(scope)
+    super(scope)
+    format_array_for_assignment
+  end
+
+  def format_array_for_assignment
+    desired_array_size = rand(3..6)
+    cull_array_to_valid_size_for_output(desired_array_size)
+    if [1, 2, 3, 4, 5].sample.odd?
+      self.value_to_replace = data_structure.sample
+      self.value_to_replace_formatted = format_value_for_stdout_and_eval(value_to_replace)
+    end
+    self.assignment_value = possible_assignments.sample
+    self.assignment_value_class = format_class_for_output(assignment_value.class)
+    self.formatted_assignment_value = format_value_for_stdout_and_eval(assignment_value)
+  end
+
+  def cull_array_to_valid_size_for_output(desired_size)
+    while data_structure.size > desired_size
+      new_assignment_possibility = data_structure.delete(data_structure.sample)
+      possible_assignments.push(new_assignment_possibility)
+    end
+  end
+
+  def print_replace_array_value_prompt
+    puts "Given the data structure below, replace the #{replacement_value_class_formatted} value ".blue +
+         value_to_replace_formatted.yellow + " with the #{assignment_value_class} value ".blue +
+         formatted_assignment_value.yellow + ".\n\n"
+  end
+
+  def print_data_structure_assignment_prompt
+    if value_to_replace
+      self.replacement_index = data_structure.index(value_to_replace)
+      self.replacement_value_class_formatted = format_class_for_output(value_to_replace.class)
+      print_replace_array_value_prompt
+    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 ''
+  end
+
+  def handle_replacement_of_array_value_input(user_input)
+    if evaluation_scope.eval("#{variable_name}[#{replacement_index}] == #{formatted_assignment_value}") && user_input.include?(variable_name)
+      print_resulting_data_structure
+      true
+    else
+      puts "\nNope! Here's what the data stucture would look like given your code:\n".red
+      resulting_data_structure = evaluation_scope.eval(variable_name)
+      ap(resulting_data_structure, { indent: -2, index: false, multiline: true, plain: true })
+      puts "\nCheck your index and assignment values and try again.\n".red
+    end
+  end
+
+  def handles_user_workarounds(user_input)
+    cheater_regex = Regexp.new("#{variable_name}\s+?\=\s+?(\\[)?")
+    # checks if user reassigned the variable to a new array of identical values
+    if user_input.match(cheater_regex)
+      if $1
+        puts 'You reassigned the variable to a new array object, when you could have worked with the array provided! Look up Ruby\'s Array#push method and try again!'.red
+      else
+        puts 'You reassigned the variable '.red + variable_name.green + ' rather than working with the array provided. Try again.'.red
+      end
+      puts ''
+      true
+    end
+  end
+
+  def evaluate_user_input(user_input)
+    if handles_user_workarounds(user_input)
+      false
+    end
+    if value_to_replace
+      handle_replacement_of_array_value_input(user_input)
+    elsif evaluation_scope.eval("#{variable_name}.last == #{formatted_assignment_value}") && user_input.include?(variable_name)
+      print_resulting_data_structure
+      true
+    else
+      puts 'Nope! Try again.'.red
+    end
+  end
+
+end

data/lib/battleroom/models/data_structure_assignment_question.rb

@@ -0,0 +1,50 @@
+require_relative './data_structure_question'
+
+class DataStructureAssignmentQuestion < DataStructureQuestion
+
+  attr_accessor :assignment_value, :assignment_key, :assignment_value_class,
+                :formatted_assignment_value, :value_to_replace,
+                :value_to_replace_formatted, :replacement_index,
+                :replacement_value_class_formatted
+
+  def initialize(eval_scope)
+    super(eval_scope)
+  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
+    puts "\n#{intro_congrat}. Here's the resulting data structure:\n".green
+    sleep 1.0
+    resulting_data_structure = evaluation_scope.eval(variable_name)
+    ap(resulting_data_structure, { indent: -2, index: false, multiline: true, plain: true })
+    puts ''
+    sleep 3.2
+  end
+
+  def evaluate_data_structure_assignment_input
+    enter_evaluation_loop do |user_input|
+      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)
+      rescue NoMethodError, NameError => e
+        print_colorized_error_prompt(e)
+      rescue TypeError => e
+        print_colorized_type_error_prompt(e)
+      end
+    end
+  end
+
+end

data/lib/battleroom/models/hash_access_question.rb

@@ -0,0 +1,31 @@
+require_relative '../data/hash_questions'
+require_relative './data_structure_access_question'
+
+class HashAccessQuestion < DataStructureAccessQuestion
+
+  @questions = HASH_QUESTIONS.shuffle
+
+  def initialize(scope)
+    super(scope)
+    format_hash
+  end
+
+  def format_hash
+    cull_hash_to_valid_size_for_output
+    remove_multiple_booleans
+    self.answer_value = data_structure[data_structure.keys.sample]
+    self.hint = 'you have to use the EXACT hash key to retrieve the associated value.'
+  end
+
+  def remove_multiple_booleans
+    boolean_count = find_number_of_boolean_values_in_hash
+    while boolean_count > 1
+      grouped_by_value = data_structure.group_by { |k, v| v }
+      boolean_to_delete = [true, false].sample
+      key_to_delete = grouped_by_value[boolean_to_delete].sample[0] if grouped_by_value[boolean_to_delete]
+      data_structure.delete(key_to_delete)
+      boolean_count = find_number_of_boolean_values_in_hash
+    end
+  end
+
+end

data/lib/battleroom/models/hash_assignment_question.rb

@@ -0,0 +1,38 @@
+require_relative '../data/hash_questions'
+require_relative './data_structure_access_question'
+
+class HashAssignmentQuestion < DataStructureAssignmentQuestion
+
+  @questions = HASH_QUESTIONS.shuffle
+
+  def initialize(scope)
+    super(scope)
+    format_hash_for_assignment
+  end
+
+  def format_hash_for_assignment
+    cull_hash_to_valid_size_for_output
+    assignment = possible_assignments.sample
+    self.assignment_value = assignment.values[0]
+    self.assignment_value_class = format_class_for_output(assignment_value.class)
+    self.formatted_assignment_value = format_value_for_stdout_and_eval(assignment_value)
+    self.assignment_key = format_value_for_stdout_and_eval(assignment.keys[0])
+  end
+
+  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 ''
+  end
+
+  def evaluate_user_input(user_input)
+    if evaluation_scope.eval("#{variable_name}[#{assignment_key}] == #{formatted_assignment_value}") && user_input.include?(variable_name)
+      print_resulting_data_structure
+      true
+    else
+      puts 'Nope! Try again!'.red
+    end
+  end
+
+end

data/lib/battleroom/models/nested_data_structure_access_question.rb

@@ -0,0 +1,19 @@
+require_relative 'data_structure_access_question'
+require_relative '../data/nested_data_structure_access_questions'
+
+class NestedDataStructureAccessQuestion < DataStructureAccessQuestion
+  attr_accessor :inner_hash, :inner_array
+  # class instance variable used within the initialize method for Question
+  @questions = NESTED_DATA_STRUCTURE_ACCESS_QUESTIONS.shuffle
+
+  def initialize(eval_scope)
+    super(eval_scope)
+    if data_structure.class == Array
+      self.inner_hash = data_structure.sample
+      self.answer_value = inner_hash[inner_hash.keys.sample]
+    else
+      self.answer_value = data_structure[data_structure.keys.sample]
+    end
+  end
+end
+

data/lib/battleroom/models/variable_question.rb

@@ -0,0 +1,63 @@
+require_relative 'question'
+require_relative '../data/variable_assignment_questions'
+
+class VariableQuestion < Question
+  attr_accessor :formatted_value
+  # using a class instance variable, as manipulating a single class var
+  # in the parent class is troublesome
+  @questions = VARIABLE_QUESTIONS.shuffle
+
+  def initialize(eval_scope)
+    super(eval_scope)
+    @variable_value = rotate_array(data[:possible_variable_values]).first
+    @formatted_value = format_value_for_stdout_and_eval(variable_value)
+  end
+
+  def print_variable_assignment_prompt
+    formatted_class = format_class_for_output(variable_value.class)
+    substrings = [
+      'Create a variable '.blue,
+      variable_name.yellow,
+      ' and assign it the '.blue,
+      formatted_class.blue,
+      ' value '.blue,
+      formatted_value.yellow
+    ]
+    puts substrings.join
+  end
+
+  def reveal_name_error_follies_to_user(user_input)
+    if user_input.include?(variable_name) && !user_input.match(/[^=]=[^=]/i)
+      puts 'You\'re not using the assignment operator!'.red
+    elsif !user_input.match(/("|')/) && variable_value.class == String
+      puts 'Rats! You\'ve just made a common rookie mistake! ' +
+           'Strings are always surrounded by quotes. Otherwise, Ruby will ' +
+           'think you\'re referencing a variable or method name. Try again.'.red
+    else
+      puts 'Looks like you mistyped the variable name. Check for misspellings and try again.'.red
+    end
+  end
+
+  def evaluate_variable_assignment_input
+    enter_evaluation_loop do |user_input|
+      begin
+        evaluation_scope.eval(user_input)
+        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
+          true
+        else
+          puts "You mis-assigned #{variable_name}. Try again!".red
+        end
+      rescue NameError => e
+        reveal_name_error_follies_to_user(user_input)
+      rescue Exception => e
+        if e.message.match(/unterminated string/)
+          puts 'Blurg! You neglected to provide closing quotes for your string. Try again!'.red
+        else
+          puts e.message
+        end
+      end
+    end
+  end
+end # VariableQuestion

data/lib/battleroom.rb

@@ -9,7 +9,10 @@ require 'Faker'
 
 require_relative './battleroom/models/nested_data_structure_access_question'
 require_relative './battleroom/models/data_structure_assignment_question'
-require_relative './battleroom/models/data_structure_access_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'
 
 require_relative 'battleroom/battleroom_machinery'
@@ -36,13 +39,13 @@ loop do
     end
   when '2'
     5.times do
-      q = DataStructureAccessQuestion.new(b)
+      q = [ArrayAccessQuestion.new(b), HashAccessQuestion.new(b)].sample
       q.print_data_structure_access_prompt
       q.evaluate_data_structure_access_input
     end
   when '3'
     5.times do
-      q = DataStructureAssignmentQuestion.new(b)
+      q = [ArrayAssignmentQuestion.new(b), HashAssignmentQuestion.new(b)].sample
       q.print_data_structure_assignment_prompt
       q.evaluate_data_structure_assignment_input
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: battleroom
 version: !ruby/object:Gem::Version
-  version: 0.0.2x
+  version: 0.0.3
 platform: ruby
 authors:
 - Travis Vander Hoop
@@ -60,8 +60,17 @@ files:
 - bin/battleroom
 - lib/battleroom.rb
 - lib/battleroom/battleroom_machinery.rb
-- lib/battleroom/data/data_structure_questions.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/array_access_question.rb
+- lib/battleroom/models/array_assignment_question.rb
+- lib/battleroom/models/data_structure_assignment_question.rb
+- lib/battleroom/models/hash_access_question.rb
+- lib/battleroom/models/hash_assignment_question.rb
+- lib/battleroom/models/nested_data_structure_access_question.rb
+- lib/battleroom/models/variable_question.rb
 homepage: https://github.com/vanderhoop/battleroom
 licenses:
 - MIT
@@ -74,12 +83,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2