codemonitor 0.1.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce80c6de6c3579fdb8bc4d52f63905ec45124f6e4a9891ac0ddae5c90608d3f2
-  data.tar.gz: da5354cb8704715dc4d005b2615f034a85b6c43ff0a16ef3a4ddcf45561f139e
+  metadata.gz: b2b693d8b21e5c6041765bf54d568d21b7e8e54abeb1695d7937166a6bf9b2b7
+  data.tar.gz: 3af8eb6ab76db485ddc34a793c04793238b0d92c4523440028dd2809d58c1f50
 SHA512:
-  metadata.gz: 9b3ceadf4db389641f91d732038e6fc7affbd604815d3b5e50e16743b601a6471c7bab85445f20669c2ecd364e7f33984d931b941130b2b3dd31eaebf8efdfe8
-  data.tar.gz: e17eb93b4b386a587ac9265c63508942055a692ab2c53cd9865c20f31a1c4750c18e42bbb9ca8de70a387ceb4fcc25f7330f6c7d69695ed8364005c04652071c
+  metadata.gz: 2c0a23989bded3388a21ac6c40c87ed4ed6d18a3f62d9ff804a13e595fb2152eb17dd8955224812ebfac2a71d37a569b1cadf1bf9f46195d87f7576351a6b39d
+  data.tar.gz: 8ae23e524620fd956835b5bf85699153a579796701c6e605ab7ad1f670f30622b50ee3d1528b2a79f7ef7b3d698e0aae5d8b463a59b96c69b663ba4e77896d22

data/.rubocop.yml

@@ -1,3 +1,6 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
 Lint/RaiseException:
   Enabled: false
 

data/Gemfile

@@ -1,4 +1,6 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rubocop-changes.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    codemonitor (0.1.0)
+    codemonitor (0.3.0)
       dogapi (~> 1.45)
 
 GEM

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "rubocop/changes"
+require 'bundler/setup'
+require 'rubocop/changes'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "rubocop/changes"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/codemonitor.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'codemonitor/version'
@@ -26,7 +28,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added
   # into git.
-  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = 'exe'
@@ -37,8 +39,8 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'dogapi', '~> 1.45'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'pry', '~> 0.13.1'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.9'
-  spec.add_development_dependency 'pry', '~> 0.13.1'
   spec.add_development_dependency 'rubocop', '~> 0.80'
 end

data/engines/debug/extractor.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Engines
+  module Debug
+    class Extractor
+      METRICS = %i[
+        debug_random
+      ].freeze
+
+      def call(provider)
+        return unless requirements?
+
+        metrics = METRICS.map do |metric|
+          [metric, send(metric) || 0]
+        end.to_h
+
+        provider.emit(metrics)
+      end
+
+      private
+
+      def requirements?
+        true
+      end
+
+      def debug_random
+        rand(0..100)
+      end
+    end
+  end
+end

data/engines/eslint/extractor.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Engines
+  module Eslint
+    class Extractor
+      METRICS = %i[
+        eslint_number_of_offended_files
+        eslint_number_of_offenses
+        eslint_number_of_correctable
+      ].freeze
+
+      def initialize
+        @threshold = ENV.fetch('CODEMONITOR_ESLINT_THRESHOLD', '10').to_i
+      end
+
+      def call(provider)
+        return unless requirements?
+
+        metrics = METRICS.map do |metric|
+          [metric, send(metric)]
+        end.to_h
+
+        metrics
+          .merge!(eslint_by_severity)
+          .merge!(eslint_by_rule)
+
+        provider.emit(metrics)
+      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
+
+      def eslint_files
+        eslint
+      end
+
+      def eslint_number_of_offended_files
+        eslint_files.length
+      end
+
+      def eslint_offenses
+        eslint_files
+          .map { |offense| offense['messages'] }
+          .flatten
+      end
+
+      def eslint_number_of_offenses
+        eslint_offenses.length
+      end
+
+      def eslint_number_of_correctable
+        eslint_offenses
+          .filter { |offense| offense['correctable'] }
+          .length
+      end
+
+      def eslint_by_severity
+        eslint_offenses
+          .each_with_object(Hash.new(0)) do |offense, total|
+            total[severity(offense['severity'])] += 1
+          end.map do |key, value|
+            ["eslint_severity_#{key}", value]
+          end.to_h
+      end
+
+      def eslint_by_rule
+        eslint_offenses
+          .each_with_object(Hash.new(0)) do |offense, total|
+            total[offense['ruleId']] += 1
+          end.map do |key, value|
+            ["eslint_rule_#{clean(key)}", value] if value >= threshold
+          end.compact.to_h
+      end
+
+      def clean(key)
+        key.gsub(%r{[-,./ ]}, '_').downcase
+      end
+
+      def severity(value)
+        return 'warning' if value == 1
+        return 'error' if value == 2
+
+        'unknown'
+      end
+    end
+  end
+end

data/engines/git/extractor.rb

@@ -15,6 +15,10 @@ module Engines
         git_number_of_lines
       ].freeze
 
+      def initialize
+        @threshold = ENV.fetch('CODEMONITOR_GIT_FILES_THRESHOLD', '0').to_i
+      end
+
       def call(provider)
         return unless requirements?
 
@@ -22,11 +26,16 @@ module Engines
           [metric, send(metric)]
         end.to_h
 
+        metrics
+          .merge!(git_file_extensions)
+
         provider.emit(metrics)
       end
 
       private
 
+      attr_reader :threshold
+
       def requirements?
         File.exist?('.git')
       end
@@ -58,7 +67,7 @@ module Engines
       end
 
       def git_number_of_files
-        Shell.run('git ls-tree -r master --name-only')
+        Shell.run('git ls-tree -r HEAD --name-only')
           .lines
           .count
       end
@@ -74,6 +83,18 @@ module Engines
             File.read(File.expand_path(file.strip, Dir.pwd)).lines.count
           end.sum
       end
+
+      def git_file_extensions
+        Shell.run('git ls-files')
+          .lines
+          .map do |file|
+            File.extname(file.strip)
+          end.each_with_object(Hash.new(0)) do |type, total|
+            total[type.gsub('.', '')] += 1
+          end.map do |key, value|
+            ["git_file_extensions_#{key}", value] if value >= threshold
+          end.compact.to_h
+      end
     end
   end
 end

data/engines/packwerk/extractor.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Engines
+  module Packwerk
+    class Extractor
+      METRICS = %i[
+        packwerk_number_of_dependency_violations
+        packwerk_number_of_privacy_violations
+      ].freeze
+
+      def initialize; end
+
+      def call(provider)
+        return unless requirements?
+
+        metrics = METRICS.map do |metric|
+          [metric, send(metric)]
+        end.to_h
+
+        provider.emit(metrics)
+      end
+
+      private
+
+      def requirements?
+        packwerk_files.length.positive?
+      end
+
+      # NOTE: This output file must be created by an external command
+      def packwerk_files
+        Dir.glob('./**/deprecated_references.yml')
+      end
+
+      def packwerk_number_of_dependency_violations
+        packwerk_violations['dependency']
+      end
+
+      def packwerk_number_of_privacy_violations
+        packwerk_violations['privacy']
+      end
+
+      def packwerk_items
+        @packwerk_items ||= packwerk_files
+          .map { |file| YAML.load_file(file) }
+          .reduce({}, :merge)
+          .map { |_key, values| values }
+          .flatten
+          .reduce({}, :merge)
+      end
+
+      def packwerk_violations
+        packwerk_items
+          .values
+          .each_with_object(Hash.new(0)) do |offense, total|
+            offense['violations'].each do |violation|
+              total[violation] += 1
+            end
+          end
+      end
+    end
+  end
+end

data/engines/sorbet/extractor.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Engines
+  module Sorbet
+    class Extractor
+      METRICS = %i[
+        sorbet_number_of_sig_count
+        sorbet_number_of_input_classes_total
+        sorbet_number_of_input_sends_total
+        sorbet_number_of_input_files
+        sorbet_number_of_input_methods_total
+        sorbet_number_of_input_modules_total
+
+        sorbet_number_of_sigil_true
+        sorbet_number_of_sigil_false
+        sorbet_number_of_sigil_autogenerated
+        sorbet_number_of_sigil_strong
+        sorbet_number_of_sigil_strict
+        sorbet_number_of_sigil_ignore
+      ].freeze
+
+      def initialize; end
+
+      def call(provider)
+        return unless requirements?
+
+        metrics = METRICS.map do |metric|
+          [metric, send(metric)]
+        end.to_h
+
+        provider.emit(metrics)
+      end
+
+      private
+
+      def requirements?
+        File.exist?('sorbet.output.json')
+      end
+
+      # NOTE: This output file must be created by an external command
+      def sorbet
+        @sorbet ||= JSON.parse(File.read('sorbet.output.json'))
+      end
+
+      def sorbet_metrics
+        sorbet['metrics']
+      end
+
+      def find_metric(name, default = 0)
+        match = sorbet_metrics.find do |metric|
+          metric['name'] == name
+        end
+
+        return default if match.nil?
+
+        match['value']
+      end
+
+      def sorbet_number_of_sig_count
+        find_metric('codemetrics.types.sig.count')
+      end
+
+      def sorbet_number_of_input_classes_total
+        find_metric('codemetrics.types.input.classes.total')
+      end
+
+      def sorbet_number_of_input_sends_total
+        find_metric('codemetrics.types.input.sends.total')
+      end
+
+      def sorbet_number_of_input_files
+        find_metric('codemetrics.types.input.files')
+      end
+
+      def sorbet_number_of_input_methods_total
+        find_metric('codemetrics.types.input.methods.total')
+      end
+
+      def sorbet_number_of_input_modules_total
+        find_metric('codemetrics.types.input.modules.total')
+      end
+
+      def sorbet_number_of_sigil_true
+        find_metric('codemetrics.types.input.files.sigil.true')
+      end
+
+      def sorbet_number_of_sigil_false
+        find_metric('codemetrics.types.input.files.sigil.false')
+      end
+
+      def sorbet_number_of_sigil_autogenerated
+        find_metric('codemetrics.types.input.files.sigil.autogenerated')
+      end
+
+      def sorbet_number_of_sigil_strong
+        find_metric('codemetrics.types.input.files.sigil.strong')
+      end
+
+      def sorbet_number_of_sigil_strict
+        find_metric('codemetrics.types.input.files.sigil.strict')
+      end
+
+      def sorbet_number_of_sigil_ignore
+        find_metric('codemetrics.types.input.files.sigil.ignore')
+      end
+    end
+  end
+end

data/exe/codemonitor

@@ -4,10 +4,14 @@
 require_relative '../providers/console'
 require_relative '../providers/datadog'
 
+require_relative '../engines/eslint/extractor'
+require_relative '../engines/debug/extractor'
 require_relative '../engines/git/extractor'
 require_relative '../engines/npm/extractor'
-require_relative '../engines/semgrep/extractor'
+require_relative '../engines/packwerk/extractor'
 require_relative '../engines/rubocop/extractor'
+require_relative '../engines/semgrep/extractor'
+require_relative '../engines/sorbet/extractor'
 
 PROVIDERS = {
   console: Providers::Console,
@@ -15,10 +19,14 @@ PROVIDERS = {
 }.freeze
 
 EXTRACTORS = {
+  eslint: Engines::Eslint::Extractor,
+  debug: Engines::Debug::Extractor,
   git: Engines::Git::Extractor,
   npm: Engines::Npm::Extractor,
+  packwerk: Engines::Packwerk::Extractor,
+  rubocop: Engines::Rubocop::Extractor,
   semgrep: Engines::Semgrep::Extractor,
-  rubocop: Engines::Rubocop::Extractor
+  sorbet: Engines::Sorbet::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.1.0'
+  VERSION = '0.3.3'
 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
@@ -26,6 +26,6 @@ module Providers
 
     private
 
-    attr_reader :pending, :datadog_client
+    attr_reader :pending, :metric_prefix, :datadog_client
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codemonitor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Ferran Basora
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-11 00:00:00.000000000 Z
+date: 2021-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dogapi
@@ -39,47 +39,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 0.13.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 0.13.1
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -115,10 +115,14 @@ files:
 - bin/console
 - bin/setup
 - codemonitor.gemspec
+- engines/debug/extractor.rb
+- engines/eslint/extractor.rb
 - engines/git/extractor.rb
 - engines/npm/extractor.rb
+- engines/packwerk/extractor.rb
 - engines/rubocop/extractor.rb
 - engines/semgrep/extractor.rb
+- engines/sorbet/extractor.rb
 - exe/codemonitor
 - lib/codemonitor/version.rb
 - lib/shell.rb