semverve 0.3.0 → 0.4.0

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.
@@ -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
@@ -139,7 +154,7 @@ module Semverve
       )
       @version_match_mode = :older
       self.release_checks = []
-      self.version_checks = VALID_VERSION_CHECKS
+      @version_checks = DEFAULT_VERSION_CHECKS
     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,17 +316,25 @@ 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
 
     ##
@@ -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
 
     ##
@@ -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

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

data/lib/semverve/{version_metadata.rb → package_metadata.rb}

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
-require "bundler"
 require "rubygems"
 
+require_relative "finding"
+require_relative "fix_result"
 require_relative "semantic_version"
 
 module Semverve
   ##
-  # Checks generated gem metadata against the configured version file.
-  class VersionMetadata
+  # Checks generated package metadata against the configured version file.
+  class PackageMetadata
     ##
     # Literal gemspec version assignments that can be safely rewritten.
     #
@@ -16,117 +17,29 @@ module Semverve
     GEMSPEC_LITERAL_PATTERN = /^(\s*\w+\.version\s*=\s*)(["'])(\d+\.\d+\.\d+)(\2)/
 
     ##
-    # A metadata version mismatch.
-    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
-
-      ##
-      # Metadata semantic version.
-      #
-      # @return [Semverve::SemanticVersion]
-      attr_reader :version
-
-      ##
-      # Output label for the finding.
-      #
-      # @return [String]
-      attr_reader :label
-
-      ##
-      # Initializes a finding.
-      #
-      # @param [String] path
-      # @param [Integer] line
-      # @param [Integer] column
-      # @param [Semverve::SemanticVersion] version
-      # @param [String] label
-      #
-      # @return [Semverve::VersionMetadata::Finding]
-      def initialize(path:, line:, column:, version:, label:)
-        @path = path
-        @line = line
-        @column = column
-        @version = version
-        @label = label
-      end
-    end
-
-    ##
-    # Result of fixing metadata version mismatches.
-    class FixResult
-      ##
-      # Files changed by the fix.
-      #
-      # @return [Array<String>]
-      attr_reader :changed_files
-
-      ##
-      # Number of literal replacements made.
-      #
-      # @return [Integer]
-      attr_reader :replacement_count
-
-      ##
-      # Whether bundle lock was run.
-      #
-      # @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::VersionMetadata::FixResult]
-      def initialize(changed_files:, replacement_count:, bundle_lock_ran:)
-        @changed_files = changed_files
-        @replacement_count = replacement_count
-        @bundle_lock_ran = bundle_lock_ran
-      end
-    end
-
-    ##
-    # Initializes metadata version checking.
+    # Initializes package metadata version checking.
     #
     # @param [Semverve::ResolvedConfiguration] configuration
     # @param [Semverve::SemanticVersion] current_version
     #
-    # @return [Semverve::VersionMetadata]
+    # @return [Semverve::PackageMetadata]
     def initialize(configuration, current_version)
       @configuration = configuration
       @current_version = current_version
     end
 
     ##
-    # Metadata mismatches.
+    # Package metadata mismatches.
     #
-    # @return [Array<Semverve::VersionMetadata::Finding>]
+    # @return [Array<Semverve::Finding>]
     def findings
       [gemspec_finding, lockfile_finding].compact
     end
 
     ##
-    # Fixes safe metadata mismatches.
+    # Fixes safe package metadata mismatches.
     #
-    # @return [Semverve::VersionMetadata::FixResult]
+    # @return [Semverve::FixResult]
     def fix
       changed_files = []
       replacement_count = fix_gemspec_literal
@@ -135,7 +48,7 @@ module Semverve
 
       bundle_lock_ran = lockfile_finding ? run_bundle_lock : false
 
-      FixResult.new(
+      Semverve::FixResult.new(
         changed_files: changed_files,
         replacement_count: replacement_count,
         bundle_lock_ran: bundle_lock_ran
@@ -151,7 +64,7 @@ module Semverve
     attr_reader :configuration
 
     ##
-    # Current gem version.
+    # Current package version.
     #
     # @return [Semverve::SemanticVersion]
     attr_reader :current_version
@@ -167,14 +80,14 @@ module Semverve
     ##
     # Finding for a gemspec mismatch.
     #
-    # @return [Semverve::VersionMetadata::Finding, nil]
+    # @return [Semverve::Finding, nil]
     def gemspec_finding
       return unless gemspec_file && gemspec_version
       return if gemspec_version == current_version
 
       line, column = gemspec_position
 
-      Finding.new(
+      Semverve::Finding.new(
         path: relative_path(gemspec_file),
         line: line,
         column: column,
@@ -186,7 +99,7 @@ module Semverve
     ##
     # Finding for a lockfile mismatch.
     #
-    # @return [Semverve::VersionMetadata::Finding, nil]
+    # @return [Semverve::Finding, nil]
     def lockfile_finding
       return unless File.file?(lockfile_path)
 
@@ -196,7 +109,7 @@ module Semverve
 
       line, column = lockfile_position(version)
 
-      Finding.new(
+      Semverve::Finding.new(
         path: "Gemfile.lock",
         line: line,
         column: column,
@@ -210,6 +123,8 @@ module Semverve
     #
     # @return [String, nil]
     def gemspec_file
+      return unless configuration.gem_name
+
       @gemspec_file ||= begin
         files = Dir.glob(File.join(root, "*.gemspec"))
 
@@ -271,18 +186,14 @@ module Semverve
     #
     # @return [Semverve::SemanticVersion, nil]
     def lockfile_version
-      spec = lockfile_parser.specs.find { |candidate| candidate.name == configuration.gem_name }
-      return unless spec
+      return unless configuration.gem_name
 
-      SemanticVersion.parse(spec.version.to_s)
-    end
+      File.readlines(lockfile_path).each do |line|
+        match = line.match(lockfile_line_pattern)
+        return SemanticVersion.parse(match[:version]) if match
+      end
 
-    ##
-    # Parsed Gemfile.lock.
-    #
-    # @return [Bundler::LockfileParser]
-    def lockfile_parser
-      Bundler::LockfileParser.new(File.read(lockfile_path))
+      nil
     end
 
     ##
@@ -292,16 +203,25 @@ module Semverve
     #
     # @return [Array(Integer, Integer)]
     def lockfile_position(version)
-      pattern = /^\s*#{Regexp.escape(configuration.gem_name)}\s+\(#{Regexp.escape(version.to_s)}\)/
-
       File.readlines(lockfile_path).each_with_index do |line, index|
-        match = line.match(pattern)
+        match = line.match(lockfile_line_pattern(version))
         return [index + 1, line.index(version.to_s) + 1] if match
       end
 
       [1, 1]
     end
 
+    ##
+    # Gemfile.lock line pattern for the configured package.
+    #
+    # @param [Semverve::SemanticVersion, nil] version
+    #
+    # @return [Regexp]
+    def lockfile_line_pattern(version = nil)
+      version_pattern = version ? Regexp.escape(version.to_s) : "\\d+\\.\\d+\\.\\d+"
+      /^\s*#{Regexp.escape(configuration.gem_name)}\s+\((?<version>#{version_pattern})\)/
+    end
+
     ##
     # Fixes a literal gemspec version assignment.
     #

data/lib/semverve/presets.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative "error"
+require_relative "adapters"
 
 module Semverve
   ##
-  # Framework-specific default configuration adapters.
+  # Backward-compatible framework preset lookup.
   module Presets
     ##
     # Returns defaults for a configured preset.
@@ -14,9 +14,7 @@ module Semverve
     #
     # @return [Hash]
     def self.defaults_for(name, configuration)
-      return {} unless name
-
-      fetch(name).defaults(configuration)
+      Adapters.defaults_for(name, configuration)
     end
 
     ##
@@ -26,101 +24,7 @@ module Semverve
     #
     # @return [#name, #defaults]
     def self.fetch(name)
-      case name.to_sym
-      when :rails
-        Rails.new
-      else
-        raise Error, "Unknown preset #{name.inspect}. Use :rails."
-      end
-    end
-
-    ##
-    # Rails application defaults.
-    class Rails
-      ##
-      # Preset 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_file: File.join("config", "version.rb")
-        }
-      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
-
-      ##
-      # 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
-
-      ##
-      # Whether Rails is loaded.
-      #
-      # @return [Boolean]
-      def rails_defined?
-        Object.const_defined?(:Rails)
-      end
-
-      ##
-      # Converts a project directory into a Ruby module name.
-      #
-      # @param [String] value
-      #
-      # @return [String]
-      def camelize(value)
-        value.split(/[_-]/).map(&:capitalize).join
-      end
+      Adapters.fetch(name)
     end
   end
 end