#525521653

Committed 26 Jul 2025 06:20AM UTC coverage: 82.193% (-0.09%) from 82.281%

Build # #525521653

Build Type

push

github

Committed by

hurricup

Commit Message

#3058 Implemented synchronizer for the TemplateToolkitSettings

Configurable moved to the backend, because it is a part of the backend-only Perl5SettingsConfigurable

Run Details

2 of 4 new or added lines in 2 files covered. (50.0%)

34 existing lines in 14 files now uncovered.

30981 of 37693 relevant lines covered (82.19%)

0.82 hits per line

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

96.43

/plugin/common/src/main/java/com/perl5/lang/perl/idea/configuration/settings/PerlSharedSettings.java

/*
 * Copyright 2015-2025 Alexandr Evstigneev
 *
 * 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 com.perl5.lang.perl.idea.configuration.settings;

import com.intellij.codeInsight.daemon.DaemonCodeAnalyzer;
import com.intellij.openapi.components.PersistentStateComponent;
import com.intellij.openapi.components.State;
import com.intellij.openapi.components.Storage;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.ClearableLazyValue;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiManager;
import com.intellij.util.containers.ContainerUtil;
import com.intellij.util.xmlb.XmlSerializerUtil;
import com.intellij.util.xmlb.annotations.Tag;
import com.intellij.util.xmlb.annotations.Transient;
import com.perl5.lang.perl.idea.PerlPathMacros;
import com.perl5.lang.perl.internals.PerlVersion;
import com.perl5.lang.perl.util.PerlUtil;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import static com.perl5.lang.perl.util.PerlScalarUtilCore.DEFAULT_SELF_NAME;


@State(
  name = "Perl5Settings",
  storages = @Storage(PerlPathMacros.PERL5_PROJECT_SHARED_SETTINGS_FILE),
  perClient = true
)
public final class PerlSharedSettings implements PersistentStateComponent<PerlSharedSettings> {
  public List<String> selfNames = PerlUtil.mutableList(DEFAULT_SELF_NAME, "this", "class", "proto");

  private final List<String> myWarningsProviders = new ArrayList<>();

  private final List<String> myStrictProviders = new ArrayList<>();

  public boolean SIMPLE_MAIN_RESOLUTION = true;
  public boolean AUTOMATIC_HEREDOC_INJECTIONS = true;
  public boolean ALLOW_INJECTIONS_WITH_INTERPOLATION = false;
  public boolean PERL_CRITIC_ENABLED = false;
  public boolean PERL_ANNOTATOR_ENABLED = false;
  public String PERL_DEPARSE_ARGUMENTS = "";
  public String PERL_TIDY_ARGS = "";
  public String PERL_CRITIC_ARGS = "";
  public boolean PERL_SWITCH_ENABLED = false;
  private PerlVersion myTargetPerlVersion = PerlVersion.V5_10;

  @Transient
  private Set<String> SELF_NAMES_SET = null;

  private final ClearableLazyValue<Set<String>> myWarningsProvidersSet = ClearableLazyValue.create(() -> Set.copyOf(myWarningsProviders));
  private final ClearableLazyValue<Set<String>> myStrictProvidersSet = ClearableLazyValue.create(() -> Set.copyOf(myStrictProviders));

  @Transient
  private final Project myProject;

  @SuppressWarnings("unused")
  private PerlSharedSettings() {
    this(null);
  }

  public PerlSharedSettings(Project project) {
    myProject = project;
    setWarningsProviders(ContainerUtil.concat(PerlStrictWarningsDefaults.DEFAULT_STRICT_AND_WARNINGS_PROVIDERS,
                                              PerlStrictWarningsDefaults.DEFAULT_WARNINGS_ONLY_PROVIDERS));
    setStrictProviders(ContainerUtil.concat(PerlStrictWarningsDefaults.DEFAULT_STRICT_AND_WARNINGS_PROVIDERS,
                                            PerlStrictWarningsDefaults.DEFAULT_STRICT_ONLY_PROVIDERS));
  }

  @Override
  public @NotNull PerlSharedSettings getState() {
    return this;
  }

  @Override
  public void loadState(@NotNull PerlSharedSettings state) {
    XmlSerializerUtil.copyBean(state, this);
  }

  public @NotNull PerlVersion getTargetPerlVersion() {
    return myTargetPerlVersion;
  }

  public @NotNull PerlSharedSettings setTargetPerlVersion(@NotNull PerlVersion targetPerlVersion) {
    myTargetPerlVersion = targetPerlVersion;
    return this;
  }

  public void settingsUpdated() {
    SELF_NAMES_SET = null;
    PsiManager.getInstance(myProject).dropResolveCaches();
    DaemonCodeAnalyzer.getInstance(myProject).restart();
  }

  public boolean isSelfName(String name) {
    if (SELF_NAMES_SET == null) {
      SELF_NAMES_SET = new HashSet<>(selfNames);
    }
    return SELF_NAMES_SET.contains(name);
  }

  public void setStrictProviders(@NotNull List<String> strictProviders) {
    myStrictProviders.clear();
    myStrictProviders.addAll(ContainerUtil.sorted(strictProviders));
    myStrictProvidersSet.drop();
  }

  @Contract("null->false")
  public boolean isStrictProvider(@Nullable String packageName) {
    return packageName != null && myStrictProvidersSet.getValue().contains(packageName);
  }

  public void setWarningsProviders(@NotNull List<String> warningsProviders) {
    myWarningsProviders.clear();
    myWarningsProviders.addAll(ContainerUtil.sorted(warningsProviders));
    myWarningsProvidersSet.drop();
  }

  @Contract("null->false")
  public boolean isWarningsProvider(@Nullable String packageName) {
    return packageName != null && myWarningsProvidersSet.getValue().contains(packageName);
  }

  public void setDeparseOptions(String optionsString) {
    while (!optionsString.isEmpty() && optionsString.charAt(0) != '-') {
      optionsString = optionsString.substring(1);
    }
    PERL_DEPARSE_ARGUMENTS = optionsString;
  }

  @Override
  public void noStateLoaded() {
    loadState(new PerlSharedSettings());
  }

  public static @NotNull PerlSharedSettings getInstance(@NotNull Project project) {
    return project.getService(PerlSharedSettings.class);
  }

  public static @NotNull PerlSharedSettings getInstance(@NotNull PsiElement psiElement) {
    return getInstance(psiElement.getProject());
  }

  @Tag("WARNING_PROVIDERS")
  public @NotNull List<String> getWarningsProviders() {
    return List.copyOf(myWarningsProviders);
  }

  @Tag("STRICT_PROVIDERS")
  public @NotNull List<String> getStrictProviders() {
    return List.copyOf(myStrictProviders);
  }
}

1	/*
2	* Copyright 2015-2025 Alexandr Evstigneev
3	*
4	* Licensed under the Apache License, Version 2.0 (the "License");
5	* you may not use this file except in compliance with the License.
6	* You may obtain a copy of the License at
7	*
8	* http://www.apache.org/licenses/LICENSE-2.0
9	*
10	* Unless required by applicable law or agreed to in writing, software
11	* distributed under the License is distributed on an "AS IS" BASIS,
12	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13	* See the License for the specific language governing permissions and
14	* limitations under the License.
15	*/
16
17	package com.perl5.lang.perl.idea.configuration.settings;
18
19	import com.intellij.codeInsight.daemon.DaemonCodeAnalyzer;
20	import com.intellij.openapi.components.PersistentStateComponent;
21	import com.intellij.openapi.components.State;
22	import com.intellij.openapi.components.Storage;
23	import com.intellij.openapi.project.Project;
24	import com.intellij.openapi.util.ClearableLazyValue;
25	import com.intellij.psi.PsiElement;
26	import com.intellij.psi.PsiManager;
27	import com.intellij.util.containers.ContainerUtil;
28	import com.intellij.util.xmlb.XmlSerializerUtil;
29	import com.intellij.util.xmlb.annotations.Tag;
30	import com.intellij.util.xmlb.annotations.Transient;
31	import com.perl5.lang.perl.idea.PerlPathMacros;
32	import com.perl5.lang.perl.internals.PerlVersion;
33	import com.perl5.lang.perl.util.PerlUtil;
34	import org.jetbrains.annotations.Contract;
35	import org.jetbrains.annotations.NotNull;
36	import org.jetbrains.annotations.Nullable;
37
38	import java.util.ArrayList;
39	import java.util.HashSet;
40	import java.util.List;
41	import java.util.Set;
42
43	import static com.perl5.lang.perl.util.PerlScalarUtilCore.DEFAULT_SELF_NAME;
44
45
46	@State(
47	name = "Perl5Settings",
48	storages = @Storage(PerlPathMacros.PERL5_PROJECT_SHARED_SETTINGS_FILE),
49	perClient = true
50	)
51	public final class PerlSharedSettings implements PersistentStateComponent<PerlSharedSettings> {
52	public List<String> selfNames = PerlUtil.mutableList(DEFAULT_SELF_NAME, "this", "class", "proto");	1✔
53
54	private final List<String> myWarningsProviders = new ArrayList<>();	1✔
55
56	private final List<String> myStrictProviders = new ArrayList<>();	1✔
57
58	public boolean SIMPLE_MAIN_RESOLUTION = true;	1✔
59	public boolean AUTOMATIC_HEREDOC_INJECTIONS = true;	1✔
60	public boolean ALLOW_INJECTIONS_WITH_INTERPOLATION = false;	1✔
61	public boolean PERL_CRITIC_ENABLED = false;	1✔
62	public boolean PERL_ANNOTATOR_ENABLED = false;	1✔
63	public String PERL_DEPARSE_ARGUMENTS = "";	1✔
64	public String PERL_TIDY_ARGS = "";	1✔
65	public String PERL_CRITIC_ARGS = "";	1✔
66	public boolean PERL_SWITCH_ENABLED = false;	1✔
67	private PerlVersion myTargetPerlVersion = PerlVersion.V5_10;	1✔
68
69	@Transient	1✔
70	private Set<String> SELF_NAMES_SET = null;
71
72	private final ClearableLazyValue<Set<String>> myWarningsProvidersSet = ClearableLazyValue.create(() -> Set.copyOf(myWarningsProviders));	1✔
73	private final ClearableLazyValue<Set<String>> myStrictProvidersSet = ClearableLazyValue.create(() -> Set.copyOf(myStrictProviders));	1✔
74
75	@Transient
76	private final Project myProject;
77
78	@SuppressWarnings("unused")
79	private PerlSharedSettings() {
80	this(null);	1✔
81	}	1✔
82
83	public PerlSharedSettings(Project project) {	1✔
84	myProject = project;	1✔
85	setWarningsProviders(ContainerUtil.concat(PerlStrictWarningsDefaults.DEFAULT_STRICT_AND_WARNINGS_PROVIDERS,	1✔
86	PerlStrictWarningsDefaults.DEFAULT_WARNINGS_ONLY_PROVIDERS));
87	setStrictProviders(ContainerUtil.concat(PerlStrictWarningsDefaults.DEFAULT_STRICT_AND_WARNINGS_PROVIDERS,	1✔
88	PerlStrictWarningsDefaults.DEFAULT_STRICT_ONLY_PROVIDERS));
89	}	1✔
90
91	@Override
92	public @NotNull PerlSharedSettings getState() {
UNCOV 93	return this;	×
94	}
95
96	@Override
97	public void loadState(@NotNull PerlSharedSettings state) {
98	XmlSerializerUtil.copyBean(state, this);	1✔
99	}	1✔
100
101	public @NotNull PerlVersion getTargetPerlVersion() {
102	return myTargetPerlVersion;	1✔
103	}
104
105	public @NotNull PerlSharedSettings setTargetPerlVersion(@NotNull PerlVersion targetPerlVersion) {
106	myTargetPerlVersion = targetPerlVersion;	1✔
107	return this;	1✔
108	}
109
110	public void settingsUpdated() {
111	SELF_NAMES_SET = null;	1✔
112	PsiManager.getInstance(myProject).dropResolveCaches();	1✔
113	DaemonCodeAnalyzer.getInstance(myProject).restart();	1✔
114	}	1✔
115
116	public boolean isSelfName(String name) {
117	if (SELF_NAMES_SET == null) {	1✔
118	SELF_NAMES_SET = new HashSet<>(selfNames);	1✔
119	}
120	return SELF_NAMES_SET.contains(name);	1✔
121	}
122
123	public void setStrictProviders(@NotNull List<String> strictProviders) {
124	myStrictProviders.clear();	1✔
125	myStrictProviders.addAll(ContainerUtil.sorted(strictProviders));	1✔
126	myStrictProvidersSet.drop();	1✔
127	}	1✔
128
129	@Contract("null->false")
130	public boolean isStrictProvider(@Nullable String packageName) {
131	return packageName != null && myStrictProvidersSet.getValue().contains(packageName);	1✔
132	}
133
134	public void setWarningsProviders(@NotNull List<String> warningsProviders) {
135	myWarningsProviders.clear();	1✔
136	myWarningsProviders.addAll(ContainerUtil.sorted(warningsProviders));	1✔
137	myWarningsProvidersSet.drop();	1✔
138	}	1✔
139
140	@Contract("null->false")
141	public boolean isWarningsProvider(@Nullable String packageName) {
142	return packageName != null && myWarningsProvidersSet.getValue().contains(packageName);	1✔
143	}
144
145	public void setDeparseOptions(String optionsString) {
146	while (!optionsString.isEmpty() && optionsString.charAt(0) != '-') {	1✔
UNCOV 147	optionsString = optionsString.substring(1);	×
148	}
149	PERL_DEPARSE_ARGUMENTS = optionsString;	1✔
150	}	1✔
151
152	@Override
153	public void noStateLoaded() {
154	loadState(new PerlSharedSettings());	1✔
155	}	1✔
156
157	public static @NotNull PerlSharedSettings getInstance(@NotNull Project project) {
158	return project.getService(PerlSharedSettings.class);	1✔
159	}
160
161	public static @NotNull PerlSharedSettings getInstance(@NotNull PsiElement psiElement) {
162	return getInstance(psiElement.getProject());	1✔
163	}
164
165	@Tag("WARNING_PROVIDERS")
166	public @NotNull List<String> getWarningsProviders() {
167	return List.copyOf(myWarningsProviders);	1✔
168	}
169
170	@Tag("STRICT_PROVIDERS")
171	public @NotNull List<String> getStrictProviders() {
172	return List.copyOf(myStrictProviders);	1✔
173	}
174	}

Camelcade / Perl5-IDEA / #525521653

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