Skip to content

Commit

Permalink
feat: Move NamingConvention to presets package
Browse files Browse the repository at this point in the history
Moved `NamingConvention` from the settings package to a new settings.presets package. This involved modifying various import statements across the application and updating methods that utilised this enum. Increased the `KeyCaseFormater` minimum and preferred width to 200 for better UI rendering.
  • Loading branch information
JPilson committed Apr 21, 2024
1 parent 4c737e2 commit 340ab13
Show file tree
Hide file tree
Showing 14 changed files with 54 additions and 24 deletions.
11 changes: 8 additions & 3 deletions src/main/java/de/marhali/easyi18n/action/LocalizeItAction.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
package de.marhali.easyi18n.action;

import com.google.common.base.CaseFormat;
import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.AnActionEvent;
import com.intellij.openapi.actionSystem.CommonDataKeys;
Expand All @@ -11,7 +10,7 @@

import de.marhali.easyi18n.dialog.AddDialog;
import de.marhali.easyi18n.model.KeyPath;
import de.marhali.easyi18n.settings.NamingConvention;
import de.marhali.easyi18n.settings.presets.NamingConvention;
import de.marhali.easyi18n.settings.ProjectSettingsService;
import de.marhali.easyi18n.util.DocumentUtil;

Expand Down Expand Up @@ -79,10 +78,16 @@ private void replaceSelectedText(Project project, @NotNull Editor editor, @NotNu
*/
private String buildReplacement(String flavorTemplate, String key, DocumentUtil documentUtil) {
if (documentUtil.isVue() || documentUtil.isJsOrTs()) return flavorTemplate + "('" + key + "')";

return flavorTemplate + "(\"" + key + "\")";
}

/**
* Converts a given key to the specified naming convention.
*
* @param key the key to convert
* @param project the project where the key is being converted
* @return the converted key
*/
private String convertKeyToNamingCase(String key, Project project) {
return NamingConvention.convertKeyToConvention(key, ProjectSettingsService.get(project).getState().getCaseFormat());

Check warning on line 92 in src/main/java/de/marhali/easyi18n/action/LocalizeItAction.java

View check run for this annotation

Codecov / codecov/patch

src/main/java/de/marhali/easyi18n/action/LocalizeItAction.java#L92

Added line #L92 was not covered by tests
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
package de.marhali.easyi18n.settings;

import com.google.common.base.CaseFormat;
import de.marhali.easyi18n.io.parser.ParserStrategyType;
import de.marhali.easyi18n.io.folder.FolderStrategyType;

import de.marhali.easyi18n.settings.presets.NamingConvention;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
package de.marhali.easyi18n.settings;

import com.google.common.base.CaseFormat;
import com.intellij.ide.BrowserUtil;
import com.intellij.openapi.fileChooser.FileChooserDescriptor;
import com.intellij.openapi.project.Project;
Expand All @@ -14,6 +13,7 @@

import de.marhali.easyi18n.io.parser.ArrayMapper;
import de.marhali.easyi18n.io.parser.ParserStrategyType;
import de.marhali.easyi18n.settings.presets.NamingConvention;
import de.marhali.easyi18n.settings.presets.Preset;

import javax.swing.*;
Expand Down Expand Up @@ -233,7 +233,7 @@ private JComponent constructFlavorTemplate() {
private JComponent constructKeyCaseFormater() {
KeyCaseFormater = new ComboBox<>(NamingConvention.getEnumNames());
KeyCaseFormater.setToolTipText(bundle.getString("settings.experimental.key-naming-format.tooltip"));
KeyCaseFormater.setMinimumAndPreferredWidth(120);
KeyCaseFormater.setMinimumAndPreferredWidth(200);
return KeyCaseFormater;

Check warning on line 237 in src/main/java/de/marhali/easyi18n/settings/ProjectSettingsComponent.java

View check run for this annotation

Codecov / codecov/patch

src/main/java/de/marhali/easyi18n/settings/ProjectSettingsComponent.java#L234-L237

Added lines #L234 - L237 were not covered by tests
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
package de.marhali.easyi18n.settings;

import com.google.common.base.CaseFormat;
import com.intellij.openapi.ui.ComboBox;
import com.intellij.openapi.ui.TextFieldWithBrowseButton;

import de.marhali.easyi18n.io.parser.ParserStrategyType;
import de.marhali.easyi18n.io.folder.FolderStrategyType;
import de.marhali.easyi18n.settings.presets.NamingConvention;
import de.marhali.easyi18n.settings.presets.Preset;

import javax.swing.*;
import java.util.Objects;

/**
* Mandatory for state management for the project settings component.
Expand Down Expand Up @@ -72,7 +71,7 @@ protected ProjectSettingsState getState() {

state.setFlavorTemplate(flavorTemplate.getText());

state.setCaseFormat(NamingConvention.fromSelector(KeyCaseFormater.getSelectedItem().toString()));
state.setCaseFormat(NamingConvention.fromString(KeyCaseFormater.getSelectedItem().toString()));

Check warning on line 74 in src/main/java/de/marhali/easyi18n/settings/ProjectSettingsComponentState.java

View workflow job for this annotation

GitHub Actions / Inspect code

Nullability and data flow problems

Method invocation `toString` may produce `NullPointerException`

Check warning on line 74 in src/main/java/de/marhali/easyi18n/settings/ProjectSettingsComponentState.java

View check run for this annotation

Codecov / codecov/patch

src/main/java/de/marhali/easyi18n/settings/ProjectSettingsComponentState.java#L74

Added line #L74 was not covered by tests

return state;
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
package de.marhali.easyi18n.settings;

import com.google.common.base.CaseFormat;
import com.intellij.util.xmlb.annotations.Property;

import de.marhali.easyi18n.io.parser.ParserStrategyType;
import de.marhali.easyi18n.io.folder.FolderStrategyType;
import de.marhali.easyi18n.settings.presets.DefaultPreset;

import de.marhali.easyi18n.settings.presets.NamingConvention;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

import de.marhali.easyi18n.io.parser.ParserStrategyType;
import de.marhali.easyi18n.io.folder.FolderStrategyType;
import de.marhali.easyi18n.settings.NamingConvention;
import de.marhali.easyi18n.settings.ProjectSettings;

import org.jetbrains.annotations.NotNull;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,21 +1,30 @@
package de.marhali.easyi18n.settings;
package de.marhali.easyi18n.settings.presets;

import com.google.common.base.CaseFormat;

import java.util.Arrays;

/**
* Enum representing different naming conventions.
* Provides utility methods to convert keys to the specified convention.
*/
public enum NamingConvention {
CAMEL_CASE("Camel Case"),
CAMEL_CASE_UPPERCASE("Camel Case Uppercase"),
CAMEL_CASE_UPPERCASE("Camel Case (Uppercase)"),
SNAKE_CASE("Snake Case"),
SNAKE_CASE_UPPERCASE("Snake Case Uppercase");
SNAKE_CASE_UPPERCASE("Snake Case (Uppercase)");

private final String name;

private NamingConvention(String name) {
this.name = name;
}

/**
* Retrieves the name of the current instance of the class.
*
* @return the name of the current instance
*/
public String getName() {
return this.name;

Check warning on line 29 in src/main/java/de/marhali/easyi18n/settings/presets/NamingConvention.java

View check run for this annotation

Codecov / codecov/patch

src/main/java/de/marhali/easyi18n/settings/presets/NamingConvention.java#L29

Added line #L29 was not covered by tests
}
Expand All @@ -25,17 +34,38 @@ public String toString() {
return super.name().toLowerCase();

Check warning on line 34 in src/main/java/de/marhali/easyi18n/settings/presets/NamingConvention.java

View check run for this annotation

Codecov / codecov/patch

src/main/java/de/marhali/easyi18n/settings/presets/NamingConvention.java#L34

Added line #L34 was not covered by tests
}

static public NamingConvention fromSelector(String name) {
String formated = name.replace(" ", "_");
return valueOf(formated.toUpperCase());
/**
* Converts a string representation of a naming convention to the corresponding NamingConvention enum value.
*
* @param name the string representation of the naming convention
* @return the corresponding NamingConvention enum value
*/
static public NamingConvention fromString(String name) {
for (NamingConvention value : NamingConvention.values()) {
if (value.getName().equals(name))
return value;

Check warning on line 46 in src/main/java/de/marhali/easyi18n/settings/presets/NamingConvention.java

View check run for this annotation

Codecov / codecov/patch

src/main/java/de/marhali/easyi18n/settings/presets/NamingConvention.java#L46

Added line #L46 was not covered by tests
}
return NamingConvention.CAMEL_CASE;

Check warning on line 48 in src/main/java/de/marhali/easyi18n/settings/presets/NamingConvention.java

View check run for this annotation

Codecov / codecov/patch

src/main/java/de/marhali/easyi18n/settings/presets/NamingConvention.java#L48

Added line #L48 was not covered by tests
}

/**
* Returns an array of strings representing the names of the enum values in the {@link NamingConvention} enum.
*
* @return an array of strings representing the enum names
*/
static public String[] getEnumNames() {
return Arrays.stream(NamingConvention.values())
.map(NamingConvention::getName)
.toArray(String[]::new);

Check warning on line 59 in src/main/java/de/marhali/easyi18n/settings/presets/NamingConvention.java

View check run for this annotation

Codecov / codecov/patch

src/main/java/de/marhali/easyi18n/settings/presets/NamingConvention.java#L57-L59

Added lines #L57 - L59 were not covered by tests
}

/**
* Converts a given key to the specified naming convention.
*
* @param key the key to convert
* @param convention the naming convention to convert the key to
* @return the converted key
*/
static public String convertKeyToConvention(String key, NamingConvention convention) {
String newKey = key.toLowerCase();
newKey = newKey.replaceAll("\\s+", "_");

Check warning on line 71 in src/main/java/de/marhali/easyi18n/settings/presets/NamingConvention.java

View check run for this annotation

Codecov / codecov/patch

src/main/java/de/marhali/easyi18n/settings/presets/NamingConvention.java#L70-L71

Added lines #L70 - L71 were not covered by tests
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
package de.marhali.easyi18n.settings.presets;

import com.google.common.base.CaseFormat;
import de.marhali.easyi18n.io.parser.ParserStrategyType;
import de.marhali.easyi18n.io.folder.FolderStrategyType;
import de.marhali.easyi18n.settings.NamingConvention;
import de.marhali.easyi18n.settings.ProjectSettings;

import org.jetbrains.annotations.NotNull;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

import de.marhali.easyi18n.io.parser.ParserStrategyType;
import de.marhali.easyi18n.io.folder.FolderStrategyType;
import de.marhali.easyi18n.settings.NamingConvention;
import de.marhali.easyi18n.settings.ProjectSettings;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
Expand Down
1 change: 0 additions & 1 deletion src/main/resources/messages.properties
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ settings.experimental.flavor-template =I18n flavor template
settings.experimental.flavor-template-tooltip = Specify how to replace strings with i18n representation.
settings.experimental.key-naming-format.title=Key format of extracted translation
settings.experimental.key-naming-format.tooltip=Choose Naming Convention for the keys of extracted translation
settings.experimental.key-naming-format.items=Camel Case;Snake Case

error.io=An error occurred while processing translation files. \n\
Config: {0} => {1} ({2}) \n\
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import de.marhali.easyi18n.io.parser.ParserStrategyType;
import de.marhali.easyi18n.io.folder.FolderStrategyType;
import de.marhali.easyi18n.model.KeyPath;
import de.marhali.easyi18n.settings.NamingConvention;
import de.marhali.easyi18n.settings.presets.NamingConvention;
import de.marhali.easyi18n.settings.ProjectSettings;
import de.marhali.easyi18n.util.KeyPathConverter;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import de.marhali.easyi18n.io.parser.properties.SortableProperties;
import de.marhali.easyi18n.model.TranslationData;
import de.marhali.easyi18n.model.KeyPath;
import de.marhali.easyi18n.settings.NamingConvention;
import de.marhali.easyi18n.settings.presets.NamingConvention;
import de.marhali.easyi18n.settings.ProjectSettings;
import de.marhali.easyi18n.util.KeyPathConverter;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import com.intellij.util.xmlb.XmlSerializerUtil;

import de.marhali.easyi18n.settings.presets.DefaultPreset;
import de.marhali.easyi18n.settings.presets.NamingConvention;

/**
* Tests for the project settings service itself.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
package de.marhali.easyi18n.settings;

import com.google.common.base.CaseFormat;
import de.marhali.easyi18n.io.folder.FolderStrategyType;
import de.marhali.easyi18n.io.parser.ParserStrategyType;

import de.marhali.easyi18n.settings.presets.NamingConvention;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

Expand Down

0 comments on commit 340ab13

Please sign in to comment.