RubyGems - cobench - Versions diffs - 0.0.8 → 0.0.11 - Mend

cobench 0.0.8 → 0.0.11

Files changed (10) hide show

checksums.yaml +4 -4
data/assets/index.xsl +15 -3
data/bin/cobench +27 -2
data/lib/cobench/match.rb +4 -3
data/lib/cobench/metrics/commits.rb +54 -0
data/lib/cobench/metrics/issues.rb +2 -2
data/lib/cobench/metrics/pulls.rb +2 -2
data/lib/cobench/version.rb +1 -1
data/test/test_match.rb +41 -0
metadata +4 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1eaf9208a53326a257503d91e54aae018b2dd0964c0ec11ddde8d8b392a036cc
-  data.tar.gz: 5b1d155907221ec14edfbd5ca674f345531303e383c2f13aae88335bdc35c1cd
+  metadata.gz: 106c637350232c212145a1a648680688634f9b44f488fbe660f2003666faba23
+  data.tar.gz: eaff88cb6edbc88d3d5616df41d1344c38380b38aca26b642987420f73805a93
 SHA512:
-  metadata.gz: 8c155780a0a14a843daf36336d66e5a3216b9886b0da46503d0a44ad3994a7e71eb2d4ee15c7bc4edfe3c236591673c7339e918ce9afbe697f7ca5f4bb415614
-  data.tar.gz: 2e7ca41724d9768abfbad82c6cbd2bff175b30783644c4af24650183f5868e65050832d7a72d2f776aa080d30afdb2aaaa4a82d315c5279e8f61a350e7cca72f
+  metadata.gz: 73f87f462a82919c5d435237276952a5b94be9397a053b68c17ad636e50e0b5c71dbe54b6d3118a19600e6eaf9bbd5d113e350ebf5c1330e635f5b38fd49e3b3
+  data.tar.gz: fd592b9422b5f48802723027eabcc93ba5a7a23d9f2eedf17d0cd184acf014a7668c1464e3821750a650da4771c81b9b936cdaf02a2fa9c3e43b7ab0ccc988dd

data/assets/index.xsl CHANGED Viewed

@@ -24,6 +24,8 @@ SOFTWARE.
 -->
 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="2.0">
   <xsl:output encoding="UTF-8" method="html"/>
+  <xsl:param name="version"/>
+  <xsl:key name="titles" match="/cobench/titles/title" use="."/>
   <xsl:template match="/">
     <html>
       <head>
@@ -46,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>
@@ -69,10 +71,20 @@ SOFTWARE.
               <xsl:text>The page was generated by </xsl:text>
               <a href="https://github.com/yegor256/cobench">
                 <xsl:text>cobench</xsl:text>
+                <xsl:text> </xsl:text>
+                <xsl:value-of select="$version"/>
               </a>
               <xsl:text> on </xsl:text>
               <xsl:value-of select="cobench/@time"/>
-              <xsl:text>.</xsl:text>
+              <xsl:text>. </xsl:text>
+              <xsl:text>"Pulls" is the total number of pull requests created by the user and merged. </xsl:text>
+              <xsl:text>"Issues" is the total number of issues submitted by the user. </xsl:text>
+              <xsl:text>"Commits" is the total number of commits authored 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 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>
@@ -91,7 +103,7 @@ SOFTWARE.
     <thead>
       <tr>
         <th/>
-        <xsl:for-each select="title">
+        <xsl:for-each select="title[generate-id() = generate-id(key('titles', .)[1])]">
           <xsl:sort select="."/>
           <th class="sorter num">
             <xsl:value-of select="."/>

data/bin/cobench CHANGED Viewed

@@ -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,18 +92,26 @@ 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: 'Mock', total: Random.new.rand(100), href: 'https://github.com/' }]
+        measures = [
+          { title: 'Issues', total: Random.new.rand(100), href: 'https://github.com/' },
+          { title: 'Pulls', total: Random.new.rand(100), href: 'https://github.com/' }
+        ]
       else
         measures = m.take(loog)
       end
@@ -113,6 +122,22 @@ begin
       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
@@ -141,7 +166,7 @@ begin
   File.write(index, xml)
   loog.debug("XML saved to #{index} (#{File.size(index)} bytes)")
   xslt = Nokogiri::XSLT(File.read(File.join(__dir__, '../assets/index.xsl')))
-  html = xslt.transform(Nokogiri::XML(xml))
+  html = xslt.transform(Nokogiri::XML(xml), 'version' => "'#{Cobench::VERSION}'")
   loog.debug(html)
   front = File.join(home, 'index.html')
   File.write(front, html)

data/lib/cobench/match.rb CHANGED Viewed

@@ -25,17 +25,18 @@ require_relative 'mask'
 # Copyright:: Copyright (c) 2022 Yegor Bugayenko
 # License:: MIT
 class Cobench::Match
-  def initialize(opts)
+  def initialize(opts, loog)
     @opts = opts
+    @loog = loog
   end
   def matches?(repo)
     if !@opts[:include].empty? && @opts[:include].none? { |m| Cobench::Mask.new(m).matches?(repo) }
-      loog.debug("Excluding #{repo}##{pr} due to lack of --include")
+      @loog.debug("Excluding #{repo} due to lack of --include")
       return false
     end
     if @opts[:exclude].any? { |m| Cobench::Mask.new(m).matches?(repo) }
-      loog.debug("Excluding #{repo}##{pr} due to --exclude")
+      @loog.debug("Excluding #{repo} due to --exclude")
       return false
     end
     true

data/lib/cobench/metrics/commits.rb ADDED Viewed

@@ -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'
+# 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")
+    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}")
+    end
+    [
+      {
+        title: 'Commits',
+        total: total,
+        href: Iri.new('https://github.com/search').add(q: q)
+      }
+    ]
+  end
+end

data/lib/cobench/metrics/issues.rb CHANGED Viewed

@@ -34,13 +34,13 @@ 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|
       pr = p.url.split('/')[-1]
       repo = p.repository_url.split('/')[-2..-1].join('/')
-      next unless Cobench::Match.new(@opts).matches?(repo)
+      next unless Cobench::Match.new(@opts, loog).matches?(repo)
       loog.debug("Including #{repo}#{pr}")
     end
     [

data/lib/cobench/metrics/pulls.rb CHANGED Viewed

@@ -34,14 +34,14 @@ 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
     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).matches?(repo)
+      next unless Cobench::Match.new(@opts, loog).matches?(repo)
       pr_json = @api.pull_request(repo, pr)
       hocs = pr_json.additions + pr_json.deletions
       hoc += hocs

data/lib/cobench/version.rb CHANGED Viewed

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

data/test/test_match.rb ADDED Viewed

@@ -0,0 +1,41 @@
+# 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 'minitest/autorun'
+require 'loog'
+require_relative '../lib/cobench/match'
+# Test for Match.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2022 Yegor Bugayenko
+# License:: MIT
+class TestMatch < Minitest::Test
+  def test_positive
+    loog = Loog::NULL
+    opts = { include: [], exclude: [] }
+    assert Cobench::Match.new(opts, loog).matches?('foo/bar')
+  end
+  def test_negative
+    loog = Loog::NULL
+    opts = { include: ['*/*'], exclude: ['foo/*'] }
+    assert !Cobench::Match.new(opts, loog).matches?('foo/bar')
+  end
+end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cobench
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.11
 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,12 +252,14 @@ 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
 - logo.svg
 - test/test__helper.rb
 - test/test_mask.rb
+- test/test_match.rb
 homepage: http://github.com/yegor256/cobench
 licenses:
 - MIT