danger-compose_compiler_metrics 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cc60271478af15e0a283d10f7d2b5e1cd1ecc5d899496b6ee3e0ed9b1f58da5
-  data.tar.gz: dc17d7971fae2598ef76c779cd120f3a87bcb943fbd2e9645717c20654885bdd
+  metadata.gz: 8b9f0973e51bb4416bad39bb523c7d0b9e81828aa750c435fbdfe2b471857a48
+  data.tar.gz: cffa918441edcfa7bbd58e0d994a508c32abb22679194af550836e5edd5cb294
 SHA512:
-  metadata.gz: 9c5bc88d19bf7f84dc09a03f14d8ebc1f211afc6036646f9a6f1a5b469260036fce31d5c4e306d0f2033399d07bd38a5c81804dbfd89b071a3ee47d2a071fe6e
-  data.tar.gz: '085f7761b5f940d85af421a44877a0cd5db43b263412b17f822019189b86bd6ea044c080ed7048f8e0c599da8e9e1ed3985b0bd628d32f122e266854adb9d61f'
+  metadata.gz: c171857c7292b8b335c143721da0bc3cf8b38dd28de677b33bf210d49346908ebde5ae5e073151c7c47f1016d5d79f34c799aa1a077ee476312033a2d2b08862
+  data.tar.gz: 2b4451fb0c7150296ab5c71ead7711584816412349afc8195631016121a2c2cab87bc6eb423b3ee8f681a19d3064492420f13a91578888cff648059ae4ff6ddc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-compose_compiler_metrics (0.0.3)
+    danger-compose_compiler_metrics (0.0.4)
       csv
       danger-plugin-api (~> 1.0)
       json

data/lib/compose_compiler_metrics/gem_version.rb

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

data/lib/compose_compiler_metrics/helper.rb

@@ -33,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/plugin.rb

@@ -10,7 +10,7 @@ module Danger
   class DangerComposeCompilerMetrics < Plugin
     include Helper
 
-    def report_difference(metrics_dir, reference_metrics_dir)
+    def report_difference(metrics_dir, reference_metrics_dir, options = {})
       unless installed?("diff")
         failure "diff command not found. Please install diff command."
         return
@@ -24,27 +24,30 @@ module Danger
         metrics_path = File.join(metrics_dir, metrics_filename(module_name, build_variant))
         reference_metrics_path = File.join(reference_metrics_dir, metrics_filename(module_name, build_variant))
 
-        report_metrics_report("Metrics Summary", metrics_path, reference_metrics_path)
-        report_file_difference("Metrics", metrics_path, reference_metrics_path)
+        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))
         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)
+        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))
         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)
+        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))
         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)
+        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)
+    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
@@ -85,12 +88,16 @@ module Danger
       markdown(
         folding(
           "### #{title}",
-          tables.join("\n\n")
+          tables.join("\n\n"),
+          open
         )
       )
     end
 
-    def report_file_difference(title, metrics_path, reference_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
@@ -114,12 +121,13 @@ module Danger
             #{report}
             ```
             MARKDOWN
-          end
+          end,
+          open
         )
       )
     end
 
-    def report(metrics_dir)
+    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}")
@@ -128,51 +136,49 @@ module Danger
         metrics_path = File.join(metrics_dir, metrics_filename(module_name, build_variant))
         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

data/spec/compose_compiler_metrics_spec.rb

@@ -13,11 +13,12 @@ describe Danger::DangerComposeCompilerMetrics do
   end
 
   describe "#report_difference" do
-    subject { plugin.report_difference(metrics_path, reference_metrics_path) }
+    subject { plugin.report_difference(metrics_path, reference_metrics_path, options) }
 
     let(:file_timestamp) { Time.new(2024, 1, 1, 0, 0, 0) }
     let(:metrics_path) { "#{File.dirname(__FILE__)}/support/fixtures/compose_compiler_metrics" }
     let(:reference_metrics_path) { "#{File.dirname(__FILE__)}/support/fixtures/compose_compiler_metrics_baseline" }
+    let(:options) { {} }
 
     before do
       [
@@ -35,7 +36,7 @@ describe Danger::DangerComposeCompilerMetrics do
         "# Compose Compiler Metrics Difference Report",
         "## app - debug",
         <<~MARKDOWN,
-        <details>
+        <details >
         <summary>
 
         ### Metrics Summary
@@ -95,7 +96,7 @@ describe Danger::DangerComposeCompilerMetrics do
         </details>
         MARKDOWN
         <<~MARKDOWN,
-        <details>
+        <details >
         <summary>
 
         ### Metrics
@@ -153,7 +154,7 @@ describe Danger::DangerComposeCompilerMetrics do
         </details>
         MARKDOWN
         <<~MARKDOWN,
-        <details>
+        <details >
         <summary>
 
         ### Composable Stats Report
@@ -178,7 +179,7 @@ describe Danger::DangerComposeCompilerMetrics do
         </details>
         MARKDOWN
         <<~MARKDOWN,
-        <details>
+        <details >
         <summary>
 
         ### Composable Report
@@ -216,7 +217,7 @@ describe Danger::DangerComposeCompilerMetrics do
         </details>
         MARKDOWN
         <<~MARKDOWN
-        <details>
+        <details >
         <summary>
 
         ### Class Report
@@ -290,18 +291,45 @@ describe Danger::DangerComposeCompilerMetrics do
         )
       end
     end
+
+    context "when metrics option is disabled" do
+      let(:options) { { metrics: :disabled } }
+
+      it do
+        within_block_is_expected.to change {
+          dangerfile.status_report[:markdowns].map(&:message)
+        }.from(
+          be_empty
+        ).to(
+          expect_report_list.reject.with_index { |_, i| i == 3 }
+        )
+      end
+    end
+
+    context "when metrics option is open" do
+      let(:options) { { metrics: :open } }
+
+      it do
+        subject
+
+        expect(dangerfile.status_report[:markdowns][3].message).to eq(
+          expect_report_list[3].gsub("<details >", "<details open>")
+        )
+      end
+    end
   end
 
   describe "#report" do
-    subject { plugin.report(metrics_path) }
+    subject { plugin.report(metrics_path, options) }
 
     let(:metrics_path) { "#{File.dirname(__FILE__)}/support/fixtures/compose_compiler_metrics" }
+    let(:options) { {} }
     let(:expect_report_list) do
       [
         "# Compose Compiler Metrics Report",
         "## app - debug",
         <<~MARKDOWN,
-        <details>
+        <details >
         <summary>
 
         ### Metrics
@@ -337,7 +365,7 @@ describe Danger::DangerComposeCompilerMetrics do
         </details>
         MARKDOWN
         <<~MARKDOWN,
-        <details>
+        <details >
         <summary>
 
         ### Composable Stats Report
@@ -353,7 +381,7 @@ describe Danger::DangerComposeCompilerMetrics do
         </details>
         MARKDOWN
         <<~MARKDOWN,
-        <details>
+        <details >
         <summary>
 
         ### Composable Report
@@ -379,7 +407,7 @@ describe Danger::DangerComposeCompilerMetrics do
         </details>
         MARKDOWN
         <<~MARKDOWN
-        <details>
+        <details >
         <summary>
 
         ### Class Report
@@ -404,11 +432,39 @@ describe Danger::DangerComposeCompilerMetrics do
       ]
     end
 
-    it "output markdown summary" do
-      subject
+    it do
+      within_block_is_expected.to change {
+        dangerfile.status_report[:markdowns].map(&:message)
+      }.from(
+        be_empty
+      ).to(
+        expect_report_list
+      )
+    end
 
-      dangerfile.status_report[:markdowns].map(&:message).each_with_index do |message, index|
-        expect(message).to eq(expect_report_list[index])
+    context "when metrics option is disabled" do
+      let(:options) { { metrics: :disabled } }
+
+      it do
+        within_block_is_expected.to change {
+          dangerfile.status_report[:markdowns].map(&:message)
+        }.from(
+          be_empty
+        ).to(
+          expect_report_list.reject.with_index { |_, i| i == 2 }
+        )
+      end
+    end
+
+    context "when metrics option is open" do
+      let(:options) { { metrics: :open } }
+
+      it do
+        subject
+
+        expect(dangerfile.status_report[:markdowns][2].message).to eq(
+          expect_report_list[2].gsub("<details >", "<details open>")
+        )
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-compose_compiler_metrics
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Tomoki Yamashita
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-23 00:00:00.000000000 Z
+date: 2024-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: csv