├── .github └── workflows │ ├── build.yml │ └── publish.yml ├── .gitignore ├── LICENSE ├── README.md ├── build.gradle.kts ├── gradle-plugin ├── .gitignore ├── build.gradle.kts └── src │ └── main │ └── kotlin │ └── com │ └── cherryperry │ └── nostrings │ ├── DataClassNoStringExtension.kt │ ├── DataClassNoStringGradleSubplugin.kt │ └── DataClassNoStringPlugin.kt ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── kotlin-plugin ├── .gitignore ├── build.gradle.kts └── src │ └── main │ └── kotlin │ └── com │ └── cherryperry │ └── nostrings │ ├── DataClassNoStringClassBuilder.kt │ ├── DataClassNoStringClassGenerationInterceptor.kt │ ├── DataClassNoStringCommandLineProcessor.kt │ ├── DataClassNoStringComponentRegistrar.kt │ └── DataClassNoStringOptions.kt ├── sample ├── .gitignore ├── build.gradle.kts └── src │ ├── main │ └── kotlin │ │ └── com │ │ └── cherryperry │ │ └── nostrings │ │ └── App.kt │ └── test │ └── kotlin │ └── com │ └── cherryperry │ └── nostrings │ └── AppTest.kt └── settings.gradle.kts /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | pull_request: 8 | 9 | jobs: 10 | build: 11 | name: Build 12 | runs-on: ubuntu-latest 13 | steps: 14 | - name: Checkout 15 | uses: actions/checkout@v2 16 | - name: Cache 17 | uses: actions/cache@v2 18 | with: 19 | path: | 20 | ~/.gradle/caches 21 | ~/.gradle/wrapper 22 | key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }} 23 | restore-keys: | 24 | ${{ runner.os }}-gradle- 25 | - name: Validate Gradle Wrapper 26 | uses: gradle/wrapper-validation-action@v1 27 | - name: Build 28 | run: ./gradlew build 29 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish 2 | 3 | on: 4 | release: 5 | types: [ created ] 6 | 7 | jobs: 8 | build: 9 | name: Publish 10 | runs-on: ubuntu-latest 11 | steps: 12 | - name: Checkout 13 | uses: actions/checkout@v2 14 | - name: Cache 15 | uses: actions/cache@v2 16 | with: 17 | path: | 18 | ~/.gradle/caches 19 | ~/.gradle/wrapper 20 | key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }} 21 | restore-keys: | 22 | ${{ runner.os }}-gradle- 23 | - name: Validate Gradle Wrapper 24 | uses: gradle/wrapper-validation-action@v1 25 | - name: Publish 26 | run: ./gradlew publish -Ppublish.user=${{ secrets.PUBLISH_USER }} -Ppublish.key=${{ secrets.PUBLISH_KEY }} 27 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /.gradle 2 | /build 3 | /out 4 | 5 | .DS_Store 6 | Thumbs.db 7 | 8 | /.idea 9 | *.iml 10 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2020 CherryPerry, Anatolii Afanasev 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # DataClassNoString 2 | 3 | [![Download](https://api.bintray.com/packages/cherryperry/maven/DataClassNoString/images/download.svg)](https://bintray.com/cherryperry/maven/DataClassNoString/_latestVersion) 4 | [![License](https://img.shields.io/badge/Licence-MIT-blue)](https://github.com/badoo/Reaktive/blob/master/LICENSE) 5 | [![Build Status](https://github.com/CherryPerry/DataClassNoString/workflows/Build/badge.svg?branch=master)](https://github.com/CherryPerry/DataClassNoString/actions) 6 | 7 | Kotlin compiler plugin, that removes `toString()`, `equals(any: Any)` and `hashCode()` functions from your data classes. 8 | 9 | ## Motivation 10 | 11 | Kotlin is cool and data class are cool. But sometimes we overuse them in places where we actually do not need to. So the 12 | question is what is a price of using data classes when we actually do not need them? To answer this question I decide to 13 | explore edge case situation when we consider all data classes in a project as useless and replaceable with simple 14 | classes. After applying this compiler plugin we should see the price (APK size) which we pay for using data classes. 15 | 16 | ## Usage 17 | 18 | ```groovy 19 | buildscript { 20 | repositories { 21 | maven { url 'https://dl.bintray.com/cherryperry/maven' } 22 | } 23 | dependencies { 24 | classpath 'com.cherryperry.nostrings:gradle-plugin:VERSION' 25 | } 26 | } 27 | 28 | repositories { 29 | maven { url 'https://dl.bintray.com/cherryperry/maven' } 30 | } 31 | 32 | apply plugin: 'com.cherryperry.nostrings' 33 | 34 | dataClassNoString { 35 | enabled = true / false 36 | removeAll = true / false // Remove everything or toString() only 37 | } 38 | ``` 39 | 40 | Compile your app and compare the results by using [diffuse](https://github.com/JakeWharton/diffuse). 41 | 42 | You should see the difference in dex size, method and string count. 43 | -------------------------------------------------------------------------------- /build.gradle.kts: -------------------------------------------------------------------------------- 1 | import org.jetbrains.kotlin.gradle.tasks.KotlinCompile 2 | 3 | plugins { 4 | kotlin("jvm") version "1.4.20" apply false 5 | } 6 | 7 | allprojects { 8 | 9 | group = "com.cherryperry.nostrings" 10 | version = "1.4.0" 11 | 12 | repositories { 13 | jcenter() 14 | maven("https://dl.bintray.com/cherryperry/maven") 15 | } 16 | 17 | } 18 | 19 | subprojects { 20 | tasks.withType { 21 | kotlinOptions { 22 | jvmTarget = JavaVersion.VERSION_1_8.toString() 23 | apiVersion = "1.3" 24 | languageVersion = "1.3" 25 | } 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /gradle-plugin/.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | -------------------------------------------------------------------------------- /gradle-plugin/build.gradle.kts: -------------------------------------------------------------------------------- 1 | plugins { 2 | kotlin("jvm") 3 | kotlin("kapt") 4 | `java-gradle-plugin` 5 | `maven-publish` 6 | } 7 | 8 | dependencies { 9 | implementation(kotlin("stdlib-jdk8")) 10 | implementation(kotlin("gradle-plugin-api")) 11 | implementation("com.google.auto.service:auto-service:1.0-rc7") 12 | kapt("com.google.auto.service:auto-service:1.0-rc7") 13 | } 14 | 15 | gradlePlugin { 16 | plugins { 17 | register("plugin") { 18 | id = "com.cherryperry.nostrings" 19 | implementationClass = "com.cherryperry.nostrings.DataClassNoStringPlugin" 20 | } 21 | } 22 | } 23 | 24 | publishing { 25 | repositories { 26 | maven { 27 | name = "bintray" 28 | url = uri("https://api.bintray.com/maven/cherryperry/maven/DataClassNoString/;publish=1") 29 | credentials { 30 | username = project.findProperty("publish.user") as String? 31 | password = project.findProperty("publish.key") as String? 32 | } 33 | } 34 | } 35 | } 36 | 37 | tasks.named("jar", org.gradle.jvm.tasks.Jar::class.java) { 38 | manifest.attributes("Implementation-Version" to archiveVersion) 39 | } 40 | -------------------------------------------------------------------------------- /gradle-plugin/src/main/kotlin/com/cherryperry/nostrings/DataClassNoStringExtension.kt: -------------------------------------------------------------------------------- 1 | package com.cherryperry.nostrings 2 | 3 | open class DataClassNoStringExtension { 4 | var enabled: Boolean = true 5 | var removeAll: Boolean = true 6 | } 7 | -------------------------------------------------------------------------------- /gradle-plugin/src/main/kotlin/com/cherryperry/nostrings/DataClassNoStringGradleSubplugin.kt: -------------------------------------------------------------------------------- 1 | package com.cherryperry.nostrings 2 | 3 | import com.google.auto.service.AutoService 4 | import org.gradle.api.Project 5 | import org.gradle.api.tasks.compile.AbstractCompile 6 | import org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions 7 | import org.jetbrains.kotlin.gradle.plugin.KotlinCompilation 8 | import org.jetbrains.kotlin.gradle.plugin.KotlinGradleSubplugin 9 | import org.jetbrains.kotlin.gradle.plugin.SubpluginArtifact 10 | import org.jetbrains.kotlin.gradle.plugin.SubpluginOption 11 | 12 | @AutoService(KotlinGradleSubplugin::class) 13 | class DataClassNoStringGradleSubplugin : KotlinGradleSubplugin { 14 | 15 | private val version: String by lazy { 16 | this::class.java.`package`.implementationVersion 17 | } 18 | 19 | override fun isApplicable(project: Project, task: AbstractCompile): Boolean = 20 | project.plugins.hasPlugin(DataClassNoStringPlugin::class.java) 21 | 22 | override fun apply( 23 | project: Project, 24 | kotlinCompile: AbstractCompile, 25 | javaCompile: AbstractCompile?, 26 | variantData: Any?, 27 | androidProjectHandler: Any?, 28 | kotlinCompilation: KotlinCompilation? 29 | ): List { 30 | val extension = 31 | project 32 | .extensions 33 | .findByType(DataClassNoStringExtension::class.java) 34 | ?: DataClassNoStringExtension() 35 | 36 | val enabled = SubpluginOption("enabled", extension.enabled.toString()) 37 | val removeAll = SubpluginOption("removeAll", extension.removeAll.toString()) 38 | 39 | return listOf(enabled, removeAll) 40 | } 41 | 42 | override fun getCompilerPluginId(): String = "data-class-no-string" 43 | 44 | override fun getPluginArtifact(): SubpluginArtifact = 45 | SubpluginArtifact("com.cherryperry.nostrings", "kotlin-plugin", version) 46 | 47 | } 48 | -------------------------------------------------------------------------------- /gradle-plugin/src/main/kotlin/com/cherryperry/nostrings/DataClassNoStringPlugin.kt: -------------------------------------------------------------------------------- 1 | package com.cherryperry.nostrings 2 | 3 | import org.gradle.api.Plugin 4 | import org.gradle.api.Project 5 | 6 | class DataClassNoStringPlugin : Plugin { 7 | 8 | override fun apply(project: Project) { 9 | project.extensions.create(EXTENSION_NAME, DataClassNoStringExtension::class.java) 10 | } 11 | 12 | companion object { 13 | const val EXTENSION_NAME = "dataClassNoString" 14 | } 15 | 16 | } 17 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CherryPerry/DataClassNoString/c48c8ad6fb6e1373c66b956ca09e70107e132f38/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-6.8-all.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | # 4 | # Copyright 2015 the original author or authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | ## 21 | ## Gradle start up script for UN*X 22 | ## 23 | ############################################################################## 24 | 25 | # Attempt to set APP_HOME 26 | # Resolve links: $0 may be a link 27 | PRG="$0" 28 | # Need this for relative symlinks. 29 | while [ -h "$PRG" ] ; do 30 | ls=`ls -ld "$PRG"` 31 | link=`expr "$ls" : '.*-> \(.*\)$'` 32 | if expr "$link" : '/.*' > /dev/null; then 33 | PRG="$link" 34 | else 35 | PRG=`dirname "$PRG"`"/$link" 36 | fi 37 | done 38 | SAVED="`pwd`" 39 | cd "`dirname \"$PRG\"`/" >/dev/null 40 | APP_HOME="`pwd -P`" 41 | cd "$SAVED" >/dev/null 42 | 43 | APP_NAME="Gradle" 44 | APP_BASE_NAME=`basename "$0"` 45 | 46 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 47 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 48 | 49 | # Use the maximum available, or set MAX_FD != -1 to use that value. 50 | MAX_FD="maximum" 51 | 52 | warn () { 53 | echo "$*" 54 | } 55 | 56 | die () { 57 | echo 58 | echo "$*" 59 | echo 60 | exit 1 61 | } 62 | 63 | # OS specific support (must be 'true' or 'false'). 64 | cygwin=false 65 | msys=false 66 | darwin=false 67 | nonstop=false 68 | case "`uname`" in 69 | CYGWIN* ) 70 | cygwin=true 71 | ;; 72 | Darwin* ) 73 | darwin=true 74 | ;; 75 | MINGW* ) 76 | msys=true 77 | ;; 78 | NONSTOP* ) 79 | nonstop=true 80 | ;; 81 | esac 82 | 83 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 84 | 85 | # Determine the Java command to use to start the JVM. 86 | if [ -n "$JAVA_HOME" ] ; then 87 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 88 | # IBM's JDK on AIX uses strange locations for the executables 89 | JAVACMD="$JAVA_HOME/jre/sh/java" 90 | else 91 | JAVACMD="$JAVA_HOME/bin/java" 92 | fi 93 | if [ ! -x "$JAVACMD" ] ; then 94 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 95 | 96 | Please set the JAVA_HOME variable in your environment to match the 97 | location of your Java installation." 98 | fi 99 | else 100 | JAVACMD="java" 101 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 102 | 103 | Please set the JAVA_HOME variable in your environment to match the 104 | location of your Java installation." 105 | fi 106 | 107 | # Increase the maximum file descriptors if we can. 108 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 109 | MAX_FD_LIMIT=`ulimit -H -n` 110 | if [ $? -eq 0 ] ; then 111 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 112 | MAX_FD="$MAX_FD_LIMIT" 113 | fi 114 | ulimit -n $MAX_FD 115 | if [ $? -ne 0 ] ; then 116 | warn "Could not set maximum file descriptor limit: $MAX_FD" 117 | fi 118 | else 119 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 120 | fi 121 | fi 122 | 123 | # For Darwin, add options to specify how the application appears in the dock 124 | if $darwin; then 125 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 126 | fi 127 | 128 | # For Cygwin, switch paths to Windows format before running java 129 | if $cygwin ; then 130 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 131 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 132 | JAVACMD=`cygpath --unix "$JAVACMD"` 133 | 134 | # We build the pattern for arguments to be converted via cygpath 135 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 136 | SEP="" 137 | for dir in $ROOTDIRSRAW ; do 138 | ROOTDIRS="$ROOTDIRS$SEP$dir" 139 | SEP="|" 140 | done 141 | OURCYGPATTERN="(^($ROOTDIRS))" 142 | # Add a user-defined pattern to the cygpath arguments 143 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 144 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 145 | fi 146 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 147 | i=0 148 | for arg in "$@" ; do 149 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 150 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 151 | 152 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 153 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 154 | else 155 | eval `echo args$i`="\"$arg\"" 156 | fi 157 | i=$((i+1)) 158 | done 159 | case $i in 160 | (0) set -- ;; 161 | (1) set -- "$args0" ;; 162 | (2) set -- "$args0" "$args1" ;; 163 | (3) set -- "$args0" "$args1" "$args2" ;; 164 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 165 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 166 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 167 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 168 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 169 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 170 | esac 171 | fi 172 | 173 | # Escape application args 174 | save () { 175 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 176 | echo " " 177 | } 178 | APP_ARGS=$(save "$@") 179 | 180 | # Collect all arguments for the java command, following the shell quoting and substitution rules 181 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 182 | 183 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 184 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 185 | cd "$(dirname "$0")" 186 | fi 187 | 188 | exec "$JAVACMD" "$@" 189 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem http://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 33 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 34 | 35 | @rem Find java.exe 36 | if defined JAVA_HOME goto findJavaFromJavaHome 37 | 38 | set JAVA_EXE=java.exe 39 | %JAVA_EXE% -version >NUL 2>&1 40 | if "%ERRORLEVEL%" == "0" goto init 41 | 42 | echo. 43 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 44 | echo. 45 | echo Please set the JAVA_HOME variable in your environment to match the 46 | echo location of your Java installation. 47 | 48 | goto fail 49 | 50 | :findJavaFromJavaHome 51 | set JAVA_HOME=%JAVA_HOME:"=% 52 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 53 | 54 | if exist "%JAVA_EXE%" goto init 55 | 56 | echo. 57 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 58 | echo. 59 | echo Please set the JAVA_HOME variable in your environment to match the 60 | echo location of your Java installation. 61 | 62 | goto fail 63 | 64 | :init 65 | @rem Get command-line arguments, handling Windows variants 66 | 67 | if not "%OS%" == "Windows_NT" goto win9xME_args 68 | 69 | :win9xME_args 70 | @rem Slurp the command line arguments. 71 | set CMD_LINE_ARGS= 72 | set _SKIP=2 73 | 74 | :win9xME_args_slurp 75 | if "x%~1" == "x" goto execute 76 | 77 | set CMD_LINE_ARGS=%* 78 | 79 | :execute 80 | @rem Setup the command line 81 | 82 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 83 | 84 | @rem Execute Gradle 85 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 86 | 87 | :end 88 | @rem End local scope for the variables with windows NT shell 89 | if "%ERRORLEVEL%"=="0" goto mainEnd 90 | 91 | :fail 92 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 93 | rem the _cmd.exe /c_ return code! 94 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 95 | exit /b 1 96 | 97 | :mainEnd 98 | if "%OS%"=="Windows_NT" endlocal 99 | 100 | :omega 101 | -------------------------------------------------------------------------------- /kotlin-plugin/.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | -------------------------------------------------------------------------------- /kotlin-plugin/build.gradle.kts: -------------------------------------------------------------------------------- 1 | plugins { 2 | kotlin("jvm") 3 | kotlin("kapt") 4 | `maven-publish` 5 | } 6 | 7 | dependencies { 8 | implementation(kotlin("stdlib-jdk8")) 9 | implementation(kotlin("compiler-embeddable")) 10 | implementation("com.google.auto.service:auto-service:1.0-rc7") 11 | kapt("com.google.auto.service:auto-service:1.0-rc7") 12 | } 13 | 14 | publishing { 15 | publications { 16 | register("maven", MavenPublication::class.java) { 17 | from(components["java"]) 18 | } 19 | } 20 | repositories { 21 | maven { 22 | name = "bintray" 23 | url = uri("https://api.bintray.com/maven/cherryperry/maven/DataClassNoString/;publish=1") 24 | credentials { 25 | username = project.findProperty("publish.user") as String? 26 | password = project.findProperty("publish.key") as String? 27 | } 28 | } 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /kotlin-plugin/src/main/kotlin/com/cherryperry/nostrings/DataClassNoStringClassBuilder.kt: -------------------------------------------------------------------------------- 1 | package com.cherryperry.nostrings 2 | 3 | import org.jetbrains.kotlin.codegen.ClassBuilder 4 | import org.jetbrains.kotlin.codegen.DelegatingClassBuilder 5 | import org.jetbrains.kotlin.resolve.jvm.diagnostics.JvmDeclarationOrigin 6 | import org.jetbrains.org.objectweb.asm.MethodVisitor 7 | import org.jetbrains.org.objectweb.asm.Opcodes 8 | 9 | class DataClassNoStringClassBuilder( 10 | val classBuilder: ClassBuilder, 11 | private val removeAll: Boolean 12 | ) : DelegatingClassBuilder() { 13 | 14 | override fun getDelegate(): ClassBuilder = classBuilder 15 | 16 | override fun newMethod( 17 | origin: JvmDeclarationOrigin, 18 | access: Int, 19 | name: String, 20 | desc: String, 21 | signature: String?, 22 | exceptions: Array? 23 | ): MethodVisitor { 24 | val callSuper: () -> MethodVisitor = { super.newMethod(origin, access, name, desc, signature, exceptions) } 25 | return when (name) { 26 | "toString" -> EmptyVisitor 27 | "hashCode" -> if (removeAll) EmptyVisitor else callSuper() 28 | "equals" -> if (removeAll) EmptyVisitor else callSuper() 29 | else -> callSuper() 30 | } 31 | } 32 | 33 | private object EmptyVisitor : MethodVisitor(Opcodes.ASM5) 34 | 35 | } 36 | -------------------------------------------------------------------------------- /kotlin-plugin/src/main/kotlin/com/cherryperry/nostrings/DataClassNoStringClassGenerationInterceptor.kt: -------------------------------------------------------------------------------- 1 | package com.cherryperry.nostrings 2 | 3 | import org.jetbrains.kotlin.codegen.ClassBuilder 4 | import org.jetbrains.kotlin.codegen.ClassBuilderFactory 5 | import org.jetbrains.kotlin.codegen.ClassBuilderMode 6 | import org.jetbrains.kotlin.codegen.extensions.ClassBuilderInterceptorExtension 7 | import org.jetbrains.kotlin.descriptors.ClassDescriptor 8 | import org.jetbrains.kotlin.descriptors.ClassKind 9 | import org.jetbrains.kotlin.diagnostics.DiagnosticSink 10 | import org.jetbrains.kotlin.resolve.BindingContext 11 | import org.jetbrains.kotlin.resolve.jvm.diagnostics.JvmDeclarationOrigin 12 | 13 | class DataClassNoStringClassGenerationInterceptor( 14 | private val removeAll: Boolean 15 | ) : ClassBuilderInterceptorExtension { 16 | 17 | override fun interceptClassBuilderFactory( 18 | interceptedFactory: ClassBuilderFactory, 19 | bindingContext: BindingContext, 20 | diagnostics: DiagnosticSink 21 | ): ClassBuilderFactory = 22 | object : ClassBuilderFactory { 23 | 24 | override fun newClassBuilder(origin: JvmDeclarationOrigin): ClassBuilder { 25 | val classDescription = origin.descriptor as? ClassDescriptor 26 | return if (classDescription?.kind == ClassKind.CLASS && classDescription.isData) { 27 | DataClassNoStringClassBuilder(interceptedFactory.newClassBuilder(origin), removeAll) 28 | } else { 29 | interceptedFactory.newClassBuilder(origin) 30 | } 31 | } 32 | 33 | override fun getClassBuilderMode(): ClassBuilderMode { 34 | return interceptedFactory.classBuilderMode 35 | } 36 | 37 | override fun asText(builder: ClassBuilder?): String? { 38 | return interceptedFactory.asText((builder as? DataClassNoStringClassBuilder)?.classBuilder ?: builder) 39 | } 40 | 41 | override fun asBytes(builder: ClassBuilder?): ByteArray? { 42 | return interceptedFactory.asBytes((builder as? DataClassNoStringClassBuilder)?.classBuilder ?: builder) 43 | } 44 | 45 | override fun close() { 46 | interceptedFactory.close() 47 | } 48 | 49 | } 50 | 51 | } 52 | -------------------------------------------------------------------------------- /kotlin-plugin/src/main/kotlin/com/cherryperry/nostrings/DataClassNoStringCommandLineProcessor.kt: -------------------------------------------------------------------------------- 1 | package com.cherryperry.nostrings 2 | 3 | import com.cherryperry.nostrings.DataClassNoStringOptions.KEY_ENABLED 4 | import com.cherryperry.nostrings.DataClassNoStringOptions.KEY_REMOVE_ALL 5 | import com.google.auto.service.AutoService 6 | import org.jetbrains.kotlin.compiler.plugin.AbstractCliOption 7 | import org.jetbrains.kotlin.compiler.plugin.CliOption 8 | import org.jetbrains.kotlin.compiler.plugin.CommandLineProcessor 9 | import org.jetbrains.kotlin.config.CompilerConfiguration 10 | 11 | @AutoService(CommandLineProcessor::class) 12 | class DataClassNoStringCommandLineProcessor : CommandLineProcessor { 13 | 14 | override val pluginId: String = "data-class-no-string" 15 | 16 | override val pluginOptions: Collection = 17 | listOf( 18 | CliOption( 19 | KEY_ENABLED.toString(), 20 | "", 21 | "Whether plugin is enabled", 22 | required = false 23 | ), 24 | CliOption( 25 | KEY_REMOVE_ALL.toString(), 26 | "", 27 | "Whether plugin should remove also equals() and hashCode() implementations", 28 | required = false 29 | ) 30 | ) 31 | 32 | override fun processOption( 33 | option: AbstractCliOption, 34 | value: String, 35 | configuration: CompilerConfiguration 36 | ) { 37 | when (option.optionName) { 38 | KEY_ENABLED.toString() -> configuration.put(KEY_ENABLED, value.toBoolean()) 39 | KEY_REMOVE_ALL.toString() -> configuration.put(KEY_REMOVE_ALL, value.toBoolean()) 40 | else -> error("Unexpected config option ${option.optionName}") 41 | } 42 | } 43 | 44 | } 45 | -------------------------------------------------------------------------------- /kotlin-plugin/src/main/kotlin/com/cherryperry/nostrings/DataClassNoStringComponentRegistrar.kt: -------------------------------------------------------------------------------- 1 | package com.cherryperry.nostrings 2 | 3 | import com.cherryperry.nostrings.DataClassNoStringOptions.KEY_ENABLED 4 | import com.cherryperry.nostrings.DataClassNoStringOptions.KEY_REMOVE_ALL 5 | import com.google.auto.service.AutoService 6 | import org.jetbrains.kotlin.codegen.extensions.ClassBuilderInterceptorExtension 7 | import org.jetbrains.kotlin.com.intellij.mock.MockProject 8 | import org.jetbrains.kotlin.compiler.plugin.ComponentRegistrar 9 | import org.jetbrains.kotlin.config.CompilerConfiguration 10 | 11 | @AutoService(ComponentRegistrar::class) 12 | class DataClassNoStringComponentRegistrar : ComponentRegistrar { 13 | 14 | override fun registerProjectComponents( 15 | project: MockProject, 16 | configuration: CompilerConfiguration 17 | ) { 18 | if (!configuration.get(KEY_ENABLED, true)) { 19 | return 20 | } 21 | val removeAll = configuration.get(KEY_REMOVE_ALL, true) 22 | ClassBuilderInterceptorExtension.registerExtension( 23 | project = project, 24 | extension = DataClassNoStringClassGenerationInterceptor(removeAll) 25 | ) 26 | } 27 | 28 | } 29 | -------------------------------------------------------------------------------- /kotlin-plugin/src/main/kotlin/com/cherryperry/nostrings/DataClassNoStringOptions.kt: -------------------------------------------------------------------------------- 1 | package com.cherryperry.nostrings 2 | 3 | import org.jetbrains.kotlin.config.CompilerConfigurationKey 4 | 5 | object DataClassNoStringOptions { 6 | val KEY_ENABLED = CompilerConfigurationKey.create("enabled") 7 | val KEY_REMOVE_ALL = CompilerConfigurationKey.create("removeAll") 8 | } 9 | -------------------------------------------------------------------------------- /sample/.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | -------------------------------------------------------------------------------- /sample/build.gradle.kts: -------------------------------------------------------------------------------- 1 | buildscript { 2 | repositories.maven("https://dl.bintray.com/cherryperry/maven") 3 | // Use published version 4 | // dependencies.classpath("com.cherryperry.nostrings:gradle-plugin:${parent?.version}") 5 | } 6 | 7 | plugins { 8 | kotlin("jvm") 9 | application 10 | } 11 | 12 | // Use published version 13 | // apply(plugin = "com.cherryperry.nostrings") 14 | 15 | dependencies { 16 | implementation(kotlin("stdlib-jdk8")) 17 | 18 | testImplementation("junit:junit:4.13") 19 | } 20 | 21 | application { 22 | mainClassName = "com.cherryperry.nostrings.AppKt" 23 | } 24 | 25 | // Use local build 26 | tasks.withType { 27 | kotlinOptions { 28 | freeCompilerArgs += "-Xplugin=${project(":kotlin-plugin").buildDir}/libs/kotlin-plugin-$version.jar" 29 | } 30 | dependsOn(project(":kotlin-plugin").tasks.named("jar")) 31 | } 32 | -------------------------------------------------------------------------------- /sample/src/main/kotlin/com/cherryperry/nostrings/App.kt: -------------------------------------------------------------------------------- 1 | package com.cherryperry.nostrings 2 | 3 | data class Sample(val text: String) 4 | 5 | fun main() { 6 | println("Sample.toString() should return class name and hash code: ${Sample("text")}") 7 | } 8 | -------------------------------------------------------------------------------- /sample/src/test/kotlin/com/cherryperry/nostrings/AppTest.kt: -------------------------------------------------------------------------------- 1 | package com.cherryperry.nostrings 2 | 3 | import org.junit.Assert.assertEquals 4 | import org.junit.Assert.assertNotEquals 5 | import org.junit.Test 6 | 7 | class AppTest { 8 | 9 | @Test 10 | fun `toString method should return default string`() { 11 | val sample = Sample("test") 12 | assertEquals( 13 | "${sample.javaClass.name}@${Integer.toHexString(System.identityHashCode(sample))}", 14 | sample.toString() 15 | ) 16 | } 17 | 18 | @Test 19 | fun `hashCode method should return identityHashCode`() { 20 | val sample = Sample("test") 21 | assertEquals(System.identityHashCode(sample), sample.hashCode()) 22 | } 23 | 24 | @Test 25 | fun `equals method should return true only for itself`() { 26 | val sample = Sample("test") 27 | assertEquals(sample, sample) 28 | assertNotEquals(Sample("test"), sample) 29 | } 30 | 31 | } 32 | -------------------------------------------------------------------------------- /settings.gradle.kts: -------------------------------------------------------------------------------- 1 | include("gradle-plugin", "kotlin-plugin", "sample") 2 | --------------------------------------------------------------------------------