Be, and it is

azam · Jan 7, 2017 · fe5ee67 · fe5ee67
commit fe5ee67
Show file tree

Hide file tree

Showing 7 changed files with 810 additions and 0 deletions.
diff --git a/.settings.xml b/.settings.xml
@@ -0,0 +1,11 @@
+<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
+	<servers>
+		<server>
+			<id>ossrh</id>
+			<username>${env.SONATYPE_USERNAME}</username>
+			<password>${env.SONATYPE_PASSWORD}</password>
+		</server>
+	</servers>
+</settings>
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,34 @@
+language: java
+jdk:
+  - oraclejdk8
+  - oraclejdk7
+install:
+  - mvn clean install --settings .settings.xml -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip -B -V
+before_install:
+  - if [ ! -z "$GPG_SECRET_KEYS" ]; then echo $GPG_SECRET_KEYS | base64 --decode | $GPG_EXECUTABLE --import; fi
+  - if [ ! -z "$GPG_OWNERTRUST" ]; then echo $GPG_OWNERTRUST | base64 --decode | $GPG_EXECUTABLE --import-ownertrust; fi
+before_deploy:
+  - mvn clean package -P release --settings .settings.xml -DperformRelease=true -DskipTests=true -B -U
+deploy:
+  -
+    provider: script
+    script: mvn deploy -P release --settings .settings.xml -DperformRelease=true -DskipTests=true -B -U
+    skip_cleanup: true
+    on:
+      repo: azam/ulidj
+      jdk: oraclejdk7
+  -
+    provider: releases
+    api_key: "$GITHUB_OAUTH_TOKEN"
+    file_glob: true
+    file:
+      - "target/ulidj-*.jar"
+      - "target/*.pom"
+      - "target/*.asc"
+      - "target/*.sha1"
+    skip_cleanup: true
+    overwrite: true
+    on:
+      repo: azam/ulidj
+      jdk: oraclejdk7
+      tags: true
diff --git a/license b/license
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Azamshul Azizy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/pom.xml b/pom.xml
@@ -0,0 +1,139 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<groupId>io.azam.ulidj</groupId>
+	<artifactId>ulidj</artifactId>
+	<version>1.0.0</version>
+	<name>ulidj</name>
+	<description>ULID (Universally Unique Lexicographically Sortable Identifier) generator and parser for Java.</description>
+	<url>https://github.com/azam/ulidj</url>
+	<licenses>
+		<license>
+			<name>The MIT License (MIT)</name>
+			<url>http://opensource.org/licenses/MIT</url>
+			<distribution>repo</distribution>
+		</license>
+	</licenses>
+	<scm>
+		<url>https://github.com/azam/ulidj</url>
+		<developerConnection>azam</developerConnection>
+	</scm>
+	<developers>
+		<developer>
+			<id>1</id>
+			<name>azam</name>
+			<email>azamshul@gmail.com</email>
+			<organization>azam.io</organization>
+			<organizationUrl>http://azam.io</organizationUrl>
+			<roles>
+				<role>Geek</role>
+			</roles>
+			<timezone>+9</timezone>
+		</developer>
+	</developers>
+	<issueManagement>
+		<system>GitHub</system>
+		<url>https://github.com/azam/ulidj/issues</url>
+	</issueManagement>
+	<organization>
+		<name>azam</name>
+		<url>http://azam.io</url>
+	</organization>
+	<properties>
+		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+	</properties>
+	<dependencies>
+		<dependency>
+			<groupId>junit</groupId>
+			<artifactId>junit</artifactId>
+			<version>4.12</version>
+			<scope>test</scope>
+		</dependency>
+	</dependencies>
+	<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>
+	<profiles>
+		<profile>
+			<id>release</id>
+			<activation>
+				<activeByDefault>false</activeByDefault>
+			</activation>
+			<properties>
+				<gpg.executable>${env.GPG_EXECUTABLE}</gpg.executable>
+				<gpg.passphrase>${env.GPG_PASSPHRASE}</gpg.passphrase>
+			</properties>
+			<build>
+				<plugins>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-compiler-plugin</artifactId>
+						<version>3.6.0</version>
+						<configuration>
+							<source>1.7</source>
+							<target>1.7</target>
+						</configuration>
+					</plugin>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-source-plugin</artifactId>
+						<version>3.0.1</version>
+						<executions>
+							<execution>
+								<id>attach-sources</id>
+								<goals>
+									<goal>jar-no-fork</goal>
+								</goals>
+							</execution>
+						</executions>
+					</plugin>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-javadoc-plugin</artifactId>
+						<version>2.10.4</version>
+						<executions>
+							<execution>
+								<id>attach-javadocs</id>
+								<goals>
+									<goal>jar</goal>
+								</goals>
+							</execution>
+						</executions>
+					</plugin>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-gpg-plugin</artifactId>
+						<version>1.6</version>
+						<executions>
+							<execution>
+								<id>sign-artifacts</id>
+								<phase>verify</phase>
+								<goals>
+									<goal>sign</goal>
+								</goals>
+							</execution>
+						</executions>
+					</plugin>
+					<plugin>
+						<groupId>org.sonatype.plugins</groupId>
+						<artifactId>nexus-staging-maven-plugin</artifactId>
+						<version>1.6.6</version>
+						<extensions>true</extensions>
+						<configuration>
+							<serverId>ossrh</serverId>
+							<nexusUrl>https://oss.sonatype.org/</nexusUrl>
+							<autoReleaseAfterClose>true</autoReleaseAfterClose>
+						</configuration>
+					</plugin>
+				</plugins>
+			</build>
+		</profile>
+	</profiles>
+</project>
diff --git a/readme.md b/readme.md
@@ -0,0 +1,73 @@
+# ulidj
+
+[![MIT licensed](https://img.shields.io/badge/license-mit-blue.svg)](https://raw.githubusercontent.com/azam/ulidj/master/license)
+[![Travis CI](https://api.travis-ci.org/azam/ulidj.svg?branch=master)](https://travis-ci.org/azam/ulidj)
+
+ULID (Universally Unique Lexicographically Sortable Identifier) generator and parser for Java.
+
+Refer [alizain/ulid](https://github.com/alizain/ulid) for a more detailed ULID specification.
+
+## License
+
+```
+MIT License
+
+Copyright (c) 2016 Azamshul Azizy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```
+
+## Maven
+
+Add the following tag to `dependencies` tag in your `pom.xml` file.
+
+```xml
+<dependency>
+  <groupId>io.azam</groupId>
+  <artifactId>ulidj</artifactId>
+  <version>1.0.0</version>
+</dependency>
+```
+
+## Usage
+
+ULID generation examples:
+
+```java
+String ulid1 = ULID.random();
+String ulid2 = ULID.random(ThreadLocalRandom.current());
+String ulid3 = ULID.random(SecureRandom.newInstance("SHA1PRNG"));
+byte[] entropy = new byte[] { 0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8, 0x9 };
+String ulid4 = ULID.generate(System.currentTimeMillis(), entropy);
+```
+
+ULID parsing examples:
+
+```java
+String ulid = "003JZ9J6G80123456789abcdef";
+assert ULID.isValid(ulid);
+long ts = ULID.getTimestamp(ulid);
+assert ts == 123456789000L;
+byte[] entropy = ULID.getEntropy(ulid);
+```
+
+## Prior Art
+
+- [Lewiscowles1986/jULID](https://github.com/Lewiscowles1986/jULID)
+- [alizain/ulid](https://github.com/alizain/ulid)