Module: ReleaseHx::CheckOps

Defined in:
lib/releasehx/ops/check_ops.rb

Overview

Provides validation and reporting methods for Release content quality checks. The CheckOps module contains utilities for verifying Release completeness, particularly focused on ensuring required release notes are present for issues that demand them based on configured tag requirements.

Class Method Summary collapse

Class Method Details

.extract_value(data, path, lang) ⇒ Object?

Extracts a value from structured data using the specified path and query language. Supports multiple path query languages including JMESPath for complex JSON navigation and basic hash key lookup for simple access patterns.

Parameters:

  • data (Hash, Array) —
    The structured data to query.
  • path (String) —
    The path expression for locating the target value.
  • lang (String) —
    The query language to use ('jmespath', 'jsonpath', or default hash lookup).

Returns:

  • (Object, nil) —
    The extracted value or nil if path is invalid or value not found.


19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/releasehx/ops/check_ops.rb', line 19

def self.extract_value data, path, lang
  return nil unless path.is_a?(String) && !path.empty?

  case lang.downcase
  when 'jmespath'
    JMESPath.search(path, data)
  when 'jsonpath'
    JsonPath.new(path).on(data)
  else
    data[path]
  end
end

.find_missing_note_issues(release, payload, config, mapping) ⇒ Array<Hash>

Identifies issues that require release notes but are missing them. Searches the original payload for issues tagged with the release note requirement, then cross-references with Changes that already have notes to find gaps.

Parameters:

  • release (Release) —
    The Release object containing processed Changes.
  • payload (Hash, Array) —
    The original API payload data.
  • config (Hash) —
    The configuration hash containing tag settings.
  • mapping (Hash) —
    The field mapping configuration for data extraction.

Returns:

  • (Array<Hash>) —
    Array of issue objects missing required release notes.


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
101
 
# File 'lib/releasehx/ops/check_ops.rb', line 74

def self.find_missing_note_issues release, payload, config, mapping
  # Extract release note requirement configuration
  tag_config = config['tags'] || {}
  rn_tag_key = 'release_note_needed'
  rn_slug = tag_config.dig(rn_tag_key, 'slug')&.downcase || rn_tag_key.downcase

  # Configure data extraction paths
  tick_path = mapping.dig('tick', 'path') || 'number'
  tags_path = mapping.dig('tags', 'path') || 'labels[].name'
  path_lang = mapping.dig('$config', 'path_lang') || 'jmespath'

  # Find issues tagged as requiring release notes
  payload_items = payload.is_a?(Array) ? payload : payload['issues'] || payload.values
  rn_issues = payload_items.select do |item|
    tags = extract_value(item, tags_path, path_lang)
    tags = tags.is_a?(Array) ? tags.map(&:downcase) : Array(tags).map(&:downcase)
    tags.include?(rn_slug)
  end

  # Get ticket IDs that already have notes
  noted_ticks = release.changes.reject { |c| c.note.to_s.strip == '' }.map(&:tick)

  # Return issues that need notes but don't have them
  rn_issues.reject do |item|
    tick = extract_value(item, tick_path, path_lang)
    noted_ticks.include?(tick)
  end
end

.print_check_summary(release, raw_issues_count, payload, config, mapping) ⇒ void

This method returns an undefined value.

Prints a comprehensive summary report of release note completeness. Displays statistics about the Release including issue counts, note coverage, and detailed lists of any issues missing required release notes.

Parameters:

  • release (Release) —
    The Release object to report on.
  • raw_issues_count (Integer) —
    Total number of issues fetched from the API.
  • payload (Hash, Array) —
    The original API payload data.
  • config (Hash) —
    The configuration hash containing tag settings.
  • mapping (Hash) —
    The field mapping configuration for data extraction.


43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/releasehx/ops/check_ops.rb', line 43

def self.print_check_summary release, raw_issues_count, payload, config, mapping
  missing_issues = find_missing_note_issues(release, payload, config, mapping)

  puts
  puts 'Release Note Check Report'
  puts
  puts "• Release Code:       #{release.code}"
  puts "• Issues Fetched:     #{raw_issues_count}"
  puts "• Viable Issues:      #{release.changes.size}"
  puts "• Notes Present:      #{release.changes.count { |c| c.note.to_s.strip != '' }}"
  puts "• Missing Notes:      #{missing_issues.size}"

  if missing_issues.any?
    print_issue_list('Missing required release notes:', missing_issues, config, mapping)
  else
    puts
    puts 'No missing release notes!'
  end
  puts
end

.print_issue_list(title, issues, config, mapping) ⇒ void

This method returns an undefined value.

Prints a formatted list of issues with extracted metadata. Displays issues in a consistent format with ticket IDs, summaries, and assignee information, using API-specific formatting conventions.

Parameters:

  • title (String) —
    The header title for the issue list.
  • issues (Array<Hash>) —
    Array of issue objects to display.
  • config (Hash) —
    The configuration hash for API type detection.
  • mapping (Hash) —
    The field mapping configuration for data extraction.


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/releasehx/ops/check_ops.rb', line 113

def self.print_issue_list title, issues, config, mapping
  puts
  puts title

  # Configure extraction paths for issue metadata
  tick_path = mapping.dig('tick', 'path') || 'number'
  summ_path = mapping.dig('summ', 'path') || 'title'
  lead_path = mapping.dig('lead', 'path') || 'assignee.login'
  path_lang = mapping.dig('$config', 'path_lang') || 'jmespath'
  api_type = config.dig('source', 'type')&.downcase || 'unknown'

  issues.each do |issue|
    tick = extract_value(issue, tick_path, path_lang)
    summ = extract_value(issue, summ_path, path_lang)
    lead = extract_value(issue, lead_path, path_lang)

    # Format ticket display based on API type conventions
    tick_display = api_type == 'jira' ? tick.to_s : "##{tick}"
    lead_display = lead ? " (#{lead})" : ''
    puts " - #{tick_display}: #{summ}#{lead_display}"
  end
end