danger-compose_compiler_metrics 0.0.2 → 0.0.3

data/spec/compose_compiler_metrics_spec.rb

@@ -2,45 +2,413 @@
 
 require File.expand_path("spec_helper", __dir__)
 
-module Danger
-  describe Danger::DangerComposeCompilerMetrics do
-    it "should be a plugin" do
-      expect(Danger::DangerComposeCompilerMetrics.new(nil)).to be_a Danger::Plugin
+describe Danger::DangerComposeCompilerMetrics do
+  let(:dangerfile) { testing_dangerfile }
+  let(:plugin) { dangerfile.compose_compiler_metrics }
+
+  describe "#new" do
+    subject { plugin }
+
+    it { is_expected.to be_a Danger::Plugin }
+  end
+
+  describe "#report_difference" do
+    subject { plugin.report_difference(metrics_path, reference_metrics_path) }
+
+    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" }
+
+    before do
+      [
+        metrics_path,
+        reference_metrics_path
+      ].each do |dir|
+        Dir.glob("#{dir}/*").each do |file|
+          FileUtils.touch(file, mtime: file_timestamp)
+        end
+      end
     end
 
-    #
-    # You should test your custom attributes and methods here
-    #
-    describe "with Dangerfile" do
-      before do
-        @dangerfile = testing_dangerfile
-        @my_plugin = @dangerfile.compose_compiler_metrics
+    let(:expect_report_list) do
+      [
+        "# Compose Compiler Metrics Difference Report",
+        "## app - debug",
+        <<~MARKDOWN,
+        <details>
+        <summary>
+
+        ### Metrics Summary
+
+        </summary>
+
+        #### Composables
+
+        | name | reference | new | diff |
+        | --- | --- | --- | --- |
+        | skippableComposables | 5 | 6 | +1 |
+        | unskippableComposables | 3 | 1 | -2 |
+        | restartableComposables | 8 | 7 | -1 |
+        | unrestartableComposables | 0 | 0 |  |
+        | readonlyComposables | 0 | 0 |  |
+        | totalComposables | 8 | 7 | -1 |
+
+        #### Groups
+
+        | name | reference | new | diff |
+        | --- | --- | --- | --- |
+        | restartGroups | 8 | 7 | -1 |
+        | totalGroups | 11 | 7 | -4 |
+
+        #### Arguments
+
+        | name | reference | new | diff |
+        | --- | --- | --- | --- |
+        | staticArguments | 5 | 4 | -1 |
+        | certainArguments | 5 | 4 | -1 |
+        | knownStableArguments | 50 | 47 | -3 |
+        | knownUnstableArguments | 2 | 0 | -2 |
+        | unknownStableArguments | 0 | 0 |  |
+        | totalArguments | 52 | 47 | -5 |
+
+        #### Classes
+
+        | name | reference | new | diff |
+        | --- | --- | --- | --- |
+        | markedStableClasses | 0 | 0 |  |
+        | inferredStableClasses | 1 | 2 | +1 |
+        | inferredUnstableClasses | 1 | 0 | -1 |
+        | inferredUncertainClasses | 0 | 0 |  |
+        | effectivelyStableClasses | 1 | 2 | +1 |
+        | totalClasses | 2 | 2 |  |
+
+        #### Lambdas
+
+        | name | reference | new | diff |
+        | --- | --- | --- | --- |
+        | memoizedLambdas | 4 | 4 |  |
+        | singletonLambdas | 0 | 0 |  |
+        | singletonComposableLambdas | 3 | 3 |  |
+        | composableLambdas | 3 | 3 |  |
+        | totalLambdas | 5 | 4 | -1 |
+
+        </details>
+        MARKDOWN
+        <<~MARKDOWN,
+        <details>
+        <summary>
+
+        ### Metrics
+
+        </summary>
+
+        ```diff
+        --- #{File.dirname(__FILE__)}/support/fixtures/compose_compiler_metrics_baseline/app_debug-module.json	#{file_timestamp.strftime('%F %T.%N %z')}
+        +++ #{File.dirname(__FILE__)}/support/fixtures/compose_compiler_metrics/app_debug-module.json	#{file_timestamp.strftime('%F %T.%N %z')}
+        @@ -1,25 +1,25 @@
+         {
+        - "skippableComposables": 5,
+        - "restartableComposables": 8,
+        + "skippableComposables": 6,
+        + "restartableComposables": 7,
+          "readonlyComposables": 0,
+        - "totalComposables": 8,
+        - "restartGroups": 8,
+        - "totalGroups": 11,
+        - "staticArguments": 5,
+        - "certainArguments": 5,
+        - "knownStableArguments": 50,
+        - "knownUnstableArguments": 2,
+        + "totalComposables": 7,
+        + "restartGroups": 7,
+        + "totalGroups": 7,
+        + "staticArguments": 4,
+        + "certainArguments": 4,
+        + "knownStableArguments": 47,
+        + "knownUnstableArguments": 0,
+          "unknownStableArguments": 0,
+        - "totalArguments": 52,
+        + "totalArguments": 47,
+          "markedStableClasses": 0,
+        - "inferredStableClasses": 1,
+        - "inferredUnstableClasses": 1,
+        + "inferredStableClasses": 2,
+        + "inferredUnstableClasses": 0,
+          "inferredUncertainClasses": 0,
+        - "effectivelyStableClasses": 1,
+        + "effectivelyStableClasses": 2,
+          "totalClasses": 2,
+          "memoizedLambdas": 4,
+          "singletonLambdas": 0,
+          "singletonComposableLambdas": 3,
+          "composableLambdas": 3,
+        - "totalLambdas": 5
+        + "totalLambdas": 4
+         }
+        \
+
+        ```
+
+
+        </details>
+        MARKDOWN
+        <<~MARKDOWN,
+        <details>
+        <summary>
+
+        ### Composable Stats Report
+
+        </summary>
+
+        ```diff
+        --- #{File.dirname(__FILE__)}/support/fixtures/compose_compiler_metrics_baseline/app_debug-composables.csv	#{file_timestamp.strftime('%F %T.%N %z')}
+        +++ #{File.dirname(__FILE__)}/support/fixtures/compose_compiler_metrics/app_debug-composables.csv	#{file_timestamp.strftime('%F %T.%N %z')}
+        @@ -1,5 +1,4 @@
+         package,name,composable,skippable,restartable,readonly,inline,isLambda,hasDefaults,defaultsGroup,groups,calls,
+        -com.example.android.ContactRow,ContactRow,1,0,1,0,0,0,0,0,1,2,
+        +com.example.android.ContactRow,ContactRow,1,1,1,0,0,0,0,0,1,2,
+         com.example.android.ToggleButton,ToggleButton,1,1,1,0,0,0,0,0,1,1,
+        -com.example.android.ContactDetails,ContactDetails,1,0,1,0,0,0,0,0,1,1,
+        -com.example.android.ui.theme.ExampleTheme,ExampleTheme,1,1,1,0,0,0,1,0,4,5,
+        +com.example.android.ContactDetails,ContactDetails,1,1,1,0,0,0,0,0,1,1,
+
+        ```
+
+
+        </details>
+        MARKDOWN
+        <<~MARKDOWN,
+        <details>
+        <summary>
+
+        ### Composable Report
+
+        </summary>
+
+        ```diff
+        --- #{File.dirname(__FILE__)}/support/fixtures/compose_compiler_metrics_baseline/app_debug-composables.txt	#{file_timestamp.strftime('%F %T.%N %z')}
+        +++ #{File.dirname(__FILE__)}/support/fixtures/compose_compiler_metrics/app_debug-composables.txt	#{file_timestamp.strftime('%F %T.%N %z')}
+        @@ -1,16 +1,11 @@
+        -restartable scheme("[androidx.compose.ui.UiComposable]") fun ContactRow(
+        -  unstable contact: Contact
+        +restartable skippable scheme("[androidx.compose.ui.UiComposable]") fun ContactRow(
+        +  stable contact: Contact
+           stable modifier: Modifier? = @static Companion
+         )
+         restartable skippable scheme("[androidx.compose.ui.UiComposable]") fun ToggleButton(
+           stable selected: Boolean
+           stable onToggled: Function1<Boolean, Unit>
+         )
+        -restartable scheme("[androidx.compose.ui.UiComposable]") fun ContactDetails(
+        -  unstable contact: Contact
+        -)
+        -restartable skippable scheme("[0, [0]]") fun ExampleTheme(
+        -  stable darkTheme: Boolean = @dynamic isSystemInDarkTheme($composer, 0)
+        -  stable dynamicColor: Boolean = @static true
+        -  stable content: Function2<Composer, Int, Unit>
+        +restartable skippable scheme("[androidx.compose.ui.UiComposable]") fun ContactDetails(
+        +  stable contact: Contact
+         )
+
+        ```
+
 
-        # mock the PR data
-        # you can then use this, eg. github.pr_author, later in the spec
-        json = File.read("#{File.dirname(__FILE__)}/support/fixtures/github_pr.json") # example json: `curl https://api.github.com/repos/danger/danger-plugin-template/pulls/18 > github_pr.json`
-        allow(@my_plugin.github).to receive(:pr_json).and_return(json)
+        </details>
+        MARKDOWN
+        <<~MARKDOWN
+        <details>
+        <summary>
+
+        ### Class Report
+
+        </summary>
+
+        ```diff
+        --- #{File.dirname(__FILE__)}/support/fixtures/compose_compiler_metrics_baseline/app_debug-classes.txt	#{file_timestamp.strftime('%F %T.%N %z')}
+        +++ #{File.dirname(__FILE__)}/support/fixtures/compose_compiler_metrics/app_debug-classes.txt	#{file_timestamp.strftime('%F %T.%N %z')}
+        @@ -1,8 +1,8 @@
+         stable class MainActivity {
+           <runtime stability> = Stable
+         }
+        -unstable class Contact {
+        -  stable var name: String
+        +stable class Contact {
+        +  stable val name: String
+           stable val number: String
+        -  <runtime stability> = Unstable
+        +  <runtime stability> = Stable
+         }
+
+        ```
+
+
+        </details>
+        MARKDOWN
+      ]
+    end
+
+    it "output markdown summary" do
+      subject
+
+      dangerfile.status_report[:markdowns].map(&:message).each_with_index do |message, index|
+        expect(message).to eq(expect_report_list[index])
       end
+    end
 
-      # Some examples for writing tests
-      # You should replace these with your own.
+    context "when missing diff command" do
+      before do
+        allow_any_instance_of(Helper).to receive(:installed?).with("diff").and_return(false)
+      end
 
-      xit "Warns on a monday" do
-        monday_date = Date.parse("2016-07-11")
-        allow(Date).to receive(:today).and_return monday_date
+      it do
+        within_block_is_expected.to change {
+          dangerfile.status_report[:errors]
+        }.from(
+          be_empty
+        ).to(
+          ["diff command not found. Please install diff command."]
+        )
+      end
+    end
 
-        @my_plugin.warn_on_mondays
+    context "when missing reference metrics file" do
+      let(:reference_metrics_path) { "#{File.dirname(__FILE__)}/support/fixtures/compose_compiler_metrics_missing" }
 
-        expect(@dangerfile.status_report[:warnings]).to eq(["Trying to merge code on a Monday"])
+      it do
+        within_block_is_expected.to change {
+          dangerfile.status_report[:warnings]
+        }.from(
+          be_empty
+        ).to(
+          [
+            "DangerComposeCompilerMetrics: reference file not found at #{File.dirname(__FILE__)}/support/fixtures/compose_compiler_metrics_missing/app_debug-module.json. Skipping file difference report.",
+            "DangerComposeCompilerMetrics: reference file not found at #{File.dirname(__FILE__)}/support/fixtures/compose_compiler_metrics_missing/app_debug-module.json. Skipping file difference report.",
+            "DangerComposeCompilerMetrics: reference file not found at #{File.dirname(__FILE__)}/support/fixtures/compose_compiler_metrics_missing/app_debug-composables.csv. Skipping file difference report.",
+            "DangerComposeCompilerMetrics: reference file not found at #{File.dirname(__FILE__)}/support/fixtures/compose_compiler_metrics_missing/app_debug-composables.txt. Skipping file difference report.",
+            "DangerComposeCompilerMetrics: reference file not found at #{File.dirname(__FILE__)}/support/fixtures/compose_compiler_metrics_missing/app_debug-classes.txt. Skipping file difference report."
+          ]
+        )
       end
+    end
+  end
+
+  describe "#report" do
+    subject { plugin.report(metrics_path) }
+
+    let(:metrics_path) { "#{File.dirname(__FILE__)}/support/fixtures/compose_compiler_metrics" }
+    let(:expect_report_list) do
+      [
+        "# Compose Compiler Metrics Report",
+        "## app - debug",
+        <<~MARKDOWN,
+        <details>
+        <summary>
+
+        ### Metrics
 
-      xit "Does nothing on a tuesday" do
-        monday_date = Date.parse("2016-07-12")
-        allow(Date).to receive(:today).and_return monday_date
+        </summary>
+
+        | name | value |
+        | --- | --- |
+        | skippableComposables | 6 |
+        | restartableComposables | 7 |
+        | readonlyComposables | 0 |
+        | totalComposables | 7 |
+        | restartGroups | 7 |
+        | totalGroups | 7 |
+        | staticArguments | 4 |
+        | certainArguments | 4 |
+        | knownStableArguments | 47 |
+        | knownUnstableArguments | 0 |
+        | unknownStableArguments | 0 |
+        | totalArguments | 47 |
+        | markedStableClasses | 0 |
+        | inferredStableClasses | 2 |
+        | inferredUnstableClasses | 0 |
+        | inferredUncertainClasses | 0 |
+        | effectivelyStableClasses | 2 |
+        | totalClasses | 2 |
+        | memoizedLambdas | 4 |
+        | singletonLambdas | 0 |
+        | singletonComposableLambdas | 3 |
+        | composableLambdas | 3 |
+        | totalLambdas | 4 |
+
+        </details>
+        MARKDOWN
+        <<~MARKDOWN,
+        <details>
+        <summary>
+
+        ### Composable Stats Report
+
+        </summary>
+
+        | package | name | composable | skippable | restartable | readonly | inline | isLambda | hasDefaults | defaultsGroup | groups | calls |  |
+        | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
+        | com.example.android.ContactRow | ContactRow | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 1 | 2 |  |
+        | com.example.android.ToggleButton | ToggleButton | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 1 | 1 |  |
+        | com.example.android.ContactDetails | ContactDetails | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 1 | 1 |  |
+
+        </details>
+        MARKDOWN
+        <<~MARKDOWN,
+        <details>
+        <summary>
+
+        ### Composable Report
+
+        </summary>
+
+        ```kotlin
+        restartable skippable scheme("[androidx.compose.ui.UiComposable]") fun ContactRow(
+          stable contact: Contact
+          stable modifier: Modifier? = @static Companion
+        )
+        restartable skippable scheme("[androidx.compose.ui.UiComposable]") fun ToggleButton(
+          stable selected: Boolean
+          stable onToggled: Function1<Boolean, Unit>
+        )
+        restartable skippable scheme("[androidx.compose.ui.UiComposable]") fun ContactDetails(
+          stable contact: Contact
+        )
+
+        ```
+
+
+        </details>
+        MARKDOWN
+        <<~MARKDOWN
+        <details>
+        <summary>
+
+        ### Class Report
+
+        </summary>
+
+        ```kotlin
+        stable class MainActivity {
+          <runtime stability> = Stable
+        }
+        stable class Contact {
+          stable val name: String
+          stable val number: String
+          <runtime stability> = Stable
+        }
+
+        ```
+
+
+        </details>
+        MARKDOWN
+      ]
+    end
 
-        @my_plugin.warn_on_mondays
+    it "output markdown summary" do
+      subject
 
-        expect(@dangerfile.status_report[:warnings]).to eq([])
+      dangerfile.status_report[:markdowns].map(&:message).each_with_index do |message, index|
+        expect(message).to eq(expect_report_list[index])
       end
     end
   end

data/spec/metrics_spec.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+require "./lib/compose_compiler_metrics/metrics"
+require "tempfile"
+
+describe Metrics do
+  let(:metrics) { described_class.new(hash) }
+
+  let(:hash) do
+    {
+      "skippableComposables" => 5,
+      "unskippableComposables" => 3,
+      "restartableComposables" => 8,
+      "unrestartableComposables" => 0,
+      "readonlyComposables" => 0,
+      "totalComposables" => 8,
+      "restartGroups" => 8,
+      "totalGroups" => 11,
+      "staticArguments" => 5,
+      "certainArguments" => 5,
+      "knownStableArguments" => 50,
+      "knownUnstableArguments" => 2,
+      "unknownStableArguments" => 0,
+      "totalArguments" => 52,
+      "markedStableClasses" => 0,
+      "inferredStableClasses" => 1,
+      "inferredUnstableClasses" => 1,
+      "inferredUncertainClasses" => 0,
+      "effectivelyStableClasses" => 1,
+      "totalClasses" => 2,
+      "memoizedLambdas" => 4,
+      "singletonLambdas" => 0,
+      "singletonComposableLambdas" => 3,
+      "composableLambdas" => 3,
+      "totalLambdas" => 5
+    }
+  end
+
+  describe "#keys" do
+    subject { metrics.keys }
+
+    it do
+      is_expected.to eq %w(
+        skippableComposables
+        unskippableComposables
+        restartableComposables
+        unrestartableComposables
+        readonlyComposables
+        totalComposables
+        restartGroups
+        totalGroups
+        staticArguments
+        certainArguments
+        knownStableArguments
+        knownUnstableArguments
+        unknownStableArguments
+        totalArguments
+        markedStableClasses
+        inferredStableClasses
+        inferredUnstableClasses
+        inferredUncertainClasses
+        effectivelyStableClasses
+        totalClasses
+        memoizedLambdas
+        singletonLambdas
+        singletonComposableLambdas
+        composableLambdas
+        totalLambdas
+      )
+    end
+  end
+
+  describe "#grouping_keys" do
+    subject { metrics.grouping_keys }
+
+    it { is_expected.to eq %w(Composables Groups Arguments Classes Lambdas) }
+  end
+
+  describe "#grouped_metrics" do
+    subject { metrics.grouped_metrics }
+
+    it do
+      is_expected.to eq(
+        "Composables" => described_class.new(
+          "skippableComposables" => 5,
+          "unskippableComposables" => 3,
+          "restartableComposables" => 8,
+          "unrestartableComposables" => 0,
+          "readonlyComposables" => 0,
+          "totalComposables" => 8
+        ),
+        "Groups" => described_class.new(
+          "restartGroups" => 8,
+          "totalGroups" => 11
+        ),
+        "Arguments" => described_class.new(
+          "staticArguments" => 5,
+          "certainArguments" => 5,
+          "knownStableArguments" => 50,
+          "knownUnstableArguments" => 2,
+          "unknownStableArguments" => 0,
+          "totalArguments" => 52
+        ),
+        "Classes" => described_class.new(
+          "markedStableClasses" => 0,
+          "inferredStableClasses" => 1,
+          "inferredUnstableClasses" => 1,
+          "inferredUncertainClasses" => 0,
+          "effectivelyStableClasses" => 1,
+          "totalClasses" => 2
+        ),
+        "Lambdas" => described_class.new(
+          "memoizedLambdas" => 4,
+          "singletonLambdas" => 0,
+          "singletonComposableLambdas" => 3,
+          "composableLambdas" => 3,
+          "totalLambdas" => 5
+        )
+      )
+    end
+  end
+
+  describe "#skippable_composables" do
+    subject { metrics.skippable_composables }
+
+    it { is_expected.to eq 5 }
+  end
+
+  describe "#unskippable_composables" do
+    subject { metrics.unskippable_composables }
+
+    it { is_expected.to eq 3 }
+  end
+
+  describe "#total_composables" do
+    subject { metrics.total_composables }
+
+    it { is_expected.to eq 8 }
+  end
+
+  describe "#to_h" do
+    subject { metrics.to_h }
+
+    it { is_expected.to eq metrics.hash }
+  end
+end
+
+describe Metrics::Loader do
+  let(:loader) { described_class.new(json_file.path) }
+
+  let(:json_file) do
+    Tempfile.create(["compose_compiler_metrics_", ".json"]).tap do |file|
+      file.write(json)
+      file.flush
+    end
+  end
+
+  let(:json) do
+    {
+      "skippableComposables" => 5,
+      "restartableComposables" => 8,
+      "readonlyComposables" => 0,
+      "totalComposables" => 8,
+      "restartGroups" => 8,
+      "totalGroups" => 11,
+      "staticArguments" => 5,
+      "certainArguments" => 5,
+      "knownStableArguments" => 50,
+      "knownUnstableArguments" => 2,
+      "unknownStableArguments" => 0,
+      "totalArguments" => 52,
+      "markedStableClasses" => 0,
+      "inferredStableClasses" => 1,
+      "inferredUnstableClasses" => 1,
+      "inferredUncertainClasses" => 0,
+      "effectivelyStableClasses" => 1,
+      "totalClasses" => 2,
+      "memoizedLambdas" => 4,
+      "singletonLambdas" => 0,
+      "singletonComposableLambdas" => 3,
+      "composableLambdas" => 3,
+      "totalLambdas" => 5
+    }.to_json
+  end
+
+  describe "#load" do
+    subject { loader.load }
+
+    it do
+      is_expected.to have_attributes(
+        skippable_composables: 5,
+        restartable_composables: 8,
+        readonly_composables: 0,
+        total_composables: 8,
+        restart_groups: 8,
+        total_groups: 11,
+        static_arguments: 5,
+        certain_arguments: 5,
+        known_stable_arguments: 50,
+        known_unstable_arguments: 2,
+        unknown_stable_arguments: 0,
+        total_arguments: 52,
+        marked_stable_classes: 0,
+        inferred_stable_classes: 1,
+        inferred_unstable_classes: 1,
+        inferred_uncertain_classes: 0,
+        effectively_stable_classes: 1,
+        total_classes: 2,
+        memoized_lambdas: 4,
+        singleton_lambdas: 0,
+        singleton_composable_lambdas: 3,
+        composable_lambdas: 3,
+        total_lambdas: 5
+      )
+    end
+
+    it { is_expected.to have_attributes(unskippableComposables: 3) }
+    it { is_expected.to have_attributes(unrestartableComposables: 0) }
+  end
+end

data/spec/spec_helper.rb

@@ -17,11 +17,18 @@ if `git remote -v` == ""
   exit(0)
 end
 
+module WithinBlockIsExpected
+  def within_block_is_expected
+    expect { subject }
+  end
+end
+
 # Use coloured output, it's the best.
 RSpec.configure do |config|
   config.filter_gems_from_backtrace "bundler"
   config.color = true
   config.tty = true
+  config.include WithinBlockIsExpected
 end
 
 require "danger_plugin"

data/spec/support/fixtures/compose_compiler_metrics/app_debug-classes.txt

@@ -0,0 +1,8 @@
+stable class MainActivity {
+  <runtime stability> = Stable
+}
+stable class Contact {
+  stable val name: String
+  stable val number: String
+  <runtime stability> = Stable
+}

data/spec/support/fixtures/compose_compiler_metrics/app_debug-composables.csv

@@ -0,0 +1,4 @@
+package,name,composable,skippable,restartable,readonly,inline,isLambda,hasDefaults,defaultsGroup,groups,calls,
+com.example.android.ContactRow,ContactRow,1,1,1,0,0,0,0,0,1,2,
+com.example.android.ToggleButton,ToggleButton,1,1,1,0,0,0,0,0,1,1,
+com.example.android.ContactDetails,ContactDetails,1,1,1,0,0,0,0,0,1,1,