Module: FsrsRuby::State

Defined in:
lib/fsrs_ruby/models.rb

Overview

State enum - Card states

Constant Summary collapse

NEW = 
0
LEARNING = 
1
REVIEW = 
2
RELEARNING = 
3

Class Method Summary collapse

Class Method Details

.from_string(str) ⇒ Object 



15
16
17
18
19
 
# File 'lib/fsrs_ruby/models.rb', line 15

def self.from_string(str)
  const_get(str.upcase.to_sym)
rescue NameError
  raise ArgumentError, "Invalid state: #{str}"
end

.to_string(value) ⇒ Object 



21
22
23
24
25
26
27
28
29
 
# File 'lib/fsrs_ruby/models.rb', line 21

def self.to_string(value)
  case value
  when NEW then 'New'
  when LEARNING then 'Learning'
  when REVIEW then 'Review'
  when RELEARNING then 'Relearning'
  else raise ArgumentError, "Invalid state value: #{value}"
  end
end

.valid?(value) ⇒ Boolean

Returns:

  • (Boolean) 


11
12
13
 
# File 'lib/fsrs_ruby/models.rb', line 11

def self.valid?(value)
  [NEW, LEARNING, REVIEW, RELEARNING].include?(value)
end