active_recall 1.2.2 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b83f978a503c9b2dc8d75c153fa4442b7b63534f1bbccbb5f18c5d38576e4f9e
-  data.tar.gz: 55be412316a8b2f77854d235fa0e73994efc0463afe5e4c428f253f74e801efd
+  metadata.gz: cfa5de74ed9196b1484d8ff5829edae52adc82d7cec8c5c42b22f5c71abaae2b
+  data.tar.gz: 1e17d2f83a70bdbf4a5e0184bb89cb4f36aab98b94e0210dc9e32ce48b1769ba
 SHA512:
-  metadata.gz: b8deb2e788b721c376f1ce28e49be2e17dc120fcb85cc3fd0eaeb7dd6cf6e4eb609c89766ceefd53e65bc0e8b28425337a09bc3fdedcf57800d295a126520252
-  data.tar.gz: e7b826f752bed82704edc395214bacd80d5fd94e4fe828f8bad563aff8ad571551725d35d687c236f04f7d1930ea064f669a4b012c9e060700ffd1e0df381042
+  metadata.gz: 397d873582d9cd7b6591f1c2bf78888eddca83d7936020acb1d5b4d0b9ede6f9fa211b6a3b800ccb49de13c33c42e23d951bc2d3475e7870f5dd17b40f1d58f6
+  data.tar.gz: 234e542f97ca7f0454f362b59db98dec06c56ed7c93e0ae4654c48e788eb45f95466054ddc75d7862596eb24db2194d5771ff23283e0671523645242429dad88

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: false
+    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.2.2)
-      activerecord (>= 5.2.3)
-      activesupport (>= 5.2.3)
+    active_recall (1.6.1)
+      activerecord (>= 5.2.3, <= 6.1)
+      activesupport (>= 5.2.3, <= 6.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activerecord (6.0.2.1)
-      activemodel (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activesupport (6.0.2.1)
+    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.2)
-    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.7.0)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
-    minitest (5.13.0)
-    rake (10.5.0)
+    minitest (5.14.4)
+    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.6)
-      thread_safe (~> 0.1)
-    zeitwerk (2.2.2)
+    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 and Ruby 3.0.
 
 ## Installation
 
@@ -116,9 +116,12 @@ user.words.next #=> nil
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake 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`. 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

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

@@ -10,7 +10,7 @@ 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

data/lib/active_recall/algorithms/fibonacci_sequence.rb

@@ -2,7 +2,7 @@
 
 module ActiveRecall
   class FibonacciSequence
-    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,
@@ -11,7 +11,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,
@@ -20,7 +20,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/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/deck_methods.rb

@@ -3,10 +3,10 @@
 module ActiveRecall
   module DeckMethods
     def deck
-      d = ActiveRecall::Deck.where(user_id: id, user_type: self.class.name).first_or_create
+      d = ActiveRecall::Deck.find_or_create_by(user_id: id, user_type: self.class.name)
       d.source_class.module_eval do
         def stats
-          ActiveRecall::Item.where(source_id: id, source_type: self.class.name).first
+          ActiveRecall::Item.find_by(source_id: id, source_type: self.class.name)
         end
       end
       d

data/lib/active_recall/item_methods.rb

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

data/lib/active_recall/models/deck.rb

@@ -37,16 +37,19 @@ module ActiveRecall
     end
 
     def delete(source)
-      item = ActiveRecall::Item.new(deck: self, source_id: source.id, source_type: source.class.name)
-      item.destroy
+      ActiveRecall::Item
+        .find_by(deck: self, source_id: source.id, source_type: source.class.name)
+        .destroy
     end
 
+    # OPTIMIZE: Attempt in active record, rather than array of Ruby records
     def review
       %i[untested failed expired].inject([]) do |words, s|
         words += items.send(s).order(random_order_function).map(&:source)
       end
     end
 
+    # OPTIMIZE: Use optimized #review and build only the record to be returned
     def next
       word = nil
       %i[untested failed expired].each do |category|

data/lib/active_recall/models/item.rb

@@ -5,7 +5,6 @@ module ActiveRecall
     self.table_name = 'active_recall_items'
 
     belongs_to :deck
-    belongs_to :source, polymorphic: true
 
     scope :failed, -> { where(['box = ? and last_reviewed is not null', 0]) }
     scope :untested, -> { where(['box = ? and last_reviewed is null', 0]) }
@@ -18,12 +17,16 @@ module ActiveRecall
       where(['box > ? and next_review > ?', 0, current_time])
     end
 
+    def source
+      source_type.constantize.find(source_id)
+    end
+
     def right!
-      update!(algorithm_class.right(scoring_attributes))
+      update!(algorithm_class.right(**scoring_attributes))
     end
 
     def wrong!
-      update!(algorithm_class.wrong(scoring_attributes))
+      update!(algorithm_class.wrong(**scoring_attributes))
     end
 
     private

data/lib/active_recall/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecall
-  VERSION = '1.2.2'
+  VERSION = '1.6.1'
 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.2.2
+  version: 1.6.1
 platform: ruby
 authors:
 - Robert Gravina
 - Jayson Virissimo
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-01-02 00:00:00.000000000 Z
+date: 2021-02-28 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
@@ -148,7 +146,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org/
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -163,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