Class: SafeDb::QueryVerse

Inherits:
Controller show all
Defined in:
lib/controller/abstract/query_verse.rb

Overview

Any Controller class wishing to query a safe verse can make use of the functionality in this parent by exposing an query_verse() method.

Classes extending this class will have access to

  • a @chapther_data data structure

  • a @chapther_id string index

  • a @has_chapter boolean indicator

  • a @verse_data data structure

  • a @verse_id string index

  • a @has_verse boolean indicator

The query_verse() method is not succeeded by any behaviour in the parent. Chilc classes must do their own output management.

Direct Known Subclasses

Copy, Docker, Git, Print, Publish, Send, Show, Tell, Write

Instance Method Summary collapse

Methods inherited from Controller

#check_post_conditions, #check_pre_conditions, #flow, #initialize, #open_remote_backend_location, #post_validation, #pre_validation, #read_verse, #set_verse, #update_verse

Constructor Details

This class inherits a constructor from SafeDb::Controller

Instance Method Details

#execute ⇒ Object

This parental behaviour sets up common ubiquitous chapter and verse data structures and indices.



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/controller/abstract/query_verse.rb', line 23

def execute

  # Before calling the edit_verse() method we perform some
  # preparatory activities that check, validate and setup.
  read_verse()

  # The query verse behaviour implemented by the child classes will read and
  # perhaps display credentials without changing state.
  query_verse()

end