Class: Pra::WindowSystem

Inherits:
Object
  • Object
show all
Defined in:
lib/pra/window_system.rb

Direct Known Subclasses

CursesWindowSystem

Defined Under Namespace

Classes: PureVirtualMethodNotImplemented

Instance Method Summary collapse

Instance Method Details

#fetch_failed ⇒ Object

This method is a pure virtual method and is called by the system when an error occurs while fetching pull requests. It is intended to be a notification to the window system so that it can notify the user that fetching pull requests failed.

Raises:



25
26
27
 
# File 'lib/pra/window_system.rb', line 25

def fetch_failed
  raise PureVirtualMethodNotImplemented, "the 'fetch_failed' method needs to be implemented."
end

#fetching_pull_requests ⇒ Object

This method is a pure virtual method and is called by the system right before the fetching of the pull requests is started. It is simply intended to be a notification to the window system so that it can notify the user in whatever is an appropriate fashion that it is in the process of fetching the pull requests.

Raises:



17
18
19
 
# File 'lib/pra/window_system.rb', line 17

def fetching_pull_requests
  raise PureVirtualMethodNotImplemented, "the 'fetching_pull_requests' method needs to be implemented."
end

#refresh_pull_requests(pull_requests) ⇒ Object

This method is a pure virtual method and is intendend for the inheriting class to implement it to handle refreshing the pull requests within in the window system. This method is called evertime the pull request fetching system fetches pull requests.

Raises:



33
34
35
 
# File 'lib/pra/window_system.rb', line 33

def refresh_pull_requests(pull_requests)
  raise PureVirtualMethodNotImplemented, "the 'refresh_pull_requests' method needs to be implemented."
end

#run_loop ⇒ Object

This method is a pure virtual method and is intended for the inherting class to implement it in order to initiate the main run loop of the windowing system the inheriting class is implementing. It can also be used to include any tear down that needs to happen when the run loop exits.

Raises:



42
43
44
 
# File 'lib/pra/window_system.rb', line 42

def run_loop
  raise PureVirtualMethodNotImplemented, "the 'run_loop' method needs to be implemented."
end

#setup ⇒ Object

This method is a pure virtual method and is intended for the inheriting class to implement it in order to handle all the initialization and setup of the windowing system the inheriting class is implementing.

Raises:



8
9
10
 
# File 'lib/pra/window_system.rb', line 8

def setup
  raise PureVirtualMethodNotImplemented, "the 'setup' method needs to be implemented."
end