pairing_matrix 1.1.1 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35ec19065f4bfb24ce4adaefe51a4088984df74b
-  data.tar.gz: 6e0a2b8c06c4b15b869b2313f3a49e80e383f775
+  metadata.gz: af02e69747fa79c094ca77ae52e262e9369af13c
+  data.tar.gz: 456b22b0d6793d219e9b106f98db4886b362a9af
 SHA512:
-  metadata.gz: 8d23f19ef1643be44d8c46c596603e2afb519f852029b4085056ade26c8167c419ec46dfd4562126f0988419b2bcf9bf1147a19e38c84ea4a4ddb8c5cb14c19e
-  data.tar.gz: c3779a6ee64625855d6dfad2f221e59faf0d62f510e0c4da88caa0efdd2aace6a20a48396a8e7e4fd3985b34ec63b19ed87bac970cfb9b5ed8a0e0ce9b38e4e6
+  metadata.gz: 7cf09ef83aabc1a4c21d95e26146b38eb6b94df47c7272c94bd941568987d15a5e45abba314da42e62e40a832ea4cd850a5f1c678fb03242b0f45da2dc15c21d
+  data.tar.gz: 649c8c4a4db5b91a536868eaa7a42dd56e30d062a1d3d9cb8402966025e58c75f397c08ca4aeeeb6a45d7c5e9c2ddf964ba77c1d3a27388004edc2cf683c3d4d

data/README.md

@@ -1,6 +1,16 @@
 # PairingMatrix
 
 [![Gem Version](https://badge.fury.io/rb/pairing_matrix.svg)](https://badge.fury.io/rb/pairing_matrix)
+![Gem Downloads](http://ruby-gem-downloads-badge.herokuapp.com/pairing_matrix?type=total)
+[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=102)](https://opensource.org/licenses/MIT)
+[![Twitter](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/Ajit5ingh)
+
+<img src="https://github.com/ajitsing/ScreenShots/blob/master/pairing_matrix/pairing_mat.png" width="600" height="550" />
+
+## How to read this matrix?
+    1. This matrix is purely based on commits.
+    2. Darker the line more the pair has worked together.
+    3. If you see a dark red circle around a name that means the person has worked alone
 
 ## Installation
 
@@ -18,12 +28,41 @@ Or install it yourself as:
 
 ## Usage
 
-Once you have installed the pairing matrix gem, simply run the pairing_matrix command as shown below and the gem will start the web server. Then hit the url ```localhost:4567/matrix``` in the browser.
+First of all you need to decide a format for your commit messages e.g.
+#Feature [Dev1/Dev2] Your commit message
+
+You can choose any format as long as you are able to extract dev names from the message using a regex.
+Once you have decided on the commit message format, create a pairing_matrix.yml file.
+
+```yml
+authors_regex: ^.*\[([\w]*)(?:\/)?([\w]*)\].*$
+github_access_token: 000324cff69wes5613f732c345hn679c0knt509c
+github_repos:
+  - org1/repo1
+  - org1/repo2
+  - github_username/my_private_repo
+```
+
+#### authors_regex:
+This regex is used to extract dev names from the commit message. You can verify your regex in irb console using the below command. If your regex is correct it will return an array of dev names.
 
-```pairing_matrix```
+e.g
+```ruby
+"#4324 [Ajit/Abhishek] My commit message".scan(/^.*\[([\w]*)(?:\/)?([\w]*)\].*$/).flatten
+=> ["Ajit", "Abhishek"]
+```
 
-To run the web server successfully, it needs a configuration file with name ```pairing_matrix.yml``` in the same directory where you are running the command.
+#### github_access_token:
+If you want to use private github repos for matrix, then create a github_access_token and give it the repo read permission. Here is how you can create this token: https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/
 
+#### github_repos:
+List your repos which you want to use for matrix. If you have your repos inside organization then follow the ```org/repo``` format else just mention ```github_username/repo```.
+
+
+Now after installing the pairing matrix gem, simply run the ```pairing_matrix``` command in the repo where you have ```pairing_matrix.yml``` file. This command will start a web server.
+Then hit the url ```localhost:4567/matrix``` in the browser.
+
+## Some example of pairing_matrix.yml
 ### Here is a sample pairing_matrix.yml file
 
 ```yml
@@ -56,8 +95,6 @@ github_repos:
   - github_username/my_public_repo2
 ```
 
-authors_regex is the regex which extracts developers name from the commit message. This regex will depend on the commit message format that you follow in your project.
-
 ## Contributing
 
 1. Fork it ( https://github.com/ajitsing/pairing_matrix/fork )

data/lib/pairing_matrix/commit_reader.rb

@@ -19,7 +19,7 @@ module PairingMatrix
     def authors(since)
       commits = read(since)
       commits.map do |commit|
-        commit.scan(/#{@config.authors_regex}/).flatten.compact.reject(&:empty?).sort.join(',')
+        commit.scan(/#{@config.authors_regex}/).flatten.compact.reject(&:empty?).map { |name| name.gsub(' ', '') }.sort.join(',')
       end.compact.reject(&:empty?)
     end
 

data/lib/pairing_matrix/server/public/matrix.js

@@ -1,230 +1,246 @@
 var playground;
 
-
 function PlayGround(selector) {
-    this.el = null;
-    this.centerX = 400;
-    this.centerY = 350;
-    this.radius = 300;
-    this.selector = selector;
-
-    this.pairingData = [];
-    this.playersData = [];
-
-    this.connectionScale = d3.scaleLinear()
-        .domain([0, 200])
-        .range([0, 50]);
-
-    this.init = function () {
-        playground = this;
-        this.el = d3.select(this.selector);
-    };
-
-    this.load = function (pairingData) {
-        this.pairingData = pairingData;
-        this.validPairsData = this.getValidPairs(pairingData);
-        this.playersData = this.getPlayerNames(pairingData);
-        this.clear();
-        this.setGround();
-        this.setPairing();
-        this.setPlayers();
-    };
-
-    this.clear = function () {
-        $(this.selector).children().remove();
+  this.el = null;
+  this.centerX = 400;
+  this.centerY = 350;
+  this.radius = 300;
+  this.selector = selector;
+
+  this.pairingData = [];
+  this.playersData = [];
+
+  this.connectionScale = d3.scaleLinear()
+    .domain([0, 200])
+    .range([0, 50]);
+
+  this.init = function () {
+    playground = this;
+    this.el = d3.select(this.selector);
+  };
+
+  this.load = function (pairingData) {
+    this.pairingData = pairingData;
+    this.validPairsData = this.getValidPairs(pairingData);
+    this.playersData = this.getPlayerNames(pairingData);
+    this.clear();
+    this.setGround();
+    this.setPairing();
+    this.setPlayers();
+  };
+
+  this.clear = function () {
+    $(this.selector).children().remove();
+  };
+
+  this.setPairing = function () {
+    this.el.selectAll(".connect")
+      .data(playground.validPairsData)
+      .enter().append("path")
+      .attr("class", "connect")
+      .attr("d", function (d) {
+        var fromIndex = _.indexOf(playground.playersData, d[0]),
+          fromCoordinates = playground.getPlayerCoordinates(fromIndex);
+        var toIndex = (d[1] == "") ? fromIndex : _.indexOf(playground.playersData, d[1]),
+          toCoordinates = playground.getPlayerCoordinates(toIndex);
+        return "M " + fromCoordinates.x + " " + fromCoordinates.y + " Q 400 350 " +
+          toCoordinates.x + " " + toCoordinates.y;
+      })
+      .attr("id", function (d) {
+        return d.join('_')
+      })
+      .attr("stroke-width", function (d) {
+        return playground.connectionScale(d[2])
+      })
+      .attr("data-from", function (d) {
+        return d[0]
+      })
+      .attr("data-to", function (d) {
+        return d[1]
+      });
+  };
+
+  this.setGround = function () {
+    this.el.append("circle")
+      .attr("cx", this.centerX)
+      .attr("cy", this.centerY)
+      .attr("r", this.radius)
+      .style("fill-opacity", 0.05);
+  };
+
+  this.setPlayers = function () {
+    var colors = d3.scaleOrdinal(d3.schemeCategory20);
+    var players = this.el.selectAll(".players")
+      .data(playground.playersData)
+      .enter()
+      .append("g");
+    players.append("circle")
+      .attr("cx", function (d, i) {
+        return playground.getPlayerCoordinates(i).x
+      })
+      .attr("cy", function (d, i) {
+        return playground.getPlayerCoordinates(i).y
+      })
+      .attr("fill", colors)
+      .attr("stroke-width", function (d) {
+        return playground.connectionScale(playground.getSoloContribution(d))
+      })
+      .attr("class", "player")
+      .attr("id", function (d) {
+        return d
+      })
+      .on('mouseover', this.mouseOver)
+      .on('mouseout', this.mouseOut);
+    players.append("text")
+      .attr("class", "player_names")
+      .text(function (d) {
+        return d
+      })
+      .attr("x", function (d, i) {
+        return playground.getPlayerCoordinates(i).x + 2
+      })
+      .attr("y", function (d, i) {
+        return playground.getPlayerCoordinates(i).y + 3
+      })
+      .attr("fill", "#000000");
+  };
+
+  this.getAllPairsContaining = function (name) {
+    return _.filter(this.validPairsData, function (pair) {
+      return pair.indexOf(name) >= 0
+    });
+  };
+
+  this.toggleClass = function toggleClass(newClass, pair) {
+    for (ii = 0; ii < 2; ii++) {
+      d3.selectAll($("#" + pair[ii]))
+        .attr("class", newClass)
     }
-
-    this.setPairing = function () {
-        this.el.selectAll(".connect")
-            .data(playground.validPairsData)
-            .enter().append("path")
-            .attr("class", "connect")
-            .attr("d", function (d) {
-                var fromIndex = _.indexOf(playground.playersData, d[0]),
-                    fromCoordinates = playground.getPlayerCoordinates(fromIndex);
-                var toIndex = (d[1] == "") ? fromIndex : _.indexOf(playground.playersData, d[1]),
-                    toCoordinates = playground.getPlayerCoordinates(toIndex);
-                return "M " + fromCoordinates.x + " " + fromCoordinates.y + " Q 400 350 " +
-                    toCoordinates.x + " " + toCoordinates.y;
-            })
-            .attr("id", function(d) {return d.join('_')})
-            .attr("stroke-width", function (d) {
-                return playground.connectionScale(d[2])
-            })
-            .attr("data-from", function (d) {
-                return d[0]
-            })
-            .attr("data-to", function (d) {
-                return d[1]
-            });
-    };
-
-    this.setGround = function () {
-        this.el.append("circle")
-            .attr("cx", this.centerX)
-            .attr("cy", this.centerY)
-            .attr("r", this.radius)
-            .style("fill-opacity", 0.05);
-    };
-
-    this.setPlayers = function () {
-        var colors = d3.scaleOrdinal(d3.schemeCategory20);
-        var players = this.el.selectAll(".players")
-            .data(playground.playersData)
-            .enter()
-            .append("g");
-        players.append("circle")
-            .attr("cx", function (d, i) {
-                return playground.getPlayerCoordinates(i).x
-            })
-            .attr("cy", function (d, i) {
-                return playground.getPlayerCoordinates(i).y
-            })
-            .attr("fill", colors)
-            .attr("stroke-width", function (d) {
-                return playground.connectionScale(playground.getSoloContribution(d))
-            })
-            .attr("class", "player")
-            .attr("id", function (d) {
-                return d
-            })
-            .on('mouseover', this.mouseOver)
-            .on('mouseout', this.mouseOut)
-        players.append("text")
-            .attr("class", "player_names")
-            .text(function (d) {
-                return d
-            })
-            .attr("x", function (d, i) {
-                return playground.getPlayerCoordinates(i).x + 2
-            })
-            .attr("y", function (d, i) {
-                return playground.getPlayerCoordinates(i).y + 3
-            })
-            .attr("fill", "#000000");
-    };
-
-    this.getAllPairsContaining = function(name) {
-        return _.filter(this.validPairsData, function(pair) {
-            return pair.indexOf(name) >= 0
-        });
-    };
-
-    this.toggleClass = function toggleClass(newClass, pair) {
-        for(ii = 0; ii < 2; ii++) {
-            d3.selectAll($("#" + pair[ii]))
-                .attr("class", newClass)    
-        }
-    }
-
-    this.mouseOut = function(id) {
-        var connectedPairs = playground.getAllPairsContaining(id);
-        connectedPairs.forEach(function(pair) {
-            playground.toggleClass("player", pair);
-            var pairId = pair.join('_');
-            d3.selectAll($("#" + pairId))
-            .attr("class", "connect")
-            .style("stroke-width", function(d) {return playground.connectionScale(d[2])})
-        })
-        d3.selectAll($("#" + id))
-        .attr("class", "player")
-    }
-
-    this.mouseOver = function (id) {
-        var connectedPairs = playground.getAllPairsContaining(id);
-        connectedPairs.forEach(function(pair) {
-            playground.toggleClass("playerLarge", pair)
-            var pairId = pair.join('_');
-            d3.selectAll($("#" + pairId))
-            .attr("class", "connectLarge")
-            .style("stroke-width", function(d) {return playground.connectionScale(d[2])})
-        })
-        d3.selectAll($("#" + id))
-        .attr("class", "playerLarge")
-    };
-
-    this.updateConnectorsPath = function (playerId, newPoint) {
-        playground.el
-            .selectAll(".connect[data-from='" + playerId + "']")
-            .attr("d", function (d) {
-                    return playground.replaceFromInPath($(this).attr("d"), newPoint);
-                }
-            );
-        playground.el
-            .selectAll(".connect[data-to='" + playerId + "']")
-            .attr("d", function (d) {
-                    return playground.replaceToInPath($(this).attr("d"), newPoint);
-                }
-            );
-    }
-
-    this.getCollidingPlayer = function (player) {
-        var svg = $("svg")[0];
-        var rectangle = svg.createSVGRect();
-        rectangle.x = player.attr("cx");
-        rectangle.y = player.attr("cy");
-        rectangle.width = player.attr("r");
-        rectangle.height = player.attr("r");
-        var allElements = svg.getIntersectionList(rectangle, null);
-        return _.filter(allElements, function (elem) {
-            return $(elem).attr("class") == "player" && $(elem).attr("id") != player.attr("id")
-        });
+  };
+
+  this.mouseOut = function (id) {
+    showMatrix();
+  };
+
+  this.mouseOver = function (id) {
+    var connectedPairs = _.unique(_.flatten(playground.getAllPairsContaining(id)));
+    hideMatrix();
+    if (connectedPairs.length == 0) {
+      showPlayer(id);
+      return;
     }
-
-    this.replaceFromInPath = function (path, from) {
-        var parts = path.split(" ");
-        parts[1] = from[0];
-        parts[2] = from[1];
-        return parts.join(" ");
-    }
-
-    this.replaceToInPath = function (path, to) {
-        var parts = path.split(" ");
-        parts[6] = to[0];
-        parts[7] = to[1];
-        return parts.join(" ");
-
-    }
-
-    this.closestPointOnCircumference = function () {
-        var vx = d3.event.x - this.centerX,
-            vy = d3.event.y - this.centerY,
-            magV = Math.sqrt(vx * vx + vy * vy);
-        return [(this.centerX + vx / magV * this.radius), (this.centerY + vy / magV * this.radius)];
-    };
-
-    this.getPlayerCoordinates = function (index) {
-        var distanceInDegrees = 2 * Math.PI / playground.playersData.length;
-        return {
-            x: (playground.radius * Math.sin(distanceInDegrees * index) + playground.centerX),
-            y: (playground.radius * Math.cos(distanceInDegrees * index) + playground.centerY)
+    
+    connectedPairs.forEach(function (pair) {
+      showPlayer(pair);
+    });
+    showPath(id);
+  };
+
+  this.updateConnectorsPath = function (playerId, newPoint) {
+    playground.el
+      .selectAll(".connect[data-from='" + playerId + "']")
+      .attr("d", function (d) {
+          return playground.replaceFromInPath($(this).attr("d"), newPoint);
         }
-    };
-
-    this.getValidPairs = function (pairingData) {
-        return _.filter(pairingData, function (data) {
-            return (!_.isEmpty(data[0]) && !_.isEmpty(data[1]));
-        })
-    };
-
-    this.getPlayerNames = function (pairingData) {
-        var playerNames = [];
-        _.each(pairingData, function (data) {
-            playerNames.push(data[0]);
-            playerNames.push(data[1]);
-        });
-        playerNames = _.compact(playerNames);
-        return _.sortBy(_.uniq(playerNames), function (d) {
-            return d
-        });
-    };
-
-    this.getSoloContribution = function (name) {
-        var contrib = _.find(this.pairingData, function (data) {
-            return ((data[0] == name && _.isEmpty(data[1])) || (data[1] == name && _.isEmpty(data[0])));
-        });
-        return contrib ? contrib[2] : 1;
-    };
-
-    this.init();
+      );
+    playground.el
+      .selectAll(".connect[data-to='" + playerId + "']")
+      .attr("d", function (d) {
+          return playground.replaceToInPath($(this).attr("d"), newPoint);
+        }
+      );
+  };
+
+  this.getCollidingPlayer = function (player) {
+    var svg = $("svg")[0];
+    var rectangle = svg.createSVGRect();
+    rectangle.x = player.attr("cx");
+    rectangle.y = player.attr("cy");
+    rectangle.width = player.attr("r");
+    rectangle.height = player.attr("r");
+    var allElements = svg.getIntersectionList(rectangle, null);
+    return _.filter(allElements, function (elem) {
+      return $(elem).attr("class") == "player" && $(elem).attr("id") != player.attr("id")
+    });
+  };
+
+  this.replaceFromInPath = function (path, from) {
+    var parts = path.split(" ");
+    parts[1] = from[0];
+    parts[2] = from[1];
+    return parts.join(" ");
+  };
+
+  this.replaceToInPath = function (path, to) {
+    var parts = path.split(" ");
+    parts[6] = to[0];
+    parts[7] = to[1];
+    return parts.join(" ");
+
+  };
+
+  this.closestPointOnCircumference = function () {
+    var vx = d3.event.x - this.centerX,
+      vy = d3.event.y - this.centerY,
+      magV = Math.sqrt(vx * vx + vy * vy);
+    return [(this.centerX + vx / magV * this.radius), (this.centerY + vy / magV * this.radius)];
+  };
+
+  this.getPlayerCoordinates = function (index) {
+    var distanceInDegrees = 2 * Math.PI / playground.playersData.length;
+    return {
+      x: (playground.radius * Math.sin(distanceInDegrees * index) + playground.centerX),
+      y: (playground.radius * Math.cos(distanceInDegrees * index) + playground.centerY)
+    }
+  };
+
+  this.getValidPairs = function (pairingData) {
+    return _.filter(pairingData, function (data) {
+      return (!_.isEmpty(data[0]) && !_.isEmpty(data[1]));
+    })
+  };
+
+  this.getPlayerNames = function (pairingData) {
+    var playerNames = [];
+    _.each(pairingData, function (data) {
+      playerNames.push(data[0]);
+      playerNames.push(data[1]);
+    });
+    playerNames = _.compact(playerNames);
+    return _.sortBy(_.uniq(playerNames), function (d) {
+      return d
+    });
+  };
+
+  this.getSoloContribution = function (name) {
+    var contrib = _.find(this.pairingData, function (data) {
+      return ((data[0] == name && _.isEmpty(data[1])) || (data[1] == name && _.isEmpty(data[0])));
+    });
+    return contrib ? contrib[2] : 1;
+  };
+
+  var showPlayer = function (player) {
+    $("#" + player).show();
+    $("#" + player).siblings().show();
+  };
+
+  var hideMatrix = function () {
+    $('circle').hide();
+    $('g.area>circle').show();
+    $('path').hide();
+    $('text').hide();
+  };
+
+  var showMatrix = function () {
+    $('circle').show();
+    $('path').show();
+    $('text').show();
+  };
+
+  var showPath = function (player) {
+    $("path[data-from='" + player + "']").show();
+    $("path[data-to='" + player + "']").show();
+  };
+
+  this.init();
 }

data/lib/pairing_matrix/version.rb

@@ -1,3 +1,3 @@
 module PairingMatrix
-  VERSION = '1.1.1'
+  VERSION = '1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pairing_matrix
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: '1.2'
 platform: ruby
 authors:
 - Ajit Singh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-28 00:00:00.000000000 Z
+date: 2017-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler