Flash_Cards_Sturdy_Cards_App 0.1.2

data/lib/tests.rb

@@ -0,0 +1,37 @@
+require_relative 'classes/Deck.rb'
+require_relative 'classes/Card.rb'
+require_relative 'noname.rb'
+
+# TESTING METHODS THAT RECEIVE OBJECTS FROM CSV AND PUSH OBJECTS INTO NEW ARRAY VARIABLE
+
+test_deck = Deck.new(1,"Test Deck", "Testing")
+
+actual = test_deck.to_a # what the method returns
+expected = [1,"Test Deck", "Testing"]
+
+if actual == expected
+  puts "CSV deck inputs --> new array var PASSED"
+  else
+  puts "CSV card inputs --> new array var FAILED"
+  end
+
+test_card = Card.new(1,"Test Card", "Card Name", "Some Description")
+
+actual = test_card.to_a
+expected = [1, "Test Card", "Card Name", "Some Description"]
+
+if actual == expected
+  puts "CSV card inputs --> new array var PASSED"
+  else
+  puts "CSV card inputs --> new array var FAILED"
+  end
+
+# TESTS FOR TERMINAL APP
+
+# 1. Valid data type view deck
+
+
+
+
+
+

data/software_dev_plan/pseudo_code.txt

@@ -0,0 +1,218 @@
+Prior to code
+- users are required to install the gems required to run the program
+- once installed, ruby run program
+
+including a simple card visual using lines and asterisks
+
+First interaction 
+
+# USE CASE STATEMENT FOR ALL OPTIONS RELATED PROBLEMS, INTEGERS FOR OPTIONS
+# IF/ELSE FOR CONFIRMATION OF ACTIONS **
+
+1. Menu (OPTIONS ARE REPRESENTED BY INTEGERS)
+- Decks
+- Learning Mode --> Current Progress
+
+the above items are list as "integers" for users to select. Once selected, will move into the folder. 
+
+2. Deck - deck's data type is an array consisting of hashes which would be the cards (ARRAY)
+
+# USE CASE STATEMENT
+
+- View current Decks - will show all decks and also allow option 2, 3 and 4 to be actioned here
+- Edit current Decks - will ask what users would like to update (name) 
+- delete Deck **
+- go back to first Menu
+
+3. card (under deck) - this will show all the cards in hashes
+- view card 
+- edit card 
+- delete card **
+- go back to decks
+
+# LOGIC
+
+Classes
+  Parent = Deck
+    - allow deck to be initialized (parameters include "name")
+    - remember to implement attr_accessor/etc whenever applicable
+    - instance variables 
+        - deck name y
+        - count_deck?? maybe only in class var y
+        - count_cards = 0 y
+        - count_tests = 0 y
+        - familiarity rate = 0 y
+    - class variables
+        - count deck = 0 y
+        - familiarity rate (should be different for each deck created) y
+    - methods 
+      - count deck (self) (class?) y
+      - update deck y
+      - create deck y
+      - view deck y
+      - delete deck y
+      - LEARNING MODE - class method to calculate if deck familiarity is under "recap" (familiar) or under "unfamiliar" 
+      - random generator for questions - REVISIT LAST
+      - get familiarity rate y 
+      - get date created y
+      - get date modified y
+      - back to main menu y
+
+  Child = Card
+    - allow card to be initialized (parameters = "card name", "description")
+    - remember to implement attr_accessor/etc whenever applicable
+    - instance variables
+      - card name y
+      - description y
+    
+    - methods 
+      - add card
+      - update card
+      - view card
+      - delete card
+      - back to deck menu
+
+card = array.find { |card| card[:name] == incoming_card_name }
+if card
+  puts "Duplicate detected"
+else 
+  # add to array
+end
+
+Menu 
+  1. Decks
+  2. Learning Mode >> Current Progress
+
+users select from {case statement} 
+  1. View Deck
+  2. Create Deck
+  3. Update Deck
+  4. Delete Deck
+  5. Go back to menu
+
+  note: show decks and cards in visual form (if possible)
+
+  >> Login (not mandatory)
+  
+
+  >> Decks
+
+    >> to process selected deck 
+
+      >> program will asks user to enter the correct name of a deck until the name req is satisfied
+      >>  LOOP  { if "deck name" > deck, else print "deck does not exist, please check name" (write a better error handling message) } LOOP
+
+      >> if successful, then show deck
+
+        >> data to show includes:
+          - name of the deck
+          - familiarity rate 
+          - topic
+          - number of cards
+          - number of completed practices
+          - number of mastered cards
+          - number of unmastered cards
+          - date modified (not mandatory)
+          - date created (not mandatory)
+          
+        >> show all cards (below deck)
+            >> present one card per line (HASH)
+        
+    >> create a deck
+      >> LOOP ask for user input "what name youd like for new deck?" LOOP
+       {if "deck name" already exist in your collection, choose another name"} - REVISIT
+
+    >> update a deck
+      >> program will asks user to enter the correct name of a deck until the name req is satisfied
+      >>  LOOP  { if "deck name" > deck, else print "deck does not exist, please check name" (write a better error handling message) } LOOP
+
+  >> Cards 
+    present users with a menu (case statement)
+      1. view card 
+      2. create card
+      3. edit card
+      4. delete card
+      5. go back to deck
+
+    >> 1 selected
+      LOOP { if "card name" , else print "card does not exist within this deck, please check name" (write a better error handling message) } LOOP
+      >> card details
+        - card name
+        - card description
+
+      >> menu 
+        1. edit
+        2. delete
+        3. go back
+    
+    >> 2 
+      >> LOOP user input "What would you like to name your card?" LOOP {if "card name" already exist within this deck, choose another name"}
+      >> "description of the card?"
+      >> succeed - "card created"
+      >> pause and go back to previous menu
+    
+    >> 3
+      >> LOOP "which card would you like to update?" LOOP 
+      { if "card name" , else print "card does not exist within this deck, please check name"
+
+      >> current card details:
+        - card name
+        - card description
+
+      >> "what would you like to change? 
+      
+        1. name
+        2. description
+      
+      >> case statement "what would be the new name/description?"
+        {if "card name" already exist within this deck, choose another name"}
+
+      >> if new card name == name > error 'same name' or duplicate in the deck >> PROBLEM
+        >> else, succeed - "name/description changed"
+
+      >> pause and go back to previous menu
+
+   >> 4
+    >> list of cards (hashes)
+      >> "which card would you like to delete? 
+        >> confirmation > do you really want to delete {card}? 
+          Yes/No
+      >> succeed - "card deleted"
+
+  >> 5 
+    >> go back to previous menu (deck)
+
+  
+
+>> Learning Mode 
+
+"Cards are randomly shuffled" 
+
+  >> options in case statement:
+    1. Recap
+    2. Unfamiliar decks
+    3. New decks
+    
+  >> 1
+    >> familiarity threshold == 100%? - set in class?
+    >> show decks that == threshold
+    >> Q & A: 
+      >> get from 100% familiarity deck, if no deck found, use default.
+      >> answers --> generated by random generator using data from within the deck
+      >> BONUS --> generate answers which are similar to each other
+  >> 2
+    >> familiarity threshold < 100%? 
+    >> Q & A:
+      >> from unfamiliar Decks
+      >> answers --> generated by random generator using data from within the deck
+      >> BONUS --> generate answers which are similar to each other
+
+  >> 3 
+    >> show new decks (recently created)
+    >> define recent --> within the last 30 days? set in class?
+
+  
+  >> Current Progress
+    >> shows progress for all decks
+      >> in hash, with percentage 
+      >> BONUS - show comforting/inspiring messages in deck (if applicable)

data/sturdy_cards.gemspec

@@ -0,0 +1,52 @@
+require_relative 'lib/noname/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "Flash_Cards_Sturdy_Cards_App"
+  spec.version       = Noname::VERSION
+  spec.authors       = ["Guan Kuan Lee"]
+  spec.email         = ["angusl.zanshin@gmail.com"]
+
+  spec.summary       = "something"
+  spec.description   = "something longer to write"
+  spec.homepage      = "https://github.com/codebender16?tab=repositories"
+  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
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "colorize", "~> 0.8.1"
+  spec.add_dependency "tty-font', '~> 0.5.0"
+end
+
+#this will be shown on gem page
+
+# to update gem in github
+# git status 
+# git add .
+# git commit -m <URL> 
+# git remote add origin <URL>
+# git remote -v
+# git push -u origin master
+
+# curl -u <gkuanlee16> https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials; chmod 0600 ~/.gem/credentials
+# gem signin
+
+# building a gem 
+# gem build noname.gemspec
+
+# udpating the gem
+# rake build --> another version of gem will be created --> move the version file to "pkg"
+# pushing the update
+# gem push pkg/noname-version.gem

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: Flash_Cards_Sturdy_Cards_App
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Guan Kuan Lee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: tty-font', '~> 0.5.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: something longer to write
+email:
+- angusl.zanshin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/.DS_Store
+- lib/classes/Card.rb
+- lib/classes/Deck.rb
+- lib/database/cards.csv
+- lib/database/decks.csv
+- lib/database/recap.csv
+- lib/database/recent.csv
+- lib/database/unfamiliar.csv
+- lib/noname/README.md
+- lib/noname/version.rb
+- lib/source_code.rb
+- lib/tests.rb
+- resources/UML Sturdy Cards.png
+- software_dev_plan/pseudo_code.txt
+- sturdy_cards.gemspec
+homepage: https://github.com/codebender16?tab=repositories
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: something
+test_files: []