Class: Dependabot::FileFetchers::Base
- Inherits:
-
Object
- Object
- Dependabot::FileFetchers::Base
- Defined in:
- lib/dependabot/file_fetchers/base.rb
Constant Summary collapse
- CLIENT_NOT_FOUND_ERRORS =
[ Octokit::NotFound, Gitlab::Error::NotFound, Dependabot::Clients::Azure::NotFound, Dependabot::Clients::Bitbucket::NotFound, Dependabot::Clients::CodeCommit::NotFound ].freeze
Instance Attribute Summary collapse
-
#credentials ⇒ Object
readonly
Returns the value of attribute credentials.
-
#repo_contents_path ⇒ Object
readonly
Returns the value of attribute repo_contents_path.
-
#source ⇒ Object
readonly
Returns the value of attribute source.
Class Method Summary collapse
Instance Method Summary collapse
-
#clone_repo_contents ⇒ Object
Returns the path to the cloned repo.
- #commit ⇒ Object
- #directory ⇒ Object
- #files ⇒ Object
-
#initialize(source:, credentials:, repo_contents_path: nil) ⇒ Base
constructor
Creates a new FileFetcher for retrieving ‘DependencyFile`s.
- #repo ⇒ Object
- #target_branch ⇒ Object
Constructor Details
#initialize(source:, credentials:, repo_contents_path: nil) ⇒ Base
Creates a new FileFetcher for retrieving ‘DependencyFile`s.
Files are typically grabbed individually via the source’s API. repo_contents_path is an optional empty directory that will be used to clone the entire source repository on first read.
If provided, file data will be loaded from the clone. Submodules and directory listings are not currently supported by repo_contents_path and still use an API trip.
44 45 46 47 48 49 |
# File 'lib/dependabot/file_fetchers/base.rb', line 44 def initialize(source:, credentials:, repo_contents_path: nil) @source = source @credentials = credentials @repo_contents_path = repo_contents_path @linked_paths = {} end |
Instance Attribute Details
#credentials ⇒ Object (readonly)
Returns the value of attribute credentials.
17 18 19 |
# File 'lib/dependabot/file_fetchers/base.rb', line 17 def credentials @credentials end |
#repo_contents_path ⇒ Object (readonly)
Returns the value of attribute repo_contents_path.
17 18 19 |
# File 'lib/dependabot/file_fetchers/base.rb', line 17 def repo_contents_path @repo_contents_path end |
#source ⇒ Object (readonly)
Returns the value of attribute source.
17 18 19 |
# File 'lib/dependabot/file_fetchers/base.rb', line 17 def source @source end |
Class Method Details
.required_files_in?(_filename_array) ⇒ Boolean
27 28 29 |
# File 'lib/dependabot/file_fetchers/base.rb', line 27 def self.required_files_in?(_filename_array) raise NotImplementedError end |
.required_files_message ⇒ Object
31 32 33 |
# File 'lib/dependabot/file_fetchers/base.rb', line 31 def self. raise NotImplementedError end |
Instance Method Details
#clone_repo_contents ⇒ Object
Returns the path to the cloned repo
80 81 82 83 84 85 |
# File 'lib/dependabot/file_fetchers/base.rb', line 80 def clone_repo_contents @clone_repo_contents ||= _clone_repo_contents(target_directory: repo_contents_path) rescue Dependabot::SharedHelpers::HelperSubprocessFailed raise Dependabot::RepoNotFound, source end |
#commit ⇒ Object
67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/dependabot/file_fetchers/base.rb', line 67 def commit return source.commit if source.commit branch = target_branch || default_branch_for_repo @commit ||= client_for_provider.fetch_commit(repo, branch) rescue *CLIENT_NOT_FOUND_ERRORS raise Dependabot::BranchNotFound, branch rescue Octokit::Conflict => e raise unless e..include?("Repository is empty") end |
#directory ⇒ Object
55 56 57 |
# File 'lib/dependabot/file_fetchers/base.rb', line 55 def directory Pathname.new(source.directory || "/").cleanpath.to_path end |
#files ⇒ Object
63 64 65 |
# File 'lib/dependabot/file_fetchers/base.rb', line 63 def files @files ||= fetch_files end |
#repo ⇒ Object
51 52 53 |
# File 'lib/dependabot/file_fetchers/base.rb', line 51 def repo source.repo end |
#target_branch ⇒ Object
59 60 61 |
# File 'lib/dependabot/file_fetchers/base.rb', line 59 def target_branch source.branch end |