forgetful 0.3.0 → 0.3.3

data/Rakefile

@@ -10,7 +10,7 @@ begin
     gem.email = "jonathan.palardy@gmail.com"
     gem.homepage = "http://github.com/jpalardy/forgetful"
     gem.authors = ["Jonathan Palardy"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "rspec", "= 1.2.9"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.3

data/bin/forgetful

@@ -1,55 +1,58 @@
+#!/usr/bin/env ruby
 
 require "forgetful"
 require "forgetful/cli"
-require 'getoptlong'
+require 'optparse'
 
 #-------------------------------------------------
 
-def usage(status=0)
-  $stderr.puts <<-END
-Usage: #{File.basename($0)} [options] filename(s)
+def parse(args)
+  options = { :filenames => [],
+              :verbose   => false,
+              :action    => :quiz }
 
-    --help,               -h   Show this message
-    --touch,              -t   Validate filename(s) and write back in full CSV format
-    --version                  Show version information
-  END
+  args.options do |arg|
+    arg.banner = "Usage: forgetful [OPTION]... [FILE]..."
+    arg.separator ""
+    arg.separator "Specific options:"
 
-  exit status
-end
+    arg.on(     '-t', '--touch',   "Validate filename(s) and write back in full CSV format") do
+      options[:action] = :touch
+    end
+
+    arg.separator ""
+    arg.separator "Common options:"
+
+    arg.on(     '-v', '--verbose', "Show more information") do
+      options[:verbose] = true
+    end
 
-def parse_argv
-  result = { :filenames => [],
-             :action    => :quiz }
-
-  opts = GetoptLong.new(['--help',    '-h', GetoptLong::NO_ARGUMENT],
-                        ['--touch',   '-t', GetoptLong::NO_ARGUMENT],
-                        ['--version',       GetoptLong::NO_ARGUMENT])
-
-  opts.each do |opt, arg|
-    case opt
-    when '--help'
-      usage
-    when '--touch'
-      result[:action] = :touch
-    when '--version'
+    arg.on(           '--version', "Show version") do
       puts File.read(File.join(File.dirname(__FILE__), "..", "VERSION"))
-      exit 0
+      exit
+    end
+
+    arg.on_tail('-h', '--help',    "Show this message") do
+      puts arg
+      exit
     end
+
+    arg.parse!
   end
 
-  result[:filenames] = ARGV.dup
-  ARGV.clear
+  options[:filenames] = args.dup
+  args.clear
 
-  result
+  options
 end
 
 #-------------------------------------------------
 
-options = parse_argv
+options = parse(ARGV)
 
 begin
   options[:filenames].each do |filename|
-    ReminderFile.new(filename).send(options[:action])
+    ReminderFile.new(filename, options[:verbose]).send(options[:action])
   end
 rescue Interrupt
   puts

data/lib/forgetful/cli.rb

@@ -1,16 +1,18 @@
 
 class ReminderFile
-  attr_reader :filename
+  attr_reader :filename, :verbose
 
-  def initialize(filename)
+  def initialize(filename, verbose=false)
     @filename = filename
+    @verbose  = verbose
   end
 
   def reminders
     @reminders ||= Reminder.read_csv(filename)
   end
 
-  def reminders=(reminders)
+  def write(reminders)
+    raise "Writing back a different number of reminders than read from file (#{reminders.size} != #{@reminders.size})" if reminders.size != @reminders.size
     Reminder.write_csv(filename, reminders.sort)
   end
 
@@ -20,30 +22,37 @@ class ReminderFile
   # 3. sort the rows
   def touch
     puts "### TOUCH: #{filename}"
-    self.reminders = reminders
+    write(reminders)
   end
 
   def quiz
     puts "### QUIZ: #{filename}"
     dues, not_dues = reminders.partition { |reminder| reminder.due_on <= Date.today }
-    gradeds = quiz_map(dues.sort_by { rand })
+    gradeds, ungradeds = quiz_map(dues.sort_by { rand })
 
-    self.reminders = gradeds + not_dues
+    write(gradeds + ungradeds + not_dues)
 
     faileds = gradeds.select { |reminder| reminder.review? }
-    until faileds.empty?
+    until faileds.empty? || ungradeds.any?
       puts "### REVIEW: #{filename}"
-      gradeds = quiz_map(faileds.sort_by { rand })
+      gradeds, ungradeds = quiz_map(faileds.sort_by { rand })
       faileds = gradeds.select { |reminder| reminder.review? }
     end
   end
 
   private
     def quiz_map(reminders)
-      reminders.zip(1..reminders.length).map do |reminder, i|
-        q = ask(reminder, i, reminders.size)
-        reminder.next(q)
+      gradeds = []
+      ungradeds = reminders.dup
+
+      reminders.each_with_index do |reminder, i|
+        q = ask(reminder, i+1, reminders.size)
+        gradeds << ungradeds.shift.next(q)
       end
+    rescue EOFError
+      # tolerate Ctrl-D, skips the rest of the quiz
+    ensure
+      return gradeds, ungradeds
     end
 
     def ask(reminder, i, n)
@@ -54,6 +63,7 @@ class ReminderFile
       readline
 
       puts padding + "A: #{reminder.answer}"
+      puts padding + "   %.2f -> %s" % [reminder.ef, reminder.history.join] if verbose
 
       while true
         print padding + "? "

data/lib/forgetful/reminder.rb

@@ -8,6 +8,10 @@ class Reminder
     @history = history.dup.freeze
   end
 
+  def ef
+    SuperMemo::traverse(history)[0]
+  end
+
   def next(q)
     new_history = history + [q]
     Reminder.new(question, answer, SuperMemo::next_date(Date.today, new_history), new_history)

data/spec/reminder_spec.rb

@@ -16,6 +16,10 @@ describe "reminder" do
     it "should be valid" do
       @reminder.to_a.should == [@question, @answer, Date.today, []]
     end
+
+    it "should have an ef of 2.5" do
+      @reminder.ef.should be_close(2.5, 0.0001)
+    end
   end
 
   describe "with full constructor" do
@@ -33,6 +37,10 @@ describe "reminder" do
         @reminder.history.push(5)
       }.should raise_error(error_type, "can't modify frozen array")
     end
+
+    it "should have an ef of 2.8 (based on history)" do
+      @reminder.ef.should be_close(2.8, 0.0001)
+    end
   end
 
   describe "next" do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 3
+  version: 0.3.3
 platform: ruby
 authors: 
 - Jonathan Palardy
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-22 00:00:00 -04:00
+date: 2010-11-05 00:00:00 -04:00
 default_executable: forgetful
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -23,7 +23,7 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         segments: 
         - 1