Class: Mousevc::App

Inherits:
Object
  • Object
show all
Defined in:
lib/mousevc/app.rb

Overview

true The top level class of Mousevc. The container for all of the objects created within a Mousevc application.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ App

Note:

as of v0.0.6 Mousevc requires that the views path be absolute, e.g “#{File.dirname(__FILE__)}/views”

Creates a new Mousevc::App instance

Parameters:

  • options (Hash) (defaults to: {}) —

    expects the following keys:

    • :controller => [String] name of default controller class

    • :model => [String] name of default model class

    • :action => [Symbol] method to call on default controller

    • :views => [String] the absolute path to your views directory

    • :looping => [Boolean] true if the application should loop, defaults to false

    • :system_clear => [Boolean] true if output should be cleared on update, defaults to false



56
57
58
59
60
61
62
63
 
# File 'lib/mousevc/app.rb', line 56

def initialize(options={})
	@controller = options[:controller]
	@model = options[:model]
	@action = options[:action]
	@views = options[:views]
	@looping = options[:looping].nil? ? false : options[:looping]
	@system_clear = options[:system_clear].nil? ? false : options[:system_clear]
end

Instance Attribute Details

#looping ⇒ Boolean

Set this to true if you want the application to loop, defaults to false

Returns:

  • (Boolean) —

    whether or not the application should loop



32
33
34
 
# File 'lib/mousevc/app.rb', line 32

def looping
  @looping
end

#router ⇒ Mousevc::Router

Returns the current router

Returns:



41
42
43
 
# File 'lib/mousevc/app.rb', line 41

def router
  @router
end

#system_clear ⇒ Boolean

Setting this to false will disable calls to system(‘clear’) at the start of each application loop.

Returns:

  • (Boolean) —

    whether or not to perform system clear



23
24
25
 
# File 'lib/mousevc/app.rb', line 23

def system_clear
  @system_clear
end

Instance Method Details

#looping? ⇒ Boolean

Returns true if @looping is set to true

Returns:

  • (Boolean) 


87
88
89
 
# File 'lib/mousevc/app.rb', line 87

def looping?
	@looping
end

#run ⇒ Object

Runs the application



68
69
70
71
72
73
 
# File 'lib/mousevc/app.rb', line 68

def run
	reset
	@looping ? listen : single
	Input.clear
	nil
end

#system_clear? ⇒ Boolean

Returns true if @system_clear is true

Returns:

  • (Boolean) —

    whether or not system clearing is enabled



80
81
82
 
# File 'lib/mousevc/app.rb', line 80

def system_clear?
	@system_clear
end