Lorenz 0.6.0

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: jamierocks

.gitignore

@@ -130,3 +130,4 @@ fabric.properties
 ### Lorenz ##
 lorenz*/build/
 lorenz*/out/
+run/

.mailmap

@@ -0,0 +1,2 @@
+# Jamie Mansfield <[email protected]>
+<[email protected]> <[email protected]>

.travis.yml

@@ -5,7 +5,8 @@ jdk:
 - oraclejdk8
 
 script: ./gradlew build
-after_success: '[[ "$TRAVIS_BRANCH" = "develop" ]] && ./gradlew uploadArchives'
+after_success:
+  - '[[ "$TRAVIS_PULL_REQUEST" = "false" && "$TRAVIS_BRANCH" = "develop" ]] && ./gradlew uploadArchives'
 
 # Ugh.
 notifications:

README.md

@@ -8,7 +8,6 @@ supports a variety of mapping formats:
 - SRG and its variants (CSRG, TSRG, and XSRG)
 - Enigma (through `lorenz-io-enigma`)
 - JAM (through `lorenz-io-jam`)
-- Kin (through `lorenz-io-kin`)
 - ProGuard (**reader only** through `lorenz-io-proguard`)
 
 ## Branches
@@ -79,5 +78,16 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 ```
 
+## Discuss
+
+**Found an issue with Lorenz?** [Make an issue]! We'd rather close invalid
+reports than have bugs go unreported :)
+
+We have an IRC channel on [EsperNet], `#cadix`, which is available for all
+[registered](https://esper.net/getting_started.php#registration) users to join
+and discuss Lorenz and other Cadix projects.
+
 [git-flow]: https://nvie.com/posts/a-successful-git-branching-model/
 [Sonatype's OSS repository]: https://oss.sonatype.org/content/repositories/snapshots/
+[Make an issue]: https://github.com/CadixDev/Lorenz/issues/new
+[EsperNet]: https://esper.net/

build.gradle.kts

@@ -3,23 +3,28 @@ import org.cadixdev.gradle.licenser.LicenseExtension
 
 plugins {
     `java-library`
+    jacoco
     id("org.cadixdev.licenser") version "0.5.0" apply false
 }
 
 val projectName: String by project
 val projectUrl: String by project
 val projectInceptionYear: String by project
 val bombeVersion: String by project
+val groovyVersion: String by project
+val spockVersion: String by project
 
 val isSnapshot = version.toString().endsWith("-SNAPSHOT")
 
 allprojects {
     group = "org.cadixdev"
-    version = "0.5.7"
+    version = "0.6.0-SNAPSHOT"
 }
 
 subprojects {
     apply<JavaLibraryPlugin>()
+    apply<GroovyPlugin>()
+    apply<JacocoPlugin>()
     apply<MavenPublishPlugin>()
     apply<Licenser>()
 
@@ -31,9 +36,14 @@ subprojects {
     }
 
     dependencies {
+        // Standard JUnit
         testImplementation(platform("org.junit:junit-bom:5.7.0"))
         testImplementation("org.junit.jupiter:junit-jupiter-api")
         testImplementation("org.junit.jupiter:junit-jupiter-engine")
+
+        // Spock
+        testImplementation("org.codehaus.groovy:groovy-all:$groovyVersion")
+        testImplementation("org.spockframework:spock-core:$spockVersion")
     }
 
     java {
@@ -60,6 +70,14 @@ subprojects {
         useJUnitPlatform()
     }
 
+    tasks.jacocoTestReport {
+        reports {
+            xml.isEnabled = false
+            csv.isEnabled = false
+            html.destination = file("${buildDir}/jacocoHtml")
+        }
+    }
+
     tasks.processResources {
         from(rootProject.file("LICENSE.txt"))
     }

changelogs/0.4.1.md → changelogs/0.4/0.4.1.md

@@ -5,6 +5,7 @@ This version of Lorenz addresses a critical bug in the Enigma writer, that cause
 output (totally broken).
 
 ### Broken
+
 ```
 CLASS none/aet
 

changelogs/0.5.8.md

@@ -0,0 +1,9 @@
+Lorenz 0.5.8
+===
+
+## Fixes
+
+- [GH-53]\: Don't de-obfuscate field types twice, which can cause
+  invalid output in some conditions.
+
+[GH-53]: https://github.com/CadixDev/Lorenz/issues/53

changelogs/0.6.0.md

@@ -0,0 +1,72 @@
+Lorenz 0.6.0
+============
+
+## Groovy DSL
+
+Lorenz now has a Groovy DSL, that simplifies the creation of mappings.
+
+```groovy
+def EXTRA = new ExtensionKey(String, 'extra')
+
+def mappings = MappingSetDsl.create {
+    klass('a') {
+        deobf = 'Demo'
+        extension EXTRA, 'demo data'
+
+        field('g') { deobf = 'name' }
+
+        method('h', '(Z)Ljava/lang/String;') {
+            deobf = 'getName'
+
+            param(0) { deobf = 'example' }
+        }
+    }
+}
+```
+
+To use the Groovy DSL, simply add `org.cadixdev:lorenz-dsl-groovy:0.6.0` to your build
+tool.
+
+## ASM Module
+
+Inline with changes made in Bombe 0.4.0, the ASM package is no more - with both classes
+now available under the same package in the core Lorenz module.
+
+## Enigma Module
+
+The Enigma mapping format no longer erroneously reports the standard file extension as
+being "enigma", but rather the standard (as set by cuchaz's mapping project, and continued
+by the Fabric Project) "mapping". The former file extension is included as a supported file
+extension with the new multiple file extension functionality (detailed below).
+
+Additionally, we now have support for reading/writing Fabric's fork of the format,
+registered as `fabric-engima`. This implements the two major format changes made by the
+Fabric Project: 1. the removal of the `none/` prefix for un-packaged classes, and 2. not using
+the fully qualified name for inner classes (i.e. with the parent class' name).
+
+## Mapping Formats
+
+### Registration
+
+Mapping Formats are still registered by use of service loaders, populating a registry in
+`MappingFormats` - however their registration key (identifier) is now more explicit, and
+formats are able to provide a name. Implementations must now provide the following:
+- Name (can be used by tools such as Symphony)
+- Identifier (used as the registration key)
+
+### File extensions
+
+Mapping Formats can now specify multiple file extensions that are typical, this will allow
+tools such as Symphony and Nocturne to give richer (and more useful) file choice dialogs.
+
+### Miscellaneous
+
+- Mapping formats can now specify whether they support reading and writing. This will allow
+  tools, for example, to only show supported formats in a file save or file read dialog
+- The Kin IO module has been removed.
+
+## Conveniences
+
+- `Mapping#set(key, value)` now returns the `Mapping` allowing for fluent method calls.
+- The de-obfuscated names of `Mapping`s are now observable, through
+  `Mapping#addListener(MappingChangedListener)`.

etc/codestyle-intellij.xml

@@ -0,0 +1,68 @@
+<code_scheme name="jr2019" version="173">
+  <GroovyCodeStyleSettings>
+    <option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="1000" />
+    <option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="1000" />
+    <option name="PACKAGES_TO_USE_IMPORT_ON_DEMAND">
+      <value />
+    </option>
+    <option name="IMPORT_LAYOUT_TABLE">
+      <value>
+        <package name="" withSubpackages="true" static="true" />
+        <emptyLine />
+        <package name="" withSubpackages="true" static="false" />
+        <emptyLine />
+        <package name="javax" withSubpackages="true" static="false" />
+        <package name="java" withSubpackages="true" static="false" />
+      </value>
+    </option>
+  </GroovyCodeStyleSettings>
+  <JavaCodeStyleSettings>
+    <option name="GENERATE_FINAL_LOCALS" value="true" />
+    <option name="GENERATE_FINAL_PARAMETERS" value="true" />
+    <option name="REPLACE_INSTANCEOF_AND_CAST" value="true" />
+    <option name="CLASS_NAMES_IN_JAVADOC" value="3" />
+    <option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="1000" />
+    <option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="1000" />
+    <option name="PACKAGES_TO_USE_IMPORT_ON_DEMAND">
+      <value />
+    </option>
+    <option name="IMPORT_LAYOUT_TABLE">
+      <value>
+        <package name="" withSubpackages="true" static="true" />
+        <emptyLine />
+        <package name="" withSubpackages="true" static="false" />
+        <emptyLine />
+        <package name="javax" withSubpackages="true" static="false" />
+        <package name="java" withSubpackages="true" static="false" />
+      </value>
+    </option>
+    <option name="JD_ALIGN_PARAM_COMMENTS" value="false" />
+    <option name="JD_ALIGN_EXCEPTION_COMMENTS" value="false" />
+  </JavaCodeStyleSettings>
+  <JetCodeStyleSettings>
+    <option name="PACKAGES_TO_USE_STAR_IMPORTS">
+      <value />
+    </option>
+    <option name="NAME_COUNT_TO_USE_STAR_IMPORT" value="100" />
+    <option name="NAME_COUNT_TO_USE_STAR_IMPORT_FOR_MEMBERS" value="100" />
+  </JetCodeStyleSettings>
+  <codeStyleSettings language="Groovy">
+    <option name="ELSE_ON_NEW_LINE" value="true" />
+    <option name="CATCH_ON_NEW_LINE" value="true" />
+    <option name="FINALLY_ON_NEW_LINE" value="true" />
+  </codeStyleSettings>
+  <codeStyleSettings language="JAVA">
+    <option name="BLANK_LINES_AFTER_CLASS_HEADER" value="1" />
+    <option name="BLANK_LINES_BEFORE_CLASS_END" value="1" />
+    <option name="ELSE_ON_NEW_LINE" value="true" />
+    <option name="WHILE_ON_NEW_LINE" value="true" />
+    <option name="CATCH_ON_NEW_LINE" value="true" />
+    <option name="FINALLY_ON_NEW_LINE" value="true" />
+    <option name="ALIGN_MULTILINE_EXTENDS_LIST" value="true" />
+  </codeStyleSettings>
+  <codeStyleSettings language="kotlin">
+    <option name="ELSE_ON_NEW_LINE" value="true" />
+    <option name="CATCH_ON_NEW_LINE" value="true" />
+    <option name="FINALLY_ON_NEW_LINE" value="true" />
+  </codeStyleSettings>
+</code_scheme>

gradle.properties

@@ -4,4 +4,9 @@ projectUrl = https://www.cadixdev.org/
 projectInceptionYear = 2016
 
 # Build Settings
-bombeVersion = 0.3.4
+javaVersion = 1.8
+groovyVersion = 3.0.7
+asmVersion = 7.1
+bombeVersion = 0.5.0-SNAPSHOT
+junitVersion = 5.5.1
+spockVersion = 2.0-M4-groovy-3.0

lorenz-dsl-groovy/build.gradle.kts

@@ -0,0 +1,14 @@
+plugins {
+    `java-library`
+}
+
+val groovyVersion: String by rootProject
+
+dependencies {
+    implementation("org.codehaus.groovy:groovy:$groovyVersion")
+    api(project(":lorenz"))
+}
+
+tasks.jar.configure {
+    manifest.attributes(mapOf("Automatic-Module-Name" to "${project.group}.lorenz.dsl.groovy"))
+}

lorenz-dsl-groovy/gradle.properties

@@ -0,0 +1,4 @@
+projectName = Lorenz-DSL-Groovy
+description = A DSL for easing use of Lorenz within Groovy projects.
+projectUrl = https://www.jamiemansfield.me/projects/lorenz
+projectInceptionYear = 2019