Class: Dependabot::MetadataFinders::Base::ChangelogFinder

Inherits:
Object
  • Object
show all
Defined in:
lib/dependabot/metadata_finders/base/changelog_finder.rb

Constant Summary collapse

CHANGELOG_NAMES =

Earlier entries are preferred

%w(changelog history news changes release).freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source:, dependency:, credentials:) ⇒ ChangelogFinder

Returns a new instance of ChangelogFinder.



23
24
25
26
27
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 23

def initialize(source:, dependency:, credentials:)
  @source = source
  @dependency = dependency
  @credentials = credentials
end

Instance Attribute Details

#credentials ⇒ Object (readonly)

Returns the value of attribute credentials.



21
22
23
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 21

def credentials
  @credentials
end

#dependency ⇒ Object (readonly)

Returns the value of attribute dependency.



21
22
23
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 21

def dependency
  @dependency
end

#source ⇒ Object (readonly)

Returns the value of attribute source.



21
22
23
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 21

def source
  @source
end

Instance Method Details

#changelog_text ⇒ Object 



33
34
35
36
37
38
39
40
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 33

def changelog_text
  return unless full_changelog_text

  ChangelogPruner.new(
    dependency: dependency,
    changelog_text: full_changelog_text
  ).pruned_text
end

#changelog_url ⇒ Object 



29
30
31
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 29

def changelog_url
  changelog&.html_url
end

#upgrade_guide_text ⇒ Object 



46
47
48
49
50
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 46

def upgrade_guide_text
  return unless upgrade_guide

  @upgrade_guide_text ||= fetch_file_text(upgrade_guide)
end

#upgrade_guide_url ⇒ Object 



42
43
44
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 42

def upgrade_guide_url
  upgrade_guide&.html_url
end