Finish 0.5.1

Author: khorevaa

docs/README.md

@@ -13,8 +13,32 @@
     - [СравнитьВерсии](#сравнитьверсии)
 - [Класс СравнениеВерсий:](#класс-сравнениеверсий)
     - [ДобавитьДиапазон](#добавитьдиапазон)
+    - [ПроверяемыеВерсии](#проверяемыеверсии)
+    - [ПроверяемаяВерсия](#проверяемаяверсия)
+    - [Сравнить](#сравнить)
+    - [ВМассив](#вмассив)
+    - [ВМассивСтрок](#вмассивстрок)
+    - [ВДиапазоне](#вдиапазоне)
+    - [Максимальная](#максимальная)
+    - [Сброс](#сброс)
 - [Класс ДиапазонВерсий:](#класс-диапазонверсий)
+    - [ПроверитьВерсию](#проверитьверсию)
+    - [ПолучитьСравнение](#получитьсравнение)
+    - [ПроверитьВерсии](#проверитьверсии)
+    - [МаксимальнаяВерсияИЗВерсий](#максимальнаяверсияизверсий)
+    - [ВСтроку](#встроку)
+    - [ОбъединитьСДиапазоном](#объединитьсдиапазоном)
 - [Класс Версия:](#класс-версия)
+    - [Ошибка](#ошибка)
+    - [ПолучитьОписаниеОшибки](#получитьописаниеошибки)
+    - [ВСтроку](#встроку-1)
+    - [Сравнить](#сравнить-1)
+    - [Равны](#равны)
+    - [НеРавны](#неравны)
+    - [Меньше](#меньше)
+    - [МеньшеИлиРавны](#меньшеилиравны)
+    - [Больше](#больше)
+    - [БольшеИлиРавны](#большеилиравны)
 
 <!-- /TOC -->
 
@@ -112,11 +136,9 @@
 //  (1) - СтрокаВерсия1 больше (>) СтрокаВерсия2
 //  (0) - СтрокаВерсия1 равна (=) СтрокаВерсия2
 ```
-
 ### Класс СравнениеВерсий:
 
 > Класс для работы в форме fluent с сравнениями версий
-
 #### ДобавитьДиапазон
 ```bsl
 // Добавляет диапазон в сравнение
@@ -126,16 +148,208 @@
 // Возвращаемое значение:
 //   ЭтотОбъект - класс СравнениеВерсий
 ```
-`TODO`
-
+#### ПроверяемыеВерсии
+```bsl
+// Добавляет массив версий в сравнение и возвращает себя
+//
+// Параметры:
+//   СтрокаДиапазона - Массив - Элементы <Строка> или класс <Версия> проверяемых версий
+//   ОчищатьМассив - булево - признак очистки предыдущего набора версий
+// Возвращаемое значение:
+//   ЭтотОбъект - класс СравнениеВерсий
+```
+#### ПроверяемаяВерсия
+```bsl
+// Добавляет версию в сравнение и возвращает себя
+//
+// Параметры:
+//   ВходящаяВерсия - Строка/Класс_Версия - Версия для сравнения с диапазоном
+//   ОчищатьМассив - булево - признак очистки предыдущего набора версий
+// Возвращаемое значение:
+//   ЭтотОбъект - класс СравнениеВерсий
+```
+#### Сравнить
+```bsl
+// Выполняет сравнение и возвращает себя
+//
+// Возвращаемое значение:
+//   ЭтотОбъект - класс СравнениеВерсий
+```
+#### ВМассив
+```bsl
+// Выполняет сравнение и выгружает результат в массив
+//
+// Возвращаемое значение:
+//   Массив - массив элементов класса версия 
+```
+#### ВМассивСтрок
+```bsl
+// Выполняет сравнение и выгружает результат в массив строк версий
+//
+// Возвращаемое значение:
+//   Массив - массив элементов строка  (вызов Версия.ВСтроку())
+```
+#### ВДиапазоне
+```bsl
+// Выполняет сравнение и проверяет, что все элементы, присутствуют в массиве после сравнения
+//
+// Возвращаемое значение:
+//   Булево - все элементы есть в массиве
+```
+#### Максимальная
+```bsl
+// Выполняет сравнение и возвращает максимальную версию из результата
+//
+// Возвращаемое значение:
+//   Версия - элемент класса версия 
+```
+#### Сброс
+```bsl
+// Выполняет сброс версий, результата сравнения и возвращает себя
+// НЕ СБРАСЫВАЕТ ДИАПАЗОН ВЕРСИЙ
+//
+// Возвращаемое значение:
+//   ЭтотОбъект - класс СравнениеВерсий
+```
 ### Класс ДиапазонВерсий:
 
 > Класс для работы с диапазонами версий и их чтение из строки
-
-`TODO`
-
+#### ПроверитьВерсию
+```bsl
+// Выполняет проверку, что версия удовлетворяет диапазону
+//
+// Возвращаемое значение:
+//   Булево - Истина / ложь 
+```
+#### ПолучитьСравнение
+```bsl
+// Возвращает сравнение для диапазона версий
+//
+// Возвращаемое значение:
+//   Соответствие 
+//      ключ     - символ действия (>=. <=, =, >, <)
+//      Значение - класс версия
+```
+#### ПроверитьВерсии
+```bsl
+// Выполняет проверку массива версий, на соответствие диапазону
+//
+// Параметры:
+//   МассивВерсий - элементы класса версия - Версия для сравнения с диапазоном
+//
+// Возвращаемое значение:
+//   Массив - элементы класса версия
+```
+#### МаксимальнаяВерсияИЗВерсий
+```bsl
+// Выполняет проверку массива версий, на соответствие диапазону
+// И возвращает максимальную из них 
+//
+// Параметры:
+//   МассивВерсий - элементы класса версия - Версия для сравнения с диапазоном
+//
+// Возвращаемое значение:
+//   Версия - класс версия, максимальный из проверяемого массива
+```
+#### ВСтроку
+```bsl
+// Возвращает строковое представление диапазона версий
+//
+// Возвращаемое значение:
+//   строка - строковое представление (типа: >=1.0.0 - < 2.0.0)
+```
+#### ОбъединитьСДиапазоном
+```bsl
+// Объединяет с переданным диапазоном
+//
+// Параметры:
+//   ВходящийДиапазон - класс ДиапазонВерсий - объединяемый диапазон
+```
 ### Класс Версия:
 
 > Класс для работы с версиями и их чтение из строки
 
-`TODO`
+#### Ошибка
+```bsl
+// Возвращает наличие ошибки при чтении версии
+//
+// Возвращаемое значение:
+//   булево - истина / ложь
+```
+#### ПолучитьОписаниеОшибки
+```bsl
+// Возвращает описание ошибки при чтении версии
+//
+// Возвращаемое значение:
+//   строка - подробное описание чтения версии из строки
+```
+#### ВСтроку
+```bsl
+// Возвращает строковое представление версии
+//
+// Возвращаемое значение:
+//   строка - строковое представление версии (типа: 1.0.0, 2.0.0)
+```
+#### Сравнить
+```bsl
+// Выполняет сравнение версии с входящей версией
+//
+// Параметры:
+//   ВходящаяВерсия - Класс Версия - версия для сравнения
+// Возвращаемое значение:
+//   Число - результат сравнения в числе (0 = Равны, -1 = Меньше, 1 = Больше), относительно входящей версии
+```
+#### Равны
+```bsl
+// Проверяет равенство версии с входящей версией
+//
+// Параметры:
+//   ВходящаяВерсия - Класс Версия - версия для сравнения
+// Возвращаемое значение:
+//   Булево - истина / ложь
+```
+#### НеРавны
+```bsl
+// Проверяет не равенство версии с входящей версией
+//
+// Параметры:
+//   ВходящаяВерсия - Класс Версия - версия для сравнения
+// Возвращаемое значение:
+//   Булево - истина / ложь
+```
+#### Меньше
+```bsl
+// Проверяет, что текущая версия меньше входящей версии
+//
+// Параметры:
+//   ВходящаяВерсия - Класс Версия - версия для сравнения
+// Возвращаемое значение:
+//   Булево - истина / ложь
+```
+#### МеньшеИлиРавны
+```bsl
+// Проверяет, что текущая версия меньше или равна входящей версии
+//
+// Параметры:
+//   ВходящаяВерсия - Класс Версия - версия для сравнения
+// Возвращаемое значение:
+//   Булево - истина / ложь
+```
+#### Больше
+```bsl
+// Проверяет, что текущая версия больше входящей версии
+//
+// Параметры:
+//   ВходящаяВерсия - Класс Версия - версия для сравнения
+// Возвращаемое значение:
+//   Булево - истина / ложь
+```
+#### БольшеИлиРавны
+```bsl
+// Проверяет, что текущая версия больше или равна входящей версии
+//
+// Параметры:
+//   ВходящаяВерсия - Класс Версия - версия для сравнения
+// Возвращаемое значение:
+//   Булево - истина / ложь
+```

packagedef

@@ -4,7 +4,7 @@
 //
 
 Описание.Имя("semver")
-        .Версия("0.5.0")
+        .Версия("0.5.1")
         .Автор("Khorev Aleksey")
         .АдресАвтора("[email protected]")
         .Описание("Эта библиотека облегчает работу с семантическими версиями")
@@ -17,6 +17,9 @@
         .ЗависитОт("fluent")
         //.ЗависитОт("package3", ">=1.1", "<2.0")
         //.ЗависитОт("package4", ">=1.1", "<2.0")
-        //.ОпределяетКласс("УправлениеВселенной", "src/universe-mngr.os")
+        .ОпределяетМодуль("Версии", "src/core/Модули/Версии.os")
+        .ОпределяетКласс("Версия", "src/core/Классы/Версия.os")
+        .ОпределяетКласс("ДиапазонВерсий", "src/core/Классы/ДиапазонВерсий.os")
+        .ОпределяетКласс("СравнениеВерсий", "src/core/Классы/СравнениеВерсий.os")
         //.ОпределяетМодуль("ПолезныеФункции", "src/tools.os")
         ;

src/core/Классы/ДиапазонВерсий.os

@@ -91,6 +91,7 @@
 КонецФункции
 
 // Возвращает строковое представление диапазона версий
+//
 // Возвращаемое значение:
 //   строка - строковое представление (типа: >=1.0.0 - < 2.0.0)
 Функция ВСтроку() Экспорт