active_recall 1.1.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f26bb57ebefa4026475f96a4e9df6051990de46bb131ff38f6a8cb5536d30b1
-  data.tar.gz: 439d4544a42ebfd704686ea81bcc7f32242ef3e4828772fed2cc77843d014d8c
+  metadata.gz: 4569fb2091dedb5e74e5b52969bccda5a63dafcce224d794d2c9f1685a943a87
+  data.tar.gz: 3efab95a63e1c777e1b4e20c436752490b18f12394a8e1e01380e2ee04fadefd
 SHA512:
-  metadata.gz: 6eade4d6980383d43077857517aaec84b287953567860b7c3f9c5b0ba414f3ed9d1ac43c2e4747147f2b7689edcbf8daa7e5c6829b8b1ed90f56b74bfa560987
-  data.tar.gz: 6d77b4755a8eef49319d17b3f2d0e285dca85ad53c51553f9783761b7c8ec0cd1cde86ec69170d0efecefb8a39f893c04a35ba81eab42cb72542689ca9f82578
+  metadata.gz: bff87655e7cd1968ae406995a500651500cd5997205adb026da4f3fe454cdbbdf2f0954cf8259cbe02c0c21045dcc8aa479cc2b2a7ab51f41a971669cbc6bcdd
+  data.tar.gz: 7e04ae7f856dfc2b1f3e86d560329a443726c4d163f5b0f80518385fc847fa3f593baea926632bc9ba5d951c890a23375861a0bafb877374202bdb83a944804e

data/.github/workflows/tests.yml

@@ -0,0 +1,46 @@
+name: Tests 
+
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+
+jobs:
+  unit_tests:
+    name: Unit Tests
+    if: "contains(github.event.commits[0].message, '[ci skip]') == false"
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - macos 
+          - ubuntu
+        ruby:
+          - 2.5
+          - 2.6
+          - 2.7
+          - 3.0
+        allow_failures:
+          - false
+        include:
+          - os: ubuntu
+            ruby: ruby-head
+            allow_failures: true
+    env:
+      BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
+      ALLOW_FAILURES: "${{ matrix.allow_failures }}"
+    runs-on: ${{ matrix.os }}-latest
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Test
+        run: bundle exec rake spec || $ALLOW_FAILURES

data/.ruby-version

@@ -1 +1 @@
-2.5.3
+3.0.0

data/Gemfile

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
-ruby '2.5.3'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 

data/Gemfile.lock

@@ -1,30 +1,30 @@
 PATH
   remote: .
   specs:
-    active_recall (1.1.0)
-      activerecord (>= 5.2.3)
-      activesupport (>= 5.2.3)
+    active_recall (1.4.0)
+      activerecord (>= 5.2.3, <= 6.1)
+      activesupport (>= 5.2.3, <= 6.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.0)
-      activesupport (= 6.0.0)
-    activerecord (6.0.0)
-      activemodel (= 6.0.0)
-      activesupport (= 6.0.0)
-    activesupport (6.0.0)
+    activemodel (6.1.0)
+      activesupport (= 6.1.0)
+    activerecord (6.1.0)
+      activemodel (= 6.1.0)
+      activesupport (= 6.1.0)
+    activesupport (6.1.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
-    concurrent-ruby (1.1.5)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.8)
     diff-lcs (1.3)
-    i18n (1.6.0)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
-    minitest (5.11.3)
-    rake (10.5.0)
+    minitest (5.14.3)
+    rake (12.3.3)
     rdoc (6.2.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -39,25 +39,20 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)
-    sqlite3 (1.4.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    zeitwerk (2.1.10)
+    sqlite3 (1.4.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   active_recall!
-  bundler (>= 1.16)
-  rake (~> 10.0)
+  rake (~> 12.0)
   rdoc
   rspec (~> 3.0)
   sqlite3
 
-RUBY VERSION
-   ruby 2.5.3p105
-
 BUNDLED WITH
-   1.17.3
+   2.2.3

data/README.md

@@ -1,8 +1,8 @@
-# ActiveRecall [![Build Status](https://travis-ci.org/jaysonvirissimo/active_recall.svg?branch=master)](https://travis-ci.org/jaysonvirissimo/active_recall)
+# ActiveRecall
 
 **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.
+The primary differentiating features are that it lets the user specify the scheduling algorithm and is fully compatible with Rails 6.0.
 
 ## Installation
 
@@ -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/active_recall.gemspec

@@ -32,11 +32,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '>= 1.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  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'
-  spec.add_runtime_dependency 'activesupport', '>= 5.2.3'
+  spec.add_runtime_dependency 'activerecord', '>= 5.2.3', '<= 6.1'
+  spec.add_runtime_dependency 'activesupport', '>= 5.2.3', '<= 6.1'
 end

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)
+ActiveRecord::Base.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:, 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
+      {
+        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/algorithms/leitner_system.rb

@@ -4,7 +4,7 @@ module ActiveRecall
   class LeitnerSystem
     DELAYS = [3, 7, 14, 30, 60, 120, 240].freeze
 
-    def self.right(box:, current_time: Time.current, times_right:, times_wrong:)
+    def self.right(box:, times_right:, times_wrong:, current_time: Time.current)
       new(
         box: box,
         current_time: current_time,
@@ -13,7 +13,7 @@ module ActiveRecall
       ).right
     end
 
-    def self.wrong(box:, current_time: Time.current, times_right:, times_wrong:)
+    def self.wrong(box:, times_right:, times_wrong:, current_time: Time.current)
       new(
         box: box,
         current_time: current_time,
@@ -22,7 +22,7 @@ module ActiveRecall
       ).wrong
     end
 
-    def initialize(box:, current_time: Time.current, times_right:, times_wrong:)
+    def initialize(box:, times_right:, times_wrong:, current_time: Time.current)
       @box = box
       @current_time = current_time
       @times_right = times_right

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/deck_methods.rb

@@ -13,8 +13,9 @@ module ActiveRecall
     end
 
     def remove_deck
-      deck = ActiveRecall::Deck.where(user_id: id, user_type: self.class.name).first
-      deck.destroy
+      ActiveRecall::Deck
+        .where(user_id: id, user_type: self.class.name)
+        .destroy_all
     end
   end
 end

data/lib/active_recall/item_methods.rb

@@ -3,13 +3,13 @@
 module ActiveRecall
   module ItemMethods
     def right_answer_for!(item)
-      i = deck.items.where(source_id: item.id).first
+      i = deck.items.find_by(source_id: item.id)
       i.right!
       i.save!
     end
 
     def wrong_answer_for!(item)
-      i = deck.items.where(source_id: item.id).first
+      i = deck.items.find_by(source_id: item.id)
       i.wrong!
       i.save!
     end

data/lib/active_recall/models/item.rb

@@ -3,10 +3,11 @@
 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])
@@ -16,16 +17,24 @@ module ActiveRecall
       where(['box > ? and next_review > ?', 0, current_time])
     end
 
+    def source
+      source_type.constantize.find(source_id)
+    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.4.0'
 end

data/lib/generators/active_recall/active_recall_generator.rb

@@ -20,9 +20,7 @@ class ActiveRecallGenerator < Rails::Generators::Base
   def create_migration_files
     create_migration_file_if_not_exist 'create_active_recall_tables'
     create_migration_file_if_not_exist 'add_active_recall_item_answer_counts'
-    if options['migrate_data']
-      create_migration_file_if_not_exist 'migrate_okubo_to_active_recall'
-    end
+    create_migration_file_if_not_exist 'migrate_okubo_to_active_recall' if options['migrate_data']
   end
 
   private

metadata

@@ -1,44 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: active_recall
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Robert Gravina
 - Jayson Virissimo
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-09-17 00:00:00.000000000 Z
+date: 2021-02-19 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +74,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.3
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -95,6 +84,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.3
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +94,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.3
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -109,6 +104,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.3
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6.1'
 description: A spaced-repetition system to be used with ActiveRecord models
 email:
 - robert.gravina@gmail.com
@@ -117,10 +115,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -130,8 +128,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
@@ -146,7 +146,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org/
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -161,9 +161,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: A spaced-repetition system
 test_files: []

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.3
-before_install: gem install bundler -v 1.17.3