Skip to content

Commit

Permalink
Release 1.0.0
Browse files Browse the repository at this point in the history 
[ + ] Put readme content
[ * ] Improve build process to publish artifacts.
  • Loading branch information
@zkejid
zkejid committed May 18, 2020
1 parent f7312fc commit b24c62c
Show file tree
Hide file tree
Showing 4 changed files with 181 additions and 5 deletions.
29 changes: 27 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,27 @@
# string-value
Wrapper for an optional string value
# String value module
## Overview
Part of Zkejid's Constructor Framework. Serves as a wrapper around string values provided through any container: command line property, configuration property, etc. Includes semantics of "empty value" and "omitted value". Sometimes it is hard to say if the value of string parameter is actually an empty string, or the value is unspecified due to any reason. Sometimes both of these situationsshould be processed similarly, bot in other cases actions should be different. This module helps to process the value in strict and obvious way.

## Usage
## API
To use the API as the publisher of the value you should request ```StringValueFactory.class``` interface in your ```ConstructorPart``` implementation:
```
@Override
public Set<Class<?>> getInterfacesNecessary() {
return Set.of(StringValueFactory.class);
}
```
For a given value to publish you should call ```make(String, InputValueType)``` method of the factory. ```String``` value contains the value to pass, ```InputValueType``` contains type of raw value obtained from the source.

To use the API as the receiver of value you may just use ```StringValue``` object.

## Constructor Module
String Value is the module of [Constructor Framework](https://github.com/zkejidsconstructor).
You can simply place artifacts of this module on the path of application to use its API.

## Versioning
Artifact versions of the CliArguments Module follow the
[Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) specification.

## License
The module is provided under MIT License Copyright (c) 2020 Zkejid.
111 changes: 108 additions & 3 deletions pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,25 @@
<packaging>pom</packaging>
<version>1.0.0</version>

<description>Wrapper for optional string values</description>
<name>String value wrapper</name>
<description>
Part of Zkejid's Constructor Framework. Serves as a wrapper around string values provided
through any container: command line property, configuration property, etc. Includes semantics
of "empty value" and "omitted value".
</description>
<url>https://github.com/zkejidsconstructor/string-value</url>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<string.value.version>1.0.0</string.value.version>
<maven.compiler.plugin.version>3.8.1</maven.compiler.plugin.version>
<maven.surefire.plugin.version>3.0.0-M4</maven.surefire.plugin.version>
<constructor.parts.version>1.0.0</constructor.parts.version>
<junit.jupiter.version>5.6.2</junit.jupiter.version>
<maven.compiler.plugin.version>3.8.1</maven.compiler.plugin.version>
<maven.surefire.plugin.version>3.0.0-M4</maven.surefire.plugin.version>
<maven.source.plugin.version>3.2.0</maven.source.plugin.version>
<maven.javadoc.plugin.version>3.2.0</maven.javadoc.plugin.version>
<maven.gpg.plugin.version>1.6</maven.gpg.plugin.version>
<maven.staging.plugin.version>1.6.8</maven.staging.plugin.version>
</properties>

<modules>
Expand All @@ -41,6 +51,68 @@
<artifactId>maven-surefire-plugin</artifactId>
<version>${maven.surefire.plugin.version}</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>${maven.source.plugin.version}</version>
<executions>
<execution>
<id>attach-sources</id>
<phase>verify</phase>
<goals>
<goal>jar-no-fork</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>${maven.javadoc.plugin.version}</version>
<executions>
<execution>
<id>attach-javadocs</id>
<phase>verify</phase>
<goals>
<goal>jar</goal>
</goals>
<!-- TODO: fix issue with wrong version of javadoc -->
<!-- <configuration>-->
<!-- <javadocExecutable>/usr/lib/jvm/bellsoft-java13-i586/bin/javadoc</javadocExecutable>-->
<!-- </configuration>-->
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>${maven.gpg.plugin.version}</version>
<executions>
<execution>
<id>sign-artifacts</id>
<phase>verify</phase>
<goals>
<goal>sign</goal>
</goals>
<configuration>
<!-- get from local pom -->
<keyname>${gpg.keyname}</keyname>
<passphraseServerId>${gpg.keyname}</passphraseServerId>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<version>${maven.staging.plugin.version}</version>
<extensions>true</extensions>
<configuration>
<serverId>ossrh</serverId>
<nexusUrl>https://oss.sonatype.org/</nexusUrl>
<autoReleaseAfterClose>true</autoReleaseAfterClose>
</configuration>
</plugin>
</plugins>
</build>

Expand Down Expand Up @@ -78,4 +150,37 @@
</dependencies>
</dependencyManagement>

<licenses>
<license>
<name>MIT License</name>
<url>http://www.opensource.org/licenses/mit-license.php</url>
</license>
</licenses>

<developers>
<developer>
<name>Ivan Panfilov</name>
<email>developer@zkejid.com</email>
<organization>Zkejid</organization>
<organizationUrl>https://github.com/zkejid</organizationUrl>
</developer>
</developers>

<scm>
<connection>scm:git:git@github.com:zkejidsconstructor/string-value.git</connection>
<developerConnection>scm:git:git@github.com:zkejidsconstructor/string-value.git</developerConnection>
<url>https://github.com/zkejidsconstructor/string-value</url>
</scm>

<distributionManagement>
<snapshotRepository>
<id>ossrh</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
</snapshotRepository>
<repository>
<id>ossrh</id>
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
</repository>
</distributionManagement>

</project>
23 changes: 23 additions & 0 deletions string-value-api/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,27 @@

<artifactId>string-value-api</artifactId>

<name>String value wrapper: API</name>
<description>
Part of Zkejid's Constructor Framework. Serves as a wrapper around string values provided
through any container: command line property, configuration property, etc. Includes semantics
of "empty value" and "omitted value".
</description>
<url>https://github.com/zkejidsconstructor/string-value/tree/master/string-value-api</url>

<licenses>
<license>
<name>MIT License</name>
<url>http://www.opensource.org/licenses/mit-license.php</url>
</license>
</licenses>

<developers>
<developer>
<name>Ivan Panfilov</name>
<email>developer@zkejid.com</email>
<organization>Zkejid</organization>
<organizationUrl>https://github.com/zkejid</organizationUrl>
</developer>
</developers>
</project>
23 changes: 23 additions & 0 deletions string-value-impl/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@

<artifactId>string-value-impl</artifactId>

<name>String value wrapper: implementation</name>
<description>
Part of Zkejid's Constructor Framework. Serves as a wrapper around string values provided
through any container: command line property, configuration property, etc. Includes semantics
of "empty value" and "omitted value".
</description>
<url>https://github.com/zkejidsconstructor/string-value/tree/master/string-value-impl</url>

<dependencies>
<dependency>
<groupId>com.zkejid.constructor</groupId>
Expand All @@ -37,4 +45,19 @@
</dependency>
</dependencies>

<licenses>
<license>
<name>MIT License</name>
<url>http://www.opensource.org/licenses/mit-license.php</url>
</license>
</licenses>

<developers>
<developer>
<name>Ivan Panfilov</name>
<email>developer@zkejid.com</email>
<organization>Zkejid</organization>
<organizationUrl>https://github.com/zkejid</organizationUrl>
</developer>
</developers>
</project>

0 comments on commit b24c62c

Please sign in to comment.