Merge pull request #3169 from hiroponz/refactor-network-graph

Refactor network graph

app/assets/javascripts/branch-graph.js

@@ -117,8 +117,7 @@
       // Draw lines
       for (var j = 0, jj = this.commits[i].parents.length; j < jj; j++) {
         c = this.preparedCommits[this.commits[i].parents[j][0]];
-        ps = this.commits[i].parent_spaces[j];
-        if (c) {
+        ps = this.commits[i].parents[j][1];
         var cx = offsetX + 20 * c.time
           , cy = offsetY + 10 * c.space
           , psy = offsetY + 10 * ps;
@@ -171,7 +170,6 @@
           });
         }
       }
-      }
       
       if (this.commits[i].refs) {
         this.appendLabel(x, y, this.commits[i].refs);

app/controllers/graph_controller.rb

@@ -8,24 +8,21 @@ class GraphController < ProjectResourceController
   before_filter :require_non_empty_project
 
   def show
-    if params.has_key?(:q) && params[:q].blank?
+    if params.has_key?(:q)
+      if params[:q].blank?
         redirect_to project_graph_path(@project, params[:id])
         return
       end
 
-    if params.has_key?(:q)
       @q = params[:q]
       @commit = @project.repository.commit(@q) || @commit
     end
 
     respond_to do |format|
       format.html
+
       format.json do
-        graph = Graph::JsonBuilder.new(project, @ref, @commit)
-        graph.commits.each do |c|
-          c.icon = gravatar_icon(c.author.email)
-        end
-        render :json => graph.to_json
+        @graph = Network::Graph.new(project, @ref, @commit)
       end
     end
   end

app/helpers/graph_helper.rb

+module GraphHelper
+  def join_with_space(ary)
+    ary.collect{|r|r.name}.join(" ") unless ary.nil?
+  end
+
+  def parents_zip_spaces(parents, parent_spaces)
+    ids = parents.map { |p| p.id }
+    ids.zip(parent_spaces)
+  end
+end

app/models/graph/commit.rb

-require "grit"
-
-module Graph
-  class Commit
-    include ActionView::Helpers::TagHelper
-
-    attr_accessor :time, :spaces, :refs, :parent_spaces, :icon
-
-    def initialize(commit)
-      @_commit = commit
-      @time = -1
-      @spaces = []
-      @parent_spaces = []
-    end
-
-    def method_missing(m, *args, &block)
-      @_commit.send(m, *args, &block)
-    end
-
-    def to_graph_hash
-      h = {}
-      h[:parents] = self.parents.collect do |p|
-        [p.id,0,0]
-      end
-      h[:author]  = {
-        name: author.name,
-        email: author.email,
-        icon: icon
-      }
-      h[:time]    = time
-      h[:space]   = spaces.first
-      h[:parent_spaces]   = parent_spaces
-      h[:refs]    = refs.collect{|r|r.name}.join(" ") unless refs.nil?
-      h[:id]      = sha
-      h[:date]    = date
-      h[:message] = message
-      h
-    end
-
-    def add_refs(ref_cache, repo)
-      if ref_cache.empty?
-        repo.refs.each do |ref|
-          ref_cache[ref.commit.id] ||= []
-          ref_cache[ref.commit.id] << ref
-        end
-      end
-      @refs = ref_cache[@_commit.id] if ref_cache.include?(@_commit.id)
-      @refs ||= []
-    end
-
-    def space
-      if @spaces.size > 0
-        @spaces.first
-      else
-        0
-      end
-    end
-  end
-end

app/models/network/commit.rb

+require "grit"
+
+module Network
+  class Commit
+    include ActionView::Helpers::TagHelper
+
+    attr_reader :refs
+    attr_accessor :time, :spaces, :parent_spaces
+
+    def initialize(raw_commit, refs)
+      @commit = ::Commit.new(raw_commit)
+      @time = -1
+      @spaces = []
+      @parent_spaces = []
+      @refs = refs || []
+    end
+
+    def method_missing(m, *args, &block)
+      @commit.send(m, *args, &block)
+    end
+
+    def space
+      if @spaces.size > 0
+        @spaces.first
+      else
+        0
+      end
+    end
+
+    def parents(map)
+      @commit.parents.map do |p|
+        if map.include?(p.id)
+          map[p.id]
+        end
+      end
+      .compact
+    end
+  end
+end

app/models/graph/json_builder.rb → app/models/network/graph.rb

 require "grit"
 
-module Graph
-  class JsonBuilder
-    attr_accessor :days, :commits, :ref_cache, :repo
+module Network
+  class Graph
+    attr_reader :days, :commits, :map
 
     def self.max_count
       @max_count ||= 650
@@ -13,80 +13,68 @@ module Graph
       @ref = ref
       @commit = commit
       @repo = project.repo
-      @ref_cache = {}
 
       @commits = collect_commits
       @days = index_commits
     end
 
-    def to_json(*args)
-      {
-        days: @days.compact.map { |d| [d.day, d.strftime("%b")] },
-        commits: @commits.map(&:to_graph_hash)
-      }.to_json(*args)
-    end
-
     protected
 
     # Get commits from repository
     #
     def collect_commits
+      refs_cache = build_refs_cache
 
-      @commits = Grit::Commit.find_all(repo, nil, {date_order: true, max_count: self.class.max_count, skip: to_commit}).dup
-
-      # Decorate with app/models/commit.rb
-      @commits.map! { |commit| Commit.new(commit) }
-
-      # Decorate with lib/gitlab/graph/commit.rb
-      @commits.map! { |commit| Graph::Commit.new(commit) }
-
-      # add refs to each commit
-      @commits.each { |commit| commit.add_refs(ref_cache, repo) }
-
-      @commits
+      Grit::Commit.find_all(
+        @repo,
+        nil,
+        {
+          date_order: true,
+          max_count: self.class.max_count,
+          skip: count_to_display_commit_in_center
+        }
+      )
+      .map do |commit|
+          # Decorate with app/model/network/commit.rb
+          Network::Commit.new(commit, refs_cache[commit.id])
+      end
     end
 
     # Method is adding time and space on the
     # list of commits. As well as returns date list
     # corelated with time set on commits.
     #
-    # @param [Array<Graph::Commit>] commits to index
-    #
     # @return [Array<TimeDate>] list of commit dates corelated with time on commits
     def index_commits
-      days, times = [], []
-      map = {}
+      days = []
+      @map = {}
 
-      commits.reverse.each_with_index do |c,i|
+      @commits.reverse.each_with_index do |c,i|
         c.time = i
         days[i] = c.committed_date
-        map[c.id] = c
-        times[i] = c
+        @map[c.id] = c
       end
 
-      @_reserved = {}
+      @reserved = {}
       days.each_index do |i|
-        @_reserved[i] = []
+        @reserved[i] = []
       end
 
       commits_sort_by_ref.each do |commit|
-        if map.include? commit.id then
-          place_chain(map[commit.id], map)
-        end
+        place_chain(commit)
       end
 
       # find parent spaces for not overlap lines
-      times.each do |c|
-        c.parent_spaces.concat(find_free_parent_spaces(c, map, times))
+      @commits.each do |c|
+        c.parent_spaces.concat(find_free_parent_spaces(c))
       end
 
       days
     end
 
     # Skip count that the target commit is displayed in center.
-    def to_commit
-      commits = Grit::Commit.find_all(repo, nil, {date_order: true})
-      commit_index = commits.index do |c|
+    def count_to_display_commit_in_center
+      commit_index = Grit::Commit.find_all(@repo, nil, {date_order: true}).index do |c|
         c.id == @commit.id
       end
 
@@ -99,7 +87,7 @@ module Graph
     end
 
     def commits_sort_by_ref
-      commits.sort do |a,b|
+      @commits.sort do |a,b|
         if include_ref?(a)
           -1
         elsif include_ref?(b)
@@ -122,13 +110,10 @@ module Graph
       heads.include?(@ref)
     end
 
-    def find_free_parent_spaces(commit, map, times)
+    def find_free_parent_spaces(commit)
       spaces = []
 
-      commit.parents.each do |p|
-        if map.include?(p.id) then
-          parent = map[p.id]
-
+      commit.parents(@map).each do |parent|
         range = if commit.time < parent.time then
                   commit.time..parent.time
                 else
@@ -136,32 +121,31 @@ module Graph
                 end
 
         space = if commit.space >= parent.space then
-                    find_free_parent_space(range, parent.space, -1, commit.space, times)
+                  find_free_parent_space(range, parent.space, -1, commit.space)
                 else
-                    find_free_parent_space(range, commit.space, -1, parent.space, times)
+                  find_free_parent_space(range, commit.space, -1, parent.space)
                 end
 
         mark_reserved(range, space)
         spaces << space
       end
-      end
 
       spaces
     end
 
-    def find_free_parent_space(range, space_base, space_step, space_default, times)
-      if is_overlap?(range, times, space_default) then
+    def find_free_parent_space(range, space_base, space_step, space_default)
+      if is_overlap?(range, space_default) then
         find_free_space(range, space_step, space_base, space_default)
       else
         space_default
       end
     end
 
-    def is_overlap?(range, times, overlap_space)
+    def is_overlap?(range, overlap_space)
       range.each do |i|
         if i != range.first &&
           i != range.last &&
-          times[i].spaces.include?(overlap_space) then
+          @commits[reversed_index(i)].spaces.include?(overlap_space) then
 
           return true;
         end
@@ -172,41 +156,33 @@ module Graph
 
     # Add space mark on commit and its parents
     #
-    # @param [Graph::Commit] the commit object.
-    # @param [Hash<String,Graph::Commit>] map of commits
-    def place_chain(commit, map, parent_time = nil)
-      leaves = take_left_leaves(commit, map)
+    # @param [::Commit] the commit object.
+    def place_chain(commit, parent_time = nil)
+      leaves = take_left_leaves(commit)
       if leaves.empty?
         return
       end
 
       time_range = leaves.last.time..leaves.first.time
-      space_base = get_space_base(leaves, map)
+      space_base = get_space_base(leaves)
       space = find_free_space(time_range, 2, space_base)
       leaves.each do |l|
         l.spaces << space
         # Also add space to parent
-        l.parents.each do |p|
-          if map.include?(p.id)
-            parent = map[p.id]
+        l.parents(@map).each do |parent|
           if parent.space > 0
             parent.spaces << space
           end
         end
       end
-      end
 
       # and mark it as reserved
       min_time = leaves.last.time
-      parents = leaves.last.parents.collect
-      parents.each do |p|
-        if map.include? p.id
-          parent = map[p.id]
+      leaves.last.parents(@map).each do |parent|
         if parent.time < min_time
           min_time = parent.time
         end
       end
-      end
 
       if parent_time.nil?
         max_time = leaves.first.time
@@ -217,22 +193,19 @@ module Graph
 
       # Visit branching chains
       leaves.each do |l|
-        parents = l.parents.collect.select{|p| map.include? p.id and map[p.id].space.zero?}
+        parents = l.parents(@map).select{|p| p.space.zero?}
         for p in parents
-          place_chain(map[p.id], map, l.time)
+          place_chain(p, l.time)
         end
       end
     end
 
-    def get_space_base(leaves, map)
+    def get_space_base(leaves)
       space_base = 1
-      if leaves.last.parents.size > 0
-        first_parent = leaves.last.parents.first
-        if map.include?(first_parent.id)
-          first_p = map[first_parent.id]
-          if first_p.space > 0
-            space_base = first_p.space
-          end
+      parents = leaves.last.parents(@map)
+      if parents.size > 0
+        if parents.first.space > 0
+          space_base = parents.first.space
         end
       end
       space_base
@@ -240,7 +213,7 @@ module Graph
 
     def mark_reserved(time_range, space)
       for day in time_range
-        @_reserved[day].push(space)
+        @reserved[day].push(space)
       end
     end
 
@@ -249,7 +222,7 @@ module Graph
 
       reserved = []
       for day in time_range
-        reserved += @_reserved[day]
+        reserved += @reserved[day]
       end
       reserved.uniq!
 
@@ -268,24 +241,36 @@ module Graph
     # Takes most left subtree branch of commits
     # which don't have space mark yet.
     #
-    # @param [Graph::Commit] the commit object.
-    # @param [Hash<String,Graph::Commit>] map of commits
+    # @param [::Commit] the commit object.
     #
-    # @return [Array<Graph::Commit>] list of branch commits
-    def take_left_leaves(commit, map)
+    # @return [Array<Network::Commit>] list of branch commits
+    def take_left_leaves(raw_commit)
+      commit = @map[raw_commit.id]
       leaves = []
       leaves.push(commit) if commit.space.zero?
 
       while true
-        return leaves if commit.parents.count.zero?
-        return leaves unless map.include? commit.parents.first.id
+        return leaves if commit.parents(@map).count.zero?
 
-        commit = map[commit.parents.first.id]
+        commit = commit.parents(@map).first
 
         return leaves unless commit.space.zero?
 
         leaves.push(commit)
       end
     end
+
+    def build_refs_cache
+      refs_cache = {}
+      @repo.refs.each do |ref|
+        refs_cache[ref.commit.id] = [] unless refs_cache.include?(ref.commit.id)
+        refs_cache[ref.commit.id] << ref
+      end
+      refs_cache
+    end
+
+    def reversed_index(index)
+      -index - 1
+    end
   end
 end

app/views/graph/show.json.erb

+<% self.formats = ["html"] %>
+
+<%= raw(
+  {
+    days: @graph.days.compact.map { |d| [d.day, d.strftime("%b")] },
+    commits: @graph.commits.map do |c|
+      {
+        parents: parents_zip_spaces(c.parents(@graph.map), c.parent_spaces),
+        author: {
+          name: c.author.name,
+          email: c.author.email,
+          icon: gravatar_icon(c.author.email, 20)
+        },
+        time: c.time,
+        space: c.spaces.first,
+        refs: join_with_space(c.refs),
+        id: c.sha,
+        date: c.date,
+        message: c.message,
+      }
+    end
+  }.to_json
+) %>

features/steps/project/project_network_graph.rb

@@ -8,8 +8,8 @@ class ProjectNetworkGraph < Spinach::FeatureSteps
   end
 
   When 'I visit project "Shop" network page' do
-    # Stub Graph::JsonBuilder max_size to speed up test (10 commits vs. 650)
-    Graph::JsonBuilder.stub(max_count: 10)
+    # Stub Graph max_size to speed up test (10 commits vs. 650)
+    Network::Graph.stub(max_count: 10)
 
     project = Project.find_by_name("Shop")
     visit project_graph_path(project, "master")
@@ -25,7 +25,7 @@ class ProjectNetworkGraph < Spinach::FeatureSteps
     end
   end
 
-  And 'I switch ref to "stable"' do
+  When 'I switch ref to "stable"' do
     page.select 'stable', :from => 'ref'
     sleep 2
   end
@@ -40,7 +40,7 @@ class ProjectNetworkGraph < Spinach::FeatureSteps
     end
   end
 
-  And 'I looking for a commit by SHA of "v2.1.0"' do
+  When 'I looking for a commit by SHA of "v2.1.0"' do
     within ".content .search" do
       fill_in 'q', :with => '98d6492'
       find('button').click

features/steps/shared/paths.rb

@@ -142,8 +142,8 @@ module SharedPaths
   end
 
   Given "I visit my project's network page" do
-    # Stub Graph::JsonBuilder max_size to speed up test (10 commits vs. 650)
-    Graph::JsonBuilder.stub(max_count: 10)
+    # Stub Graph max_size to speed up test (10 commits vs. 650)
+    Network::Graph.stub(max_count: 10)
 
     visit project_graph_path(@project, root_ref)
   end