Class: MLB::GameStatus

Inherits:
Shale::Mapper
  • Object
show all
Defined in:
lib/mlb/game_status.rb

Overview

Represents a game status

Constant Summary collapse

FINAL = 
"Final".freeze
LIVE = 
"Live".freeze
PREVIEW = 
"Preview".freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#abstract_game_code ⇒ String

Returns the abstract game code

Examples:

game_status.abstract_game_code #=> "F"

Returns:

  • the abstract game code

API:

  • public



51
 
# File 'lib/mlb/game_status.rb', line 51

attribute :abstract_game_code, Shale::Type::String

#abstract_game_state ⇒ String

Returns the high-level game state

Examples:

game_status.abstract_game_state #=> "Final"

Returns:

  • the high-level game state

API:

  • public



19
 
# File 'lib/mlb/game_status.rb', line 19

attribute :abstract_game_state, Shale::Type::String

#coded_game_state ⇒ String

Returns the coded game state

Examples:

game_status.coded_game_state #=> "F"

Returns:

  • the coded game state

API:

  • public



27
 
# File 'lib/mlb/game_status.rb', line 27

attribute :coded_game_state, Shale::Type::String

#detailed_state ⇒ String

Returns the detailed game state

Examples:

game_status.detailed_state #=> "Final"

Returns:

  • the detailed game state

API:

  • public



35
 
# File 'lib/mlb/game_status.rb', line 35

attribute :detailed_state, Shale::Type::String

#reason ⇒ String

Returns the reason for the status

Examples:

game_status.reason #=> "Rain"

Returns:

  • the reason for the status

API:

  • public



59
 
# File 'lib/mlb/game_status.rb', line 59

attribute :reason, Shale::Type::String

#status_code ⇒ String

Returns the status code

Examples:

game_status.status_code #=> "F"

Returns:

  • the status code

API:

  • public



43
 
# File 'lib/mlb/game_status.rb', line 43

attribute :status_code, Shale::Type::String

Instance Method Details

#final? ⇒ Boolean

Returns whether the game is final (completed)

Examples:

game_status.final? #=> true

Returns:

  • whether the game is final

API:

  • public



67
 
# File 'lib/mlb/game_status.rb', line 67

def final? = abstract_game_state.eql?(FINAL)

#live? ⇒ Boolean

Returns whether the game is live (in progress)

Examples:

game_status.live? #=> false

Returns:

  • whether the game is live

API:

  • public



75
 
# File 'lib/mlb/game_status.rb', line 75

def live? = abstract_game_state.eql?(LIVE)

#preview? ⇒ Boolean

Returns whether the game is in preview (not yet started)

Examples:

game_status.preview? #=> false

Returns:

  • whether the game is in preview

API:

  • public



83
 
# File 'lib/mlb/game_status.rb', line 83

def preview? = abstract_game_state.eql?(PREVIEW)