ashcards 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 46a9e085e29bec6bc7859755d89a2c26f1d9d3374e9a9f32dc384cc0ff7e6035
+  data.tar.gz: 475eb874cbfd42e4d42638d47516178c442c72356cb52f608ab087c58465cc20
+SHA512:
+  metadata.gz: ae0622b354dcb977ac2e6208b2a2b5ab58b1a510fefcdf95136dce38766953c5c53e6de5e326e801058870fc2f359dacd9d3b0f5669958a0095cf64bc9c6d1d4
+  data.tar.gz: 124a6dfef7cdc009814363dfdcbab95b5638e4033d177ce22b1bcdf29823e59fa616fe80388994a9fbf074f4c30728ceec57b87c3755dfa8f836b6fb38d07eb9

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-05-27
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Marigold
+
+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,39 @@
+# Ashcards
+
+TODO: Delete this and the text below, and describe your gem
+
+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/ashcards`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 the created tag, 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]/ashcards.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/ashcards/card.rb

@@ -0,0 +1,32 @@
+require 'date'
+
+class Card
+  attr_reader :word, :meaning, :date
+
+  def initialize(id, word, meaning, date, ease)
+    @id = id
+    @word = word
+    @meaning = meaning
+    @date = Date.parse(date)
+    @ease = ease.to_i
+  end
+
+  def get_date
+    @date
+  end
+
+  def correct_ease
+    @ease = (1.5 * @ease).floor + 1
+    @date = Date.today + @ease
+  end
+
+  def incorrect_ease
+    @ease = 0
+    @date = Date.today
+  end
+
+  def to_s
+    "#{@word} | #{@meaning} | #{@date} | #{@ease}\n"
+  end
+end
+

data/lib/ashcards/collection.rb

@@ -0,0 +1,80 @@
+require 'date'
+require_relative 'card.rb'
+
+class Collection
+  attr_reader :name, :cards, :dues
+
+  def initialize(name, cards=[], dues=[])
+    @name = name
+    @cards = cards
+    @dues = dues
+  end
+
+  # add card to the cards list
+  def add_card(card)
+    @cards << card
+  end
+
+  # adds a due card to the dues list
+  def add_due(due)
+    @dues << due
+  end
+
+  def remove_due(due)
+    @dues.delete(due)
+  end
+
+  def delay_due(due)
+    @dues.insert(-1, @dues.delete(due))
+  end
+
+  def search_date
+    matches = []
+    @cards.each do |card|
+      if (card.get_date <=> Date.today) == -1 || (card.get_date <=> Date.today) == 0
+        matches << card
+      end
+    end
+    return matches
+  end
+
+  # gets all cards in collection file
+  def find_cards
+    File.foreach("./collections/" + @name + ".data").with_index do |line, idx|
+      # if line is NOT empty, then add card
+      unless line.chomp.empty?
+        card_data = line.split("|")
+        card = Card.new(idx, card_data[0].chomp.strip, card_data[1].chomp.strip, card_data[2].chomp.strip, card_data[3].chomp.strip)
+        self.add_card card
+      end
+    end
+  end
+
+  def find_dues
+    @dues = self.search_date
+  end
+
+  def write
+    File.write("./collections/" + @name + ".data", "")
+    @cards.each do |card|
+      File.write("./collections/" + @name + ".data", card.to_s, mode: "a")
+    end
+  end
+
+  def to_s
+    "#{@name}: \n#{@cards}\n#{@dues}"
+  end
+end
+
+if __FILE__ == $0
+  filenames = Dir.entries("./collections/")
+  filenames.each do |filename|
+    if filename.end_with? ".data"
+      collection = Collection.new filename[..-6]
+      collection.find_cards
+      collection.find_dues
+      puts collection
+    end
+  end
+end
+

data/lib/ashcards/collections.rb

@@ -0,0 +1,19 @@
+require_relative 'collection.rb'
+
+class Collections
+  def initialize(collections=[])
+    @collections = collections
+  end
+
+  def find_collections
+    filenames = Dir.entries("./collections/")
+    filenames.each do |filename|
+      if filename.end_with? ".data"
+        collection = Collection.new(filename[..-6])
+        @collections << collection
+      end
+    end
+  end
+
+  def get_collections = @collections
+end

data/lib/ashcards/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ashcards
+  VERSION = "0.1.0"
+end

data/lib/ashcards/window_modified.rb

@@ -0,0 +1,269 @@
+require 'curses'
+
+include Curses
+
+class Window_Extra < Window
+  def draw_border
+    width = self.maxx
+    height = self.maxy
+
+    self.addstr "┌" + "─" * (width - 2) + "┐"
+    (height-2).times do |y|
+      self.setpos(y+1, 0)
+      self.addstr "│"
+      self.setpos(y+1, width-1)
+      self.addstr "│"
+    end
+    self.addstr "└" + "─" * (width - 2) + "┘"
+  end
+
+  def write_collection(collection, row)
+    self.attrset A_NORMAL
+    self.setpos(row, 3)
+    self.addstr collection.name
+    self.setpos(row, 31)
+    self.addstr collection.cards.length.to_s
+    self.setpos(row, 41)
+    self.addstr collection.dues.length.to_s
+  end
+
+  def become_collection_selection(collections)
+    init_pair(2, COLOR_BLUE, COLOR_BLACK)
+
+    self.draw_border
+    self.attrset A_BOLD
+    self.color_set 2
+    self.setpos(1,2)
+    self.addstr "Name"
+    self.setpos(1,31)
+    self.addstr "Total"
+    self.setpos(1,41)
+    self.addstr "Due"
+
+    collections.get_collections.each_with_index do |collection, idx|
+      self.write_collection(collection, idx + 2)
+    end
+
+    line_selected = 2
+    self.setpos(line_selected,2)
+    self.addstr "+"
+  end
+
+  def init_collection_selection
+    subwindow = self.subwin(self.maxy-2, 52, 1, (self.maxx-52)/2)
+    subwindow.draw_border
+
+    return subwindow
+  end
+end
+
+class Ashcards_Window < Window_Extra
+  attr_accessor :collections
+
+  def measure_size
+    @width = Terminal.size[:width]
+    @height = Terminal.size[:height]
+    @line_selected = 0
+  end
+
+  def draw_select
+    measure_size
+    self.resize(@height - 2, 52)
+    self.move(1, (@width - 52) / 2)
+    self.draw_border
+
+    init_pair(1, 15, 0)
+    init_pair(2, COLOR_BLUE, COLOR_BLACK)
+    init_pair(3, 0, 15)
+
+    self.attrset A_BOLD
+    self.color_set 2
+    self.setpos(1,2)
+    self.addstr "Name"
+    self.setpos(1,31)
+    self.addstr "Total"
+    self.setpos(1,41)
+    self.addstr "Due"
+
+    self.attrset A_NORMAL
+    self.color_set 1
+    self.setpos(self.maxy - 1, 2)
+    self.addstr "┤Q to quit├"
+    self.setpos(self.maxy - 1, 14)
+    self.addstr "┤↑ to up├"
+    self.setpos(self.maxy - 1, 24)
+    self.addstr "┤↓ to down├"
+
+    @collections.get_collections.each_with_index do |collection, idx|
+      self.write_collection(collection, idx + 2)
+    end
+
+    self.setpos(2, 2)
+    self.addstr "+"
+    @line_selected = 2
+  end
+
+  def draw_test
+    measure_size
+    self.resize(9, 29)
+    self.attrset A_NORMAL
+    self.draw_border
+    self.move((@height - 9) / 2, (@width - 29) / 2)
+
+    self.attrset A_BOLD
+    self.setpos(9/2-1, (29-2 - @word.length)/2+1)
+    self.addstr @word
+    self.attrset A_DIM
+    self.setpos(9/2+1, 29/2)
+    self.addstr "?"
+    self.attrset A_NORMAL
+  end
+
+  def quit
+    confirm_window = Window_Extra.new(7, 40, (@height-7)/2, (@width-40)/2)
+    confirm_window.draw_border
+    message = "Are you sure you want to quit?"
+    confirm_window.setpos(2, (40-message.length)/2)
+    confirm_window.addstr message
+    confirm_window.color_set 3
+    confirm_window.setpos(4, 40/2+10-4)
+    confirm_window.addstr ' No[ANY] '
+    confirm_window.setpos(4, 40/2-10-4)
+    confirm_window.addstr ' Yes[Q] '
+    case confirm_window.getch.to_s
+    when 'Q', 'q'
+      exit
+    else
+      confirm_window.clear
+      confirm_window.refresh
+    end
+  end
+
+
+  def run
+    measure_size
+    @line_selected = 2
+    select
+  end
+  
+  def select
+    draw_select
+    loop do
+      key = self.getch
+      case key.to_s
+      when '27'
+        case self.getch.to_s
+        when '['
+          case self.getch.to_s
+          when 'B'
+            unless @line_selected+1 > collections.get_collections.length+1
+              self.setpos(@line_selected, 2)
+              self.addstr " "
+              @line_selected += 1
+            end
+          when 'A'
+            unless @line_selected-1 < 2
+              self.setpos(@line_selected, 2)
+              self.addstr " "
+              @line_selected -= 1
+            end
+          end
+        end
+      when 'Q', 'q'
+        quit
+      when ' ', '10'
+        test
+        self.clear
+        self.refresh
+        draw_select
+      when '410'
+        self.clear
+        self.refresh
+        draw_select
+      else
+        self.addstr key.to_s
+      end
+      self.setpos(@line_selected,2)
+      self.addstr "+"
+      self.refresh
+    end
+  end
+
+  def test
+    collection = @collections.get_collections[@line_selected - 2]
+    while collection.dues.length > 0
+      due = collection.dues[0]
+      @word = due.word
+      @meaning = due.meaning
+
+      self.clear
+      self.refresh
+      draw_test
+
+      self.attrset A_BOLD
+      self.setpos(9/2-1, (29-2 - @word.length)/2+1)
+      self.addstr @word
+      self.attrset A_DIM
+      self.setpos(9/2+1, 29/2)
+      self.addstr "?"
+      loop do
+        c = self.getch
+        case c.to_s
+        when 'Q', 'q'
+          collection.write
+          quit
+          self.clear
+          self.refresh
+          draw_test
+        when ' ', '10'
+          self.setpos(9/2+1, (29-2 - @meaning.length)/2+1)
+          self.addstr @meaning
+          case self.getch.to_s
+          when ' ', '10'
+            due.correct_ease
+            collection.remove_due(due)
+            break
+          when '2'
+            due.incorrect_ease
+            collection.delay_due(due)
+            break
+          when '27'
+            case self.getch.to_s
+            when '['
+              case self.getch.to_s
+              when 'D'
+                collection.write
+                return
+              end
+            end
+          else
+          end
+        when 'H'
+          self.attrset A_NORMAL
+          self.setpos(9/2+1, 1)
+          self.addstr " "*(29-2)
+
+          self.attrset A_DIM
+          self.setpos(9/2+1, 29/2)
+          self.addstr "?"
+        when '410'
+          draw_test
+        when '27'
+          case self.getch.to_s
+          when '['
+            case self.getch.to_s
+            when 'D'
+              collection.write
+              return
+            end
+          end
+        else
+          self.addstr c.to_s
+        end
+        self.refresh
+      end
+    end
+    collection.write
+  end
+end
+

data/lib/ashcards.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require_relative "ashcards/version"
+require 'curses'
+require 'terminal-size'
+require_relative 'ashcards/collections.rb'
+require_relative 'ashcards/window_modified.rb'
+
+include Curses
+
+module Ashcards
+  class Error < StandardError; end
+  collections = Collections.new
+  collections.find_collections
+  collections.get_collections.each do |collection|
+    collection.find_cards
+    collection.find_dues
+  end
+
+  init_screen
+  start_color
+  curs_set(0)
+  noecho
+  init_pair(1, 1, 0)
+  init_pair(2, COLOR_BLUE, COLOR_BLACK)
+  init_pair(3, 0, 15)
+  crmode
+
+  begin
+    win = Ashcards_Window.new(0,0,0,0)
+    win.collections = collections
+    win.run
+
+    subwindow = win.init_collection_selection
+    subwindow.become_collection_selection(collections)
+
+    line_selected = 2
+
+    loop do
+      key = subwindow.getch
+      case key.to_s
+      when '27'
+        case subwindow.getch.to_s
+        when '['
+          case subwindow.getch.to_s
+          when 'B'
+            unless line_selected+1 > collections.get_collections.length+1
+              subwindow.setpos(line_selected, 2)
+              subwindow.addstr " "
+              line_selected += 1
+            end
+          when 'A'
+            unless line_selected-1 < 2
+              subwindow.setpos(line_selected, 2)
+              subwindow.addstr " "
+              line_selected -= 1
+            end
+          end
+        end
+      when 'Q', 'q'
+        confirm_window = win.subwin(7, 40, (win.maxy-7)/2, (win.maxx-40)/2)
+        confirm_window.draw_border
+        message = "Are you sure you want to quit?"
+        confirm_window.setpos(2, (40-message.length)/2)
+        confirm_window.addstr message
+        confirm_window.color_set 3
+        confirm_window.setpos(4, 40/2+10-4)
+        confirm_window.addstr ' No[ANY] '
+        confirm_window.setpos(4, 40/2-10-4)
+        confirm_window.addstr ' Yes[Q] '
+        case confirm_window.getch.to_s
+        when 'Q', 'q', '10'
+          exit
+        else
+          confirm_window.clear
+          confirm_window.refresh
+        end
+      when '10'
+      when '410'
+        win.resize(Terminal.size[:height], Terminal.size[:width])
+        subwindow.close
+        subwindow.refresh
+        subwindow = win.init_collection_selection
+        subwindow.become_collection_selection(collections)
+      else
+        subwindow.addstr key.to_s
+      end
+      subwindow.setpos(line_selected,2)
+      subwindow.addstr "+"
+      subwindow.refresh
+    end
+  ensure
+  end
+end

data/sig/ashcards.rbs

@@ -0,0 +1,4 @@
+module Ashcards
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: ashcards
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- marigold
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: terminal-size
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: curses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+description: Application that lets you study flashcards on the terminal, Anki-style.
+email:
+- marigoldyyellow@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ashcards.rb
+- lib/ashcards/card.rb
+- lib/ashcards/collection.rb
+- lib/ashcards/collections.rb
+- lib/ashcards/version.rb
+- lib/ashcards/window_modified.rb
+- sig/ashcards.rbs
+homepage: https://rubygems.org/gems/ashcards
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/ashcards
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.4
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Flashcards for you terminal
+test_files: []