codemonitor 0.3.2 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b9e0298cc93e22a2eb9b0de7b44ceafc1a0b34edaaac684d590c01d0b5dfc88
-  data.tar.gz: b3fbe2ebc9efe2de493f79492f0f26a4c20b21b744cf8cdc71be987d95cf8cce
+  metadata.gz: 32f7be0ad2a196ea1dd1e420c56b9a2b1c87c2b7e0381f6e968fd1df706f86c0
+  data.tar.gz: 5a88b2dec7531acc15f99085ee4f456ee18a0e535cec5f242feaabc718974c96
 SHA512:
-  metadata.gz: 6f86d0f5080a730085b40782c71127400914054430a375c602030970303be00e50b9df4d85da182a5a2c67e6d733866727e37fa59ab9213cceff96196ea07552
-  data.tar.gz: 4ce76891b6e0ae204fb737b1ccecee4b7c19b6e2f698b0b92853b33bda98978c374c5924290797a3f19bb550c53dd2f5ffc5ddfe741eedd800148aff8c8cfa56
+  metadata.gz: d34229aa5e21856c951a9b707f5269cdffbe4c4c1839b741fdddadf672829e3c94a83a08075f3abeff2e414f33eaedbebdbb42a36ab3abfecd5d7165abc54657
+  data.tar.gz: d6a0d476275b4738887fa4acf83948fac95700142fb3fbe0092a54dd778ee5da4182d7b8cba4f781678d4ae85d8fe34fa106dbe7c4db598f8b4baf9c3595f102

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/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,37 @@
+# frozen_string_literal: true
+
+module Engines
+  module Custom
+    class Extractor
+      def call(provider)
+        return unless requirements?
+
+        provider.emit(metrics)
+      end
+
+      private
+
+      def requirements?
+        custom_files.length.positive?
+      end
+
+      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/github/extractor.rb

@@ -0,0 +1,74 @@
+# 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)
+        return unless requirements?
+
+        metrics = METRICS.map do |metric|
+          [metric, send(metric)]
+        end.to_h
+
+        provider.emit(metrics)
+      end
+
+      private
+
+      attr_reader :access_token, :repository, :since_days
+
+      def github
+        @github ||= Octokit::Client.new(access_token: access_token)
+      end
+
+      def requirements?
+        !access_token.nil? && !repository.nil?
+      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/scc/extractor.rb

@@ -0,0 +1,62 @@
+# 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)
+        return unless requirements?
+
+        metrics = METRICS.map do |metric|
+          [metric, send(metric)]
+        end.to_h
+
+        metrics
+          .merge!(scc_totals)
+          .merge!(scc_by_file_type)
+
+        provider.emit(metrics)
+      end
+
+      private
+
+      def requirements?
+        File.exist?('scc.output.json')
+      end
+
+      # NOTE: This output file must be created by an external command
+      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/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'

data/lib/codemonitor/version.rb

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

data/providers/datadog.rb

@@ -17,7 +17,7 @@ module Providers
     def send
       datadog_client.batch_metrics do
         pending.each do |metric, value|
-          metric = metric_prefix + metric
+          metric = "#{metric_prefix}#{metric}"
           puts "#{metric}: #{value}"
           datadog_client.emit_point(metric, value, type: 'gauge')
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codemonitor
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.6
 platform: ruby
 authors:
 - Ferran Basora
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-01 00:00:00.000000000 Z
+date: 2022-01-29 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