Flash_Cards_Sturdy_Cards_App 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a5c9004967345d130c3deede895d6907d4028fa404135c0032d16054d0818a8
+  data.tar.gz: 3a8d824e15692c82f41040d7bdc57c0ba6c16fbdcd607ae1b17062464753c51d
+SHA512:
+  metadata.gz: c104285471e9583565a6fa6fc0a20772d63e8debf5f129247948aa4562f8f9b971dd349789bae611d56bd4c3d93036d2cfca8fdc2da7c18ce4e85651b6368869
+  data.tar.gz: ec5ab1da8ab494cefdd7f9354c75d86f9b79d9f970e8988d971ac1c04f0f3a300cd8eea28d7fa05cf36d0da09474a80ebce587a247c851b0827d790a704de763

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at angusl.zanshin@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 CoderAcademy-MEL
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,134 @@
+# STURDY CARDS
+
+- [STURDY CARDS](#sturdy-cards)
+  - [Installation](#installation)
+  - [About](#about)
+      - [Research and Problem statement](#research-and-problem-statement)
+  - [Features](#features)
+  - [Next Steps](#next-steps)
+  - [Tutorial](#tutorial)
+  - [UML Diagram](#uml-diagram)
+  - [Project Timeline](#project-timeline)
+  - [Github](#github)
+  - [Development](#development)
+  - [Contributing](#contributing)
+  - [License](#license)
+  - [Code of Conduct](#code-of-conduct)
+- [noname](#noname)
+
+
+## Installation
+
+```ruby
+gem 'noname'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install noname
+
+## About
+
+
+Sturdy cards is flash cards with spaced repetition learning feature. It is created for anyone who wants to reinforce their learning through spaced repetition.
+
+The concept is simple.
+
+1. You will be given a few default decks to get a feel of how the application works. 
+2. You can create custom decks and cards within the decks. 
+3. You can export decks as csv files to share information with friends/families, or create new decks by importing csv files
+4. Once you are all set up, you can start learning. There are a few different modes available for you so you will never get bored of being tested by the same method throughout the process.
+5. Lastly, sit back and be sturdy. Your knowledge will only ever going to get sturdier.
+
+
+
+* There is a [tutorial](##Tutorial) section below if you need further instructions on how to use the application.
+* Feel free to read through the [feature section](##Features) to understand how our feature works.
+
+
+
+#### Research and Problem statement 
+
+From my learning experience and my observation with how humans learn, we humans learn and retain better through continuous repetition. As quoted from Tony Robbins,
+
+> Repetitions is a mother of skill
+> - Tony Robbins
+
+**"Many students find it difficult to memorise information even though the information has been processed and understood. More often than not, subject contents delivered in a traditional method, do not provide students with the time and reinforcement tool to excel in mastering those content."**
+
+With Sturdy Cards, you can be rest assured your learning will be taken care of. By using spaced repetition and several distinctive modes available to choose from, we can help you learn and retain information more effectively. For those who are already at an advanced level in a subject, your subject expertise can be further reinforced. 
+
+## Features
+
+|   Features    |              Functions                                 |        Released Date                     |
+|:----------------- | :--------------------------------------------------------: | :---------------------------------: |
+|1. Decks | Allows deck viewing, creation, updating and deletion | 14-March-2020 |
+|2. Cards | Allows card viewing, creation, updating and deletion |         14-March-2020 |
+|3. Learning Mode | Users are given a few different modes to learn |         14-March-2020 - Present |
+
+## Next Steps
+
+1. More learning modes - TBA
+2. Learning Progress - implement a tracking feature every time the users attempt the learning mode
+3. Export/Import of csv files as decks and cards
+4. Notifications - daily question auto-prompt
+5. Community and Friends - allow information to be published publicly in the app and follow friends
+6. Ranking system
+7. Competitions
+
+## Tutorial
+
+The app runs on terminal command-line. 
+
+CSV files are used to keep the data created/altered from the command-line.
+
+Notes:
+  * Most deck search functionality uses id unless stated otherwise by the program. 
+  * Card search functionality uses card_name
+  * Errors like duplicates, names and non-existent data are captured
+
+The first menu you will encounter is the *Main Menu*
+* Select one of the options (select 1 as Learning Mode is in progress)
+* The next stop is *Deck Menu*. 
+  * Select one of the options (View, Create, Update and etc) 
+  *  In View Deck, you will be asked to select a deck id. (The program will catch the error if id does not exist and asks for your input again)
+  *  In Create Deck, you will be asked *name* and *topic* of the deck you want to create (If name already exists, you will need to enter another name)
+  *  In Update Deck, the information presented is the same as View Deck. Once a deck is selected for update, it will update the csv file.
+  *  In Delete Deck, select a deck to be removed (csv will update). If deck does not exist, it will prompt you to enter a valid id.
+
+
+## UML Diagram 
+
+![UML Diagram](./resources/UML Sturdy Cards.png)
+
+## Project Timeline 
+
+[Sturdy Cards - Trello](https://trello.com/b/crD1QQab/sturdycards-terminal-app)
+
+## Github 
+
+[codebender16-git-hub](https://github.com/codebender16/noname)
+
+## 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.
+
+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]/noname. 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]/noname/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Noname project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/noname/blob/master/CODE_OF_CONDUCT.md).
+# noname

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "noname"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/classes/Card.rb

@@ -0,0 +1,23 @@
+# CARD IS A CHILD CLASS
+require_relative "Deck"
+
+class Card < Deck
+  attr_accessor :card_id, :deck, :card_name, :description
+
+  def initialize(card_id, deck, card_name, description)
+    @card_id = card_id
+    @deck = deck
+    @card_name = card_name
+    @description = description
+    # Deck.add_card(deck)
+  end 
+
+  def to_a
+    [@card_id, @deck, @card_name, @description] 
+  end
+
+end
+    
+
+# ruby = Deck.new(nil, "ruby deck", "ruby")
+# ruby_card_one = Card.new("file handling", "something to do with files", ruby)

data/lib/classes/Deck.rb

@@ -0,0 +1,71 @@
+# require_relative "Card"
+# DECK IS A PARENT CLASS
+
+class Deck
+
+  attr_reader :familiarity_rate, :test_counts, :id, :date_created
+  attr_accessor :date_modified, :topic, :deck_name, :card_counts
+
+  @@deck_counts = 0
+
+  def initialize(id, deck_name, topic)
+    @id = id
+    @deck_name = deck_name
+    @date_created = Time.new.to_s[0, 10]  
+    @date_modified = @date_created
+    @familiarity_rate = 0
+    @card_counts = 0
+    @test_counts = 0
+    @familiar_card_counts = 0
+    @topic = topic
+  end
+
+  # def calculate_familiarity_rate # divide {familiar_card_counts} by {card_counts}
+  #   @familiarity_rate = familiar_card_counts / card_counts
+  # end
+
+  def to_a
+    [@id, @deck_name, @topic]
+  end
+
+# INCREMENTING COUNTS FOR CLASS VAR AND INSTANCE VAR
+
+  # def self.add_card_to_count # add everytime a card is created from Card class 
+  #   card_counts += 1
+  # end
+
+  # def add_card(deck)
+  #   self.class.add_card_to_count
+  # end
+
+  class << self
+    attr_accessor :deck_counts, :card_counts
+
+    def add_deck_to_count
+      @@deck_counts += 1
+    end
+
+    def add_test_to_count # add everytime a practice is attempted
+      @test_counts += 1
+    end
+
+    def add_familiar_card_to_count
+      @familiar_card_counts += 1
+    end
+
+  end
+
+  def view_deck(deck_name) 
+    if deck_name == @deck_name
+    end
+  end
+
+  def del_deck(deck_name)
+
+  end
+
+  def back_to_main_menu
+    # go back to main menu
+  end
+
+end

data/lib/database/cards.csv

@@ -0,0 +1,19 @@
+card id,deck,card name,description
+1,trying,try harder,soldier through1,
+2,ruby arrays,"[a, b, c] + [d, e]","= [a, b, c, d, e]"
+3,ruby arrays,creating an array ,"array.new, arr = []"
+4,ruby arrays,accessing elements, arr[index], arr.at(index)
+5,ruby arrays,access first element, arr.first
+6,ruby arrays,access last element, arr.last
+7,ruby arrays,arr.drop(n), return elements after n
+8,ruby arrays,arr.length, counts number of elements in an array
+9,ruby arrays,arr.include?, return TRUE if exist in an array
+10,ruby arrays,arr.unshift, add new item to beginning
+11,ruby arrays,arr.shift, retrieve and remove first element
+12,ruby arrays,arr.pop, remove last element
+13,ruby arrays,interating over an array, arr.each do |item|
+14,ruby arrays,Array.new(4) {Hash.new}, => [{}, {}, {}, {}]
+15,ruby arrays,what is slicing?, return a specified range of elements
+16,ruby arrays,arr.empty?, return FALSE is it is not empty
+17,ruby arrays,remove nil?, arr.compact
+18,ruby arrays, arr.uniq, remove duplicate elements from an array

data/lib/database/decks.csv

@@ -0,0 +1,11 @@
+id,deck name,topic
+1,ruby file handling,files
+2,ruby arrays,arrays
+3,fdsgf,gfdgff
+4,python,python arrays
+5,fate series,fate stay night
+6,naruto,flame jutsu
+7,testing,manual testing
+8,second test,2nd time
+9,trying,maybe not
+10,c++,Object oriented