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

%w(changelog news changes history release whatsnew releases).freeze

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.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 88

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.nilable(Sawyer::Resource))
end

Instance Attribute Details

#credentials ⇒ Object (readonly)

Returns the value of attribute credentials.



74
75
76
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 74

def credentials
  @credentials
end

#dependency ⇒ Object (readonly)

Returns the value of attribute dependency.



71
72
73
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 71

def dependency
  @dependency
end

#source ⇒ Object (readonly)

Returns the value of attribute source.



68
69
70
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 68

def source
  @source
end

#suggested_changelog_url ⇒ Object (readonly)

Returns the value of attribute suggested_changelog_url.



77
78
79
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 77

def suggested_changelog_url
  @suggested_changelog_url
end

Instance Method Details

#changelog_text ⇒ Object 



111
112
113
114
115
116
117
118
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 111

def changelog_text
  return unless full_changelog_text

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

#changelog_url ⇒ Object 



106
107
108
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 106

def changelog_url
  changelog&.html_url
end

#upgrade_guide_text ⇒ Object 



126
127
128
129
130
131
132
133
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 126

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 



121
122
123
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 121

def upgrade_guide_url
  upgrade_guide&.html_url
end