cobench 0.0.10 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 625fd5b08eece40f4c28722c9258b730336e360cd6d3c51e67a8a6cc969072cd
-  data.tar.gz: 5e5e65c72b3568c12edf3cbca87c20526e40704388d31dec0221a5b0fe526a4a
+  metadata.gz: 1b298ef3dbb65893787af11d1b4cf86e9b02169dc2c83a3e34d902c2c26a2d43
+  data.tar.gz: b13f5d42eb289a3e6a5fdd9bdb8a5c31a2357ec1c8a3f35cc35b3c5ec1b6c9e6
 SHA512:
-  metadata.gz: c3a6ffbbe1ba49ece0b153abe1c98e5885295a32aa834c5ba0972ec15e01a3c3dc61d2032f9e3f281614b25567e3f0003357f6fec17728a9e45651739238ce05
-  data.tar.gz: bf16dac666f420e6b576fa0a086d2c1dfd84d8193acec2e863c8ed1be140f722db8ac3d186fa8448a7ae9015a2be9b588a56fc1e933c045b034b4eeab4d492a4
+  metadata.gz: 83080a2db71ccd8d2e93a00bcbb0bd33a1aa3ddd3ae4a31accdc442403f65b22db215b6e2887dae69c43f0a3655293c7d398f8d5be2819e272995162884923bc
+  data.tar.gz: 86b2a9d10ac6e59b41b43ba16c1e55aa0cec3b83729556f53a7530b847a6c2b5738bc8b142ebca0583ac231dc3750156c870776dfad93f2201c1467ab85c67eb

data/assets/index.xsl

@@ -48,7 +48,7 @@ SOFTWARE.
           .num { text-align: right; }
           .left { border-bottom: 0; }
           header { text-align: center; }
-          footer { text-align: center; font-size: 0.8em; }
+          footer { text-align: center; font-size: 0.8em; line-height: 1.2em; color: gray; }
           article { width: 60em; border: 0; }
           .sorter { cursor: pointer; }
         </style>
@@ -76,7 +76,32 @@ SOFTWARE.
               </a>
               <xsl:text> on </xsl:text>
               <xsl:value-of select="cobench/@time"/>
-              <xsl:text>.</xsl:text>
+              <xsl:text>. </xsl:text>
+              <xsl:text>"Commits" is the total number of </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>
+              <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>
+              <a href="https://docs.github.com/en/issues">
+                <xsl:text>issues</xsl:text>
+              </a>
+              <xsl:text>. </xsl:text>
+              <xsl:text>"Pulls" is the total number of </xsl:text>
+              <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>
             </p>
             <p>
               <xsl:text>The numbers you see reflect the activity of the last </xsl:text>
@@ -126,13 +151,13 @@ SOFTWARE.
   <xsl:template match="m">
     <td class="num">
       <xsl:choose>
-        <xsl:when test="@href">
+        <xsl:when test="@href = ''">
+          <xsl:value-of select="."/>
+        </xsl:when>
+        <xsl:otherwise>
           <a href="{@href}">
             <xsl:value-of select="."/>
           </a>
-        </xsl:when>
-        <xsl:otherwise>
-          <xsl:value-of select="."/>
         </xsl:otherwise>
       </xsl:choose>
     </td>

data/bin/cobench

@@ -51,6 +51,7 @@ opts = Slop.parse(args, strict: true, help: true) do |o|
   o.string '--to', 'Directory where to save all files to', default: './cobench'
   o.string '--token', 'GitHub authentication token'
   o.array '--coder', 'GitHub nickname of a coder to track'
+  o.array '--metrics', 'Names of metrics to use (all by default)'
   o.array '--include', 'Mask of GitHub repo to include, e.g. yegor256/*'
   o.array '--exclude', 'Mask of GitHub repo to exclude'
 end
@@ -91,31 +92,56 @@ begin
   end
   api.auto_paginate = true
   api = Obk.new(api, pause: 2000)
+  loog.info("Reading GitHub data for the last #{opts[:days]} days")
   titles = {}
   opts[:coder].each do |u|
     loog.info("Scanning #{u}...")
     data[u] = {}
     Dir[File.join(__dir__, '../lib/cobench/metrics/*.rb')].each do |f|
       name = File::basename(f).split('.')[0]
+      if !opts[:metrics].empty? && !opts[:metrics].include?(name)
+        loog.info("Ignoring #{u}/#{name} due to --metrics")
+        next
+      end
       type = "Cobench::#{name.capitalize}"
       loog.info("Reading #{u}/#{name}...")
       require_relative f
       m = type.split('::').reduce(Module, :const_get).new(api, u, opts)
       if opts.dry?
         measures = [
-          { title: 'Test1', total: Random.new.rand(100), href: 'https://github.com/' },
-          { title: 'Test2', total: Random.new.rand(100), href: 'https://github.com/' }
+          { 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: '' }
         ]
       else
         measures = m.take(loog)
       end
       measures.each do |d|
-        data[u][d[:title]] = { total: d[:total], href: d[:href] }
+        before = 0
+        before += data[u][d[:title]][:total] if data[u][d[:title]] != nil
+        data[u][d[:title]] = { total: d[:total] + before, href: d[:href] }
         titles[d[:title]] = d[:title]
         loog.info("The value of #{u}/#{d[:title]} is #{d[:total]}")
       end
     end
   end
+  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
+    end.inject(0, :+)
+    data[u]['Score'] = { total: score, href: '' }
+  end
   builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
     xml.cobench(time: Time.now, days: opts[:days]) do
       xml.titles do

data/lib/cobench/metrics/commits.rb

@@ -0,0 +1,64 @@
+# 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'
+
+# Commits in GitHub API.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2022 Yegor Bugayenko
+# License:: MIT
+class Cobench::Commits
+  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 = "author:#{@user} author-date:>#{from}"
+    json = @api.search_commits(q)
+    loog.debug("Found #{json.total_count} commits")
+    hoc = 0
+    total = json.items.count do |c|
+      sha = c.sha
+      repo = c.repository.full_name
+      next unless Cobench::Match.new(@opts, loog).matches?(repo)
+      loog.debug("Including #{sha} in #{repo}")
+      json = @api.commit(repo, sha)
+      hocs = json.stats.total
+      loog.debug("Found #{hocs} HoC in #{sha}")
+      hoc += hocs
+    end
+    [
+      {
+        title: 'Commits',
+        total: total,
+        href: Iri.new('https://github.com/search').add(q: q)
+      },
+      {
+        title: 'HoC',
+        total: hoc,
+        href: ''
+      }
+    ]
+  end
+end

data/lib/cobench/metrics/issues.rb

@@ -34,7 +34,7 @@ class Cobench::Issues
 
   def take(loog)
     from = (Time.now - (60 * 60 * 24 * @opts[:days])).strftime('%Y-%m-%d')
-    q = "#{@user} in:comments type:issue author:#{@user} created:>#{from}"
+    q = "in:comments type:issue author:#{@user} created:>#{from}"
     json = @api.search_issues(q)
     loog.debug("Found #{json.total_count} issues")
     total = json.items.count do |p|

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 = "#{@user} in:comments type:pr author:#{@user} is:merged closed:>#{from}"
+    q = "in:comments type:pr author:#{@user} is:merged closed:>#{from}"
     json = @api.search_issues(q)
     loog.debug("Found #{json.total_count} pull requests")
     hoc = 0

data/lib/cobench/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cobench
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.13
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-14 00:00:00.000000000 Z
+date: 2022-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -252,6 +252,7 @@ files:
 - features/support/env.rb
 - lib/cobench/mask.rb
 - lib/cobench/match.rb
+- lib/cobench/metrics/commits.rb
 - lib/cobench/metrics/issues.rb
 - lib/cobench/metrics/pulls.rb
 - lib/cobench/version.rb