BigW Consortium Gitlab

commit_range.rb 3.39 KB
Newer Older
1 2 3 4 5
# CommitRange makes it easier to work with commit ranges
#
# Examples:
#
#   range = CommitRange.new('f3f85602...e86e1013')
6
#   range.exclude_start?  # => false
7
#   range.reference_title # => "Commits f3f85602 through e86e1013"
8
#   range.to_s            # => "f3f85602...e86e1013"
9 10
#
#   range = CommitRange.new('f3f856029bc5f966c5a7ee24cf7efefdd20e6019..e86e1013709735be5bb767e2b228930c543f25ae')
11 12 13 14
#   range.exclude_start?  # => true
#   range.reference_title # => "Commits f3f85602^ through e86e1013"
#   range.to_param        # => {from: "f3f856029bc5f966c5a7ee24cf7efefdd20e6019^", to: "e86e1013709735be5bb767e2b228930c543f25ae"}
#   range.to_s            # => "f3f85602..e86e1013"
15 16 17 18 19 20 21
#
#   # Assuming `project` is a Project with a repository containing both commits:
#   range.project = project
#   range.valid_commits? # => true
#
class CommitRange
  include ActiveModel::Conversion
22
  include Referable
23 24 25 26 27 28

  attr_reader :sha_from, :notation, :sha_to

  # Optional Project model
  attr_accessor :project

29 30
  # See `exclude_start?`
  attr_reader :exclude_start
31

32 33
  # The beginning and ending SHAs can be between 6 and 40 hex characters, and
  # the range notation can be double- or triple-dot.
34 35
  PATTERN = /\h{6,40}\.{2,3}\h{6,40}/

36 37 38 39 40 41 42 43 44 45 46 47 48 49
  def self.reference_prefix
    '@'
  end

  # Pattern used to extract commit range references from text
  #
  # This pattern supports cross-project references.
  def self.reference_pattern
    %r{
      (?:#{Project.reference_pattern}#{reference_prefix})?
      (?<commit_range>#{PATTERN})
    }x
  end

50 51 52 53 54 55 56 57 58 59 60 61 62
  # Initialize a CommitRange
  #
  # range_string - The String commit range.
  # project      - An optional Project model.
  #
  # Raises ArgumentError if `range_string` does not match `PATTERN`.
  def initialize(range_string, project = nil)
    range_string.strip!

    unless range_string.match(/\A#{PATTERN}\z/)
      raise ArgumentError, "invalid CommitRange string format: #{range_string}"
    end

63
    @exclude_start = !range_string.include?('...')
64 65 66 67 68 69 70 71 72
    @sha_from, @notation, @sha_to = range_string.split(/(\.{2,3})/, 2)

    @project = project
  end

  def inspect
    %(#<#{self.class}:#{object_id} #{to_s}>)
  end

73 74
  def to_s
    "#{sha_from[0..7]}#{notation}#{sha_to[0..7]}"
75 76
  end

77
  def to_reference(from_project = nil)
78 79 80
    # Not using to_s because we want the full SHAs
    reference = sha_from + notation + sha_to

81
    if cross_project_reference?(from_project)
82
      reference = project.to_reference + '@' + reference
83
    end
84 85

    reference
86 87
  end

88 89
  # Returns a String for use in a link's title attribute
  def reference_title
90
    "Commits #{suffixed_sha_from} through #{sha_to}"
91 92 93 94 95 96
  end

  # Return a Hash of parameters for passing to a URL helper
  #
  # See `namespace_project_compare_url`
  def to_param
97
    { from: suffixed_sha_from, to: sha_to }
98 99
  end

100 101
  def exclude_start?
    exclude_start
102 103 104 105 106 107 108 109 110 111
  end

  # Check if both the starting and ending commit IDs exist in a project's
  # repository
  #
  # project - An optional Project to check (default: `project`)
  def valid_commits?(project = project)
    return nil   unless project.present?
    return false unless project.valid_repo?

112
    commit_from.present? && commit_to.present?
113 114 115 116 117 118
  end

  def persisted?
    true
  end

119
  def commit_from
120
    @commit_from ||= project.repository.commit(suffixed_sha_from)
121
  end
122

123 124
  def commit_to
    @commit_to ||= project.repository.commit(sha_to)
125 126
  end

127
  private
128

129
  def suffixed_sha_from
130
    sha_from + (exclude_start? ? '^' : '')
131 132
  end
end