repetition 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bab3c51f0e4592dd7fc82d9731b58a0fd323ca80
-  data.tar.gz: 524371c1e719cf976ca4986fb3aefed473565725
+SHA256:
+  metadata.gz: 395411bf8918658d462f941a292cf0ed689987505f30c13e31843fad1e45e38a
+  data.tar.gz: bc4232618f5ebde02ee0b6c63daf4b21217a43bb9aa29a8230279f374bd9d67c
 SHA512:
-  metadata.gz: 0a3cbbabf457be18665be1c8f52f1867d109711f8c740e5ada8df8339dd74eca10c5189346cae00241793611d26582201c8f6f4da31c5d6c48f2947f33cbbe88
-  data.tar.gz: 813ad91b742549a0c9c9478cfaf7b0f9082032440919c1b3c7745040bd89f2bc62e1dc70619c44103cfa2293a64f4b11a97a121aa69565e3c2a83472f11e610e
+  metadata.gz: b0b276d0d13d1515c656b967a397ad89bcf50925c66920a7f1daf65eda1ef8136b021e44ed6751b748dc2da4b9db7a9fa8d0a2037cc3f578a431729448ab8276
+  data.tar.gz: e1bb3c765debf1b8b1acafdb75e9477581d36d9ba4d062c408d1e31d63a164088798cf9a9c76a740fb89fab9fb7382bc75198c12c8219b9331cc560962d4f7a7

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [2.0.0] - 2018-08-08
+### Changed
+- Move from module to class implementation
+- Test with Minitest instead of RSpec
+
+## [1.0.1] - 2017-04-10
+### Changed
+- Move code into a Bundler style gem package
+- Update gemspec
+- Update dependencies
+
+### Fixed
+- Require date for non-Rails projects
+
+## [1.0.0] - 2014-06-14
+### Added
+- Initial release

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
 # Specify your gem's dependencies in repetition.gemspec
 gemspec

data/LICENSE.TXT

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Dan Kim
+
+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

@@ -1,70 +1,43 @@
-# Repetition gem
-Spaced repetition module which can be used as a mixin in Ruby apps. SuperMemo 2 is used as a repetition algorithm.
-
-### Installation
-Add to your Gemfile
-
-    gem 'repetition'
+# Repetition
 
-or install from RubyGems
-
-    gem install repetition
+Spaced repetition module which can be used as a mixin in Ruby apps. SuperMemo 2 is used as a repetition algorithm.
 
+## Installation
 
-### Rails
+Add this line to your application's Gemfile:
 
-Create a migration to add the new fields to your model.
 ```ruby
-change_table :cards do |t|
-  t.decimal :easiness_factor, precision: 2, scale: 1, default: 2.5, null: false
-  t.integer :number_repetitions, default: 0, null: false
-  t.integer :quality_of_last_recall
-  t.date :next_repetition
-  t.integer :repetition_interval
-  t.date :last_studied
-end
+gem 'repetition'
 ```
 
-### Usage
-Include module in your class or ActiveRecord model
-```ruby
-class Card < ActiveRecord::Base
-  # some code
-  include Repetition
-end
-```
+And then execute:
 
-This will add a bunch of properties to your model:
-* easyness_factor
-* number_repetitions
-* quality_of_last_recall
-* next_repetition
-* repetition_interval
-* last_studied
+    $ bundle
 
-Make sure that appropriate fields are created in your database using migrations
+Or install it yourself as:
 
-You can now use all methods that are provided by gem, use `process_recall_result(quality)` method to update next repetition date. Method takes one argument which should be integer in range from 0 to 5 (0 - again, 5 - perfect).
-```ruby
-card = Card.first
-card.reset_spaced_repetition_data # Reset data for first use
+    $ gem install repetition
 
-card.next_repetition # => nil
-card.process_recall_result(4)
+## Usage
 
-card.repetition_interval # => 1
-card.next_repetition # Tomorrow
-card.save # Don't forget to save your card!
+```ruby
+# Default values are provided
+repetition = Repetition::Flashcard.new(easiness_factor: 2.5, interval: 0, repetitions: 0)
+# Quality of recall: 0..5
+# Returns: date of the next recall => <Date: 2018-08-09>
+repetition.recall(4)
 ```
 
-### Changelog
-#### 1.0
-* Initial version
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
 
-### Running Specs
+## Contributing
 
-`bundle exec rake`
+Bug reports and pull requests are welcome on GitHub at https://github.com/dankimio/repetition.
 
-### Contributing
-Contributions are welcome! Feel free to post issues and create pull requests.
+## License
 
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,6 +1,10 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
-RSpec::Core::RakeTask.new(:spec)
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
 
-task :default => :spec
+task default: :test

data/bin/console

@@ -1,14 +1,14 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "repetition"
+require 'bundler/setup'
+require 'repetition'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
+# require 'pry'
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/repetition.rb

@@ -1,59 +1,70 @@
-require 'repetition/version'
+#
+# The Repetition module uses the Super Memo method to determine when to next
+# review an item. The quality values are as follows:
+#
+# 5 - perfect response
+# 4 - correct response after a hesitation
+# 3 - correct response recalled with serious difficulty
+# 2 - incorrect response; where the correct one seemed easy to recall
+# 1 - incorrect response; the correct one remembered
+# 0 - complete blackout
+#
+# Find out more here: https://www.supermemo.com/english/ol/sm2.htm
+#
 
 require 'date'
 
 module Repetition
-  def reset_spaced_repetition_data
-    self.easiness_factor = 2.5
-    self.number_repetitions = 0
-    self.quality_of_last_recall = nil
-    self.repetition_interval = nil
-    self.next_repetition = nil
-    self.last_studied = nil
-  end
+  class Flashcard
+    attr_reader :easiness_factor, :interval, :repetitions
 
-  def process_recall_result(quality_of_recall)
-    unless (1..5).include?(quality_of_recall)
-      raise 'Invalid quality of recall. Should be in range from 1 to 5.'
+    def initialize(easiness_factor: 2.5, interval: 0, repetitions: 0)
+      @easiness_factor = easiness_factor
+      @interval = interval
+      @repetitions = repetitions
     end
 
-    if quality_of_recall < 3
-      self.number_repetitions = 0
-      self.repetition_interval = 0
-    else
-      self.easiness_factor = calculate_easiness_factor(easiness_factor, quality_of_recall)
+    def recall(quality)
+      raise ArgumentError, 'Invalid quality of recall. Should be in range from 0 to 5.' unless (0..5).cover?(quality)
 
-      if quality_of_recall == 3
-        self.repetition_interval = 0
+      if quality < 3
+        # An incorrect recall is reset back to the beginning
+        @repetitions = 0
+        @interval = 0
+      elsif quality == 3
+        # The item was correctly recalled but should be tested again quickly
+        @interval = 0
       else
-        self.number_repetitions += 1
+        # The item was correctly recalled and we can review later on
+        @repetitions += 1
 
-        case number_repetitions
+        case @repetitions
         when 1
-          self.repetition_interval = 1
+          @interval = 1
         when 2
-          self.repetition_interval = 6
+          @interval = 6
         else
-          self.repetition_interval = repetition_interval * easiness_factor
+          @easiness_factor = calculate_easiness_factor(@easiness_factor, quality)
+          @interval = interval * easiness_factor
         end
       end
-    end
 
-    self.next_repetition = Date.today + repetition_interval
-    self.last_studied = Date.today
-  end
+      due_on
+    end
 
-  def scheduled_to_recall?
-    !next_repetition.nil? && next_repetition <= Date.today
-  end
+    def due_on
+      today + @interval
+    end
 
-  private
+    private
 
-  def calculate_easiness_factor(easiness_factor, quality_of_recall)
-    q = quality_of_recall
-    ef_old = easiness_factor
+    def today
+      @today ||= Date.today
+    end
 
-    result = ef_old - 0.8 + (0.28 * q) - (0.02 * q * q)
-    result < 1.3 ? 1.3 : result
+    def calculate_easiness_factor(easiness_factor, quality)
+      result = easiness_factor - 0.8 + (0.28 * quality) - (0.02 * quality * quality)
+      result < 1.3 ? 1.3 : result
+    end
   end
 end

data/lib/repetition/version.rb

@@ -1,3 +1,3 @@
 module Repetition
-  VERSION = '1.0.2'
+  VERSION = '2.0.0'
 end

data/repetition.gemspec

@@ -1,25 +1,24 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'repetition/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "repetition"
+  spec.name          = 'repetition'
   spec.version       = Repetition::VERSION
-  spec.authors       = ["Dan Kim"]
-  spec.email         = ["itsdanya@gmail.com"]
+  spec.authors       = ['Dan Kim']
+  spec.email         = ['itsdanya@gmail.com']
 
-  spec.summary       = %q{Spaced repetition algorithm}
-  spec.description   = %q{Spaced repetition algorithm module that can be used as a mixin in Ruby apps}
-  spec.homepage      = "http://github.com/danyakim/repetition"
-  spec.license       = "MIT"
+  spec.summary       = 'Spaced repetition algorithm'
+  spec.description   = 'Spaced repetition algorithm module that can be used as a mixin in Ruby apps'
+  spec.homepage      = 'http://github.com/danyakim/repetition'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 11.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 11.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: repetition
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Dan Kim
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-10 00:00:00.000000000 Z
+date: 2018-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '11.0'
 description: Spaced repetition algorithm module that can be used as a mixin in Ruby
   apps
 email:
@@ -61,7 +61,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- LICENSE.TXT
 - README.md
 - Rakefile
 - bin/console
@@ -89,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Spaced repetition algorithm