Class: Gemstar::ChangeLog

Inherits:
Object
  • Object
show all
Defined in:
lib/gemstar/change_log.rb

Constant Summary collapse

GITHUB_CLI_TIMEOUT = 
8
MAX_CHANGELOG_REDIRECTS = 
3
CHANGELOG_REDIRECT_PATTERN = 
/\b(?:change\s*log|changelog|release\s+notes?)\b.{0,160}\b(?:moved|relocated|now\s+lives|lives\s+here)\b/im
DEFAULT_CHANGELOG_PATHS = 
%w[
  CHANGELOG.md CHANGELOG releases.md CHANGES.md
  Changelog.md changelog.md ChangeLog.md
  Changes.md changes.md
  HISTORY.md History.md history.md
  History
  RELEASE_NOTES.md Release_Notes.md release_notes.md
  RELEASE-NOTES.md Release-Notes.md release-notes.md
  CHANGELOG.rst Changelog.rst changelog.rst ChangeLog.rst
  CHANGES.rst Changes.rst changes.rst
  HISTORY.rst History.rst history.rst
  CHANGES Changes
  CHANGELOG.rdoc
].freeze
@@candidates_found = 
Hash.new(0)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(metadata) ⇒ ChangeLog

Returns a new instance of ChangeLog.



32
33
34
 
# File 'lib/gemstar/change_log.rb', line 32

def initialize(metadata)
  @metadata = metadata
end

Instance Attribute Details

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



36
37
38
 
# File 'lib/gemstar/change_log.rb', line 36

def metadata
  @metadata
end

Instance Method Details

#compute_release_dates(force_refresh: false) ⇒ Object 



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/gemstar/change_log.rb', line 138

def compute_release_dates(force_refresh: false)
  registry_dates = if @metadata.respond_to?(:registry_release_dates)
    @metadata.registry_release_dates(cache_only: false, force_refresh: force_refresh)
  else
    {}
  end
  return registry_dates unless registry_dates.nil? || registry_dates.empty?

  changelog_dates = parse_changelog_release_dates(cache_only: false, force_refresh: force_refresh)
  return changelog_dates unless changelog_dates.nil? || changelog_dates.empty?

  repo_uri = @metadata&.repo_uri(cache_only: false, force_refresh: force_refresh)
  return {} unless repo_uri&.include?("github.com")

  parse_github_tag_dates(repo_uri, cache_only: false, force_refresh: force_refresh)
end

#compute_sections(force_refresh: false) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
 
# File 'lib/gemstar/change_log.rb', line 127

def compute_sections(force_refresh: false)
  changelog_sections = parse_changelog_sections(cache_only: false, force_refresh: force_refresh) || {}
  github_sections = parse_github_release_sections(cache_only: false, force_refresh: force_refresh) || {}

  sections = merge_section_sources(changelog_sections, github_sections)

  pp @@candidates_found if Gemstar.debug?

  sections
end

#content(cache_only: false, force_refresh: false) ⇒ Object 



38
39
40
41
42
43
44
 
# File 'lib/gemstar/change_log.rb', line 38

def content(cache_only: false, force_refresh: false)
  return @content if !cache_only && defined?(@content)

  result = fetch_changelog_content(cache_only: cache_only, force_refresh: force_refresh)
  @content = result unless cache_only
  result
end

#decode_sections(serialized) ⇒ Object 



155
156
157
158
159
 
# File 'lib/gemstar/change_log.rb', line 155

def decode_sections(serialized)
  JSON.parse(serialized)
rescue JSON::ParserError
  nil
end

#extract_relevant_sections(old_version, new_version) ⇒ Object 



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/gemstar/change_log.rb', line 166

def extract_relevant_sections(old_version, new_version)
  from = Gem::Version.new(old_version.gsub(/-[\w\-]+$/, "")) rescue nil if old_version
  from ||= Gem::Version.new("0.0.0")
  to = Gem::Version.new(new_version.gsub(/-[\w\-]+$/, "")) rescue nil if new_version
  to ||= Gem::Version.new("9999.9999.9999")

  sections.select do |version, _|
    v = Gem::Version.new(version.gsub(/-[\w\-]+$/, ""))
    v > from && v <= to
  rescue => e
    false
  end.sort_by do |k, _|
    Gem::Version.new(k.gsub(/-[\w\-]+$/, ""))
  rescue => e
    Gem::Version.new("0.0.0")
  end.reverse.to_h
end

#merge_section_sources(changelog_sections, github_sections) ⇒ Object 



161
162
163
164
 
# File 'lib/gemstar/change_log.rb', line 161

def merge_section_sources(changelog_sections, github_sections)
  return github_sections if changelog_sections.nil? || changelog_sections.empty?
  changelog_sections
end

#release_dates(versions: nil, cache_only: false, force_refresh: false) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/gemstar/change_log.rb', line 102

def release_dates(versions: nil, cache_only: false, force_refresh: false)
  requested_versions = normalize_requested_versions(versions)
  metadata_key = @metadata.respond_to?(:cache_key) ? @metadata.cache_key : @metadata.gem_name
  cache_key = "release-dates-v2-#{metadata_key}"
  serialized = if cache_only
    Cache.peek(cache_key)
  else
    Cache.fetch(cache_key, force: force_refresh) do
      JSON.generate(compute_release_dates(force_refresh: force_refresh))
    end
  end

  dates = if serialized
    decode_sections(serialized) || {}
  elsif cache_only
    {}
  else
    compute_release_dates(force_refresh: force_refresh)
  end

  return dates if requested_versions.empty?

  dates.select { |version, _date| requested_versions.include?(normalize_version_key(version)) }
end

#sections(cache_only: false, force_refresh: false) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/gemstar/change_log.rb', line 46

def sections(cache_only: false, force_refresh: false)
  return @sections if !cache_only && defined?(@sections) && !force_refresh

  metadata_key = @metadata.respond_to?(:cache_key) ? @metadata.cache_key : @metadata.gem_name
  cache_key = "sections-v10-#{metadata_key}"
  serialized = if cache_only
    Cache.peek(cache_key)
  else
    Cache.fetch(cache_key, force: force_refresh) do
      JSON.generate(compute_sections(force_refresh: force_refresh))
    end
  end

  result = if serialized
    decode_sections(serialized)
  elsif cache_only
    nil
  else
    compute_sections(force_refresh: force_refresh)
  end

  @sections = result unless cache_only
  result
end

#sections_for_versions(versions, cache_only: false, force_refresh: false, use_github_cli: false) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/gemstar/change_log.rb', line 71

def sections_for_versions(versions, cache_only: false, force_refresh: false, use_github_cli: false)
  requested_versions = normalize_requested_versions(versions)
  return {} if requested_versions.empty?

  cached_sections = sections(cache_only: true) || {}
  result = cached_sections.select { |version, _| requested_versions.include?(normalize_version_key(version)) }
  return result if cache_only

  changelog_sections = parse_changelog_sections(cache_only: false, force_refresh: force_refresh) || {}
  changelog_sections.each do |version, lines|
    result[version] ||= lines if requested_versions.include?(normalize_version_key(version))
  end

  repo_uri = @metadata&.repo_uri(cache_only: false, force_refresh: force_refresh)
  if repo_uri&.include?("github.com")
    missing_versions = requested_versions - result.keys.map { |version| normalize_version_key(version) }
    missing_versions.each do |version|
      specific_release = parse_specific_github_release_pages(
        repo_uri,
        version,
        cache_only: false,
        force_refresh: force_refresh,
        use_github_cli: use_github_cli
      )
      result.merge!(specific_release) if specific_release
    end
  end

  result
end