semverve 0.2.1 → 0.4.0

data/lib/semverve/task.rb

@@ -3,13 +3,12 @@
 require "rake"
 
 require_relative "../semverve"
+require_relative "adapters"
 require_relative "generator"
 require_relative "published_version"
 require_relative "semantic_version"
 require_relative "version_file"
-require_relative "version_code_references"
-require_relative "version_metadata"
-require_relative "version_references"
+require_relative "version_checks"
 
 module Semverve
   ##
@@ -115,24 +114,16 @@ module Semverve
         end
 
         desc "Check version references, code literals, and metadata"
-        task :check do
-          check
+        task :check, [:version] do |_task, args|
+          check(args)
         end
 
         namespace :check do
-          desc "Check configured files for stale version references"
-          task :references do
-            check_references
-          end
-
-          desc "Check configured code files for version literals"
-          task :code do
-            check_code
-          end
-
-          desc "Check gem metadata for version mismatches"
-          task :metadata do
-            check_metadata
+          version_checks.each do |version_check|
+            desc version_check.check_description
+            task version_check.task_name, version_check.task_arguments do |_task, args|
+              check_version_check(version_check, args)
+            end
           end
 
           desc "Check whether the current gem version is already published"
@@ -147,24 +138,16 @@ module Semverve
         end
 
         desc "Fix version references, code literals, and metadata"
-        task :fix do
-          fix
+        task :fix, [:version] do |_task, args|
+          fix(args)
         end
 
         namespace :fix do
-          desc "Replace stale version references in configured files"
-          task :references do
-            fix_references
-          end
-
-          desc "Replace safe code version literals in configured files"
-          task :code do
-            fix_code
-          end
-
-          desc "Fix safe gem metadata version mismatches"
-          task :metadata do
-            fix_metadata
+          version_checks.each do |version_check|
+            desc version_check.fix_description
+            task version_check.task_name, version_check.task_arguments do |_task, args|
+              fix_version_check(version_check, args)
+            end
           end
         end
       end
@@ -203,11 +186,14 @@ module Semverve
     # Checks all version-maintenance surfaces.
     #
     # @return [void]
-    def check
+    def check(args = nil)
       configuration, current_version = check_context
+      target_version = target_version_argument(args, "semverve:check")
       report_findings(
-        check_groups(configuration, current_version),
+        check_groups(configuration, current_version, target_version),
         current_version,
+        target_version: target_version,
+        fix_task_name: "semverve:fix",
         clean_message: "Version checks passed."
       )
     end
@@ -216,72 +202,79 @@ module Semverve
     # Fixes all check surfaces.
     #
     # @return [void]
-    def fix
+    def fix(args = nil)
       configuration, current_version = check_context
-      report_fix_results(fix_results(configuration, current_version))
+      target_version = target_version_argument(args, "semverve:fix")
+      return report_current_target_noop(target_version) if target_version == current_version
+
+      report_fix_results(fix_results(configuration, current_version, target_version))
     end
 
     ##
-    # Checks configured files for stale version references.
+    # Checks a single registered version check.
+    #
+    # @param [#findings] version_check
+    # @param [Rake::TaskArguments, nil] args
     #
     # @return [void]
-    def check_references
+    def check_version_check(version_check, args = nil)
       configuration, current_version = check_context
+      target_version = check_target_version(version_check, args, "semverve:check:#{version_check.task_name}")
       report_findings(
-        [["version reference", VersionReferences.new(configuration, current_version, include_ignored: report_ignored?).findings]],
+        [[
+          version_check,
+          version_check.finding_label,
+          version_check.findings(
+            configuration,
+            current_version,
+            include_ignored: report_ignored?,
+            target_version: target_version
+          )
+        ]],
         current_version,
-        clean_message: "Version references are current."
+        target_version: target_version,
+        fix_task_name: "semverve:fix:#{version_check.task_name}",
+        clean_message: version_check.clean_message
       )
     end
 
     ##
-    # Replaces stale version references in configured files.
+    # Fixes a single registered version check.
+    #
+    # @param [#fix] version_check
+    # @param [Rake::TaskArguments, nil] args
     #
     # @return [void]
-    def fix_references
+    def fix_version_check(version_check, args = nil)
       configuration, current_version = check_context
+      target_version = check_target_version(version_check, args, "semverve:fix:#{version_check.task_name}")
+      return report_current_target_noop(target_version) if target_version == current_version
+
       report_fix_results(
-        [["version reference", VersionReferences.new(configuration, current_version).fix]],
-        clean_message: "Version references are current."
+        [[
+          version_check.fix_label,
+          version_check.fix(configuration, current_version, target_version: target_version)
+        ]],
+        clean_message: version_check.clean_message
       )
     end
 
     ##
-    # Checks configured code files for version literals.
+    # Registered version checks available to tasks.
     #
-    # @return [void]
-    def check_code
-      configuration, current_version = check_context
-      report_findings(
-        [["code version literal", VersionCodeReferences.new(configuration, current_version, include_ignored: report_ignored?).findings]],
-        current_version,
-        clean_message: "Code version literals are current."
-      )
+    # @return [Array<#name>]
+    def version_checks
+      VersionChecks.all(extra_checks: Adapters.checks)
     end
 
     ##
-    # Replaces safe code version literals in configured files.
+    # Fetches a registered version check.
     #
-    # @return [void]
-    def fix_code
-      configuration, current_version = check_context
-      report_fix_results(
-        [["code version literal", VersionCodeReferences.new(configuration, current_version).fix]],
-        clean_message: "Code version literals are current."
-      )
-    end
-
-    ##
-    # Checks gem metadata for version mismatches.
+    # @param [Symbol, String] name
     #
-    # @return [void]
-    def check_metadata
-      configuration, current_version = check_context
-      report_findings(
-        [[nil, VersionMetadata.new(configuration, current_version).findings]],
-        current_version,
-        clean_message: "Version metadata is current."
-      )
+    # @return [#name]
+    def version_check(name)
+      VersionChecks.fetch(name, extra_checks: Adapters.checks)
     end
 
     ##
@@ -309,18 +302,6 @@ module Semverve
       puts "Release checks passed."
     end
 
-    ##
-    # Fixes safe gem metadata version mismatches.
-    #
-    # @return [void]
-    def fix_metadata
-      configuration, current_version = check_context
-      report_fix_results(
-        [["metadata version", VersionMetadata.new(configuration, current_version).fix]],
-        clean_message: "Version metadata is current."
-      )
-    end
-
     ##
     # Resolved configuration and current version for check tasks.
     #
@@ -336,19 +317,23 @@ module Semverve
     # @param [Semverve::ResolvedConfiguration] configuration
     # @param [Semverve::SemanticVersion] current_version
     #
-    # @return [Array<Array(String, Array)>]
-    def check_groups(configuration, current_version)
-      groups = []
-      if configuration.version_checks.include?(:doc_references)
-        groups << ["version reference", VersionReferences.new(configuration, current_version, include_ignored: report_ignored?).findings]
-      end
-      if configuration.version_checks.include?(:code_references)
-        groups << ["code version literal", VersionCodeReferences.new(configuration, current_version, include_ignored: report_ignored?).findings]
-      end
-      if configuration.version_checks.include?(:metadata)
-        groups << [nil, VersionMetadata.new(configuration, current_version).findings]
+    # @param [Semverve::SemanticVersion, nil] target_version
+    #
+    # @return [Array<Array(#name, String, Array)>]
+    def check_groups(configuration, current_version, target_version = nil)
+      configuration.version_checks.map do |check_name|
+        version_check = version_check(check_name)
+        [
+          version_check,
+          version_check.finding_label,
+          version_check.findings(
+            configuration,
+            current_version,
+            include_ignored: report_ignored?,
+            target_version: target_version_for(version_check, target_version)
+          )
+        ]
       end
-      groups
     end
 
     ##
@@ -412,25 +397,67 @@ module Semverve
       version
     end
 
+    ##
+    # Optional exact version argument for check and fix tasks.
+    #
+    # @param [Rake::TaskArguments, nil] args
+    # @param [String] task_name
+    #
+    # @return [Semverve::SemanticVersion, nil]
+    def target_version_argument(args, task_name)
+      version = args&.[](:version)
+      return nil if version.nil? || version.empty?
+
+      SemanticVersion.parse(version)
+    rescue Error
+      raise Error, "Run rake '#{task_name}[MAJOR.MINOR.PATCH]'."
+    end
+
+    ##
+    # Optional exact version argument for checks that support targeting.
+    #
+    # @param [#targetable?] version_check
+    # @param [Rake::TaskArguments, nil] args
+    # @param [String] task_name
+    #
+    # @return [Semverve::SemanticVersion, nil]
+    def check_target_version(version_check, args, task_name)
+      return nil unless version_check.targetable?
+
+      target_version_argument(args, task_name)
+    end
+
+    ##
+    # Applies an umbrella target only to checks that support targeting.
+    #
+    # @param [#targetable?] version_check
+    # @param [Semverve::SemanticVersion, nil] target_version
+    #
+    # @return [Semverve::SemanticVersion, nil]
+    def target_version_for(version_check, target_version)
+      version_check.targetable? ? target_version : nil
+    end
+
     ##
     # Fix results enabled for the umbrella fix task.
     #
     # @param [Semverve::ResolvedConfiguration] configuration
     # @param [Semverve::SemanticVersion] current_version
+    # @param [Semverve::SemanticVersion, nil] target_version
     #
     # @return [Array<Array(String, #replacement_count, #changed_files)>]
-    def fix_results(configuration, current_version)
-      results = []
-      if configuration.version_checks.include?(:doc_references)
-        results << ["version reference", VersionReferences.new(configuration, current_version).fix]
-      end
-      if configuration.version_checks.include?(:code_references)
-        results << ["code version literal", VersionCodeReferences.new(configuration, current_version).fix]
+    def fix_results(configuration, current_version, target_version = nil)
+      configuration.version_checks.map do |check_name|
+        version_check = version_check(check_name)
+        [
+          version_check.fix_label,
+          version_check.fix(
+            configuration,
+            current_version,
+            target_version: target_version_for(version_check, target_version)
+          )
+        ]
       end
-      if configuration.version_checks.include?(:metadata)
-        results << ["metadata version", VersionMetadata.new(configuration, current_version).fix]
-      end
-      results
     end
 
     ##
@@ -438,12 +465,14 @@ module Semverve
     #
     # @param [Array<Array(String, Array)>] groups
     # @param [Semverve::SemanticVersion] current_version
+    # @param [Semverve::SemanticVersion, nil] target_version
+    # @param [String, nil] fix_task_name
     # @param [String] clean_message
     #
     # @return [void]
-    def report_findings(groups, current_version, clean_message:)
-      findings = groups.flat_map do |(label, group_findings)|
-        group_findings.map { |finding| [label || finding.label, finding] }
+    def report_findings(groups, current_version, clean_message:, target_version: nil, fix_task_name: nil)
+      findings = groups.flat_map do |(version_check, label, group_findings)|
+        group_findings.map { |finding| [version_check, label || finding.label, finding] }
       end
 
       if findings.empty?
@@ -451,14 +480,37 @@ module Semverve
         return
       end
 
-      findings.each do |(label, finding)|
+      findings.each do |(_version_check, label, finding)|
         puts "#{finding.path}:#{finding.line}:#{finding.column}: #{label} #{finding.version} -> #{current_version}"
       end
+      if target_version == current_version && fix_task_name && exact_target_fix_noop_findings?(findings)
+        puts "Target version #{target_version} is already current; #{fix_task_name}[#{target_version}] will not change these references."
+      end
 
       issue = findings.one? ? "issue" : "issues"
       raise Error, "Found #{findings.count} version check #{issue}."
     end
 
+    ##
+    # Prints a no-op message for exact fix requests targeting the current version.
+    #
+    # @param [Semverve::SemanticVersion, nil] target_version
+    #
+    # @return [void]
+    def report_current_target_noop(target_version)
+      puts "Target version #{target_version} is already current; nothing to fix."
+    end
+
+    ##
+    # Whether findings include surfaces controlled by exact-target fixes.
+    #
+    # @param [Array<Array(#exact_target_fix_noop_notice?, String, Object)>] findings
+    #
+    # @return [Boolean]
+    def exact_target_fix_noop_findings?(findings)
+      findings.any? { |(version_check, _label, _finding)| version_check.exact_target_fix_noop_notice? }
+    end
+
     ##
     # Prints fix results.
     #
@@ -468,7 +520,7 @@ module Semverve
     # @return [void]
     def report_fix_results(results, clean_message: "Version checks passed.")
       replacement_count = results.sum { |(_label, result)| result.replacement_count }
-      bundle_lock_ran = results.any? { |(_label, result)| result.respond_to?(:bundle_lock_ran) && result.bundle_lock_ran }
+      bundle_lock_ran = results.any? { |(_label, result)| result.bundle_lock_ran }
 
       if replacement_count.zero? && !bundle_lock_ran
         puts clean_message

data/lib/semverve/version.rb

@@ -15,13 +15,13 @@ module Semverve
     # Minor version.
     #
     # @return [Integer]
-    MINOR = 2
+    MINOR = 4
 
     ##
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 1
+    PATCH = 0
 
     module_function