monster_encyclopedia 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac705d6ce8d0788ef9ceb095232be997f108d21f17eb3922eafd9184d70d49ef
-  data.tar.gz: d7efc6d00b7db65267213c6b5773046ed4ad3a8e2c8d30d1fd41a6ef9b54a905
+  metadata.gz: 4a9fa49c824cc1924f275a5cd7c55ff802b768a47eadaafb3eb5f34900065563
+  data.tar.gz: cf76318d2e60f2a33b7e1454a5e5f29c9eb413c67b9a15e282fa71d6f2bbcfb2
 SHA512:
-  metadata.gz: b9031d29656eef77628e61eeba914e5462f17865d5112ce1d56134f761c3e74984fe34b7beace495b93f1956b1a77bbc317f0eed15da52037cbff61b179e06d1
-  data.tar.gz: 4971c16962413b069eb0ac330cf1a8a0c82864712cadcf07a0bf5bd9778c0d054c21dbcfbd9400e40fe12b30238da7591855c777705a85d0f79a1b29ec768f0e
+  metadata.gz: 56562d3957b0c1a73de034fcb67d3a2b8b6b06d2598b20f20b99a94c4805eaa1567405980d318fcc5c32ceed826560c31f3b42dd271ca878499c6d4339a77006
+  data.tar.gz: a29044e5367416e347ed63b0cb0c938561ce4e36724625e39d2d2e31a77ce49a125846200ec7ce6b17162672b86dcf1557a10f756f40ef4e1a5a3fc175b9ec81

data/README.md

@@ -1,8 +1,20 @@
+
 # MonsterEncyclopedia
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/monster_encyclopedia`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
+Hello and thankyou for using the Monster Encyclopedia! this program is a useful application for all your monster hunting needs!
+It can be used to view documented monster details, add newly discovered monsters to your database or remove monsters if they have been proven false!
+It utilizes the gems colorize, tty-prompt, artii and csv for a great user experience!
+Have fun.
+
+## Links
+-[GitHub](https://github.com/RobThomas30/Monster-Encyclopedia/commits/master)
+-[Trello](https://trello.com/b/AvlKLu12/monsterencyclopedia)
+
+## Tests
+
+
 
 ## Installation
 
@@ -20,9 +32,69 @@ Or install it yourself as:
 
     $ gem install monster_encyclopedia
 
+
 ## Usage
 
-TODO: Write usage instructions here
+When running Monster Encyclopedia you will be briefly greeted on the opening screen before the menu launches.
+
+Menu:
+    This is the hub of the application and can be navigated with the arrow keys, press enter to select.
+    The menu consists of 4 options:
+        -View Monsters
+        -Add Monster
+        -Remove Monster
+        -Exit
+
+View Monsters:
+    If you select the view monster option the program will call on the csv database and print the data to the screen, monsters will be ordered by name alphabetically and will also show where they have been seen followed by a description of the monster.
+
+Add Monsters:
+    If you select add monster option from the menu you will be prompted to write in the name, location and description of a monster.
+    After completing these 3 steps you will be asked to confirm that what you have input is correct you can press 1 or 2 and enter to confirm:
+        -Press 1 to confirm your input and append the csv database with your new entry.
+        -Press 2 if your information is incorrect or you change your mind about adding a new entry you can select this option and it will not append the csv
+
+Remove Monster:
+    If you select this option the screen will be populated with only the names of the monsters from the csv, you will be prompted to type the name of the monster you wish to remove from the database.
+        *To ensure you don't accidentally remove the wrong monster you must type the name of the monster exactly how it appears on screen(case sensitive)
+
+Exit:
+    If you select this option the program will display a goodby message accompanied by the logo before the program closes.
+
+
+## Features
+
+Persistent memory:
+    This application communicates with a csv file which allows it to read, write and re-write data.
+    It will even store the applications data after the program closes!
+        -Read: When reading from the csv first the program 'requires csv' then reads in the information and stores it in a variable.
+        It then uses this variable to print to screen for the user.
+        -Write: When writing to the csv the program utilizes the -ab function to append the csv with a new entry.
+        -Re-write: When deleting something from the csv it combines both read and write functions by reading in the csv and converting it to an array of hashes if the user input is the same as a monster name it will remove that monster from the array and then use the -w function to overwrite the csv data.
+
+Gem integration:
+    The Monster Encyclopedia utilizes multiple gems that make it easier to navigate the application and enhance its appearance.
+        -TTY Prompt: Allows the user to navigate the main menu using the arrow keys
+        -Colorize: Adds a splash of colour to the application!
+        -Artii: Was used to make a logo for startup and shutdown.
+
+
+## Statement of Purpose
+
+The Application:
+    - The monster Encyclopedia will allow users to view, add and remove "entries" in the encyclopedia which will consist of monster name, location and description.
+Why:
+    - The monster encyclopedia will allow adventurers to keep track of their discoveries in an organized logbook type application.
+Target Audience:
+    - The target audience is unorganized scientists and monster hunters that need an application to track their discoveries and experiments.
+    How:
+    - The app will be easy to navigate utilizing with simple instructions built into the app telling the user what to do and how to use it.
+    -the menu will be traversable with the arrow keys and enter to select.
+    -When adding or removing a monster entry the user will be required to type in information.
+
+
+
+
 
 ## Development
 
@@ -42,3 +114,8 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the MonsterEncyclopedia project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/monster_encyclopedia/blob/master/CODE_OF_CONDUCT.md).
+
+
+## UML
+
+![](.docs/)

data/documentation/features

@@ -0,0 +1,13 @@
+Features
+
+Menu:
+The menu of the Monster Encyclopedia terminal application will serve as a central hub.
+On startup a welcome message and logo will display, then the menu will run showing the user the available functions/options.
+-View entries
+-Add new monster
+-Remove a monster
+-Exit program
+A ruby gem will be used to make the menu interactive, the arrow keys will be used to navigate and enter will confirm your choice.
+
+View monsters:
+

data/lib/add_monster.rb

@@ -0,0 +1,50 @@
+
+class Monster
+    attr_reader :name, :location, :description
+    def initialize(name, location, description)
+        @name = name
+        @location = location
+        @description = description
+    end
+end
+
+def add_monster(monsters_array)
+    info = true
+    
+    while info == true
+      system 'clear'
+      puts '-'.colorize(:light_red) * 45
+      puts "What is the name of the monster?"
+      print '> '
+      monster_name = gets.chomp 
+      puts '-'.colorize(:light_red) * 45
+      puts "Where was the monster sighted?"
+      print '> '
+      monster_location = gets.chomp
+      puts '-'.colorize(:light_red) * 45
+      puts "What does the monster look like?"
+      print '> '
+      monster_description = gets.chomp
+      puts '-'.colorize(:light_red) * 45
+      puts "Is your entry correct?"
+      puts "1. Yes => Add entry to encyclopedia"
+      puts "2. No  => Cancel entry return to menu"
+      while info == true
+        case gets.chomp.to_i
+        when 1
+          new_monster = Monster.new(monster_name, monster_location, monster_description)
+          monsters_array << new_monster
+          CSV.open("data.csv", "ab") do |csv|
+            csv << [monster_name, monster_location, monster_description]
+            system 'clear'
+            info = false
+          end
+        when 2
+          system 'clear'
+          info = false
+        else
+          puts "Please pick 1 or 2"
+        end
+      end
+    end
+  end

data/lib/data.csv

@@ -0,0 +1,8 @@
+name,location,description
+Lock-ness Monster,Scotland,A large amphibious dinosaur like monster with a long neck and fins instead of legs.
+Cthulu,???,An enormous being with a tentacle covered face rumoured to be sleeping at the bottom of the ocean.
+Bigfoot,North America,A slightly larger than man sized monster covered in white hair.
+Tooth Fairy,Bedrooms of children,Unsighted however when a child leaves a tooth under their pillow it will take the tooth and leave a coin
+Guy,Coder Academy,A nice chap that broke my code then helped me fix it.
+Godzilla,Manhatten,A gigantic iguana altered by radiation it breathes fire and destroys buildings with ease
+Bunyip,Australia,A slightly larger than man gangly long limbed monster that lives in australian wetlands

data/lib/encyclopedia_menu.rb

@@ -0,0 +1,52 @@
+
+require_relative 'view_monsters.rb'
+require_relative 'add_monster.rb'
+require_relative 'remove_monster'
+require_relative 'invalid_and_exit'
+require 'csv'
+require 'tty-prompt'
+require 'colorize'
+require 'artii'
+
+$prompt = TTY::Prompt.new
+
+system 'clear'
+puts "-".colorize(:red) * 45
+puts "Welcome to Monster Encyclopedia!"
+puts "-".colorize(:red) * 45
+text = Artii::Base.new :font => 'epic'
+puts text.asciify('--M:E--').colorize(:color => :black, :background => :red)
+puts '-'.colorize(:light_red) * 45
+sleep 3
+
+def menu()
+  system 'clear'
+  puts "-".colorize(:red) * 45
+  puts "Welcome to the Monster Encyclopedia"
+  puts "-".colorize(:red) * 45
+  input = $prompt.select("What would you like to do?") do |menu|
+    menu.choice name: "View all entries", value: 1
+    menu.choice name: "Add a new monster to the encyclopedia", value: 2
+    menu.choice name: "Remove a monster from the encyclopedia", value: 3
+    menu.choice name: "Close encyclopedia", value: 4
+  end
+  return input
+end
+
+while true
+  input = menu()
+  monsters_array = []
+
+  case input
+  when 1
+    view_monsters()
+  when 2
+    add_monster(monsters_array)
+  when 3
+    remove_monster(monsters_array)
+  when 4
+    exit_program()
+  else
+    invalid_input()
+  end
+end

data/lib/invalid_and_exit.rb

@@ -0,0 +1,22 @@
+
+def invalid_input
+    system 'clear'
+    puts '-'.colorize(:light_red) * 45
+    puts "Please pick a number from the menu."
+    puts '-'.colorize(:light_red) * 45
+    sleep 3.0
+    system 'clear'
+end
+
+def exit_program()
+    system 'clear'
+    puts '-'.colorize(:light_red) * 45
+    puts "Thankyou for using the Monster Encyclopedia!"
+    puts '-'.colorize(:light_red) * 45
+    text = Artii::Base.new :font => 'epic'
+    puts text.asciify('--M:E--').colorize(:color => :black, :background => :red)
+    puts '-'.colorize(:light_red) * 45
+    sleep 3.0
+    system "clear"
+    exit
+end

data/lib/monster_encyclopedia/version.rb

@@ -1,3 +1,3 @@
 module MonsterEncyclopedia
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/remove_monster.rb

@@ -0,0 +1,45 @@
+def remove_monster(monsters_array)
+  monster = []
+  monster_names = []
+  csv_text = File.read('data.csv')
+  csv = CSV.parse(csv_text, :headers => true)
+  csv.each do |row|
+    monster << row.to_hash
+  end
+
+  system 'clear'
+
+  monster.sort_by! { |mon| mon["name"]}
+  monster.each do |thing|
+    puts '-'.colorize(:red) * 45
+    puts "Name: #{thing["name"]}"
+    puts
+    monster_names << thing["name"]
+  end
+
+  puts "Which monster would you like to remove from the encyclopedia?"
+  input = gets.chomp
+
+  if monster_names.include?(input)
+    table = CSV.table("data.csv")
+    table.delete_if.with_index  do |row, index|
+      next if index.zero?
+      row[0] == input
+    end
+
+    File.open("data.csv", 'w') do |data|
+      data.write(table.to_csv)
+    end
+    system 'clear'
+    puts '-'.colorize(:red) * 45
+    puts "#{input} was deleted!"
+    puts '-'.colorize(:red) * 45
+    sleep 2
+  else
+    system 'clear'
+    puts '-'.colorize(:red) * 45
+    puts "No monster by that name..."
+    puts '-'.colorize(:red) * 45
+    sleep 2
+  end
+end

data/lib/view_monsters.rb

@@ -0,0 +1,21 @@
+
+def view_monsters()
+    monsters_array = []
+    csv_text = File.read('data.csv')
+    csv = CSV.parse(csv_text, :headers => true)
+    csv.each do |row|
+      monster = row.to_hash
+      monsters_array << monster
+      system 'clear'
+    end
+      monsters_array.sort_by! { |mon| mon["name"]}
+      monsters_array.each do |monster|
+      puts '-'.colorize(:red) * 45
+      puts "Name:" + " #{monster["name"]}".colorize(:light_red)
+      puts "Found: #{monster["location"]}"
+      puts
+      puts "Description: #{monster["description"]}"  
+      puts
+    end 
+    gets
+  end

data/monster_encyclopedia.gemspec

@@ -12,12 +12,6 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
-  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
-
-  # spec.metadata["homepage_uri"] = spec.homepage
-  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
-
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: monster_encyclopedia
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Robert Thomas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-11 00:00:00.000000000 Z
+date: 2020-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -39,8 +39,15 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/monster_encyclopedia.rb
+- documentation/Monster Encyclopedia.png
+- documentation/features
+- lib/add_monster.rb
+- lib/data.csv
+- lib/encyclopedia_menu.rb
+- lib/invalid_and_exit.rb
 - lib/monster_encyclopedia/version.rb
+- lib/remove_monster.rb
+- lib/view_monsters.rb
 - monster_encyclopedia.gemspec
 homepage: https://github.com/RobThomas30/Monster-Encyclopedia
 licenses:

data/lib/monster_encyclopedia.rb

@@ -1,6 +0,0 @@
-require "monster_encyclopedia/version"
-
-module MonsterEncyclopedia
-  class Error < StandardError; end
-  # Your code goes here...
-end