repetition 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89fa95239d478362f8cab88f40a62ee975d4d99c
-  data.tar.gz: 6fe83ccf267e5d018c51ad8400afbcb25e258aa4
+  metadata.gz: bab3c51f0e4592dd7fc82d9731b58a0fd323ca80
+  data.tar.gz: 524371c1e719cf976ca4986fb3aefed473565725
 SHA512:
-  metadata.gz: dbe30561431c38311506b689e146df2396562c726f3bf5775596ac6c891cec2407cb33c90c9124c9df334269f6355ff21311d84436743f8052210b519a67ebb7
-  data.tar.gz: c757c5d9ac663120acd496682f36d4098dc8abd10cca25208fa36b24332c397bb24b5cee2e73d5f5b5c225ae115066ac273ad811a33d9d2d8b1bb87890178a03
+  metadata.gz: 0a3cbbabf457be18665be1c8f52f1867d109711f8c740e5ada8df8339dd74eca10c5189346cae00241793611d26582201c8f6f4da31c5d6c48f2947f33cbbe88
+  data.tar.gz: 813ad91b742549a0c9c9478cfaf7b0f9082032440919c1b3c7745040bd89f2bc62e1dc70619c44103cfa2293a64f4b11a97a121aa69565e3c2a83472f11e610e

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem
+
+# byebug
+.byebug_history
+
+# macOS
+*.DS_Store

data/Gemfile

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

data/README.md

@@ -0,0 +1,70 @@
+# 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'
+
+or install from RubyGems
+
+    gem install repetition
+
+
+### Rails
+
+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
+```
+
+### Usage
+Include module in your class or ActiveRecord model
+```ruby
+class Card < ActiveRecord::Base
+  # some code
+  include Repetition
+end
+```
+
+This will add a bunch of properties to your model:
+* easyness_factor
+* number_repetitions
+* quality_of_last_recall
+* next_repetition
+* repetition_interval
+* last_studied
+
+Make sure that appropriate fields are created in your database using migrations
+
+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
+
+card.next_repetition # => nil
+card.process_recall_result(4)
+
+card.repetition_interval # => 1
+card.next_repetition # Tomorrow
+card.save # Don't forget to save your card!
+```
+
+### Changelog
+#### 1.0
+* Initial version
+
+### Running Specs
+
+`bundle exec rake`
+
+### Contributing
+Contributions are welcome! Feel free to post issues and create pull requests.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/repetition.rb

@@ -1,3 +1,7 @@
+require 'repetition/version'
+
+require 'date'
+
 module Repetition
   def reset_spaced_repetition_data
     self.easiness_factor = 2.5
@@ -10,15 +14,15 @@ module Repetition
 
   def process_recall_result(quality_of_recall)
     unless (1..5).include?(quality_of_recall)
-      raise 'Invalid quality of recall. Should be in range from 0 to 5.'
+      raise 'Invalid quality of recall. Should be in range from 1 to 5.'
     end
-    
+
     if quality_of_recall < 3
-      self.number_repetitions = 0 
+      self.number_repetitions = 0
       self.repetition_interval = 0
     else
       self.easiness_factor = calculate_easiness_factor(easiness_factor, quality_of_recall)
-    
+
       if quality_of_recall == 3
         self.repetition_interval = 0
       else
@@ -34,7 +38,7 @@ module Repetition
         end
       end
     end
-    
+
     self.next_repetition = Date.today + repetition_interval
     self.last_studied = Date.today
   end
@@ -42,9 +46,9 @@ module Repetition
   def scheduled_to_recall?
     !next_repetition.nil? && next_repetition <= Date.today
   end
-  
-  private 
-  
+
+  private
+
   def calculate_easiness_factor(easiness_factor, quality_of_recall)
     q = quality_of_recall
     ef_old = easiness_factor
@@ -52,4 +56,4 @@ module Repetition
     result = ef_old - 0.8 + (0.28 * q) - (0.02 * q * q)
     result < 1.3 ? 1.3 : result
   end
-end
+end

data/lib/repetition/version.rb

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

data/repetition.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'repetition/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "repetition"
+  spec.version       = Repetition::VERSION
+  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.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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"
+end

metadata

@@ -1,37 +1,74 @@
 --- !ruby/object:Gem::Specification
 name: repetition
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
-- Danya Kim
+- Dan Kim
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2014-06-14 00:00:00.000000000 Z
+date: 2017-04-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Spaced repetition algorithm (SuperMemo 2) module that can be used as
-  a mixin
-email: itsdanya@gmail.com
+        version: '3.0'
+description: Spaced repetition algorithm module that can be used as a mixin in Ruby
+  apps
+email:
+- itsdanya@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
 - lib/repetition.rb
+- lib/repetition/version.rb
+- repetition.gemspec
 homepage: http://github.com/danyakim/repetition
 licenses:
 - MIT
@@ -52,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Spaced repetition algorithm