Read about our upcoming Code of Conduct on this issue

commit_range.rb 2.99 KB
Newer Older
Robert Speicher's avatar
Robert Speicher committed
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
Robert Speicher's avatar
Robert Speicher committed
7
#   range.reference_title # => "Commits f3f85602 through e86e1013"
8
#   range.to_s            # => "f3f85602...e86e1013"
Robert Speicher's avatar
Robert Speicher committed
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"
Robert Speicher's avatar
Robert Speicher committed
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
Robert Speicher's avatar
Robert Speicher committed
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
Robert Speicher's avatar
Robert Speicher committed
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

  # The beginning and ending SHA sums can be between 6 and 40 hex characters,
  # and the range selection can be double- or triple-dot.
  PATTERN = /\h{6,40}\.{2,3}\h{6,40}/

  # 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

49
    @exclude_start = !range_string.include?('...')
Robert Speicher's avatar
Robert Speicher committed
50
51
52
53
54
55
56
57
58
    @sha_from, @notation, @sha_to = range_string.split(/(\.{2,3})/, 2)

    @project = project
  end

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

59
60
  def to_s
    "#{sha_from[0..7]}#{notation}#{sha_to[0..7]}"
Robert Speicher's avatar
Robert Speicher committed
61
62
  end

63
64
65
66
67
68
69
70
  def to_reference(from_project = nil)
    if cross_project_reference?(from_project)
      "#{project.to_reference}@#{to_s}"
    else
      to_s
    end
  end

Robert Speicher's avatar
Robert Speicher committed
71
72
  # Returns a String for use in a link's title attribute
  def reference_title
73
    "Commits #{suffixed_sha_from} through #{sha_to}"
Robert Speicher's avatar
Robert Speicher committed
74
75
76
77
78
79
  end

  # Return a Hash of parameters for passing to a URL helper
  #
  # See `namespace_project_compare_url`
  def to_param
80
    { from: suffixed_sha_from, to: sha_to }
Robert Speicher's avatar
Robert Speicher committed
81
82
  end

83
84
  def exclude_start?
    exclude_start
Robert Speicher's avatar
Robert Speicher committed
85
86
87
88
89
90
91
92
93
94
  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?

Robert Speicher's avatar
Robert Speicher committed
95
    commit_from.present? && commit_to.present?
Robert Speicher's avatar
Robert Speicher committed
96
97
98
99
100
101
  end

  def persisted?
    true
  end

Robert Speicher's avatar
Robert Speicher committed
102
  def commit_from
103
    @commit_from ||= project.repository.commit(suffixed_sha_from)
Robert Speicher's avatar
Robert Speicher committed
104
  end
Robert Speicher's avatar
Robert Speicher committed
105

Robert Speicher's avatar
Robert Speicher committed
106
107
  def commit_to
    @commit_to ||= project.repository.commit(sha_to)
Robert Speicher's avatar
Robert Speicher committed
108
109
  end

Robert Speicher's avatar
Robert Speicher committed
110
  private
Robert Speicher's avatar
Robert Speicher committed
111

112
  def suffixed_sha_from
113
    sha_from + (exclude_start? ? '^' : '')
Robert Speicher's avatar
Robert Speicher committed
114
115
  end
end