[INTERNAL] code cleanup, wording, readme & version update

SeeSharpSoft · SeeSharpSoft · commit 4744d3eacba2 · 2020-07-21T20:08:32.000+02:00
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,9 @@
+2.14.0
+
+NEW: Predefined column colors (Rainbow-style)
+NEW: Enhanced color scheme switch
+NEW: Table Editor coloring
+
 2.13.0
 Jul 20, 2020
 
diff --git a/README.md b/README.md
@@ -155,6 +155,15 @@ Please note:
 
 Enable zero-based column numbering. This affects the tooltip info of the text editor as well as column numbering of the table editor.
 
+##### Value coloring
+
+Choose the coloring method of values. Possible options are:
+
+- _Rainbow (Column Color)_ - values are colored based on their column.
+- _Simple (Text Color)_ - values are colored based on the defined text color.
+
+All colors can be adjusted via [CSV Color Scheme](#color-scheme) settings.
+
 #### Text Editor
 
 ##### Highlighting
@@ -163,10 +172,6 @@ Enable zero-based column numbering. This affects the tooltip info of the text ed
 
 The highlighting of the current caret row might interfere with custom background color settings and can be enabled/disabled for CSV/TSV/PSV files here.
 
-###### Enable column highlighting
-
-An easy way to switch *Column Highlighting* on or off (in text editor).
-
 ###### Highlight tab separator
 
 Enable/disable highlighting (and choose the highlight color) of tab characters (&#8633;) in their role as value separator (TSV). Tabs as part of a value are therefore not highlighted on purpose.
@@ -205,7 +210,7 @@ The maximum width of a single table column in _px_, which is used when adjusting
 
 If selected, the table column widths are adjusted based on the column contents automatically when the table editor is opened. This setting can be changed in the table editor itself per file. 
 
-##### Keep/ignore linebreak at end of file
+##### Keep/ignore linebreak at file end
 
 If the file ends with a completely empty line (no spaces or tabs either), the table editor will not show this line as empty values but ignore it. When table data is serialized, an existing empty line is kept at the end of the file.
 
@@ -217,23 +222,22 @@ Enables/disables the info panel at the bottom of the table editor.
 
 Always quotes a single value on save - even if not required.
 
-##### Enable column highlighting
-
-An easy way to switch *Column Highlighting* on or off (in table editor).
-
 ### Color Scheme
 
-The different symbols of a CSV document, namely the separator (comma), the quotes, the escaped literals and the text elements itself, are highlighted by a coloring scheme that can be customized:
+The different symbols of a CSV document, namely the *separator* (e.g. comma, pipe, semicolon), the *quote* character, the *escaped literals* and the *text* elements itself, are colored based on the CSV color scheme settings:
 
-- _File > Settings > Editor > Color Scheme > CSV_
+- _File > Settings > Editor > Color Scheme > CSV/TSV/PSV_
 
 Preset colors are based on Jetbrains IDE defaults and support the different UI themes.
 
 ![Color scheme settings](./docs/colorsettings.png)
 
-#### Column Highlighting Colors
+#### Column Colors
+
+Besides the colors and font-style variants for the different CSV symbols, additionally up to 10 different column colors can be defined.
+Those colors are applied to the columns round robin.
+Column colors are taken into account when **Rainbow** is selected as [**Value Coloring**](#value-coloring) option in the [Editor Settings](#editor-settings).
 
-Besides defining colors and font-style variants for the different CSV symbols, additionally up to 10 different column highlight colors can be defined. Those colors are applied to the columns round robin. Undefined column highlight colors will be skipped if they are not followed by any other color definition.
 
 ### Formatting
 
diff --git a/build.gradle b/build.gradle
@@ -24,7 +24,7 @@ jacocoTestReport {
 }
 
 group 'net.seesharpsoft.intellij.plugins'
-version '2.13.0'
+version '2.14.0'
 
 apply plugin: 'java'
 sourceCompatibility = javaVersion
diff --git a/docs/colorsettings.png b/docs/colorsettings.png
diff --git a/docs/example.png b/docs/example.png
diff --git a/src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvPlugin.java b/src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvPlugin.java
@@ -31,8 +31,6 @@ protected static String getChangeNotes() {
         return getPluginDescriptor().getChangeNotes();
     }
 
-    private static final String SETTINGS_URL = "#Settings";
-
     private static void openLink(Project project, String link) {
         if (!project.isDisposed() && link.startsWith("#")) {
             ((ShowSettingsUtilImpl)ShowSettingsUtil.getInstance()).showSettingsDialog(project, link.substring(1), null);
diff --git a/src/main/java/net/seesharpsoft/intellij/plugins/csv/editor/CsvAnnotator.java b/src/main/java/net/seesharpsoft/intellij/plugins/csv/editor/CsvAnnotator.java
@@ -67,7 +67,7 @@ public void annotate(@NotNull final PsiElement element, @NotNull final Annotatio
 
             Annotation annotation = holder.createAnnotation(CSV_COLUMN_INFO_SEVERITY, textRange, message, tooltip);
             annotation.setEnforcedTextAttributes(
-                    CsvEditorSettings.getInstance().getColumnColoring() == CsvEditorSettings.ColumnColoring.RAINBOW ?
+                    CsvEditorSettings.getInstance().getValueColoring() == CsvEditorSettings.ValueColoring.RAINBOW ?
                             CsvColorSettings.getTextAttributesOfColumn(columnInfo.getColumnIndex(), holder.getCurrentAnnotationSession()) :
                             null
             );
diff --git a/src/main/java/net/seesharpsoft/intellij/plugins/csv/settings/CsvColorSettings.java b/src/main/java/net/seesharpsoft/intellij/plugins/csv/settings/CsvColorSettings.java
@@ -42,7 +42,7 @@ public class CsvColorSettings implements ColorSettingsPage {
         for (int i = 0; i < MAX_COLUMN_COLORING_COLORS; ++i) {
             TextAttributesKey textAttributesKey = createTextAttributesKey(String.format("CSV_PLUGIN_COLUMN_COLORING_ATTRIBUTE_%d", i + 1), CsvSyntaxHighlighter.TEXT);
             COLUMN_COLORING_ATTRIBUTES.add(textAttributesKey);
-            attributesDescriptors.add(new AttributesDescriptor(String.format("Rainbow Coloring %d", i + 1), textAttributesKey));
+            attributesDescriptors.add(new AttributesDescriptor(String.format("Column Color %d", i + 1), textAttributesKey));
         }
         DESCRIPTORS = attributesDescriptors.toArray(new AttributesDescriptor[attributesDescriptors.size()]);
     }
@@ -53,15 +53,15 @@ public static TextAttributes getTextAttributesOfColumn(int columnIndex, UserData
             EditorColorsScheme editorColorsScheme = EditorColorsManager.getInstance().getGlobalScheme();
             textAttributeList = new ArrayList<>();
             int maxIndex = 0;
-            switch(CsvEditorSettings.getInstance().getColumnColoring()) {
+            switch(CsvEditorSettings.getInstance().getValueColoring()) {
                 case RAINBOW:
                     maxIndex = applyColumnTextAttributes(editorColorsScheme, textAttributeList);
                     break;
                 case SIMPLE:
                     textAttributeList.add(editorColorsScheme.getAttributes(CsvSyntaxHighlighter.TEXT));
                     break;
                 default:
-                    throw new UnhandledSwitchCaseException(CsvEditorSettings.getInstance().getColumnColoring());
+                    throw new UnhandledSwitchCaseException(CsvEditorSettings.getInstance().getValueColoring());
             }
             textAttributeList = textAttributeList.subList(0, maxIndex + 1);
             userDataHolder.putUserData(COLUMN_COLORING_TEXT_ATTRIBUTES_KEY, textAttributeList);
diff --git a/src/main/java/net/seesharpsoft/intellij/plugins/csv/settings/CsvEditorSettings.java b/src/main/java/net/seesharpsoft/intellij/plugins/csv/settings/CsvEditorSettings.java
@@ -40,13 +40,13 @@ public enum EditorPrio {
         TEXT_ONLY
     }
 
-    public enum ColumnColoring {
-        RAINBOW("Rainbow (colorful columns)"),
-        SIMPLE("Simple (single text color)");
+    public enum ValueColoring {
+        RAINBOW("Rainbow (Column Color)"),
+        SIMPLE("Simple (Text Color)");
 
         private final String display;
 
-        ColumnColoring(String displayArg) {
+        ValueColoring(String displayArg) {
             this.display = displayArg;
         }
 
@@ -79,7 +79,7 @@ public static final class OptionSet {
         public CsvValueSeparator DEFAULT_VALUE_SEPARATOR = VALUE_SEPARATOR_DEFAULT;
         public boolean KEEP_TRAILING_SPACES = false;
         public String COMMENT_INDICATOR = COMMENT_INDICATOR_DEFAULT;
-        public ColumnColoring COLUMN_COLORING = ColumnColoring.RAINBOW;
+        public ValueColoring VALUE_COLORING = ValueColoring.RAINBOW;
 
         public OptionSet() {
             EditorSettingsExternalizable editorSettingsExternalizable = EditorSettingsExternalizable.getInstance();
@@ -285,20 +285,19 @@ public String getCommentIndicator() {
         return getState().COMMENT_INDICATOR;
     }
 
-    public ColumnColoring getColumnColoring() {
-        return getState().COLUMN_COLORING;
+    public ValueColoring getValueColoring() {
+        return getState().VALUE_COLORING;
     }
 
-    public void setColumnColoring(ColumnColoring columnColoring) {
-        getState().COLUMN_COLORING = columnColoring;
+    public void setValueColoring(ValueColoring valueColoring) {
+        getState().VALUE_COLORING = valueColoring;
     }
 
     public boolean checkCurrentPluginVersion(String actualVersion) {
-        return false;
-//        if (!actualVersion.equals(getState().CURRENT_PLUGIN_VERSION)) {
-//            getState().CURRENT_PLUGIN_VERSION = actualVersion;
-//            return false;
-//        }
-//        return true;
+        if (!actualVersion.equals(getState().CURRENT_PLUGIN_VERSION)) {
+            getState().CURRENT_PLUGIN_VERSION = actualVersion;
+            return false;
+        }
+        return true;
     }
 }
diff --git a/src/main/java/net/seesharpsoft/intellij/plugins/csv/settings/CsvEditorSettingsProvider.form b/src/main/java/net/seesharpsoft/intellij/plugins/csv/settings/CsvEditorSettingsProvider.form
@@ -379,7 +379,7 @@
               <grid row="0" column="0" row-span="1" col-span="1" vsize-policy="0" hsize-policy="0" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
             </constraints>
             <properties>
-              <text value="Line comment indicator (e.g. # or //):"/>
+              <text value="Line comment indicator:"/>
             </properties>
           </component>
           <component id="a30e" class="javax.swing.JTextField" binding="tfCommentIndicator">
@@ -410,10 +410,10 @@
               <grid row="0" column="0" row-span="1" col-span="1" vsize-policy="0" hsize-policy="0" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
             </constraints>
             <properties>
-              <text value="Column Coloring:"/>
+              <text value="Value Coloring:"/>
             </properties>
           </component>
-          <component id="2e9e9" class="javax.swing.JComboBox" binding="comboColumnColoring" custom-create="true">
+          <component id="2e9e9" class="javax.swing.JComboBox" binding="comboValueColoring" custom-create="true">
             <constraints>
               <grid row="0" column="1" row-span="1" col-span="1" vsize-policy="0" hsize-policy="2" anchor="8" fill="1" indent="0" use-parent-layout="false"/>
             </constraints>
diff --git a/src/main/java/net/seesharpsoft/intellij/plugins/csv/settings/CsvEditorSettingsProvider.java b/src/main/java/net/seesharpsoft/intellij/plugins/csv/settings/CsvEditorSettingsProvider.java
@@ -41,7 +41,7 @@ public class CsvEditorSettingsProvider implements EditorOptionsProvider {
     private JComboBox comboValueSeparator;
     private JCheckBox cbKeepTrailingWhitespaces;
     private JTextField tfCommentIndicator;
-    private JComboBox comboColumnColoring;
+    private JComboBox comboValueColoring;
 
     @NotNull
     @Override
@@ -92,7 +92,7 @@ public boolean isModified() {
                 !Objects.equals(comboValueSeparator.getSelectedItem(), csvEditorSettings.getDefaultValueSeparator()) ||
                 isModified(cbKeepTrailingWhitespaces, csvEditorSettings.getKeepTrailingSpaces()) ||
                 isModified(tfCommentIndicator, csvEditorSettings.getCommentIndicator()) ||
-                !Objects.equals(comboColumnColoring.getSelectedItem(), csvEditorSettings.getColumnColoring());
+                !Objects.equals(comboValueColoring.getSelectedItem(), csvEditorSettings.getValueColoring());
     }
 
     @Override
@@ -116,7 +116,7 @@ public void reset() {
         comboValueSeparator.setSelectedItem(csvEditorSettings.getDefaultValueSeparator());
         cbKeepTrailingWhitespaces.setSelected(csvEditorSettings.getKeepTrailingSpaces());
         tfCommentIndicator.setText(csvEditorSettings.getCommentIndicator());
-        comboColumnColoring.setSelectedItem(csvEditorSettings.getColumnColoring());
+        comboValueColoring.setSelectedItem(csvEditorSettings.getValueColoring());
     }
 
     @Override
@@ -140,7 +140,7 @@ public void apply() throws ConfigurationException {
         csvEditorSettings.setDefaultValueSeparator((CsvValueSeparator)comboValueSeparator.getSelectedItem());
         csvEditorSettings.setKeepTrailingSpaces(cbKeepTrailingWhitespaces.isSelected());
         csvEditorSettings.setCommentIndicator(tfCommentIndicator.getText());
-        csvEditorSettings.setColumnColoring((CsvEditorSettings.ColumnColoring)comboColumnColoring.getSelectedItem());
+        csvEditorSettings.setValueColoring((CsvEditorSettings.ValueColoring) comboValueColoring.getSelectedItem());
     }
 
     protected void createUIComponents() {
@@ -150,8 +150,8 @@ protected void createUIComponents() {
         comboValueSeparator = new ComboBox(CsvValueSeparator.values());
         comboValueSeparator.setRenderer(new CustomDisplayListCellRenderer<CsvValueSeparator>(ec -> ec.getDisplay()));
 
-        comboColumnColoring = new ComboBox(CsvEditorSettings.ColumnColoring.values());
-        comboColumnColoring.setRenderer(new CustomDisplayListCellRenderer<CsvEditorSettings.ColumnColoring>(ec -> ec.getDisplay()));
+        comboValueColoring = new ComboBox(CsvEditorSettings.ValueColoring.values());
+        comboValueColoring.setRenderer(new CustomDisplayListCellRenderer<CsvEditorSettings.ValueColoring>(ec -> ec.getDisplay()));
 
         cbTabHighlightColor = new CheckBoxWithColorChooser("Highlight tab separator   ");
         cbTabHighlightColor.setColor(Color.CYAN);
diff --git a/src/test/java/net/seesharpsoft/intellij/plugins/csv/settings/CsvEditorSettingsProviderTest.java b/src/test/java/net/seesharpsoft/intellij/plugins/csv/settings/CsvEditorSettingsProviderTest.java
@@ -78,7 +78,7 @@ public void testResetAndModified() throws ConfigurationException {
         csvEditorSettings.setDefaultValueSeparator(CsvValueSeparator.PIPE);
         csvEditorSettings.setKeepTrailingSpaces(true);
         csvEditorSettings.setCommentIndicator("//");
-        csvEditorSettings.setColumnColoring(CsvEditorSettings.ColumnColoring.SIMPLE);
+        csvEditorSettings.setValueColoring(CsvEditorSettings.ValueColoring.SIMPLE);
 
         assertEquals(true, editorSettingsPanel.isModified());
 
@@ -101,7 +101,7 @@ public void testResetAndModified() throws ConfigurationException {
         assertEquals(CsvValueSeparator.PIPE, csvEditorSettings.getDefaultValueSeparator());
         assertEquals(true, csvEditorSettings.getKeepTrailingSpaces());
         assertEquals("//", csvEditorSettings.getCommentIndicator());
-        assertEquals( CsvEditorSettings.ColumnColoring.SIMPLE, csvEditorSettings.getColumnColoring());
+        assertEquals( CsvEditorSettings.ValueColoring.SIMPLE, csvEditorSettings.getValueColoring());
 
         editorSettingsPanel.disposeUIResources();
     }
@@ -146,7 +146,7 @@ public void testApply() throws ConfigurationException {
         assertEquals(freshOptionSet.DEFAULT_VALUE_SEPARATOR, csvEditorSettings.getDefaultValueSeparator());
         assertEquals(freshOptionSet.KEEP_TRAILING_SPACES, csvEditorSettings.getKeepTrailingSpaces());
         assertEquals(freshOptionSet.COMMENT_INDICATOR, csvEditorSettings.getCommentIndicator());
-        assertEquals(freshOptionSet.COLUMN_COLORING, csvEditorSettings.getColumnColoring());
+        assertEquals(freshOptionSet.VALUE_COLORING, csvEditorSettings.getValueColoring());
 
         editorSettingsPanel.disposeUIResources();
     }

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ jacocoTestReport {`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`group 'net.seesharpsoft.intellij.plugins'`
`27`		`-version '2.13.0'`
	`27`	`+version '2.14.0'`
`28`	`28`
`29`	`29`	`apply plugin: 'java'`
`30`	`30`	`sourceCompatibility = javaVersion`
Original file line number	Diff line number	Diff line change
`@@ -31,8 +31,6 @@ protected static String getChangeNotes() {`
`31`	`31`	`return getPluginDescriptor().getChangeNotes();`
`32`	`32`	`}`
`33`	`33`
`34`		`- private static final String SETTINGS_URL = "#Settings";`
`35`		`-`
`36`	`34`	`private static void openLink(Project project, String link) {`
`37`	`35`	`if (!project.isDisposed() && link.startsWith("#")) {`
`38`	`36`	`((ShowSettingsUtilImpl)ShowSettingsUtil.getInstance()).showSettingsDialog(project, link.substring(1), null);`