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
CHANGELOG_FILE_TYPES = 
%w(file dir).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.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 59

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(ChangelogFile))
  @file_text = T.let({}, T::Hash[String, T.nilable(String)])
  @dependency_file_list = T.let({}, T::Hash[T.nilable(String), T::Array[ChangelogFile]])
end

Instance Attribute Details

#credentials ⇒ Object (readonly)

Returns the value of attribute credentials.



45
46
47
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 45

def credentials
  @credentials
end

#dependency ⇒ Object (readonly)

Returns the value of attribute dependency.



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

def dependency
  @dependency
end

#source ⇒ Object (readonly)

Returns the value of attribute source.



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

def source
  @source
end

#suggested_changelog_url ⇒ Object (readonly)

Returns the value of attribute suggested_changelog_url.



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

def suggested_changelog_url
  @suggested_changelog_url
end

Instance Method Details

#changelog_text ⇒ Object 



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

def changelog_text
  return unless full_changelog_text

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

#changelog_url ⇒ Object 



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

def changelog_url
  changelog&.html_url
end

#upgrade_guide_text ⇒ Object 



99
100
101
102
103
104
105
106
107
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 99

def upgrade_guide_text
  guide = upgrade_guide
  return unless guide

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

#upgrade_guide_url ⇒ Object 



94
95
96
 
# File 'lib/dependabot/metadata_finders/base/changelog_finder.rb', line 94

def upgrade_guide_url
  upgrade_guide&.html_url
end