acts_as_learnable 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9092717ab1468252ea8a8cf91d265ec3e8027fbd
+  data.tar.gz: f079169cecead415c0f71e22f4b217bd76c592a9
+SHA512:
+  metadata.gz: a7da136b1d6a9289f4757ec0547adadbff6c4099b2d5182396d63e8a85cd07e8d354c233e3e82a47204cf86d96a013a04e2047111041558bd1714ec8865f2c62
+  data.tar.gz: 3ec4488330cda7f47dd0c46fe8fdfb29963180d4e5341d0bde9bdea58d05fb71ccfa1268aa51153a8784e29ee4901cdc255c4bf2af8cee0a2aaa5ffbd2ec688d

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acts_as_learnable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Danya Kim
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# ActsAsLearnable
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'acts_as_learnable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_learnable
+
+## Usage
+
+Within your model call `acts_as_learnable` method:
+
+```ruby
+class Flashcard < ActiveRecord::Base
+  acts_as_learnable
+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):
+
+```ruby
+ActiveRecord::Schema.define(version: 1) do
+  create_table :flashcards do |t|
+    t.float :easiness_factor, default: 2.5
+    t.integer :repetitions, default: 0
+    t.integer :interval, default: 0
+    t.date :due, default: nil
+    t.date :studied_at, default: nil
+  end
+end
+```
+
+Then you can review items:
+
+```ruby
+card = Flashcard.create
+card.review(4)   # => Recall quality from 1 (bad) to 5 (perfect)
+card.due_today?  # => false
+card.due         # => 2015-03-11
+card.studied_at  # => 2015-03-10
+card.interval    # => 1
+card.repetitions # => 1
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/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
+
+* Migration generators
+* More detailed README
+* Other repetition algorithms (Anki)

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+end
+
+task default: :test

data/acts_as_learnable.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+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.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.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.add_dependency 'activerecord'
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler', "~> 1.7"
+  spec.add_development_dependency 'rake', "~> 10.0"
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'byebug'
+end

data/lib/acts_as_learnable/base.rb

@@ -0,0 +1,84 @@
+module ActsAsLearnable
+  module Base
+    def acts_as_learnable
+      class_eval do
+        include ActsAsLearnable::InstanceMethods
+      end
+    end
+  end
+
+  module ClassMethods
+    def acts_as_learnable?
+      true
+    end
+  end
+
+  module InstanceMethods
+    def review(recall_quality)
+      fail 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
+
+      # Calculate new easiness factor
+      update_easiness_factor(recall_quality)
+
+      # Repeat all items that scored below 4
+      if recall_quality == 3
+        self.interval = 0
+      else
+        # Otherwise, increment repetitions count and set new interval
+        self.repetitions += 1
+        update_interval
+      end
+
+      schedule_repetition
+      save
+    end
+
+    def due_today?
+      due.nil? || due <= Date.today
+    end
+
+    private
+
+    # Bad recall quality, start over
+    def reset
+      self.repetitions = 0
+      self.interval = 0
+      self.due = Date.today
+      self.studied_at = Date.today
+      save
+    end
+
+    # Calculates and updates easiness factor
+    def update_easiness_factor(quality)
+      new_easiness_factor = calculate_easiness_factor(quality)
+      # If EF is less than 1.3 then let EF be 1.3
+      self.easiness_factor = new_easiness_factor < 1.3 ? 1.3 : new_easiness_factor
+    end
+
+    # Calculates new easiness factor according to the formula
+    def calculate_easiness_factor(quality)
+      easiness_factor + (0.1 - (5 - quality) * (0.08 + (5 - quality) * 0.02))
+    end
+
+    # 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
+        end
+    end
+
+    # Update next repetition date, set studied_at to today
+    def schedule_repetition
+      self.due = Date.today + interval
+      self.studied_at = Date.today
+    end
+  end
+end

data/lib/acts_as_learnable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsLearnable
+  VERSION = '0.0.2'
+end

data/lib/acts_as_learnable.rb

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

data/test/test_base.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+
+class BaseTest < MiniTest::Test
+  def setup
+    setup_db
+    @card = Flashcard.create
+  end
+
+  def test_valid
+    assert @card.valid?
+    assert @card.due_today?
+    assert_equal 2.5, @card.easiness_factor
+    assert_equal 0, @card.repetitions
+    assert_equal 0, @card.interval
+    assert_nil @card.due
+    assert_nil @card.studied_at
+  end
+
+  def test_incorrect_response
+    @card.review(1)
+    assert @card.due_today?
+    assert_equal Date.today, @card.due
+    assert_equal 0, @card.repetitions
+
+    @card.review(2)
+    assert @card.due_today?
+    assert_equal Date.today, @card.due
+    assert_equal 0, @card.repetitions
+  end
+
+  def test_correct_response
+    # Recalled with serious difficulty
+    @card.review(3)
+    assert @card.due_today?
+    assert_equal Date.today, @card.due
+    assert_equal 0, @card.repetitions
+
+    # Response after hesitation
+    @card.review(4)
+    refute @card.due_today?
+    assert_equal Date.today + 1, @card.due
+    assert_equal 1, @card.repetitions
+
+    # Perfect response
+    refute @card.due_today?
+    @card.review(5)
+    assert_equal Date.today + 6, @card.due
+    assert_equal 2, @card.repetitions
+  end
+
+  def test_flow
+    # Review two times
+    @card.review(4)
+    @card.review(4)
+
+    assert_equal 2, @card.repetitions
+    assert_equal 6, @card.interval
+    assert_equal Date.today, @card.studied_at
+    assert_equal Date.today + 6, @card.due
+    assert_in_delta @card.easiness_factor, 2.5, 0.01
+    refute @card.due_today?
+  end
+
+  def teardown
+    teardown_db
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,28 @@
+require 'minitest/autorun'
+require 'sqlite3'
+require 'active_record'
+require 'acts_as_learnable'
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+
+def setup_db
+  ActiveRecord::Schema.define(version: 1) do
+    create_table :flashcards do |t|
+      t.float :easiness_factor, default: 2.5
+      t.integer :repetitions, default: 0
+      t.integer :interval, default: 0
+      t.date :due, default: nil
+      t.date :studied_at, default: nil
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class Flashcard < ActiveRecord::Base
+  acts_as_learnable
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_learnable
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Danya Kim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        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
+  Repetition System (SRS) using this gem.
+email:
+- itsdanya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_learnable.gemspec
+- lib/acts_as_learnable.rb
+- lib/acts_as_learnable/base.rb
+- lib/acts_as_learnable/version.rb
+- lib/generators/acts_as_learnable/USAGE
+- lib/generators/acts_as_learnable/templates/add_fields_migration.rb
+- lib/generators/acts_as_learnable/templates/create_table_migration.rb
+- test/test_base.rb
+- test/test_helper.rb
+homepage: http://github.com/itsdan/acts_as_learnable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A simple way to create flashcards in your app.
+test_files:
+- test/test_base.rb
+- test/test_helper.rb