danger-compose_compiler_metrics 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5174bc2092a2c48fa3a84c6cb7006b0836fc9ccdc55f647efad88cc3fbd52e65
-  data.tar.gz: de4c9958f624409b65e36aa49d5b001de6f474e79c43afe51a42011f1150ac91
+  metadata.gz: 8b9f0973e51bb4416bad39bb523c7d0b9e81828aa750c435fbdfe2b471857a48
+  data.tar.gz: cffa918441edcfa7bbd58e0d994a508c32abb22679194af550836e5edd5cb294
 SHA512:
-  metadata.gz: 4543a2ecc312efe6d7357acaf70e19bf84d4f2938cc525b9c33db740f04aee929acc7c2cdd17a98c5cb112bb3d3595654ac92498d3bf5de665e246608ea7e3b3
-  data.tar.gz: 77d0f263a40a8286b3b36cc6a3dc2bf6b3dff3370e91717d5bdefd4ed824ddecb067c8f14a9c70c1e8d000a35867817e66895f16701d9f653cef050f86fb251b
+  metadata.gz: c171857c7292b8b335c143721da0bc3cf8b38dd28de677b33bf210d49346908ebde5ae5e073151c7c47f1016d5d79f34c799aa1a077ee476312033a2d2b08862
+  data.tar.gz: 2b4451fb0c7150296ab5c71ead7711584816412349afc8195631016121a2c2cab87bc6eb423b3ee8f681a19d3064492420f13a91578888cff648059ae4ff6ddc

data/.github/workflows/test.yml

@@ -0,0 +1,47 @@
+name: test
+on: [push]
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    container:
+      image: ruby:3.0
+      options: --user 1001
+
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Restore gem cache
+        uses: actions/cache/restore@v4
+        with:
+          key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+          path: |
+            vendor/bundle
+          restore-keys: |
+            ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+            ${{ runner.os }}-gem-
+            ${{ runner.os }}-
+
+      - name: Bundle install
+        run: |
+          bundle config set path 'vendor/bundle'
+          bundle config set clean 'true'
+          bundle install --jobs 4 --retry 3
+
+      - name: Save gem cache
+        uses: actions/cache/save@v4
+        with:
+          path: |
+            vendor/bundle
+          key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+
+      - name: Run rubocop
+        run: bundle exec rubocop
+
+      - name: Run rspec
+        run: bundle exec rspec

data/.rubocop.yml

@@ -3,7 +3,7 @@
 # If you don't like these settings, just delete this file :)
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes

data/.ruby-version

@@ -0,0 +1 @@
+3.0.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-compose_compiler_metrics (0.0.1)
+    danger-compose_compiler_metrics (0.0.4)
       csv
       danger-plugin-api (~> 1.0)
       json
@@ -98,7 +98,7 @@ GEM
     public_suffix (5.0.4)
     racc (1.7.3)
     rainbow (3.1.1)
-    rake (10.5.0)
+    rake (13.1.0)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
@@ -154,7 +154,7 @@ DEPENDENCIES
   guard-rspec (~> 4.7)
   listen (= 3.0.7)
   pry
-  rake (~> 10.0)
+  rake
   rspec (~> 3.4)
   rubocop
   yard

data/danger-compose_compiler_metrics.gemspec

@@ -19,13 +19,15 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = "~> 3.0"
+
+  spec.add_runtime_dependency "csv"
   spec.add_runtime_dependency "danger-plugin-api", "~> 1.0"
   spec.add_runtime_dependency "json"
-  spec.add_runtime_dependency "csv"
 
   # General ruby development
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake"
 
   # Testing support
   spec.add_development_dependency "rspec", "~> 3.4"

data/lib/compose_compiler_metrics/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ComposeCompilerMetrics
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/lib/compose_compiler_metrics/helper.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Helper
   def build_variants(dir)
     Dir.glob("#{dir}/*").
-      map { |s| File.basename(s).split(/[_\-]/).take(2) }.
+      map { |s| File.basename(s).split(/[_-]/).take(2) }.
       uniq
   end
 
@@ -31,9 +33,11 @@ module Helper
     end.join("\n")
   end
 
-  def folding(summary, details)
+  def folding(summary, details, open)
+    open_attribute = open == :open ? "open" : ""
+
     <<~HTML
-    <details>
+    <details #{open_attribute}>
     <summary>
 
     #{summary}

data/lib/compose_compiler_metrics/metrics.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "json"
+
+class Metrics
+  attr_reader :hash
+
+  def initialize(hash)
+    @hash = hash
+  end
+
+  def keys
+    to_h.keys
+  end
+
+  def grouping_keys
+    keys.map { |key| grouping_key(key) }.uniq
+  end
+
+  def grouped_metrics
+    hash.
+      group_by { |k, _| grouping_key(k) }.
+      transform_values { |array| Metrics.new(array.to_h) }
+  end
+
+  def to_h
+    hash
+  end
+
+  def respond_to_missing?(method_name, include_private)
+    hash.key?(method_name.to_s) || hash.key?(convert_to_metrics_key(method_name)) || super
+  end
+
+  def method_missing(method_name)
+    return hash[method_name.to_s] if hash.key?(method_name.to_s)
+
+    key = convert_to_metrics_key(method_name)
+    return hash[key] if hash.key?(key)
+
+    super method_name
+  end
+
+  def self.load(path)
+    Loader.new(path).load
+  end
+
+  def ==(other)
+    hash == other.hash
+  end
+
+  class Loader
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def metrics_hash
+      @metrics_hash ||= JSON.parse(File.read(path))
+    end
+
+    def load
+      advanced_metrics_hash = metrics_hash.each.with_object({}) do |(k, v), h|
+        h[k] = v
+
+        case k
+        when "skippableComposables"
+          h["unskippableComposables"] = metrics_hash["totalComposables"] - metrics_hash["skippableComposables"]
+        when "restartableComposables"
+          h["unrestartableComposables"] = metrics_hash["totalComposables"] - metrics_hash["restartableComposables"]
+        end
+      end
+
+      Metrics.new(advanced_metrics_hash)
+    end
+  end
+
+  private
+
+  def grouping_key(key)
+    to_snake_case(key).split("_").last.capitalize
+  end
+
+  def to_small_camel_case(str)
+    str.to_s.split("_").each_with_index.map { |s, i| i.zero? ? s : s.capitalize }.join
+  end
+  alias convert_to_metrics_key to_small_camel_case
+
+  def to_snake_case(str)
+    str.gsub(/::/, "/")
+      .gsub(/([A-Z]+)([A-Z][a-z])/, "\\1_\\2")
+      .gsub(/([a-z\d])([A-Z])/, "\\1_\\2")
+      .tr("-", "_")
+      .downcase
+  end
+end

data/lib/compose_compiler_metrics/plugin.rb

@@ -1,17 +1,18 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'csv'
+require "json"
+require "csv"
 
-require_relative './helper'
+require_relative "./helper"
+require_relative "./metrics"
 
 module Danger
   class DangerComposeCompilerMetrics < Plugin
     include Helper
 
-    def report_difference(metrics_dir, base_metrics_dir)
+    def report_difference(metrics_dir, reference_metrics_dir, options = {})
       unless installed?("diff")
-        error "diff command not found. Please install diff command."
+        failure "diff command not found. Please install diff command."
         return
       end
 
@@ -21,38 +22,93 @@ module Danger
 
         # Metrics Report
         metrics_path = File.join(metrics_dir, metrics_filename(module_name, build_variant))
-        base_metrics_path = File.join(base_metrics_dir, metrics_filename(module_name, build_variant))
-        report_file_difference("Metrics", metrics_path, base_metrics_path)
+        reference_metrics_path = File.join(reference_metrics_dir, metrics_filename(module_name, build_variant))
+
+        report_metrics_report("Metrics Summary", metrics_path, reference_metrics_path, options[:metrics_summary])
+        report_file_difference("Metrics", metrics_path, reference_metrics_path, options[:metrics])
 
         # Composable Stats Report
         composable_stats_report_path = File.join(metrics_dir, composable_stats_report_path(module_name, build_variant))
-        base_composable_stats_report_path = File.join(base_metrics_dir, composable_stats_report_path(module_name, build_variant))
-        report_file_difference("Composable Stats Report", composable_stats_report_path, base_composable_stats_report_path)
+        reference_composable_stats_report_path = File.join(reference_metrics_dir, composable_stats_report_path(module_name, build_variant))
+        report_file_difference("Composable Stats Report", composable_stats_report_path, reference_composable_stats_report_path, options[:composable_stats])
 
         # Composable Report
         composable_report_path = File.join(metrics_dir, composable_report_path(module_name, build_variant))
-        base_composable_report_path = File.join(base_metrics_dir, composable_report_path(module_name, build_variant))
-        report_file_difference("Composable Report", composable_report_path, base_composable_report_path)
+        reference_composable_report_path = File.join(reference_metrics_dir, composable_report_path(module_name, build_variant))
+        report_file_difference("Composable Report", composable_report_path, reference_composable_report_path, options[:composable_report])
 
         # Class Report
         class_report_path = File.join(metrics_dir, class_report_path(module_name, build_variant))
-        base_class_report_path = File.join(base_metrics_dir, class_report_path(module_name, build_variant))
-        report_file_difference("Composable Report", class_report_path, base_class_report_path)
+        reference_class_report_path = File.join(reference_metrics_dir, class_report_path(module_name, build_variant))
+        report_file_difference("Class Report", class_report_path, reference_class_report_path, options[:class_report])
+      end
+    end
+
+    def report_metrics_report(title, metrics_path, reference_metrics_path, open)
+      open ||= :close
+      return if open == :disabled
+
+      unless File.exist?(metrics_path)
+        warn "DangerComposeCompilerMetrics: new file not found at #{metrics_path}. Skipping file difference report."
+        return
+      end
+
+      unless File.exist?(reference_metrics_path)
+        warn "DangerComposeCompilerMetrics: reference file not found at #{reference_metrics_path}. Skipping file difference report."
+        return
+      end
+
+      metrics = Metrics.load(metrics_path)
+      reference_metrics = Metrics.load(reference_metrics_path)
+
+      tables = reference_metrics.grouped_metrics.map do |group_key, grouped_reference_metrics|
+        grouped_metrics = metrics.grouped_metrics[group_key]
+
+        table_headers = %w(name reference new diff)
+        table_rows = grouped_reference_metrics.keys.map do |key|
+          new_value = grouped_metrics.send(key.to_sym)
+          reference_value = grouped_reference_metrics.send(key.to_sym)
+          diff_value = (new_value - reference_value).then do |v|
+            next "+#{v}" if v.positive?
+
+            next v.to_s if v.negative?
+
+            ""
+          end
+
+          [key, reference_value, new_value, diff_value]
+        end
+
+        [
+          "#### #{group_key}",
+          build_markdown_table(table_headers, table_rows)
+        ].join("\n\n")
       end
+
+      markdown(
+        folding(
+          "### #{title}",
+          tables.join("\n\n"),
+          open
+        )
+      )
     end
 
-    def report_file_difference(title, metrics_path, base_metrics_path)
+    def report_file_difference(title, metrics_path, reference_metrics_path, open)
+      open ||= :close
+      return if open == :disabled
+
       unless File.exist?(metrics_path)
         warn "DangerComposeCompilerMetrics: new file not found at #{metrics_path}. Skipping file difference report."
         return
       end
 
-      unless File.exist?(base_metrics_path)
-        warn "DangerComposeCompilerMetrics: reference file not found at #{base_metrics_path}. Skipping file difference report."
+      unless File.exist?(reference_metrics_path)
+        warn "DangerComposeCompilerMetrics: reference file not found at #{reference_metrics_path}. Skipping file difference report."
         return
       end
 
-      report = `diff -u #{base_metrics_path} #{metrics_path}`
+      report = `diff -u #{reference_metrics_path} #{metrics_path}`
 
       markdown(
         folding(
@@ -65,65 +121,64 @@ module Danger
             #{report}
             ```
             MARKDOWN
-          end
+          end,
+          open
         )
       )
     end
 
-    def report(metrics_dir)
-      markdown('# Compose Compiler Metrics Report')
+    def report(metrics_dir, options = {})
+      markdown("# Compose Compiler Metrics Report")
       build_variants(metrics_dir).each do |module_name, build_variant|
         markdown("## #{module_name} - #{build_variant}")
 
         # Metrics Report
         metrics_path = File.join(metrics_dir, metrics_filename(module_name, build_variant))
-        table_headers = %w[name value]
+        table_headers = %w(name value)
         table_rows = JSON.load_file(metrics_path).to_a
-
-        markdown(
-          folding(
-            '### Metrics',
-            build_markdown_table(table_headers, table_rows)
-          )
-        )
+        report_table("Metrics", table_headers, table_rows, options[:metrics])
 
         # Composable Stats Report
         composable_stats_report_path = File.join(metrics_dir, composable_stats_report_path(module_name, build_variant))
         csv = CSV.read(composable_stats_report_path, headers: true)
-
-        markdown(
-          folding(
-            '### Composable Stats Report',
-            build_markdown_table(csv.headers, csv.map(&:fields))
-          )
-        )
+        report_table("Composable Stats Report", csv.headers, csv.map(&:fields), options[:composable_stats])
 
         # Composable Report
         composable_report_path = File.join(metrics_dir, composable_report_path(module_name, build_variant))
-        markdown(
-          folding(
-            '### Composable Report',
-            <<~MARKDOWN
-            ```kotlin
-            #{File.read(composable_report_path)}
-            ```
-            MARKDOWN
-          )
-        )
+        report_code_block("Composable Report", "kotlin", File.read(composable_report_path), options[:composable_report])
 
         # Class Report
         class_report_path = File.join(metrics_dir, class_report_path(module_name, build_variant))
-        markdown(
-          folding(
-            '### Class Report',
-            <<~MARKDOWN
-            ```kotlin
-            #{File.read(class_report_path)}
-            ```
-            MARKDOWN
-          )
-        )
+        report_code_block("Class Report", "kotlin", File.read(class_report_path), options[:class_report])
       end
     end
+
+    def report_table(title, headers, rows, open)
+      return if open == :disabled
+
+      markdown(
+        folding(
+          "### #{title}",
+          build_markdown_table(headers, rows),
+          open
+        )
+      )
+    end
+
+    def report_code_block(title, language, code, open)
+      return if open == :disabled
+
+      markdown(
+        folding(
+          "### #{title}",
+          <<~MARKDOWN,
+          ```#{language}
+          #{code}
+          ```
+          MARKDOWN
+          open
+        )
+      )
+    end
   end
 end