BigW Consortium Gitlab

commit.rb 3.34 KB
Newer Older
1
class Commit
2
  include ActiveModel::Conversion
3
  include StaticModel
4
  extend ActiveModel::Naming
5 6 7
  include Mentionable

  attr_mentionable :safe_message
Saito committed
8

9
  # Safe amount of changes (files and lines) in one commit to render
10 11
  # Used to prevent 500 error on huge commits by suppressing diff
  #
12 13 14 15
  # User can force display of diff above this size
  DIFF_SAFE_FILES  = 100
  DIFF_SAFE_LINES  = 5000
  # Commits above this size will not be rendered in HTML
16 17
  DIFF_HARD_LIMIT_FILES = 1000
  DIFF_HARD_LIMIT_LINES = 50000
18

19 20 21 22
  class << self
    def decorate(commits)
      commits.map { |c| self.new(c) }
    end
23

24 25 26 27
    # Calculate number of lines to render for diffs
    def diff_line_count(diffs)
      diffs.reduce(0){|sum, d| sum + d.diff.lines.count}
    end
28

29 30 31
    def diff_suppress?(diffs, line_count = nil)
      # optimize - check file count first
      return true if diffs.size > DIFF_SAFE_FILES
32

33 34 35
      line_count ||= Commit::diff_line_count(diffs)
      line_count > DIFF_SAFE_LINES
    end
36

37 38 39
    def diff_force_suppress?(diffs, line_count = nil)
      # optimize - check file count first
      return true if diffs.size > DIFF_HARD_LIMIT_FILES
40

41 42 43
      line_count ||= Commit::diff_line_count(diffs)
      line_count > DIFF_HARD_LIMIT_LINES
    end
44 45
  end

46
  attr_accessor :raw
47

48
  def initialize(raw_commit)
49 50
    raise "Nil as raw commit passed" unless raw_commit

51
    @raw = raw_commit
52
  end
53

54 55 56 57
  def id
    @raw.id
  end

58 59 60 61 62 63 64 65 66 67 68 69 70
  def diff_line_count
    @diff_line_count ||= Commit::diff_line_count(self.diffs)
    @diff_line_count
  end

  def diff_suppress?
    Commit::diff_suppress?(self.diffs, diff_line_count)
  end

  def diff_force_suppress?
    Commit::diff_force_suppress?(self.diffs, diff_line_count)
  end

71 72 73 74 75 76 77 78 79 80 81 82
  # Returns a string describing the commit for use in a link title
  #
  # Example
  #
  #   "Commit: Alex Denisov - Project git clone panel"
  def link_title
    "Commit: #{author_name} - #{title}"
  end

  # Returns the commits title.
  #
  # Usually, the commit title is the first line of the commit message.
83 84
  # In case this first line is longer than 100 characters, it is cut off
  # after 80 characters and ellipses (`&hellp;`) are appended.
85 86 87 88 89 90
  def title
    title = safe_message

    return no_commit_message if title.blank?

    title_end = title.index(/\n/)
91 92
    if (!title_end && title.length > 100) || (title_end && title_end > 100)
      title[0..79] << "&hellip;".html_safe
93 94 95 96 97 98 99 100 101
    else
      title.split(/\n/, 2).first
    end
  end

  # Returns the commits description
  #
  # cut off, ellipses (`&hellp;`) are prepended to the commit message.
  def description
102 103 104 105 106 107 108
    title_end = safe_message.index(/\n/)
    @description ||= if (!title_end && safe_message.length > 100) || (title_end && title_end > 100)
                    "&hellip;".html_safe << safe_message[80..-1]
                  else
                    safe_message.split(/\n/, 2)[1].try(:chomp)
                  end
  end
109

110 111
  def description?
    description.present?
112 113
  end

114 115 116
  # Discover issues should be closed when this commit is pushed to a project's
  # default branch.
  def closes_issues project
117
    Gitlab::ClosingIssueExtractor.closed_by_message_in_project(safe_message, project)
118 119 120 121 122 123 124
  end

  # Mentionable override.
  def gfm_reference
    "commit #{sha[0..5]}"
  end

125 126
  def method_missing(m, *args, &block)
    @raw.send(m, *args, &block)
127
  end
128 129 130 131 132 133

  def respond_to?(method)
    return true if @raw.respond_to?(method)

    super
  end
134
end