diff --git a/CHANGELOG.md b/CHANGELOG.md index b95f869..f436e67 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,48 @@

-

+

--- +# 0.3.0 +
+ Version Details +

+ Release Date: 2017-07-17
+ Milestone
+ Project Board +

+
+ +## Features +### API +❯ Implemented a non-parameter constructor as an equivalent to the default `Hashids.Builder` instance. The builder supports the creation of an Hashids instance without parameters for custom configurations, but there was no equivalent constructor for this case. (#1) + +## Improvements +### API +#### Performance +##### Internal +❯ The private method `consistentShuffle(String,String)` now uses `char` arrays instead of `String` operations. This removes five additional `String` operations/methods and six String concatenations to three simple array assignments. (#7) + +❯ Replaced `toCharArray(int)` methods with `charAt(int)` since `Strings` are implemented as array internally so there is no need to convert to a char array. + +❯ Adapted to SonarQube minor rule [squid:S3400](https://sonarcloud.io/coding_rules#q=squid%3AS3400). (#5) + +❯ Adapted to SonarQube minor rule [squid:S3400](https://sonarcloud.io/coding_rules#q=squid%3AS1643) to improve the performance. (#6) + +### Documentation +❯ Adapted to a new project setup and documentation style. (#2) + +### Tests +❯ Slighly increased the code coverage by implementation unit tests for the `Hashid` *equals* symmetric. (#8) + +## Bug Fixes +### API +❯ Fixed a `ArrayIndexOutOfBoundsException` when using a invalid decode salt. + +### JavaDoc +❯ Fixed JavaDoc lint compilation errors for self-closed tags. (#3) + # 0.2.0 (2016-06-11) ## Features ### API diff --git a/README.md b/README.md index 20c5a03..7b51bc6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

-

+

A lightweight generator for short, unique, non-sequential and decodable Hashids from positive unsigned (long) integer numbers.
Implementation of the Hashids project.

@@ -32,18 +32,18 @@ You can use it as a dependency for your favorite build tool or [download the lat com.arcticicestudio icecore-hashids - 0.2.0 + 0.3.0 ``` Gradle ```java -compile(group: 'com.arcticicestudio', name: 'icecore-hashids', version: '0.2.0') +compile(group: 'com.arcticicestudio', name: 'icecore-hashids', version: '0.3.0') ``` Apache Ivy ```xml - + ``` Development snapshots are available via [OSS Sonatype](https://oss.sonatype.org/content/repositories/snapshots/com/arcticicestudio/icecore-hashids). @@ -230,7 +230,7 @@ This is done by never placing the following letters next to each other: --- ## Development -[![](https://img.shields.io/badge/Changelog-0.2.0-blue.svg)](https://github.com/arcticicestudio/icecore-hashids/blob/v0.2.0/CHANGELOG.md) [![](https://img.shields.io/badge/Workflow-gitflow_Branching_Model-blue.svg)](http://nvie.com/posts/a-successful-git-branching-model) [![](https://img.shields.io/badge/Versioning-ArcVer_0.8.0-blue.svg)](https://github.com/arcticicestudio/arcver) +[![](https://img.shields.io/badge/Changelog-0.3.0-blue.svg)](https://github.com/arcticicestudio/icecore-hashids/blob/v0.3.0/CHANGELOG.md) [![](https://img.shields.io/badge/Workflow-gitflow_Branching_Model-blue.svg)](http://nvie.com/posts/a-successful-git-branching-model) [![](https://img.shields.io/badge/Versioning-ArcVer_0.8.0-blue.svg)](https://github.com/arcticicestudio/arcver) ### Contribution Please report issues/bugs, feature requests and suggestions for improvements to the [issue tracker](https://github.com/arcticicestudio/icecore-hashids/issues). diff --git a/pom.xml b/pom.xml index 10c3a67..a51aea1 100644 --- a/pom.xml +++ b/pom.xml @@ -27,7 +27,7 @@ JFrog Bintray com.arcticicestudio icecore-hashids - 0.3.0-SNAPSHOT + 0.3.0 jar icecore-hashids diff --git a/src/main/java/com/arcticicestudio/icecore/hashids/Hashids.java b/src/main/java/com/arcticicestudio/icecore/hashids/Hashids.java index 388ec21..dc1dab9 100644 --- a/src/main/java/com/arcticicestudio/icecore/hashids/Hashids.java +++ b/src/main/java/com/arcticicestudio/icecore/hashids/Hashids.java @@ -51,8 +51,7 @@ copyright Copyright (C) 2017 + * @author Arctic Ice Studio <development@arcticicestudio.com> * @see IceCore Hashids * @see Hashids - * @version 0.2.0 - * @since 0.1.0 + * @version 0.3.0 */ public final class Hashids { @@ -89,7 +88,7 @@ public final class Hashids { * * @since 0.3.0 */ - public static final String VERSION = "0.2.0"; + public static final String VERSION = "0.3.0"; private static final int GUARD_DIV = 12; private static final int MIN_ALPHABET_LENGTH = 16; diff --git a/src/main/java/com/arcticicestudio/icecore/hashids/package-info.java b/src/main/java/com/arcticicestudio/icecore/hashids/package-info.java index 003badd..01edaea 100644 --- a/src/main/java/com/arcticicestudio/icecore/hashids/package-info.java +++ b/src/main/java/com/arcticicestudio/icecore/hashids/package-info.java @@ -18,6 +18,6 @@ copyright Copyright (C) 2017 + * * @author Arctic Ice Studio <development@arcticicestudio.com> * @see Hashids - * @version 0.2.0 + * @version 0.3.0 */ -package com.arcticicestudio.icecore.hashids; \ No newline at end of file +package com.arcticicestudio.icecore.hashids;