wordwise 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1947e162210a172708d21e999c7768353bc347cbc29172471129dfc1262992d
-  data.tar.gz: 5fa3952b37f6112138aca33bbd3673114c9042c99d502d2248fe4ca0cf92705e
+  metadata.gz: ea617b3ed88889e8f480f611d6a09565378984b548619a2b1e59f328d97dd8ba
+  data.tar.gz: e11409a2fba66a31f8f69baf4f9f0e65bb8ee6a91e81112857da67b1c1d5ba42
 SHA512:
-  metadata.gz: 51986ba8891c9bebe953c7de9d65f93806f064c5ac420a914353bd0914ffd37dbee340ba9979d3c979f32813f96decac6a536ee49f0a3d55c2b27c39bc1ff286
-  data.tar.gz: f6adfe9314385aed6ca33d5b2aa5825743624c0b9625279d0abafa191f99f908c3e9ece7e1de900a7413aeda0c246fd71834bdc61e26737ea283aa8b801e3b87
+  metadata.gz: 38221fdb3e912e8ed3dae3ba41c95adb3f90f49367c0b7c1addfe51f3900dab1c96371384d7b342d756a55a0a930cad1a24dd91856b7497b47b0833c974759f0
+  data.tar.gz: c2c04d0fd46a6033aeef4a042ea45f2a04eddf82ca94104743e8f5e6bc1c8982af22d3e00a7c9a053fe361bb9e2fd0e59b55a7bcbf0e29d3219e22a8fc44d038

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    wordwise (0.1.1)
+    wordwise (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-On starting, WordWise will choose a word and several definitions, one of which is correct. (This process may take a few seconds). Once you've made your choice, type the corresponding number and hit 'enter'. WordWise will tell you if you're correct and, if not, the correct definition. Type 'o' and 'enter' to see the word's origin (etymology) or 'n' and 'enter' for the next question. To exit the game, type 'e' and 'enter'.
+Start the program in your terminal with "ruby bin/wordise". On starting, WordWise will choose a word and several definitions, one of which is correct. (This process may take a few seconds). Once you've made your choice, type the corresponding number and hit 'enter'. WordWise will tell you if you're correct and, if not, the correct definition. Type 'o' and 'enter' to see the word's origin (etymology) or 'n' and 'enter' for the next question. To exit the game, type 'e' and 'enter'.
 
 ## Development
 

data/lib/cli.rb

@@ -9,13 +9,20 @@ class Wordwise::CLI
     puts "You can learn more about the words in this quiz at https://www.oxforddictionaries.com.\n\n".center(80)
     puts "Get ready to test your word wisdom....\n\n".center(80)
     puts "What category would you like to test your knowledge on?\n"
-    display_lists
+    list
   end
 
-  # Presents list of categories.
-  def display_lists
+  # Checks if @lists is populated. If not, calls .scrape_word_lists and populates it.
+  # Otherwise, call display_list and pass in the list.
+  def list
+    @list ||= Wordwise::Scraper.scrape_word_lists
     puts ''
-    Wordwise::Scraper.scrape_word_lists.each_with_index do |l, i|
+    display_list
+  end
+
+  # Presents list of categories.
+  def display_list 
+    @list.each_with_index do |l, i|
       puts wrap_indent("#{i + 1}) #{l}")
       puts ''
     end
@@ -45,19 +52,19 @@ class Wordwise::CLI
     end
   end
 
-    # Checks if there are enough unused words and definitions to form question.
-    # Minumum size is set at 5 because sample method in #sample_words_defs
-    # is not called on first item in array.
-    def check_remaining
-      if @words_defs_ary.size >= 5
-        sample_words_defs
-      else
-        ask_c_or_e
-      end
+  # Checks if there are enough unused words and definitions to form question.
+  # Minumum size is set at 5 because sample method in #sample_words_defs
+  # is not called on first item in array.
+  def check_remaining
+    if @words_defs_ary.size >= 5
+      sample_words_defs
+    else
+      ask_c_or_e
+    end
   end
 
+  # Samples starting at index 1 of array to avoid any column headings.
   def sample_words_defs
-    # Samples starting at index 1 of array to avoid any column headings.
     @question_words_defs = @words_defs_ary[1..@words_defs_ary.size - 1].sample(4)
     # Prevents repetition of words in questions.
     @words_defs_ary.delete_if { |wd| wd == @question_words_defs[0] }
@@ -91,13 +98,13 @@ class Wordwise::CLI
     ask_no
   end
 
-  def self.get_question_words
+  def self.question_words
     @@question_words
   end
 
-  def self.get_question_array
+  # Array is return value to be used in Question.
+  def self.question_array
     origin = Wordwise::Scraper.scrape_entry_pages
-    # Array is return value to be used in Question.
     [@@question_words, @@question_defs, origin]
   end
 
@@ -160,7 +167,7 @@ class Wordwise::CLI
     when 'n'
       check_remaining
     when 'c'
-      display_lists
+      display_list
     when 'e'
       goodbye
     else
@@ -201,6 +208,7 @@ class Wordwise::CLI
     end
   end
 
+  # Presents main words, their definitions and origins from session.
   def display_review
     Wordwise::Question.all.each_index do |i|
       question = Wordwise::Question.all[i]

data/lib/question.rb

@@ -7,7 +7,7 @@ class Wordwise::Question
 
   # Set instance variables for Question objects.
   def initialize
-    question_array = Wordwise::CLI.get_question_array
+    question_array = Wordwise::CLI.question_array
     @word = question_array[0][0]
     @def = question_array[1][0]
     @defs = question_array[1].shuffle
@@ -15,7 +15,8 @@ class Wordwise::Question
     @@all << self
   end
 
-  def self.all
+  def self.all 
     @@all
   end
+
 end

data/lib/scraper.rb

@@ -42,7 +42,7 @@ class Wordwise::Scraper
   # definition, and 3 more definitions.
   def self.scrape_entry_pages
     docs, word_urls = [], []
-    question_words = Wordwise::CLI.get_question_words
+    question_words = Wordwise::CLI.question_words
     # Iterates over array to make array of urls that are parsed by Nokogiri
     # and put in another array.
     question_words.each_index do |i|

data/lib/wordwise/version.rb

@@ -1,3 +1,3 @@
 module Wordwise
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/wordwise.gemspec

@@ -8,7 +8,7 @@ require 'nokogiri'
 Gem::Specification.new do |spec|
   spec.name          = "wordwise"
   spec.version       = Wordwise::VERSION
-  spec.authors       = ["RonSala"]
+  spec.authors       = ["Ron Sala"]
   spec.email         = ["ron.sala@gmail.com"]
 
   spec.summary       = %q{A quiz game. Challenge your vocabulary!}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wordwise
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
-- RonSala
+- Ron Sala
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-06 00:00:00.000000000 Z
+date: 2018-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,7 +80,6 @@ files:
 - lib/wordwise.rb
 - lib/wordwise/version.rb
 - spec.md
-- spec.rb
 - wordwise.gemspec
 homepage: https://github.com/ronsala/wordwise
 licenses:

data/spec.rb

@@ -1,6 +0,0 @@
-# Specifications for the CLI Assessment
-
-Specs:
-- [x] Have a CLI for interfacing with the application
-- [X] Pull data from an external source
-- [ ] Implement both list and detail views