cobench 0.0.18 → 0.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ebe9e177a3dbecdb610079242b819c7f35188a15ea362f9b14b2f3f4d5b7d87
-  data.tar.gz: b17a94e0a3ea2f9f57184860f7747ebe232b2ea7af19a42ebb81dea59d4b29c9
+  metadata.gz: 6117bbba07444b2da4210d173981f6199005ac182482fca43aa36c04d919ef1b
+  data.tar.gz: 38172dfd6d7cb9cb8604d051ca0cf82b53aebb89c604edf23ac1bcb12a6c5c86
 SHA512:
-  metadata.gz: 8c891cf36011771f14f89c2b762ea57ce53d44af35d3fcbb8033fef402453ed1f7911ed191f243492c2ac4d83ae2e6c32079a3a454a35bdaaa5888fefbc20a08
-  data.tar.gz: 072a7bb771a409c753be6a1027f024d72cd887eddf3c5a6ec02c992e04ae4ce0dd7f39ef9b41437cc0bf607e49965748548edc39b92534fb1a06c37ff121b9e6
+  metadata.gz: f37e7867a1359bc99291f7607ec43f3c7ced2039fb46e2cefd8b50a2a3c1aeabaef18ac095a1579cc3a1e265a5132809a567504782211f593a1b79a72d8415e4
+  data.tar.gz: 36115b07683f34eed5ea446a455ec4ab7b8b18bd70bf27e860c281d4711ebcdf5b9221d7730da3a3b80355328585c316c1599162619d585dd9652f19d1bd5bf4

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

@@ -187,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="."/>
@@ -198,6 +198,24 @@ SOFTWARE.
           </a>
         </xsl:otherwise>
       </xsl:choose>
+    </xsl:variable>
+    <td class="num">
+      <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>
+      <xsl:if test="@actual">
+        <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,6 +120,20 @@ begin
       end
     end
   end
+  caps = {
+    'HoC' => lambda { |ms| ms['Commits'][:total] * 512 },
+  }
+  data.each do |u, ms|
+    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,
@@ -157,10 +164,13 @@ begin
       end
       xml.coders do
         data.each do |u, ms|
-          xml.coder(id: u, details: api.user(u).name) do
+          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
@@ -170,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,7 @@ 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
 

data/lib/cobench/version.rb

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

metadata

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