codemonitor 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2b693d8b21e5c6041765bf54d568d21b7e8e54abeb1695d7937166a6bf9b2b7
-  data.tar.gz: 3af8eb6ab76db485ddc34a793c04793238b0d92c4523440028dd2809d58c1f50
+  metadata.gz: 67bdedaed6063ea891d58825204d5dd31d60498325ee9b4b217d5981947282d7
+  data.tar.gz: 2cdf8289ed5be0af4dfbd1acbb0d7d6d77964b81427ae22edf3f4aff1b081d19
 SHA512:
-  metadata.gz: 2c0a23989bded3388a21ac6c40c87ed4ed6d18a3f62d9ff804a13e595fb2152eb17dd8955224812ebfac2a71d37a569b1cadf1bf9f46195d87f7576351a6b39d
-  data.tar.gz: 8ae23e524620fd956835b5bf85699153a579796701c6e605ab7ad1f670f30622b50ee3d1528b2a79f7ef7b3d698e0aae5d8b463a59b96c69b663ba4e77896d22
+  metadata.gz: 8fc80f0a516df374fa081ead8d3de1d3a9a58cd320b36ad867e106aa13c123fb9aed0bafa07f9958df4ce1a3a7c78c6451c49cd56fe9dcb225e1635eb61c5c86
+  data.tar.gz: 6bc644578c63a242697bea5d17949c610e2ca1b3d1ccda0fcf62999cd3dd77f6d15b44f4dc1dce0cbcd07620dde3bf49e3032f390bb47b91031291017f04b19b

data/Gemfile

@@ -2,5 +2,5 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in rubocop-changes.gemspec
+# Specify your gem's dependencies in codemonitor.gemspec
 gemspec

data/Gemfile.lock

@@ -1,25 +1,56 @@
 PATH
   remote: .
   specs:
-    codemonitor (0.3.0)
+    codemonitor (0.4.0)
       dogapi (~> 1.45)
+      octokit (~> 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
     coderay (1.1.3)
     diff-lcs (1.3)
     dogapi (1.45.0)
       multi_json
+    faraday (1.9.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
     method_source (1.0.0)
     multi_json (1.15.0)
+    multipart-post (2.1.1)
+    octokit (4.22.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
     parallel (1.20.1)
     parser (3.0.1.1)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (13.0.3)
     regexp_parser (2.1.1)
@@ -49,6 +80,10 @@ GEM
     rubocop-ast (1.5.0)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
     unicode-display_width (1.7.0)
 
 PLATFORMS

data/README.md

@@ -1,9 +1,134 @@
-# CodeMonitor
+# 🖥️ CodeMonitor
 
 A engine to collect multiple metrics from your repository and push them to a
 time series provider.
 
 
-# Inspiration
+# Engines
 
-https://github.com/scribd/github-action-datadog-reporting
+## Git
+
+Collect multiple metrics from the a Git repository.
+
+**Requirements / Setup**:
+
+You need a `.git` folder present in the current folder:
+
+**Options**:
+
+`CODEMONITOR_GIT_FILES_THRESHOLD`: Don't emit metrics about number of files, from those that are above of this threshold. (Default: `0`)
+
+## Eslint
+
+Collect multiple metrics from the a project with [Eslint](https://eslint.org/) configured.
+
+**Requirements / Setup**:
+
+You need a `.eslintrc.js` and a `eslint.output.json` file present in the current folder.
+
+You can generate the `eslint.output.json` file with this example command:
+
+```
+eslint -f json -o eslint.output.json
+```
+**Options**:
+
+`CODEMONITOR_ESLINT_THRESHOLD`: Don't emit metrics about eslint rules that are above of this threshold. (Default: `10`)
+
+
+## Npm
+
+Collect multiple metrics from the a NodeJS.
+
+**Requirements / Setup**:
+
+You need a `package.json` file present in the current folder.
+
+## Packwerk
+
+Collect multiple metrics from the a Ruby project with [Packwerk](https://github.com/Shopify/packwerk) configured.
+
+**Requirements / Setup**:
+
+You need a `deprecated_references.yml` files present in the current project.
+
+## Rubocop
+
+Collect multiple metrics from the a Ruby project with [Rubocop](https://github.com/rubocop/rubocop) configured.
+
+**Requirements / Setup**:
+
+You need a `.rubocop.yml` and a `rubocop.output.json` file present in the current folder.
+
+You can generate the `rubocop.output.json` file with this example command:
+
+```
+bundle exec srb tc --metrics-prefix 'codemetrics' --metrics-file sorbet.output.json
+```
+
+**Options**:
+
+`CODEMONITOR_RUBOCOP_THRESHOLD`: Don't emit metrics about rubocop cops that are above of this threshold. (Default: `50`)
+
+
+## Semgrep
+
+Collect multiple metrics from the a with [Semgrep](https://semgrep.dev/) configured.
+
+**Requirements / Setup**:
+
+You need a `.semgrep.yml` and a `semgrep.output.json` file present in the current folder.
+
+You can generate the `semgrep.output.json` file with this example command:
+
+```
+semgrep --json -o semgrep.output.json
+```
+
+**Options**:
+
+`CODEMONITOR_SEMGREP_THRESHOLD`: Don't emit metrics about rubocop cops that are above of this threshold. (Default: `50`)
+
+## Sorbet
+
+Collect multiple metrics from the a with [Sorbet](https://sorbet.org/) configured.
+
+**Requirements / Setup**:
+
+You need a `sorbet.output.json` file present in the current folder.
+
+You can generate the `sorbet.output.json` file with this example command:
+
+```
+bundle exec srb tc --metrics-prefix 'codemetrics' --metrics-file sorbet.output.json
+```
+
+## SCC
+
+Collect multiple metrics from [SCC](https://github.com/boyter/scc) configured.
+
+**Requirements / Setup**:
+
+You need a `scc.output.json` file present in the current folder.
+
+You can generate the `scc.output.json` file with this example command:
+
+```
+scc -f json scc.output.json
+```
+
+# Providers
+
+## Console
+
+TODO
+
+## Datadog
+
+TODO
+
+# Contribute
+
+This project started as a side project, so I'm sure that is full
+of mistakes and areas to be improve. If you think you can tweak the code to
+make it better, I'll really appreciate a pull request. ;)

data/codemonitor.gemspec

@@ -37,6 +37,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'dogapi', '~> 1.45'
+  spec.add_runtime_dependency 'octokit', '~> 4.0'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'pry', '~> 0.13.1'

data/engines/custom/extractor.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Engines
+  module Custom
+    class Extractor
+      def call(provider)
+        provider.emit(metrics)
+      end
+
+      def requirements?
+        custom_files.length.positive?
+      end
+
+      private
+
+      def custom_files
+        Dir.glob('./.codemonitor/*.rb')
+      end
+
+      def metrics
+        custom_files.map do |file|
+          values = begin
+            eval File.read(file)
+          rescue SyntaxError => e
+            raise "Unable to execute the custom codemonitor script `#{file}` file"
+          end
+
+          raise "Malformed return value from `#{file}` file. It must be a hash of metrics" unless values.is_a?(Hash)
+
+          values
+        end.reduce({}, :merge)
+      end
+    end
+  end
+end

data/engines/debug/extractor.rb

@@ -8,8 +8,6 @@ module Engines
       ].freeze
 
       def call(provider)
-        return unless requirements?
-
         metrics = METRICS.map do |metric|
           [metric, send(metric) || 0]
         end.to_h
@@ -17,12 +15,12 @@ module Engines
         provider.emit(metrics)
       end
 
-      private
-
       def requirements?
         true
       end
 
+      private
+
       def debug_random
         rand(0..100)
       end

data/engines/eslint/extractor.rb

@@ -16,8 +16,6 @@ module Engines
       end
 
       def call(provider)
-        return unless requirements?
-
         metrics = METRICS.map do |metric|
           [metric, send(metric)]
         end.to_h
@@ -29,16 +27,14 @@ module Engines
         provider.emit(metrics)
       end
 
+      def requirements?
+        File.exist?('eslint.output.json')
+      end
+
       private
 
       attr_reader :threshold
 
-      def requirements?
-        # FIXME: Review if this is the only check we can do or there are more.
-        File.exist?('.eslintrc.js')
-      end
-
-      # NOTE: This output file must be created by an external command
       def eslint
         @eslint ||= JSON.parse(File.read('eslint.output.json'))
       end

data/engines/git/extractor.rb

@@ -20,8 +20,6 @@ module Engines
       end
 
       def call(provider)
-        return unless requirements?
-
         metrics = METRICS.map do |metric|
           [metric, send(metric)]
         end.to_h
@@ -32,14 +30,14 @@ module Engines
         provider.emit(metrics)
       end
 
-      private
-
-      attr_reader :threshold
-
       def requirements?
         File.exist?('.git')
       end
 
+      private
+
+      attr_reader :threshold
+
       def git_number_of_commits
         Shell.run("git log --format='%h'").lines.count
       end

data/engines/github/extractor.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'octokit'
+require 'date'
+
+Octokit.configure do |c|
+  c.auto_paginate = true
+end
+
+module Engines
+  module Github
+    class Extractor
+      METRICS = %i[
+        github_number_of_open_pull_requests
+        github_number_of_lead_time_in_days
+      ].freeze
+
+      def initialize
+        @access_token = ENV['GITHUB_TOKEN']
+        @repository = ENV['GITHUB_REPOSITORY']
+        @since_days = ENV['GITHUB_SINCE_DAYS'] || 30
+      end
+
+      def call(provider)
+        metrics = METRICS.map do |metric|
+          [metric, send(metric)]
+        end.to_h
+
+        provider.emit(metrics)
+      end
+
+      def requirements?
+        !access_token.nil? && !repository.nil?
+      end
+
+      private
+
+      attr_reader :access_token, :repository, :since_days
+
+      def github
+        @github ||= Octokit::Client.new(access_token: access_token)
+      end
+
+      def since
+        (Date.today - since_days).to_time.iso8601
+      end
+
+      def github_number_of_open_pull_requests
+        github.issues(repository, state: 'open').length
+      end
+
+      def github_number_of_lead_time_in_days
+        diffs = github
+          .issues(repository, since: since, state: 'closed')
+          .map do |issue|
+            next nil if issue[:pull_request][:merged_at].nil? || issue[:created_at].nil?
+
+            merged_at = Time.at(issue[:pull_request][:merged_at])
+            created_at = Time.at(issue[:created_at])
+
+            merged_at - created_at
+          end.reject do |diff|
+            diff.nil?
+          end
+
+        value = (diffs.reduce(:+) / diffs.size.to_f / (24 * 60 * 60))
+
+        value.round(2)
+      end
+    end
+  end
+end

data/engines/npm/extractor.rb

@@ -18,8 +18,6 @@ module Engines
       ].freeze
 
       def call(provider)
-        return unless requirements?
-
         metrics = METRICS.map do |metric|
           [metric, send(metric) || 0]
         end.to_h
@@ -27,12 +25,12 @@ module Engines
         provider.emit(metrics)
       end
 
-      private
-
       def requirements?
         File.exist?('package.json')
       end
 
+      private
+
       def npm_number_of_dependencies
         npm_package['dependencies'].keys.length
       end

data/engines/packwerk/extractor.rb

@@ -13,8 +13,6 @@ module Engines
       def initialize; end
 
       def call(provider)
-        return unless requirements?
-
         metrics = METRICS.map do |metric|
           [metric, send(metric)]
         end.to_h
@@ -22,12 +20,12 @@ module Engines
         provider.emit(metrics)
       end
 
-      private
-
       def requirements?
         packwerk_files.length.positive?
       end
 
+      private
+
       # NOTE: This output file must be created by an external command
       def packwerk_files
         Dir.glob('./**/deprecated_references.yml')

data/engines/rubocop/extractor.rb

@@ -15,8 +15,6 @@ module Engines
       end
 
       def call(provider)
-        return unless requirements?
-
         metrics = METRICS.map do |metric|
           [metric, send(metric)]
         end.to_h
@@ -28,15 +26,14 @@ module Engines
         provider.emit(metrics)
       end
 
+      def requirements?
+        File.exist?('rubocop.output.json')
+      end
+
       private
 
       attr_reader :threshold
 
-      def requirements?
-        File.exist?('.rubocop.yml')
-      end
-
-      # NOTE: This output file must be created by an external command
       def rubocop
         @rubocop ||= JSON.parse(File.read('rubocop.output.json'))
       end

data/engines/scc/extractor.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Engines
+  module Scc
+    class Extractor
+      METRICS = %i[].freeze
+      FIELDS = %w[Bytes Lines Code Comment Blank Complexity Count WeightedComplexity]
+
+      def initialize; end
+
+      def call(provider)
+        metrics = METRICS.map do |metric|
+          [metric, send(metric)]
+        end.to_h
+
+        metrics
+          .merge!(scc_totals)
+          .merge!(scc_by_file_type)
+
+        provider.emit(metrics)
+      end
+
+      def requirements?
+        File.exist?('scc.output.json')
+      end
+
+      private
+
+      def scc
+        @scc ||= JSON.parse(File.read('scc.output.json'))
+      end
+
+      def scc_totals
+        scc.each_with_object({}) do |type, totals|
+          FIELDS.each do |field|
+            key = "scc_total_#{clean(field)}"
+            totals[key] = 0 unless totals.key?(key)
+
+            totals[key] += type[field]
+          end
+        end
+      end
+
+      def scc_by_file_type
+        scc.map do |type|
+          FIELDS.map do |field|
+            ["scc_type_#{clean(type['Name'])}_#{clean(field)}", type[field]]
+          end.to_h
+        end.inject(&:merge)
+      end
+
+      def clean(key)
+        key.gsub(%r{[-,./ ]}, '_').downcase
+      end
+    end
+  end
+end

data/engines/semgrep/extractor.rb

@@ -15,8 +15,6 @@ module Engines
       end
 
       def call(provider)
-        return unless requirements?
-
         metrics = METRICS.map do |metric|
           [metric, send(metric)]
         end.to_h
@@ -26,15 +24,14 @@ module Engines
         provider.emit(metrics)
       end
 
+      def requirements?
+        File.exist?('semgrep.output.json')
+      end
+
       private
 
       attr_reader :threshold
 
-      def requirements?
-        File.exist?('.semgrep.yml')
-      end
-
-      # NOTE: This output file must be created by an external command
       def semgrep
         @semgrep ||= JSON.parse(File.read('semgrep.output.json'))
       end

data/engines/sorbet/extractor.rb

@@ -24,8 +24,6 @@ module Engines
       def initialize; end
 
       def call(provider)
-        return unless requirements?
-
         metrics = METRICS.map do |metric|
           [metric, send(metric)]
         end.to_h
@@ -33,13 +31,12 @@ module Engines
         provider.emit(metrics)
       end
 
-      private
-
       def requirements?
         File.exist?('sorbet.output.json')
       end
 
-      # NOTE: This output file must be created by an external command
+      private
+
       def sorbet
         @sorbet ||= JSON.parse(File.read('sorbet.output.json'))
       end

data/exe/codemonitor

@@ -7,11 +7,14 @@ require_relative '../providers/datadog'
 require_relative '../engines/eslint/extractor'
 require_relative '../engines/debug/extractor'
 require_relative '../engines/git/extractor'
+require_relative '../engines/github/extractor'
 require_relative '../engines/npm/extractor'
 require_relative '../engines/packwerk/extractor'
 require_relative '../engines/rubocop/extractor'
 require_relative '../engines/semgrep/extractor'
 require_relative '../engines/sorbet/extractor'
+require_relative '../engines/scc/extractor'
+require_relative '../engines/custom/extractor'
 
 PROVIDERS = {
   console: Providers::Console,
@@ -22,11 +25,14 @@ EXTRACTORS = {
   eslint: Engines::Eslint::Extractor,
   debug: Engines::Debug::Extractor,
   git: Engines::Git::Extractor,
+  github: Engines::Github::Extractor,
   npm: Engines::Npm::Extractor,
   packwerk: Engines::Packwerk::Extractor,
   rubocop: Engines::Rubocop::Extractor,
   semgrep: Engines::Semgrep::Extractor,
-  sorbet: Engines::Sorbet::Extractor
+  sorbet: Engines::Sorbet::Extractor,
+  scc: Engines::Scc::Extractor,
+  custom: Engines::Custom::Extractor
 }.freeze
 
 config_provider = ENV['CODEMONITOR_PROVIDER'] || 'console'
@@ -45,6 +51,8 @@ puts '# process start'
 extractors
   .map(&:new)
   .map do |extractor|
+    raise "Requirements not fullfiled in #{extractor.class.name}" unless extractor.requirements?
+
     extractor.call(provider)
   end
 

data/lib/codemonitor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CodeMonitor
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codemonitor
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Ferran Basora
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-01 00:00:00.000000000 Z
+date: 2022-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dogapi
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.45'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -115,12 +129,15 @@ files:
 - bin/console
 - bin/setup
 - codemonitor.gemspec
+- engines/custom/extractor.rb
 - engines/debug/extractor.rb
 - engines/eslint/extractor.rb
 - engines/git/extractor.rb
+- engines/github/extractor.rb
 - engines/npm/extractor.rb
 - engines/packwerk/extractor.rb
 - engines/rubocop/extractor.rb
+- engines/scc/extractor.rb
 - engines/semgrep/extractor.rb
 - engines/sorbet/extractor.rb
 - exe/codemonitor