active_recall 1.8.5 → 1.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e96531570c81f3e7457acc497a7db792708b6b765794e2294b00cce0bd0cfe2
-  data.tar.gz: 06c2f07e0438fc376beefe980dbdc579f06bb7d8bab77e692faed876b5a69629
+  metadata.gz: 95111c003ae9481ad46fd817553888897dcbcab55e901240bb76169dc60c56ff
+  data.tar.gz: 71c3da4109511587c2adbc2056d8ddd12f18e5c0bfa263b38c3e1516b667c8a0
 SHA512:
-  metadata.gz: c8c4385a5646b277f27b6a90505e6f55847eba3d5e96bb32e0694f9148a018f71846d5cb9d552078a5c215965e5d72f6661f96c64885e9199ff557e77b47b059
-  data.tar.gz: 9089edaa9ef21c0d1a8750d60b223ac4cda49c075268bee4bea25493b7951c3bd31747a129a93721f0e239efb41bb9d7db3a6f96d157d9b2f95930494f812c91
+  metadata.gz: 4a93d9af15d20ecaf631a7ebf9ae36568849c103f916e80b4d4bd0782563420b1280aca3fa951ad622ec30b1e6d6a509966b5ffa92ef940c75928c175a05dd46
+  data.tar.gz: dd1119b28d07cf45db8177ffba1b7486e5b623d8472c2f7decb1549391d9258c9924c6b22b5285647b3c1fecc26e1f8cc2980ca73615c9e37356cc22d6b72e37

data/.gitignore

@@ -14,3 +14,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.idea/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_recall (1.8.5)
+    active_recall (1.8.6)
       activerecord (>= 5.2.3, <= 7.1)
       activesupport (>= 5.2.3, <= 7.1)
 

data/README.md

@@ -35,6 +35,7 @@ ActiveRecall.configure do |config|
   config.algorithm_class = ActiveRecall::FibonacciSequence
 end
 ```
+Algorithms include `FibonacciSequence`, `LeitnerSystem`, and `SoftLeitnerSystem`.
 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 `has_deck` method you can set up a deck of flashcards that the user will study:

data/lib/active_recall/algorithms/soft_leitner_system.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module ActiveRecall
+  class SoftLeitnerSystem
+    DELAYS = [3, 7, 14, 30, 60, 120, 240].freeze
+
+    def self.right(box:, times_right:, times_wrong:, current_time: Time.current)
+      new(
+        box: box,
+        current_time: current_time,
+        times_right: times_right,
+        times_wrong: times_wrong
+      ).right
+    end
+
+    def self.wrong(box:, times_right:, times_wrong:, current_time: Time.current)
+      new(
+        box: box,
+        current_time: current_time,
+        times_right: times_right,
+        times_wrong: times_wrong
+      ).wrong
+    end
+
+    def initialize(box:, times_right:, times_wrong:, current_time: Time.current)
+      @box = box
+      @current_time = current_time
+      @times_right = times_right
+      @times_wrong = times_wrong
+    end
+
+    def right
+      self.box = [box + 1, DELAYS.count].min
+
+      {
+        box: box,
+        times_right: times_right + 1,
+        times_wrong: times_wrong,
+        last_reviewed: current_time,
+        next_review: next_review
+      }
+    end
+
+    def wrong
+      self.box = [box - 1, 0].max
+
+      {
+        box: box,
+        times_right: times_right,
+        times_wrong: times_wrong + 1,
+        last_reviewed: current_time,
+        next_review: next_review
+      }
+    end
+
+    private
+
+    attr_accessor :box
+    attr_reader :current_time, :times_right, :times_wrong
+
+    def next_review
+      (current_time + DELAYS[[DELAYS.count, box].min - 1].days)
+    end
+  end
+end

data/lib/active_recall/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecall
-  VERSION = "1.8.5"
+  VERSION = "1.8.6"
 end

data/lib/active_recall.rb

@@ -5,6 +5,7 @@ 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/algorithms/soft_leitner_system"
 require "active_recall/configuration"
 require "active_recall/models/deck"
 require "active_recall/models/item"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_recall
 version: !ruby/object:Gem::Version
-  version: 1.8.5
+  version: 1.8.6
 platform: ruby
 authors:
 - Robert Gravina
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-06 00:00:00.000000000 Z
+date: 2023-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -130,6 +130,7 @@ files:
 - lib/active_recall.rb
 - lib/active_recall/algorithms/fibonacci_sequence.rb
 - lib/active_recall/algorithms/leitner_system.rb
+- lib/active_recall/algorithms/soft_leitner_system.rb
 - lib/active_recall/base.rb
 - lib/active_recall/configuration.rb
 - lib/active_recall/deck_methods.rb