10142209796

Committed 29 Jul 2024 10:03AM UTC coverage: 61.2% (+0.03%) from 61.174%

Build # 10142209796

Build Type

push

github

Committed by

web-flow

Commit Message

#308: Group commandlets into non-tool and tool (#485)

Run Details

2003 of 3601 branches covered (55.62%)

Branch coverage included in aggregate %.

5308 of 8345 relevant lines covered (63.61%)

2.8 hits per line

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

94.15

cli/src/main/java/com/devonfw/tools/ide/commandlet/HelpCommandlet.java

package com.devonfw.tools.ide.commandlet;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import com.devonfw.tools.ide.context.IdeContext;
import com.devonfw.tools.ide.log.IdeLogLevel;
import com.devonfw.tools.ide.log.IdeSubLogger;
import com.devonfw.tools.ide.nls.NlsBundle;
import com.devonfw.tools.ide.property.CommandletProperty;
import com.devonfw.tools.ide.property.KeywordProperty;
import com.devonfw.tools.ide.property.Property;
import com.devonfw.tools.ide.tool.ToolCommandlet;
import com.devonfw.tools.ide.version.IdeVersion;

/**
 * {@link Commandlet} to print the environment variables.
 */
public final class HelpCommandlet extends Commandlet {

  static final String LOGO = """
      __       ___ ___  ___
      ╲ ╲     |_ _|   ╲| __|__ _ ____ _
       > >     | || |) | _|/ _` (_-< || |
      /_/ ___ |___|___/|___╲__,_/__/╲_, |
         |___|                       |__/
      """.replace('╲', '\\');

  /** The optional commandlet to get help about. */
  public final CommandletProperty commandlet;

  /**
   * The constructor.
   *
   * @param context the {@link IdeContext}.
   */
  public HelpCommandlet(IdeContext context) {

    super(context);
    addKeyword(getName());
    this.commandlet = add(new CommandletProperty("", false, "commandlet"));
  }

  @Override
  public String getName() {

    return "help";
  }

  @Override
  public boolean isIdeRootRequired() {

    return false;
  }

  private void printLogo() {

    this.context.info(LOGO);
  }

  @Override
  public void run() {

    printLogo();
    NlsBundle bundle = NlsBundle.of(this.context);
    this.context.success(bundle.get("version-banner"), IdeVersion.get());
    Commandlet cmd = this.commandlet.getValue();
    if (cmd == null) {
      this.context.info(bundle.get("usage") + " ide [option]* [[commandlet] [arg]*]");
      this.context.info("");
      printCommandlets(bundle);
    } else {
      printCommandletHelp(bundle, cmd);
    }
    this.context.info("");
    this.context.info(bundle.get("options"));
    Args options = new Args();
    ContextCommandlet cxtCmd = new ContextCommandlet();
    collectOptions(options, cxtCmd, bundle);
    if (cmd != null) {
      collectOptions(options, cmd, bundle);
    }
    options.print();
    if (cmd == null) {
      this.context.info("");
      this.context.info(bundle.getDetail(this.context.getCommandletManager().getCommandlet(HelpCommandlet.class)));
    }
  }

  private void printCommandletHelp(NlsBundle bundle, Commandlet cmd) {

    StringBuilder usage = new StringBuilder();
    Args values = new Args();
    usage.append(bundle.get("usage"));
    usage.append(" ide [option]*");
    for (Property<?> property : cmd.getProperties()) {
      if (property.isValue() || property.isRequired()) {
        usage.append(" ");
        if (!property.isRequired()) {
          usage.append('[');
        }
        String name = property.getName();
        if (name.isEmpty()) {
          assert !(property instanceof KeywordProperty);
          String key = "<" + property.getAlias() + ">";
          usage.append(key);
          values.add(key, bundle.get(cmd, property));
        } else {
          usage.append(name);
        }
        if (property.isMultiValued()) {
          usage.append('*');
        }
        if (!property.isRequired()) {
          usage.append(']');
        }
      }
    }
    this.context.info(usage.toString());
    this.context.info(bundle.get(cmd));
    this.context.info(bundle.getDetail(cmd));
    this.context.info("");
    this.context.info(bundle.get("values"));
    values.print();
    cmd.printHelp(bundle);
  }

  private void printCommandlets(NlsBundle bundle) {

    Args commandlets = new Args();
    Args toolcommandlets = new Args();
    for (Commandlet cmd : this.context.getCommandletManager().getCommandlets()) {
      String key = cmd.getName();
      String keyword = cmd.getKeyword();
      if ((keyword != null) && !keyword.equals(key)) {
        key = key + "(" + keyword + ")";
      }
      if (cmd instanceof ToolCommandlet) {
        toolcommandlets.add(key, bundle.get(cmd));
      } else {
        commandlets.add(key, bundle.get(cmd));
      }
    }

    this.context.info(bundle.get("commandlets"));
    commandlets.print(IdeLogLevel.INTERACTION);
    this.context.info("");
    this.context.info(bundle.get("toolcommandlets"));
    toolcommandlets.print(IdeLogLevel.INTERACTION);
  }

  private void collectOptions(Args options, Commandlet cmd, NlsBundle bundle) {

    for (Property<?> property : cmd.getProperties()) {
      if (property.isOption() && !property.isRequired()) {
        String id = property.getAlias();
        String name = property.getName();
        if (id == null) {
          id = name;
        } else {
          id = id + " | " + name;
        }
        String description = bundle.get(cmd, property);
        options.add(id, description);
      }
    }
  }

  private static class Arg implements Comparable<Arg> {

    private final String key;

    private final String description;

    private Arg(String key, String description) {

      super();
      this.key = key;
      this.description = description;
    }

    @Override
    public int compareTo(Arg arg) {

      if (arg == null) {
        return 1;
      }
      return this.key.compareTo(arg.key);
    }
  }

  private class Args {

    private final List<Arg> args;

    private int maxKeyLength;

    private Args() {

      super();
      this.args = new ArrayList<>();
    }

    private void add(String key, String description) {

      add(new Arg(key, description));
    }

    private void add(Arg arg) {

      this.args.add(arg);
      int keyLength = arg.key.length();
      if (keyLength > this.maxKeyLength) {
        this.maxKeyLength = keyLength;
      }
    }

    String format(Arg arg) {

      StringBuilder sb = new StringBuilder(this.maxKeyLength + 2 + arg.description.length());
      sb.append(arg.key);
      int delta = this.maxKeyLength - arg.key.length();
      while (delta > 0) {
        sb.append(' ');
        delta--;
      }
      sb.append("  ");
      sb.append(arg.description);
      return sb.toString();
    }

    void print() {

      print(IdeLogLevel.INFO);
    }

    void print(IdeLogLevel level) {

      IdeSubLogger logger = HelpCommandlet.this.context.level(level);
      for (Arg arg : get()) {
        logger.log(format(arg));
      }
    }

    public List<Arg> get() {

      Collections.sort(this.args);
      return this.args;
    }
  }
}

1	package com.devonfw.tools.ide.commandlet;
2
3	import java.util.ArrayList;
4	import java.util.Collections;
5	import java.util.List;
6
7	import com.devonfw.tools.ide.context.IdeContext;
8	import com.devonfw.tools.ide.log.IdeLogLevel;
9	import com.devonfw.tools.ide.log.IdeSubLogger;
10	import com.devonfw.tools.ide.nls.NlsBundle;
11	import com.devonfw.tools.ide.property.CommandletProperty;
12	import com.devonfw.tools.ide.property.KeywordProperty;
13	import com.devonfw.tools.ide.property.Property;
14	import com.devonfw.tools.ide.tool.ToolCommandlet;
15	import com.devonfw.tools.ide.version.IdeVersion;
16
17	/**
18	* {@link Commandlet} to print the environment variables.
19	*/
20	public final class HelpCommandlet extends Commandlet {
21
22	static final String LOGO = """	4✔
23	__ ___ ___ ___
24	╲ ╲ \|_ _\| ╲\| __\|__ _ ____ _
25	> > \| \|\| \|) \| _\|/ _` (_-< \|\| \|
26	/_/ ___ \|___\|___/\|___╲__,_/__/╲_, \|
27	\|___\| \|__/
28	""".replace('╲', '\\');	2✔
29
30	/** The optional commandlet to get help about. */
31	public final CommandletProperty commandlet;
32
33	/**
34	* The constructor.
35	*
36	* @param context the {@link IdeContext}.
37	*/
38	public HelpCommandlet(IdeContext context) {
39
40	super(context);	3✔
41	addKeyword(getName());	4✔
42	this.commandlet = add(new CommandletProperty("", false, "commandlet"));	11✔
43	}	1✔
44
45	@Override
46	public String getName() {
47
48	return "help";	2✔
49	}
50
51	@Override
52	public boolean isIdeRootRequired() {
53
54	return false;	2✔
55	}
56
57	private void printLogo() {
58
59	this.context.info(LOGO);	4✔
60	}	1✔
61
62	@Override
63	public void run() {
64
65	printLogo();	2✔
66	NlsBundle bundle = NlsBundle.of(this.context);	4✔
67	this.context.success(bundle.get("version-banner"), IdeVersion.get());	12✔
68	Commandlet cmd = this.commandlet.getValue();	5✔
69	if (cmd == null) {	2✔
70	this.context.info(bundle.get("usage") + " ide [option]* [[commandlet] [arg]*]");	7✔
71	this.context.info("");	4✔
72	printCommandlets(bundle);	4✔
73	} else {
74	printCommandletHelp(bundle, cmd);	4✔
75	}
76	this.context.info("");	4✔
77	this.context.info(bundle.get("options"));	6✔
78	Args options = new Args();	5✔
79	ContextCommandlet cxtCmd = new ContextCommandlet();	4✔
80	collectOptions(options, cxtCmd, bundle);	5✔
81	if (cmd != null) {	2✔
82	collectOptions(options, cmd, bundle);	5✔
83	}
84	options.print();	2✔
85	if (cmd == null) {	2✔
86	this.context.info("");	4✔
87	this.context.info(bundle.getDetail(this.context.getCommandletManager().getCommandlet(HelpCommandlet.class)));	10✔
88	}
89	}	1✔
90
91	private void printCommandletHelp(NlsBundle bundle, Commandlet cmd) {
92
93	StringBuilder usage = new StringBuilder();	4✔
94	Args values = new Args();	5✔
95	usage.append(bundle.get("usage"));	6✔
96	usage.append(" ide [option]*");	4✔
97	for (Property<?> property : cmd.getProperties()) {	11✔
98	if (property.isValue() \|\| property.isRequired()) {	3!
99	usage.append(" ");	4✔
100	if (!property.isRequired()) {	3✔
101	usage.append('[');	4✔
102	}
103	String name = property.getName();	3✔
104	if (name.isEmpty()) {	3✔
105	assert !(property instanceof KeywordProperty);	4!
106	String key = "<" + property.getAlias() + ">";	4✔
107	usage.append(key);	4✔
108	values.add(key, bundle.get(cmd, property));	7✔
109	} else {	1✔
110	usage.append(name);	4✔
111	}
112	if (property.isMultiValued()) {	3✔
113	usage.append('*');	4✔
114	}
115	if (!property.isRequired()) {	3✔
116	usage.append(']');	4✔
117	}
118	}
119	}	1✔
120	this.context.info(usage.toString());	5✔
121	this.context.info(bundle.get(cmd));	6✔
122	this.context.info(bundle.getDetail(cmd));	6✔
123	this.context.info("");	4✔
124	this.context.info(bundle.get("values"));	6✔
125	values.print();	2✔
126	cmd.printHelp(bundle);	3✔
127	}	1✔
128
129	private void printCommandlets(NlsBundle bundle) {
130
131	Args commandlets = new Args();	5✔
132	Args toolcommandlets = new Args();	5✔
133	for (Commandlet cmd : this.context.getCommandletManager().getCommandlets()) {	13✔
134	String key = cmd.getName();	3✔
135	String keyword = cmd.getKeyword();	3✔
136	if ((keyword != null) && !keyword.equals(key)) {	6!
137	key = key + "(" + keyword + ")";	×
138	}
139	if (cmd instanceof ToolCommandlet) {	3✔
140	toolcommandlets.add(key, bundle.get(cmd));	7✔
141	} else {
142	commandlets.add(key, bundle.get(cmd));	6✔
143	}
144	}	1✔
145
146	this.context.info(bundle.get("commandlets"));	6✔
147	commandlets.print(IdeLogLevel.INTERACTION);	3✔
148	this.context.info("");	4✔
149	this.context.info(bundle.get("toolcommandlets"));	6✔
150	toolcommandlets.print(IdeLogLevel.INTERACTION);	3✔
151	}	1✔
152
153	private void collectOptions(Args options, Commandlet cmd, NlsBundle bundle) {
154
155	for (Property<?> property : cmd.getProperties()) {	11✔
156	if (property.isOption() && !property.isRequired()) {	6!
157	String id = property.getAlias();	3✔
158	String name = property.getName();	3✔
159	if (id == null) {	2✔
160	id = name;	3✔
161	} else {
162	id = id + " \| " + name;	4✔
163	}
164	String description = bundle.get(cmd, property);	5✔
165	options.add(id, description);	4✔
166	}
167	}	1✔
168	}	1✔
169
170	private static class Arg implements Comparable<Arg> {
171
172	private final String key;
173
174	private final String description;
175
176	private Arg(String key, String description) {
177
178	super();	2✔
179	this.key = key;	3✔
180	this.description = description;	3✔
181	}	1✔
182
183	@Override
184	public int compareTo(Arg arg) {
185
186	if (arg == null) {	2!
187	return 1;	×
188	}
189	return this.key.compareTo(arg.key);	6✔
190	}
191	}
192
193	private class Args {
194
195	private final List<Arg> args;
196
197	private int maxKeyLength;
198
199	private Args() {	3✔
200
201	super();	2✔
202	this.args = new ArrayList<>();	5✔
203	}	1✔
204
205	private void add(String key, String description) {
206
207	add(new Arg(key, description));	7✔
208	}	1✔
209
210	private void add(Arg arg) {
211
212	this.args.add(arg);	5✔
213	int keyLength = arg.key.length();	4✔
214	if (keyLength > this.maxKeyLength) {	4✔
215	this.maxKeyLength = keyLength;	3✔
216	}
217	}	1✔
218
219	String format(Arg arg) {
220
221	StringBuilder sb = new StringBuilder(this.maxKeyLength + 2 + arg.description.length());	12✔
222	sb.append(arg.key);	5✔
223	int delta = this.maxKeyLength - arg.key.length();	7✔
224	while (delta > 0) {	2✔
225	sb.append(' ');	4✔
226	delta--;	2✔
227	}
228	sb.append(" ");	4✔
229	sb.append(arg.description);	5✔
230	return sb.toString();	3✔
231	}
232
233	void print() {
234
235	print(IdeLogLevel.INFO);	3✔
236	}	1✔
237
238	void print(IdeLogLevel level) {
239
240	IdeSubLogger logger = HelpCommandlet.this.context.level(level);	6✔
241	for (Arg arg : get()) {	11✔
242	logger.log(format(arg));	5✔
243	}	1✔
244	}	1✔
245
246	public List<Arg> get() {
247
248	Collections.sort(this.args);	3✔
249	return this.args;	3✔
250	}
251	}
252	}

devonfw / IDEasy / 10142209796

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