Merge branch 'prepare-v0.2' into 'master'

Prepare v0.2

See merge request TurpIF/lambda-string!9

Author: TurpIF

.gitlab-ci.yml

@@ -35,7 +35,7 @@ build-benchmark:
       - target/*.jar
     expire_in: 20 minutes
 
-package:jdk8:
+package-jdk8:
   <<: *build
   script: "mvn verify `eval $MAVEN_CLI_OPTS`"
   artifacts:
@@ -53,7 +53,7 @@ package:jdk8:
     -Dassembly.skipAssembly=true \
     -Djacoco.skip=true"
   dependencies:
-    - package:jdk8
+    - package-jdk8
 
 test-jre8:
   <<: *test
@@ -120,7 +120,7 @@ coverage-rate:
   image: alpine:3.7
   stage: package
   dependencies:
-    - package:jdk8
+    - package-jdk8
   script:
     - awk -F"," \
       '{
@@ -158,7 +158,7 @@ pages:
   image: alpine:3.7
   stage: deploy
   dependencies:
-    - package:jdk8
+    - package-jdk8
     - benchmark-report
   script:
     - mkdir -p public/coverage

README.md

@@ -1,43 +1,43 @@
-# lambda-string [![build status](https://gitlab.com/TurpIF/lambda-to-string/badges/master/build.svg)](https://gitlab.com/TurpIF/lambda-to-string/commits/master) [![coverage report](https://gitlab.com/TurpIF/lambda-to-string/badges/master/coverage.svg)](https://turpif.gitlab.io/lambda-to-string/coverage)
+# lambda-string [![build status](https://gitlab.com/TurpIF/lambda-string/badges/master/build.svg)](https://gitlab.com/TurpIF/lambda-string/commits/master) [![coverage report](https://gitlab.com/TurpIF/lambda-string/badges/master/coverage.svg)](https://turpif.gitlab.io/lambda-string/coverage)
 
 Lambda-string (LS) is a helping java agent that inject configurable toString method into lambdas with some useful meta-information.
 
 LS comes with a default toString strategy that print the origin of the lambdas. This feature let you easily track their origin while debugging as shown below :
 
-![With and without the agent](https://gitlab.com/TurpIF/lambda-to-string/raw/master/doc/with-without.gif)
+![With and without the agent](https://gitlab.com/TurpIF/lambda-string/raw/master/doc/with-without.gif)
 
 ## Usage
 
-The most recent release is [LS 0.1](https://gitlab.com/TurpIF/lambda-to-string/tags/v0.1).
+The most recent release is [LS 0.2](https://gitlab.com/TurpIF/lambda-string/tags/v0.2).
 
 To activate the LS agent in general, please use the following:
-- Download the [lambdaString-0.1.jar](https://gitlab.com/TurpIF/lambda-to-string/-/jobs/artifacts/v0.1/raw/target/lambdaString-0.1.jar?job=package%3Ajdk8)
-- Add `-javaagent:/path/to/lambdaString-0.1.jar` in your java options
+- Download the [lambda-string-0.2.jar](https://gitlab.com/TurpIF/lambda-string/-/jobs/artifacts/v0.2/raw/target/lambda-string-0.2.jar?job=package-jdk8)
+- Add `-javaagent:/path/to/lambda-string-0.2.jar` in your java options
 
 
 To activate the LS agent using remote debugger, please use the following:
 ```bash
 # Download JAR
-wget -O /tmp/lambdaString-0.1.jar "https://gitlab.com/TurpIF/lambda-to-string/-/jobs/artifacts/v0.1/raw/target/lambdaString-0.1.jar?job=package%3Ajdk8"
+wget -O /tmp/lambda-string-0.2.jar "https://gitlab.com/TurpIF/lambda-string/-/jobs/artifacts/v0.2/raw/target/lambda-string-0.2.jar?job=package-jdk8"
 
 # Start debug server
 cd /your/project
-java -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005 -javaagent:/tmp/lambdaString-0.1.jar my.dummy.Main
+java -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005 -javaagent:/tmp/lambda-string-0.2.jar my.dummy.Main
 
 # Attach a debugger client with JDB or your preferred IDE
 ```
 
 
 To activate the LS agent using IntelliJ, please use the following:
-- Download the [lambdaString-0.1.jar](https://gitlab.com/TurpIF/lambda-to-string/-/jobs/artifacts/v0.1/raw/target/lambdaString-0.1.jar?job=package%3Ajdk8)
-- Add `-javaagent:/path/to/lambdaString-0.1.jar` in the "VM options" of your debugging configuration
+- Download the [lambda-string-0.2.jar](https://gitlab.com/TurpIF/lambda-string/-/jobs/artifacts/v0.2/raw/target/lambda-string-0.2.jar?job=package-jdk8)
+- Add `-javaagent:/path/to/lambda-string-0.2.jar` in the "VM options" of your debugging configuration
 
-![Intellij hint](https://gitlab.com/TurpIF/lambda-to-string/raw/master/doc/intellij-usage.png)
+![Intellij hint](https://gitlab.com/TurpIF/lambda-string/raw/master/doc/intellij-usage.png)
 
 
 To activate the LS agent with custom toString strategy, please use the following:
-- Download the [lambdaString-0.1.jar](https://gitlab.com/TurpIF/lambda-to-string/-/jobs/artifacts/v0.1/raw/target/lambdaString-0.1.jar?job=package%3Ajdk8)
-- Add `-javaagent:/path/to/lambdaString-0.1.jar=my.custom.ToStringStrategy` in your java options
+- Download the [lambda-string-0.2.jar](https://gitlab.com/TurpIF/lambda-string/-/jobs/artifacts/v0.2/raw/target/lambda-string-0.2.jar?job=package-jdk8)
+- Add `-javaagent:/path/to/lambda-string-0.2.jar=my.custom.ToStringStrategy` in your java options
 
 
 ## Why
@@ -89,10 +89,10 @@ This agent should be used during a debugging session with human interaction,
 so a little performance overhead is still acceptable as long as it is not perceptible by a human.
 Although, here is some benchmarks to give you some ideas of the potential impacts :
 
-- [HotSpot JVM 8](https://turpif.gitlab.io/lambda-to-string/benchmark/jre8/)
-- [HotSpot JVM 9](https://turpif.gitlab.io/lambda-to-string/benchmark/jre9/)
-- [HotSpot JVM 10](https://turpif.gitlab.io/lambda-to-string/benchmark/jre10/)
-- [IBM J9 VM (JRE 8)](https://turpif.gitlab.io/lambda-to-string/benchmark/jre8-ibm/)
+- [HotSpot JVM 8](https://turpif.gitlab.io/lambda-string/benchmark/jre8/)
+- [HotSpot JVM 9](https://turpif.gitlab.io/lambda-string/benchmark/jre9/)
+- [HotSpot JVM 10](https://turpif.gitlab.io/lambda-string/benchmark/jre10/)
+- [IBM J9 VM (JRE 8)](https://turpif.gitlab.io/lambda-string/benchmark/jre8-ibm/)
 
 To reduce the impacts, a particular attention is done when transforming the lambda runtime representations.
 Also, the majority of the computation is done when `toString` is effectively called.
@@ -132,7 +132,7 @@ a new implementation of the `LambdaToStringStrategy` interface.
 Then the agent setup should give the custom strategy class as below :
 
 ```bash
-java -javaagent:./lambdaString-0.1.jar=my.dummy.MyToStringStrategy my.dummy.Main
+java -javaagent:./lambda-string-0.2.jar=my.dummy.MyToStringStrategy my.dummy.Main
 ```
 
 Here is a sample of custom strategy returning a constant toString :
@@ -163,8 +163,8 @@ Installing a development environment needs few requirements:
 ### Installation
 
 ```bash
-git clone https://gitlab.com/TurpIF/lambda-to-string lambda-to-string
-cd lambda-to-string
+git clone https://gitlab.com/TurpIF/lambda-string lambda-string
+cd lambda-string
 mvn verify
 ```
 
@@ -173,8 +173,8 @@ Also, few scripts are available to simulate the gitlab CI pipeline through a sha
 Available testing JRE tasks are those matching the `test-jre*` pattern in the GitLab CI file.
 
 ```bash
-git clone https://gitlab.com/TurpIF/lambda-to-string lambda-to-string
-cd lambda-to-string
+git clone https://gitlab.com/TurpIF/lambda-string lambda-string
+cd lambda-string
 
 # GitLab Runner does not allow running pipeline with shared artifact, so the build-jre8 task should be called
 # once before running any testing task.
@@ -199,8 +199,8 @@ Running the benchmarks locally is equivalent to execute the tests.
 Available benchmarking JRE tasks are those matching the `benchmark-jre*` pattern in the GitLab CI file.
 
 ```bash
-git clone https://gitlab.com/TurpIF/lambda-to-string lambda-to-string
-cd lambda-to-string
+git clone https://gitlab.com/TurpIF/lambda-string lambda-string
+cd lambda-string
 
 # Build the agent and the benchmark JAR
 ./src/test/shell/build-jdk8.sh

pom.xml

@@ -9,7 +9,7 @@
 
     <name>lambda-string</name>
     <description>Lambda-string (LS) is a helping java agent that inject configurable toString method into lambdas with some useful meta-information</description>
-    <url>https://gitlab.com/TurpIF/lambda-to-string</url>
+    <url>https://gitlab.com/TurpIF/lambda-string</url>
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -43,9 +43,9 @@
     </developers>
 
     <scm>
-        <connection>scm:git:https://gitlab.com/TurpIF/lambda-to-string.git</connection>
-        <developerConnection>ssh://[email protected]:TurpIF/lambda-to-string.git</developerConnection>
-        <url>https://gitlab.com/TurpIF/lambda-to-string</url>
+        <connection>scm:git:https://gitlab.com/TurpIF/lambda-string.git</connection>
+        <developerConnection>ssh://[email protected]:TurpIF/lambda-string.git</developerConnection>
+        <url>https://gitlab.com/TurpIF/lambda-string</url>
     </scm>
 
     <dependencies>

src/test/shell/build-jdk8.sh

@@ -8,4 +8,4 @@ rm -rf /tmp/output/*
 gitlab-runner exec docker \
     --pre-build-script "ln -s /cache/ ./target" \
     --docker-volumes /tmp/output:/cache \
-    package:jdk8
+    package-jdk8