semverve 0.3.0 → 0.4.1

data/lib/semverve/version_literal_rewriter.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative "error"
+
+module Semverve
+  ##
+  # Rewrites a named capture inside the first match for a safe version literal.
+  class VersionLiteralRewriter
+    ##
+    # Initializes a literal rewriter.
+    #
+    # @param [Regexp] pattern
+    # @param [String, #to_s] replacement
+    # @param [Symbol, String] capture
+    #
+    # @return [Semverve::VersionLiteralRewriter]
+    def initialize(pattern:, replacement:, capture: :version)
+      @pattern = pattern
+      @replacement = replacement.to_s
+      @capture_name = capture.to_s
+      @capture_key = capture.to_sym
+
+      validate_capture
+    end
+
+    ##
+    # Rewrites the configured capture in +text+.
+    #
+    # @param [String] text
+    #
+    # @return [String]
+    def rewrite(text)
+      text.sub(pattern) do |matched_text|
+        match = Regexp.last_match
+        capture_start = match.begin(capture_key) - match.begin(0)
+        capture_end = match.end(capture_key) - match.begin(0)
+
+        "#{matched_text[0...capture_start]}#{replacement}#{matched_text[capture_end..]}"
+      end
+    end
+
+    private
+
+    ##
+    # Safe literal pattern.
+    #
+    # @return [Regexp]
+    attr_reader :pattern
+
+    ##
+    # Replacement text.
+    #
+    # @return [String]
+    attr_reader :replacement
+
+    ##
+    # Named capture as a string.
+    #
+    # @return [String]
+    attr_reader :capture_name
+
+    ##
+    # Named capture as a symbol.
+    #
+    # @return [Symbol]
+    attr_reader :capture_key
+
+    ##
+    # Validates that the pattern can be rewritten safely.
+    #
+    # @return [void]
+    def validate_capture
+      return if pattern.named_captures.key?(capture_name)
+
+      raise Error, "version literal pattern must include a named capture called #{capture_name}."
+    end
+  end
+end

data/lib/semverve/version_match_policy.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative "error"
+
+module Semverve
+  ##
+  # Decides whether a discovered version should be reported or fixed.
+  class VersionMatchPolicy
+    ##
+    # Initializes a version match policy.
+    #
+    # @param [Semverve::SemanticVersion] current_version
+    # @param [Symbol, String] match_mode
+    # @param [Semverve::SemanticVersion, nil] target_version
+    #
+    # @return [Semverve::VersionMatchPolicy]
+    def initialize(current_version:, match_mode:, target_version: nil)
+      @current_version = current_version
+      @match_mode = match_mode.to_sym
+      @target_version = target_version
+    end
+
+    ##
+    # Whether the version should be reported or fixed.
+    #
+    # @param [Semverve::SemanticVersion] version
+    #
+    # @return [Boolean]
+    def report?(version)
+      return version == target_version if target_version
+
+      case match_mode
+      when :older
+        version < current_version
+      when :non_current
+        version != current_version
+      else
+        raise Error, "Unknown version match mode #{match_mode.inspect}. Use :older or :non_current."
+      end
+    end
+
+    private
+
+    ##
+    # Current Semverve version.
+    #
+    # @return [Semverve::SemanticVersion]
+    attr_reader :current_version
+
+    ##
+    # Matching mode when no exact target version is supplied.
+    #
+    # @return [Symbol]
+    attr_reader :match_mode
+
+    ##
+    # Exact version to match.
+    #
+    # @return [Semverve::SemanticVersion, nil]
+    attr_reader :target_version
+  end
+end

data/lib/semverve/version_references.rb

@@ -2,9 +2,11 @@
 
 require "ripper"
 
-require_relative "error"
 require_relative "file_list_resolver"
+require_relative "finding"
+require_relative "fix_result"
 require_relative "semantic_version"
+require_relative "version_match_policy"
 
 module Semverve
   ##
@@ -28,78 +30,6 @@ module Semverve
     # @return [Array<String>]
     TEXT_EXTENSIONS = %w[.adoc .markdown .md .rdoc .txt].freeze
 
-    ##
-    # A stale or non-current version reference found in a project file.
-    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
-
-      ##
-      # Initializes a finding.
-      #
-      # @param [String] path
-      # @param [Integer] line
-      # @param [Integer] column
-      # @param [Semverve::SemanticVersion] version
-      #
-      # @return [Semverve::VersionReferences::Finding]
-      def initialize(path:, line:, column:, version:)
-        @path = path
-        @line = line
-        @column = column
-        @version = version
-      end
-    end
-
-    ##
-    # Result of fixing version references.
-    class FixResult
-      ##
-      # Files changed by the fix.
-      #
-      # @return [Array<String>]
-      attr_reader :changed_files
-
-      ##
-      # Number of replacements made.
-      #
-      # @return [Integer]
-      attr_reader :replacement_count
-
-      ##
-      # Initializes a fix result.
-      #
-      # @param [Array<String>] changed_files
-      # @param [Integer] replacement_count
-      #
-      # @return [Semverve::VersionReferences::FixResult]
-      def initialize(changed_files:, replacement_count:)
-        @changed_files = changed_files
-        @replacement_count = replacement_count
-      end
-    end
-
     ##
     # Initializes version-reference scanning.
     #
@@ -117,7 +47,7 @@ module Semverve
     ##
     # Version-reference findings in configured files.
     #
-    # @return [Array<Semverve::VersionReferences::Finding>]
+    # @return [Array<Semverve::Finding>]
     def findings
       files.flat_map { |path| findings_for_file(path) }
     end
@@ -125,7 +55,7 @@ module Semverve
     ##
     # Replaces found version references with the current version.
     #
-    # @return [Semverve::VersionReferences::FixResult]
+    # @return [Semverve::FixResult]
     def fix
       changed_files = []
       replacement_count = 0
@@ -141,7 +71,7 @@ module Semverve
         replacement_count += count
       end
 
-      FixResult.new(changed_files: changed_files, replacement_count: replacement_count)
+      Semverve::FixResult.new(changed_files: changed_files, replacement_count: replacement_count)
     end
 
     private
@@ -202,7 +132,7 @@ module Semverve
     #
     # @param [String] path
     #
-    # @return [Array<Semverve::VersionReferences::Finding>]
+    # @return [Array<Semverve::Finding>]
     def findings_for_file(path)
       content = File.read(path)
 
@@ -324,10 +254,10 @@ module Semverve
     # @param [Hash] segment
     # @param [String] content
     #
-    # @return [Array<Semverve::VersionReferences::Finding>]
+    # @return [Array<Semverve::Finding>]
     def findings_for_segment(path, segment, content)
       references_for_segment(segment, content).map do |reference|
-        Finding.new(
+        Semverve::Finding.new(
           path: relative_path(path),
           line: segment[:line],
           column: reference[:column],
@@ -386,14 +316,7 @@ module Semverve
     def report?(version)
       return version == target_version if target_version
 
-      case configuration.version_match_mode
-      when :older
-        version < current_version
-      when :non_current
-        version != current_version
-      else
-        raise Error, "Unknown version match mode #{configuration.version_match_mode.inspect}. Use :older or :non_current."
-      end
+      match_policy.report?(version)
     end
 
     ##
@@ -414,6 +337,18 @@ module Semverve
       previous_nonblank_line&.include?(IGNORE_MARKER)
     end
 
+    ##
+    # Version matching behavior for references.
+    #
+    # @return [Semverve::VersionMatchPolicy]
+    def match_policy
+      @match_policy ||= VersionMatchPolicy.new(
+        current_version: current_version,
+        match_mode: configuration.version_match_mode,
+        target_version: target_version
+      )
+    end
+
     ##
     # Starting index for each line in content.
     #

data/lib/semverve.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require_relative "semverve/finding"
+require_relative "semverve/fix_result"
+require_relative "semverve/version_literal_rewriter"
+require_relative "semverve/version_match_policy"
 require_relative "semverve/configuration"
 require_relative "semverve/version"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: semverve
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Evan Gray
@@ -107,26 +107,32 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- UPGRADING.md
 - lib/semverve.rb
+- lib/semverve/adapters.rb
 - lib/semverve/configuration.rb
-- lib/semverve/docs_publisher.rb
-- lib/semverve/docs_publisher/task.rb
 - lib/semverve/error.rb
 - lib/semverve/file_list_resolver.rb
+- lib/semverve/finding.rb
+- lib/semverve/fix_result.rb
 - lib/semverve/formats.rb
 - lib/semverve/formats/module_constants.rb
 - lib/semverve/formats/simple_string.rb
 - lib/semverve/generator.rb
+- lib/semverve/package_metadata.rb
 - lib/semverve/presets.rb
 - lib/semverve/project_metadata.rb
 - lib/semverve/published_version.rb
+- lib/semverve/rails_config_metadata.rb
 - lib/semverve/railtie.rb
 - lib/semverve/semantic_version.rb
 - lib/semverve/task.rb
 - lib/semverve/version.rb
+- lib/semverve/version_checks.rb
 - lib/semverve/version_code_references.rb
 - lib/semverve/version_file.rb
-- lib/semverve/version_metadata.rb
+- lib/semverve/version_literal_rewriter.rb
+- lib/semverve/version_match_policy.rb
 - lib/semverve/version_references.rb
 - semverve.gemspec
 homepage: https://github.com/evanthegrayt/semverve

data/lib/semverve/docs_publisher/task.rb

@@ -1,166 +0,0 @@
-# frozen_string_literal: true
-
-require "rake"
-
-require_relative "../docs_publisher"
-
-module Semverve
-  class DocsPublisher
-    ##
-    # Defines Rake tasks for publishing generated documentation.
-    class Task
-      include Rake::DSL
-
-      ##
-      # Source project root.
-      #
-      # @return [String]
-      attr_accessor :root
-
-      ##
-      # Rake task that builds documentation before publishing.
-      #
-      # @return [String]
-      attr_accessor :build_task
-
-      ##
-      # Directory containing generated documentation.
-      #
-      # @return [String]
-      attr_accessor :source_dir
-
-      ##
-      # Documentation directory on the publishing branch.
-      #
-      # @return [String]
-      attr_accessor :target_dir
-
-      ##
-      # Branch that receives generated documentation.
-      #
-      # @return [String]
-      attr_accessor :branch
-
-      ##
-      # Remote used when pushing the publishing branch.
-      #
-      # @return [String]
-      attr_accessor :remote
-
-      ##
-      # Commit message for generated documentation updates.
-      #
-      # @return [String]
-      attr_accessor :commit_message
-
-      ##
-      # Optional path for the temporary worktree.
-      #
-      # @return [String, nil]
-      attr_accessor :worktree_path
-
-      ##
-      # Whether dirty source working trees are allowed.
-      #
-      # @return [Boolean]
-      attr_accessor :allow_dirty
-
-      ##
-      # Whether the publishing branch should be pushed.
-      #
-      # @return [Boolean]
-      attr_accessor :push
-
-      ##
-      # Output stream for status messages.
-      #
-      # @return [#puts]
-      attr_accessor :output
-
-      ##
-      # Namespace for the generated tasks.
-      #
-      # @return [Symbol, String]
-      attr_accessor :task_namespace
-
-      ##
-      # Initializes and defines documentation publishing tasks.
-      #
-      # @yieldparam [Semverve::DocsPublisher::Task] task
-      #
-      # @return [Semverve::DocsPublisher::Task]
-      def initialize
-        @root = Dir.pwd
-        @build_task = "rerdoc"
-        @source_dir = "docs"
-        @target_dir = "docs"
-        @branch = "gh-pages"
-        @remote = "origin"
-        @commit_message = "Update generated documentation"
-        @worktree_path = nil
-        @allow_dirty = false
-        @push = true
-        @output = $stdout
-        @task_namespace = :docs
-
-        yield self if block_given?
-
-        define
-      end
-
-      ##
-      # Defines the documentation publishing tasks.
-      #
-      # @return [void]
-      def define
-        namespace namespace_name do
-          desc "Publish generated documentation to #{branch}"
-          task :publish do
-            publish(dry_run: false)
-          end
-
-          namespace :publish do
-            desc "Show whether generated documentation would change #{branch}"
-            task :dry_run do
-              publish(dry_run: true)
-            end
-          end
-        end
-      end
-
-      private
-
-      ##
-      # Normalized namespace name.
-      #
-      # @return [Symbol]
-      def namespace_name
-        task_namespace.to_sym
-      end
-
-      ##
-      # Builds and publishes documentation.
-      #
-      # @param [Boolean] dry_run
-      #
-      # @return [void]
-      def publish(dry_run:)
-        Rake::Task[build_task].invoke
-
-        DocsPublisher.new do |publisher|
-          publisher.root = root
-          publisher.source_dir = source_dir
-          publisher.target_dir = target_dir
-          publisher.branch = branch
-          publisher.remote = remote
-          publisher.commit_message = commit_message
-          publisher.worktree_path = worktree_path
-          publisher.allow_dirty = allow_dirty
-          publisher.push = push
-          publisher.dry_run = dry_run
-          publisher.output = output
-        end.publish
-      end
-    end
-  end
-end