repetition 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 395411bf8918658d462f941a292cf0ed689987505f30c13e31843fad1e45e38a
-  data.tar.gz: bc4232618f5ebde02ee0b6c63daf4b21217a43bb9aa29a8230279f374bd9d67c
+  metadata.gz: a8f83e5a3642ef6323489f00d79859b2641e739c68f2a09dd3fddf0abc17ffdd
+  data.tar.gz: acfb2c388061a6bb2ce61610cddcecd723ad80e5a0799dc34d01d60b1f52e6d3
 SHA512:
-  metadata.gz: b0b276d0d13d1515c656b967a397ad89bcf50925c66920a7f1daf65eda1ef8136b021e44ed6751b748dc2da4b9db7a9fa8d0a2037cc3f578a431729448ab8276
-  data.tar.gz: e1bb3c765debf1b8b1acafdb75e9477581d36d9ba4d062c408d1e31d63a164088798cf9a9c76a740fb89fab9fb7382bc75198c12c8219b9331cc560962d4f7a7
+  metadata.gz: b7bc7a4f0c11835667cb55e131e169b7cee5807f861299af27dc2a37de816d79931aa2bc9c0c3d8c5da77a247665e21a59ffb36eb36396f0393b793c6dde7c5a
+  data.tar.gz: d443112a976d1561887bc4fab0614999fe4c0e4d20107fd01fcef4766806f5fe01b9d2e79a6746ba0956430de6e6cab5e7122a4034e1a6f460adcf8a5ff5fd13

data/CHANGELOG.md

@@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Fixed
+- Fix interval calculation bug
+
 ## [2.0.0] - 2018-08-08
 ### Changed
 - Move from module to class implementation

data/README.md

@@ -1,6 +1,10 @@
 # Repetition
 
-Spaced repetition module which can be used as a mixin in Ruby apps. SuperMemo 2 is used as a repetition algorithm.
+[![Build Status](https://img.shields.io/travis/dankimio/repetition.svg?style=flat)](https://travis-ci.org/dankimio/repetition)
+[![Gem Version](https://img.shields.io/gem/v/repetition.svg?style=flat&color=brightgreen)](https://rubygems.org/gems/repetition)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://raw.githubusercontent.com/dankimio/repetition/master/LICENSE.TXT)
+
+Spaced repetition algorithm for scheduling flashcard repetitions. SuperMemo 2 is used as a repetition algorithm.
 
 ## Installation
 

data/lib/repetition.rb

@@ -1,70 +1 @@
-#
-# The Repetition module uses the Super Memo method to determine when to next
-# review an item. The quality values are as follows:
-#
-# 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
-#
-# Find out more here: https://www.supermemo.com/english/ol/sm2.htm
-#
-
-require 'date'
-
-module Repetition
-  class Flashcard
-    attr_reader :easiness_factor, :interval, :repetitions
-
-    def initialize(easiness_factor: 2.5, interval: 0, repetitions: 0)
-      @easiness_factor = easiness_factor
-      @interval = interval
-      @repetitions = repetitions
-    end
-
-    def recall(quality)
-      raise ArgumentError, 'Invalid quality of recall. Should be in range from 0 to 5.' unless (0..5).cover?(quality)
-
-      if quality < 3
-        # An incorrect recall is reset back to the beginning
-        @repetitions = 0
-        @interval = 0
-      elsif quality == 3
-        # The item was correctly recalled but should be tested again quickly
-        @interval = 0
-      else
-        # The item was correctly recalled and we can review later on
-        @repetitions += 1
-
-        case @repetitions
-        when 1
-          @interval = 1
-        when 2
-          @interval = 6
-        else
-          @easiness_factor = calculate_easiness_factor(@easiness_factor, quality)
-          @interval = interval * easiness_factor
-        end
-      end
-
-      due_on
-    end
-
-    def due_on
-      today + @interval
-    end
-
-    private
-
-    def today
-      @today ||= Date.today
-    end
-
-    def calculate_easiness_factor(easiness_factor, quality)
-      result = easiness_factor - 0.8 + (0.28 * quality) - (0.02 * quality * quality)
-      result < 1.3 ? 1.3 : result
-    end
-  end
-end
+require 'repetition/flashcard'

data/lib/repetition/flashcard.rb

@@ -0,0 +1,70 @@
+#
+# The Repetition module uses the Super Memo method to determine when to next
+# review an item. The quality values are as follows:
+#
+# 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
+#
+# Find out more here: https://www.supermemo.com/english/ol/sm2.htm
+#
+
+require 'date'
+
+module Repetition
+  class Flashcard
+    attr_reader :easiness_factor, :interval, :repetitions
+
+    def initialize(easiness_factor: 2.5, interval: 0, repetitions: 0)
+      @easiness_factor = easiness_factor
+      @interval = interval
+      @repetitions = repetitions
+    end
+
+    def recall(quality)
+      raise ArgumentError, 'Invalid quality of recall. Should be in range from 0 to 5.' unless (0..5).cover?(quality)
+
+      if quality < 3
+        # An incorrect recall is reset back to the beginning
+        @repetitions = 0
+        @interval = 0
+      elsif quality == 3
+        # The item was correctly recalled but should be tested again quickly
+        @interval = 0
+      else
+        # The item was correctly recalled and we can review later on
+        @repetitions += 1
+
+        case @repetitions
+        when 1
+          @interval = 1
+        when 2
+          @interval = 6
+        else
+          @easiness_factor = calculate_easiness_factor(@easiness_factor, quality)
+          @interval = @interval * @easiness_factor
+        end
+      end
+
+      due_on
+    end
+
+    def due_on
+      today + @interval
+    end
+
+    private
+
+    def today
+      @today ||= Date.today
+    end
+
+    def calculate_easiness_factor(easiness_factor, quality)
+      result = easiness_factor - 0.8 + (0.28 * quality) - (0.02 * quality * quality)
+      result < 1.3 ? 1.3 : result
+    end
+  end
+end

data/lib/repetition/version.rb

@@ -1,3 +1,3 @@
 module Repetition
-  VERSION = '2.0.0'
+  VERSION = '2.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: repetition
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Dan Kim
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-08 00:00:00.000000000 Z
+date: 2018-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,6 +70,7 @@ files:
 - bin/console
 - bin/setup
 - lib/repetition.rb
+- lib/repetition/flashcard.rb
 - lib/repetition/version.rb
 - repetition.gemspec
 homepage: http://github.com/danyakim/repetition