diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..82eca33 --- /dev/null +++ b/.gitignore @@ -0,0 +1,25 @@ +/target/ +!.mvn/wrapper/maven-wrapper.jar + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr + +### NetBeans ### +/nbproject/private/ +/build/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + 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 + + http://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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..7fa2191 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# mini-table + +> A lightweight, non-dependent Java ASCII TABLE generation library \ No newline at end of file diff --git a/google_checks.xml b/google_checks.xml new file mode 100644 index 0000000..f4358b7 --- /dev/null +++ b/google_checks.xml @@ -0,0 +1,252 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..6f2aa2d --- /dev/null +++ b/pom.xml @@ -0,0 +1,185 @@ + + + 4.0.0 + + com.blinkfox + mini-table + 1.0.0-SNAPSHOT + jar + + mini-table + A lightweight, non-dependent Java ASCII TABLE generation library. + + + + The Apache Software License, Version 2.0 + http://www.apache.org/licenses/LICENSE-2.0.txt + + + + + + blinkfox + chenjiayin1990@163.com + https://blinkfox.github.io/ + + + + + UTF-8 + UTF-8 + UTF-8 + + + + + junit + junit + 4.12 + test + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + 2.3.2 + + 1.6 + 1.6 + UTF-8 + + + + org.apache.maven.plugins + maven-pmd-plugin + 3.7 + + 1.6 + true + + + + org.codehaus.mojo + cobertura-maven-plugin + 2.7 + + + html + xml + + + + + + + + + + + org.apache.maven.plugins + maven-project-info-reports-plugin + 2.9 + + + org.apache.maven.plugins + maven-pmd-plugin + 3.7 + + + org.apache.maven.plugins + maven-jxr-plugin + 2.5 + + + org.codehaus.mojo + cobertura-maven-plugin + 2.7 + + + html + xml + + + + + + + + + + release + + + + + org.apache.maven.plugins + maven-source-plugin + 3.0.1 + + + package + + jar-no-fork + + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 2.10.4 + + + package + + jar + + + + + + + org.apache.maven.plugins + maven-gpg-plugin + 1.6 + + + verify + + sign + + + + + + + + + oss + https://oss.sonatype.org/content/repositories/snapshots/ + + + oss + https://oss.sonatype.org/service/local/staging/deploy/maven2/ + + + + + + + + oss + https://oss.sonatype.org/content/repositories/snapshots/ + + + oss + https://oss.sonatype.org/service/local/staging/deploy/maven2/ + + + + diff --git a/src/main/java/com/blinkfox/minitable/MiniTable.java b/src/main/java/com/blinkfox/minitable/MiniTable.java new file mode 100644 index 0000000..08952b7 --- /dev/null +++ b/src/main/java/com/blinkfox/minitable/MiniTable.java @@ -0,0 +1,317 @@ +package com.blinkfox.minitable; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + * 生成 ASCII TABLE 的主核心类. + * + * @author blinkfox on 2019-01-13. + */ +public final class MiniTable { + + /** 表格标题. */ + private String title; + + /** 最后处理行类型. */ + private RowType lastRowType; + + /** 用于拼接字符串的 StringBuilder 对象. */ + private StringBuilder join; + + /** 用来存放每行数据的有序Map. */ + private List rows; + + /** 用来存放每列长度最大值的Map. */ + private Map maxColMap; + + /** + * 默认的空构造方法. + */ + public MiniTable() { + this.init(); + } + + /** + * 包含标题的构造方法. + * + * @param title 标题 + */ + public MiniTable(String title) { + this.init(); + this.title = title; + } + + /** + * 初始化数据. + */ + private void init() { + this.join = new StringBuilder(); + this.rows = new ArrayList(); + this.maxColMap = new HashMap(); + } + + /** + * 向表格中添加表头数据. + * + * @param objects 表头数据 + * @return MiniTable对象 + */ + public MiniTable addHeaders(Object... objects) { + return this.appendRows(RowType.HEADER, objects); + } + + /** + * 向表格中添加一行普通数据. + * + * @param objects 表头数据 + * @return MiniTable对象 + */ + public MiniTable addDatas(Object... objects) { + return this.appendRows(RowType.DATA, objects); + } + + /** + * 向表格添加中一行数据. + * + * @param objects 表行数据 + * @return MiniTable对象 + */ + private MiniTable appendRows(RowType rowType, Object... objects) { + int len; + if (objects != null && (len = objects.length) > 0) { + if (this.maxColMap.size() > len) { + throw new IllegalArgumentException("向表格中插入某行数据的列数比之前的列数多了,请检查!"); + } + + // 遍历传入的数据集合,并将其存入到行数据对象中. + List datas = new ArrayList(); + for (int i = 0; i < len; i++) { + Object o = objects[i]; + String value = o == null ? "null" : o.toString(); + datas.add(value); + + // 获取第 i 列的最大长度值,如果当前列的长度大于了以前的最大列,就覆盖最大列长度为当前的列长度. + Integer maxColSize = this.maxColMap.get(i); + if (maxColSize == null) { + this.maxColMap.put(i, value.length()); + continue; + } + + if (value.length() > maxColSize) { + this.maxColMap.put(i, value.length()); + } + } + this.rows.add(new Row(rowType, datas)); + } + return this; + } + + /** + * 构建表格标题所在行的字符串. + * + *

这里重点需要计算出标题所占用的最大字符串长度,然后截取出标题的字符串. + * 计算标题字符串最大长度的公式: `maxTitleSize = n * (maxColSize) + (n - 1) * 3`; + *

+ */ + private void buildTitle() { + if (this.title != null) { + // 计算出标题字符串最大长度. + int maxTitleSize = 0; + for (Integer maxColSize : this.maxColMap.values()) { + maxTitleSize += maxColSize; + } + maxTitleSize += 3 * (this.maxColMap.size() - 1); + + // 如果最大的标题字符串长度大于了现有的标题,就对现有的标题进行截取. + if (this.title.length() > maxTitleSize) { + this.title = this.title.substring(0, maxTitleSize); + } + + // 拼接出标题行的上边框和标题行的数据. + this.join.append("+"); + for (int i = 0; i < maxTitleSize + 2; i++) { + this.join.append("-"); + } + this.join.append("+\n") + .append("|") + .append(StrUtils.center(this.title, maxTitleSize + 2, ' ')) + .append("|\n"); + + this.lastRowType = RowType.TITLE; + } + } + + /** + * 构建生成表格 table,先构建出标题,然后遍历每行数据进行构建. + */ + private void buildTable() { + this.buildTitle(); + + // 遍历每行的数据,生成表格的行数据. + for (int i = 0, len = this.rows.size(); i < len; i++) { + List datas = this.rows.get(i).datas; + switch (this.rows.get(i).rowType) { + // 如果当前行是表头,则需要考虑生成上下边框. + case HEADER: + if (this.lastRowType != RowType.HEADER) { + this.buildRowBorder(datas); + } + this.buildRowData(datas); + this.buildRowBorder(datas); + break; + // 如果当前行是普通数据行,则需要考虑在最后一行处追加下边框. + case DATA: + this.buildRowData(datas); + if (i == len - 1) { + this.buildRowBorder(datas); + } + break; + default: + break; + } + } + } + + /** + * 构建边框行的方法. + * + * @param datas 行 + */ + private void buildRowBorder(List datas) { + this.join.append("+"); + for (int i = 0, len = datas.size(); i < len; i++) { + for (int j = 0; j < this.maxColMap.get(i) + 2; j++) { + this.join.append("-"); + } + this.join.append("+"); + } + this.join.append("\n"); + } + + /** + * 构建数据行的方法. + * + * @param datas 行数据 + */ + private void buildRowData(List datas) { + this.join.append("|"); + for (int i = 0, len = datas.size(); i < len; i++) { + this.join.append(StrUtils.center(datas.get(i), this.maxColMap.get(i) + 2, ' ')) + .append("|"); + } + this.join.append("\n"); + } + + /** + * 渲染出生成的结果. + * + * @return Table的ASCII字符串 + */ + public String render() { + this.buildTable(); + return this.join.toString(); + } + + /** + * 表格每行的类型和数据的实体类. + */ + private static class Row { + + /** 行类型. */ + private RowType rowType; + + /** 行数据. */ + private List datas; + + /** + * 构造方法. + * + * @param rowType 行类型 + * @param datas 行数据集 + */ + Row(RowType rowType, List datas) { + this.rowType = rowType; + this.datas = datas; + } + + } + + /** + * 区分是表头还是普通表格数据的枚举类. + */ + private enum RowType { + TITLE, HEADER, DATA + } + + /** + * 字符串工具类. + */ + private static final class StrUtils { + + /** + * 将某字符串置于给定大小的中间. + * + * @param str 字符串 + * @param size 总大小 + * @param padChar 填充字符 + * @return 字符串结果 + */ + private static String center(String str, int size, char padChar) { + if (str != null && size > 0) { + int strLen = str.length(); + int pads = size - strLen; + if (pads > 0) { + str = leftPad(str, strLen + pads / 2, padChar); + str = rightPad(str, size, padChar); + } + } + return str; + } + + /** + * 对给定的字符串和大小进行左填充. + * + * @param str 字符串 + * @param size 填充的总大小 + * @param padChar 填充字符 + * @return 填充结果 + */ + private static String leftPad(final String str, int size, char padChar) { + int pads = size - str.length(); + return pads <= 0 ? str : repeat(padChar, pads).concat(str); + } + + /** + * 对给定的字符串和大小进行右填充. + * + * @param str 字符串 + * @param size 填充的总大小 + * @param padChar 填充字符 + * @return 填充结果 + */ + private static String rightPad(final String str, int size, char padChar) { + int pads = size - str.length(); + return pads <= 0 ? str : str.concat(repeat(padChar, pads)); + } + + /** + * 重复填充字符为字符串. + * + * @param ch 字符 + * @param repeat 重复次数 + * @return 字符串 + */ + private static String repeat(char ch, int repeat) { + char[] buf = new char[repeat]; + for (int i = repeat - 1; i >= 0; i--) { + buf[i] = ch; + } + return new String(buf); + } + + } + +} diff --git a/src/test/java/com/blinkfox/minitable/MiniTableTest.java b/src/test/java/com/blinkfox/minitable/MiniTableTest.java new file mode 100644 index 0000000..c7f0e0b --- /dev/null +++ b/src/test/java/com/blinkfox/minitable/MiniTableTest.java @@ -0,0 +1,72 @@ +package com.blinkfox.minitable; + +import org.junit.Assert; +import org.junit.Test; + +/** + * MiniTableTest. + * + * @author blinkfox on 2019-01-13. + */ +public class MiniTableTest { + + private static final String TABLE = "" + + "+-------------------------------------------------------------+\n" + + "| The Title |\n" + + "+-----------+--------+-----+--------------------+-------------+\n" + + "| Name | Sex | Age | Email | Phone |\n" + + "+-----------+--------+-----+--------------------+-------------+\n" + + "| LiLei | male | 25 | lilei@gmail.com | 13809345219 |\n" + + "| hanMeiMei | female | 23 | hmm@163.com | 13515343853 |\n" + + "+-----------+--------+-----+--------------------+-------------+\n" + + "| Name | Sex | Age | Email | Phone |\n" + + "+-----------+--------+-----+--------------------+-------------+\n" + + "| ZhangSan | female | 32 | zhangsan@gmail.com | 13920199836 |\n" + + "| Lisi | male | 28 | lisi@qq.com | 13635781534 |\n" + + "| WangWu | male | 48 | wangwu@163.com | 15809876236 |\n" + + "+-----------+--------+-----+--------------------+-------------+\n"; + + /** + * 测试正常渲染的情况. + */ + @Test + public void render() { + String table = new MiniTable("The Title") + .addHeaders("Name", "Sex", "Age", "Email", "Phone") + .addDatas("LiLei", "male", 25, "lilei@gmail.com", "13809345219") + .addDatas("hanMeiMei", "female", 23, "hmm@163.com", "13515343853") + .addHeaders("Name", "Sex", "Age", "Email", "Phone") + .addDatas("ZhangSan", "female", 32, "zhangsan@gmail.com", "13920199836") + .addDatas("Lisi", "male", 28, "lisi@qq.com", "13635781534") + .addDatas("WangWu", "male", 48, "wangwu@163.com", "15809876236") + .render(); + Assert.assertEquals(TABLE, table); + } + + /** + * 测试参数不对时的情况. + */ + @Test(expected = IllegalArgumentException.class) + public void renderWithException() { + new MiniTable().addHeaders("col11", "col12") + .addDatas("col21") + .render(); + } + + /** + * 测试参数不对时的情况. + */ + @Test + public void renderWithLongTitle() { + String table = new MiniTable("This is a too long title.") + .addHeaders("col11", "col12") + .render(); + Assert.assertEquals("" + + "+---------------+\n" + + "| This is a too |\n" + + "+-------+-------+\n" + + "| col11 | col12 |\n" + + "+-------+-------+\n", table); + } + +} \ No newline at end of file