fief 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba06e870d6a95356820b15bd3f692a4662057e7a466cf7a877065228bd74e536
-  data.tar.gz: 1deec8fafbe79d23d4d2f7a580daec7089b056ad3c03a2d29c36150251721496
+  metadata.gz: 8283e5cbb1075fb17ae4ee598290b94836df887ef58f00f25a369128afd3f469
+  data.tar.gz: ed4fe0314ef1b4cc6bd591ad7eec31da037642dac59d5834c11fadd43900098e
 SHA512:
-  metadata.gz: 0b80671ae6d23c725dcaf3f94920682a45b2ec0d304736e6266d888fd976ceab3eb810c06d48dd828fe4d0d1c8c24c45943a33b17668e3baf790a9a39d149076
-  data.tar.gz: 24d27ab6bb0cf97bf7b4ef9176381918f295641448f31dbaca719ddb3cb45eed6ab5dd977b100572a77734e8612a2c5ce4038d1feb7dd5388b7e6967174cb686
+  metadata.gz: 690bb54a315e20c3519411fabeb34aa0a49948a710e840c4b28c84d857b1148d52e022cf7433e6ab4262ed969c634f3701ede8c03a15761282b0b9ed2cfc54f9
+  data.tar.gz: bb116efa704b8e4f8eec845d84649eff42fec4582e93992c07756f6e79460634c3f935e17ccabccaf8772fa47d2cbede16aa461ddbf8f5a868f2565a0abd4a28

data/.github/workflows/cron.yml

@@ -2,10 +2,7 @@
 name: cron
 on:
   schedule:
-    - cron: "23 23 * * *"
-  push:
-    branches:
-      - master
+    - cron: "13 4 * * 1,3,5"
 concurrency:
   group: cron
   cancel-in-progress: true
@@ -19,12 +16,20 @@ jobs:
           ruby-version: 2.7
       - run: bundle install
       - run: |
-          bin/fief --verbose --token ${{ secrets.TOKEN }} --to gh-pages \
+          bin/fief --token ${{ secrets.TOKEN }} --delay 1500 \
             --include jcabi/* \
+            --include yegor256/* \
+            --include sttc/* \
+            --include objectionary/* \
+            --include polystat/* \
+            --include zerocracy/* \
+            --include zold-io/* \
             --exclude jcabi/.github \
-            --include yegor256/cactoos \
-            --include yegor256/takes \
-            --include yegor256/xembly
+            --exclude yegor256/quiz \
+            --exclude yegor256/hangman \
+            --exclude objectionary/.github \
+            --exclude polystat/.github \
+            --to gh-pages
       - run: mkdir -p gh-pages/$(date +'%Y/%m/%d')
       - run: cp gh-pages/index.xml gh-pages/$(date +'%Y/%m/%d')/index.xml
       - uses: JamesIves/github-pages-deploy-action@v4.4.2

data/.rubocop.yml

@@ -8,7 +8,7 @@ AllCops:
   SuggestExtensions: false
 
 Metrics/CyclomaticComplexity:
-  Max: 10
+  Max: 14
 Metrics/MethodLength:
   Enabled: false
 Layout/MultilineMethodCallIndentation:
@@ -21,3 +21,5 @@ Layout/EmptyLineAfterGuardClause:
   Enabled: false
 Style/ClassAndModuleChildren:
   Enabled: false
+Metrics/BlockLength:
+  Max: 30

data/Gemfile

@@ -25,7 +25,7 @@ gem 'cucumber', '8.0.0', require: false
 gem 'minitest', '5.15.0', require: false
 gem 'rake', '13.0.6', require: false
 gem 'rdoc', '6.5.0', require: false
-gem 'rubocop', '1.52.0', require: false
+gem 'rubocop', '1.52.1', require: false
 gem 'rubocop-rspec', '2.22.0', require: false
 gem 'simplecov', '0.22.0', require: false
 gem 'xcop', '0.7.1', require: false

data/assets/index.xsl

@@ -110,7 +110,15 @@ SOFTWARE.
               </thead>
               <xsl:apply-templates select="fief/repositories"/>
               <tfoot>
-                <!-- nothing yet -->
+                <tr>
+                  <td>Total:</td>
+                  <xsl:for-each select="fief/titles/title">
+                    <xsl:variable name="title" select="."/>
+                    <td class="num">
+                      <xsl:value-of select="sum(//m[@id=$title])"/>
+                    </td>
+                  </xsl:for-each>
+                </tr>
               </tfoot>
             </table>
           </article>
@@ -131,6 +139,18 @@ SOFTWARE.
               </xsl:for-each>
               <xsl:text>.</xsl:text>
             </p>
+            <p>
+              <xsl:for-each select="fief/legend/column">
+                <xsl:if test="position() &gt; 1">
+                  <xsl:text>, </xsl:text>
+                </xsl:if>
+                <xsl:text>"</xsl:text>
+                <xsl:value-of select="@title"/>
+                <xsl:text>" is </xsl:text>
+                <xsl:value-of select="."/>
+              </xsl:for-each>
+              <xsl:text>.</xsl:text>
+            </p>
             <p>
               <xsl:text>The page was generated by </xsl:text>
               <a href="https://github.com/yegor256/fief">
@@ -142,6 +162,24 @@ SOFTWARE.
               <xsl:value-of select="fief/@time"/>
               <xsl:text>. </xsl:text>
               <br/>
+              <xsl:text>It took </xsl:text>
+              <xsl:variable name="sec" select="round(fief/@sec)"/>
+              <xsl:choose>
+                <xsl:when test="$sec &lt; 60">
+                  <xsl:value-of select="$sec"/>
+                  <xsl:text>s</xsl:text>
+                </xsl:when>
+                <xsl:when test="$sec &lt; 3600">
+                  <xsl:value-of select="format-number($sec div 60, '#.##')"/>
+                  <xsl:text>min</xsl:text>
+                </xsl:when>
+                <xsl:otherwise>
+                  <xsl:value-of select="format-number($sec div 3600, '#.#')"/>
+                  <xsl:text>h</xsl:text>
+                </xsl:otherwise>
+              </xsl:choose>
+              <xsl:text> to build the report.</xsl:text>
+              <br/>
               <xsl:text>The XML with the data </xsl:text>
               <a href="index.xml">
                 <xsl:text>is here</xsl:text>
@@ -185,15 +223,16 @@ SOFTWARE.
     </tr>
   </xsl:template>
   <xsl:template match="m">
-    <td class="num">
+    <td>
+      <xsl:attribute name="class">
+        <xsl:text>num</xsl:text>
+        <xsl:if test="@alert">
+          <xsl:text> firebrick</xsl:text>
+        </xsl:if>
+      </xsl:attribute>
       <xsl:attribute name="data-sort-value">
         <xsl:copy-of select="."/>
       </xsl:attribute>
-      <xsl:if test="@alert">
-        <xsl:attribute name="class">
-          <xsl:text>firebrick</xsl:text>
-        </xsl:attribute>
-      </xsl:if>
       <xsl:copy-of select="."/>
     </td>
   </xsl:template>

data/bin/fief

@@ -57,7 +57,7 @@ opts = Slop.parse(args, strict: true, help: true) do |o|
   o.array '--exclude', 'Mask of GitHub repo to exclude'
 end
 
-if opts.help? || opts[:include].empty?
+if opts.help?
   puts opts
   exit
 end
@@ -75,6 +75,7 @@ Encoding.default_external = Encoding::UTF_8
 Encoding.default_internal = Encoding::UTF_8
 
 def build_xml(opts, loog)
+  start = Time.now
   if opts.token?
     api = Octokit::Client.new(:access_token => opts[:token])
   else
@@ -88,6 +89,7 @@ def build_xml(opts, loog)
     repos = Fief::Repos.new(opts, api, loog).all
   end
   data = []
+  legend = {}
   repos.each do |repo|
     Dir[File.join(__dir__, '../lib/fief/metrics/*.rb')].each do |f|
       name = File::basename(f).split('.')[0]
@@ -100,18 +102,23 @@ def build_xml(opts, loog)
       require_relative f
       m = type.split('::').reduce(Module, :const_get).new(api, repo, opts)
       if opts.dry?
-        measures = [{ title: 'Open Pull Requests', value: 42 }, { title: 'Open Issues', value: 42 }]
+        measures = [{ title: 'Pulls+', value: 42, legend: 'Open pulls' }, { title: 'Issues', value: 42 }]
       else
         measures = m.take(loog)
       end
+      measures.each do |m|
+        legend[m[:title]] = m[:legend]
+      end
       if data.find { |d| d[:name] == repo }.nil?
         data << {name: repo, metrics: []}
       end
       data.find { |d| d[:name] == repo }[:metrics] += measures
+      loog.info("Read from '#{name}': #{measures.map { |m| "#{m[:title]}=#{m[:value]}" }.join(', ')}")
     end
   end
+  p data
   builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
-    xml.fief(time: Time.now) do
+    xml.fief(time: Time.now, sec: Time.now - start) do
       xml.titles do
         data.map { |r| r[:metrics].map { |ms| ms[:title] } }.flatten.uniq.each do |t|
           xml.title do
@@ -119,6 +126,13 @@ def build_xml(opts, loog)
           end
         end
       end
+      xml.legend do
+        legend.each do |t, text|
+          xml.column(title: t) do
+            xml.text text
+          end
+        end
+      end
       xml.repositories do
         data.each do |r|
           xml.repository(id: r[:name]) do
@@ -140,6 +154,7 @@ def build_xml(opts, loog)
   xml
 end
 begin
+  raise 'At least one --include is required' if opts[:include].empty?
   home = File.absolute_path(opts[:to])
   loog.debug("All files generated will be saved to #{home}")
   if File.exist?(home)

data/lib/fief/metrics/issues.rb

@@ -31,6 +31,7 @@ class Fief::Issues
 
   def take(loog)
     json = @api.list_issues(@repo, state: 'open')
+    json.select! { |i| i[:pull_request].nil? }
     total = json.count
     loog.debug("Found #{total} open issues in #{@repo}")
     old = 0
@@ -38,31 +39,44 @@ class Fief::Issues
     json.each do |issue|
       num = issue[:number]
       data = @api.issue(@repo, num)
-      if data[:created_at] < Time.now - (60 * 60 * 24 * 14)
+      if data[:created_at] < Time.now - (60 * 60 * 24 * old_days)
         loog.debug("Issue #{@repo}/##{num} is old")
         old += 1
       end
-      if data[:created_at] < Time.now - (60 * 60 * 24 * 56)
+      if data[:created_at] < Time.now - (60 * 60 * 24 * older_days)
         loog.debug("Issue #{@repo}/##{num} is very old")
         older += 1
       end
     end
     [
       {
-        title: 'Open Issues',
+        title: 'Issues',
         value: total,
-        alert: false
+        alert: false,
+        legend: 'сurrently unresolved issues'
       },
       {
-        title: 'Old Issues',
+        title: 'Issues+',
         value: old,
-        alert: older > total * 0.4
+        alert: older > total * 0.4,
+        legend: "issues unresolved for more than #{old_days} days"
       },
       {
-        title: 'Older Issues',
+        title: 'Issues++',
         value: older,
-        alert: older > total * 0.4
+        alert: older > total * 0.4,
+        legend: "issues unresolved for more than #{older_days} days"
       }
     ]
   end
+
+  private
+
+  def old_days
+    28
+  end
+
+  def older_days
+    112
+  end
 end

data/lib/fief/metrics/pulls.rb

@@ -38,31 +38,44 @@ class Fief::Pulls
     json.each do |pr|
       num = pr[:number]
       data = @api.pull_request(@repo, num)
-      if data[:created_at] < Time.now - (60 * 60 * 24 * 14)
+      if data[:created_at] < Time.now - (60 * 60 * 24 * old_days)
         loog.debug("PR #{@repo}/##{num} is old")
         old += 1
       end
-      if data[:created_at] < Time.now - (60 * 60 * 24 * 56)
+      if data[:created_at] < Time.now - (60 * 60 * 24 * older_days)
         loog.debug("PR #{@repo}/##{num} is very old")
         older += 1
       end
     end
     [
       {
-        title: 'Open PRs',
+        title: 'Pulls',
         value: total,
-        alert: false
+        alert: false,
+        legend: 'currently open pull requests'
       },
       {
-        title: 'Old PRs',
+        title: 'Pulls+',
         value: old,
-        alert: older > total * 0.4
+        alert: older > total * 0.4,
+        legend: "pull requests open for more than #{old_days} days"
       },
       {
-        title: 'Older PRs',
+        title: 'Pulls++',
         value: older,
-        alert: older > total * 0.2
+        alert: older > total * 0.2,
+        legend: "pull requests open for more than #{older_days} days"
       }
     ]
   end
+
+  private
+
+  def old_days
+    28
+  end
+
+  def older_days
+    112
+  end
 end

data/lib/fief/metrics/runs.rb

@@ -0,0 +1,57 @@
+# Copyright (c) 2023 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.
+
+# GitHub Action Runs in one GitHub repository.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# License:: MIT
+class Fief::Runs
+  def initialize(api, repo, opts)
+    @api = api
+    @repo = repo
+    @opts = opts
+  end
+
+  def take(loog)
+    master = @api.repository(@repo)[:default_branch]
+    json = @api.repository_workflow_runs(@repo, branch: master)
+    workflows = []
+    failures = 0
+    json[:workflow_runs].take(32).each do |run|
+      workflow = run[:workflow_id]
+      next if workflows.include?(workflow)
+      workflows << workflow
+      next if run[:status] != 'completed'
+      conclusion = run[:conclusion]
+      loog.debug("Workflow run '#{run[:name]}' in #{@repo} is '#{conclusion}'")
+      if conclusion == 'failure'
+        loog.debug("Workflow run '#{run[:name]}' is failed")
+        failures += 1
+      end
+    end
+    [
+      {
+        title: 'CI failures',
+        value: failures,
+        alert: failures > 0
+      }
+    ]
+  end
+end

data/lib/fief/repos.rb

@@ -40,6 +40,10 @@ class Fief::Repos
           @loog.debug("GitHub account @#{org} is a user's account")
           @api.repositories(org, { type: 'public' }).each do |json|
             id = json[:full_name]
+            if json[:archived]
+              @loog.debug("The #{id} repo is archived, ignoring it")
+              next
+            end
             repos << id
             @loog.debug("Including #{id} as it is owned by @#{org}")
           end
@@ -47,6 +51,10 @@ class Fief::Repos
           @loog.debug("GitHub account @#{org} is an organization account")
           @api.organization_repositories(org, { type: 'public' }).each do |json|
             id = json[:full_name]
+            if json[:archived]
+              @loog.debug("The #{id} repo is archived, ignoring it")
+              next
+            end
             repos << id
             @loog.debug("Including #{id} as a member of @#{org} organization")
           end

data/lib/fief/version.rb

@@ -23,5 +23,5 @@
 # Copyright:: Copyright (c) 2023 Yegor Bugayenko
 # License:: MIT
 module Fief
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.4'.freeze
 end

data/test/metrics/test_issues.rb

@@ -33,7 +33,6 @@ class TestIssues < Minitest::Test
     m = Fief::Issues.new(api, 'yegor256/fief', {})
     ms = m.take(Loog::VERBOSE)
     assert !ms.empty?
-    p ms
   rescue Octokit::TooManyRequests => e
     puts e.message
     skip

data/test/metrics/test_pulls.rb

@@ -33,7 +33,6 @@ class TestPulls < Minitest::Test
     m = Fief::Pulls.new(api, 'yegor256/fief', {})
     ms = m.take(Loog::VERBOSE)
     assert !ms.empty?
-    p ms
   rescue Octokit::TooManyRequests => e
     puts e.message
     skip

data/test/metrics/test_runs.rb

@@ -0,0 +1,40 @@
+# Copyright (c) 2023 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 'octokit'
+require 'loog'
+require_relative '../../lib/fief/metrics/runs'
+
+# Test for Workflow Runs.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# License:: MIT
+class TestRuns < Minitest::Test
+  def test_real
+    api = Octokit::Client.new
+    m = Fief::Runs.new(api, 'yegor256/debate', {})
+    ms = m.take(Loog::VERBOSE)
+    assert !ms.empty?
+  rescue Octokit::TooManyRequests => e
+    puts e.message
+    skip
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fief
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-03 00:00:00.000000000 Z
+date: 2023-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -157,6 +157,7 @@ files:
 - lib/fief/match.rb
 - lib/fief/metrics/issues.rb
 - lib/fief/metrics/pulls.rb
+- lib/fief/metrics/runs.rb
 - lib/fief/repos.rb
 - lib/fief/version.rb
 - logo.png
@@ -164,6 +165,7 @@ files:
 - renovate.json
 - test/metrics/test_issues.rb
 - test/metrics/test_pulls.rb
+- test/metrics/test_runs.rb
 - test/test__helper.rb
 - test/test_mask.rb
 - test/test_match.rb