#774

Committed 28 May 2024 08:33PM CUT coverage: 22.137%. Remained the same

Build # #774

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #337 from mybatis/renovate/org.apache.maven.reporting-maven-reporting-impl-4.x

Update dependency org.apache.maven.reporting:maven-reporting-impl to v4.0.0-M15

Run Details

28 of 226 branches covered (12.39%)

116 of 524 relevant lines covered (22.14%)

0.22 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/main/java/org/mybatis/maven/mvnmigrate/report/MigrationStatusReportView.java

/*
 *    Copyright 2010-2022 the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       https://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.mybatis.maven.mvnmigrate.report;

import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.ResourceBundle;

import org.apache.ibatis.migration.Change;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.project.MavenProject;

/**
 * View of status report.
 */
public final class MigrationStatusReportView {

  /**
   * Generates the report.
   *
   * @param changes
   *          list of {@link Change}
   * @param sink
   *          the {@link Sink} instance
   * @param bundle
   *          the {@link ResourceBundle} instance
   */
  public void generateReport(Map<MavenProject, List<Change>> changes, Sink sink, ResourceBundle bundle,
      boolean isAggregate) {

    sink.head();
    sink.title();
    sink.text(bundle.getString("migration.status.report.header"));
    sink.title_();
    sink.head_();
    sink.body();

    // Generate title
    sink.section1();
    sink.sectionTitle1();
    sink.text(bundle.getString("migration.status.report.mainTitle"));
    sink.sectionTitle1_();
    sink.section1_();
    sink.lineBreak();

    sink.section2();
    sink.sectionTitle2();
    sink.text(bundle.getString("migration.status.report.secondSectionTitle"));
    sink.sectionTitle2_();

    for (Entry<MavenProject, List<Change>> entries : changes.entrySet()) {
      if (isAggregate) {
        sink.section3();
        sink.sectionTitle3();
        sink.text(bundle.getString("migration.status.report.moduleTitle") + entries.getKey().getName());
        sink.sectionTitle3_();
      }
      generateStatisticsTable(sink, entries.getValue());
    }

    sink.section2_();
    sink.lineBreak();

    sink.section3();
    sink.sectionTitle2();
    sink.text(bundle.getString("migration.status.report.thirdSectionTitle"));
    sink.sectionTitle2_();
    for (Entry<MavenProject, List<Change>> entries : changes.entrySet()) {
      if (isAggregate) {
        sink.section3();
        sink.sectionTitle3();
        sink.text(bundle.getString("migration.status.report.moduleTitle") + entries.getKey().getName());
        sink.sectionTitle3_();
      }
      // Generate Unused declared dependencies:
      generateChangesTable(sink, entries.getValue());
    }

    sink.section3_();

    // Closing the report
    sink.body_();
    sink.flush();
    sink.close();
  }

  /**
   * Generates statistic table.
   *
   * @param sink
   *          the sink
   * @param changes
   *          the changes
   */
  private void generateStatisticsTable(Sink sink, List<Change> changes) {
    sink.table();

    sink.tableRow();
    sink.tableCell();
    sink.text(" Number of migration changes: ");
    sink.tableCell_();

    sink.tableCell();
    sink.text("" + changes.size());
    sink.tableCell_();
    sink.tableRow_();

    sink.tableRow();
    sink.tableCell();
    sink.text(" Number of pending migrations: ");
    sink.tableCell_();

    int nop = numberOfPending(changes);

    sink.tableCell();
    sink.text(nop + "  (" + calcPerc(changes.size(), nop) + ")  ");
    sink.nonBreakingSpace();
    sink.figure();
    sink.figureGraphics(nop == 0 ? "images/icon_success_sml.gif" : "images/icon_warning_sml.gif");
    sink.figure_();
    sink.tableCell_();
    sink.tableRow_();

    sink.table_();
  }

  /**
   * Calculates the percentage.
   *
   * @param tot
   *          the tot
   * @param nop
   *          the nop
   *
   * @return the string
   */
  private String calcPerc(int tot, int nop) {
    return "" + ((100 * nop) / tot) + "%";
  }

  /**
   * Return the number of pending change found.
   *
   * @param changes
   *          list of {@link Change}
   *
   * @return Return the number of pending change found.
   */
  private int numberOfPending(List<Change> changes) {
    int numberOfPending = 0;
    for (Change change : changes) {
      if (change.getAppliedTimestamp() == null) {
        numberOfPending++;
      }
    }
    return numberOfPending;
  }

  /**
   * Generate a table for the given dependencies iterator.
   *
   * @param sink
   *          the {@link Sink} instance
   * @param iter
   *          list of {@link Change}
   */
  public void generateChangesTable(Sink sink, List<Change> iter) {
    sink.table();

    sink.tableRow();
    sink.tableCell();
    sink.bold();
    sink.text("ID");
    sink.bold_();
    sink.tableCell_();

    sink.tableCell();
    sink.bold();
    sink.text("Applied At");
    sink.bold_();
    sink.tableCell_();

    sink.tableCell();
    sink.bold();
    sink.text("Description");
    sink.bold_();
    sink.tableCell_();

    sink.tableCell();
    sink.bold();
    sink.text("Filename");
    sink.bold_();
    sink.tableCell_();

    sink.tableCell();
    sink.bold();
    sink.text("Status");
    sink.bold_();
    sink.tableCell_();

    sink.tableRow_();

    for (Change change : iter) {
      sink.tableRow();

      sink.tableCell();
      sink.text("" + change.getId());
      sink.tableCell_();

      sink.tableCell();
      sink.text(change.getAppliedTimestamp() == null ? " ... pending ... " : change.getAppliedTimestamp());
      sink.tableCell_();

      sink.tableCell();
      sink.text(change.getDescription());
      sink.tableCell_();

      sink.tableCell();
      sink.text(change.getFilename());
      sink.tableCell_();

      sink.tableCell();
      sink.figure();
      sink.figureGraphics(
          change.getAppliedTimestamp() != null ? "images/icon_success_sml.gif" : "images/icon_warning_sml.gif");
      sink.figure_();
      sink.tableCell_();

      sink.tableRow_();
    }

    sink.table_();
    sink.horizontalRule();
  }

}

1	/*
2	* Copyright 2010-2022 the original author or authors.
3	*
4	* Licensed under the Apache License, Version 2.0 (the "License");
5	* you may not use this file except in compliance with the License.
6	* You may obtain a copy of the License at
7	*
8	* https://www.apache.org/licenses/LICENSE-2.0
9	*
10	* Unless required by applicable law or agreed to in writing, software
11	* distributed under the License is distributed on an "AS IS" BASIS,
12	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13	* See the License for the specific language governing permissions and
14	* limitations under the License.
15	*/
16	package org.mybatis.maven.mvnmigrate.report;
17
18	import java.util.List;
19	import java.util.Map;
20	import java.util.Map.Entry;
21	import java.util.ResourceBundle;
22
23	import org.apache.ibatis.migration.Change;
24	import org.apache.maven.doxia.sink.Sink;
25	import org.apache.maven.project.MavenProject;
26
27	/**
28	* View of status report.
29	*/
30	public final class MigrationStatusReportView {	×
31
32	/**
33	* Generates the report.
34	*
35	* @param changes
36	* list of {@link Change}
37	* @param sink
38	* the {@link Sink} instance
39	* @param bundle
40	* the {@link ResourceBundle} instance
41	*/
42	public void generateReport(Map<MavenProject, List<Change>> changes, Sink sink, ResourceBundle bundle,
43	boolean isAggregate) {
44
45	sink.head();	×
46	sink.title();	×
47	sink.text(bundle.getString("migration.status.report.header"));	×
48	sink.title_();	×
49	sink.head_();	×
50	sink.body();	×
51
52	// Generate title
53	sink.section1();	×
54	sink.sectionTitle1();	×
55	sink.text(bundle.getString("migration.status.report.mainTitle"));	×
56	sink.sectionTitle1_();	×
57	sink.section1_();	×
58	sink.lineBreak();	×
59
60	sink.section2();	×
61	sink.sectionTitle2();	×
62	sink.text(bundle.getString("migration.status.report.secondSectionTitle"));	×
63	sink.sectionTitle2_();	×
64
65	for (Entry<MavenProject, List<Change>> entries : changes.entrySet()) {	×
66	if (isAggregate) {	×
67	sink.section3();	×
68	sink.sectionTitle3();	×
69	sink.text(bundle.getString("migration.status.report.moduleTitle") + entries.getKey().getName());	×
70	sink.sectionTitle3_();	×
71	}
72	generateStatisticsTable(sink, entries.getValue());	×
73	}	×
74
75	sink.section2_();	×
76	sink.lineBreak();	×
77
78	sink.section3();	×
79	sink.sectionTitle2();	×
80	sink.text(bundle.getString("migration.status.report.thirdSectionTitle"));	×
81	sink.sectionTitle2_();	×
82	for (Entry<MavenProject, List<Change>> entries : changes.entrySet()) {	×
83	if (isAggregate) {	×
84	sink.section3();	×
85	sink.sectionTitle3();	×
86	sink.text(bundle.getString("migration.status.report.moduleTitle") + entries.getKey().getName());	×
87	sink.sectionTitle3_();	×
88	}
89	// Generate Unused declared dependencies:
90	generateChangesTable(sink, entries.getValue());	×
91	}	×
92
93	sink.section3_();	×
94
95	// Closing the report
96	sink.body_();	×
97	sink.flush();	×
98	sink.close();	×
99	}	×
100
101	/**
102	* Generates statistic table.
103	*
104	* @param sink
105	* the sink
106	* @param changes
107	* the changes
108	*/
109	private void generateStatisticsTable(Sink sink, List<Change> changes) {
110	sink.table();	×
111
112	sink.tableRow();	×
113	sink.tableCell();	×
114	sink.text(" Number of migration changes: ");	×
115	sink.tableCell_();	×
116
117	sink.tableCell();	×
118	sink.text("" + changes.size());	×
119	sink.tableCell_();	×
120	sink.tableRow_();	×
121
122	sink.tableRow();	×
123	sink.tableCell();	×
124	sink.text(" Number of pending migrations: ");	×
125	sink.tableCell_();	×
126
127	int nop = numberOfPending(changes);	×
128
129	sink.tableCell();	×
130	sink.text(nop + " (" + calcPerc(changes.size(), nop) + ") ");	×
131	sink.nonBreakingSpace();	×
132	sink.figure();	×
133	sink.figureGraphics(nop == 0 ? "images/icon_success_sml.gif" : "images/icon_warning_sml.gif");	×
134	sink.figure_();	×
135	sink.tableCell_();	×
136	sink.tableRow_();	×
137
138	sink.table_();	×
139	}	×
140
141	/**
142	* Calculates the percentage.
143	*
144	* @param tot
145	* the tot
146	* @param nop
147	* the nop
148	*
149	* @return the string
150	*/
151	private String calcPerc(int tot, int nop) {
152	return "" + ((100 * nop) / tot) + "%";	×
153	}
154
155	/**
156	* Return the number of pending change found.
157	*
158	* @param changes
159	* list of {@link Change}
160	*
161	* @return Return the number of pending change found.
162	*/
163	private int numberOfPending(List<Change> changes) {
164	int numberOfPending = 0;	×
165	for (Change change : changes) {	×
166	if (change.getAppliedTimestamp() == null) {	×
167	numberOfPending++;	×
168	}
169	}	×
170	return numberOfPending;	×
171	}
172
173	/**
174	* Generate a table for the given dependencies iterator.
175	*
176	* @param sink
177	* the {@link Sink} instance
178	* @param iter
179	* list of {@link Change}
180	*/
181	public void generateChangesTable(Sink sink, List<Change> iter) {
182	sink.table();	×
183
184	sink.tableRow();	×
185	sink.tableCell();	×
186	sink.bold();	×
187	sink.text("ID");	×
188	sink.bold_();	×
189	sink.tableCell_();	×
190
191	sink.tableCell();	×
192	sink.bold();	×
193	sink.text("Applied At");	×
194	sink.bold_();	×
195	sink.tableCell_();	×
196
197	sink.tableCell();	×
198	sink.bold();	×
199	sink.text("Description");	×
200	sink.bold_();	×
201	sink.tableCell_();	×
202
203	sink.tableCell();	×
204	sink.bold();	×
205	sink.text("Filename");	×
206	sink.bold_();	×
207	sink.tableCell_();	×
208
209	sink.tableCell();	×
210	sink.bold();	×
211	sink.text("Status");	×
212	sink.bold_();	×
213	sink.tableCell_();	×
214
215	sink.tableRow_();	×
216
217	for (Change change : iter) {	×
218	sink.tableRow();	×
219
220	sink.tableCell();	×
221	sink.text("" + change.getId());	×
222	sink.tableCell_();	×
223
224	sink.tableCell();	×
225	sink.text(change.getAppliedTimestamp() == null ? " ... pending ... " : change.getAppliedTimestamp());	×
226	sink.tableCell_();	×
227
228	sink.tableCell();	×
229	sink.text(change.getDescription());	×
230	sink.tableCell_();	×
231
232	sink.tableCell();	×
233	sink.text(change.getFilename());	×
234	sink.tableCell_();	×
235
236	sink.tableCell();	×
237	sink.figure();	×
238	sink.figureGraphics(	×
239	change.getAppliedTimestamp() != null ? "images/icon_success_sml.gif" : "images/icon_warning_sml.gif");	×
240	sink.figure_();	×
241	sink.tableCell_();	×
242
243	sink.tableRow_();	×
244	}	×
245
246	sink.table_();	×
247	sink.horizontalRule();	×
248	}	×
249
250	}

mybatis / migrations-maven-plugin / #774

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous