active_recall 1.8.6 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95111c003ae9481ad46fd817553888897dcbcab55e901240bb76169dc60c56ff
-  data.tar.gz: 71c3da4109511587c2adbc2056d8ddd12f18e5c0bfa263b38c3e1516b667c8a0
+  metadata.gz: 1be7449fff68fa72825e50fd75ac16c5e66c289b8478aa6b5777492a6d15f84c
+  data.tar.gz: 60a2523b2e4ea54a3cceebc442be03a36bfae90a8047d77bc96df17fe3f12e2c
 SHA512:
-  metadata.gz: 4a93d9af15d20ecaf631a7ebf9ae36568849c103f916e80b4d4bd0782563420b1280aca3fa951ad622ec30b1e6d6a509966b5ffa92ef940c75928c175a05dd46
-  data.tar.gz: dd1119b28d07cf45db8177ffba1b7486e5b623d8472c2f7decb1549391d9258c9924c6b22b5285647b3c1fecc26e1f8cc2980ca73615c9e37356cc22d6b72e37
+  metadata.gz: 04fc13601da77c775765ff7e465010a9227d367dcfe4e7dd2eac0b7faf92461d2377ce106b1b03b1c14538e36ce9ab3c63d906b46fa1885f6eec784547aa3231
+  data.tar.gz: 3c663fbd9f5f5d14b040eefd4ad7dbe0c8ba58fcd2b5c90445658c3512c1c80a86da8bd91601ad219eb1043764cb5d221f9a35e2f45d5d7feb53398a20f1dc00

data/.github/workflows/tests.yml

@@ -19,16 +19,12 @@ jobs:
           - macos
           - ubuntu
         ruby:
-          - 2.7
           - 3.0
           - 3.1
           - 3.2
+          - 3.3
         allow_failures:
           - false
-        include:
-          - os: ubuntu
-            ruby: ruby-head
-            allow_failures: false
     env:
       BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
       ALLOW_FAILURES: "${{ matrix.allow_failures }}"
@@ -42,5 +38,13 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
-      - name: Test
-        run: bundle exec rake spec || $ALLOW_FAILURES
+      - name: Install Appraisal Dependencies
+        run: bundle exec appraisal install
+      - name: Test with Rails 6.0
+        run: bundle exec appraisal rails-6-0 rake spec
+      - name: Test with Rails 6.1
+        run: bundle exec appraisal rails-6-1 rake spec
+      - name: Test with Rails 7.0
+        run: bundle exec appraisal rails-7-0 rake spec
+      - name: Test with Rails 7.0
+        run: bundle exec appraisal rails-7-0 rake spec

data/.tool-versions

@@ -1 +1 @@
-ruby 3.2.2
+ruby 3.3.0

data/Appraisals

@@ -0,0 +1,15 @@
+appraise 'rails-6-0' do
+  gem 'rails', '~> 6.0'
+end
+
+appraise 'rails-6-1' do
+  gem 'rails', '~> 6.1'
+end
+
+appraise 'rails-7-0' do
+  gem 'rails', '~> 7.0'
+end
+
+appraise 'rails-7-1' do
+  gem 'rails', '~> 7.1'
+end

data/Gemfile.lock

@@ -1,30 +1,180 @@
 PATH
   remote: .
   specs:
-    active_recall (1.8.6)
-      activerecord (>= 5.2.3, <= 7.1)
-      activesupport (>= 5.2.3, <= 7.1)
+    active_recall (2.0.1)
+      activerecord (>= 6.0, <= 7.2)
+      activesupport (>= 6.0, <= 7.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.5.1)
-      activesupport (= 7.0.5.1)
-    activerecord (7.0.5.1)
-      activemodel (= 7.0.5.1)
-      activesupport (= 7.0.5.1)
-    activesupport (7.0.5.1)
+    actioncable (7.1.3)
+      actionpack (= 7.1.3)
+      activesupport (= 7.1.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.3)
+      actionpack (= 7.1.3)
+      activejob (= 7.1.3)
+      activerecord (= 7.1.3)
+      activestorage (= 7.1.3)
+      activesupport (= 7.1.3)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.1.3)
+      actionpack (= 7.1.3)
+      actionview (= 7.1.3)
+      activejob (= 7.1.3)
+      activesupport (= 7.1.3)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.3)
+      actionview (= 7.1.3)
+      activesupport (= 7.1.3)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.3)
+      actionpack (= 7.1.3)
+      activerecord (= 7.1.3)
+      activestorage (= 7.1.3)
+      activesupport (= 7.1.3)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.1.3)
+      activesupport (= 7.1.3)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.3)
+      activesupport (= 7.1.3)
+      globalid (>= 0.3.6)
+    activemodel (7.1.3)
+      activesupport (= 7.1.3)
+    activerecord (7.1.3)
+      activemodel (= 7.1.3)
+      activesupport (= 7.1.3)
+      timeout (>= 0.4.0)
+    activestorage (7.1.3)
+      actionpack (= 7.1.3)
+      activejob (= 7.1.3)
+      activerecord (= 7.1.3)
+      activesupport (= 7.1.3)
+      marcel (~> 1.0)
+    activesupport (7.1.3)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
+    builder (3.2.4)
     concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    date (3.3.4)
     diff-lcs (1.3)
+    drb (2.2.0)
+      ruby2_keywords
+    erubi (1.12.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
+    irb (1.11.1)
+      rdoc
+      reline (>= 0.4.2)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.5)
     minitest (5.18.1)
+    mutex_m (0.2.0)
+    net-imap (0.4.9.1)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.4.0.1)
+      net-protocol
+    nio4r (2.7.0)
+    nokogiri (1.16.0)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    nokogiri (1.16.0-x86_64-linux)
+      racc (~> 1.4)
+    racc (1.7.3)
+    rack (3.0.8)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.1.3)
+      actioncable (= 7.1.3)
+      actionmailbox (= 7.1.3)
+      actionmailer (= 7.1.3)
+      actionpack (= 7.1.3)
+      actiontext (= 7.1.3)
+      actionview (= 7.1.3)
+      activejob (= 7.1.3)
+      activemodel (= 7.1.3)
+      activerecord (= 7.1.3)
+      activestorage (= 7.1.3)
+      activesupport (= 7.1.3)
+      bundler (>= 1.15.0)
+      railties (= 7.1.3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.3)
+      actionpack (= 7.1.3)
+      activesupport (= 7.1.3)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rake (12.3.3)
     rdoc (6.2.0)
+    reline (0.4.2)
+      io-console (~> 0.5)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -38,9 +188,17 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)
+    ruby2_keywords (0.0.5)
     sqlite3 (1.4.2)
+    thor (1.3.0)
+    timeout (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   ruby
@@ -48,6 +206,8 @@ PLATFORMS
 
 DEPENDENCIES
   active_recall!
+  appraisal
+  rails (>= 6.0, <= 7.2)
   rake (>= 12.0)
   rdoc
   rspec (>= 3.0)

data/README.md

@@ -2,7 +2,7 @@
 
 **ActiveRecall** is a spaced-repetition system that allows you to treat arbitrary [ActiveRecord](https://github.com/rails/rails/tree/master/activerecord) models as if they were flashcards to be learned and reviewed.
 It it based on, and is intended to be backwards compatible with, the [okubo](https://github.com/rgravina/okubo) gem.
-The primary differentiating features are that it lets the user specify the scheduling algorithm and is fully compatible with Rails 6+ and Ruby 3+.
+The primary differentiating features are that it lets the user specify the scheduling algorithm and is fully compatible with (and requires) Rails 6+ and Ruby 3+.
 
 ## Installation
 
@@ -35,7 +35,7 @@ ActiveRecall.configure do |config|
   config.algorithm_class = ActiveRecall::FibonacciSequence
 end
 ```
-Algorithms include `FibonacciSequence`, `LeitnerSystem`, and `SoftLeitnerSystem`.
+Algorithms include `FibonacciSequence`, `LeitnerSystem`, `SoftLeitnerSystem`, and `SM2` (see [here](https://en.wikipedia.org/wiki/SuperMemo#Description_of_SM-2_algorithm)).
 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:
@@ -59,7 +59,7 @@ You can add words and record attempts to guess the word as right or wrong. Vario
 user.words << word
 user.words.untested #=> [word]
 
-# Guessing a word correctly
+# Guessing a word correctly (when using a binary algorithm)
 user.right_answer_for!(word)
 user.words.known #=> [word]
 
@@ -93,6 +93,16 @@ user.right_answer_for!(word)
 user.words.expired #=> [word]
 ```
 
+When using a gradable algorithm (rather than binary) such as the SM2 algorithm, you will need to supply your own grade along with the item:
+```ruby
+grade = 3
+user.score!(grade, word)
+
+# Using the binary-only methods will raise an error
+user.right_answer_for!(word)
+=> ActiveRecall::IncompatibleAlgorithmError
+```
+
 Reviewing
 ---------
 
@@ -118,7 +128,7 @@ user.words.next #=> nil
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.
-Then, run `rake spec` to run the tests.
+Then, run `bin/spec` 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`.

data/active_recall.gemspec

@@ -32,11 +32,13 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency "rails", ">= 6.0", "<= 7.2"
   spec.add_development_dependency "rake", ">= 12.0"
   spec.add_development_dependency "rdoc"
   spec.add_development_dependency "rspec", ">= 3.0"
   spec.add_development_dependency "sqlite3"
-  spec.add_runtime_dependency "activerecord", ">= 5.2.3", "<= 7.1"
-  spec.add_runtime_dependency "activesupport", ">= 5.2.3", "<= 7.1"
-  spec.required_ruby_version = ">= 2.6"
+  spec.add_runtime_dependency "activerecord", ">= 6.0", "<= 7.2"
+  spec.add_runtime_dependency "activesupport", ">= 6.0", "<= 7.2"
+  spec.required_ruby_version = ">= 3.0"
 end

data/bin/setup

@@ -4,3 +4,4 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
+bundle exec appraisal install

data/bin/spec

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+set -eo pipefail
+IFS=$'\n\t'
+set -vx
+
+appraisal=${1:-}
+
+if [ -z "$appraisal" ]; then
+  # Run tests for all appraisals if none is specified
+  bundle exec appraisal rake spec
+else
+  # Run tests for a specific appraisal
+  bundle exec appraisal "$appraisal" rake spec
+fi

data/gemfiles/rails_6_0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 6.0"
+
+gemspec path: "../"

data/gemfiles/rails_6_0.gemfile.lock

@@ -0,0 +1,189 @@
+PATH
+  remote: ..
+  specs:
+    active_recall (2.0.1)
+      activerecord (>= 6.0, <= 7.2)
+      activesupport (>= 6.0, <= 7.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.7.6)
+      actionpack (= 6.1.7.6)
+      activesupport (= 6.1.7.6)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.7.6)
+      actionpack (= 6.1.7.6)
+      activejob (= 6.1.7.6)
+      activerecord (= 6.1.7.6)
+      activestorage (= 6.1.7.6)
+      activesupport (= 6.1.7.6)
+      mail (>= 2.7.1)
+    actionmailer (6.1.7.6)
+      actionpack (= 6.1.7.6)
+      actionview (= 6.1.7.6)
+      activejob (= 6.1.7.6)
+      activesupport (= 6.1.7.6)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.7.6)
+      actionview (= 6.1.7.6)
+      activesupport (= 6.1.7.6)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.7.6)
+      actionpack (= 6.1.7.6)
+      activerecord (= 6.1.7.6)
+      activestorage (= 6.1.7.6)
+      activesupport (= 6.1.7.6)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.7.6)
+      activesupport (= 6.1.7.6)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.7.6)
+      activesupport (= 6.1.7.6)
+      globalid (>= 0.3.6)
+    activemodel (6.1.7.6)
+      activesupport (= 6.1.7.6)
+    activerecord (6.1.7.6)
+      activemodel (= 6.1.7.6)
+      activesupport (= 6.1.7.6)
+    activestorage (6.1.7.6)
+      actionpack (= 6.1.7.6)
+      activejob (= 6.1.7.6)
+      activerecord (= 6.1.7.6)
+      activesupport (= 6.1.7.6)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.7.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    builder (3.2.4)
+    concurrent-ruby (1.2.3)
+    crass (1.0.6)
+    date (3.3.4)
+    diff-lcs (1.5.0)
+    erubi (1.12.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.5)
+    minitest (5.21.2)
+    net-imap (0.4.9.1)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.4.0.1)
+      net-protocol
+    nio4r (2.7.0)
+    nokogiri (1.16.0-arm64-darwin)
+      racc (~> 1.4)
+    psych (5.1.2)
+      stringio
+    racc (1.7.3)
+    rack (2.2.8)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails (6.1.7.6)
+      actioncable (= 6.1.7.6)
+      actionmailbox (= 6.1.7.6)
+      actionmailer (= 6.1.7.6)
+      actionpack (= 6.1.7.6)
+      actiontext (= 6.1.7.6)
+      actionview (= 6.1.7.6)
+      activejob (= 6.1.7.6)
+      activemodel (= 6.1.7.6)
+      activerecord (= 6.1.7.6)
+      activestorage (= 6.1.7.6)
+      activesupport (= 6.1.7.6)
+      bundler (>= 1.15.0)
+      railties (= 6.1.7.6)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (6.1.7.6)
+      actionpack (= 6.1.7.6)
+      activesupport (= 6.1.7.6)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+    rake (13.1.0)
+    rdoc (6.6.2)
+      psych (>= 4.0.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    sprockets (4.2.1)
+      concurrent-ruby (~> 1.0)
+      rack (>= 2.2.4, < 4)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.7.1-arm64-darwin)
+    stringio (3.1.0)
+    thor (1.3.0)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.12)
+
+PLATFORMS
+  arm64-darwin-23
+
+DEPENDENCIES
+  active_recall!
+  appraisal
+  rails (~> 6.0)
+  rake (>= 12.0)
+  rdoc
+  rspec (>= 3.0)
+  sqlite3
+
+BUNDLED WITH
+   2.4.14

data/gemfiles/rails_6_1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 6.1"
+
+gemspec path: "../"