Merge pull request #10 from spacious-team/develop

Релиз 2023.1

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: Отчет об ошибке
+about: Создайте отчет об ошибке, чтобы улучшить приложение
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Опишите ошибку**
+Ясное и краткое описание ошибки.
+
+**Последовательность действий для воспроизведения**
+Шаги по воспроизведению ошибки.
+
+**Ожидаемый результат**
+Ясное и краткое описание того, что вы ожидали.
+
+**Скриншоты**
+Если возможно, добавьте скриншоты, чтобы объяснить проблему.
+
+**Окружение:**
+ - ОС: [например windows 10]
+ - Версия Java [например 19]
+ - Версия приложения[например 2020.1]
+
+**Дополнительный контекст**
+Любой другой контекст проблемы.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Запрос новой функциональности
+about: Предложите идею для этого проекта
+title: ''
+labels: feature
+assignees: ''
+
+---
+
+**Связан ли ваш запрос новой функциональности с проблемой? Пожалуйста, опишите.**
+Четкое и краткое описание проблемы. Например, я всегда расстраиваюсь, когда [...]
+
+**Опишите желаемое решение**
+Четкое и краткое описание того, что вы хотите сделать.
+
+**Опишите альтернативы, которые вы рассмотрели**
+Четкое и краткое описание любых рассмотренных вами альтернативных решений или функций.
+
+**Дополнительный контекст**
+Любой другой контекст.

.github/workflows/unit-tests.yml

@@ -0,0 +1,45 @@
+name: Unit Tests
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - 'master'
+      - 'develop'
+  push:
+    branches:
+      - 'master'
+      - 'develop'
+
+jobs:
+  tests:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up JDK
+        uses: actions/setup-java@v3
+        with:
+          java-version: '18'
+          distribution: 'liberica'
+          cache: maven
+
+      - name: Maven Tests
+        run: mvn --batch-mode clean test
+
+      - name: Test Coverage
+        uses: codecov/codecov-action@v3
+
+      - name: SonarCloud Analyze
+        run: >
+          mvn --batch-mode sonar:sonar
+          -Dsonar.projectKey=spacious-team_table-wrapper-csv-impl
+          -Dsonar.organization=spacious-team
+          -Dsonar.host.url=https://sonarcloud.io
+          -Dsonar.login=$SONAR_TOKEN
+          -Dsonar.coverage.jacoco.xmlReportPaths=./target/site/jacoco/jacoco.xml
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.gitignore

@@ -1,7 +1,6 @@
 target/
 .mvn
 !.mvn/wrapper/maven-wrapper.properties
-!.mvn/wrapper/MavenWrapperDownloader.java
 !**/src/main/**
 !**/src/test/**
 
@@ -22,6 +21,7 @@ target/
 !.idea/runConfigurations
 !.idea/codeStyles
 !.idea/copyright
+!.idea/inspectionProfiles
 
 ### NetBeans ###
 /nbproject/private/

.mvn/wrapper/maven-wrapper.properties

@@ -1,2 +1,18 @@
-distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.6.3/apache-maven-3.6.3-bin.zip
-wrapperUrl=https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.1/apache-maven-3.8.1-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar

README.md

@@ -1,8 +1,19 @@
 ![java-version](https://img.shields.io/badge/Java-11-brightgreen?style=flat-square)
-![jitpack-last-release](https://jitpack.io/v/spacious-team/table-wrapper-csv-impl.svg?style=flat-square)
+[![jitpack-last-release](https://jitpack.io/v/spacious-team/table-wrapper-csv-impl.svg?style=flat-square)](
+https://jitpack.io/#spacious-team/table-wrapper-csv-impl)
+[![Unit tests](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fspacious-team%2Ftable-wrapper-csv-impl%2Fbadge%3Fref%3Ddevelop&style=flat-square&label=Test&logo=none)](
+https://github.com/spacious-team/table-wrapper-csv-impl/actions/workflows/unit-tests.yml)
+[![Coverage](https://img.shields.io/codecov/c/github/spacious-team/table-wrapper-csv-impl/develop?label=Coverage&style=flat-square&token=abjh1TArzE)](
+https://codecov.io/gh/spacious-team/table-wrapper-csv-impl)
 
 ### Назначение
 Предоставляет реализацию `Table Wrapper API` для удобного доступа к табличным данным, сохраненным в файлах формата `csv`.
+
+Если не используется [Spring Boot Starter](https://github.com/spacious-team/table-wrapper-spring-boot-starter),
+то сначала в реестр доступных фабрик нужно зарегистрировать фабрику csv таблиц:
+```java
+TableFactoryRegistry.add(new CsvTableFactory());
+```
 Пример создания таблиц из файла `1.csv`
 ```java
 ReportPage reportPage = new CsvReportPage(Path.of("1.csv"));
@@ -34,7 +45,7 @@ Table tableN = reportPage.create("Table N description", ...);
     </repository>
 </repositories>
 ```
-и добавить зависимость
+Далее следует добавить зависимость
 ```xml
 <dependency>
     <groupId>com.github.spacious-team</groupId>
@@ -45,4 +56,4 @@ Table tableN = reportPage.create("Table N description", ...);
 В качестве версии можно использовать:
 - версию [релиза](https://github.com/spacious-team/table-wrapper-csv-impl/releases) на github;
 - паттерн `<branch>-SNAPSHOT` для сборки зависимости с последнего коммита выбранной ветки;
-- короткий 10-ти значный номер коммита для сборки зависимости с указанного коммита.
+- короткий десяти значный номер коммита для сборки зависимости с указанного коммита.

jitpack.yml

@@ -0,0 +1,8 @@
+# Workaround for any java version not supported by Jitpack.io yet
+# https://github.com/jitpack/jitpack.io/issues/4260
+#before_install:
+#  - wget https://github.com/sormuras/bach/raw/master/install-jdk.sh
+#  - source install-jdk.sh --feature 15
+#  - jshell --version
+jdk:
+  - openjdk11