spaced_repetition 1.0.0

data/README.md

@@ -0,0 +1,35 @@
+Spaced Repetition algorithm for Ruby. 
+
+## Install
+Add to your Gemfile:
+
+    gem 'spaced_repetition', :git => 'git://github.com/espresse/spaced_repetition.git'
+
+and run 
+
+    bundle install
+
+## Typical use-case:
+
+    require 'rubygems'
+    require 'spaced_repetition'
+
+    #user's quality_response is 5, no previous repetition had been done yet
+    sm2 = SpacedRepetition::Sm2.new(5) 
+
+    #user's quality response is 3, his/her prevoius interval was 3 days and easiness factor was 2.1
+    sm2 = SpacedRepetition::Sm2.new(3,3,2.1)
+
+You can fetch results:
+
+    #new interval
+    new_interval = sm2.interval
+
+    #new easiness_factor
+    new_ef = sm2.easniness_factor
+
+    #new repetition date
+    new_date = sm2.next_repetition_date
+
+By default, SM2, uses 6 possible answers (0-5), where 0 is very bad and 5 is perfect. If you want to use 4 answers (0 /very bad/ - 3 /perfect/) you can choose SM2Mod. It works in the same manner as SM2 does.
+

data/lib/spaced_repetition/sm2.rb

@@ -0,0 +1,63 @@
+#http://www.supermemo.com/english/ol/sm2.htm
+require 'date'
+
+module SpacedRepetition
+  class Sm2
+    def initialize(quality_response, prev_interval=0, prev_ef=2.5)
+      @prev_ef = prev_ef
+      @prev_interval = prev_interval
+      @quality_response = quality_response
+
+      @calculated_interval = nil
+      @calculated_ef = nil
+      @repetition_date = nil
+
+      #if quality_response is below 3 start repetition from the begining, but without changing easiness_factor
+      if @quality_response < 3
+        @prev_interval=0
+        @calculated_ef = @prev_ef
+      else
+        calculate_easiness_factor
+      end
+        calculate_interval
+
+        calculate_date
+    end
+
+    def interval
+      @calculated_interval
+    end
+
+    def easiness_factor
+      @calculated_ef
+    end
+
+    def next_repetition_date
+      @repetition_date
+    end
+
+    private
+    
+    def calculate_interval
+      if @prev_interval == 0
+        @calculated_interval = 1
+      elsif @prev_interval == 1
+        @calculated_interval = 6
+      else
+        @calculated_interval = (@prev_interval*@prev_ef).to_i
+      end
+    end
+
+    def calculate_easiness_factor
+      @calculated_ef = @prev_ef+(0.1-(5-@quality_response)*(0.08+(5-@quality_response)*0.02))
+      if @calculated_ef < 1.3
+        @calculated_ef = 1.3
+      end
+      @calculated_ef
+    end
+
+    def calculate_date
+      @repetition_date = Date.today + @calculated_interval
+    end
+  end
+end

data/lib/spaced_repetition/sm2_mod.rb

@@ -0,0 +1,69 @@
+#modified sm2 algorithm
+#changes:
+# - initial interval depends on given quality_response
+# - states (easiness_factor is calulated using that states, sm2 for ok uses 4)
+#   - 0 - bad (0, -0.8), 1 - so so(2, -0.3), 2 - ok(4, 0), 3 - more than better(5, 0.1)
+require 'date'
+
+module SpacedRepetition
+  class Sm2Mod
+    def initialize(quality_response, prev_interval=0, prev_ef=2.5)
+      @prev_ef = prev_ef
+      @prev_interval = prev_interval
+      @quality_response = quality_response
+
+      @calculated_interval = nil
+      @calculated_ef = nil
+      @repetition_date = nil
+
+      #if quality_response is below 3 start repetition from the begining, but without changing easiness_factor
+      if @quality_response < 2
+        @prev_interval=0
+        @calculated_ef = @prev_ef
+      else
+        calculate_easiness_factor
+      end
+        calculate_interval
+        calculate_date
+    end
+
+    def interval
+      @calculated_interval
+    end
+
+    def easiness_factor
+      @calculated_ef
+    end
+
+    def next_repetition_date
+      @repetition_date
+    end
+
+    private
+    
+    def calculate_interval
+      if @prev_interval == 0
+        @calculated_interval = 1
+        if @quality_response == 3
+          @calculated_interval = 6
+        end
+      elsif @prev_interval == 1
+        @calculated_interval = 6
+      else
+        @calculated_interval = (@prev_interval*@prev_ef).to_i
+      end
+    end
+
+    def calculate_easiness_factor
+      @calculated_ef = @prev_ef+(0.1-(3-@quality_response)*((3-@quality_response)*0.1))
+      if @calculated_ef < 1.3
+        @calculated_ef = 1.3
+      end
+      @calculated_ef
+    end
+
+    def calculate_date
+      @repetition_date = Date.today + @calculated_interval
+    end
+  end
+end

data/lib/spaced_repetition.rb

@@ -0,0 +1,2 @@
+require 'spaced_repetition/sm2'
+require 'spaced_repetition/sm2_mod'

data/spaced_repetition.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "spaced_repetition"
+  s.version = "1.0.0"
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Michał Ostrowski"]
+  s.email = ["michol@linuxcsb.org"]
+  s.summary = %q{Ruby gem for calculating spaced repetition intervals}
+  s.description = %q{Ruby gem for calculating spaced repetition intervals.}
+
+  s.files = `git ls-files`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency("bundler", ["~> 1.0"])
+end

data/test/test_sm2.rb

@@ -0,0 +1,54 @@
+require "spaced_repetition"
+require "test/unit"
+ 
+class TestSm2 < Test::Unit::TestCase
+
+  def test_scenario_user_starts_learning_new_element
+    sm2 = SpacedRepetition::Sm2.new(5)
+    assert_equal(1, sm2.interval)
+    assert_in_delta 2.6, sm2.easiness_factor, 0.001
+
+    sm2 = SpacedRepetition::Sm2.new(4)
+    assert_equal(1, sm2.interval)
+    assert_in_delta 2.5, sm2.easiness_factor, 0.001
+
+    sm2 = SpacedRepetition::Sm2.new(3)
+    assert_equal(1, sm2.interval)
+    assert_in_delta 2.36, sm2.easiness_factor, 0.001
+  end
+
+  def test_scenario_user_is_doing_good
+    sm2 = SpacedRepetition::Sm2.new(4, 6, 2.1)
+    assert_equal(12, sm2.interval)
+    assert_in_delta 2.1, sm2.easiness_factor, 0.001
+
+    sm2 = SpacedRepetition::Sm2.new(5, 12, 2.1)
+    assert_equal(25, sm2.interval)
+    assert_in_delta 2.2, sm2.easiness_factor, 0.001
+
+    sm2 = SpacedRepetition::Sm2.new(5, 25, 2.1)
+    assert_equal(52, sm2.interval)
+    assert_in_delta 2.2, sm2.easiness_factor, 0.001
+  end
+
+  def test_scenario_user_is_doing_good_but_later_is_going_bad
+    sm2 = SpacedRepetition::Sm2.new(3, 6, 2.1)
+    assert_equal(12, sm2.interval)
+    assert_in_delta 1.96, sm2.easiness_factor, 0.001
+
+    sm2 = SpacedRepetition::Sm2.new(0, 12, 1.96)
+    assert_equal(1, sm2.interval)
+    assert_in_delta 1.96, sm2.easiness_factor, 0.001
+
+    sm2 = SpacedRepetition::Sm2.new(0, 1, 1.96)
+    assert_equal(1, sm2.interval)
+    assert_in_delta 1.96, sm2.easiness_factor, 0.001
+  end
+
+  def test_scenario_user_passed_char_instead_of_number
+    assert_raise( ArgumentError ) { SpacedRepetition::Sm2.new("a", 6, 2.1) }
+  end
+
+  
+end
+

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: spaced_repetition
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- "Micha\xC5\x82 Ostrowski"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-16 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+description: Ruby gem for calculating spaced repetition intervals.
+email: 
+- michol@linuxcsb.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- lib/spaced_repetition.rb
+- lib/spaced_repetition/sm2.rb
+- lib/spaced_repetition/sm2_mod.rb
+- spaced_repetition.gemspec
+- test/test_sm2.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby gem for calculating spaced repetition intervals
+test_files: []
+