BigW Consortium Gitlab

snippets_helper.rb 3.14 KB
Newer Older
gitlabhq committed
1
module SnippetsHelper
2
  def reliable_snippet_path(snippet, opts = nil)
Dmitriy Zaporozhets committed
3
    if snippet.project_id?
4
      project_snippet_path(snippet.project, snippet, opts)
Dmitriy Zaporozhets committed
5
    else
6
      snippet_path(snippet, opts)
Dmitriy Zaporozhets committed
7 8
    end
  end
9

10 11
  def download_snippet_path(snippet)
    if snippet.project_id
12
      raw_project_snippet_path(@project, snippet, inline: false)
13 14 15 16 17
    else
      raw_snippet_path(snippet, inline: false)
    end
  end

18 19 20
  # Return the path of a snippets index for a user or for a project
  #
  # @returns String, path to snippet index
21
  def subject_snippets_path(subject = nil, opts = nil)
22
    if subject.is_a?(Project)
23
      project_snippets_path(subject, opts)
24 25 26 27 28
    else # assume subject === User
      dashboard_snippets_path(opts)
    end
  end

29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
  # Get an array of line numbers surrounding a matching
  # line, bounded by min/max.
  #
  # @returns Array of line numbers
  def bounded_line_numbers(line, min, max, surrounding_lines)
    lower = line - surrounding_lines > min ? line - surrounding_lines : min
    upper = line + surrounding_lines < max ? line + surrounding_lines : max
    (lower..upper).to_a
  end

  # Returns a sorted set of lines to be included in a snippet preview.
  # This ensures matching adjacent lines do not display duplicated
  # surrounding code.
  #
  # @returns Array, unique and sorted.
Valery Sizov committed
44
  def matching_lines(lined_content, surrounding_lines, query)
45 46 47 48 49 50 51
    used_lines = []
    lined_content.each_with_index do |line, line_number|
      used_lines.concat bounded_line_numbers(
        line_number,
        0,
        lined_content.size,
        surrounding_lines
52
      ) if line.downcase.include?(query.downcase)
53 54 55 56 57 58 59 60 61
    end

    used_lines.uniq.sort
  end

  # 'Chunkify' entire snippet.  Splits the snippet data into matching lines +
  # surrounding_lines() worth of unmatching lines.
  #
  # @returns a hash with {snippet_object, snippet_chunks:{data,start_line}}
Valery Sizov committed
62
  def chunk_snippet(snippet, query, surrounding_lines = 3)
63
    lined_content = snippet.content.split("\n")
Valery Sizov committed
64
    used_lines = matching_lines(lined_content, surrounding_lines, query)
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102

    snippet_chunk = []
    snippet_chunks = []
    snippet_start_line = 0
    last_line = -1

    # Go through each used line, and add consecutive lines as a single chunk
    # to the snippet chunk array.
    used_lines.each do |line_number|
      if last_line < 0
        # Start a new chunk.
        snippet_start_line = line_number
        snippet_chunk << lined_content[line_number]
      elsif last_line == line_number - 1
        # Consecutive line, continue chunk.
        snippet_chunk << lined_content[line_number]
      else
        # Non-consecutive line, add chunk to chunk array.
        snippet_chunks << {
          data: snippet_chunk.join("\n"),
          start_line: snippet_start_line + 1
        }

        # Start a new chunk.
        snippet_chunk = [lined_content[line_number]]
        snippet_start_line = line_number
      end
      last_line = line_number
    end
    # Add final chunk to chunk array
    snippet_chunks << {
      data: snippet_chunk.join("\n"),
      start_line: snippet_start_line + 1
    }

    # Return snippet with chunk array
    { snippet_object: snippet, snippet_chunks: snippet_chunks }
  end
gitlabhq committed
103
end