Class: Semverve::VersionChecks::CodeReferences

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

Overview

Code literal version check.

Instance Method Summary collapse

Methods inherited from Check

#fix_label, #task_arguments

Constructor Details

#initialize(scanner: VersionCodeReferences) ⇒ Semverve::VersionChecks::CodeReferences

Initializes the check.

Parameters:

  • scanner (Class) (defaults to: VersionCodeReferences) 


272
273
274
 
# File 'lib/semverve/version_checks.rb', line 272

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

Instance Method Details

#check_description ⇒ String

Focused check task description.

Returns:

  • (String) 


296
297
298
 
# File 'lib/semverve/version_checks.rb', line 296

def check_description
  "Check configured code files for version literals"
end

#clean_message ⇒ String

Message printed when no findings or replacements exist.

Returns:

  • (String) 


320
321
322
 
# File 'lib/semverve/version_checks.rb', line 320

def clean_message
  "Code version literals are current."
end

#exact_target_fix_noop_notice? ⇒ Boolean

Returns:

  • (Boolean) 


328
329
330
 
# File 'lib/semverve/version_checks.rb', line 328

def exact_target_fix_noop_notice?
  true
end

#finding_label ⇒ String

Label printed for findings and replacement counts.

Returns:

  • (String) 


312
313
314
 
# File 'lib/semverve/version_checks.rb', line 312

def finding_label
  "code version literal"
end

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



332
333
334
335
336
337
338
339
 
# File 'lib/semverve/version_checks.rb', line 332

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 



341
342
343
 
# File 'lib/semverve/version_checks.rb', line 341

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) 


304
305
306
 
# File 'lib/semverve/version_checks.rb', line 304

def fix_description
  "Replace safe code version literals in configured files"
end

#name ⇒ Symbol

Public check name used in config.version_checks.

Returns:

  • (Symbol) 


280
281
282
 
# File 'lib/semverve/version_checks.rb', line 280

def name
  :code_references
end

#targetable? ⇒ Boolean

Returns:

  • (Boolean) 


324
325
326
 
# File 'lib/semverve/version_checks.rb', line 324

def targetable?
  true
end

#task_name ⇒ Symbol

Focused Rake task suffix.

Returns:

  • (Symbol) 


288
289
290
 
# File 'lib/semverve/version_checks.rb', line 288

def task_name
  :code
end