Skip to content

Commit e6b2bab

Browse files
kopporkoppor
committed
Fix namings
- entry point: JabKitLauncher - command "jabkit": JabKit
1 parent add1432 commit e6b2bab

File tree

17 files changed

+84
-108
lines changed

17 files changed

+84
-108
lines changed

‎.jbang/JabKitLauncher.java‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@
55
//JAVA 24
66
//RUNTIME_OPTIONS --enable-native-access=ALL-UNNAMED
77

8-
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/converter/CygWinPathConverter.java
9-
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/ArgumentProcessor.java
10-
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/CheckConsistency.java
11-
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/CheckIntegrity.java
12-
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/Convert.java
13-
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/DoiToBibtex.java
14-
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/Fetch.java
15-
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/GenerateBibFromAux.java
16-
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/GenerateCitationKeys.java
17-
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/Pdf.java
18-
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/PdfUpdate.java
19-
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/Preferences.java
20-
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/Pseudonymize.java
21-
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/Search.java
22-
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/JabKit.java
8+
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/converter/CygWinPathConverter.java
9+
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/commands/JabKit.java
10+
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/commands/CheckConsistency.java
11+
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/commands/CheckIntegrity.java
12+
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/commands/Convert.java
13+
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/commands/DoiToBibtex.java
14+
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/commands/Fetch.java
15+
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/commands/GenerateBibFromAux.java
16+
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/commands/GenerateCitationKeys.java
17+
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/commands/Pdf.java
18+
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/commands/PdfUpdate.java
19+
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/commands/Preferences.java
20+
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/commands/Pseudonymize.java
21+
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/commands/Search.java
22+
//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/JabKitLauncher.java
2323
//FILES tinylog.properties=../jabkit/src/main/resources/tinylog.properties
2424

2525
// raw is for https://github.com/unicode-org/icu/pull/2127
@@ -33,6 +33,6 @@
3333
/// This class is required for [jbang](https://www.jbang.dev/)
3434
public class JabKitLauncher {
3535
public static void main(String[] args) {
36-
org.jabref.toolkit.JabKit.main(args);
36+
org.jabref.toolkit.JabKitLauncher.main(args);
3737
}
3838
}

jabkit/src/main/java/org/jabref/toolkit/JabKit.java renamed to jabkit/src/main/java/org/jabref/toolkit/JabKitLauncher.java

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
import org.jabref.model.entry.BibEntryTypesManager;
3333
import org.jabref.model.util.DummyFileUpdateMonitor;
3434
import org.jabref.model.util.FileUpdateMonitor;
35+
import org.jabref.toolkit.commands.JabKit;
3536

3637
import com.airhacks.afterburner.injection.Injector;
3738
import org.slf4j.Logger;
@@ -50,7 +51,7 @@
5051
/// For the GUI application see {@link org.jabref.Launcher}.
5152
///
5253
/// Does not do any preference migrations.
53-
public class JabKit {
54+
public class JabKitLauncher {
5455
// J.U.L. bridge to SLF4J must be initialized before any logger is created, see initLogging()
5556
private static Logger LOGGER;
5657

@@ -71,13 +72,13 @@ public static void main(String[] args) {
7172
BibEntryTypesManager entryTypesManager = preferences.getCustomEntryTypesRepository();
7273
Injector.setModelOrService(BibEntryTypesManager.class, entryTypesManager);
7374

74-
ArgumentProcessor argumentProcessor = new ArgumentProcessor(preferences, entryTypesManager);
75-
CommandLine commandLine = new CommandLine(argumentProcessor);
75+
JabKit jabKit = new JabKit(preferences, entryTypesManager);
76+
CommandLine commandLine = new CommandLine(jabKit);
7677
String usageHeader = BuildInfo.JABREF_BANNER.formatted(buildInfo.version) + "\n" + JABKIT_BRAND;
7778
commandLine.getCommandSpec().usageMessage().header(usageHeader);
7879
applyUsageFooters(commandLine,
79-
ArgumentProcessor.getAvailableImportFormats(preferences),
80-
ArgumentProcessor.getAvailableExportFormats(preferences),
80+
JabKit.getAvailableImportFormats(preferences),
81+
JabKit.getAvailableExportFormats(preferences),
8182
WebFetchers.getSearchBasedFetchers(preferences.getImportFormatPreferences(), preferences.getImporterPreferences()));
8283

8384
// Show help when no arguments are given. Placed after header and footer setup
@@ -157,7 +158,7 @@ public static void initLogging(String[] args) {
157158
try {
158159
Files.createDirectories(directory);
159160
} catch (IOException e) {
160-
LOGGER = LoggerFactory.getLogger(JabKit.class);
161+
LOGGER = LoggerFactory.getLogger(JabKitLauncher.class);
161162
LOGGER.error("Could not create log directory {}", directory, e);
162163
return;
163164
}
@@ -180,7 +181,7 @@ public static void initLogging(String[] args) {
180181
Configuration.set("%s.policies".formatted(fileWriterName), "startup");
181182
Configuration.set("%s.backups".formatted(fileWriterName), "30");
182183

183-
LOGGER = LoggerFactory.getLogger(JabKit.class);
184+
LOGGER = LoggerFactory.getLogger(JabKitLauncher.class);
184185
}
185186

186187
private static void configureProxy(ProxyPreferences proxyPreferences) {

‎jabkit/src/main/java/org/jabref/toolkit/commands/CheckConsistency.java‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
import org.jabref.logic.quality.consistency.BibliographyConsistencyCheckResultTxtWriter;
1515
import org.jabref.logic.quality.consistency.BibliographyConsistencyCheckResultWriter;
1616
import org.jabref.model.database.BibDatabaseContext;
17-
import org.jabref.toolkit.ArgumentProcessor;
1817
import org.jabref.toolkit.converter.CygWinPathConverter;
1918

2019
import org.slf4j.Logger;
@@ -29,10 +28,10 @@ class CheckConsistency implements Callable<Integer> {
2928
private static final Logger LOGGER = LoggerFactory.getLogger(CheckConsistency.class);
3029

3130
@ParentCommand
32-
private ArgumentProcessor argumentProcessor;
31+
private JabKit jabKit;
3332

3433
@Mixin
35-
private ArgumentProcessor.SharedOptions sharedOptions = new ArgumentProcessor.SharedOptions();
34+
private JabKit.SharedOptions sharedOptions = new JabKit.SharedOptions();
3635

3736
// [impl->req~jabkit.cli.input-flag~1]
3837
@Option(names = {"--input"}, converter = CygWinPathConverter.class, description = "Input BibTeX file", required = true)
@@ -43,10 +42,10 @@ class CheckConsistency implements Callable<Integer> {
4342

4443
@Override
4544
public Integer call() {
46-
Optional<ParserResult> parserResult = ArgumentProcessor.importFile(
45+
Optional<ParserResult> parserResult = JabKit.importFile(
4746
inputFile,
4847
"bibtex",
49-
argumentProcessor.cliPreferences,
48+
jabKit.cliPreferences,
5049
sharedOptions.porcelain);
5150
if (parserResult.isEmpty()) {
5251
System.out.println(Localization.lang("Unable to open file '%0'.", inputFile));
@@ -84,14 +83,14 @@ private int writeCheckResult(BibliographyConsistencyCheck.Result result, BibData
8483
result,
8584
writer,
8685
sharedOptions.porcelain,
87-
argumentProcessor.entryTypesManager,
86+
jabKit.entryTypesManager,
8887
databaseContext.getMode());
8988
} else {
9089
checkResultWriter = new BibliographyConsistencyCheckResultCsvWriter(
9190
result,
9291
writer,
9392
sharedOptions.porcelain,
94-
argumentProcessor.entryTypesManager,
93+
jabKit.entryTypesManager,
9594
databaseContext.getMode());
9695
}
9796

‎jabkit/src/main/java/org/jabref/toolkit/commands/CheckIntegrity.java‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
import org.jabref.logic.journals.JournalAbbreviationLoader;
2121
import org.jabref.logic.l10n.Localization;
2222
import org.jabref.model.database.BibDatabaseContext;
23-
import org.jabref.toolkit.ArgumentProcessor;
2423
import org.jabref.toolkit.converter.CygWinPathConverter;
2524

2625
import org.slf4j.Logger;
@@ -37,10 +36,10 @@ class CheckIntegrity implements Callable<Integer> {
3736
private static final Logger LOGGER = LoggerFactory.getLogger(CheckIntegrity.class);
3837

3938
@CommandLine.ParentCommand
40-
private ArgumentProcessor argumentProcessor;
39+
private JabKit jabKit;
4140

4241
@Mixin
43-
private ArgumentProcessor.SharedOptions sharedOptions = new ArgumentProcessor.SharedOptions();
42+
private JabKit.SharedOptions sharedOptions = new JabKit.SharedOptions();
4443

4544
// [impl->req~jabkit.cli.input-flag~1]
4645
@Option(names = {"--input"}, converter = CygWinPathConverter.class, description = "Input BibTeX file", required = true)
@@ -55,10 +54,10 @@ class CheckIntegrity implements Callable<Integer> {
5554

5655
@Override
5756
public Integer call() {
58-
Optional<ParserResult> parserResult = ArgumentProcessor.importFile(
57+
Optional<ParserResult> parserResult = JabKit.importFile(
5958
inputFile,
6059
"bibtex",
61-
argumentProcessor.cliPreferences,
60+
jabKit.cliPreferences,
6261
sharedOptions.porcelain);
6362
if (parserResult.isEmpty()) {
6463
System.out.println(Localization.lang("Unable to open file '%0'.", inputFile));
@@ -79,9 +78,9 @@ public Integer call() {
7978

8079
IntegrityCheck integrityCheck = new IntegrityCheck(
8180
databaseContext,
82-
argumentProcessor.cliPreferences.getFilePreferences(),
83-
argumentProcessor.cliPreferences.getCitationKeyPatternPreferences(),
84-
JournalAbbreviationLoader.loadRepository(argumentProcessor.cliPreferences.getJournalAbbreviationPreferences()),
81+
jabKit.cliPreferences.getFilePreferences(),
82+
jabKit.cliPreferences.getCitationKeyPatternPreferences(),
83+
JournalAbbreviationLoader.loadRepository(jabKit.cliPreferences.getJournalAbbreviationPreferences()),
8584
allowIntegerEdition
8685
);
8786

‎jabkit/src/main/java/org/jabref/toolkit/commands/Convert.java‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
import org.jabref.logic.journals.JournalAbbreviationRepository;
1616
import org.jabref.logic.l10n.Localization;
1717
import org.jabref.model.database.BibDatabaseContext;
18-
import org.jabref.toolkit.ArgumentProcessor;
1918
import org.jabref.toolkit.converter.CygWinPathConverter;
2019

2120
import com.airhacks.afterburner.injection.Injector;
@@ -29,14 +28,14 @@
2928
import static picocli.CommandLine.ParentCommand;
3029

3130
@Command(name = "convert", description = "Convert between bibliography formats.")
32-
public class Convert implements Runnable {
31+
class Convert implements Runnable {
3332
private static final Logger LOGGER = LoggerFactory.getLogger(Convert.class);
3433

3534
@ParentCommand
36-
private ArgumentProcessor argumentProcessor;
35+
private JabKit jabKit;
3736

3837
@Mixin
39-
private ArgumentProcessor.SharedOptions sharedOptions = new ArgumentProcessor.SharedOptions();
38+
private JabKit.SharedOptions sharedOptions = new JabKit.SharedOptions();
4039

4140
// [impl->req~jabkit.cli.input-flag~1]
4241
@Option(names = {"--input"}, converter = CygWinPathConverter.class, description = "Input file", required = true)
@@ -53,7 +52,7 @@ public class Convert implements Runnable {
5352

5453
@Override
5554
public void run() {
56-
Optional<ParserResult> parserResult = ArgumentProcessor.importFile(inputFile, inputFormat, argumentProcessor.cliPreferences, sharedOptions.porcelain);
55+
Optional<ParserResult> parserResult = JabKit.importFile(inputFile, inputFormat, jabKit.cliPreferences, sharedOptions.porcelain);
5756
if (parserResult.isEmpty()) {
5857
System.out.println(Localization.lang("Unable to open file '%0'.", inputFile));
5958
return;
@@ -82,9 +81,9 @@ protected void exportFile(@NonNull ParserResult parserResult, @NonNull Path outp
8281
}
8382

8483
if ("bibtex".equalsIgnoreCase(format)) {
85-
ArgumentProcessor.saveDatabase(
86-
argumentProcessor.cliPreferences,
87-
argumentProcessor.entryTypesManager,
84+
JabKit.saveDatabase(
85+
jabKit.cliPreferences,
86+
jabKit.entryTypesManager,
8887
parserResult.getDatabase(),
8988
outputFile);
9089
return;
@@ -94,9 +93,9 @@ protected void exportFile(@NonNull ParserResult parserResult, @NonNull Path outp
9493
BibDatabaseContext databaseContext = parserResult.getDatabaseContext();
9594
databaseContext.setDatabasePath(path);
9695
List<Path> fileDirForDatabase = databaseContext
97-
.getFileDirectories(argumentProcessor.cliPreferences.getFilePreferences());
96+
.getFileDirectories(jabKit.cliPreferences.getFilePreferences());
9897

99-
ExporterFactory exporterFactory = ExporterFactory.create(argumentProcessor.cliPreferences);
98+
ExporterFactory exporterFactory = ExporterFactory.create(jabKit.cliPreferences);
10099
Optional<Exporter> exporter = exporterFactory.getExporterByName(format);
101100
if (exporter.isEmpty()) {
102101
System.out.println(Localization.lang("Unknown export format '%0'.", format));

‎jabkit/src/main/java/org/jabref/toolkit/commands/DoiToBibtex.java‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
import org.jabref.model.database.BibDatabaseContext;
1717
import org.jabref.model.entry.BibEntry;
1818
import org.jabref.model.entry.identifier.DOI;
19-
import org.jabref.toolkit.ArgumentProcessor;
2019

2120
import org.slf4j.Logger;
2221
import org.slf4j.LoggerFactory;
@@ -25,15 +24,15 @@
2524
import picocli.CommandLine.Parameters;
2625

2726
@Command(name = "doi-to-bibtex", description = "Converts a DOI to BibTeX")
28-
public class DoiToBibtex implements Callable<Integer> {
27+
class DoiToBibtex implements Callable<Integer> {
2928

3029
private static final Logger LOGGER = LoggerFactory.getLogger(DoiToBibtex.class);
3130

3231
@CommandLine.ParentCommand
33-
private ArgumentProcessor argumentProcessor;
32+
private JabKit argumentProcessor;
3433

3534
@CommandLine.Mixin
36-
private ArgumentProcessor.SharedOptions sharedOptions = new ArgumentProcessor.SharedOptions();
35+
private JabKit.SharedOptions sharedOptions = new JabKit.SharedOptions();
3736

3837
@Parameters(paramLabel = "DOI", description = "one or more DOIs to fetch", arity = "1..*")
3938
private String[] dois;

‎jabkit/src/main/java/org/jabref/toolkit/commands/Fetch.java‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
import org.jabref.logic.l10n.Localization;
1313
import org.jabref.model.database.BibDatabase;
1414
import org.jabref.model.entry.BibEntry;
15-
import org.jabref.toolkit.ArgumentProcessor;
1615

1716
import org.slf4j.Logger;
1817
import org.slf4j.LoggerFactory;
@@ -30,10 +29,10 @@ record Provider(String name, String query) {
3029
}
3130

3231
@ParentCommand
33-
private ArgumentProcessor argumentProcessor;
32+
private JabKit argumentProcessor;
3433

3534
@Mixin
36-
private ArgumentProcessor.SharedOptions sharedOptions = new ArgumentProcessor.SharedOptions();
35+
private JabKit.SharedOptions sharedOptions = new JabKit.SharedOptions();
3736

3837
@Option(names = "--provider", required = true)
3938
private String provider;
@@ -74,7 +73,7 @@ public void run() {
7473
}
7574

7675
if (outputFile != null) {
77-
ArgumentProcessor.saveDatabase(
76+
JabKit.saveDatabase(
7877
argumentProcessor.cliPreferences,
7978
argumentProcessor.entryTypesManager,
8079
new BibDatabase(matches),

‎jabkit/src/main/java/org/jabref/toolkit/commands/GenerateBibFromAux.java‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
import org.jabref.logic.l10n.Localization;
1414
import org.jabref.model.database.BibDatabase;
1515
import org.jabref.model.entry.BibEntry;
16-
import org.jabref.toolkit.ArgumentProcessor;
1716
import org.jabref.toolkit.converter.CygWinPathConverter;
1817

1918
import org.slf4j.Logger;
@@ -29,10 +28,10 @@ class GenerateBibFromAux implements Runnable {
2928
private static final Logger LOGGER = LoggerFactory.getLogger(GenerateBibFromAux.class);
3029

3130
@ParentCommand
32-
private ArgumentProcessor argumentProcessor;
31+
private JabKit argumentProcessor;
3332

3433
@Mixin
35-
private ArgumentProcessor.SharedOptions sharedOptions = new ArgumentProcessor.SharedOptions();
34+
private JabKit.SharedOptions sharedOptions = new JabKit.SharedOptions();
3635

3736
@Option(names = "--aux", required = true)
3837
private Path auxFile;
@@ -46,7 +45,7 @@ class GenerateBibFromAux implements Runnable {
4645

4746
@Override
4847
public void run() {
49-
Optional<ParserResult> pr = ArgumentProcessor.importFile(
48+
Optional<ParserResult> pr = JabKit.importFile(
5049
inputFile,
5150
"bibtex",
5251
argumentProcessor.cliPreferences,
@@ -84,7 +83,7 @@ public void run() {
8483
.collect(Collectors.joining("\n\n")));
8584
return;
8685
} else {
87-
ArgumentProcessor.saveDatabase(
86+
JabKit.saveDatabase(
8887
argumentProcessor.cliPreferences,
8988
argumentProcessor.entryTypesManager,
9089
subDatabase,

‎jabkit/src/main/java/org/jabref/toolkit/commands/GenerateCitationKeys.java‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
import org.jabref.logic.l10n.Localization;
1010
import org.jabref.model.database.BibDatabaseContext;
1111
import org.jabref.model.entry.BibEntry;
12-
import org.jabref.toolkit.ArgumentProcessor;
1312
import org.jabref.toolkit.converter.CygWinPathConverter;
1413

1514
import org.slf4j.Logger;
@@ -21,14 +20,14 @@
2120
import static picocli.CommandLine.ParentCommand;
2221

2322
@Command(name = "generate-citation-keys", description = "Generate citation keys for entries in a .bib file.")
24-
public class GenerateCitationKeys implements Runnable {
23+
class GenerateCitationKeys implements Runnable {
2524
private static final Logger LOGGER = LoggerFactory.getLogger(GenerateCitationKeys.class);
2625

2726
@ParentCommand
28-
private ArgumentProcessor argumentProcessor;
27+
private JabKit argumentProcessor;
2928

3029
@Mixin
31-
private ArgumentProcessor.SharedOptions sharedOptions = new ArgumentProcessor.SharedOptions();
30+
private JabKit.SharedOptions sharedOptions = new JabKit.SharedOptions();
3231

3332
// [impl->req~jabkit.cli.input-flag~1]
3433
@Option(names = {"--input"}, converter = CygWinPathConverter.class, description = "Input BibTeX file", required = true)
@@ -39,7 +38,7 @@ public class GenerateCitationKeys implements Runnable {
3938

4039
@Override
4140
public void run() {
42-
Optional<ParserResult> parserResult = ArgumentProcessor.importFile(
41+
Optional<ParserResult> parserResult = JabKit.importFile(
4342
inputFile,
4443
"bibtex",
4544
argumentProcessor.cliPreferences,
@@ -68,7 +67,7 @@ public void run() {
6867
}
6968

7069
if (outputFile != null) {
71-
ArgumentProcessor.saveDatabase(
70+
JabKit.saveDatabase(
7271
argumentProcessor.cliPreferences,
7372
argumentProcessor.entryTypesManager,
7473
parserResult.get().getDatabase(),

0 commit comments

Comments
 (0)