rpsg 0.1.1 → 0.1.2

data/lib/Constants.rb

@@ -1,22 +1,30 @@
+# create module that holds all contents for this script
 module Constants 
-  CHOICES = [['r', 'rock'], ['p', 'paper'], ['s', 'scissors']] # create 2d list of choices
-  NTRY_TO_SYM = { # define entry to symbol (key to value)
+  
+  # create 2d list of choices
+  CHOICES = [['r', 'rock'], ['p', 'paper'], ['s', 'scissors']] 
+
+  # define entry to symbol (key to value)
+  NTRY_TO_SYM = { 
     CHOICES[0][0] => :ROCK    , CHOICES[0][1]     => :ROCK    ,
     CHOICES[1][0] => :PAPER   , CHOICES[1][1]     => :PAPER   ,
     CHOICES[2][0] => :SCISSORS, CHOICES[2][1]     => :SCISSORS
   } 
-  VALID_ENTRIES = NTRY_TO_SYM.keys # define valid entries
-  COMPUTER_CHOICES = NTRY_TO_SYM.values # define computer choices
+
+  # define valid entries
+  VALID_ENTRIES = NTRY_TO_SYM.keys 
+
+  # define computer choices
+  COMPUTER_CHOICES = NTRY_TO_SYM.values 
+
+  # create winners 2d list array with format: winning choice, losing choice
   WINNERS = [
-    # format: player choice, computer choice
     [:SCISSORS, :PAPER   ], 
     [:PAPER   , :ROCK    ], 
     [:ROCK    , :SCISSORS]
   ] 
-  LOSERS = WINNERS.map { |winning_choice,losing_choice| [losing_choice,winning_choice] } # this will take the original WINNERS array and flip the symbols, thus returning a loss for the user/player
-  INIT_STRINGS = [
-    "You are about to enter a rock-paper-scissors best of 3 match.", 
-    "Press the return/enter key to continue...", 
-    ""
-  ]
+
+  # this will take the original WINNERS array and flip the symbols, thus returning a loss for the user/player
+  LOSERS = WINNERS.map { |winning_choice,losing_choice| [losing_choice,winning_choice] } 
+
 end

data/lib/PrivateMethods.rb

@@ -1,5 +1,7 @@
+# add module for private methods for the rpsg calculations
 module PrivateMethods
   class << self
+    # make a definition that asks for the players choice
     def player_choice
       loop do
         print "\nChoose: Rock (r), Paper (p), or Scissors (s): \n"
@@ -20,11 +22,13 @@ module PrivateMethods
         # end
       end 
     end 
+    # define outcomes of players choice against cpu
     def player_outcome(plays)
       return :WIN  if Constants::WINNERS.include?(plays)
       return :LOSE if Constants::LOSERS.include?(plays)
       return :TIE  if !:WIN | !:LOSE
     end 
+    # define final outcome that gives the result of who one the whole match
     def final_outcome(pl,co) 
       return :WIN  if pl > co 
       return :LOSE if pl < co

data/lib/rpsg/version.rb

@@ -1,3 +1,5 @@
+# specify the version for the rubygem
 module RPSG
-	VERSION = "0.1.1" 
+	# create version constant for the rubygem
+	VERSION = "0.1.2" 
 end

data/rpsg.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec| 
   spec.name                             = "rpsg"
-  spec.version                          = "0.1.1"
+  spec.version                          = "0.1.2"
   spec.date                             = "2017-10-12"
   spec.summary                          = "A Rock Paper Scissors Game Ruby Gem"
   spec.description                      = <<-EOF 

data/test/rpsg.rb

@@ -1 +1,2 @@
+# load from bin directory
 load "bin/rpsg"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rpsg
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - bag3318
@@ -85,6 +85,56 @@ files:
 - README.md
 - Rakefile
 - bin/rpsg
+- html/Constants.html
+- html/PrivateMethods.html
+- html/README_md.html
+- html/RPSG.html
+- html/RockPapaerScissorsGame.html
+- html/created.rid
+- html/css/fonts.css
+- html/css/rdoc.css
+- html/fonts/Lato-Light.ttf
+- html/fonts/Lato-LightItalic.ttf
+- html/fonts/Lato-Regular.ttf
+- html/fonts/Lato-RegularItalic.ttf
+- html/fonts/SourceCodePro-Bold.ttf
+- html/fonts/SourceCodePro-Regular.ttf
+- html/images/add.png
+- html/images/arrow_up.png
+- html/images/brick.png
+- html/images/brick_link.png
+- html/images/bug.png
+- html/images/bullet_black.png
+- html/images/bullet_toggle_minus.png
+- html/images/bullet_toggle_plus.png
+- html/images/date.png
+- html/images/delete.png
+- html/images/find.png
+- html/images/loadingAnimation.gif
+- html/images/macFFBgHack.png
+- html/images/package.png
+- html/images/page_green.png
+- html/images/page_white_text.png
+- html/images/page_white_width.png
+- html/images/plugin.png
+- html/images/ruby.png
+- html/images/tag_blue.png
+- html/images/tag_green.png
+- html/images/transparent.png
+- html/images/wrench.png
+- html/images/wrench_orange.png
+- html/images/zoom.png
+- html/index.html
+- html/js/darkfish.js
+- html/js/jquery.js
+- html/js/navigation.js
+- html/js/navigation.js.gz
+- html/js/search.js
+- html/js/search_index.js
+- html/js/search_index.js.gz
+- html/js/searcher.js
+- html/js/searcher.js.gz
+- html/table_of_contents.html
 - lib/Constants.rb
 - lib/PrivateMethods.rb
 - lib/rpsg/version.rb