acts_as_learnable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 24b49c5a5beec988626f52390586b33b40b40ec6
-  data.tar.gz: 38e31cd2da1105c780ae3aee8f081ebf3aba2d33
+SHA256:
+  metadata.gz: 6e65eaf9f25b641df9f9377c40997cadfeec15a64d28686c84ae1c1cb37d44e8
+  data.tar.gz: 5b76d804d68b1e557580b044cd56e93866aa5720544c5867b68be9ded5fd9a45
 SHA512:
-  metadata.gz: 8e7ff740e320e942b5a03a07cf2bd6da9a9dbf885fc964bb12d89fa30d5e6ec7a0a9af7316c617e5cd651dd2b728de6d72f4493656796504f734bc169e9ce9ac
-  data.tar.gz: ce389b6a20c055613ee143946eaab9f04bcf3cad8ade54ec61bad56f45abcab60324c6bea3f2216ada1ab3af30d334c8ef94f7d9c763141373ec6ba4e0f7c3ce
+  metadata.gz: fd561ac48b1c65675addbda453947414e7d063a2d1defc67fbf096658626334576dc36cdb0b125d8ce3b282eb2c918c98649bb260496d07d419c7a418bfe0db1
+  data.tar.gz: 8548a28b5433b4a7a7f0c1bac89377026a9cdcc94b43747ce631e01463fb04062c002f491100d3f58f9b89c37a4bb649a4baaec5ad5b9e5ffed39cc30dcffeeb

data/README.md

@@ -35,9 +35,7 @@ end
 
 It will automatically extend your class with all necessary methods.
 
-Make sure you have the following fields on the model (generators will be added later):
-
-Then you can review items:
+Then you can review flashcards:
 
 ```ruby
 card = Flashcard.create
@@ -51,13 +49,8 @@ card.repetitions # => 1
 
 ## Contributing
 
-1. Fork it ( https://github.com/itsdan/acts_as_learnable/fork )
+1. Fork it ( https://github.com/dankimio/acts_as_learnable/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
-
-## TODO
-
-* More detailed README
-* Other repetition algorithms (Anki)

data/Rakefile

@@ -1,3 +1,4 @@
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|

data/acts_as_learnable.gemspec

@@ -6,23 +6,23 @@ require 'acts_as_learnable/version'
 Gem::Specification.new do |spec|
   spec.name          = 'acts_as_learnable'
   spec.version       = ActsAsLearnable::VERSION
-  spec.authors       = ['Danya Kim']
-  spec.email         = ["itsdanya@gmail.com"]
+  spec.authors       = ['Dan Kim']
+  spec.email         = ['itsdanya@gmail.com']
   spec.summary       = 'A simple way to create flashcards in your app.'
   spec.description   = 'ActsAsLearnable is a Ruby gem for ActiveRecord models. It provides a simple way to create flashcards in your app. It automatically schedules flashcards for review depending on recall quality (1 to 5). You can easily create a Spaced Repetition System (SRS) using this gem.'
-  spec.homepage      = 'http://github.com/itsdan/acts_as_learnable'
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/itsdn/acts_as_learnable'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency 'activerecord', '~> 4.0'
-  spec.add_dependency 'activesupport', '~> 4.0'
+  spec.add_dependency 'activerecord', '>= 5.2'
+  spec.add_dependency 'activesupport', '>= 5.2'
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'sqlite3', '~> 1.3'
-  spec.add_development_dependency 'byebug', '~> 4.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'byebug'
 end

data/lib/acts_as_learnable/base.rb

@@ -15,7 +15,7 @@ module ActsAsLearnable
 
   module InstanceMethods
     def review(recall_quality)
-      fail unless (1..5).include?(recall_quality)
+      raise unless (1..5).include?(recall_quality)
 
       # If the quality of response was lower than 3, then start repetitions from the beginning
       reset and return if recall_quality <= 2
@@ -65,13 +65,12 @@ module ActsAsLearnable
 
     # Update interval according to the formula
     def update_interval
-      # TODO: Extract magic numbers
       self.interval =
         case repetitions
         when 1 then 1
         when 2 then 6
         else
-          interval(repetitions - 1) * easiness_factor
+          (repetitions - 1) * easiness_factor
         end
     end
 

data/lib/acts_as_learnable/version.rb

@@ -1,3 +1,3 @@
 module ActsAsLearnable
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'.freeze
 end

data/lib/acts_as_learnable.rb

@@ -1,10 +1,7 @@
 require 'active_record'
 require 'acts_as_learnable/base'
-require 'byebug'
 
 module ActsAsLearnable
   # Extend ActiveRecord if defined
-  if defined?(ActiveRecord::Base)
-    ActiveRecord::Base.extend(ActsAsLearnable::Base)
-  end
+  ActiveRecord::Base.extend(ActsAsLearnable::Base) if defined?(ActiveRecord::Base)
 end

data/lib/generators/flashcard/flashcard_generator.rb

@@ -6,16 +6,19 @@ class FlashcardGenerator < ActiveRecord::Generators::Base
 
   desc 'This generator creates a migration file with flashcard fields.'
 
-  source_root File.expand_path('../templates', __FILE__)
+  source_root File.expand_path('templates', __dir__)
 
   def install_flashcards
-    if File.exist?("#{destination_root}/db/schema.rb") &&
-       File.read("#{destination_root}/db/schema.rb") =~ /create_table \"#{table_name}\"/
-      migration_template(
-        'add_fields_migration.rb',
-        "db/migrate/add_flashcard_fields_to_#{table_name}.rb")
+    if schema_exists? && File.read("#{destination_root}/db/schema.rb") =~ /create_table "#{table_name}"/
+      migration_template('add_fields_migration.rb', "db/migrate/add_flashcard_fields_to_#{table_name}.rb")
     else
       migration_template('create_table_migration.rb', "db/migrate/create_#{table_name}.rb")
     end
   end
+
+  private
+
+  def schema_exists?
+    File.exist?("#{destination_root}/db/schema.rb")
+  end
 end

data/lib/generators/flashcard/templates/add_fields_migration.rb

@@ -1,17 +1,9 @@
 class <%= @migration_class_name %> < ActiveRecord::Migration
-  def self.up
+  def change
     add_column :<%= table_name %>, :easiness_factor, :float,   default: 2.5
-    add_column :<%= table_name %>, :repetitions,     :integer, default: 0
-    add_column :<%= table_name %>, :interval,        :integer, default: 0
-    add_column :<%= table_name %>, :due,             :date,    default: nil
-    add_column :<%= table_name %>, :studied_at,      :date,    default: nil
-  end
-
-  def self.down
-    remove_column :<%= table_name %>, :easiness_factor
-    remove_column :<%= table_name %>, :repetitions
-    remove_column :<%= table_name %>, :interval
-    remove_column :<%= table_name %>, :due
-    remove_column :<%= table_name %>, :studied_at
+    add_column :<%= table_name %>, :repetitions, :integer, default: 0
+    add_column :<%= table_name %>, :interval, :integer, default: 0
+    add_column :<%= table_name %>, :due, :date, default: nil
+    add_column :<%= table_name %>, :studied_at, :date, default: nil
   end
 end

data/lib/generators/flashcard/templates/create_table_migration.rb

@@ -1,15 +1,11 @@
 class <%= @migration_class_name %> < ActiveRecord::Migration
-  def self.up
-    create_table '<%= table_name %>' do |t|
-      t.column :easiness_factor, :float,   default: 2.5
-      t.column :repetitions,     :integer, default: 0
-      t.column :interval,        :integer, default: 0
-      t.column :due,             :date,    default: nil
-      t.column :studied_at,      :date,    default: nil
+  def change
+    create_table :<%= table_name %> do |t|
+      t.column :easiness_factor, :float, default: 2.5
+      t.column :repetitions, :integer, default: 0
+      t.column :interval, :integer, default: 0
+      t.column :due, :date, default: nil
+      t.column :studied_at, :date, default: nil
     end
   end
-
-  def self.down
-    drop_table '<%= table_name %>'
-  end
 end

data/test/test_helper.rb

@@ -18,7 +18,7 @@ def setup_db
 end
 
 def teardown_db
-  ActiveRecord::Base.connection.tables.each do |table|
+  ActiveRecord::Base.connection.data_sources.each do |table|
     ActiveRecord::Base.connection.drop_table(table)
   end
 end

metadata

@@ -1,99 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_learnable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
-- Danya Kim
-autorequire: 
+- Dan Kim
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-03-31 00:00:00.000000000 Z
+date: 2022-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
 description: ActsAsLearnable is a Ruby gem for ActiveRecord models. It provides a
   simple way to create flashcards in your app. It automatically schedules flashcards
   for review depending on recall quality (1 to 5). You can easily create a Spaced
@@ -118,11 +118,11 @@ files:
 - lib/generators/flashcard/templates/create_table_migration.rb
 - test/test_base.rb
 - test/test_helper.rb
-homepage: http://github.com/itsdan/acts_as_learnable
+homepage: https://github.com/itsdn/acts_as_learnable
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,9 +137,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A simple way to create flashcards in your app.
 test_files: