cobench 0.0.15 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afc414be5da28bf1b4703b1a9b7783dafd90594c42dcf6692102f05030af39a0
-  data.tar.gz: 1fdabac9c6c9e1d6179b8c6d6995ee2579d7949111a2c12f24027aa9ecda7c0d
+  metadata.gz: 5ebe9e177a3dbecdb610079242b819c7f35188a15ea362f9b14b2f3f4d5b7d87
+  data.tar.gz: b17a94e0a3ea2f9f57184860f7747ebe232b2ea7af19a42ebb81dea59d4b29c9
 SHA512:
-  metadata.gz: 5997a605602bb82a900cbb4cc3cc44fa15bfff5333248a8d54eb437897e5caa0ebcf9875a14127cef2ee348bf1f8b395c6fa8f27f6809a356df7e7ba7c9110f7
-  data.tar.gz: 89d955def9ee96a4965e28083e867ba5e30908f9a956f9825296be7111da91669d6d98e077150d2953d52c25b22571299958225a991f09e31b01a2c2f5e2a2f3
+  metadata.gz: 8c891cf36011771f14f89c2b762ea57ce53d44af35d3fcbb8033fef402453ed1f7911ed191f243492c2ac4d83ae2e6c32079a3a454a35bdaaa5888fefbc20a08
+  data.tar.gz: 072a7bb771a409c753be6a1027f024d72cd887eddf3c5a6ec02c992e04ae4ce0dd7f39ef9b41437cc0bf607e49965748548edc39b92534fb1a06c37ff121b9e6

data/.rultor.yml

@@ -1,3 +1,5 @@
+docker:
+  image: yegor256/rultor-image:1.9.1
 assets:
   rubygems.yml: yegor256/home#assets/rubygems.yml
 install: |
@@ -16,7 +18,3 @@ release:
 merge:
   script: |-
     bundle exec rake
-deploy:
-  script: |-
-    echo "There is nothing to deploy"
-    exit -1

data/assets/index.xsl

@@ -50,6 +50,9 @@ SOFTWARE.
           header { text-align: center; }
           footer { text-align: center; font-size: 0.8em; line-height: 1.2em; color: gray; }
           article { width: 60em; border: 0; }
+          td.avatar { vertical-align: middle; text-align: center; }
+          td.avatar img { width: 1.5em; height: 1.5em; vertical-align: middle; }
+          .subtitle { font-size: 0.8em; line-height: 1em; color: gray; }
           .sorter { cursor: pointer; }
         </style>
       </head>
@@ -57,7 +60,9 @@ SOFTWARE.
         <section>
           <header>
             <p>
-              <img src="https://raw.githubusercontent.com/yegor256/cobench/master/logo.svg" style="width:64px"/>
+              <a href="">
+                <img src="https://raw.githubusercontent.com/yegor256/cobench/master/logo.svg" style="width:64px"/>
+              </a>
             </p>
           </header>
           <article>
@@ -77,17 +82,17 @@ SOFTWARE.
               <xsl:text> on </xsl:text>
               <xsl:value-of select="cobench/@time"/>
               <xsl:text>. </xsl:text>
-              <xsl:text>"Commits" is the total number of </xsl:text>
+              <xsl:text>"Commits" is the total number of non-merge </xsl:text>
               <a href="https://github.com/git-guides/git-commit">
                 <xsl:text>Git commits</xsl:text>
               </a>
-              <xsl:text> authored by the user. </xsl:text>
-              <xsl:text>"HoC" is the total number of user's hits of code. </xsl:text>
+              <xsl:text> to the default branch, authored by the user. </xsl:text>
+              <xsl:text>"HoC" is the total number of user's </xsl:text>
               <a href="https://www.yegor256.com/2014/11/14/hits-of-code.html">
                 <xsl:text>hits of code</xsl:text>
               </a>
               <xsl:text>. </xsl:text>
-              <xsl:text>"Issues" is the total number of issues. </xsl:text>
+              <xsl:text>"Issues" is the total number of issues submitted by the user. </xsl:text>
               <a href="https://docs.github.com/en/issues">
                 <xsl:text>issues</xsl:text>
               </a>
@@ -96,12 +101,37 @@ SOFTWARE.
               <a href="https://docs.github.com/en/pull-requests">
                 <xsl:text>pull requests</xsl:text>
               </a>
-              <xsl:text> created by the user and merged. </xsl:text>
-              <xsl:text>"Score" is an arithmetic summary of all other numbers with multipliers: </xsl:text>
-              <xsl:text>one Pull costs 100 points, </xsl:text>
-              <xsl:text>one Issue 50 points, </xsl:text>
-              <xsl:text>one Commit 5 points, </xsl:text>
-              <xsl:text>one HoC 1 point.</xsl:text>
+              <xsl:text> created by the user and already merged. </xsl:text>
+              <xsl:text>"Reviews" is the total number of merged pull requests that were reviewed by the user. </xsl:text>
+              <xsl:text>"Score" is an arithmetic summary of all metrics with multipliers: </xsl:text>
+              <xsl:for-each select="cobench/weights/w">
+                <xsl:if test="position() &gt; 1">
+                  <xsl:text>, </xsl:text>
+                </xsl:if>
+                <xsl:text>one </xsl:text>
+                <xsl:choose>
+                  <xsl:when test="substring(@id, string-length(@id)) = 's'">
+                    <xsl:value-of select="substring(@id, 0, string-length(@id))"/>
+                  </xsl:when>
+                  <xsl:otherwise>
+                    <xsl:value-of select="@id"/>
+                  </xsl:otherwise>
+                </xsl:choose>
+                <xsl:choose>
+                  <xsl:when test="position() = 1">
+                    <xsl:text> costs </xsl:text>
+                  </xsl:when>
+                  <xsl:otherwise>
+                    <xsl:text> — </xsl:text>
+                  </xsl:otherwise>
+                </xsl:choose>
+                <xsl:value-of select="text()"/>
+                <xsl:text> point</xsl:text>
+                <xsl:if test="text() != '1'">
+                  <xsl:text>s</xsl:text>
+                </xsl:if>
+              </xsl:for-each>
+              <xsl:text>.</xsl:text>
             </p>
             <p>
               <xsl:text>The numbers you see reflect the activity of the last </xsl:text>
@@ -119,6 +149,7 @@ SOFTWARE.
   <xsl:template match="cobench/titles">
     <thead>
       <tr>
+        <th/>
         <th/>
         <xsl:for-each select="title[generate-id() = generate-id(key('titles', .)[1])]">
           <xsl:sort select="."/>
@@ -136,11 +167,18 @@ SOFTWARE.
   </xsl:template>
   <xsl:template match="coder">
     <tr>
+      <td class="avatar">
+        <img src="https://socatar.com/github/{@id}/64-64"/>
+      </td>
       <td>
         <a href="https://github.com/{@id}">
           <xsl:text>@</xsl:text>
           <xsl:value-of select="@id"/>
         </a>
+        <br/>
+        <span class="subtitle">
+          <xsl:value-of select="@details"/>
+        </span>
       </td>
       <xsl:for-each select="metrics/m">
         <xsl:sort select="@id"/>

data/bin/cobench

@@ -127,19 +127,17 @@ begin
       end
     end
   end
+  weights = {
+    'HoC' => 1,
+    'Pulls' => 200,
+    'Issues' => 50,
+    'Commits' => 5,
+    'Reviews' => 75
+  }
   data.each do |u, ms|
     score = ms.map do |t, h|
-      h[:total] * if t == 'HoC'
-        1
-      elsif t == 'Pulls'
-        100
-      elsif t == 'Issues'
-        50
-      elsif t == 'Commits'
-        5
-      else
-        raise "Unknown title '#{t}'"
-      end
+      raise "Unknown title '#{t}'" unless weights.key?(t)
+      h[:total] * weights[t]
     end.inject(0, :+)
     data[u]['Score'] = { total: score, href: '' }
   end
@@ -150,9 +148,16 @@ begin
           xml.title t
         end
       end
+      xml.weights do
+        weights.each do |t, w|
+          xml.w(id: t) do
+            xml.text w
+          end
+        end
+      end
       xml.coders do
         data.each do |u, ms|
-          xml.coder(id: u) do
+          xml.coder(id: u, details: api.user(u).name) do
             xml.metrics do
               ms.each do |k, v|
                 xml.m(id: k, href: v[:href]) do

data/features/cli.feature

@@ -15,3 +15,14 @@ Feature: Simple Reporting
     Then Stdout contains "XML saved to"
     And Exit code is zero
 
+  Scenario: Simple report with defaults
+    Given I have a ".cobench" file with content:
+    """
+    --verbose
+
+    --coder=john
+    """
+    When I run bin/cobench with "--dry"
+    Then Stdout contains "XML saved to"
+    And Exit code is zero
+

data/lib/cobench/metrics/commits.rb

@@ -34,7 +34,7 @@ class Cobench::Commits
 
   def take(loog)
     from = (Time.now - (60 * 60 * 24 * @opts[:days])).strftime('%Y-%m-%d')
-    q = "author:#{@user} author-date:>#{from}"
+    q = "author:#{@user} author-date:>#{from} is:public merge:false"
     json = @api.search_commits(q)
     loog.debug("Found #{json.total_count} commits")
     hoc = 0
@@ -44,6 +44,7 @@ class Cobench::Commits
       next unless Cobench::Match.new(@opts, loog).matches?(repo)
       loog.debug("Including #{sha} in #{repo}")
       json = @api.commit(repo, sha)
+      next unless json
       hocs = json.stats.total
       loog.debug("Found #{hocs} HoC in #{sha}")
       hoc += hocs

data/lib/cobench/metrics/pulls.rb

@@ -34,7 +34,7 @@ class Cobench::Pulls
 
   def take(loog)
     from = (Time.now - (60 * 60 * 24 * @opts[:days])).strftime('%Y-%m-%d')
-    q = "in:comments type:pr author:#{@user} is:merged closed:>#{from}"
+    q = "in:comments type:pr author:#{@user} is:merged merged:>#{from}"
     json = @api.search_issues(q)
     loog.debug("Found #{json.total_count} pull requests")
     hoc = 0

data/lib/cobench/metrics/reviews.rb

@@ -0,0 +1,54 @@
+# Copyright (c) 2022 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'iri'
+require_relative '../match'
+
+# Reviews in GitHub API.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2022 Yegor Bugayenko
+# License:: MIT
+class Cobench::Reviews
+  def initialize(api, user, opts)
+    @api = api
+    @user = user
+    @opts = opts
+  end
+
+  def take(loog)
+    from = (Time.now - (60 * 60 * 24 * @opts[:days])).strftime('%Y-%m-%d')
+    q = "reviewed-by:#{@user} merged:>#{from}"
+    json = @api.search_issues(q)
+    loog.debug("Found #{json.total_count} reviews")
+    total = json.items.count do |p|
+      pr = p.pull_request.url.split('/')[-1]
+      repo = p.repository_url.split('/')[-2..-1].join('/')
+      next unless Cobench::Match.new(@opts, loog).matches?(repo)
+      loog.debug("Including #{repo}##{pr} reviewed by #{@user}")
+    end
+    [
+      {
+        title: 'Reviews',
+        total: total,
+        href: Iri.new('https://github.com/search').add(q: q)
+      }
+    ]
+  end
+end

data/lib/cobench/version.rb

@@ -23,5 +23,5 @@
 # Copyright:: Copyright (c) 2022 Yegor Bugayenko
 # License:: MIT
 module Cobench
-  VERSION = '0.0.15'.freeze
+  VERSION = '0.0.18'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cobench
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.18
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-15 00:00:00.000000000 Z
+date: 2022-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -255,6 +255,7 @@ files:
 - lib/cobench/metrics/commits.rb
 - lib/cobench/metrics/issues.rb
 - lib/cobench/metrics/pulls.rb
+- lib/cobench/metrics/reviews.rb
 - lib/cobench/version.rb
 - logo.svg
 - test/test__helper.rb