pokedex-terminal 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 360fced44a71058bcaec8c07f2a57d3f8b9cb2330dfb55a072f5a7dde6ea0685
-  data.tar.gz: 875cc3ace591042a18a1ce859c2f41a4b66585a9243866724a9266172f35629f
+  metadata.gz: 10da1af5c4625910694a802022db4675c81adba6e4c490256677dd4bba7eb98f
+  data.tar.gz: 83d8626e86fb96c0b0415d2a0e8c426cc71c30d476687d9d09e6c2bbcff8dccf
 SHA512:
-  metadata.gz: 264dda2ae2c32b2313d881af00aeaad9082e249d0a5e7f37b96aba54fb540569d7022438dc8129fd6051713e3c89b63851685790dfd2301342f5e472077c2508
-  data.tar.gz: c6655af403379e18d83c53caadf5e129a0b7f819b4cbe53dfad12a362696c76006ce19d2cca0d835c9cb0fa72dd29a74b1863fb997612b86d1603f21d6327bd7
+  metadata.gz: 824cf0ce804f60d950b2c1072770da11af84e337371ed2549eaafa1ac40bcc5d840207165d93f987ac1fd586c703ae0031a1b164a4d16176393b01be21261734
+  data.tar.gz: baf66dcb34a7daa5f3a1daab889a97a6a5d69a8fa5460c41112a6318f09a455c9b0bed47f256b848d74b178aa51b3c3eee400c87d2d05daff1d478bcf8efd741

data/Gemfile

@@ -1,7 +1,9 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in pokedex-terminal.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pokedex-terminal (0.1.2)
+    pokedex-terminal (0.1.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,20 +1,53 @@
-# Pokedex::Terminal
+# pokedex-terminal
 
-This terminal application seeks to emulate the basic functionality of the fictional ‘Pokedex’ device from within the Pokemon universe; a digital encyclopaedia of all existing Pokemon, their ‘Types’ and their attributes.
+This terminal application seeks to emulate the basic functionality of the fictional ‘Pokedex’ device from within the Pokemon universe; a digital encyclopaedia of all existing Pokemon, their ‘Types’ and their attributes. Unlike the classical Pokedex, the user is able to update attributes of any Pokemon and add an entirely new Pokemon of their choosing to the database.
 
-While several Pokedex applications exist, pokedex-terminal seeks to run with minimal computational resources as to allow access to the widest audience possible, particuarly those using outdated devices.
+While several Pokedex applications exist, pokedex-terminal seeks to run with *minimal computational resources* as to allow access to the widest audience possible, particuarly those using outdated devices.
 
-pokedex-terminal also allows offline access to Pokemon attributes and descriptions for usage in situations where there is no internet access, or if Pokemon-related online content has been blocked/censored under oppressive regimes.
+pokedex-terminal also allows offline access to Pokemon attributes and descriptions for usage in situations where there is no internet access, or if Pokemon-related online content has been blocked/censored under oppressive regimes where downloading or accessing Pokemon-related online content is ***punishable by death***.
+
+---
+
+## Links
+-  [pokedex-terminal Github Repository](https://github.com/novacoole/pokedex-terminal)
+-  [pokedex-terminal RubyGem Repository](https://rubygems.org/gems/pokedex-terminal)
+
+---
+
+## Tests
+
+I used manual testing to test my app. You can find a spreadsheet that documents these tests [here.](https://ethercalc.org/1joas16280u9)
+
+---
 
 ## Installation
 
+You will need ruby installed to use this application. 
+Once you have, run the command below from terminal.
 ```
 $ gem install pokedex-terminal
 ```    
+#### Dependencies
+
+* [artii](https://github.com/miketierney/artii)
+* [colorize](https://github.com/fazibear/colorize)
+* [lolcat](https://github.com/busyloop/lolcat/)
+* [smarter_csv](https://github.com/tilo/smarter_csv)
+* [tty-prompt](https://github.com/piotrmurach/tty-prompt#32-active_color)
+
+#### Hardware requirements.
+
+This program should run on any terminal-enabled device built during or after the year that the Pokemon franchise was created.
+
+---
 
 ## Usage
 
-TODO: Write usage instructions here
+Run in terminal.
+```
+$ pokemon-terminal
+```
+---
 
 ## Features
 
@@ -24,11 +57,11 @@ This application allows the user to do the following:
 
 When the user selects "List Pokemon" from the main menu, the list_menu method of the List class is called. This method contains a menu system derived from 'tty-prompt' gem. This menu offers several options:
 
-1. "List all"
+1. **"List all"**
 
     To List all pokemon, the .list_all method of the List class is called. This method takes an input of data (@@pokemon_data). Then, a .each loop to iterate through the @@pokemon_data object (which contains hashes for each Pokemon). For each hash, the .print_pokemon_condensed method of the Print class is called with that hash an input. This method prints only the ':name' value of that hash.
 
-2. "List by Type"
+2. **"List by Type"**
 
     To list Pokemon by type, firstly the .add_type method belonging to the New class is called. This presents the user with a 'tty-prompt' .select menu which allows them to select a Pokemon Type. The user choice is returned and stored in the 'user_input' variable.
     
@@ -36,15 +69,15 @@ When the user selects "List Pokemon" from the main menu, the list_menu method of
 
     This method uses a .each method to iterate through  each hash the @@pokemon_data object, if a hash's ':type_1' value matches user_input, the .print_pokemon_condensed method of the Print class is called with that hash an input. This method prints only the ':name' value of that hash.
 
-3. "List by Secondary Type"
+3. **"List by Secondary Type"**
 
-     To list Pokemon by type, firstly the .add_type method belonging to the New class is called. This presents the user with a 'tty-prompt' .select menu which allows them to select a Pokemon Secondary Type. The user choice is returned and stored in the 'user_input' variable.
+    To list Pokemon by type, firstly the .add_type method belonging to the New class is called. This presents the user with a 'tty-prompt' .select menu which allows them to select a Pokemon Secondary Type. The user choice is returned and stored in the 'user_input' variable.
     
     Then the .list_by method of the List class is called. This method takes an input of data (@@pokemon_data), the hash key we want to filter within (:type_2), and the exact value we want to filter (user_input).
 
     This method uses a .each method to iterate through  each hash the @@pokemon_data object, if a hash's ':type_2' value matches user_input, the .print_pokemon_condensed method of the Print class is called with that hash an input. This method prints only the ':name' value of that hash.
 
-4. "List by Generation"
+4. **"List by Generation"**
 
     To list Pokemon by generation, firstly a 'tty-prompt' ..ask method is used to prompt the user for a number between 1-8. This input is returned and stored in a variable called 'user_input.
 
@@ -53,7 +86,7 @@ When the user selects "List Pokemon" from the main menu, the list_menu method of
     This method uses a .each method to iterate through  each hash the @@pokemon_data object, if a hash's ':generation' value matches user_input, the .print_pokemon_condensed method of the Print class is called with that hash an input. This method prints only the ':name' value of that hash.
 
 
-5. "List Legendary Pokemon"
+5. **"List Legendary Pokemon"**
 
     To list Pokemon by generation, the .list_by method of the List class is called. This method takes an input of data (@@pokemon_data), the hash key we want to filter within (:legendary), and the exact value we want to filter ('True').
 
@@ -63,19 +96,26 @@ When the user selects "List Pokemon" from the main menu, the list_menu method of
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests (**if they exist**). You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+---
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pokedex-terminal. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/pokedex-terminal/blob/master/CODE_OF_CONDUCT.md).
 
+---
 
 ## License
 
 The gem is available as open source under the terms of the [GPL-3.0 License](https://opensource.org/licenses/GPL-3.0).
 
+---
+
 ## Code of Conduct
 
-Everyone interacting in the Pokedex::Terminal project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/pokedex-terminal/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the pokedex-terminal project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/pokedex-terminal/blob/master/CODE_OF_CONDUCT.md).
+
+---

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "terminal"
+require 'bundler/setup'
+require 'terminal'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "terminal"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/pokedex-terminal

@@ -1,3 +1,4 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require_relative "../lib/pokedex-terminal"
+require 'pokedex-terminal'

data/lib/classes/Delete.rb

@@ -1,30 +1,24 @@
+# frozen_string_literal: true
+
+# this class handles delete functionality by iterating through our data until we match with user's selected pokemon date, and then deleting the entire hash.
+
 require 'tty-prompt'
 require_relative './Main_menu'
 
 class Delete
-  
   def self.delete(data)
     delete_prompt = TTY::Prompt.new(active_color: :red)
-      poke_array = []
-      data.each do |hash|
-        hash.each do |k,v|
-          if k == :name
-            poke_array << v
-          end
-        end
-      end
-      user_input = delete_prompt.select('Please enter the name of the Pokemon you\'re looking to delete', poke_array, filter: true)
-      data.each_with_index do |hash, index|
-        if hash[:name] == user_input
-          user_input_2 = delete_prompt.yes?("Are you sure you want to permanently delete #{hash[:name]}?")
-          if user_input_2 == true
-            data.delete_at(index)
-            return data
-          else
-            Main_menu.run
-          end
-        end
+    user_input Search.by_name(data)
+    data.each_with_index do |hash, index|
+      next unless hash[:name] == user_input
+
+      user_input_2 = delete_prompt.yes?("Are you sure you want to permanently delete #{hash[:name]}?")
+      if user_input_2 == true
+        data.delete_at(index)
+        return data
+      else
+        Main_menu.run
       end
+    end
   end
-
-end
+end

data/lib/classes/List.rb

@@ -1,53 +1,58 @@
+# frozen_string_literal: true
+
 require 'tty-prompt'
 
 class List
-  
   def self.list_menu(data)
-    while true
-      system 'clear'
+    loop do
       list_prompt = TTY::Prompt.new(active_color: :red)
       user_input = list_prompt.select("How would you like to list the Pokemon?\nPlease enter one of the following options.") do |menu|
-      menu.choice "List all", 1
-      menu.choice "List by Type", 2
-      menu.choice "List by Secondary Type",3
-      menu.choice "List by Generation", 4
-      menu.choice "List Legendary Pokemon", 5
+        menu.choice 'List all', 1
+        menu.choice 'List by Type', 2
+        menu.choice 'List by Secondary Type', 3
+        menu.choice 'List by Generation', 4
+        menu.choice 'List Legendary Pokemon', 5
       end
       case user_input
-        when 1
-          puts "-" * 40
-          puts "Listing all Pokemon"
-          puts "-" * 40
-          list_all(data)
-        when 2
-          puts "Which Type would you like to list by?"
-          user_input = New.add_type
-          puts "-" * 40
-          puts "Listing by #{user_input} Type:"
-          puts "-" * 40
-          list_by(data,:type_1,user_input)
-        when 3
-          puts "Which Secondary Type would you like to list by?"
-          user_input = New.add_type
-          puts "-" * 40
-          puts "Listing by #{user_input} Secondary Type:"
-          puts "-" * 40
-          list_by(data,:type_2,user_input)
-        when 4
-          while true
-            user_input = list_prompt.ask("Which generation would you like to list by?\nInput a number between 1-8.") { |q| q.in('1-8') }
-            puts "-" * 40
-            puts "Listing by Generation #{user_input}"
-            puts "-" * 40
-            list_by(data,:generation, user_input.to_i)
-          end
-        when 5
-          puts "-" * 40
-          puts "Listing Legendary Pokemon"
-          puts "-" * 40
-          list_by(data,:legendary,'True')
-        else
-          puts "Invalid selection, please enter a number between 1-5."
+      when 1
+        puts '-' * 40
+        puts 'Listing all Pokemon'
+        puts '-' * 40
+        list_all(data)
+        Main_menu.return?
+      when 2
+        puts 'Which Type would you like to list by?'
+        user_input = New.add_type
+        puts '-' * 40
+        puts "Listing by #{user_input} Type:"
+        puts '-' * 40
+        list_by(data, :type_1, user_input)
+        Main_menu.return?
+      when 3
+        puts 'Which Secondary Type would you like to list by?'
+        user_input = New.add_type
+        puts '-' * 40
+        puts "Listing by #{user_input} Secondary Type:"
+        puts '-' * 40
+        list_by(data, :type_2, user_input)
+        Main_menu.return?
+      when 4
+        loop do
+          user_input = list_prompt.ask("Which generation would you like to list by?\nInput a number between 1-8.") { |q| q.in('1-8') }
+          puts '-' * 40
+          puts "Listing by Generation #{user_input}"
+          puts '-' * 40
+          list_by(data, :generation, user_input.to_i)
+          Main_menu.return?
+        end
+      when 5
+        puts '-' * 40
+        puts 'Listing Legendary Pokemon'
+        puts '-' * 40
+        list_by(data, :legendary, 'True')
+        Main_menu.return?
+      else
+        puts 'Invalid selection, please enter a number between 1-5.'
       end
     end
   end
@@ -56,19 +61,15 @@ class List
     data.each do |hash|
       Print.print_pokemon_condensed(hash)
     end
-  puts "-" * 40
-  Main_menu.return?
+    puts '-' * 40
+    Main_menu.return?
   end
 
-  def self.list_by(data,attribute,value)
+  def self.list_by(data, attribute, value)
     data.each do |hash|
-      if hash[attribute] == value
-      Print.print_pokemon_condensed(hash)
-      end
+      Print.print_pokemon_condensed(hash) if hash[attribute] == value
     end
-  puts "-" * 40
-  Main_menu.return?
+    puts '-' * 40
+    Main_menu.return?
   end
-
 end
-

data/lib/classes/Main_menu.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative './Search'
 require_relative './Update'
 require_relative './New'
@@ -9,62 +11,91 @@ require 'artii'
 require 'lolize'
 
 class Main_menu
-@@pokemon_data = SmarterCSV.process('../../data/pokemon.csv')
+  # Creates an array of hashes from the CSV file with keys taken from CSV headers.
+  @@pokemon_data = SmarterCSV.process(File.dirname(__FILE__) + '/pokemon.csv')
 
   def self.run
-    while true
-      fork{exec "artii './titlesequence.plaintext' --font larry3d | lolcat"}
+    loop do
+      system 'clear'
+      sleep 0.1
+      fork { exec "artii 'Pokedex' --font larry3d | lolcat" }
+      sleep(0.3)
       main_menu_prompt = TTY::Prompt.new(active_color: :red)
-      puts "-" * 40
-      puts "        Welcome to your Pokedex!        ".blue.on_red.blink
-      puts "-" * 40
-      user_input = main_menu_prompt.select("Please select from the following:") do |menu|
-      menu.choice 'List Pokemon', 1 
-      menu.choice 'Search for a Pokemon', 2
-      menu.choice 'Update an existing Pokemon', 3
-      menu.choice 'Add a new Pokemon', 4
-      menu.choice 'Delete a Pokemon', 5 
-      menu.choice 'Exit', 6
-      menu.choice 'Print hashes', 7
+      puts '-' * 40
+      puts '        Welcome to your Pokedex!        '.blue.on_red.blink
+      puts '-' * 40
+      user_input = main_menu_prompt.select('Please select from the following:') do |menu|
+        menu.choice 'List Pokemon', 1
+        menu.choice 'Search for a Pokemon', 2
+        menu.choice 'Update an existing Pokemon', 3
+        menu.choice 'Add a new Pokemon', 4
+        menu.choice 'Delete a Pokemon', 5
+        menu.choice 'Exit and save changes', 6
+        # menu.choice 'Print hashes', 7
       end
       case user_input
-        when 1
-
-          List.list_menu(@@pokemon_data)
-        when 2
-          name = Search.by_name(@@pokemon_data)
-          hash = Search.return_hash(@@pokemon_data, name)
-          Print.print_pokemon_expanded(hash)
-        when 3
-          Update.update_pokemon_menu(@@pokemon_data)
-          ## Incomplete
-        when 4
-          new_hash = New.add_pokemon
-          @@pokemon_data << new_hash
-          Print.print_pokemon_expanded(new_hash)
-        when 5
-          @@pokemon_data = Delete.delete(@@pokemon_data)
-        when 6
-          CSV.open('../../data/pokemon.csv', "wb") do |csv|
-            keys = @@pokemon_data.first.keys
-            csv << keys
-            @@pokemon_data.each do |hash|
-              csv << hash.values_at(*keys)
-            end
-          end
-          exit
-        when 7
-          pp @@pokemon_data
-        else
-          "Invalid selection, please select from the following options."
+      when 1
+        list_pokemon
+      when 2
+        search_pokemon
+      when 3
+        update_pokemon
+      when 4
+        new_pokemon
+      when 5
+        delete_pokemon
+      when 6
+        exit_menu
+      # uncomment below 2 lines to allow developer feature to check hashes
+      # when 7
+      # pp @@pokemon_data
+      else
+        'Invalid selection, please select from the following options.'
       end
     end
   end
 
   def self.return?
-    puts "Press enter to return to the Main Menu."
+    puts 'Press enter to return to the Main Menu.'
     user_input = gets.chomp
-    run()
+    run
+  end
+
+  def self.list_pokemon
+    List.list_menu(@@pokemon_data)
+  end
+
+  def self.search_pokemon
+    Print.print_pokemon_expanded(Search.return_hash(@@pokemon_data, Search.by_name(@@pokemon_data)))
+  end
+
+  def self.update_pokemon
+    Update.update_pokemon_menu(@@pokemon_data)
   end
 
-end
+  def self.new_pokemon
+    new_hash = New.add_pokemon
+    @@pokemon_data << new_hash
+    Print.print_pokemon_expanded(new_hash)
+  end
+
+  def self.delete_pokemon
+    @@pokemon_data = Delete.delete(@@pokemon_data)
+  end
+
+  def self.exit_menu
+    save_changes = main_menu_prompt.ask('Are you sure you want to save your changes?')
+    if save_changes == true
+      CSV.open(File.dirname(__FILE__) + '/pokemon.csv', 'wb') do |csv|
+        keys = @@pokemon_data.first.keys
+        csv << keys
+        @@pokemon_data.each do |hash|
+          csv << hash.values_at(*keys)
+        end
+      end
+      exit
+    else
+      exit
+    end
+  end
+end

data/lib/classes/New.rb

@@ -1,20 +1,22 @@
-class New
+# frozen_string_literal: true
 
+class New
   def self.add_pokemon
-    puts "So you want to create a new Pokemon, what will you call it?"
-    name = add_name()
-    puts "What type will your Pokemon belong to?"
-    type_1 = add_type()
-    puts "Now for the secondary type."
-    type_2 = add_type()
+    puts 'So you want to create a new Pokemon, what will you call it?'
+    name = add_name
+    puts 'What type will your Pokemon belong to?'
+    type_1 = add_type
+    puts 'Now for the secondary type.'
+    type_2 = add_type
     hp = add_points('HP')
     attack = add_points('Attack')
     defense = add_points('Defense')
     sp_atk = add_points('Special Attack')
     sp_def = add_points('Special Defense')
     speed = add_points('Speed')
-    generation = add_generation()
-    legendary = add_legendary()
+    generation = add_generation
+    legendary = add_legendary
+    p legendary
     total = hp + attack + sp_atk + sp_def + speed
     hash = {}
     hash[:name] = name
@@ -29,50 +31,48 @@ class New
     hash[:speed] = speed
     hash[:generation] = generation
     hash[:legendary] = legendary
-    pp hash
-    return hash
+    hash
   end
 
-
   def self.add_name
-    print "> "
-    return gets.chomp
+    print '> '
+    gets.chomp
   end
 
   def self.add_type
     new_prompt = TTY::Prompt.new(active_color: :red)
-    user_input = new_prompt.select("Please select a Type.") do |menu|
-      menu.choice "Normal"
-      menu.choice "Fire"
-      menu.choice "Water" 	
-      menu.choice "Grass"
-      menu.choice "Electric" 	
-      menu.choice "Ice"
-      menu.choice "Fighting" 	
-      menu.choice "Poison"
-      menu.choice "Ground"
-      menu.choice "Flying"
-      menu.choice "Psychic"
-      menu.choice "Bug"
-      menu.choice "Rock"
-      menu.choice "Ghost"
-      menu.choice "Dark" 	
-      menu.choice "Dragon"
-      menu.choice "Steel" 	
-      menu.choice "Fairy"
+    user_input = new_prompt.select('Please select a Type.') do |menu|
+      menu.choice 'Normal'
+      menu.choice 'Fire'
+      menu.choice 'Water'
+      menu.choice 'Grass'
+      menu.choice 'Electric'
+      menu.choice 'Ice'
+      menu.choice 'Fighting'
+      menu.choice 'Poison'
+      menu.choice 'Ground'
+      menu.choice 'Flying'
+      menu.choice 'Psychic'
+      menu.choice 'Bug'
+      menu.choice 'Rock'
+      menu.choice 'Ghost'
+      menu.choice 'Dark'
+      menu.choice 'Dragon'
+      menu.choice 'Steel'
+      menu.choice 'Fairy'
     end
-    return user_input
+    user_input
   end
 
   def self.add_points(attribute)
-    while true
+    loop do
       puts "How many points would you like this Pokemon to have for #{attribute}?"
-      print "> "
+      print '> '
       user_input = gets.chomp.to_i
       if user_input > 0
         return user_input
       else
-        puts "Invalid selection. Please input a number greater than 0."
+        puts 'Invalid selection. Please input a number greater than 0.'
       end
     end
   end
@@ -80,10 +80,10 @@ class New
   def self.add_generation
     new_prompt = TTY::Prompt.new(active_color: :red)
     user_input = new_prompt.ask("Which generation does this Pokemon belong to?\nInput a number between 1-8.") do |q|
-     q.in('1-8')
+      q.in('1-8')
       q.messages[:valid?] = 'Invalid number, select a number from 1-8'
     end
-    return user_input
+    user_input
   end
 
   def self.add_legendary
@@ -92,7 +92,6 @@ class New
       q.messages[:valid?] = "Invalid response, select 'Y' or 'n'"
     end
     p user_input
-    return user_input = true ? 'True' : 'False'
+    user_input == true ? 'True' : 'False'
   end
-
-end
+end