Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow CommandMetadata to be injected into Cli commands #31

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion src/main/java/io/airlift/airline/Cli.java
Original file line number Diff line number Diff line change
Expand Up @@ -117,13 +117,21 @@ public C parse(Iterable<String> args)

CommandMetadata command = state.getCommand();

ImmutableMap.Builder<Class<?>, Object> bindings = ImmutableMap.<Class<?>, Object> builder()
.put(GlobalMetadata.class, metadata)
.put(CommandMetadata.class, command);

if (state.getGroup() != null) {
bindings.put(CommandGroupMetadata.class, state.getGroup());
}

return createInstance(command.getType(),
command.getAllOptions(),
state.getParsedOptions(),
command.getArguments(),
state.getParsedArguments(),
command.getMetadataInjections(),
ImmutableMap.<Class<?>, Object>of(GlobalMetadata.class, metadata));
bindings.build());
}

private void validate(ParseState state)
Expand Down
17 changes: 17 additions & 0 deletions src/test/java/io/airlift/airline/CommandTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@
import io.airlift.airline.args.ArgsRequired;
import io.airlift.airline.args.ArgsSingleChar;
import io.airlift.airline.args.Arity1;
import io.airlift.airline.args.CommandWithHelp;
import io.airlift.airline.args.NeedsCommandGroupMetadata;
import io.airlift.airline.args.OptionsRequired;
import io.airlift.airline.command.CommandAdd;
import io.airlift.airline.command.CommandCommit;
Expand Down Expand Up @@ -382,4 +384,19 @@ class A
}
singleCommandParser(A.class).parse("-lon", "32");
}

public void helpOption()
{
CommandWithHelp command = singleCommandParser(CommandWithHelp.class).parse("CommandWithHelp", "-h");
Assert.assertTrue(command.helpOption.showHelpIfRequested());
}

public void injectCommandGroupMetadata()
{
CliBuilder<NeedsCommandGroupMetadata> builder = Cli.<NeedsCommandGroupMetadata>builder("parser");
builder.withGroup("group").withDefaultCommand(NeedsCommandGroupMetadata.class);
NeedsCommandGroupMetadata command = builder.build().parse("group");
Assert.assertNotNull(command.commandGroupMetadata);
Assert.assertEquals(command.commandGroupMetadata.getName(), "group");
}
}
31 changes: 31 additions & 0 deletions src/test/java/io/airlift/airline/args/CommandWithHelp.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
/**
* Copyright (C) 2010 the original author or authors.
* See the notice.md file distributed with this work for additional
* information regarding copyright ownership.
*
* 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.
*/

package io.airlift.airline.args;

import io.airlift.airline.Command;
import io.airlift.airline.HelpOption;

import javax.inject.Inject;

@Command(name = "CommandWithHelp")
public class CommandWithHelp
{
@Inject
public HelpOption helpOption;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/**
* Copyright (C) 2010 the original author or authors.
* See the notice.md file distributed with this work for additional
* information regarding copyright ownership.
*
* 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.
*/
package io.airlift.airline.args;

import io.airlift.airline.Command;
import io.airlift.airline.model.CommandGroupMetadata;

import javax.inject.Inject;

@Command(name="NeedsCommandGroupMetadata")
public class NeedsCommandGroupMetadata
{
@Inject
public CommandGroupMetadata commandGroupMetadata;
}