active_recall 1.6.3 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e993b98e9627ec06e8eae73c3fba15a6ed761b66dbb1092b1355140cb2bd366
-  data.tar.gz: 5402a3ae205e52b20587ab73a5d819eaf7102dea5d52cf983e4be5beddf5279d
+  metadata.gz: 06e8582ffde66de89e30751aa0f170dfd77d83f4d3e14e200aec66b3acb48683
+  data.tar.gz: 80614546c9e7235846cd580bb76ab7aebea90945e35d484a4e50ab6f87a7bb4f
 SHA512:
-  metadata.gz: aba48fb3870fd48fba35a371b48ceeaad4fb306acef718175f67451ee25111ec6389faaf0c52d9424ad1b87da94faf1c24b66f32f920392fa4b7e68ebbb27699
-  data.tar.gz: 2c9c4651bd1e4ac541ffb4c258e899bf311cd84ec6cc4490b643ef1a27bc236c9820e5e30b5af22ee4673413dfad5e0bacbdbcd7344494c9df2059e3472fee17
+  metadata.gz: e68952e966e9201f32ecc43ba64984273ba5bb0cf741eedf3b9c8625c9a55829bfe19f3fc0e3ea6b333354a38cc053d3ea89272b6f0e1ea340d7eb84e12bdc0d
+  data.tar.gz: ed5fb58e109bc17333a7e4484b22f55e76eaf77c5f81513168613f834418c19bc9cc4d5de5e1a3889bc1fd1120a9c4c443c228ba727b060594a97fde0ac8e893

data/.github/workflows/tests.yml

@@ -19,8 +19,6 @@ jobs:
           - macos 
           - ubuntu
         ruby:
-          - 2.5
-          - 2.6
           - 2.7
           - 3.0
         allow_failures:

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.0.2

data/Gemfile

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

data/Gemfile.lock

@@ -1,29 +1,28 @@
 PATH
   remote: .
   specs:
-    active_recall (1.6.3)
-      activerecord (>= 5.2.3, <= 6.2)
-      activesupport (>= 5.2.3, <= 6.2)
+    active_recall (1.8.0)
+      activerecord (>= 5.2.3, <= 7.1)
+      activesupport (>= 5.2.3, <= 7.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.4)
-      activesupport (= 6.1.4)
-    activerecord (6.1.4)
-      activemodel (= 6.1.4)
-      activesupport (= 6.1.4)
-    activesupport (6.1.4)
+    activemodel (7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activerecord (7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activesupport (7.0.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.2.2)
     diff-lcs (1.3)
-    i18n (1.8.10)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.4)
+    minitest (5.18.0)
     rake (12.3.3)
     rdoc (6.2.0)
     rspec (3.8.0)
@@ -40,9 +39,8 @@ GEM
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)
     sqlite3 (1.4.2)
-    tzinfo (2.0.4)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -55,4 +53,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.2.3
+   2.2.22

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/active_recall.gemspec

@@ -1,26 +1,26 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'active_recall/version'
+require "active_recall/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'active_recall'
-  spec.version       = ActiveRecall::VERSION
-  spec.authors       = ['Robert Gravina', 'Jayson Virissimo']
-  spec.email         = ['robert.gravina@gmail.com', 'jayson.virissimo@asu.edu']
-  spec.summary       = 'A spaced-repetition system'
-  spec.description   = 'A spaced-repetition system to be used with ActiveRecord models'
-  spec.homepage      = 'https://github.com/jaysonvirissimo/active_recall'
-  spec.license       = 'MIT'
+  spec.name = "active_recall"
+  spec.version = ActiveRecall::VERSION
+  spec.authors = ["Robert Gravina", "Jayson Virissimo"]
+  spec.email = ["robert.gravina@gmail.com", "jayson.virissimo@asu.edu"]
+  spec.summary = "A spaced-repetition system"
+  spec.description = "A spaced-repetition system to be used with ActiveRecord models"
+  spec.homepage = "https://github.com/jaysonvirissimo/active_recall"
+  spec.license = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
   else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
   end
 
   # Specify which files should be added to the gem when it is released.
@@ -28,14 +28,15 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  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', '<= 6.2'
-  spec.add_runtime_dependency 'activesupport', '>= 5.2.3', '<= 6.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"
 end

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/active_recall/models/deck.rb

@@ -4,9 +4,9 @@ module ActiveRecall
   class Deck < ActiveRecord::Base
     include Enumerable
     include ActiveRecall::Base
-    self.table_name = 'active_recall_decks'
+    self.table_name = "active_recall_decks"
     belongs_to :user, polymorphic: true
-    has_many :items, class_name: 'ActiveRecall::Item', dependent: :destroy
+    has_many :items, class_name: "ActiveRecall::Item", dependent: :destroy
 
     def each
       _items.each do |item|
@@ -27,7 +27,7 @@ module ActiveRecall
     end
 
     def <<(source)
-      raise ArgumentError, 'Word already in the stack' if include?(source)
+      raise ArgumentError, "Word already in the stack" if include?(source)
 
       items << ActiveRecall::Item.new(deck: self, source_id: source.id, source_type: source.class.name)
     end
@@ -42,41 +42,32 @@ module ActiveRecall
         .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
+      source_class.where(id: _review.select(:source_id))
     end
 
-    # OPTIMIZE: Use optimized #review and build only the record to be returned
     def next
-      word = nil
-      %i[untested failed expired].each do |category|
-        word = items.send(category).order(random_order_function).limit(1).map(&:source).first
-        break if word
-      end
-      word
+      _review.first.try(:source)
     end
 
     def last
-      items.order('created_at desc').limit(1).first.try(:source)
+      items.order("created_at desc").limit(1).first.try(:source)
     end
 
     def untested
-      source_class.find(items.untested.pluck(:source_id))
+      source_class.where(id: items.untested.select(:source_id))
     end
 
     def failed
-      source_class.find(items.failed.pluck(:source_id))
+      source_class.where(id: items.failed.select(:source_id))
     end
 
     def known
-      source_class.find(items.known.pluck(:source_id))
+      source_class.where(id: items.known.select(:source_id))
     end
 
     def expired
-      source_class.find(items.expired.pluck(:source_id))
+      source_class.where(id: items.expired.select(:source_id))
     end
 
     def box(number)
@@ -89,12 +80,20 @@ module ActiveRecall
 
     private
 
+    def _review
+      items
+        .untested
+        .or(items.failed)
+        .or(items.expired)
+        .order(random_order_function)
+    end
+
     def random_order_function
-      Arel.sql(mysql? ? 'RAND()' : 'random()')
+      Arel.sql(mysql? ? "RAND()" : "random()")
     end
 
     def mysql?
-      source_class.connection.adapter_name == 'Mysql2'
+      source_class.connection.adapter_name == "Mysql2"
     end
   end
 end

data/lib/active_recall/models/item.rb

@@ -2,19 +2,19 @@
 
 module ActiveRecall
   class Item < ActiveRecord::Base
-    self.table_name = 'active_recall_items'
+    self.table_name = "active_recall_items"
 
     belongs_to :deck
 
-    scope :failed, -> { where(['box = ? and last_reviewed is not null', 0]) }
-    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])
+      where(["box > ? and next_review <= ?", 0, current_time])
     end
 
     def self.known(current_time: Time.current)
-      where(['box > ? and next_review > ?', 0, current_time])
+      where(["box > ? and next_review > ?", 0, current_time])
     end
 
     def source

data/lib/active_recall/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecall
-  VERSION = '1.6.3'
+  VERSION = "1.8.0"
 end

data/lib/active_recall.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-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'
+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.include ActiveRecall::Base
 

data/lib/generators/active_recall/active_recall_generator.rb

@@ -1,26 +1,26 @@
 # frozen_string_literal: true
 
-require 'rails/generators'
-require 'rails/generators/migration'
-require 'rails/generators/active_record'
+require "rails/generators"
+require "rails/generators/migration"
+require "rails/generators/active_record"
 
 class ActiveRecallGenerator < Rails::Generators::Base
   include Rails::Generators::Migration
 
   class_option :migrate_data, type: :boolean, default: false
 
-  desc 'Creates migration files required by the active_recall spaced repetition gem.'
+  desc "Creates migration files required by the active_recall spaced repetition gem."
 
-  source_paths << File.join(File.dirname(__FILE__), 'templates')
+  source_paths << File.join(File.dirname(__FILE__), "templates")
 
   def self.next_migration_number(path)
     ActiveRecord::Generators::Base.next_migration_number(path)
   end
 
   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'
-    create_migration_file_if_not_exist 'migrate_okubo_to_active_recall' if options['migrate_data']
+    create_migration_file_if_not_exist "create_active_recall_tables"
+    create_migration_file_if_not_exist "add_active_recall_item_answer_counts"
+    create_migration_file_if_not_exist "migrate_okubo_to_active_recall" if options["migrate_data"]
   end
 
   private

data/lib/generators/active_recall/templates/create_active_recall_tables.rb

@@ -9,11 +9,11 @@ class CreateActiveRecallTables < ActiveRecord::Migration[5.2]
     add_index :active_recall_decks, %i[user_id user_type]
 
     create_table :active_recall_items do |t|
-      t.references  :deck
-      t.references  :source, polymorphic: true
-      t.integer     :box, default: 0
-      t.timestamp   :last_reviewed
-      t.timestamp   :next_review
+      t.references :deck
+      t.references :source, polymorphic: true
+      t.integer :box, default: 0
+      t.timestamp :last_reviewed
+      t.timestamp :next_review
       t.timestamps
     end
     add_index :active_recall_items, %i[source_id source_type]

data/lib/generators/active_recall/templates/migrate_okubo_to_active_recall.rb

@@ -17,8 +17,8 @@ class MigrateOkuboToActiveRecall < ActiveRecord::Migration[5.2]
         deck_attributes[:id] == item_attributes[:deck_id]
       end.each do |item_attributes|
         item_create_attributes = item_attributes
-                                 .except(:id, :created_at, :updated_at)
-                                 .merge(deck_id: deck.id)
+          .except(:id, :created_at, :updated_at)
+          .merge(deck_id: deck.id)
         ActiveRecall::Item.create!(item_create_attributes)
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_recall
 version: !ruby/object:Gem::Version
-  version: 1.6.3
+  version: 1.8.0
 platform: ruby
 authors:
 - Robert Gravina
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-12 00:00:00.000000000 Z
+date: 2023-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -76,7 +76,7 @@ dependencies:
         version: 5.2.3
     - - "<="
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -86,7 +86,7 @@ dependencies:
         version: 5.2.3
     - - "<="
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -96,7 +96,7 @@ dependencies:
         version: 5.2.3
     - - "<="
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -106,7 +106,7 @@ dependencies:
         version: 5.2.3
     - - "<="
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
 description: A spaced-repetition system to be used with ActiveRecord models
 email:
 - robert.gravina@gmail.com
@@ -118,14 +118,13 @@ files:
 - ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
-- ".ruby-version"
+- ".tool-versions"
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - active_recall.gemspec
-- bin/console
 - bin/setup
 - lib/active_recall.rb
 - lib/active_recall/algorithms/fibonacci_sequence.rb
@@ -154,14 +153,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.5
 signing_key:
 specification_version: 4
 summary: A spaced-repetition system

data/.ruby-version

@@ -1 +0,0 @@
-3.0.0