Class: Semverve::VersionChecks::DocReferences

Inherits:
Check
  • Object
show all
Defined in:
lib/semverve/version_checks.rb

Overview

Documentation/reference version check.

Instance Method Summary collapse

Methods inherited from Check

#fix_label, #task_arguments

Constructor Details

#initialize(scanner: VersionReferences) ⇒ Semverve::VersionChecks::DocReferences

Initializes the check.

Parameters:

  • scanner (Class) (defaults to: VersionReferences) 


181
182
183
 
# File 'lib/semverve/version_checks.rb', line 181

def initialize(scanner: VersionReferences)
  @scanner = scanner
end

Instance Method Details

#check_description ⇒ String

Focused check task description.

Returns:

  • (String) 


205
206
207
 
# File 'lib/semverve/version_checks.rb', line 205

def check_description
  "Check configured files for stale version references"
end

#clean_message ⇒ String

Message printed when no findings or replacements exist.

Returns:

  • (String) 


229
230
231
 
# File 'lib/semverve/version_checks.rb', line 229

def clean_message
  "Version references are current."
end

#exact_target_fix_noop_notice? ⇒ Boolean

Returns:

  • (Boolean) 


237
238
239
 
# File 'lib/semverve/version_checks.rb', line 237

def exact_target_fix_noop_notice?
  true
end

#finding_label ⇒ String

Label printed for findings and replacement counts.

Returns:

  • (String) 


221
222
223
 
# File 'lib/semverve/version_checks.rb', line 221

def finding_label
  "version reference"
end

#findings(configuration, current_version, include_ignored: false, target_version: nil) ⇒ Object 



241
242
243
244
245
246
247
248
 
# File 'lib/semverve/version_checks.rb', line 241

def findings(configuration, current_version, include_ignored: false, target_version: nil)
  scanner.new(
    configuration,
    current_version,
    include_ignored: include_ignored,
    target_version: target_version
  ).findings
end

#fix(configuration, current_version, target_version: nil) ⇒ Object 



250
251
252
 
# File 'lib/semverve/version_checks.rb', line 250

def fix(configuration, current_version, target_version: nil)
  scanner.new(configuration, current_version, target_version: target_version).fix
end

#fix_description ⇒ String

Focused fix task description.

Returns:

  • (String) 


213
214
215
 
# File 'lib/semverve/version_checks.rb', line 213

def fix_description
  "Replace stale version references in configured files"
end

#name ⇒ Symbol

Public check name used in config.version_checks.

Returns:

  • (Symbol) 


189
190
191
 
# File 'lib/semverve/version_checks.rb', line 189

def name
  :doc_references
end

#targetable? ⇒ Boolean

Returns:

  • (Boolean) 


233
234
235
 
# File 'lib/semverve/version_checks.rb', line 233

def targetable?
  true
end

#task_name ⇒ Symbol

Focused Rake task suffix.

Returns:

  • (Symbol) 


197
198
199
 
# File 'lib/semverve/version_checks.rb', line 197

def task_name
  :references
end