Contributors graphs feature for GitLab

Created tests and refactored some code along the way

Added stat graph util spec, refactored code

finsihed up tests and refactors

finsihed up tests and refactors

6 files changed, 429 insertions, 0 deletions

diff --git a/spec/javascripts/helpers/.gitkeep b/spec/javascripts/helpers/.gitkeep
new file mode 100644
index 00000000000..e69de29bb2d
--- /dev/null
+++ b/spec/javascripts/helpers/.gitkeep
diff --git a/spec/javascripts/stat_graph_contributors_graph_spec.js b/spec/javascripts/stat_graph_contributors_graph_spec.js
new file mode 100644
index 00000000000..8d2e2038a55
--- /dev/null
+++ b/spec/javascripts/stat_graph_contributors_graph_spec.js
@@ -0,0 +1,125 @@
+describe("ContributorsGraph", function () {
+  describe("#set_x_domain", function () {
+    it("set the x_domain", function () {
+     ContributorsGraph.set_x_domain(20)
+     expect(ContributorsGraph.prototype.x_domain).toEqual(20)
+    })
+  })
+  
+  describe("#set_y_domain", function () {
+    it("sets the y_domain", function () {
+      ContributorsGraph.set_y_domain([{commits: 30}])
+      expect(ContributorsGraph.prototype.y_domain).toEqual([0, 30])
+    })
+  })
+
+  describe("#init_x_domain", function () {
+    it("sets the initial x_domain", function () {
+      ContributorsGraph.init_x_domain([{date: "2013-01-31"}, {date: "2012-01-31"}])
+      expect(ContributorsGraph.prototype.x_domain).toEqual(["2012-01-31", "2013-01-31"])
+    })
+  })
+
+  describe("#init_y_domain", function () {
+    it("sets the initial y_domain", function () {
+      ContributorsGraph.init_y_domain([{commits: 30}])
+      expect(ContributorsGraph.prototype.y_domain).toEqual([0, 30])
+    })
+  })
+
+  describe("#init_domain", function () {
+    it("calls init_x_domain and init_y_domain", function () {
+      spyOn(ContributorsGraph, "init_x_domain")
+      spyOn(ContributorsGraph, "init_y_domain")
+      ContributorsGraph.init_domain()
+      expect(ContributorsGraph.init_x_domain).toHaveBeenCalled()
+      expect(ContributorsGraph.init_y_domain).toHaveBeenCalled()
+    })
+  })
+
+  describe("#set_dates", function () {
+    it("sets the dates", function () {
+      ContributorsGraph.set_dates("2013-12-01")
+      expect(ContributorsGraph.prototype.dates).toEqual("2013-12-01")
+    })
+  })
+
+  describe("#set_x_domain", function () {
+    it("sets the instance's x domain using the prototype's x_domain", function () {
+      ContributorsGraph.prototype.x_domain = 20
+      var instance = new ContributorsGraph()
+      instance.x = d3.time.scale().range([0, 100]).clamp(true)
+      spyOn(instance.x, 'domain')
+      instance.set_x_domain()
+      expect(instance.x.domain).toHaveBeenCalledWith(20)
+    })
+  })
+
+  describe("#set_y_domain", function () {
+    it("sets the instance's y domain using the prototype's y_domain", function () {
+      ContributorsGraph.prototype.y_domain = 30
+      var instance = new ContributorsGraph()
+      instance.y = d3.scale.linear().range([100, 0]).nice()
+      spyOn(instance.y, 'domain')
+      instance.set_y_domain()
+      expect(instance.y.domain).toHaveBeenCalledWith(30)
+    })
+  })
+
+  describe("#set_domain", function () {
+    it("calls set_x_domain and set_y_domain", function () {
+      var instance = new ContributorsGraph()
+      spyOn(instance, 'set_x_domain')
+      spyOn(instance, 'set_y_domain')
+      instance.set_domain()
+      expect(instance.set_x_domain).toHaveBeenCalled()
+      expect(instance.set_y_domain).toHaveBeenCalled()
+    })
+  })
+
+  describe("#set_data", function () {
+    it("sets the data", function () {
+      var instance = new ContributorsGraph()
+      instance.set_data("20")
+      expect(instance.data).toEqual("20")
+    })
+  })
+})
+
+describe("ContributorsMasterGraph", function () {
+  
+  describe("#process_dates", function () {
+    it("gets and parses dates", function () {
+      var graph = new ContributorsMasterGraph()
+      var data = 'random data here'
+      spyOn(graph, 'parse_dates')
+      spyOn(graph, 'get_dates').andReturn("get")
+      spyOn(ContributorsGraph,'set_dates').andCallThrough()
+      graph.process_dates(data)
+      expect(graph.parse_dates).toHaveBeenCalledWith(data)
+      expect(graph.get_dates).toHaveBeenCalledWith(data)
+      expect(ContributorsGraph.set_dates).toHaveBeenCalledWith("get")
+    })
+  }) 
+
+  describe("#get_dates", function () {
+    it("plucks the date field from data collection", function () {
+      var graph = new ContributorsMasterGraph()
+      var data = [{date: "2013-01-01"}, {date: "2012-12-15"}]
+      expect(graph.get_dates(data)).toEqual(["2013-01-01", "2012-12-15"])
+    })
+  })
+
+  describe("#parse_dates", function () {
+    it("parses the dates", function () {
+      var graph = new ContributorsMasterGraph()
+      var parseDate = d3.time.format("%Y-%m-%d").parse
+      var data = [{date: "2013-01-01"}, {date: "2012-12-15"}]
+      var correct = [{date: parseDate(data[0].date)}, {date: parseDate(data[1].date)}]
+      graph.parse_dates(data)
+      expect(data).toEqual(correct)
+    })
+  })
+
+  
+})
diff --git a/spec/javascripts/stat_graph_contributors_util_spec.js b/spec/javascripts/stat_graph_contributors_util_spec.js
new file mode 100644
index 00000000000..367f0af05f8
--- /dev/null
+++ b/spec/javascripts/stat_graph_contributors_util_spec.js
@@ -0,0 +1,200 @@
+describe("ContributorsStatGraphUtil", function () {
+
+  describe("#parse_log", function () {
+    it("returns a correctly parsed log", function () {
+      var fake_log = [
+            {author: "Karlo Soriano", date: "2013-05-09", additions: 471},
+            {author: "Dmitriy Zaporozhets", date: "2013-05-08", additions: 6, deletions: 1},
+            {author: "Dmitriy Zaporozhets", date: "2013-05-08", additions: 19, deletions: 3},
+            {author: "Dmitriy Zaporozhets", date: "2013-05-08", additions: 29, deletions: 3}]
+      
+      var correct_parsed_log = {
+        total: [
+        {date: "2013-05-09", additions: 471, deletions: 0, commits: 1},
+        {date: "2013-05-08", additions: 54, deletions: 7, commits: 3}],
+        by_author:
+        [
+        { 
+          author: "Karlo Soriano", 
+          "2013-05-09": {date: "2013-05-09", additions: 471, deletions: 0, commits: 1}
+        },
+        {
+          author: "Dmitriy Zaporozhets",
+          "2013-05-08": {date: "2013-05-08", additions: 54, deletions: 7, commits: 3}
+        }
+        ]
+      }
+      expect(ContributorsStatGraphUtil.parse_log(fake_log)).toEqual(correct_parsed_log)
+    })
+  })
+
+  describe("#store_data", function () {
+
+    var fake_entry = {author: "Karlo Soriano", date: "2013-05-09", additions: 471}
+    var fake_total = {}
+    var fake_by_author = {}
+
+    it("calls #store_commits", function () {
+      spyOn(ContributorsStatGraphUtil, 'store_commits')
+      ContributorsStatGraphUtil.store_data(fake_entry, fake_total, fake_by_author)
+      expect(ContributorsStatGraphUtil.store_commits).toHaveBeenCalled()
+    })
+
+    it("calls #store_additions", function () {
+      spyOn(ContributorsStatGraphUtil, 'store_additions')
+      ContributorsStatGraphUtil.store_data(fake_entry, fake_total, fake_by_author)
+      expect(ContributorsStatGraphUtil.store_additions).toHaveBeenCalled()
+    })
+
+    it("calls #store_deletions", function () {
+      spyOn(ContributorsStatGraphUtil, 'store_deletions')
+      ContributorsStatGraphUtil.store_data(fake_entry, fake_total, fake_by_author)
+      expect(ContributorsStatGraphUtil.store_deletions).toHaveBeenCalled()
+    })
+
+  })
+
+  describe("#store_commits", function () {
+    var fake_total = "fake_total"
+    var fake_by_author = "fake_by_author"
+
+    it("calls #add twice with arguments fake_total and fake_by_author respectively", function () {
+      spyOn(ContributorsStatGraphUtil, 'add')
+      ContributorsStatGraphUtil.store_commits(fake_total, fake_by_author)
+      expect(ContributorsStatGraphUtil.add.argsForCall).toEqual([["fake_total", "commits", 1], ["fake_by_author", "commits", 1]])
+    })
+  })
+
+  describe("#add", function () {
+    it("adds 1 to current test_field in collection", function () {
+      var fake_collection = {test_field: 10}
+      ContributorsStatGraphUtil.add(fake_collection, "test_field", 1)
+      expect(fake_collection.test_field).toEqual(11)
+    })
+
+    it("inits and adds 1 if test_field in collection is not defined", function () {
+      var fake_collection = {}
+      ContributorsStatGraphUtil.add(fake_collection, "test_field", 1)
+      expect(fake_collection.test_field).toEqual(1)
+    })
+  })
+
+  describe("#store_additions", function () {
+    var fake_entry = {additions: 10}
+    var fake_total= "fake_total"
+    var fake_by_author = "fake_by_author"
+    it("calls #add twice with arguments fake_total and fake_by_author respectively", function () {
+      spyOn(ContributorsStatGraphUtil, 'add')
+      ContributorsStatGraphUtil.store_additions(fake_entry, fake_total, fake_by_author)
+      expect(ContributorsStatGraphUtil.add.argsForCall).toEqual([["fake_total", "additions", 10], ["fake_by_author", "additions", 10]])
+    })
+  })
+
+  describe("#store_deletions", function () {
+    var fake_entry = {deletions: 10}
+    var fake_total= "fake_total"
+    var fake_by_author = "fake_by_author"
+    it("calls #add twice with arguments fake_total and fake_by_author respectively", function () {
+      spyOn(ContributorsStatGraphUtil, 'add')
+      ContributorsStatGraphUtil.store_deletions(fake_entry, fake_total, fake_by_author)
+      expect(ContributorsStatGraphUtil.add.argsForCall).toEqual([["fake_total", "deletions", 10], ["fake_by_author", "deletions", 10]])
+    })
+  })
+
+  describe("#add_date", function () {
+    it("adds a date field to the collection", function () {
+      var fake_date = "2013-10-02"
+      var fake_collection = {}
+      ContributorsStatGraphUtil.add_date(fake_date, fake_collection)
+      expect(fake_collection[fake_date].date).toEqual("2013-10-02")
+    })
+  })
+
+  describe("#add_author", function () {
+    it("adds an author field to the collection", function () {
+      var fake_author = "Author"
+      var fake_collection = {}
+      ContributorsStatGraphUtil.add_author(fake_author, fake_collection)
+      expect(fake_collection[fake_author].author).toEqual("Author")
+    })
+  })
+
+  describe("#get_total_data", function () {
+    it("returns the collection sorted via specified field", function () {
+      var fake_parsed_log = {
+      total: [{date: "2013-05-09", additions: 471, deletions: 0, commits: 1},
+      {date: "2013-05-08", additions: 54, deletions: 7, commits: 3}],
+      by_author:[
+      { 
+        author: "Karlo Soriano", 
+        "2013-05-09": {date: "2013-05-09", additions: 471, deletions: 0, commits: 1}
+      },
+      {
+        author: "Dmitriy Zaporozhets",
+        "2013-05-08": {date: "2013-05-08", additions: 54, deletions: 7, commits: 3}
+      }
+      ]};
+      var correct_total_data = [{date: "2013-05-08", commits: 3},
+      {date: "2013-05-09", commits: 1}];
+      expect(ContributorsStatGraphUtil.get_total_data(fake_parsed_log, "commits")).toEqual(correct_total_data)
+    })
+  })
+
+  describe("#pick_field", function () {
+    it("returns the collection with only the specified field and date", function () {
+      var fake_parsed_log_total = [{date: "2013-05-09", additions: 471, deletions: 0, commits: 1},
+      {date: "2013-05-08", additions: 54, deletions: 7, commits: 3}];
+      ContributorsStatGraphUtil.pick_field(fake_parsed_log_total, "commits")
+      var correct_pick_field_data = [{date: "2013-05-09", commits: 1},{date: "2013-05-08", commits: 3}];
+      expect(ContributorsStatGraphUtil.pick_field(fake_parsed_log_total, "commits")).toEqual(correct_pick_field_data)
+    })
+  })
+
+  describe("#get_author_data", function () {
+    it("returns the log by author sorted by specified field", function () {
+      var fake_parsed_log = {
+      total: [{date: "2013-05-09", additions: 471, deletions: 0, commits: 1},
+      {date: "2013-05-08", additions: 54, deletions: 7, commits: 3}],
+      by_author:[
+      { 
+        author: "Karlo Soriano", 
+        "2013-05-09": {date: "2013-05-09", additions: 471, deletions: 0, commits: 1}
+      },
+      {
+        author: "Dmitriy Zaporozhets",
+        "2013-05-08": {date: "2013-05-08", additions: 54, deletions: 7, commits: 3}
+      }
+      ]}
+      var correct_author_data = [{author:"Dmitriy Zaporozhets",dates:{"2013-05-08":3},deletions:7,additions:54,"commits":3},
+      {author:"Karlo Soriano",dates:{"2013-05-09":1},deletions:0,additions:471,commits:1}]
+      expect(ContributorsStatGraphUtil.get_author_data(fake_parsed_log, "commits")).toEqual(correct_author_data)
+    })
+  })
+
+  describe("#parse_log_entry", function () {
+    it("adds the corresponding info from the log entry to the author", function () {
+      var fake_log_entry =    { author: "Karlo Soriano", 
+        "2013-05-09": {date: "2013-05-09", additions: 471, deletions: 0, commits: 1}
+      }
+      var correct_parsed_log = {author:"Karlo Soriano",dates:{"2013-05-09":1},deletions:0,additions:471,commits:1}
+      expect(ContributorsStatGraphUtil.parse_log_entry(fake_log_entry, 'commits', null)).toEqual(correct_parsed_log)
+    })
+  })
+
+  describe("#in_range", function () {
+    var date = "2013-05-09"
+    it("returns true if date_range is null", function () {
+      expect(ContributorsStatGraphUtil.in_range(date, null)).toEqual(true)
+    })
+    it("returns true if date is in range", function () {
+      var date_range = [new Date("2013-01-01"), new Date("2013-12-12")]
+      expect(ContributorsStatGraphUtil.in_range(date, date_range)).toEqual(true)
+    })
+    it("returns false if date is not in range", function () {
+      var date_range = [new Date("1999-12-01"), new Date("2000-12-01")]
+      expect(ContributorsStatGraphUtil.in_range(date, date_range)).toEqual(false)
+    })
+  })
+
+
+})
\ No newline at end of file
diff --git a/spec/javascripts/stat_graph_spec.js b/spec/javascripts/stat_graph_spec.js
new file mode 100644
index 00000000000..b8881769ac1
--- /dev/null
+++ b/spec/javascripts/stat_graph_spec.js
@@ -0,0 +1,17 @@
+describe("StatGraph", function () {
+
+  describe("#get_log", function () {
+    it("returns log", function () {
+      StatGraph.log = "test";
+      expect(StatGraph.get_log()).toBe("test");
+    });
+  });
+
+  describe("#set_log", function () {
+    it("sets the log", function () {
+      StatGraph.set_log("test");
+      expect(StatGraph.log).toBe("test");
+    })
+  })
+
+});
\ No newline at end of file
diff --git a/spec/javascripts/support/jasmine.yml b/spec/javascripts/support/jasmine.yml
new file mode 100644
index 00000000000..9bfa261a356
--- /dev/null
+++ b/spec/javascripts/support/jasmine.yml
@@ -0,0 +1,76 @@
+# src_files
+#
+# Return an array of filepaths relative to src_dir to include before jasmine specs.
+# Default: []
+#
+# EXAMPLE:
+#
+# src_files:
+#   - lib/source1.js
+#   - lib/source2.js
+#   - dist/**/*.js
+#
+src_files:
+  - assets/application.js
+
+# stylesheets
+#
+# Return an array of stylesheet filepaths relative to src_dir to include before jasmine specs.
+# Default: []
+#
+# EXAMPLE:
+#
+# stylesheets:
+#   - css/style.css
+#   - stylesheets/*.css
+#
+stylesheets:
+  - stylesheets/**/*.css
+
+# helpers
+#
+# Return an array of filepaths relative to spec_dir to include before jasmine specs.
+# Default: ["helpers/**/*.js"]
+#
+# EXAMPLE:
+#
+# helpers:
+#   - helpers/**/*.js
+#
+helpers:
+  - helpers/**/*.js
+
+# spec_files
+#
+# Return an array of filepaths relative to spec_dir to include.
+# Default: ["**/*[sS]pec.js"]
+#
+# EXAMPLE:
+#
+# spec_files:
+#   - **/*[sS]pec.js
+#
+spec_files:
+  - '**/*[sS]pec.js'
+
+# src_dir
+#
+# Source directory path. Your src_files must be returned relative to this path. Will use root if left blank.
+# Default: project root
+#
+# EXAMPLE:
+#
+# src_dir: public
+#
+src_dir:
+
+# spec_dir
+#
+# Spec directory path. Your spec_files must be returned relative to this path.
+# Default: spec/javascripts
+#
+# EXAMPLE:
+#
+# spec_dir: spec/javascripts
+#
+spec_dir: spec/javascripts
diff --git a/spec/javascripts/support/jasmine_helper.rb b/spec/javascripts/support/jasmine_helper.rb
new file mode 100644
index 00000000000..986a4c16f3e
--- /dev/null
+++ b/spec/javascripts/support/jasmine_helper.rb
@@ -0,0 +1,11 @@
+#Use this file to set/override Jasmine configuration options
+#You can remove it if you don't need it.
+#This file is loaded *after* jasmine.yml is interpreted.
+#
+#Example: using a different boot file.
+#Jasmine.configure do |config|
+#   @config.boot_dir = '/absolute/path/to/boot_dir'
+#   @config.boot_files = lambda { ['/absolute/path/to/boot_dir/file.js'] }
+#end
+#
+