Merge pull request #48 from Tinder/fix_bug_amin

GitQuery 3.0.4

Author: tinder-aminghadersohi

CHANGELOG.md

@@ -3,6 +3,17 @@ All notable changes to this library will be documented in this file.
 
 Version in this change log adheres to [Semantic Versioning](http://semver.org/).
 
+### 3.0.4 (2020-12-01) [#48](https://github.com/Tinder/GitQuery/pull/48) Fix cli bug prefixing / to path ([tinder-aminghadersohi](https://github.com/tinder-aminghadersohi)
+
+### 3.0.3 (2020-12-01) [#48](https://github.com/Tinder/GitQuery/pull/48) Allow init-config to use includeGlobs in config ([tinder-aminghadersohi](https://github.com/tinder-aminghadersohi)
+    
+### 3.0.2 (2020-12-01) [#48](https://github.com/Tinder/GitQuery/pull/48) Bug Fix - Snakeyaml constructor call ([tinder-aminghadersohi](https://github.com/tinder-aminghadersohi)
+    - Upgrade to Snakeyaml 1.27 
+    - Simplify constructor call for Yaml to avoid this error: `org.yaml.snakeyaml.representer.Representer.<init>(Lorg/yaml/snakeyaml/DumperOptions;)V`
+    
+### 3.0.1 (2020-12-01) [#48](https://github.com/Tinder/GitQuery/pull/48) Bug Fix - init config ([tinder-aminghadersohi](https://github.com/tinder-aminghadersohi)
+    - Fix a bug related to the gradle plugin init config writing absolute path where relative is desired. 
+    
 ### 3.0.0 (2020-11-14) [#45](https://github.com/Tinder/GitQuery/pull/45) GitQuery 3 ([tinder-aminghadersohi](https://github.com/tinder-aminghadersohi)
     - New `init-config` command line parameter
     - New Gradle extension `gitQueryInit` 

buildSrc/src/main/kotlin/Libs.kt

@@ -13,7 +13,7 @@ object Libs {
         const val kotlin = "1.4.10"
         const val ktlint = "0.39.0"
         const val ktlintGradlePlugin = "9.4.1"
-        const val snakeyaml = "1.26"
+        const val snakeyaml = "1.27"
         const val vanniktechMavenPublish = "0.13.0"
     }
 

core/src/main/kotlin/com/tinder/gitquery/core/GitQueryInit.kt

@@ -34,11 +34,12 @@ object GitQueryInit {
         configFile: String,
         config: GitQueryConfig,
         verbose: Boolean = false,
+        buildDir: String = System.getProperty("user.dir") + "/build"
     ) {
         this.verbose = verbose
         config.validate()
 
-        val actualRepoDirectory = config.getActualRepoPath()
+        val actualRepoDirectory = config.getActualRepoPath(buildDir)
 
         prepareRepo(config.remote, config.branch, actualRepoDirectory, verbose = verbose)
 

core/src/main/kotlin/com/tinder/gitquery/core/GitQuerySync.kt

@@ -27,12 +27,17 @@ object GitQuerySync {
     fun sync(
         config: GitQueryConfig,
         verbose: Boolean = false,
+        projectDir: String = System.getProperty("user.dir"),
+        buildDir: String = System.getProperty("user.dir") + "/build"
     ) {
         config.validate()
 
-        val outputPath = toAbsolutePath(config.outputDir)
+        val outputPath = toAbsolutePath(
+            path = config.outputDir,
+            prefixPath = projectDir
+        )
 
-        val actualRepoPath = config.getActualRepoPath()
+        val actualRepoPath = config.getActualRepoPath(buildDir)
 
         prepareRepo(config.remote, config.branch, actualRepoPath, verbose = verbose)
 

core/src/main/kotlin/com/tinder/gitquery/core/GitQueryVersion.kt

@@ -4,4 +4,4 @@ package com.tinder.gitquery.core
  * This file was generated by ./build-support/bin/write-version-class
  */
 
-const val GIT_QUERY_VERSION = "3.0.0"
+const val GIT_QUERY_VERSION = "3.0.4"

core/src/main/kotlin/com/tinder/gitquery/core/config/GitQueryConfig.kt

@@ -8,7 +8,6 @@ import com.tinder.gitquery.core.utils.toAbsolutePath
 import org.yaml.snakeyaml.DumperOptions
 import org.yaml.snakeyaml.Yaml
 import org.yaml.snakeyaml.constructor.Constructor
-import org.yaml.snakeyaml.representer.Representer
 import java.io.FileWriter
 import java.nio.file.Files
 import java.nio.file.Paths
@@ -78,16 +77,16 @@ data class GitQueryConfig(
         val writer = FileWriter(filename)
         val options = DumperOptions()
         options.defaultFlowStyle = DumperOptions.FlowStyle.BLOCK
-        val yaml = Yaml(Constructor(GitQueryConfig::class.java), Representer(options), options)
+        val yaml = Yaml(options)
         yaml.dump(this, writer)
         writer.flush()
     }
 
     /**
      * using the repoDir and remote config attributes, return where the repo should be cloned.
      */
-    fun getActualRepoPath(): String {
-        val repoPath = toAbsolutePath(this.repoDir)
+    fun getActualRepoPath(pathPrefix: String): String {
+        val repoPath = toAbsolutePath(path = this.repoDir, prefixPath = pathPrefix)
         val repoFullname = remote.substringAfter("[email protected]:")
             .substringBefore(".git")
         return "$repoPath/$repoFullname"

core/src/main/kotlin/com/tinder/gitquery/core/utils/PathUtils.kt

@@ -13,7 +13,7 @@ fun toAbsolutePath(
         path.isBlank() -> {
             ""
         }
-        path[0] == '/' -> {
+        path[0] == '/' || prefixPath.isBlank() -> {
             path
         }
         else -> {

core/src/test/kotlin/com/tinder/gitquery/core/GitQuerySyncTest.kt

@@ -42,7 +42,9 @@ class GitQuerySyncTest {
                 ),
                 repoDir = "${testProjectDir.root}/tmp/remote",
                 outputDir = "${testProjectDir.root}/gitquery-output"
-            )
+            ),
+            projectDir = testProjectDir.root.path,
+            buildDir = testProjectDir.root.path
         )
 
         // Then
@@ -63,7 +65,9 @@ class GitQuerySyncTest {
                     ),
                     repoDir = "${testProjectDir.root}/tmp/remote",
                     outputDir = "${testProjectDir.root}/gitquery-output"
-                )
+                ),
+                projectDir = testProjectDir.root.path,
+                buildDir = testProjectDir.root.path
             )
         }.exceptionOrNull()
 
@@ -89,7 +93,9 @@ class GitQuerySyncTest {
                     ),
                     repoDir = "${testProjectDir.root}/tmp/remote",
                     outputDir = "${testProjectDir.root}/gitquery-output"
-                )
+                ),
+                projectDir = testProjectDir.root.path,
+                buildDir = testProjectDir.root.path
             )
         }.exceptionOrNull()
 
@@ -115,7 +121,9 @@ class GitQuerySyncTest {
                     ),
                     repoDir = "${testProjectDir.root}/tmp/remote",
                     outputDir = "${testProjectDir.root}/gitquery-output"
-                )
+                ),
+                projectDir = testProjectDir.root.path,
+                buildDir = testProjectDir.root.path
             )
         }.exceptionOrNull()
 

gradle-plugin/src/main/kotlin/com/tinder/gitquery/GitQueryInitTask.kt

@@ -5,7 +5,6 @@
 package com.tinder.gitquery
 
 import com.tinder.gitquery.core.GitQueryInit.initConfig
-import org.gradle.api.logging.LogLevel
 import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.TaskAction
 import javax.inject.Inject
@@ -52,14 +51,12 @@ open class GitQueryInitTask @Inject constructor(
 
     @TaskAction
     override fun taskAction() {
-        if (includeGlobs.isEmpty()) {
-            logger.log(LogLevel.WARN, "GitQueryInit skipped - includeGlobs is empty.")
-            return
-        }
         initConfig(
             configFile = configFileName(),
             config = readConfig(createIfNotExists = true).apply {
-                initConfig.includeGlobs = includeGlobs
+                if (includeGlobs.isNotEmpty()) {
+                    initConfig.includeGlobs = includeGlobs
+                }
                 if (excludeGlobs.isNotEmpty()) {
                     initConfig.excludeGlobs = excludeGlobs
                 }
@@ -68,7 +65,8 @@ open class GitQueryInitTask @Inject constructor(
                 }
                 initConfig.flatFiles = flatFiles
             },
-            verbose = verbose
+            verbose = verbose,
+            buildDir = project.buildDir.path
         )
     }
 }

gradle-plugin/src/main/kotlin/com/tinder/gitquery/GitQuerySyncTask.kt

@@ -67,7 +67,9 @@ open class GitQuerySyncTask @Inject constructor(
     open fun taskAction() {
         GitQuerySync.sync(
             config = readConfig(createIfNotExists = false),
-            verbose = verbose
+            verbose = verbose,
+            projectDir = project.projectDir.path,
+            buildDir = project.buildDir.path
         )
     }
 
@@ -82,22 +84,12 @@ open class GitQuerySyncTask @Inject constructor(
             if (branch.isNotBlank()) {
                 it.branch = branch
             }
-            it.repoDir = toAbsolutePath(
-                path = if (repoDir.isNotBlank()) {
-                    repoDir
-                } else {
-                    it.repoDir
-                },
-                prefixPath = "${project.buildDir}"
-            )
-            it.outputDir = toAbsolutePath(
-                path = if (outputDir.isNotBlank()) {
-                    outputDir
-                } else {
-                    it.outputDir
-                },
-                prefixPath = "${project.projectDir}"
-            )
+            if (repoDir.isNotBlank()) {
+                it.repoDir = repoDir
+            }
+            if (outputDir.isNotBlank()) {
+                it.outputDir = outputDir
+            }
             it.cleanOutput = cleanOutput
         }
     }

gradle-plugin/src/test/kotlin/com/tinder/gitquery/GitQuerySyncTaskTest.kt

@@ -91,8 +91,8 @@ plugins {
 }
 
 gitQuery {
-    configFile =  "gitquery.yml"
-    outputDir =  "gitquery-output"
+    configFile = "gitquery.yml"
+    outputDir = "gitquery-output"
     repoDir = "tmp/remote"
 }
         """.trimIndent()

gradle.properties

@@ -7,7 +7,7 @@ org.gradle.daemon=true
 org.gradle.parallel=true
 
 GROUP=com.tinder.gitquery
-VERSION_NAME=3.0.0
+VERSION_NAME=3.0.4
 
 POM_DESCRIPTION=A library for querying and syncing files in a remote git repo.
 POM_URL=https://github.com/Tinder/GitQuery

samples/protobuf-sync-code-gen/README.md

@@ -1,8 +1,7 @@
-## Gradle Proto to Kotlin Code Gen 
+## Sync Protobuf and generate Java from it
 
-Taken from the the [streem/pbandk](https://github.com/streem/pbandk), this example uses git query to sync the address 
-book example in the [protobuf repository](https://github.com/google/protobuf) and use [streem/pbandk](https://github.com/streem/pbandk)
- to generate Kotlin. 
+This example uses GitQuery to sync the addressbook example in the [protobuf repository](https://github.com/google/protobuf) and use [streem/pbandk](https://github.com/streem/pbandk)
+ to generate Java. 
 
 For this example the synced proto and generated code has been committed to show what it looks like.
 

samples/protobuf-sync-code-gen/build.gradle.kts

@@ -9,26 +9,17 @@ import com.google.protobuf.gradle.protoc
 plugins {
     application
     id("com.google.protobuf") version "0.8.13"
-    id("com.tinder.gitquery") version "3.0.0"
+    id("com.tinder.gitquery") version "3.0.4"
     java
 }
 
 val protoDir = "src/main/proto"
 
 gitQuery {
     autoSync = true
-    cleanOutput = true
     configFile = "gitquery.yml"
     outputDir = protoDir
-    repoDir = "${project.buildDir}/tmp/.gitquery"
-}
-
-// This will init/update the config file every time the gitQuery task runs.
-gitQueryInit {
-    flatFiles = false
-    includeGlobs = listOf("**/examples/addressbook.proto")
-    excludeGlobs = listOf("**/generated/**/*.proto")
-    revision = "v3.14.0"
+    repoDir = "tmp/.gitquery"
 }
 
 sourceSets {

samples/protobuf-sync-code-gen/gitquery.yml

@@ -1,4 +1,4 @@
-!!com.tinder.gitquery.core.GitQueryConfig
+!!com.tinder.gitquery.core.config.GitQueryConfig
 branch: master
 cleanOutput: true
 commits: &id001 {}
@@ -13,8 +13,8 @@ initConfig:
   includeGlobs:
   - '**/examples/addressbook.proto'
   revision: v3.14.0
-outputDir: /Users/aming/github/Tinder/GitQuery/samples/protobuf-sync-code-gen/src/main/proto
+outputDir: src/main/proto
 remote: [email protected]:protocolbuffers/protobuf.git
-repoDir: /Users/aming/github/Tinder/GitQuery/samples/protobuf-sync-code-gen/build/tmp/.gitquery
+repoDir: tmp/.gitquery
 schema:
   version: '1'

samples/protobuf-sync-groovy-dsl/README.md

@@ -0,0 +1,11 @@
+## Gradle Proto to Kotlin Code Gen 
+
+This examples shows how to generate a gitquery config, and use it to sync the files. 
+
+### Building
+
+To build the code simply run:
+
+    path/to/gradle gitQueryInit build
+
+

samples/protobuf-sync-groovy-dsl/build.gradle

@@ -0,0 +1,21 @@
+plugins {
+    id("java")
+    id("com.tinder.gitquery") version "3.0.4"
+}
+
+def protoDir = "src/main/proto"
+
+gitQuery {
+    autoSync = true
+    configFile = "gitquery.yml"
+    outputDir = protoDir
+    repoDir = "tmp/.gitquery"
+}
+
+repositories {
+    jcenter()
+    if (System.getenv("CI") == "true") {
+        mavenLocal()
+    }
+    mavenCentral()
+}

samples/protobuf-sync-groovy-dsl/gitquery.yml

@@ -0,0 +1,20 @@
+!!com.tinder.gitquery.core.config.GitQueryConfig
+branch: master
+cleanOutput: true
+commits: &id001 {}
+extra: *id001
+files:
+  examples:
+    addressbook.proto: v3.14.0
+initConfig:
+  excludeGlobs:
+  - '**/generated/**/*.proto'
+  flatFiles: false
+  includeGlobs:
+  - '**/examples/addressbook.proto'
+  revision: v3.14.0
+outputDir: src/main/proto
+remote: [email protected]:protocolbuffers/protobuf.git
+repoDir: tmp/.gitquery
+schema:
+  version: '1'

samples/protobuf-sync-groovy-dsl/settings.gradle

@@ -0,0 +1,9 @@
+pluginManagement {
+    repositories {
+        if (System.getenv("CI") == "true") {
+            mavenLocal()
+        }
+        // for GA versions
+        gradlePluginPortal()
+    }
+}