Class: Match::Storage::Interface

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

Constant Summary collapse

MATCH_VERSION_FILE_NAME = 
"match_version.txt"

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#working_directory ⇒ Object

To make debugging easier, we have a custom exception here



9
10
11
 
# File 'match/lib/match/storage/interface.rb', line 9

def working_directory
  @working_directory
end

Instance Method Details

#clear_changes ⇒ Object

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



118
119
120
121
122
123
 
# File 'match/lib/match/storage/interface.rb', line 118

def clear_changes
  return unless @working_directory

  FileUtils.rm_rf(self.working_directory)
  self.working_directory = nil
end

#configure ⇒ Object

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



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

def configure
  not_implemented(__method__)
end

#delete_files(files_to_delete: [], custom_message: nil) ⇒ Object 



98
99
100
 
# File 'match/lib/match/storage/interface.rb', line 98

def delete_files(files_to_delete: [], custom_message: nil)
  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



35
36
37
 
# File 'match/lib/match/storage/interface.rb', line 35

def download
  not_implemented(__method__)
end

#generate_matchfile_content(template: nil) ⇒ Object

Implement this for the fastlane match init command This method must return the content of the Matchfile that should be generated



113
114
115
 
# File 'match/lib/match/storage/interface.rb', line 113

def generate_matchfile_content(template: nil)
  not_implemented(__method__)
end

#human_readable_description ⇒ Object

Returns a short string describing + identifying the current storage backend. This will be printed when nuking a storage



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

def human_readable_description
  not_implemented(__method__)
end

#list_files(file_name: "", file_ext: "") ⇒ Object 



106
107
108
 
# File 'match/lib/match/storage/interface.rb', line 106

def list_files(file_name: "", file_ext: "")
  not_implemented(__method__)
end

#prefixed_working_directory ⇒ Object

To make debugging easier, we have a custom exception here



12
13
14
 
# File 'match/lib/match/storage/interface.rb', line 12

def prefixed_working_directory
  not_implemented(__method__)
end

#save_changes!(files_to_commit: nil, files_to_delete: nil, custom_message: nil, clear_working_directory: true) ⇒ 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

Parameters:

  • files_to_commit (Array) (defaults to: nil) —

    Array to paths to files that should be committed to the storage provider

  • custom_message: (String) (defaults to: nil) —

    Custom change message that's optional, is used for commit title

  • clear_working_directory: (Bool) (defaults to: true) —

    Pass false to keep the local working directory after saving, so more changes can be made and saved later in the same run



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'match/lib/match/storage/interface.rb', line 57

def save_changes!(files_to_commit: nil, files_to_delete: nil, custom_message: nil, clear_working_directory: true)
  # Custom init to `[]` in case `nil` is passed
  files_to_commit ||= []
  files_to_delete ||= []
  files_to_delete -= files_to_commit # Make sure we are not removing added files.

  if files_to_commit.count == 0 && files_to_delete.count == 0
    UI.user_error!("Neither `files_to_commit` nor `files_to_delete` were provided to the `save_changes!` method call")
  end

  Dir.chdir(File.expand_path(self.working_directory)) do
    if files_to_commit.count > 0 # everything that isn't `match nuke`
      if !File.exist?(MATCH_VERSION_FILE_NAME) || File.read(MATCH_VERSION_FILE_NAME) != Fastlane::VERSION.to_s
        files_to_commit << MATCH_VERSION_FILE_NAME
        File.write(MATCH_VERSION_FILE_NAME, Fastlane::VERSION) # stored unencrypted
      end

      template = File.read("#{Match::ROOT}/lib/assets/READMETemplate.md")
      readme_path = "README.md"
      if (!File.exist?(readme_path) || File.read(readme_path) != template) && !self.skip_docs
        files_to_commit << readme_path
        File.write(readme_path, template)
      end

      self.upload_files(files_to_upload: files_to_commit, custom_message: custom_message)
      UI.message("Finished uploading files to #{self.human_readable_description}")
    end

    if files_to_delete.count > 0
      self.delete_files(files_to_delete: files_to_delete, custom_message: custom_message)
      UI.message("Finished deleting files from #{self.human_readable_description}")
    end
  end
ensure # Always clear working_directory after save
  self.clear_changes if clear_working_directory
end

#skip_docs ⇒ Object 



102
103
104
 
# File 'match/lib/match/storage/interface.rb', line 102

def skip_docs
  not_implemented(__method__)
end

#upload_files(files_to_upload: [], custom_message: nil) ⇒ Object 



94
95
96
 
# File 'match/lib/match/storage/interface.rb', line 94

def upload_files(files_to_upload: [], custom_message: nil)
  not_implemented(__method__)
end