active_recall 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f26bb57ebefa4026475f96a4e9df6051990de46bb131ff38f6a8cb5536d30b1
-  data.tar.gz: 439d4544a42ebfd704686ea81bcc7f32242ef3e4828772fed2cc77843d014d8c
+  metadata.gz: cd98a58a0b310c84f7fb225ea5d7ab8f6a15f3f784b47b57c0b423d2b7ec4001
+  data.tar.gz: 94a4401f4adb97d724d0287d6edad73ae42a8a5e1073436132f90e3fb23bb4a8
 SHA512:
-  metadata.gz: 6eade4d6980383d43077857517aaec84b287953567860b7c3f9c5b0ba414f3ed9d1ac43c2e4747147f2b7689edcbf8daa7e5c6829b8b1ed90f56b74bfa560987
-  data.tar.gz: 6d77b4755a8eef49319d17b3f2d0e285dca85ad53c51553f9783761b7c8ec0cd1cde86ec69170d0efecefb8a39f893c04a35ba81eab42cb72542689ca9f82578
+  metadata.gz: 2b7fb09f86a3513e82370c320833cf620ee9082371a27c2f404c913ff2717cc5f3fe0145acc8061a90623661266eb86d8cefcc37843081a3d998caba898c033d
+  data.tar.gz: 19d5f46d9df7f38c859adac7c2eae9eb90359529b5890ac1bf5c6f9f99251636b96be5ee2dbcb847410601826554f94f140d270bc499088c99e1cb776b9f471c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_recall (1.1.0)
+    active_recall (1.2.0)
       activerecord (>= 5.2.3)
       activesupport (>= 5.2.3)
 
@@ -21,9 +21,9 @@ GEM
       zeitwerk (~> 2.1, >= 2.1.8)
     concurrent-ruby (1.1.5)
     diff-lcs (1.3)
-    i18n (1.6.0)
+    i18n (1.7.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.11.3)
+    minitest (5.12.2)
     rake (10.5.0)
     rdoc (6.2.0)
     rspec (3.8.0)
@@ -43,7 +43,7 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    zeitwerk (2.1.10)
+    zeitwerk (2.2.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -29,9 +29,15 @@ Or install it yourself as:
     $ gem install active_recall
 
 ## Usage
+You can configure the desired SRS algorithm during runtime:
+```ruby
+ActiveRecall.configure do |config|
+  config.algorithm_class = ActiveRecall::FibonacciSequence
+end
+```
+For Rails applications, try doing this from within an [initializer file](https://guides.rubyonrails.org/configuring.html#using-initializer-files).
 
-Assume you have an application allowing your users to study words in a foreign language. Using the <code>has_deck</code> method
-you can set up a deck of flashcards that the user will study:
+Assume you have an application allowing your users to study words in a foreign language. Using the `has_deck` method you can set up a deck of flashcards that the user will study:
 
 ```ruby
 class Word < ActiveRecord::Base
@@ -48,7 +54,7 @@ word = Word.create!(:kanji => "日本語", :kana => "にほんご", :translation
 You can add words and record attempts to guess the word as right or wrong. Various methods exist to allow you to access subsets of this collection:
 
 ```ruby
-# Initally adding a word
+# Initially adding a word
 user.words << word
 user.words.untested #=> [word]
 
@@ -64,7 +70,7 @@ user.words.failed #=> [word]
 user.words #=> [word]
 ```
 
-As time passes words need to be reviewed to keep them fresh in memory:
+As time passes, words need to be reviewed to keep them fresh in memory:
 
 ```ruby
 # Three days later...
@@ -72,7 +78,7 @@ user.words.known #=> []
 user.words.expired #=> [word]
 ```
 
-Guessing a word correcly several times in a row results in the word taking longer to expire, and demonstrates mastery of that word.
+Guessing a word correctly several times in a row results in the word taking longer to expire, and demonstrates mastery of that word.
 
 ```ruby
 user.right_answer_for!(word)
@@ -89,7 +95,7 @@ user.words.expired #=> [word]
 Reviewing
 ---------
 
-In addition to an <code>expired</code> method, ActiveRecall provides a suggested reviewing sequence for all unknown words in the deck.
+In addition to an `expired` method, ActiveRecall provides a suggested reviewing sequence for all unknown words in the deck.
 Words are randomly chosen from all untested words, failed, and finally expired in order of precedence.
 
 ```ruby

data/lib/active_recall.rb

@@ -3,9 +3,29 @@
 require 'active_recall/base'
 require 'active_recall/deck_methods'
 require 'active_recall/item_methods'
+require 'active_recall/algorithms/fibonacci_sequence'
 require 'active_recall/algorithms/leitner_system'
+require 'active_recall/configuration'
 require 'active_recall/models/deck'
 require 'active_recall/models/item'
 require 'active_recall/version'
 
 ActiveRecord::Base.send(:include, ActiveRecall::Base)
+
+module ActiveRecall
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+end

data/lib/active_recall/algorithms/fibonacci_sequence.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module ActiveRecall
+  class FibonacciSequence
+    def self.right(box:, current_time: Time.current, times_right:, times_wrong:)
+      new(
+        box: box,
+        current_time: current_time,
+        times_right: times_right,
+        times_wrong: times_wrong
+      ).right
+    end
+
+    def self.wrong(box:, current_time: Time.current, times_right:, times_wrong:)
+      new(
+        box: box,
+        current_time: current_time,
+        times_right: times_right,
+        times_wrong: times_wrong
+      ).wrong
+    end
+
+    def initialize(box:, current_time: Time.current, times_right:, times_wrong:)
+      @box = box
+      @current_time = current_time
+      @times_right = times_right
+      @times_wrong = times_wrong
+    end
+
+    def right
+      {
+        box: box + 1,
+        last_reviewed: current_time,
+        next_review: next_review,
+        times_right: times_right + 1,
+        times_wrong: times_wrong
+      }
+    end
+
+    def wrong
+      {
+        box: [0, box - 1].max,
+        last_reviewed: current_time,
+        next_review: nil,
+        times_right: times_right,
+        times_wrong: times_wrong + 1
+      }
+    end
+
+    private
+
+    attr_reader :box, :current_time, :times_right, :times_wrong
+
+    def fibonacci_number_at(index)
+      if (0..1).cover?(index)
+        index
+      else
+        fibonacci_number_at(index - 1) + fibonacci_number_at(index - 2)
+      end
+    end
+
+    def next_review
+      current_time + fibonacci_number_at(box + 1).days
+    end
+  end
+end

data/lib/active_recall/configuration.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ActiveRecall
+  class Configuration
+    attr_accessor :algorithm_class
+
+    def initialize
+      @algorithm_class = LeitnerSystem
+    end
+  end
+end

data/lib/active_recall/models/item.rb

@@ -3,10 +3,12 @@
 module ActiveRecall
   class Item < ActiveRecord::Base
     self.table_name = 'active_recall_items'
+
     belongs_to :deck
     belongs_to :source, polymorphic: true
-    scope :untested, -> { where(['box = ? and last_reviewed is null', 0]) }
+
     scope :failed, -> { where(['box = ? and last_reviewed is not null', 0]) }
+    scope :untested, -> { where(['box = ? and last_reviewed is null', 0]) }
 
     def self.expired(current_time: Time.current)
       where(['box > ? and next_review <= ?', 0, current_time])
@@ -17,15 +19,19 @@ module ActiveRecall
     end
 
     def right!
-      update!(LeitnerSystem.right(scoring_attributes))
+      update!(algorithm_class.right(scoring_attributes))
     end
 
     def wrong!
-      update!(LeitnerSystem.wrong(scoring_attributes))
+      update!(algorithm_class.wrong(scoring_attributes))
     end
 
     private
 
+    def algorithm_class
+      ActiveRecall.configuration.algorithm_class
+    end
+
     def scoring_attributes
       attributes.symbolize_keys.slice(:box, :times_right, :times_wrong)
     end

data/lib/active_recall/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecall
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_recall
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Robert Gravina
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-17 00:00:00.000000000 Z
+date: 2019-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,8 +130,10 @@ files:
 - bin/console
 - bin/setup
 - lib/active_recall.rb
+- lib/active_recall/algorithms/fibonacci_sequence.rb
 - lib/active_recall/algorithms/leitner_system.rb
 - lib/active_recall/base.rb
+- lib/active_recall/configuration.rb
 - lib/active_recall/deck_methods.rb
 - lib/active_recall/item_methods.rb
 - lib/active_recall/models/deck.rb