Class: Waddup::Source

Inherits:
Object
  • Object
show all
Extended by:
Registry
Defined in:
lib/waddup/source.rb

Overview

Denotes a possible source of events Note: Any subclasses are automatically registered

Direct Known Subclasses

AppleCalendar, AppleMail, Git

Defined Under Namespace

Classes: AppleCalendar, AppleMail, Git

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Registry

inherited, registry

Class Method Details

.usable ⇒ Object

Only usable sources



32
33
34
 
# File 'lib/waddup/source.rb', line 32

def usable
  registry.select &:usable?
end

.usable? ⇒ Boolean

Whether this source is usable

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


27
28
29
 
# File 'lib/waddup/source.rb', line 27

def usable?
  raise NotImplementedError
end

Instance Method Details

#events(from, to) ⇒ Object

Aggregates events from this source

Arguments:

:from (datetime)
:to   (datetime)

Raises:

  • (NotImplementedError) 


15
16
17
 
# File 'lib/waddup/source.rb', line 15

def events(from, to)
  raise NotImplementedError
end

#usable? ⇒ Boolean

Delegate for convenience

Returns:

  • (Boolean) 


20
21
22
 
# File 'lib/waddup/source.rb', line 20

def usable?
  self.class.usable?
end