1c/v8-code-style
1
0
Fork 0
mirror of https://github.com/1C-Company/v8-code-style.git synced 2025-02-22 00:13:11 +02:00
Code Issues Releases Activity

Merge remote-tracking branch 'origin/master' into edt-2023-1

Browse Source
This commit is contained in:
Almaz Nasibullin 2023-01-12 10:05:49 +03:00
commit ebe5e46066
13 changed files with 214 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -43,6 +43,7 @@
### Исправленные ошибки
- Стандарт 492: Добавить исключение в module-unused-method для процедур подключаемых из кода с префиксом "Подключаемый_" #1141
- Стандарт 644: Исправлена ситуация при которой для вложенных областей в устаревшую область диагностировалась ошибка
## 0.3.0

37
bundles/com.e1c.v8codestyle.bsl/src/com/e1c/v8codestyle/bsl/check/AbstractModuleStructureCheck.java
View File

@ -99,6 +99,43 @@ public abstract class AbstractModuleStructureCheck
return Optional.empty();
}
/**
* Gets the parent region by name of this object located inside the region.
*
* @param object the object to find the first parent region, cannot be {@code null}.
* @param name the name of finded parent region, cannot be {@code null}.
* @return the parent region, cannot return {@code null}.
*/
protected Optional<RegionPreprocessor> getParentRegionByName(EObject object, String name)
{
EObject parent = object.eContainer();
PreprocessorItem lastItem = null;
RegionPreprocessor region = null;
do
{
if (parent instanceof RegionPreprocessor)
{
RegionPreprocessor parentRegion = (RegionPreprocessor)parent;
if (lastItem != null && parentRegion.getItem().equals(lastItem) && parentRegion.getName().equals(name))
{
region = parentRegion;
}
else
{
lastItem = null;
}
}
else if (parent instanceof PreprocessorItem)
{
lastItem = (PreprocessorItem)parent;
}
parent = parent.eContainer();
}
while (parent != null);
return Optional.ofNullable(region);
}
/**
* Gets the top parent region.
*

5
bundles/com.e1c.v8codestyle.bsl/src/com/e1c/v8codestyle/bsl/check/DeprecatedProcedureOutsideDeprecatedRegionCheck.java
View File

@ -102,8 +102,9 @@ public class DeprecatedProcedureOutsideDeprecatedRegionCheck
.orElse(null);
if (defMethod != null && defMethod.isDeprecated()
&& !verifyLocationForDeprecated(getFirstParentRegion(method), getTopParentRegion(method),
scriptVariant))
&& !verifyLocationForDeprecated(
getParentRegionByName(method, ModuleStructureSection.DEPRECATED_REGION.getName(scriptVariant)),
getTopParentRegion(method), scriptVariant))
{
resultAceptor.addIssue(MessageFormat.format(
Messages.DeprecatedProcedureOutsideDeprecatedRegionCheck_Deprecated_function_out_of_deprecated_area,

30
bundles/com.e1c.v8codestyle.md/src/com/e1c/v8codestyle/md/check/RegisterResourcePrecisionCheck.java
View File

@ -20,9 +20,13 @@ import static com._1c.g5.v8.dt.metadata.mdclass.MdClassPackage.Literals.ACCUMULA
import java.text.MessageFormat;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.emf.ecore.EObject;
import com._1c.g5.v8.dt.mcore.TypeDescription;
import com._1c.g5.v8.dt.mcore.util.McoreUtil;
import com._1c.g5.v8.dt.metadata.mdclass.DefinedType;
import com._1c.g5.v8.dt.metadata.mdclass.RegisterResource;
import com._1c.g5.v8.dt.platform.IEObjectTypeNames;
import com.e1c.g5.v8.dt.check.CheckComplexity;
import com.e1c.g5.v8.dt.check.ICheckParameters;
import com.e1c.g5.v8.dt.check.components.BasicCheck;
@ -84,8 +88,26 @@ public final class RegisterResourcePrecisionCheck
return;
}
TypeDescription td = (TypeDescription)object;
if (!(td.eContainer() instanceof RegisterResource))
TypeDescription initialTypeDescription = (TypeDescription)object;
if (!(initialTypeDescription.eContainer() instanceof RegisterResource))
{
return;
}
TypeDescription td = initialTypeDescription;
if (td.getTypes().size() == 1
&& IEObjectTypeNames.DEFINED_TYPE.equals(McoreUtil.getTypeCategory(td.getTypes().get(0))))
{
EObject definedType = td.getTypes().get(0).eContainer();
while (definedType != null && !(definedType instanceof DefinedType))
{
definedType = definedType.eContainer();
}
if (definedType instanceof DefinedType)
{
td = ((DefinedType)definedType).getType();
}
}
if (td.getNumberQualifiers() == null)
{
return;
}
@ -95,10 +117,10 @@ public final class RegisterResourcePrecisionCheck
if (precision > maxPrecision)
{
RegisterResource resource = (RegisterResource)(td.eContainer());
RegisterResource resource = (RegisterResource)(initialTypeDescription.eContainer());
resultAceptor.addIssue(
MessageFormat.format(Messages.RegisterResourcePrecisionCheck_message, resource.getName(), maxPrecision),
td);
initialTypeDescription);
}
}
}

20
docs/checks/code_typification.md
View File

@ -1261,26 +1261,21 @@ ReturnSection: # Секция описания возвращаемого з
```bsl
// Возвращаемое значение:
// СписокЗначений из ДокументОбъект:
// СписокЗначений из ЭлементСпискаЗначений:
// * Значение - ДокументОбъект
Функция НовыйСписокДокументов()
Возврат Новый СписокЗначений;
КонецФункции
```
```bsl
МояПереременная = Новый СписокЗначений; // СписокЗначений из Строка - тут так не сработает
```
ПРАВИЛЬНО:
```bsl
// Функция-конструктор нового пустого объекта даннных
//
// Возвращаемое значение:
// СписокЗначений из ЭлементСпискаЗначений:
// * Значение - ДокументОбъект
// СписокЗначений из ДокументОбъект:
Функция НовыйСписокДокументов()
Возврат Новый СписокЗначений;
КонецФункции
@ -1298,14 +1293,17 @@ ReturnSection: # Секция описания возвращаемого з
```
```bsl
МояПереременная = Новый СписокЗначений; // СписокЗначений из Строка
```
ПРАВИЛЬНО:
```bsl
// Функция-получатель объекта данных
//
// Возвращаемое значение:
// СписокЗначений из ЭлементСпискаЗначений:
// * Значение - ДокументОбъект
// СписокЗначений из ДокументОбъект
Функция ПолучитьСписокДокументов()
СписокДокументов = Новый СписокЗначений;
// Заполняем список данными
@ -1320,7 +1318,7 @@ ReturnSection: # Секция описания возвращаемого з
```bsl
// Создаем данные фукнцией-конструтором и заполняем
// Создаем данные фукнцией-конструктором и заполняем
Данные = НовыйСписокДокументов();
...
ПоместитьВоВременноеХранилище(Адрес, Данные);

4
docs/contributing/commits.md
View File

@ -10,7 +10,7 @@
```
#<НОМЕР ЗАДАЧИ> Короткое сообщение что сделано
Длинное сообщение что сделано
Длинное сообщение что сделано.
```
1. Начинаем с номера задачи (например, #12311). Идентификатор необходим для интеграции с задачами GitHub
@ -49,4 +49,4 @@
Стоит ли делать один коммит на фичу - зависит от фичи. Коммит - логически завершенное изменение, а сложная фича может содержать много таких изменений, слияние которых в один коммит, приводит к потере информации о деталях ее выполнения. Это касается не только фич.
Squash'ить коммиты стоит, если были сделаны лишнее изменения, которые в следующих коммитах отменили. Так же, стоит избегать коммитов вида "Поднятие версий", которые не являются самостоятельными (вызваны другими изменениями, без них билд проекта не будет выполнен).

18
tests/com.e1c.v8codestyle.bsl.itests/resources/deprecated-method-nested-region-compliant.bsl Normal file
View File

@ -0,0 +1,18 @@
#Region Public
#Region Deprecated
#Region NestedRegion
// Deprecated. Instead, use SupportedProcedure
Procedure DeprecatedProcedure() Export
DeprecatedProcedure()
EndProcedure
#EndRegion
#EndRegion
#EndRegion

15
tests/com.e1c.v8codestyle.bsl.itests/src/com/e1c/v8codestyle/bsl/check/itests/DeprecatedProcedureOutsideDeprecatedRegionCheckTest.java
View File

@ -55,6 +55,21 @@ public class DeprecatedProcedureOutsideDeprecatedRegionCheckTest
assertTrue(markers.isEmpty());
}
/**
* Test a deprecated method is placed a nested region in the Deprecated region of the Public region
* in a common module area
*
* @throws Exception the exception
*/
@Test
public void testCompliantNestedRegionDeprecatedMethod() throws Exception
{
updateModule(FOLDER_RESOURCE + "deprecated-method-nested-region-compliant.bsl");
List<Marker> markers = getModuleMarkers();
assertTrue(markers.isEmpty());
}
/**
* Test a non-export deprecated method
*

18
tests/com.e1c.v8codestyle.md.itests/src/com/e1c/v8codestyle/md/check/itests/RegisterResourcePrecisionTest.java
View File

@ -71,4 +71,22 @@ public class RegisterResourcePrecisionTest
Marker marker = getFirstNestedMarker(CHECK_ID, object.bmGetId(), dtProject);
assertNotNull(marker);
}
/**
* Test that accounting register resource precision longer than maximal length in user defined type
*
* @throws Exception the exception
*/
@Test
public void testAccountingRegisterResourceWithDefinedTypePrecision() throws Exception
{
IDtProject dtProject = openProjectAndWaitForValidationFinish(PROJECT_NAME);
assertNotNull(dtProject);
IBmObject object = getTopObjectByFqn("AccountingRegister.AccountingRegisterWithDefinedTypeTest", dtProject);
assertNotNull(object);
Marker marker = getFirstNestedMarker(CHECK_ID, object.bmGetId(), dtProject);
assertNotNull(marker);
}
}

48
tests/com.e1c.v8codestyle.md.itests/workspace/RegisterResourcePrecision/src/AccountingRegisters/AccountingRegisterWithDefinedTypeTest/AccountingRegisterWithDefinedTypeTest.mdo Normal file
View File

@ -0,0 +1,48 @@
<?xml version="1.0" encoding="UTF-8"?>
<mdclass:AccountingRegister xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:core="http://g5.1c.ru/v8/dt/mcore" xmlns:mdclass="http://g5.1c.ru/v8/dt/metadata/mdclass" uuid="72833b52-e4dd-4806-9c54-de51460a86e6">
<producedTypes>
<selectionType typeId="49c35f20-b405-4548-8b9a-df9698c4a7b5" valueTypeId="696338bd-0682-4981-adf5-4742ec1f55c0"/>
<listType typeId="8be989ad-6852-4b15-bf77-0e9563bb0dba" valueTypeId="cc3a32c6-5851-40a4-ab99-5a3122593dfc"/>
<managerType typeId="3fe5c4a9-efd4-4877-b8a3-ff2917cf5e8d" valueTypeId="6efa16bb-1738-4369-8507-dd53325bcd9c"/>
<recordSetType typeId="a2cecc9c-2048-4af1-a377-39e90af67683" valueTypeId="6d19b0c1-37a8-4e84-be01-039dae5e5a85"/>
<recordKeyType typeId="5fe3eeb0-d4b0-4992-9fd0-2d73f0340f7c" valueTypeId="037cca83-dbe0-42ac-ae43-69550853932b"/>
<recordType typeId="c623a4a8-cc09-4e34-9326-55c971d278e2" valueTypeId="7ed682cd-61bd-496e-bb63-753b843963db"/>
<extDimensionsType typeId="e3951c46-457e-42ea-8c98-c1af63c43f5d" valueTypeId="6b666af5-33fc-48ca-a1e3-2ccd2b139757"/>
</producedTypes>
<name>AccountingRegisterWithDefinedTypeTest</name>
<synonym>
<key>en</key>
<value>Accounting register with defined type test</value>
</synonym>
<useStandardCommands>true</useStandardCommands>
<dataLockControlMode>Managed</dataLockControlMode>
<enableTotalsSplitting>true</enableTotalsSplitting>
<resources uuid="c3818647-2758-4358-8aec-1fd5cfa366df">
<name>CorrectResourceWithDefinedType</name>
<synonym>
<key>en</key>
<value>Correct resource with defined type</value>
</synonym>
<type>
<types>DefinedType.CorrectType</types>
</type>
<minValue xsi:type="core:UndefinedValue"/>
<maxValue xsi:type="core:UndefinedValue"/>
<fullTextSearch>Use</fullTextSearch>
<balance>true</balance>
</resources>
<resources uuid="fcea05be-5dbb-4650-bbe7-3554978bd06f">
<name>WrongResourceWithDefinedType</name>
<synonym>
<key>en</key>
<value>Wrong resource with defined type</value>
</synonym>
<type>
<types>DefinedType.WrongType</types>
</type>
<minValue xsi:type="core:UndefinedValue"/>
<maxValue xsi:type="core:UndefinedValue"/>
<fullTextSearch>Use</fullTextSearch>
<balance>true</balance>
</resources>
</mdclass:AccountingRegister>

3
tests/com.e1c.v8codestyle.md.itests/workspace/RegisterResourcePrecision/src/Configuration/Configuration.mdo
View File

@ -38,7 +38,10 @@
</synonym>
<languageCode>en</languageCode>
</languages>
<definedTypes>DefinedType.CorrectType</definedTypes>
<definedTypes>DefinedType.WrongType</definedTypes>
<documents>Document.DocumentTest</documents>
<accumulationRegisters>AccumulationRegister.AccumulationRegisterTest</accumulationRegisters>
<accountingRegisters>AccountingRegister.AccountingRegisterTest</accountingRegisters>
<accountingRegisters>AccountingRegister.AccountingRegisterWithDefinedTypeTest</accountingRegisters>
</mdclass:Configuration>

17
tests/com.e1c.v8codestyle.md.itests/workspace/RegisterResourcePrecision/src/DefinedTypes/CorrectType/CorrectType.mdo Normal file
View File

@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<mdclass:DefinedType xmlns:mdclass="http://g5.1c.ru/v8/dt/metadata/mdclass" uuid="395e33ce-c83c-4202-85cf-d58f72fc6d20">
<producedTypes>
<containerType typeId="d9a914f3-0edb-40fb-baef-a7672a38bdde" valueTypeId="ceb2bdf4-8f54-420e-92a5-8afdcfe09d58"/>
</producedTypes>
<name>CorrectType</name>
<synonym>
<key>en</key>
<value>Correct type</value>
</synonym>
<type>
<types>Number</types>
<numberQualifiers>
<precision>10</precision>
</numberQualifiers>
</type>
</mdclass:DefinedType>

17
tests/com.e1c.v8codestyle.md.itests/workspace/RegisterResourcePrecision/src/DefinedTypes/WrongType/WrongType.mdo Normal file
View File

@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<mdclass:DefinedType xmlns:mdclass="http://g5.1c.ru/v8/dt/metadata/mdclass" uuid="6f55d133-da1e-4ae8-9201-48b885b1d539">
<producedTypes>
<containerType typeId="79cad748-4938-427e-a9be-342fbf989e0e" valueTypeId="b0b0de7f-db40-4e08-83df-fb42c8e00277"/>
</producedTypes>
<name>WrongType</name>
<synonym>
<key>en</key>
<value>Wrong type</value>
</synonym>
<type>
<types>Number</types>
<numberQualifiers>
<precision>50</precision>
</numberQualifiers>
</type>
</mdclass:DefinedType>