Refactoring

.github/workflows/gradle-test.yml

@@ -0,0 +1,20 @@
+name: Gradle Test
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+
+    steps:
+      - uses: actions/[email protected]
+      - name: Set up JDK 11
+        uses: actions/[email protected]
+        with:
+          java-version: 11
+          distribution: liberica
+      - name: Gradle Wrapper Validation
+        uses: gradle/[email protected]
+      - uses: gradle/[email protected]
+        with:
+          arguments: test

CodeStyleAndFormatting/CodeSchemasAndEditorConfig/Theory/src/main/kotlin/jetbrains/refactoring/course/formatting/Task.kt

@@ -7,6 +7,3 @@ fun funWithCodeStyleIssues() {
       println("Please, fix me!")
    }
 }
-
-fun main() {
-}

CodeStyleAndFormatting/WhatIsFormatting/Quiz/task-info.yaml

@@ -16,8 +16,4 @@ message_incorrect: "Incorrect solution. Explanation: Consistent code formatting
 files:
 - name: src/main/kotlin/jetbrains/refactoring/course/formatting/Main.kt
   visible: true
-- name: src/main/kotlin/jetbrains/refactoring/course/formatting/Task1.kt
-  visible: true
-- name: src/main/kotlin/jetbrains/refactoring/course/formatting/Task2.kt
-  visible: true
 local_check: true

CodeStyleAndFormatting/WhatIsFormatting/Quiz/task.md

@@ -0,0 +1 @@
+# Task 2/4: What is the primary benefit of following consistent code formatting?

CodeStyleAndFormatting/WhatIsFormatting/ReformatTheCode/task-info.yaml

@@ -1,9 +1,14 @@
 type: edu
 custom_name: Reformat the code
 files:
-- name: src/main/kotlin/jetbrains/refactoring/course/formatting/Task1.kt
-  visible: true
 - name: test/Tests.kt
   visible: false
-- name: src/main/kotlin/jetbrains/refactoring/course/formatting/Task2.kt
+- name: src/main/kotlin/jetbrains/refactoring/course/formatting/Task.kt
   visible: true
+  placeholders:
+    - offset: 49
+      length: 101
+      placeholder_text: |-
+        fun funWithLittleFormattingIssues() {
+        println ("This function definitely has formatting issues" )
+        }

CodeStyleAndFormatting/WhatIsFormatting/ReformatTheCode/task.md

@@ -1,3 +1,5 @@
+# Task 3/4: Reformat the code
+
 ### Task
 
 In this task, you need to correct formatting in a file without using IDE features.

CodeStyleAndFormatting/WhatIsFormatting/ReformatTheCode/test/Tests.kt

@@ -15,15 +15,15 @@ class ReformatCodeWithoutIDETest : BaseIjTestClass() {
         fun initialize() {
             val taskDirectoryPath = System.getProperty("user.dir")
             val sourceCodeFile =
-                File("$taskDirectoryPath/src/main/kotlin/jetbrains/refactoring/course/formatting/Task1.kt")
+                File("$taskDirectoryPath/src/main/kotlin/jetbrains/refactoring/course/formatting/Task.kt")
             sourceText = sourceCodeFile.readText()
         }
     }
 
     @Test
     fun testSolutionIsFormatted() {
         setUp()
-        myFixture.configureByText("Task1.kt", sourceText)
+        myFixture.configureByText("Task.kt", sourceText)
         myFixture.file.checkIfFormattingRulesWereApplied()
     }
 }

CodeStyleAndFormatting/WhatIsFormatting/ReformatTheCodeUsingIDE/task-info.yaml

@@ -1,7 +1,20 @@
 type: edu
 custom_name: Reformat the code using IDE
 files:
-- name: src/main/kotlin/jetbrains/refactoring/course/formatting/Task2.kt
-  visible: true
 - name: test/Tests.kt
   visible: false
+- name: src/main/kotlin/jetbrains/refactoring/course/formatting/Task.kt
+  visible: true
+  placeholders:
+    - offset: 49
+      length: 227
+      placeholder_text: |-
+        import java.io.File
+
+        fun funWithFormattingIssues() {
+              println ("This function definitely has formatting issues" )
+            println( "... that could be easily fixed using one shortcut")
+            for ( i in 1 ..10) {
+          println("Please, format me!")
+            }
+        }

CodeStyleAndFormatting/WhatIsFormatting/ReformatTheCodeUsingIDE/task.md

@@ -1,6 +1,6 @@
-### Task
+# Task 4/4: Reformat the code using IDE
 
-#### Theory
+### Theory
 
 To perform any refactoring in the IDE, you can use the Refactoring Menu or a specific shortcut. 
 It’s also possible to configure custom shortcuts.
@@ -18,7 +18,7 @@ In this dialog, you can specify the scope of formatting changes and select the o
     <img src="../../../util/src/main/resources/images/CodeStyleAndFormatting/WhatIsFormatting/reformat_dialog.png" alt="Reformat dialog" width="400"/>
 </p>
 
-#### Task
+### Task
 
 In this task, you need to reformat the provided code fragment using the shortcut. 
 

CodeStyleAndFormatting/WhatIsFormatting/ReformatTheCodeUsingIDE/test/Tests.kt

@@ -16,22 +16,22 @@ class ReformatCodeTest : BaseIjTestClass() {
         fun initialize() {
             val taskDirectoryPath = System.getProperty("user.dir")
             val sourceCodeFile =
-                File("$taskDirectoryPath/src/main/kotlin/jetbrains/refactoring/course/formatting/Task2.kt")
+                File("$taskDirectoryPath/src/main/kotlin/jetbrains/refactoring/course/formatting/Task.kt")
             sourceText = sourceCodeFile.readText()
         }
     }
 
     @Test
     fun testSolutionIsFormatted() {
         setUp()
-        myFixture.configureByText("Task2.kt", sourceText)
+        myFixture.configureByText("Task.kt", sourceText)
         myFixture.file.checkIfFormattingRulesWereApplied()
     }
 
     @Test
     fun testUnusedImportsAreRemoved() {
         setUp()
-        myFixture.configureByText("Task2.kt", sourceText)
+        myFixture.configureByText("Task.kt", sourceText)
         myFixture.file.checkIfOptimizeImportsWereApplied()
     }
 }

CodeStyleAndFormatting/WhatIsFormatting/Theory/task-info.yaml

@@ -3,7 +3,3 @@ custom_name: What is formatting?
 files:
 - name: src/main/kotlin/jetbrains/refactoring/course/formatting/Main.kt
   visible: true
-- name: src/main/kotlin/jetbrains/refactoring/course/formatting/Task1.kt
-  visible: false
-- name: src/main/kotlin/jetbrains/refactoring/course/formatting/Task2.kt
-  visible: false

CodeStyleAndFormatting/WhatIsFormatting/Theory/task.md

@@ -1,3 +1,5 @@
+# Task 1/4: What is formatting?
+
 **_Code style_** is a set of guidelines used in a development team on how to write code. 
 Usually, the code style depends on the programming language and developers’ preferences and includes rules about formatting,
 documentation, naming conventions, and other aspect that affect code readability.

CodeStyleAndFormatting/WhatIsFormatting/lesson-info.yaml

@@ -1,8 +1,6 @@
-type: framework
-custom_name: What is formatting
+custom_name: What is formatting?
 content:
 - Theory
 - Quiz
 - ReformatTheCode
 - ReformatTheCodeUsingIDE
-is_template_based: false

ExtractingCode/WhatIsExtractMethodRefactoring/ExtractDuplicatedCode/task-info.yaml

@@ -3,5 +3,29 @@ custom_name: Extract duplicated code
 files:
 - name: src/main/kotlin/jetbrains/refactoring/course/extracting/Task.kt
   visible: true
+  placeholders:
+    - offset: 107
+      length: 504
+      placeholder_text: |-
+        fun wordCount(fileName: String): Int {
+            val file = File(fileName)
+            if (!file.exists() || !file.isFile) {
+                throw FileNotFoundException()
+            }
+            var wordCount = 0
+            file.forEachLine { line ->
+                wordCount += line.split("\\s+".toRegex()).count()
+            }
+            return wordCount
+        }
+
+        fun copyFile(srcName: String, destName: String) {
+            val file = File(srcName)
+            val to = File(destName)
+            if (!file.exists() || !file.isFile) {
+                throw FileNotFoundException()
+            }
+            file.copyTo(to)
+        }
 - name: test/Tests.kt
   visible: false

ExtractingCode/WhatIsExtractMethodRefactoring/ExtractDuplicatedCode/task.md

@@ -1,3 +1,5 @@
+# Task 2/2: Extract duplicated code
+
 ### Task
 
 In this task, you need to identify duplicated code and extract it into a separate function.

ExtractingCode/WhatIsExtractMethodRefactoring/Theory/src/main/kotlin/jetbrains/refactoring/course/extracting/Main.kt

@@ -0,0 +1,5 @@
+package jetbrains.refactoring.course.extracting
+
+fun main() {
+    // Write your solution here
+}

ExtractingCode/WhatIsExtractMethodRefactoring/Theory/task-info.yaml

@@ -1,5 +1,5 @@
 type: theory
 custom_name: What is Extract Method refactoring?
 files:
-- name: src/main/kotlin/jetbrains/refactoring/course/extracting/Task.kt
+- name: src/main/kotlin/jetbrains/refactoring/course/extracting/Main.kt
   visible: true

ExtractingCode/WhatIsExtractMethodRefactoring/Theory/task.md

@@ -1,3 +1,5 @@
+# Task 1/2: What is Extract Method refactoring?
+
 As we mentioned before, **duplicated code can lead to undesirable effects**, such as when you fix a bug in one place
 but forget to fix it consistently in duplicates. 
 The bug will still remain, and now it is even harder to find.

ExtractingCode/WhatIsExtractMethodRefactoring/lesson-info.yaml

@@ -1,6 +1,4 @@
-type: framework
 custom_name: What is Extract Method refactoring?
 content:
 - Theory
 - ExtractDuplicatedCode
-is_template_based: false

ExtractingCode/WhatIsExtractVariableRefactoring/ExtractMagicConstants/task-info.yaml

@@ -3,5 +3,25 @@ custom_name: Extract magic numbers
 files:
 - name: src/main/kotlin/jetbrains/refactoring/course/extracting/Task.kt
   visible: true
+  placeholders:
+    - offset: 49
+      length: 586
+      placeholder_text: |-
+        fun calculatePhotonEnergy(waveLength: Double): Double {
+            val frequency = 299792458.0 / waveLength
+            return 6.62607015e-34 * frequency
+        }
+
+        fun calculatePhotonMass(energy: Double): Double {
+            return energy / (299792458.0 * 299792458.0)
+        }
+
+        fun main() {
+            val photonEnergy = calculatePhotonEnergy(0.5e-6)
+            val photonMass = calculatePhotonMass(photonEnergy)
+
+            println("Photon energy: $photonEnergy Joules")
+            println("Photon mass: $photonMass kg")
+        }
 - name: test/Tests.kt
   visible: false

ExtractingCode/WhatIsExtractVariableRefactoring/ExtractMagicConstants/task.md

@@ -1,6 +1,16 @@
+# Task 2/2: Extract magic numbers
+
 ### Task
 
-In this task, you need to identify magic numbers and create constant values for them.
+To calculate the **energy of a photon**, we use a simple formula: multiply the Planck constant, which is a very small
+number (`6.62607015 × 10^-34`), by the light's frequency (the number of waves that pass a point in one second). To find
+the frequency of light, divide the speed of light (which is `299,792,458` meters per second) by the wave length of
+the light. The greater the frequency, the higher the energy of the photon.
+
+To calculate the **mass of a photon**, take the energy of the photon and divide it by the speed of
+light squared. However, in practice, photons are considered to have zero mass.
+
+In this task, you need to identify magic numbers in the code and create constant values for them.
 
 ### Hints
 

ExtractingCode/WhatIsExtractVariableRefactoring/Theory/src/main/kotlin/jetbrains/refactoring/course/extracting/Main.kt

@@ -0,0 +1,5 @@
+package jetbrains.refactoring.course.extracting
+
+fun main() {
+    // Write your solution here
+}

ExtractingCode/WhatIsExtractVariableRefactoring/Theory/task-info.yaml

@@ -1,5 +1,5 @@
 type: theory
 custom_name: What is Extract Variable refactoring?
 files:
-- name: src/main/kotlin/jetbrains/refactoring/course/extracting/Task.kt
+- name: src/main/kotlin/jetbrains/refactoring/course/extracting/Main.kt
   visible: true

ExtractingCode/WhatIsExtractVariableRefactoring/Theory/task.md

@@ -1,3 +1,5 @@
+# Task 1/2: What is Extract Variable refactoring?
+
 A *magic number* is a numerical value used in the code without a comment explaining its purpose. 
 Using magic numbers in code is considered bad practice because it makes the code prone to errors and less maintainable and readable.