thinking_lobster 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 218e6e4196ddcf31ccba598e4245801c6de55daa
-  data.tar.gz: 20036c56a9646cee7d57263929cc5a9e2f0b0c03
+  metadata.gz: c3084e6508be42ea7843ff05e5cbe6c783f81838
+  data.tar.gz: 544d62472de65a0f8553e6be29ed64ad79a42a69
 SHA512:
-  metadata.gz: def04bd5c774f5347cdd63e1c828959edfd62bdfd60e2c082ac68722c2e985638c482f08d1eb47caee437b49351e6627bd4f327d7f1413cf98e3fba364d3b7ba
-  data.tar.gz: 3174c4d377ce067467366860c8c7c7fac47d849efbc374e1801a4464ec6f82686556fb23124401cd7eb5d50d2fc20d1653baa79b75e2aba3b3914ad731ab9af5
+  metadata.gz: 1fe663bedfbde5eb9498732a7993d608324d0b5da27e501ae6b8790ff54589386e427971cc44a849904a5313298fbfe327c2484621db3eb029c5433eea2f9f76
+  data.tar.gz: f48f6ae07847779b096c376220f7001b7d7e1dd196c5c513fdeb5723a778da4171abe23bb5562e9b2246dadccf5b7bf185d51bfaf7b2614d285c86882a0158db

data/lib/thinking_lobster.rb

@@ -1,20 +1,14 @@
 require 'mongoid'
 require 'active_support/time'
 
+# Provides a way of intelligently scheduling review times for learning items stored in a MongoDB database.
 module ThinkingLobster
 
 #TODO:
-  # [] Move all fixed numbers into user definable vars. eg. default review_due_at, intervals, etc
-  # [x] Make protected members protected again
-  # [x] Consider implementing a time_since_review method to replace time_since_due
-  # [x] Write documentation
-  # [x] Update the readme.md
-  # [] Github pages for sdoc documentation
   # [] wiki pages for use cases, design philosophy.
-  # [] Run a code coverage tool
+  # [] Run a test coverage tool
 
-  # Includes a set of fields and support methods into the base class. Mongoid
-  # must be included in the base class.
+  # Includes a set of fields and support methods into the base class. Mongoid must be included in the base class. Setup Mongoid before setting up this library.
   #
   # ==== Examples
   #   class FlashCard
@@ -24,7 +18,6 @@ module ThinkingLobster
   #     field :answer
   #   end
   def self.included(collection)
-    #Make all of the hardcoded 2's a user defined variable.
     collection.send :field, :times_reviewed,  type: Integer, default: 0
     collection.send :field, :winning_streak,  type: Integer, default: 0
     collection.send :field, :losing_streak,   type: Integer, default: 0
@@ -40,12 +33,11 @@ module ThinkingLobster
   # * (Float) :new_positive_multiplier - The number by which a new item's interval is multiplied by when correctly reviewed. Default value is 2. Increasing this number will shorten the number of short term reviews. Must be greater than 1.0 . Be aware that there is no such thing as a new_negative_multiplier because incorrect new items get reset to the system default when incorrect.
   # * (Float) :old_positive_multiplier - The number by which an old item's interval is multiplied by when correctly reviewed. Default value is 1.25. Increasing this number will shorten the number of long term item reviews. Must be greater than 1.0 .
   # * (Float) :Penalty - The number by which an old item's interval is multiplied by when incorrectly answered. Can be any number equal to or greater than 0 or less than 1.0. Default value is 0.25 .
-
   mattr_accessor :config
 
   self.config = {
-    cutoff:                  36.hours,
-    first_interval:          2.hours,
+    cutoff:                  36*60*60, #36 hours
+    first_interval:          2*60*60, #2 hours
     new_positive_multiplier: 2.0,
     old_positive_multiplier: 1.25,
     penalty:                 0.25
@@ -58,7 +50,7 @@ module ThinkingLobster
   #    flash_card.mark_correct! # => #<SomeItem:0x123>
   #
   # Paramters:
-  # * (Time) current_time - Time object by which review times are set. This parameter is almost always left to its default value (Time.now) but may be useful for testing or special use cases.
+  # * (Time) current_time - Time object by which review times are set. This parameter is almost always left to its default value (Time.now) but may be changed for testing or special use cases.
   #
   # Returns an instance of the base class
   def mark_correct!(current_time = Time.now)
@@ -80,7 +72,7 @@ module ThinkingLobster
   #    flash_card.mark_incorrect! # => #<SomeItem:0x123>
   #
   # Parameters:
-  # * (Time) current_time - Time object by which review times are set. Defaults to Time.now This parameter is typically left to its default value but may be useful for testing or special use cases.
+  # * (Time) current_time - Time object by which review times are set. Defaults to Time.now . This parameter is typically left to its default value but may be changed for testing or special use cases.
   #
   # Returns an instance of the base class.
   def mark_incorrect!(current_time = Time.now)
@@ -95,7 +87,7 @@ module ThinkingLobster
     self
   end
 
-  # Indicates quantity of time since the item became ready for a review. This method is under consideration for deprecation in favor of a method which returns time since the last review.
+  # Indicates quantity of time since the item became ready for a review. This method is not used by ThinkingLobster at all, but may be useful as a helper method for application logic.
   #
   # Example: 
   #    flash_card = SomeDocument.new
@@ -135,7 +127,7 @@ module ThinkingLobster
   #    flash_card = SomeDocument.new
   #    flash_card.mark_correct! 
   #    flash_card.too_soon? # In this example, we just finished the review. So it won't be due for a few more hours.
-  #    # => false
+  #    # => true
   #
   # * (Time) current_time - Time object which defaults to Time.now. This is the time by which the method compares.
   #
@@ -145,7 +137,7 @@ module ThinkingLobster
     if too_soon then true else false end
   end
 
-  # Indicates if the item has a previous review set (which would indicate wether it is a newly added item).
+  # Indicates if the item has a previous review recorded (which would indicate wether it is a newly added item).
   #
   # Example:
   #    flash_card = SomeDocument.new
@@ -158,7 +150,16 @@ module ThinkingLobster
   def previous_review?
     self.previous_review != nil
   end
+
   # Resets all attributes related to spaced repetition. You still need to call save on the item to persist.
+  #
+  # Example:
+  #   really_bad_item.reset
+  #   really_bad_item.save
+  #   # => #<SomeItem:0x123> # This item is now a new item, for all practical purposes.
+  #
+  # Parameters:
+  # * (Time) current_time - The time that the items values will be reset to. Defaults to Time.now.
   def reset(current_time = Time.now)
     self.times_reviewed   = 0
     self.winning_streak   = 0
@@ -169,9 +170,14 @@ module ThinkingLobster
 
   protected
 
+  # Take a multiplier and a time, then returns a new interval.
+  def create_interval(multiplier, current_time = Time.now)
+    seconds_ago           = time_since_review(current_time)
+    new_interval          = seconds_ago * multiplier
+    self.review_due_at    = current_time + new_interval
+  end
+
   def new_item_correct(current_time = Time.now)
-    #Takes the interval between current_time and the time the item was due
-    # And doubles that amount of time.
     if self.previous_review?
       self.set_previous_review!
       self.review_due_at += time_since_review(current_time) * @@config[:new_positive_multiplier]
@@ -191,15 +197,11 @@ module ThinkingLobster
   end
 
   def old_item_correct(current_time = Time.now)
-    hours_ago             = time_since_review(current_time)/60/60
-    new_interval          = (hours_ago * @@config[:old_positive_multiplier]).hours
-    self.review_due_at    = current_time + new_interval
+    self.create_interval(@@config[:old_positive_multiplier] , current_time)
   end
 
   def old_item_incorrect(current_time = Time.now)
-    hours_ago             = time_since_review(current_time)/60/60
-    new_interval          = (hours_ago * @@config[:penalty]).hours
-    self.review_due_at    = current_time + new_interval
+    self.create_interval(@@config[:penalty], current_time)
   end
 
   def increment_wins

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thinking_lobster
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Rick Carlino
@@ -53,69 +53,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bson_ext
-  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: mongo
-  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: pry
+  name: active_support
   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: mongoid
-  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: sdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements: