fsrs 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6cba5488414e90983669f4a77fb4ad1f4cee8ce9b9fbfa4d2609dde42d2b8c34
+  data.tar.gz: '09be9d648a12a4995a5d42a935fe04210006292695cffc638004a98b561e6be9'
+SHA512:
+  metadata.gz: 422600cbc08224ef57c382ca4d7b5d854a09065ef27b48f89622fb993a784262368b8bce0107934d2a4c46a0b16a8ed2bfb0eb159f79d531616c52bd7445acc7
+  data.tar.gz: ab99a8c63a3345c7e1944d3f74202002e788be92f8dcea2c49085d46de0d2be20f5f867370fa0dca25fca427a3e3754350c567370b86a7adb9e0f69eb0084e4b

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  SuggestExtensions: false
+  
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-04-30
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at 6334+clayton@users.noreply.github.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 clayton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Fsrs
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fsrs`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fsrs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/fsrs/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Fsrs project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/fsrs/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+require "minitest/pride"
+
+Minitest::TestTask.create
+
+task default: %i[test]
+
+# require "rubocop/rake_task"
+
+# RuboCop::RakeTask.new
+
+# task default: %i[test rubocop]

data/lib/fsrs/fsrs.rb

@@ -0,0 +1,361 @@
+# frozen_string_literal: true
+
+module Fsrs
+  #
+  ## Scheduling Info
+  class SchedulingInfo
+    attr_accessor :card, :review_log
+
+    def initialize(card, review_log)
+      @card = card
+      @review_log = review_log
+    end
+  end
+
+  #
+  ## Review Log
+  class ReviewLog
+    attr_accessor :rating, :scheduled_days, :elapsed_days, :review, :state
+
+    def initialize(rating, scheduled_days, elapsed_days, review, state)
+      @rating = rating
+      @scheduled_days = scheduled_days
+      @elapsed_days = elapsed_days
+      @review = review
+      @state = state
+    end
+  end
+
+  #
+  ## Determines next review date
+  class CardScheduler
+    attr_accessor :again, :hard, :good, :easy
+
+    def initialize(card)
+      @again = card.clone
+      @hard = card.clone
+      @good = card.clone
+      @easy = card.clone
+    end
+
+    def update_state(state)
+      case state
+      when State::NEW
+        update_new_state
+      when State::LEARNING, State::RELEARNING
+        update_learning_relearning_state(state)
+      when State::REVIEW
+        update_review_state
+      end
+    end
+
+    def schedule(now, hard_interval, good_interval, easy_interval)
+      update_schedule_days(hard_interval, good_interval, easy_interval)
+      update_due_dates(now, hard_interval, good_interval, easy_interval)
+    end
+
+    def record_log(card, now)
+      {
+        Rating::AGAIN => record_again_log(card, now),
+        Rating::HARD => record_hard_log(card, now),
+        Rating::GOOD => record_good_log(card, now),
+        Rating::EASY => record_easy_log(card, now)
+      }
+    end
+
+    private
+
+    def update_due_dates(now, hard_interval, good_interval, easy_interval)
+      @again.due = now + 5.minutes
+      @hard.due = hard_interval.positive? ? now + hard_interval.days : now + 10.minutes
+      @good.due = now + good_interval.days
+      @easy.due = now + easy_interval.days
+    end
+
+    def update_schedule_days(hard_interval, good_interval, easy_interval)
+      @again.scheduled_days = 0
+      @hard.scheduled_days = hard_interval
+      @good.scheduled_days = good_interval
+      @easy.scheduled_days = easy_interval
+    end
+
+    def update_new_state
+      @again.state = State::LEARNING
+      @hard.state = State::LEARNING
+      @good.state = State::LEARNING
+      @easy.state = State::REVIEW
+    end
+
+    def update_learning_relearning_state(state)
+      @again.state = state
+      @hard.state = state
+      @good.state = State::REVIEW
+      @easy.state = State::REVIEW
+    end
+
+    def update_review_state
+      @again.state = State::RELEARNING
+      @hard.state = State::REVIEW
+      @good.state = State::REVIEW
+      @easy.state = State::REVIEW
+      @again.lapses += 1
+    end
+
+    def record_again_log(card, now)
+      SchedulingInfo.new(
+        @again,
+        ReviewLog.new(
+          Rating::AGAIN,
+          @again.scheduled_days,
+          card.elapsed_days,
+          now,
+          card.state
+        )
+      )
+    end
+
+    def record_hard_log(card, now)
+      SchedulingInfo.new(
+        @hard,
+        ReviewLog.new(
+          Rating::HARD,
+          @hard.scheduled_days,
+          card.elapsed_days,
+          now,
+          card.state
+        )
+      )
+    end
+
+    def record_good_log(card, now)
+      SchedulingInfo.new(
+        @good,
+        ReviewLog.new(
+          Rating::GOOD,
+          @good.scheduled_days,
+          card.elapsed_days,
+          now,
+          card.state
+        )
+      )
+    end
+
+    def record_easy_log(card, now)
+      SchedulingInfo.new(
+        @easy,
+        ReviewLog.new(
+          Rating::EASY,
+          @easy.scheduled_days,
+          card.elapsed_days,
+          now,
+          card.state
+        )
+      )
+    end
+  end
+
+  #
+  ## Rating
+  class Rating
+    AGAIN = 1
+    HARD = 2
+    GOOD = 3
+    EASY = 4
+  end
+
+  #
+  ## Card
+  class Card
+    attr_accessor :due, :stability, :difficulty, :elapsed_days, :scheduled_days, :reps, :lapses, :state, :last_review
+
+    def initialize
+      @due = DateTime.new
+      @stability = 0.0
+      @difficulty = 0.0
+      @elapsed_days = 0
+      @scheduled_days = 0
+      @reps = 0
+      @lapses = 0
+      @state = State::NEW
+    end
+
+    def get_retrievability(now)
+      decay = -0.5
+      factor = (0.9**(1 / decay)) - 1
+
+      return nil unless @state == State::REVIEW
+
+      elapsed_days = [0, (now - @last_review).to_i].max
+      (1 + (factor * elapsed_days / @stability))**decay
+    end
+
+    def deep_clone
+      Marshal.load(Marshal.dump(self))
+    end
+  end
+
+  #
+  ## State
+  class State
+    NEW = 0
+    LEARNING = 1
+    REVIEW = 2
+    RELEARNING = 3
+  end
+
+  #
+  ## Scheduler
+  class Scheduler
+    attr_accessor :p, :decay, :factor
+
+    def initialize
+      @p = Parameters.new
+      @decay = -0.5
+      @factor = (0.9**(1 / @decay)) - 1
+    end
+
+    def repeat(card, now)
+      raise Fsrs::InvalidDateError unless now.utc?
+
+      card = card.clone
+      card.elapsed_days = if card.state == State::NEW
+                            0
+                          else
+                            (now - card.last_review).to_i
+                          end
+      card.last_review = now
+      card.reps += 1
+      card_scheduler = CardScheduler.new(card)
+      card_scheduler.update_state(card.state)
+
+      case card.state
+      when State::NEW
+        schedule_new_state(card_scheduler, now)
+      when State::LEARNING, State::RELEARNING
+        schedule_learning_relearning_state(card_scheduler, now)
+      when State::REVIEW
+        schedule_review_state(card_scheduler, card, now)
+      end
+      card_scheduler.record_log(card, now)
+    end
+
+    def schedule_new_state(s, now)
+      init_ds(s)
+      s.again.due = now + 60
+      s.hard.due = now + (5 * 60)
+      s.good.due = now + (10 * 60)
+      easy_interval = next_interval(s.easy.stability)
+      s.easy.scheduled_days = easy_interval
+      s.easy.due = now + easy_interval.days
+    end
+
+    def schedule_learning_relearning_state(s, now)
+      hard_interval = 0
+      good_interval = next_interval(s.good.stability)
+      easy_interval = [next_interval(s.easy.stability), good_interval + 1].max
+      s.schedule(now, hard_interval, good_interval, easy_interval)
+    end
+
+    def schedule_review_state(s, card, now)
+      interval = card.elapsed_days
+      last_d = card.difficulty
+      last_s = card.stability
+      retrievability = forgetting_curve(interval, last_s)
+      next_ds(s, last_d, last_s, retrievability)
+      hard_interval = next_interval(s.hard.stability)
+      good_interval = next_interval(s.good.stability)
+      hard_interval = [hard_interval, good_interval].min
+      good_interval = [good_interval, hard_interval + 1].max
+      easy_interval = [next_interval(s.easy.stability), good_interval + 1].max
+      s.schedule(now, hard_interval, good_interval, easy_interval)
+    end
+
+    def init_ds(s)
+      s.again.difficulty = init_difficulty(Rating::AGAIN)
+      s.again.stability = init_stability(Rating::AGAIN)
+      s.hard.difficulty = init_difficulty(Rating::HARD)
+      s.hard.stability = init_stability(Rating::HARD)
+      s.good.difficulty = init_difficulty(Rating::GOOD)
+      s.good.stability = init_stability(Rating::GOOD)
+      s.easy.difficulty = init_difficulty(Rating::EASY)
+      s.easy.stability = init_stability(Rating::EASY)
+    end
+
+    def next_ds(s, last_d, last_s, retrievability)
+      s.again.difficulty = next_difficulty(last_d, Rating::AGAIN)
+      s.again.stability = next_forget_stability(last_d, last_s, retrievability)
+      s.hard.difficulty = next_difficulty(last_d, Rating::HARD)
+      s.hard.stability = next_recall_stability(last_d, last_s, retrievability, Rating::HARD)
+      s.good.difficulty = next_difficulty(last_d, Rating::GOOD)
+      s.good.stability = next_recall_stability(last_d, last_s, retrievability, Rating::GOOD)
+      s.easy.difficulty = next_difficulty(last_d, Rating::EASY)
+      s.easy.stability = next_recall_stability(last_d, last_s, retrievability, Rating::EASY)
+    end
+
+    def init_stability(r)
+      [self.p.w[r - 1], 0.1].max
+    end
+
+    def init_difficulty(r)
+      [[self.p.w[4] - (self.p.w[5] * (r - 3)), 1].max, 10].min
+    end
+
+    def forgetting_curve(elapsed_days, stability)
+      (1 + (factor * elapsed_days / stability))**decay
+    end
+
+    def next_interval(s)
+      new_interval = s / factor * ((self.p.request_retention**(1 / decay)) - 1)
+      new_interval.round.clamp(1, self.p.maximum_interval)
+    end
+
+    def next_difficulty(d, r)
+      next_d = d - (self.p.w[6] * (r - 3))
+      mean_reversion(self.p.w[4], next_d).clamp(1, 10)
+    end
+
+    def mean_reversion(init, current)
+      (self.p.w[7] * init) + ((1 - self.p.w[7]) * current)
+    end
+
+    def next_recall_stability(d, s, r, rating)
+      hard_penalty = rating == Rating::HARD ? self.p.w[15] : 1
+      easy_bonus = rating == Rating::EASY ? self.p.w[16] : 1
+      s * (1 + (Math.exp(self.p.w[8]) * (11 - d) * (s**-self.p.w[9]) * (Math.exp((1 - r) * self.p.w[10]) - 1) * hard_penalty * easy_bonus))
+    end
+
+    def next_forget_stability(d, s, r)
+      self.p.w[11] * (d**-self.p.w[12]) * (((s + 1)**self.p.w[13]) - 1) * Math.exp((1 - r) * self.p.w[14])
+    end
+  end
+
+  #
+  ## Parameters
+  class Parameters
+    attr_accessor :request_retention, :maximum_interval, :w
+
+    def initialize
+      @request_retention = 0.9
+      @maximum_interval = 36_500
+      @w = [
+        0.4,
+        0.6,
+        2.4,
+        5.8,
+        4.93,
+        0.94,
+        0.86,
+        0.01,
+        1.49,
+        0.14,
+        0.94,
+        2.18,
+        0.05,
+        0.34,
+        1.26,
+        0.29,
+        2.61
+      ]
+    end
+  end
+end

data/lib/fsrs/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Fsrs
+  VERSION = "0.9.0"
+end

data/lib/fsrs.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "active_support/deprecator"
+require "active_support/deprecation"
+require "active_support/time"
+require "active_support/time_with_zone"
+
+require_relative "fsrs/version"
+require_relative "fsrs/fsrs"
+
+module Fsrs
+  class Error < StandardError; end
+
+  #
+  ## An error for invalidate dates
+  class InvalidDateError < Error
+    def initialize(msg = "Date must be UTC and timezone-aware")
+      super
+    end
+  end
+end

data/sig/fsrs.rbs

@@ -0,0 +1,4 @@
+module Fsrs
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: fsrs
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- clayton
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: A ruby implementation of the Open Spaced Repetition's Free Spaced Repetition
+  Scheduler.
+email:
+- 6334+clayton@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/fsrs.rb
+- lib/fsrs/fsrs.rb
+- lib/fsrs/version.rb
+- sig/fsrs.rbs
+homepage: https://github.com/clayton/rb-fsrs
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/clayton/rb-fsrs
+  source_code_uri: https://github.com/clayton/rb-fsrs
+  changelog_uri: https://github.com/clayton/rb-fsrs/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: Ruby implementation of FSRS algorithm.
+test_files: []