semverve 0.2.1 → 0.4.0

data/lib/semverve/adapters.rb

@@ -0,0 +1,292 @@
+# frozen_string_literal: true
+
+require_relative "error"
+require_relative "version_checks"
+
+module Semverve
+  ##
+  # Framework-specific configuration adapters.
+  module Adapters
+    class << self
+      ##
+      # Registers a framework adapter.
+      #
+      # @param [#name, #defaults, #checks] adapter
+      #
+      # @return [#name, #defaults, #checks]
+      def register(adapter)
+        adapters[adapter.name] = adapter
+      end
+
+      ##
+      # Returns an adapter by name.
+      #
+      # @param [Symbol, String] name
+      #
+      # @return [#name, #defaults, #checks]
+      def fetch(name)
+        normalized_name = normalize_name(name)
+        adapter = adapters[normalized_name]
+        return adapter if adapter
+
+        raise Error, unknown_adapter_message(name)
+      end
+
+      ##
+      # Defaults for the configured adapter.
+      #
+      # @param [Symbol, String, nil] name
+      # @param [Semverve::Configuration] configuration
+      #
+      # @return [Hash]
+      def defaults_for(name, configuration)
+        return {} unless name
+
+        fetch(name).defaults(configuration)
+      end
+
+      ##
+      # Checks supplied by all registered adapters.
+      #
+      # @return [Array<#name>]
+      def checks
+        adapters.values.flat_map(&:checks).each_with_object({}) do |check, checks|
+          checks[check.name] = check
+        end.values
+      end
+
+      ##
+      # Checks supplied by the configured adapter.
+      #
+      # @param [Symbol, String, nil] name
+      #
+      # @return [Array<#name>]
+      def checks_for(name)
+        return [] unless name
+
+        fetch(name).checks
+      end
+
+      ##
+      # Whether package names should be inferred for the configured adapter.
+      #
+      # @param [Symbol, String, nil] name
+      #
+      # @return [Boolean]
+      def infer_package_name?(name)
+        return true unless name
+
+        fetch(name).infer_package_name?
+      end
+
+      ##
+      # Registered adapter names.
+      #
+      # @return [Array<Symbol>]
+      def names
+        adapters.keys
+      end
+
+      private
+
+      ##
+      # Adapter registry.
+      #
+      # @return [Hash<Symbol, #name>]
+      def adapters
+        @adapters ||= {}
+      end
+
+      ##
+      # Normalizes an adapter name.
+      #
+      # @param [Object] name
+      #
+      # @return [Symbol, Object]
+      def normalize_name(name)
+        name.respond_to?(:to_sym) ? name.to_sym : name
+      end
+
+      ##
+      # Error message for invalid adapters.
+      #
+      # @param [Object] name
+      #
+      # @return [String]
+      def unknown_adapter_message(name)
+        adapter_names = names.map(&:inspect)
+        valid_adapters = "#{adapter_names[0...-1].join(", ")}, or #{adapter_names.last}"
+        "Unknown adapter #{name.inspect}. Use #{valid_adapters}."
+      end
+    end
+
+    ##
+    # Shared adapter helpers.
+    class Base
+      ##
+      # Framework-specific checks.
+      #
+      # @return [Array<#name>]
+      def checks
+        []
+      end
+
+      ##
+      # Whether Semverve should infer package names from version files or gemspecs.
+      #
+      # @return [Boolean]
+      def infer_package_name?
+        true
+      end
+
+      private
+
+      ##
+      # Module name fallback based on the project directory.
+      #
+      # @param [String] root
+      #
+      # @return [String]
+      def project_module_name(root)
+        camelize(File.basename(File.expand_path(root)))
+      end
+
+      ##
+      # Converts a project directory into a Ruby module name.
+      #
+      # @param [String] value
+      #
+      # @return [String]
+      def camelize(value)
+        value.split(/[_-]/).map(&:capitalize).join
+      end
+    end
+
+    ##
+    # Rails application adapter.
+    class Rails < Base
+      ##
+      # Adapter name.
+      #
+      # @return [Symbol]
+      def name
+        :rails
+      end
+
+      ##
+      # Rails-specific Semverve defaults.
+      #
+      # @param [Semverve::Configuration] _configuration
+      #
+      # @return [Hash]
+      def defaults(_configuration)
+        root = rails_root || Dir.pwd
+
+        {
+          format: :simple,
+          module_name: rails_module_name || project_module_name(root),
+          root: root,
+          version_checks: [:doc_references, :code_references, :rails_config_metadata],
+          version_file: File.join("config", "version.rb")
+        }
+      end
+
+      ##
+      # Rails-specific checks.
+      #
+      # @return [Array<#name>]
+      def checks
+        [VersionChecks::RailsConfigMetadataCheck.new]
+      end
+
+      ##
+      # Rails apps should not infer a package name from config/version.rb.
+      #
+      # @return [Boolean]
+      def infer_package_name?
+        false
+      end
+
+      private
+
+      ##
+      # Rails.root when Rails is available.
+      #
+      # @return [String, nil]
+      def rails_root
+        return unless rails_defined?
+        return unless ::Rails.respond_to?(:root)
+        return unless ::Rails.root
+
+        ::Rails.root.to_s
+      end
+
+      ##
+      # Application module name inferred from Rails.application.
+      #
+      # @return [String, nil]
+      def rails_module_name
+        return unless rails_defined?
+        return unless ::Rails.respond_to?(:application)
+        return unless ::Rails.application
+
+        application_class = ::Rails.application.class
+        return application_class.module_parent_name if application_class.respond_to?(:module_parent_name)
+
+        class_name = application_class.name
+        return unless class_name&.include?("::")
+
+        class_name.split("::").first
+      end
+
+      ##
+      # Whether Rails is loaded.
+      #
+      # @return [Boolean]
+      def rails_defined?
+        Object.const_defined?(:Rails)
+      end
+    end
+
+    ##
+    # Sinatra application adapter.
+    class Sinatra < Base
+      ##
+      # Adapter name.
+      #
+      # @return [Symbol]
+      def name
+        :sinatra
+      end
+
+      ##
+      # Sinatra-specific Semverve defaults.
+      #
+      # @param [Semverve::Configuration] _configuration
+      #
+      # @return [Hash]
+      def defaults(_configuration)
+        root = Dir.pwd
+
+        {
+          format: :simple,
+          module_name: project_module_name(root),
+          root: root,
+          version_checks: [:doc_references, :code_references],
+          version_file: File.join("config", "version.rb")
+        }
+      end
+
+      ##
+      # Sinatra apps should not infer a package name from config/version.rb.
+      #
+      # @return [Boolean]
+      def infer_package_name?
+        false
+      end
+    end
+  end
+end
+
+Semverve::Adapters.register(Semverve::Adapters::Rails.new)
+Semverve::Adapters.register(Semverve::Adapters::Sinatra.new)

data/lib/semverve/configuration.rb

@@ -2,9 +2,10 @@
 
 require "rake"
 
+require_relative "adapters"
 require_relative "error"
-require_relative "presets"
 require_relative "project_metadata"
+require_relative "version_checks"
 
 module Semverve
   ##
@@ -14,7 +15,13 @@ module Semverve
     # Version-maintenance surfaces supported by umbrella check and fix tasks.
     #
     # @return [Array<Symbol>]
-    VALID_VERSION_CHECKS = [:doc_references, :code_references, :metadata].freeze
+    VALID_VERSION_CHECKS = VersionChecks.names(extra_checks: Adapters.checks).freeze
+
+    ##
+    # Default version-maintenance surfaces for package projects.
+    #
+    # @return [Array<Symbol>]
+    DEFAULT_VERSION_CHECKS = VersionChecks.default_names.freeze
 
     ##
     # Release-readiness surfaces supported by release check tasks.
@@ -26,7 +33,13 @@ module Semverve
     # Default Ruby pattern for code version literals that are safe to rewrite.
     #
     # @return [Regexp]
-    DEFAULT_VERSION_CODE_REFERENCE_PATTERN = /^\s*(?:(?:[A-Z]\w*::)*(?:[A-Z]\w*VERSION[A-Z0-9_]*|VERSION)|(?:[a-z_]\w*|self)\.version)\s*=\s*(?<quote>["'])(?<version>\d+\.\d+\.\d+)\k<quote>/
+    DEFAULT_VERSION_CODE_REFERENCE_PATTERN = VersionCodeReferences::RUBY_ASSIGNMENT_PATTERN
+
+    ##
+    # Framework adapter used to apply project defaults.
+    #
+    # @return [Symbol, String, nil]
+    attr_reader :adapter
 
     ##
     # Whether increments should run +bundle lock+ after writing a version.
@@ -62,7 +75,9 @@ module Semverve
     # Framework preset used to apply project defaults.
     #
     # @return [Symbol, String, nil]
-    attr_reader :preset
+    def preset
+      adapter
+    end
 
     ##
     # Release-readiness surfaces run by the release check task.
@@ -113,10 +128,10 @@ module Semverve
     attr_reader :version_checks
 
     ##
-    # Version-reference comparison mode.
+    # Version matching mode for reference and code-literal checks.
     #
     # @return [Symbol, String]
-    attr_accessor :version_reference_mode
+    attr_accessor :version_match_mode
 
     ##
     # Initializes configuration with Semverve's default settings.
@@ -127,7 +142,7 @@ module Semverve
       @bundle_lock = false
       @command_runner = ->(command) { system(command) }
       @format = :module
-      @preset = nil
+      @adapter = nil
       @rubygems_host = "https://rubygems.org"
       @version_code_reference_files = Rake::FileList[]
       self.version_code_reference_pattern = DEFAULT_VERSION_CODE_REFERENCE_PATTERN
@@ -137,9 +152,9 @@ module Semverve
         "tmp/**/*",
         "vendor/**/*"
       )
-      @version_reference_mode = :older
+      @version_match_mode = :older
       self.release_checks = []
-      self.version_checks = VALID_VERSION_CHECKS
+      @version_checks = DEFAULT_VERSION_CHECKS
     end
 
     ##
@@ -163,7 +178,7 @@ module Semverve
         version_code_reference_files: version_code_reference_files,
         version_code_reference_pattern: version_code_reference_pattern,
         version_doc_reference_files: version_doc_reference_files,
-        version_reference_mode: normalized_version_reference_mode
+        version_match_mode: normalized_version_match_mode
       )
     end
 
@@ -178,7 +193,7 @@ module Semverve
     end
 
     ##
-    # Sets the gem name used for metadata checks.
+    # Sets the gem name used for package metadata checks.
     #
     # @param [String, nil] gem_name
     #
@@ -197,6 +212,17 @@ module Semverve
       set_explicit(:module_name, module_name)
     end
 
+    ##
+    # Sets the framework adapter used for project defaults.
+    #
+    # @param [Symbol, String, nil] adapter
+    #
+    # @return [Symbol, nil]
+    def adapter=(adapter)
+      @adapter_defaults = nil
+      @adapter = adapter.nil? ? nil : Adapters.fetch(adapter).name
+    end
+
     ##
     # Sets the framework preset used for project defaults.
     #
@@ -204,8 +230,7 @@ module Semverve
     #
     # @return [Symbol, nil]
     def preset=(preset)
-      @preset_defaults = nil
-      @preset = preset.nil? ? nil : Presets.fetch(preset).name
+      self.adapter = preset
     end
 
     ##
@@ -256,7 +281,7 @@ module Semverve
     #
     # @return [Array<Symbol>]
     def version_checks=(checks)
-      @version_checks = normalize_version_checks(checks)
+      set_explicit(:version_checks, normalize_version_checks(checks))
     end
 
     ##
@@ -291,25 +316,33 @@ module Semverve
     # @return [Object]
     def resolved_value(attribute)
       return public_send(attribute) if explicit_attribute?(attribute)
-      return preset_defaults[attribute] if preset_defaults.key?(attribute)
+      return adapter_defaults[attribute] if adapter_defaults.key?(attribute)
 
       public_send(attribute)
     end
 
+    ##
+    # Whether package names should be inferred from project files.
+    #
+    # @return [Boolean]
+    def infer_package_name?
+      Adapters.infer_package_name?(adapter)
+    end
+
     ##
     # Configured version checks normalized for lookup.
     #
     # @return [Array<Symbol>]
     def normalized_version_checks
-      normalize_version_checks(version_checks)
+      normalize_version_checks(resolved_value(:version_checks))
     end
 
     ##
-    # Configured version-reference mode normalized for lookup.
+    # Configured version matching mode normalized for lookup.
     #
     # @return [Symbol]
-    def normalized_version_reference_mode
-      version_reference_mode.to_sym
+    def normalized_version_match_mode
+      version_match_mode.to_sym
     end
 
     ##
@@ -319,15 +352,7 @@ module Semverve
     #
     # @return [Array<Symbol>]
     def normalize_version_checks(checks)
-      normalized_checks = Array(checks).map do |check|
-        check.respond_to?(:to_sym) ? check.to_sym : check
-      end
-      return normalized_checks if normalized_checks.all? { |check| VALID_VERSION_CHECKS.include?(check) }
-
-      invalid_checks = normalized_checks.reject { |check| VALID_VERSION_CHECKS.include?(check) }
-      valid_check_names = VALID_VERSION_CHECKS.map(&:inspect)
-      valid_checks = "#{valid_check_names[0...-1].join(", ")}, or #{valid_check_names.last}"
-      raise Error, "Unknown version check #{invalid_checks.map(&:inspect).join(", ")}. Use #{valid_checks}."
+      VersionChecks.normalize(checks, extra_checks: Adapters.checks)
     end
 
     ##
@@ -382,17 +407,17 @@ module Semverve
     #
     # @return [Object]
     def set_explicit(attribute, value)
-      @preset_defaults = nil
+      @adapter_defaults = nil
       @explicit_attributes << attribute unless explicit_attribute?(attribute)
       instance_variable_set(:"@#{attribute}", value)
     end
 
     ##
-    # Defaults supplied by the configured preset.
+    # Defaults supplied by the configured adapter.
     #
     # @return [Hash]
-    def preset_defaults
-      @preset_defaults ||= Presets.defaults_for(preset, self)
+    def adapter_defaults
+      @adapter_defaults ||= Adapters.defaults_for(adapter, self)
     end
   end
 
@@ -420,7 +445,7 @@ module Semverve
     ##
     # Resolved gem name.
     #
-    # @return [String]
+    # @return [String, nil]
     attr_reader :gem_name
 
     ##
@@ -478,10 +503,10 @@ module Semverve
     attr_reader :version_doc_reference_files
 
     ##
-    # Resolved version-reference comparison mode.
+    # Resolved version matching mode for reference and code-literal checks.
     #
     # @return [Symbol]
-    attr_reader :version_reference_mode
+    attr_reader :version_match_mode
 
     ##
     # Initializes a resolved configuration.
@@ -489,7 +514,7 @@ module Semverve
     # @param [Boolean] bundle_lock
     # @param [#call] command_runner
     # @param [Symbol] format
-    # @param [String] gem_name
+    # @param [String, nil] gem_name
     # @param [String] module_name
     # @param [Array<Symbol>] release_checks
     # @param [String] root
@@ -499,7 +524,7 @@ module Semverve
     # @param [Rake::FileList] version_code_reference_files
     # @param [Regexp] version_code_reference_pattern
     # @param [Rake::FileList] version_doc_reference_files
-    # @param [Symbol] version_reference_mode
+    # @param [Symbol] version_match_mode
     #
     # @return [Semverve::ResolvedConfiguration]
     def initialize(
@@ -516,7 +541,7 @@ module Semverve
       version_code_reference_files:,
       version_code_reference_pattern:,
       version_doc_reference_files:,
-      version_reference_mode:
+      version_match_mode:
     )
       @bundle_lock = bundle_lock
       @command_runner = command_runner
@@ -531,7 +556,7 @@ module Semverve
       @version_code_reference_files = version_code_reference_files
       @version_code_reference_pattern = version_code_reference_pattern
       @version_doc_reference_files = version_doc_reference_files
-      @version_reference_mode = version_reference_mode
+      @version_match_mode = version_match_mode
     end
 
     ##

data/lib/semverve/finding.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Semverve
+  ##
+  # A version mismatch found by a Semverve check.
+  class Finding
+    ##
+    # Path relative to the configured project root.
+    #
+    # @return [String]
+    attr_reader :path
+
+    ##
+    # One-based line number.
+    #
+    # @return [Integer]
+    attr_reader :line
+
+    ##
+    # One-based column number.
+    #
+    # @return [Integer]
+    attr_reader :column
+
+    ##
+    # Referenced semantic version.
+    #
+    # @return [Semverve::SemanticVersion]
+    attr_reader :version
+
+    ##
+    # Optional output label for findings that carry their own label.
+    #
+    # @return [String, nil]
+    attr_reader :label
+
+    ##
+    # Initializes a finding.
+    #
+    # @param [String] path
+    # @param [Integer] line
+    # @param [Integer] column
+    # @param [Semverve::SemanticVersion] version
+    # @param [String, nil] label
+    #
+    # @return [Semverve::Finding]
+    def initialize(path:, line:, column:, version:, label: nil)
+      @path = path
+      @line = line
+      @column = column
+      @version = version
+      @label = label
+    end
+  end
+end

data/lib/semverve/fix_result.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Semverve
+  ##
+  # Result of fixing one Semverve check surface.
+  class FixResult
+    ##
+    # Files changed by the fix.
+    #
+    # @return [Array<String>]
+    attr_reader :changed_files
+
+    ##
+    # Number of replacements made.
+    #
+    # @return [Integer]
+    attr_reader :replacement_count
+
+    ##
+    # Whether the fix ran +bundle lock+.
+    #
+    # @return [Boolean]
+    attr_reader :bundle_lock_ran
+
+    ##
+    # Initializes a fix result.
+    #
+    # @param [Array<String>] changed_files
+    # @param [Integer] replacement_count
+    # @param [Boolean] bundle_lock_ran
+    #
+    # @return [Semverve::FixResult]
+    def initialize(changed_files:, replacement_count:, bundle_lock_ran: false)
+      @changed_files = changed_files
+      @replacement_count = replacement_count
+      @bundle_lock_ran = bundle_lock_ran
+    end
+  end
+end