diff --git a/.github/RELEASE_CHECKLIST.md b/.github/RELEASE_CHECKLIST.md index 141463a54..50d774001 100644 --- a/.github/RELEASE_CHECKLIST.md +++ b/.github/RELEASE_CHECKLIST.md @@ -6,10 +6,21 @@ * Make sure to preview the change notes in the IDE by loading the plugin. * Make sure the list of acknowledgements is up-to-date. * Update screenshots and GIFs in `.github/img/` and on the plugin repository if necessary. + * Use the project in `src/test/resources/screenshots/` to store code snippets in. + Do not store `.idea/`, `.gradle`, and similar build files in this project. + * Hide (inlay) hints and set font size to 20. * Distance between bottom of "Refresh" button and top of button bar at bottom is 50 pixels, or the original distance, whichever is smaller. * On Linux, the screen can be recorded using [peek](https://github.com/phw/peek) or [SimpleScreenRecorder](https://www.maartenbaert.be/simplescreenrecorder/). + * Reducing GIF size is a difficult process. + The following seems to work fine: + 1. `for f in ./*.webm; do ffmpeg -y -i "$f" -vf "fps=10,scale=768:-1:flags=lanczos,split[s0][s1];[s0]palettegen[p];[s1][p]paletteuse" -loop 0 "${f%.*}.gif"; done` + 2. Go to [ezgif](https://ezgif.com/optimize) and upload the GIF to reduce in size. + 3. Apply the following optimisations in question; after each result, you can click "Optimize" to apply another filter: + 1. "Color Reduction" to 64 colours + 2. "Optimize Transparency" with 2% fuzz + 3. "Lossy GIF" with compression level 30 * Ensure documentation generates without errors, and push the documentation to the `gh-pages` branch. ## Verification diff --git a/.github/img/array-insertion-sample.gif b/.github/img/array-insertion-sample.gif index cd92ca995..d717c9b5b 100644 Binary files a/.github/img/array-insertion-sample.gif and b/.github/img/array-insertion-sample.gif differ diff --git a/.github/img/configuration-sample.gif b/.github/img/configuration-sample.gif index 9f118ff02..687e6c71a 100644 Binary files a/.github/img/configuration-sample.gif and b/.github/img/configuration-sample.gif differ diff --git a/.github/img/fast-insertion.png b/.github/img/fast-insertion.png index 17aece038..c18cc2af3 100644 Binary files a/.github/img/fast-insertion.png and b/.github/img/fast-insertion.png differ diff --git a/.github/img/insertion-sample.gif b/.github/img/insertion-sample.gif index 90b6f51bc..965c61cc9 100644 Binary files a/.github/img/insertion-sample.gif and b/.github/img/insertion-sample.gif differ diff --git a/.github/img/previews.gif b/.github/img/previews.gif new file mode 100644 index 000000000..669dddffc Binary files /dev/null and b/.github/img/previews.gif differ diff --git a/.github/img/shortcuts.png b/.github/img/shortcuts.png index 65f79a9f7..2010bbcd6 100644 Binary files a/.github/img/shortcuts.png and b/.github/img/shortcuts.png differ diff --git a/CHANGELOG.md b/CHANGELOG.md index fb1d3aa90..2d5f2123a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,5 @@ # Changelog -## Unreleased +## 3.0.0 -- 2023-11-17 This release brings a major overhaul of how data is generated, allowing you to create your own data types such as IP addresses or entire JSON objects. At the same time, it remains just as easy to generate plain numbers. @@ -11,8 +11,8 @@ Check the plugin description for more details and animated usage examples. * In addition to a list of standard separators, you can now also choose your own separator for all data types, including for arrays. * You can automatically pad (or truncate) integers to a specific length. -* A notification is shown after upgrading to v3 to inform the user of incompatibilities with settings from older - versions. +* A notification is shown after upgrading to Randomness 3 to inform the user of incompatibilities with settings from + older versions. * Future backwards compatibility ensures that your settings can always be imported into future versions. ### Changed diff --git a/README.md b/README.md index f042b1945..2ab6775d3 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,6 @@ Documentation

-# This README is about the upcoming v3 release. For information about the latest public version, [check the old README](https://github.com/FWDekker/intellij-randomness/tree/v2) - Rather than going to [random.org](https://www.random.org/) or making up your own random data, you can now insert random numbers, UUIDs, names, IP addresses, and much more using an IntelliJ action! @@ -43,7 +41,7 @@ Randomness can also be found in the main menu under Tools or in There are six basic data types that can be inserted and customised: 1. **Integers**, such as `7,826,922`, from a custom range, in any base from binary to hexatrigesimal. 2. **Decimals**, such as `8,816,573.10`, using customisable separators. - 3. **Strings**, such as `"PaQDQqSBEH"`, specified using a regex. + 3. **Strings**, such as `"PaQDQqSBEH"`, with support for reverse regex. 4. **Words**, such as `"Bridge"`, with predefined or custom word lists. 5. **UUIDs**, such as `0caa7b28-fe58-4ba6-a25a-9e5beaaf8f4b`, with or without dashes. 6. **Date-times**, such as `2022-02-03 19:03`, or any other format you want. @@ -58,7 +56,7 @@ Randomness can also be found in the main menu under Tools or in Animation of how to configure templates * 🗃️ **Arrays**
Need a lot of data? - Insert **an entire array** of any template you want. + Insert an **entire array** of any template you want. For example, an array of integers might look like `[978, 881, 118, 286, 288]`. You can customise the brackets, delimiter, and number of elements to your liking every time you insert an array, because no two arrays are the same. @@ -82,6 +80,8 @@ Randomness can also be found in the main menu under Tools or in * 👀 **Previews**
To **help you decide** what settings to choose, a preview of the template is shown while you're editing. + Preview window in Randomness + ## 💻 Development This section contains instructions in case you want to build the plugin from source or want to help with development. diff --git a/build.gradle.kts b/build.gradle.kts index 15248e235..6a8ef223b 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -77,7 +77,8 @@ tasks { patchPluginXml { changeNotes.set(provider { changelog.renderItem( - changelog.getUnreleased(), + if (changelog.has(properties("version"))) changelog.get(properties("version")) + else changelog.getUnreleased(), Changelog.OutputType.HTML ) }) diff --git a/src/main/resources/META-INF/description.html b/src/main/resources/META-INF/description.html index 8edd9cdf4..f8c6914b3 100644 --- a/src/main/resources/META-INF/description.html +++ b/src/main/resources/META-INF/description.html @@ -9,7 +9,7 @@

🕸 Data Types

  1. Integers, such as 7,826,922, from a custom range, in any base from binary to hexatrigesimal.
  2. Decimals, such as 8,816,573.10, using customisable separators.
    3. -
  3. Strings, such as "PaQDQqSBEH", specified using a regex.
    4. +
  4. Strings, such as "PaQDQqSBEH", with support for reverse regex.
  5. Words, such as "Bridge", with predefined or custom word lists.
  6. UUIDs, such as 0caa7b28-fe58-4ba6-a25a-9e5beaaf8f4b, with or without dashes.
  7. Date-times, such as 2022-02-03 19:03, or any other format you want.
    8. @@ -25,7 +25,7 @@

    🧬 Templates

    🗃️ Arrays

    Need a lot of data? -Insert an entire array of any template you want. +Insert an entire array of any template you want. For example, an array of integers might look like [978, 881, 118, 286, 288]. You can customise the brackets, delimiter, and number of elements to your liking every time you insert an array, because no two arrays are the same. diff --git a/src/test/kotlin/com/fwdekker/randomness/template/TemplateListConfigurableTest.kt b/src/test/kotlin/com/fwdekker/randomness/template/TemplateListConfigurableTest.kt index 9fd30591c..b9f33734f 100644 --- a/src/test/kotlin/com/fwdekker/randomness/template/TemplateListConfigurableTest.kt +++ b/src/test/kotlin/com/fwdekker/randomness/template/TemplateListConfigurableTest.kt @@ -24,7 +24,7 @@ import org.assertj.swing.fixture.FrameFixture /** * Unit tests for [TemplateListConfigurable]. */ -class TemplateListConfigurableTest : FunSpec({ +object TemplateListConfigurableTest : FunSpec({ tags(Tags.IDEA_FIXTURE) diff --git a/src/test/resources/screenshots/README.md b/src/test/resources/screenshots/README.md new file mode 100644 index 000000000..9a1858b8c --- /dev/null +++ b/src/test/resources/screenshots/README.md @@ -0,0 +1,2 @@ +# Randomness Screenshots +Used to store snippets that can be used in screenshots for in the README. diff --git a/src/test/resources/screenshots/build.gradle.kts b/src/test/resources/screenshots/build.gradle.kts new file mode 100644 index 000000000..be843bc8e --- /dev/null +++ b/src/test/resources/screenshots/build.gradle.kts @@ -0,0 +1,22 @@ +plugins { + id("java") +} + +group = "com.fwdekker" +version = "1.0.0" + +repositories { + mavenCentral() +} + +dependencies { + testImplementation("org.junit.jupiter:junit-jupiter-api:5.10.1") + testImplementation("org.assertj:assertj-core:3.24.2") + testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.10.1") +} + +tasks { + test { + useJUnitPlatform() + } +} diff --git a/src/test/resources/screenshots/gradle/wrapper/gradle-wrapper.jar b/src/test/resources/screenshots/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 000000000..249e5832f Binary files /dev/null and b/src/test/resources/screenshots/gradle/wrapper/gradle-wrapper.jar differ diff --git a/src/test/resources/screenshots/gradle/wrapper/gradle-wrapper.properties b/src/test/resources/screenshots/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 000000000..fce403e45 --- /dev/null +++ b/src/test/resources/screenshots/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-all.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/src/test/resources/screenshots/gradlew b/src/test/resources/screenshots/gradlew new file mode 100755 index 000000000..a69d9cb6c --- /dev/null +++ b/src/test/resources/screenshots/gradlew @@ -0,0 +1,240 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed 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 +# +# https://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. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/src/test/resources/screenshots/gradlew.bat b/src/test/resources/screenshots/gradlew.bat new file mode 100644 index 000000000..53a6b238d --- /dev/null +++ b/src/test/resources/screenshots/gradlew.bat @@ -0,0 +1,91 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/src/test/resources/screenshots/settings.gradle.kts b/src/test/resources/screenshots/settings.gradle.kts new file mode 100644 index 000000000..918ce4c93 --- /dev/null +++ b/src/test/resources/screenshots/settings.gradle.kts @@ -0,0 +1 @@ +rootProject.name = "randomness-screenshots" diff --git a/src/test/resources/screenshots/src/main/java/Foo.java b/src/test/resources/screenshots/src/main/java/Foo.java new file mode 100644 index 000000000..567a4373d --- /dev/null +++ b/src/test/resources/screenshots/src/main/java/Foo.java @@ -0,0 +1,8 @@ +import java.util.ArrayList; +import java.util.List; + +public record Foo(String name) { + public List getChildren() { + return new ArrayList<>(); + } +} diff --git a/src/test/resources/screenshots/src/test/java/FooTest.java b/src/test/resources/screenshots/src/test/java/FooTest.java new file mode 100644 index 000000000..ccf6f6307 --- /dev/null +++ b/src/test/resources/screenshots/src/test/java/FooTest.java @@ -0,0 +1,37 @@ +import org.junit.jupiter.api.Test; + +import java.util.List; + +import static org.assertj.core.api.Assertions.assertThat; + +public class FooTest { + @Test + public void testFoo() { + Foo foo = new Foo("Saleh Do"); + + assertThat(foo.name()).isEqualTo("Saleh Do"); + } + + @Test + public void testBar() { + Foo foo = new Foo("Chao Mostafa"); + + assertThat(foo.getChildren()) + .containsExactlyElementsOf(List.of(new Foo("Jonathan Mohammed"), new Foo("Michael Qiu"))); + } + + @Test + public void testBaz() { + Foo foo = new Foo("Mohan Martins"); + + assertThat(foo.getChildren()) + .doesNotContain(new Foo("Mohan Martins")); + } + + @Test + public void testQux() { + Foo foo = new Foo("Fatima Alvarez"); + + assertThat(foo.getChildren()).contains(new Foo("Mohan Martins")); + } +}