cobench 0.0.16 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48f017fb5f4994354ad835b809870f6c804bf3350cd22b443e29f2dfda0f1276
-  data.tar.gz: a57ba22b48e7760415921e4c80fb52c407e95ad84c1c3d5da4e1b2de76538f5e
+  metadata.gz: 221c41b7266e31f56aa5f90f39010bdd6e453b65ab8585ec20f8783f40e89f20
+  data.tar.gz: 5c163c8fa858234a5598a84a17ee9aa844b6c034fc85dca737e4365573aefe2e
 SHA512:
-  metadata.gz: 845946fc2dfb68de3ef780a35b2063311e38104f337a235067f88d2ab00bf3b309e30025e1bb3dd2091ca2d43af80e18a8332258f6085dedf96f9f3de39889ef
-  data.tar.gz: 9133dcf17b4d1ca286e70c46b122dfd458c6bce44f1f247bae74a4b5b7604db34c90a74493eb5ac49a05fa74626c5ab5ee14f09751d23ec5143052122173b5e6
+  metadata.gz: c58b0cb4b3f7505970b0c79300fedf7731eebda93c9db619bd687720672fa584aaf293a7cbcd22dde52142b7b494861e368942add8fe7807bff8af029d5c78b5
+  data.tar.gz: 89fc4df3d481cf325bc9524110deefe552c542cbabf73d565469e18567924a579cc2d6d65757a1a28ad1dffa5c75f8f670ce86898d0a6f521242d9ead9a56486

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/README.md

@@ -26,6 +26,8 @@ Then, run it locally and read its output:
 $ cobench --coder yegor256 --verbose
 ```
 
+This is how our report [looks like](https://github.com/cqfn/bench).
+
 ## How to contribute
 
 Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).

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,14 +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>"Reviews" is the total number of merged pull requests reviewed by the user. </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 Review 40 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>
@@ -121,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="."/>
@@ -138,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"/>
@@ -151,7 +187,7 @@ SOFTWARE.
     </tr>
   </xsl:template>
   <xsl:template match="m">
-    <td class="num">
+    <xsl:variable name="body">
       <xsl:choose>
         <xsl:when test="@href = ''">
           <xsl:value-of select="."/>
@@ -162,6 +198,24 @@ SOFTWARE.
           </a>
         </xsl:otherwise>
       </xsl:choose>
+    </xsl:variable>
+    <td class="num">
+      <xsl:if test="@actual">
+        <xsl:choose>
+          <xsl:when test="@actual">
+            <span class="firebrick">
+              <xsl:value-of select="$body"/>
+            </span>
+          </xsl:when>
+          <xsl:otherwise>
+            <xsl:value-of select="$body"/>
+          </xsl:otherwise>
+        </xsl:choose>
+        <br/>
+        <span class="subtitle" title="The actual value of the metric was capped">
+          <xsl:value-of select="@actual"/>
+        </span>
+      </xsl:if>
     </td>
   </xsl:template>
   <xsl:template match="node()|@*">

data/bin/cobench

@@ -35,7 +35,7 @@ loog = Loog::REGULAR
 def config(path)
   f = File.expand_path(path)
   args = []
-  args += File.readlines(f).map(&:strip) if File.exist?(f)
+  args += File.readlines(f).map(&:strip).reject { |a| a.empty? } if File.exist?(f)
   args
 end
 
@@ -47,6 +47,7 @@ opts = Slop.parse(args, strict: true, help: true) do |o|
   o.bool '--version', 'Show current version'
   o.bool '--verbose', 'Print as much log messages as possible'
   o.bool '--dry', 'Make no real round trips to GitHub'
+  o.bool '--reuse', 'Don\'t fetch from GitHub, reuse the existing XML file'
   o.integer '--days', 'How many days to measure', default: 7
   o.string '--to', 'Directory where to save all files to', default: './cobench'
   o.string '--token', 'GitHub authentication token'
@@ -73,17 +74,7 @@ end
 Encoding.default_external = Encoding::UTF_8
 Encoding.default_internal = Encoding::UTF_8
 
-data = {}
-
-begin
-  home = File.absolute_path(opts[:to])
-  loog.debug("All files generated will be saved to #{home}")
-  if File.exist?(home)
-    loog.debug("Directory #{home} exists")
-  else
-    FileUtils.mkdir_p(home)
-    loog.debug("Directory #{home} created")
-  end
+def build_xml(opts, loog)
   if opts.token?
     api = Octokit::Client.new(:access_token => opts[:token])
   else
@@ -94,6 +85,7 @@ begin
   api = Obk.new(api, pause: 2000)
   loog.info("Reading GitHub data for the last #{opts[:days]} days")
   titles = {}
+  data = {}
   opts[:coder].each do |u|
     user = u.downcase
     loog.info("Scanning #{user}...")
@@ -111,9 +103,10 @@ begin
       if opts.dry?
         measures = [
           { title: 'Issues', total: Random.new.rand(100), href: 'https://github.com/' },
-          { title: 'Pulls', total: Random.new.rand(100), href: '' },
-          { title: 'HoC', total: Random.new.rand(100), href: '' },
-          { title: 'HoC', total: Random.new.rand(100), href: '' }
+          { title: 'Pulls', total: Random.new.rand(100) },
+          { title: 'Commits', total: Random.new.rand(100) },
+          { title: 'HoC', total: Random.new.rand(100) },
+          { title: 'HoC', total: Random.new.rand(100) }
         ]
       else
         measures = m.take(loog)
@@ -127,21 +120,31 @@ begin
       end
     end
   end
+  caps = {
+    'HoC' => lambda { |ms| ms['Commits'][:total] * 1000 },
+  }
   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
-      elsif t == 'Reviews'
-        40
-      else
-        raise "Unknown title '#{t}'"
+    ms.map do |t, h|
+      next unless caps.key?(t)
+      cap = caps[t].call(ms)
+      if h[:total] > cap
+        data[u][t][:actual] = h[:total]
+        data[u][t][:total] = cap
       end
+    end
+    data[u] = ms
+  end
+  weights = {
+    'HoC' => 1,
+    'Pulls' => 200,
+    'Issues' => 50,
+    'Commits' => 5,
+    'Reviews' => 75
+  }
+  data.each do |u, ms|
+    score = ms.map do |t, h|
+      raise "Unknown title '#{t}'" unless weights.key?(t)
+      h[:total] * weights[t]
     end.inject(0, :+)
     data[u]['Score'] = { total: score, href: '' }
   end
@@ -152,12 +155,22 @@ 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.parent.set_attribute('details', api.user(u).name)
             xml.metrics do
               ms.each do |k, v|
                 xml.m(id: k, href: v[:href]) do
+                  xml.parent.set_attribute('actual', v[:actual]) unless v[:actual].nil?
+                  xml.parent.set_attribute('href', v[:href]) unless v[:href].nil?
                   xml.text v[:total]
                 end
               end
@@ -167,11 +180,27 @@ begin
       end
     end
   end
-  index = File.join(home, 'index.xml')
   xml = builder.to_xml
   loog.debug(xml)
-  File.write(index, xml)
-  loog.debug("XML saved to #{index} (#{File.size(index)} bytes)")
+  xml
+end
+begin
+  home = File.absolute_path(opts[:to])
+  loog.debug("All files generated will be saved to #{home}")
+  if File.exist?(home)
+    loog.debug("Directory #{home} exists")
+  else
+    FileUtils.mkdir_p(home)
+    loog.debug("Directory #{home} created")
+  end
+  index = File.join(home, 'index.xml')
+  if opts[:reuse]
+    xml = File.read(index)
+  else
+    xml = build_xml(opts, loog)
+    File.write(index, xml)
+    loog.debug("XML saved to #{index} (#{File.size(index)} bytes)")
+  end
   xslt = Nokogiri::XSLT(File.read(File.join(__dir__, '../assets/index.xsl')))
   html = xslt.transform(Nokogiri::XML(xml), 'version' => "'#{Cobench::VERSION}'")
   loog.debug(html)

data/features/cli.feature

@@ -11,7 +11,18 @@ Feature: Simple Reporting
     Then Exit code is zero
 
   Scenario: Simple report
-    When I run bin/cobench with "--coder yegor256 --coder John --verbose --dry --to foo"
+    When I run bin/cobench with "--coder yegor256 --coder Jeff --verbose --dry --to foo"
+    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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cobench
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.19
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-15 00:00:00.000000000 Z
+date: 2022-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace