jpalardy-forgetful 0.0.5

data/README

@@ -0,0 +1,51 @@
+
+A minimal command-line app implementing the SuperMemo 2 algorithm.
+
+The SuperMemo algorithm is designed to refresh your memory at
+intervals based on how well you remembered something.
+
+Put question-answer pairs in a file. Everyday, feed the file to forgetful and
+it will quiz you on what you need to remember today. Based on your
+self-evaluation, forgetful will reschedule at an appropriate time in the
+future.
+
+Usage:
+
+  forgetful filename.csv [more filenames]
+
+Format:
+
+A CSV file to contain your questions and answers, in the following format:
+
+  question,answer
+
+Flow:
+
+  1. shows question (press enter)
+  2. shows answer
+  3. asks for self-evaluation (type number, and enter)
+  4. repeats for all questions
+  5. repeats for questions that scored less than 4
+
+Self-evaluation:
+
+  5 - perfect response
+  4 - correct response after a hesitation
+  3 - correct response recalled with serious difficulty
+  2 - incorrect response; where the correct one seemed easy to recall
+  1 - incorrect response; the correct one remembered
+  0 - complete blackout.
+
+WARNING:
+
+Statistics are written back to the input file. This is a feature. Put your CSV
+files under source control to keep a history.
+
+Enjoy!
+
+############################################################
+
+The article that sparked my interest: http://www.wired.com/medtech/health/magazine/16-05/ff_wozniak
+
+The algorithm itself: http://www.supermemo.com/english/ol/sm2.htm
+

data/bin/forgetful

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+$VERBOSE = true
+
+############################################################
+
+require "#{File.dirname(__FILE__)}/../lib/forgetful"
+
+############################################################
+
+def ask(prompt, validate_re=//)
+  while true
+    print prompt
+    answer = readline.chomp
+
+    return answer.to_i if answer =~ validate_re
+  end
+end
+
+#-------------------------------------------------
+
+def ask_grade(prompt)
+  ask(prompt, /\A[0-5]\Z/)
+end
+
+#-------------------------------------------------
+
+def ask_about(reminder, i, n)
+  ask("#{i}/#{n}. Q: #{reminder.question}")
+  puts "     A: #{reminder.answer}"
+  q = ask_grade("     ? ")
+  puts
+  return q
+end
+
+#-------------------------------------------------
+
+def quiz(reminders)
+  i = 0
+  reminders.collect do |reminder|
+    i += 1
+    reminder.next(ask_about(reminder, i, reminders.size))
+  end
+end
+
+############################################################
+
+def process_file(filename)
+  #--------------------- quiz ----------------------
+  reminders = Reminder.load_csv(filename)
+
+  dues, not_dues = reminders.partition {|reminder| reminder.execute_on <= Date.today}
+
+  puts "### QUIZ: #{filename}"
+  gradeds = quiz(dues.sort_by { rand })
+
+  Reminder.save_csv(filename, (gradeds + not_dues).sort)
+
+  #-------------------- review ---------------------
+  faileds = gradeds.select {|reminder| reminder.review? }
+  until faileds.empty?
+    puts "# REVIEW: #{filename}"
+    gradeds = quiz(faileds.sort_by { rand }) # review
+    faileds = gradeds.select {|reminder| reminder.review? }
+  end
+end
+
+############################################################
+
+filenames = ARGV.dup
+ARGV.clear
+
+filenames.each do |filename|
+  process_file filename
+end
+

data/examples/katakana_romanji.csv

@@ -0,0 +1,71 @@
+ア,a
+バ,ba
+ベ,be
+ビ,bi
+ボ,bo
+ブ,bu
+チ,chi
+ダ,da
+デ,de
+ヂ,di (ji)
+ド,do
+ヅ,du (zu)
+エ,e
+フ,fu
+ガ,ga
+ゲ,ge
+ギ,gi
+ゴ,go
+グ,gu
+ハ,ha
+ヘ,he
+ヒ,hi
+ホ,ho
+イ,i
+ジ,ji
+カ,ka
+ケ,ke
+キ,ki
+コ,ko
+ク,ku
+マ,ma
+メ,me
+ミ,mi
+モ,mo
+ム,mu
+ン,n
+ナ,na
+ネ,ne
+ニ,ni
+ノ,no
+ヌ,nu
+オ,o
+パ,pa
+ペ,pe
+ピ,pi
+ポ,po
+プ,pu
+ラ,ra
+レ,re
+リ,ri
+ロ,ro
+ル,ru
+サ,sa
+セ,se
+シ,shi
+ソ,so
+ス,su
+タ,ta
+テ,te
+ト,to
+ツ,tsu
+ウ,u
+ワ,wa
+ヲ,wo
+ヤ,ya
+ヨ,yo
+ユ,yu
+ザ,za
+ゼ,ze
+ゾ,zo
+ズ,zu

data/examples/romanji_katakana.csv

@@ -0,0 +1,71 @@
+a,ア
+ba,バ
+be,ベ
+bi,ビ
+bo,ボ
+bu,ブ
+chi,チ
+da,ダ
+de,デ
+di (ji),ヂ
+do,ド
+du (zu),ヅ
+e,エ
+fu,フ
+ga,ガ
+ge,ゲ
+gi,ギ
+go,ゴ
+gu,グ
+ha,ハ
+he,ヘ
+hi,ヒ
+ho,ホ
+i,イ
+ji,ジ
+ka,カ
+ke,ケ
+ki,キ
+ko,コ
+ku,ク
+ma,マ
+me,メ
+mi,ミ
+mo,モ
+mu,ム
+na,ナ
+ne,ネ
+ni,ニ
+no,ノ
+nu,ヌ
+n,ン
+o,オ
+pa,パ
+pe,ペ
+pi,ピ
+po,ポ
+pu,プ
+ra,ラ
+re,レ
+ri,リ
+ro,ロ
+ru,ル
+sa,サ
+se,セ
+shi,シ
+so,ソ
+su,ス
+ta,タ
+te,テ
+to,ト
+tsu,ツ
+u,ウ
+wa,ワ
+wo,ヲ
+ya,ヤ
+yo,ヨ
+yu,ユ
+za,ザ
+ze,ゼ
+zo,ゾ
+zu,ズ

data/forgetful.gemspec

@@ -0,0 +1,34 @@
+Gem::Specification.new do |s|
+  s.name = %q{forgetful}
+  s.version = "0.0.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jonathan Palardy"]
+  s.date = %q{2008-11-12}
+  s.default_executable = %q{forgetful}
+  s.description = %q{A minimal command-line implementation of the SuperMemo 2 algorithm.}
+  s.email = %q{jonathan.palardy@gmail.com}
+  s.executables = ["forgetful"]
+  s.extra_rdoc_files = ["bin/forgetful", "lib/csv_ext/reminder.rb", "lib/forgetful.rb", "lib/reminder.rb", "README"]
+  s.files = ["bin/forgetful", "examples/katakana_romanji.csv", "examples/romanji_katakana.csv", "forgetful.gemspec", "lib/csv_ext/reminder.rb", "lib/forgetful.rb", "lib/reminder.rb", "Manifest", "README", "test/test_forgetful.rb"]
+  s.homepage = %q{http://github.com/jpalardy/forgetful}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Forgetful", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{forgetful}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{A minimal command-line implementation of the SuperMemo 2 algorithm.}
+  s.test_files = ["test/test_forgetful.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+      s.add_runtime_dependency(%q<fastercsv>, [">= 0", "= 1.4"])
+    else
+      s.add_dependency(%q<fastercsv>, [">= 0", "= 1.4"])
+    end
+  else
+    s.add_dependency(%q<fastercsv>, [">= 0", "= 1.4"])
+  end
+end

data/lib/csv_ext/reminder.rb

@@ -0,0 +1,25 @@
+
+require 'rubygems'
+require 'fastercsv'
+
+class Reminder
+
+  def self.load_csv(filename)
+    identity = lambda {|x| x}
+
+    #                                        question  answer    next   ef      i         interval  q
+    FasterCSV.read(filename, :converters => [identity, identity, :date, :float, :integer, :integer, :integer]).collect do |list|
+      self.new(*list)
+    end
+  end
+
+  def self.save_csv(filename, reminders)
+    FasterCSV.open(filename, "w") do |csv|
+      reminders.each do |reminder|
+        csv << reminder.to_a
+      end
+    end
+  end
+
+end
+

data/lib/forgetful.rb

@@ -0,0 +1,7 @@
+class Forgetful
+  VERSION = '0.0.1'
+end
+
+require "#{File.dirname(__FILE__)}/reminder"
+require "#{File.dirname(__FILE__)}/csv_ext/reminder"
+

data/lib/reminder.rb

@@ -0,0 +1,45 @@
+
+class Reminder
+  attr_reader :question, :answer, :execute_on, :ef, :i, :interval, :q
+
+  def initialize(question, answer, execute_on=Date.today, ef=2.5, i=0, interval=0, q=nil)
+    @question = question
+    @answer = answer
+    @execute_on = execute_on
+    @ef = ef
+    @i = i
+    @interval = interval
+    @q = q
+  end
+
+  def next(q)
+    if q < 3
+      i = 0
+      interval = 1
+    else
+      i = self.i + 1
+      interval = {0 => 1, 1 => 6}.fetch(self.i, self.interval * self.ef).round
+    end
+
+    execute_on = Date.today + interval
+
+    ef = self.ef + (0.1 - (5-q) * (0.08 + (5-q) * 0.02))
+    ef = [ef, 1.3].max
+
+    Reminder.new(self.question, self.answer, execute_on, ef, i, interval, q)
+  end
+
+  def to_a
+    [self.question, self.answer, self.execute_on, self.ef, self.i, self.interval, self.q]
+  end
+
+  def <=>(other)
+    self.to_a <=> other.to_a
+  end
+
+  def review?
+    q < 4
+  end
+
+end
+

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: jpalardy-forgetful
+version: !ruby/object:Gem::Version 
+  version: 0.0.5
+platform: ruby
+authors: 
+- Jonathan Palardy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-12 00:00:00 -08:00
+default_executable: forgetful
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fastercsv
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: "1.4"
+    version: 
+description: A minimal command-line implementation of the SuperMemo 2 algorithm.
+email: jonathan.palardy@gmail.com
+executables: 
+- forgetful
+extensions: []
+
+extra_rdoc_files: 
+- bin/forgetful
+- lib/csv_ext/reminder.rb
+- lib/forgetful.rb
+- lib/reminder.rb
+- README
+files: 
+- bin/forgetful
+- examples/katakana_romanji.csv
+- examples/romanji_katakana.csv
+- forgetful.gemspec
+- lib/csv_ext/reminder.rb
+- lib/forgetful.rb
+- lib/reminder.rb
+- Manifest
+- README
+- test/test_forgetful.rb
+has_rdoc: false
+homepage: http://github.com/jpalardy/forgetful
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Forgetful
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: forgetful
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A minimal command-line implementation of the SuperMemo 2 algorithm.
+test_files: 
+- test/test_forgetful.rb