Class: Apprise::Plugin::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/apprise/plugin/base.rb

Direct Known Subclasses

Git, SVN

Defined Under Namespace

Classes: NotImplementedError

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(pathname) ⇒ Base

Returns a new instance of Base.



26
27
28
 
# File 'lib/apprise/plugin/base.rb', line 26

def initialize(pathname)
  @pathname = pathname
end

Class Method Details

.executable(name) ⇒ Object 



18
19
20
21
22
23
24
 
# File 'lib/apprise/plugin/base.rb', line 18

def self.executable(name)
  define_method name do |args|
    out = ''
    Dir.chdir(@pathname) { out = `#{name} #{args}` }
    out.strip
  end
end

.inherited(klass) ⇒ Object 



6
7
8
 
# File 'lib/apprise/plugin/base.rb', line 6

def self.inherited(klass)
  Apprise::Plugin.scms << klass
end

.repo?(directory) ⇒ Boolean

Returns:

  • (Boolean)

Raises:



14
15
16
 
# File 'lib/apprise/plugin/base.rb', line 14

def self.repo?(directory)
  raise NotImplementedError, "The class `#{self.class.name}' does not implement ::repo?"
end

.scm ⇒ Object 



10
11
12
 
# File 'lib/apprise/plugin/base.rb', line 10

def self.scm
  name.split('::').last.downcase
end

Instance Method Details

#current_revision ⇒ Object

Raises:



34
35
36
 
# File 'lib/apprise/plugin/base.rb', line 34

def current_revision
  raise NotImplementedError, "The class `#{self.class.name}' does not implement #current_revision."
end

#latest_revision ⇒ Object

Raises:



38
39
40
 
# File 'lib/apprise/plugin/base.rb', line 38

def latest_revision
  raise NotImplementedError, "The class `#{self.class.name}' does not implement #latest_revision."
end

#name ⇒ Object 



30
31
32
 
# File 'lib/apprise/plugin/base.rb', line 30

def name
  @pathname.basename.to_s
end

#up_to_date? ⇒ Boolean

Returns:

  • (Boolean) 


42
43
44
 
# File 'lib/apprise/plugin/base.rb', line 42

def up_to_date?
  current_revision == latest_revision
end

#update! ⇒ Object

Raises:



46
47
48
 
# File 'lib/apprise/plugin/base.rb', line 46

def update!
  raise NotImplementedError, "The class `#{self.class.name}' does not implement #update!."
end