codemonitor 0.3.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54b2ce0b7c2997591225e5e7487433854b3fff767e3272b3d02210de337253cf
-  data.tar.gz: aa9a60e54480ec4602ec108f45b84323aa04aa46f3df622a4db2a303cb1e6ec3
+  metadata.gz: f85a1e1dbcae9d0bd26c461505a12449283dbf2029ee34ba59b36a2277e00321
+  data.tar.gz: 2cc548a6646d98cbeab3b72ce2dff06fd0d40175bf599fec2db5e12659aec7c4
 SHA512:
-  metadata.gz: 47fb68d254802463f047d96ef409b111ee3f65c6e007a74122bb90151a4e4d457ed2b7b3c4e2bb6da0cc7da45284a933a43167714b39d7d6ebe291f68e8a1822
-  data.tar.gz: 2a466e51f3cd2e5936600680068af4bdb0ee717e9fcbfcc657394d08640f2b00799e2f82a3f183093bd6e1e8c0ee286c2948b3f5f777b5eb8e2e45fd464d4fcf
+  metadata.gz: 7af9d278c2c2fcbba028ecb161cf7ee49b374ef701aee25bbb2ccfc3fe714a2fcf54d05c18a43653dee3e3d7263904668b38fa74569c8168c22a87be4bd6b4e2
+  data.tar.gz: f928807e202db2c1b60b3cec7e5df66abd44b04c8c4ddc165a201476c8e04a36ac3f3bd036abc5e3eb54aac66299bc99ac8827aae822d4587d00a1d22a6ff96d

data/Gemfile.lock

@@ -1,25 +1,56 @@
 PATH
   remote: .
   specs:
-    codemonitor (0.3.0)
+    codemonitor (0.5.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.10.0)
+      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.7)
     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
@@ -63,4 +98,4 @@ DEPENDENCIES
   rubocop (~> 0.80)
 
 BUNDLED WITH
-   2.2.17
+   2.3.12

data/README.md

@@ -12,7 +12,7 @@ Collect multiple metrics from the a Git repository.
 
 **Requirements / Setup**:
 
-You need a `.git` folder present in the current folder: 
+You need a `.git` folder present in the current folder:
 
 **Options**:
 
@@ -103,6 +103,20 @@ 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

data/engines/custom/extractor.rb

@@ -4,17 +4,15 @@ module Engines
   module Custom
     class Extractor
       def call(provider)
-        return unless requirements?
-
         provider.emit(metrics)
       end
 
-      private
-
       def requirements?
         custom_files.length.positive?
       end
 
+      private
+
       def custom_files
         Dir.glob('./.codemonitor/*.rb')
       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

@@ -22,8 +22,6 @@ module Engines
       end
 
       def call(provider)
-        return unless requirements?
-
         metrics = METRICS.map do |metric|
           [metric, send(metric)]
         end.to_h
@@ -31,6 +29,10 @@ module Engines
         provider.emit(metrics)
       end
 
+      def requirements?
+        !access_token.nil? && !repository.nil?
+      end
+
       private
 
       attr_reader :access_token, :repository, :since_days
@@ -39,10 +41,6 @@ module Engines
         @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

data/engines/jest-json-summary/extractor.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Engines
+  module JestJsonSummary
+    class Extractor
+      METRICS = %i[].freeze
+
+      def initialize; end
+
+      def call(provider)
+        metrics = METRICS.map do |metric|
+          [metric, send(metric)]
+        end.to_h
+
+        metrics
+          .merge!(total_lines)
+          .merge!(total_statements)
+          .merge!(total_functions)
+          .merge!(total_branches)
+          .merge!(total_branches_true)
+
+        provider.emit(metrics)
+      end
+
+      def requirements?
+        File.exist?('jest_json_summary.output.json')
+      end
+
+      private
+
+      def json_summary
+        @json_summary ||= JSON.parse(File.read('jest_json_summary.output.json'))
+      end
+
+      def total_lines
+        flatten('lines')
+      end
+
+      def total_statements
+        flatten('statements')
+      end
+
+      def total_functions
+        flatten('functions')
+      end
+
+      def total_branches
+        flatten('branches')
+      end
+
+      def total_branches_true
+        flatten('branchesTrue', 'branches_true')
+      end
+
+      def flatten(member, rename = nil)
+        json_summary['total'][member].map do |key, value|
+          ["jest_json_summary_#{rename || member}_#{key}", value.to_i]
+        end.to_h
+      end
+    end
+  end
+end

data/engines/npm/extractor.rb

@@ -8,18 +8,24 @@ module Engines
   module Npm
     class Extractor
       METRICS = %i[
-        npm_number_of_dependencies
+        npm_number_of_prod_dependencies
         npm_number_of_dev_dependencies
         npm_number_of_scripts
-        npm_number_of_vulnerable_dependencies
+        npm_number_of_computed_prod_dependencies
+        npm_number_of_computed_dev_dependencies
+        npm_number_of_computed_optional_dependencies
+        npm_number_of_computed_peer_dependencies
+        npm_number_of_computed_peer_optional_dependencies
+        npm_number_of_computed_total_dependencies
+        npm_number_of_vulnerable_dependencies_info
         npm_number_of_vulnerable_dependencies_low
         npm_number_of_vulnerable_dependencies_moderate
         npm_number_of_vulnerable_dependencies_high
+        npm_number_of_vulnerable_dependencies_critical
+        npm_number_of_vulnerable_dependencies_total
       ].freeze
 
       def call(provider)
-        return unless requirements?
-
         metrics = METRICS.map do |metric|
           [metric, send(metric) || 0]
         end.to_h
@@ -27,26 +33,26 @@ module Engines
         provider.emit(metrics)
       end
 
-      private
-
       def requirements?
-        File.exist?('package.json')
+        File.exist?('package.json') && File.exist?('package-lock.json')
       end
 
-      def npm_number_of_dependencies
-        npm_package['dependencies'].keys.length
+      private
+
+      def npm_number_of_prod_dependencies
+        npm_package['dependencies']&.keys&.length
       end
 
       def npm_number_of_dev_dependencies
-        npm_package['devDependencies'].keys.length
+        npm_package['devDependencies']&.keys&.length
       end
 
       def npm_number_of_scripts
         npm_package['scripts'].keys.length
       end
 
-      def npm_number_of_vulnerable_dependencies
-        npm_audit['advisories'].length
+      def npm_number_of_vulnerable_dependencies_info
+        npm_audit_by_severity['info']
       end
 
       def npm_number_of_vulnerable_dependencies_low
@@ -61,6 +67,38 @@ module Engines
         npm_audit_by_severity['high']
       end
 
+      def npm_number_of_vulnerable_dependencies_critical
+        npm_audit_by_severity['critical']
+      end
+
+      def npm_number_of_vulnerable_dependencies_total
+        npm_audit_by_severity['total']
+      end
+
+      def npm_number_of_computed_prod_dependencies
+        npm_audit_by_dependencies['prod']
+      end
+
+      def npm_number_of_computed_dev_dependencies
+        npm_audit_by_dependencies['dev']
+      end
+
+      def npm_number_of_computed_optional_dependencies
+        npm_audit_by_dependencies['optional']
+      end
+
+      def npm_number_of_computed_peer_dependencies
+        npm_audit_by_dependencies['peer']
+      end
+
+      def npm_number_of_computed_peer_optional_dependencies
+        npm_audit_by_dependencies['peerOptional']
+      end
+
+      def npm_number_of_computed_total_dependencies
+        npm_audit_by_dependencies['total']
+      end
+
       def npm_package
         @npm_package ||= JSON.parse(File.read('package.json'))
       end
@@ -69,10 +107,12 @@ module Engines
         @npm_audit ||= JSON.parse(Shell.run('npm audit --json'))
       end
 
+      def npm_audit_by_dependencies
+        npm_audit['metadata']['dependencies']
+      end
+
       def npm_audit_by_severity
-        npm_audit['advisories']
-          .map { |_key, value| value['severity'] }
-          .each_with_object(Hash.new(0)) { |e, total| total[e] += 1; }
+        npm_audit['metadata']['vulnerabilities']
       end
     end
   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].freeze
+
+      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

@@ -13,7 +13,9 @@ 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'
+require_relative '../engines/jest-json-summary/extractor'
 
 PROVIDERS = {
   console: Providers::Console,
@@ -30,7 +32,9 @@ EXTRACTORS = {
   rubocop: Engines::Rubocop::Extractor,
   semgrep: Engines::Semgrep::Extractor,
   sorbet: Engines::Sorbet::Extractor,
-  custom: Engines::Custom::Extractor
+  scc: Engines::Scc::Extractor,
+  custom: Engines::Custom::Extractor,
+  jest_json_summary: Engines::JestJsonSummary::Extractor
 }.freeze
 
 config_provider = ENV['CODEMONITOR_PROVIDER'] || 'console'
@@ -49,6 +53,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.5'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codemonitor
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.5.0
 platform: ruby
 authors:
 - Ferran Basora
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-12 00:00:00.000000000 Z
+date: 2022-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dogapi
@@ -134,9 +134,11 @@ files:
 - engines/eslint/extractor.rb
 - engines/git/extractor.rb
 - engines/github/extractor.rb
+- engines/jest-json-summary/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
@@ -166,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Collect many metrics your code is generating