feat: add after-auto generation mode

krzysztofzablocki · Sep 26, 2021 · 0f3f206 · 0f3f206
1 parent 6ef751a
commit 0f3f206
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 - Update dependencies to fix build on Xcode 13 and support Swift 5.5 [#989](https://github.com/krzysztofzablocki/Sourcery/issues/989)
 - Improves performance
 - Skips hidden files / directories and doesn't step into packages
+- added `after-auto:` generation mode to inline codegen
 
 ## 1.5.2
 ## Fixes

diff --git a/Sourcery/Sourcery.swift b/Sourcery/Sourcery.swift
@@ -606,12 +606,22 @@ extension Sourcery {
                     return MappedInlineAnnotations(range, filePath, inlineRanges[key]!, generatedBody, inlineIndentations[key] ?? "")
                 }
 
-                guard key.hasPrefix("auto:") else {
+
+                guard let autoRange = key.range(of: "auto:") else {
                     rangesToReplace.remove(range)
                     return nil
                 }
-                let autoTypeName = key.trimmingPrefix("auto:").components(separatedBy: ".").dropLast().joined(separator: ".")
-                let toInsert = "\n// sourcery:inline:\(key)\n\(generatedBody)// sourcery:end\n"
+
+                enum AutoType: String {
+                    case after = "after-"
+                    case normal = ""
+                }
+
+                let autoKey = key[..<autoRange.lowerBound]
+                let autoType = AutoType(rawValue: String(autoKey)) ?? .normal
+
+                let autoTypeName = key[autoRange.upperBound..<key.endIndex].components(separatedBy: ".").dropLast().joined(separator: ".")
+                var toInsert = "\n// sourcery:inline:\(key)\n\(generatedBody)// sourcery:end"
 
                 guard let definition = parsingResult.types.types.first(where: { $0.name == autoTypeName }),
                     let filePath = definition.path,
@@ -623,7 +633,16 @@ extension Sourcery {
                 }
                 let bodyEndRange = NSRange(location: NSMaxRange(bodyRange), length: 0)
                 let bodyEndLineRange = contents.bridge().lineRange(for: bodyEndRange)
-                let rangeInFile = NSRange(location: max(bodyRange.location, bodyEndLineRange.location), length: 0)
+                let rangeInFile: NSRange
+
+                switch autoType {
+                case .after:
+                    rangeInFile = NSRange(location: max(bodyRange.location, bodyEndLineRange.location) + 1, length: 0)
+                case .normal:
+                    rangeInFile = NSRange(location: max(bodyRange.location, bodyEndLineRange.location), length: 0)
+                    toInsert += "\n"
+                }
+
                 return MappedInlineAnnotations(range, filePath, rangeInFile, toInsert, "")
             }
             .sorted { lhs, rhs in

diff --git a/SourceryTests/SourcerySpec.swift b/SourceryTests/SourcerySpec.swift
@@ -327,6 +327,29 @@ class SourcerySpecTests: QuickSpec {
                         expect(result).to(equal(expectedResult))
                     }
 
+                    it("insert generated code after the end of type body when using after-auto") {
+                        update(code: "class Foo {}\nstruct Boo {}", in: sourcePath)
+
+                        update(code: """
+                            // sourcery:inline:after-auto:Foo.Inlined
+                            var property = 2
+                            // sourcery:end
+                            """, in: templatePath)
+
+                        expect { try Sourcery(watcherEnabled: false, cacheDisabled: true).processFiles(.sources(Paths(include: [sourcePath])), usingTemplates: Paths(include: [templatePath]), output: output) }.toNot(throwError())
+
+                        let expectedResult = """
+                            class Foo {}
+                            // sourcery:inline:after-auto:Foo.Inlined
+                            var property = 2
+                            // sourcery:end
+                            struct Boo {}
+                            """
+
+                        let result = try? sourcePath.read(.utf8)
+                        expect(result).to(equal(expectedResult))
+                    }
+
                     it("insert generated code line before the end of type body") {
                         update(code: """
                         class Foo {

diff --git a/guides/Writing templates.md b/guides/Writing templates.md
@@ -192,7 +192,8 @@ Sourcery will generate the template code and then perform replacement in your so
 
 #### Automatic inline code generation
 
-To avoid having to place the markup in your source files, you can use `inline:auto:{{ type.name }}.TemplateName`:
+To avoid having to place the markup in your source files, you can use automatic generation e.g. 
+`inline:auto:{{ type.name }}.TemplateName`:
 
 ```swift
 // in template:
@@ -216,6 +217,8 @@ class MyType {
 
 The needed markup will be automatically added at the end of the type declaration body. After first parse Sourcery will work with generated code annotated with `inline:auto` the same way as annotated with `inline`, so you can even move these blocks of code anywhere in the same file.
 
+If you want to insert code after the type declaration, use `after-auto:` instead of `auto:`
+
 ## Per file code generation
 
 Sourcery supports generating code in a separate file per type, you just need to put `file` annotation in a template, e.g.