Class: Match::Storage::Interface

Inherits:
Object
  • Object
show all
Defined in:
match/lib/match/storage/interface.rb

Direct Known Subclasses

GitStorage

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#working_directory ⇒ Object

To make debugging easier, we have a custom exception here



6
7
8
 
# File 'match/lib/match/storage/interface.rb', line 6

def working_directory
  @working_directory
end

Instance Method Details

#clear_changes ⇒ Object

Call this method to reset any changes made locally to the files



45
46
47
 
# File 'match/lib/match/storage/interface.rb', line 45

def clear_changes
  not_implemented(__method__)
end

#configure ⇒ Object

Call this method after creating a new object to configure the given Storage object. This method will take different paramters depending on specific class being used



19
20
21
 
# File 'match/lib/match/storage/interface.rb', line 19

def configure
  not_implemented(__method__)
end

#download ⇒ Object

Call this method for the initial clone/download of the user’s certificates & profiles As part of this method, the ‘self.working_directory` attribute will be set



27
28
29
 
# File 'match/lib/match/storage/interface.rb', line 27

def download
  not_implemented(__method__)
end

#save_changes!(files_to_commit: [], custom_message: nil) ⇒ Object

Call this method after locally modifying the files This will commit the changes and push it back to the given remote server This method is blocking, meaning it might take multiple seconds or longer to run



40
41
42
 
# File 'match/lib/match/storage/interface.rb', line 40

def save_changes!(files_to_commit: [], custom_message: nil)
  not_implemented(__method__)
end