Merge pull request #69 from dmeybohm/fix-view-path

Underscore the view names for Cake 3 / 4
dmeybohm · Apr 28, 2022 · 39516f5 · 39516f5
2 parents 6fad7d1 + 9b0d2ba
commit 39516f5
Show file tree

Hide file tree

Showing 8 changed files with 34 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,8 @@
 ## [0.8.1] - 2022-04-26
 ### Changed
 - Update for PhpStorm 2022.1
+- Map from camel-cased action names to underscored names for view files
+- Fix handling of extension between CakePHP 3 and CakePHP 4.
 
 ## [0.8.0] - 2022-03-11
 ### Added

diff --git a/src/main/java/com/daveme/chocolateCakePHP/ConfigForm.form b/src/main/java/com/daveme/chocolateCakePHP/ConfigForm.form
@@ -30,15 +30,15 @@
                 </constraints>
                 <properties>
                   <font style="1"/>
-                  <text value="Cake 3/4"/>
+                  <text value="CakePHP 3 and CakePHP 4"/>
                 </properties>
               </component>
               <component id="9dbcf" class="javax.swing.JCheckBox" binding="enableCake3SupportCheckBox" default-binding="true">
                 <constraints>
                   <grid row="2" column="0" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
                 </constraints>
                 <properties>
-                  <text value="Enable Cake 3 / Cake 4 Support"/>
+                  <text value="Enable CakePHP 3 / CakePHP 4 Support"/>
                 </properties>
               </component>
               <component id="a650c" class="javax.swing.JSeparator">
@@ -159,7 +159,7 @@
                   <grid row="7" column="1" row-span="1" col-span="1" vsize-policy="0" hsize-policy="0" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
                 </constraints>
                 <properties>
-                  <text value="This is the extension used for view files. By default it is &quot;ctp.&quot;"/>
+                  <text value="This is the extension used for view files. By default this is &quot;ctp&quot;. NOTE: this is only for CakePHP 3."/>
                 </properties>
               </component>
               <vspacer id="4cda0">
@@ -206,7 +206,7 @@
                 </constraints>
                 <properties>
                   <font style="1"/>
-                  <text value="Cake 2"/>
+                  <text value="CakePHP 2"/>
                 </properties>
               </component>
               <component id="aa16a" class="javax.swing.JSeparator">

diff --git a/src/main/kotlin/com/daveme/chocolateCakePHP/Cake.kt b/src/main/kotlin/com/daveme/chocolateCakePHP/Cake.kt
@@ -36,6 +36,11 @@ fun isCakeViewFile(settings: Settings, file: PsiFile): Boolean {
         return false
     }
 
+    val hasCakeFour = if (settings.cake3Enabled)
+        file.name.endsWith("php")
+    else
+        false
+
     val hasCakeThree = if (settings.cake3Enabled)
         file.name.endsWith(settings.cakeTemplateExtension)
     else
@@ -47,15 +52,12 @@ fun isCakeViewFile(settings: Settings, file: PsiFile): Boolean {
         false
 
     val topDir = topSourceDirectoryFromFile(settings, file)
-    if (hasCakeThree) {
-        if (CakeFour.isCakeViewFile(settings, topDir, file)) {
-            return true
-        }
-        if (CakeThree.isCakeViewFile(settings, topDir, file)) {
-            return true
-        }
+    if (hasCakeFour && CakeFour.isCakeViewFile(settings, topDir, file)) {
+        return true
+    }
+    if (hasCakeThree && CakeThree.isCakeViewFile(settings, topDir, file)) {
+        return true
     }
-
     if (hasCakeTwo && CakeTwo.isCakeViewFile(settings, topDir, file)) {
         return true
     }
@@ -101,10 +103,10 @@ private fun appDirectoryFromFile(settings: Settings, file: PsiFile): PsiDirector
 
 object CakeFour : Cake(viewDirectory = "templates", elementTop = "element") {
     override fun templatePath(settings: Settings, controllerName: String, controllerAction: String) =
-        "../$viewDirectory/$controllerName/$controllerAction.${settings.cakeTemplateExtension}"
+        "../$viewDirectory/$controllerName/$controllerAction.php"
 
     override fun elementPath(settings: Settings, elementPath: String): String =
-        "../$viewDirectory/$elementTop/$elementPath.${settings.cakeTemplateExtension}"
+        "../$viewDirectory/$elementTop/$elementPath.php"
 
     override fun isCakeViewFile(settings: Settings, topDir: PsiDirectory?, file: PsiFile): Boolean {
         return topDir?.name == viewDirectory

diff --git a/src/main/kotlin/com/daveme/chocolateCakePHP/files.kt b/src/main/kotlin/com/daveme/chocolateCakePHP/files.kt
@@ -45,10 +45,11 @@ fun templatePathToVirtualFile(
 ): VirtualFile? {
     var relativeFile: VirtualFile? = null
     if (settings.cake3Enabled) {
-        val cakeThreeTemplatePath = CakeThree.templatePath(settings, controllerName, controllerAction)
+        val underscored = controllerAction.camelCaseToUnderscore()
+        val cakeThreeTemplatePath = CakeThree.templatePath(settings, controllerName, underscored)
         relativeFile = findRelativeFile(appOrPluginDir, cakeThreeTemplatePath)
         if (relativeFile == null) {
-            val cakeFourTemplatePath = CakeFour.templatePath(settings, controllerName, controllerAction)
+            val cakeFourTemplatePath = CakeFour.templatePath(settings, controllerName, underscored)
             relativeFile = findRelativeFile(appOrPluginDir, cakeFourTemplatePath)
         }
     }

diff --git a/src/main/kotlin/com/daveme/chocolateCakePHP/strings.kt b/src/main/kotlin/com/daveme/chocolateCakePHP/strings.kt
@@ -18,3 +18,14 @@ fun String.controllerBaseName(): String? =
         null
     else
         substring(0, length - "Controller".length)
+
+val matchUpperCase = Regex("([A-Z])")
+fun String.camelCaseToUnderscore(): String {
+    val removeFirst = this.isNotEmpty() && this[0].isUpperCase()
+    val result = matchUpperCase.replace(this, "_$1")
+    return if (removeFirst)
+        result.substring(1).lowercase()
+    else
+        result.lowercase()
+}
+
diff --git a/src/main/resources/META-INF/plugin.xml b/src/main/resources/META-INF/plugin.xml
@@ -24,7 +24,7 @@
 
 
     <!-- please see http://confluence.jetbrains.net/display/IDEADEV/Build+Number+Ranges for description -->
-    <idea-version since-build="193.3519.25"/>
+    <idea-version since-build="213.6461.21"/>
     <extensions defaultExtensionNs="com.intellij">
         <projectService serviceImplementation="com.daveme.chocolateCakePHP.Settings" />
 

diff --git a/...fixtures/cake4/templates/Movie/artist.ctp → ...fixtures/cake4/templates/Movie/artist.php b/...fixtures/cake4/templates/Movie/artist.ctp → ...fixtures/cake4/templates/Movie/artist.php
diff --git a/src/test/kotlin/com/daveme/chocolateCakePHP/test/ViewTest.kt b/src/test/kotlin/com/daveme/chocolateCakePHP/test/ViewTest.kt
@@ -127,7 +127,7 @@ class ViewTest : BaseTestCase() {
             "cake4/vendor/cakephp.php"
         )
 
-        myFixture.configureByFilePathAndText("cake4/templates/Movie/artist.ctp", """
+        myFixture.configureByFilePathAndText("cake4/templates/Movie/artist.php", """
         <?php
         ${'$'}this-><caret>
         """.trimIndent())