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

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

Overview

rubocop:disable Metrics/ClassLength

Constant Summary collapse

CHANGELOG_NAMES =

Earlier entries are preferred

T.let(
  %w(changelog news changes history release whatsnew releases).freeze,
  T::Array[String]
)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of ChangelogFinder.



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 50

def initialize(source:, dependency:, credentials:,
               suggested_changelog_url: nil)
  @source = source
  @dependency = dependency
  @credentials = credentials
  @suggested_changelog_url = suggested_changelog_url
  # strip fragment from URL, if present
  @suggested_changelog_url = @suggested_changelog_url&.split("#")&.first

  @new_version = T.let(nil, T.nilable(String))
  @changelog_from_suggested_url = T.let(nil, T.untyped)
end

Instance Attribute Details

#credentials ⇒ Object (readonly)

Returns the value of attribute credentials.



36
37
38
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 36

def credentials
  @credentials
end

#dependency ⇒ Object (readonly)

Returns the value of attribute dependency.



33
34
35
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 33

def dependency
  @dependency
end

#source ⇒ Object (readonly)

Returns the value of attribute source.



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

def source
  @source
end

#suggested_changelog_url ⇒ Object (readonly)

Returns the value of attribute suggested_changelog_url.



39
40
41
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 39

def suggested_changelog_url
  @suggested_changelog_url
end

Instance Method Details

#changelog_text ⇒ Object 



69
70
71
72
73
74
75
76
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 69

def changelog_text
  return unless full_changelog_text

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

#changelog_url ⇒ Object 



64
65
66
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 64

def changelog_url
  changelog&.html_url
end

#upgrade_guide_text ⇒ Object 



84
85
86
87
88
89
90
91
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 84

def upgrade_guide_text
  return unless upgrade_guide

  @upgrade_guide_text ||= T.let(
    fetch_file_text(upgrade_guide),
    T.nilable(String)
  )
end

#upgrade_guide_url ⇒ Object 



79
80
81
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 79

def upgrade_guide_url
  upgrade_guide&.html_url
end