rpsg 0.4.1 → 0.4.2

data/docs/_pages/bundler.txt

@@ -1,26 +0,0 @@
----
-layout: default
-title: "Using Bundler - RPSG"
-permalink: /bundler.html
----
-
-# Utilizing Bundler
-
-* auto-gen TOC:
-{:toc}
-
-> Bundler is an easy and efficient way to get all the correct gem versions installed for `RPSG`
-
-## Windows/Mac (OSX)
-
-### Using Bundle Install
-
-1. Open `Command Prompt`/`Terminal` depending on OS
-2. `cd` to the directory of the `Gemfile` in the `RPSG` repository folder
-	* do download the `RPSG` repo folder, go [here](https://github.com/bag3318/RPSG){: target="_blank"} and click `Download` then `Download ZIP`
-3. type `bundle install` and hit <kbd>Enter</kbd>/<kbd>Return</kbd> (depending on OS)
-
-### Using Bundle Update
-
-1. `cd` to the directory of the `Gemfile` in the `RPSG` repository folder
-2. type `bundle update` and hit <kbd>Enter</kbd>/<kbd>Return</kbd> (depending on OS)

data/docs/_pages/code.txt

@@ -1,178 +0,0 @@
----
-layout: default
-permalink: /code.html
-title: "Complete Code - RPSG"
----
-
-{::comment}
-contains complete RPSG code
-{:/comment}
-
-# Complete Code
-
-* auto-gen TOC:
-{:toc}
-
-> The complete code will look like this:
-
-```
-% rpsg
-```
-
-~~~ruby
-#!/usr/bin/env ruby
-
-=begin
-|====================================|
-| Req Ruby Ver | Req Ruby Gems Ver   |
-|--------------|---------------------|
-| >= v2.0.0    | >= v2.6.0           |
-|====================================|
-=end
-
-# create master class for rpsg
-class RockPaperScissorsGame
-
-  # specify the version for the rubygem
-  module RPSG
-    # create version constant for the rubygem
-    VERSION = "0.4.1"
-  end
-
-  # create module that holds all contents for this script
-  module ProtectedConstants
-
-    # create 2d list of choices
-    protected
-    CHOICES = [['r', 'rock'], ['p', 'paper'], ['s', 'scissors']]
-
-    # define entry to symbol (key to value) dictionary
-    protected
-    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
-    }
-
-    # define valid entries
-    protected
-    VALID_ENTRIES = NTRY_TO_SYM.keys
-
-    # define computer choices
-    protected
-    COMPUTER_CHOICES = NTRY_TO_SYM.values
-
-    # create winners 2d list array with format: winning choice, losing choice
-    protected # make protected
-    WINNERS = [
-      [:SCISSORS, :PAPER   ],
-      [:PAPER   , :ROCK    ],
-      [:ROCK    , :SCISSORS]
-    ]
-
-    # this will take the original WINNERS array and flip the symbols, thus returning a loss for the user/player
-    protected
-    LOSERS = WINNERS.map { |winning_choice,losing_choice| [losing_choice,winning_choice] }
-
-  end
-
-  # protected_methods :ProtectedConstants
-
-  class << self
-    # add continue method for asking the user if they want to play rock paper scissors
-    def continue(str1,str2,str3)
-      puts  str1
-      print str2
-      gets
-      puts  str3
-    end
-  end
-
-  # print out strings
-  continue("\nYou are about to enter a rock-paper-scissors best of 3 match.", "\nPress the return/enter key to continue...", "")
-
-  # initialize variables
-  def initialize
-    # initialize variables and set all equal to zero
-    @player_score = @computer_score = @ties = 0
-  end
-
-  # define play method, this will be the main function for playing rock paper scissors
-  def play(winning_score)
-    # make while loop
-    while @player_score < winning_score && @computer_score < winning_score
-      puts "\nPlayer score: #{@player_score}, " +
-           "Computer score: #{@computer_score}, Ties: #{@ties}.\n"
-      player = PrivateMethods.player_choice
-      computer = ProtectedConstants::COMPUTER_CHOICES.sample # chooses a random option
-      puts "\nPlayer chooses #{player.to_s.downcase}."
-      puts "Computer chooses #{computer.to_s.downcase}.\n"
-      case PrivateMethods.player_outcome [player, computer]
-      when :WIN
-        puts "\n#{player.to_s.capitalize} beats #{computer.to_s.downcase}, player wins the round.\n"
-        @player_score += 1
-      when :LOSE
-        puts "\n#{computer.to_s.capitalize} beats #{player.to_s.downcase}, computer wins the round.\n"
-        @computer_score += 1
-      else
-        puts "\nTie, choose again\n"
-        @ties += 1
-      end
-    end
-    puts "\nFinal score: player: #{@player_score}, " +
-         "computer: #{@computer_score} (ties: #{@ties}).\n"
-    case PrivateMethods.final_outcome(@player_score, @computer_score)
-    when :WIN
-      puts "\nPlayer wins!\n"
-    when :LOSE
-      puts "\nComputer wins!\n"
-    else
-      puts "\nIt's a tie!\n"
-    end
-    print "\n[press the enter/return key to exit game]"
-    gets
-  end
-
-  private # make private
-  # 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): "
-          choice = gets.chomp.downcase
-          if ProtectedConstants::NTRY_TO_SYM.key?(choice)
-            return ProtectedConstants::NTRY_TO_SYM[choice]
-          elsif choice != ProtectedConstants::VALID_ENTRIES
-            puts "\nThat entry is invalid. Please re-enter.\n"
-          else
-            return nil
-          end
-        end
-      end
-      # define outcomes of players choice against cpu
-      def player_outcome(plays)
-        return :WIN  if ProtectedConstants::WINNERS.include?(plays)
-        return :LOSE if ProtectedConstants::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
-        # return :TIE  if pl = co
-        # there will never be a tie for the final outcome due to the code in the `play()` method
-      end
-    end
-  end
-  public # make public again
-
-  # private_methods :PrivateMethods
-
-end
-
-RockPaperScissorsGame.new.play(2) # best out of 3
-
-$end
-~~~

data/docs/_pages/index.txt

@@ -1,16 +0,0 @@
----
-layout: default
-title: "Rock Paper Scissors Game - RPSG"
-permalink: /index.html
----
-
-# Rock Paper Scissors Game
-
-* auto-gen TOC:
-{:toc}
-
-> Welcome to my **RPSG** home site. I created my `RPSG` gem with __Ruby__, the programming language. {::comment}<br/>{:/comment}
-
-> _**Please Enjoy! :)**_{: style="text-decoration: underline;"}
-
- 

data/docs/_pages/install.txt

@@ -1,110 +0,0 @@
----
-layout: default
-title: "How to Install - RPSG"
-permalink: /install.html
----
-
-# Install Guide
-
-* auto-gen TOC:
-{:toc}
-
-> This guide will tell you how to install everything that is needed for using my **`RPSG`** gem.
-
-## For Mac/OSX
-
-__What you will install:__
-
-1. Ruby
-2. RubyGems
-3. Homebrew
-4. RVM
-5. XCode Command Line Tools
-6. RPSG (my RubyGem)
-
-### Useful Skills:
-
-#### To open the Terminal
-
-1. Press <kbd>Command</kbd> + <kbd>Space</kbd>
-2. Type in `Terminal`
-3. Press <kbd>Return</kbd>
-
-#### To Copy
-
-1. Press <kbd>Command</kbd> + <kbd>C</kbd>
-
-#### To Paste
-
-1. Press <kbd>Command</kbd> + <kbd>V</kbd>
-
-### Step 1 - Installing XCode Command Line Tools
-
-1. Open `Terminal` and copy/paste this: `sudo xcode-select --install` and hit <kbd>Return</kbd>
-2. You might need to enter your password a few times
-
-### Step 2 - Installing Homebrew
-
-1. In the `Terminal`, copy/paste this: `/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"`, and hit <kbd>Return</kbd>
-2. You might need to enter your password
-
-### Step 3 - Installing RVM/Ruby/RubyGems
-
-1. In the `Terminal`, copy/paste this: `\curl -sSL https://get.rvm.io | bash -s stable --ruby` and hit <kbd>Return</kbd>
-2. You might need to enter your password
-
-### Step 4 - Installing RPSG
-
-1. Close `Terminal` by pressing <kbd>Command</kbd> + <kbd>Q</kbd>
-2. Open `Terminal` again
-3. Type in the following: `gem install rpsg`, then hit <kbd>Return</kbd>
-
-### Step 5 - Running RPSG
-
-1. Whenever you want to play Rock Paper Scissors, just open `Terminal` and type in: `rpsg`, then hit <kbd>Return</kbd>
-
-## For Windows
-
-__What you will install:__
-
-1. Ruby
-2. RubyGems
-3. RPSG (my RubyGem)
-
-### Useful Skills
-
-#### Opening the Command Prompt
-
-1. Press <kbd>Windows</kbd> + <kbd>R</kbd>
-2. Type in `cmd`
-3. Press <kbd>Enter</kbd>
-
-#### To Copy
-
-1. Press <kbd>Control</kbd> + <kbd>C</kbd>
-
-#### To Paste
-
-1. Press <kbd>Control</kbd> + <kbd>V</kbd>
-
-### Step 1 - Downloading Ruby Installer
-
-1. Open a Web Browser
-	* Web Browser ex: Chrome, Firefox, IE, Safari, Edge, Opera, etc...
-2. Copy/paste this into the browser's URL bar `https://rubyinstaller.org/downloads/`
-3. Press <kbd>Enter</kbd>
-4. Download the appropriate installer
-
-### Step 2 - Installing Ruby & RubyGems
-
-1. Open the `rubyinstaller.exe` (may be named differently for you)
-2. Proceed with the installation
-
-### Step 3 - Installing RPSG
-
-1. Open the `Command Prompt`
-2. Type in the following: `gem install rpsg`
-
-### Step 4 - Running RPSG
-
-1. Any time you would like to play rock paper scissors, just open the `Command Prompt` and type in: `rpsg` and hit <kbd>enter</kbd>

data/docs/_pages/simple.txt

@@ -1,45 +0,0 @@
----
-layout: default
-title: "Simple Code - RPSG"
-permalink: /simple.html
----
-
-# Simple/Beginners RPS Code
-
-* auto-gen TOC:
-{:toc}
-
-> This is what a beginner's RPS code might look like
-
-{% highlight ruby %}
-options = ["rock", "paper", "scissors"]
-computer_choice = options[rand(options.length)] 
-puts "What's your choice?"
-puts "rock, paper, or scissors"
-user_input = gets.chomp.downcase # read user input and convert to lower case
-loop do 
-  if (user_input == "rock" || user_input == "paper" || user_input == "scissors")
-    if (user_input == computer_choice)
-      puts "We got the same, let's keep playing!"
-    elsif (user_input == "rock" && computer_choice == "scissors")
-      puts "computer choice is: " + computer_choice + ", you win! :)"
-    elsif (user_input == "rock" && computer_choice == "paper")
-      puts "computer choice is: " + computer_choice + ", computer wins :("
-    elsif (user_input == "paper" && computer_choice == "scissors")
-      puts "computer choice is: " + computer_choice + ", computer wins :("
-    elsif (user_input == "paper" && computer_choice == "rock")
-      puts "computer choice is: " + computer_choice + ", you win! :)"
-    elsif (user_input == "scissors" && computer_choice == "rock")
-      puts "computer choice is: " + computer_choice + ", computer wins :("
-    elsif (user_input == "scissors" && computer_choice == "paper")
-      puts "computer choice is: " + computer_choice + ", you win! :)"
-    end
-  else
-    puts "Invalid choice, enter Rock, Paper, or Scissors"
-  end
-  break
-end
-
-$end
-{% endhighlight %}
-

data/docs/_pages/test.md

@@ -1,40 +0,0 @@
----
-layout: default
-title: "Tests for learning"
-permalink: /test.html
----
-
-# Comments
-
-* auto-gen TOC:
-{:toc}
-
-## Markdown
-
-[//]: # (comment)
-[//]: # "comment"
-
-### wrong ways
-
-[//]: <> (this is not a markdown comment)
-[//]: <> "this is not a markdown comment"
-[comment]: # (this is not a markdown comment)
-[comment]: # "this is not a markdown comment"
-[comment]: <> (this is not a markdown comment)
-[comment]: <> "this is not a markdown comment"
-
-## Kramdown
-
-{::comment}
-comment
-{:/comment}
-
-## Liquid
-
-{% comment %}
-comment
-{% endcomment %}
-
-## HTML
-
-<!-- comment -->

data/docs/_pages/uninstall.txt

@@ -1,19 +0,0 @@
----
-layout: default
-title: "How to Uninstall - RPSG"
-permalink: /uninstall.html
----
-
-# How to Uninstall
-
-* auto-gen TOC:
-{:toc}
-
-> This guide will show you how to quickly uninstall `RPSG`
-
-## Mac (OSX)/Windows
-
-1. Open `Command Prompt`/`Terminal` (depending on OS)
-2. Type in `gem uninstall rpsg`
-3. Hit <kbd>Enter</kbd>/<kbd>Return</kbd> (depending on OS)
-4. Confirm Uninstallation

data/docs/_pages/update.txt

@@ -1,19 +0,0 @@
----
-layout: default
-title: "How to Update - RPSG"
-permalink: /update.html
----
-
-# Update Guide
-
-* auto-gen TOC:
-{:toc}
-
-> This guide will show you how to easily update RPSG.
-
-## Mac (OSX)/Windows
-
-1. Open `Terminal`/`Command Prompt` (depending on OS)
-2. Type in the following: `gem update rpsg`
-3. Hit <kbd>Enter</kbd>/<kbd>Return</kbd> (depending on OS)
-