[#98] Replaced globbing feature by a recursive swift files search.

Author: trupin

Documentation/Migration_from_0.11.+_to_0.12.+.md

@@ -1,4 +1,4 @@
-# Migration from v0.11.+ to v0.12.+
+# Migration from v0.11.+ to v0.12.1+
 
 Weaver 0.12.0 comes with several breaking changes.
 
@@ -29,6 +29,7 @@ Options:
     --single-output
     --input-path - Paths to input files.
     --ignored-path - Paths to ignore.
+    --recursive-off
 ```
 
 See the [documentation](https://github.com/scribd/Weaver#generate-swift-files) for details.
@@ -43,10 +44,10 @@ The command to add to the build phase looked like the following:
 weaver generate --output_path ${SOURCE_ROOT}/output/path `find ${SOURCE_ROOT} -name '*.swift' | xargs -0`
 ```
 
-With 0.12.+:
+With 0.12.1+:
 
 This build phase should now be written like the following:
 
 ```bash
-weaver swift --project-path $PROJECT_DIR/$PROJECT_NAME --input-path "*.swift" --input-path "**/*.swift" --output-path output/relative/path
+weaver swift --project-path $PROJECT_DIR/$PROJECT_NAME --output-path output/relative/path
 ```

README.md

@@ -102,7 +102,6 @@ Run the following to check if Weaver has been installed correctly.
 
 ```bash
 $ weaver swift --help
-
 Usage:
 
     $ weaver swift
@@ -116,14 +115,15 @@ Options:
     --single-output
     --input-path - Paths to input files.
     --ignored-path - Paths to ignore.
+    --recursive-off
 ```
 
 ### (2) - Weaver build phase
 
 In Xcode, add the following command to a command line build phase: 
 
 ```
-weaver swift --project-path $PROJECT_DIR/$PROJECT_NAME --input-path "*.swift" --input-path "**/*.swift" --output-path output/relative/path
+weaver swift --project-path $PROJECT_DIR/$PROJECT_NAME --output-path output/relative/path
 ```
 
 **Important - Move this build phase above the `Compile Source` phase so Weaver can generate the boilerplate code before compilation happens.**
@@ -352,12 +352,13 @@ Options:
     --single-output
     --input-path - Paths to input files.
     --ignored-path - Paths to ignore.
+    --recursive-off
 ```
 
 ### Example:
 
 ```bash
-weaver swift --project-path $PROJECT_DIR/$PROJECT_NAME --input-path "*.swift" --input-path "**/*.swift" --output-path Generated
+weaver swift --project-path $PROJECT_DIR/$PROJECT_NAME --output-path Generated
 ```
 
 ### Parameters:
@@ -368,8 +369,9 @@ weaver swift --project-path $PROJECT_DIR/$PROJECT_NAME --input-path "*.swift" --
 - `--template-path`: Path to a custom rendering template.
 - `--unsafe`: Deactivates the dependency graph safety checks.
 - `--single-output`: Makes Weaver generate only one single Swift file.
-- `--input-path`: Path to the project's Swift code. Defaults to `project-path`. Supports [unix globbing](https://en.wikipedia.org/wiki/Glob_(programming)). Variadic parameter, which means it can be set more than once.
+- `--input-path`: Path to the project's Swift code. Defaults to `project-path`. Variadic parameter, which means it can be set more than once. By default, Weaver recursively read any Swift file located under the `input-path`.
 - `--ignored-path`: Same than `input-path` but for ignoring files which shouldn't be parsed by Weaver. 
+- `--recursive-off`: Deactivates recursivity for `input-path` and `ignored-path`.
 
 ### Configuration File:
 
@@ -382,12 +384,11 @@ Parameters are named the same, but snakecased.
 For example, the [sample project configuration](https://github.com/scribd/Weaver/blob/master/Sample/.sample.weaver.yaml) looks like:
 
 ```yaml
-output_path: "Sample/Generated"
+output_path: Sample/Generated
 input_paths:
-  - "Sample/*.swift"
-  - "Sample/**/*.swift"
+  - Sample
 ignored_paths:
-  - "Sample/Generated/*"
+  - Sample/Generated
 ```
 
 ## Export Dependency Graph
@@ -396,7 +397,6 @@ Weaver can ouput a JSON representation of the dependency graph of a project.
 
 ```bash
 $ weaver json --help
-
 Usage:
 
     $ weaver json
@@ -407,6 +407,7 @@ Options:
     --pretty [default: false]
     --input-path - Paths to input files.
     --ignored-path - Paths to ignore.
+    --recursive-off
 ```
 
 For an output example, please check this [Gist](https://gist.github.com/trupin/9438713f8fae0a5a7f424eca1976f42b).
@@ -417,7 +418,6 @@ Weaver can output the input/output `xcfilelist` files which can then be added to
 
 ```bash
 $ weaver xcfilelist --help
-
 Usage:
 
     $ weaver xcfilelist
@@ -429,6 +429,7 @@ Options:
     --single-output
     --input-path - Paths to input files.
     --ignored-path - Paths to ignore.
+    --recursive-off
 ```
 
 ## Migration guides

Sample/.api.weaver.yaml

@@ -1,6 +1,5 @@
-output_path: "API/Generated"
+output_path: API/Generated
 input_paths:
-  - "API/*.swift"
-  - "API/**/*.swift"
+  - API
 ignored_paths:
-  - "API/Generated/*"
+  - API/Generated

Sample/.sample.weaver.yaml

@@ -1,6 +1,5 @@
-output_path: "Sample/Generated"
+output_path: Sample/Generated
 input_paths:
-  - "Sample/*.swift"
-  - "Sample/**/*.swift"
+  - Sample
 ignored_paths:
-  - "Sample/Generated/*"
+  - Sample/Generated

Sample/API/Generated/Weaver.API.swift

@@ -1,4 +1,4 @@
-/// This file is generated by Weaver 0.12.0
+/// This file is generated by Weaver 0.12.1
 /// DO NOT EDIT!
 import Foundation
 // MARK: - MovieAPI

Sample/API/Generated/Weaver.ImageManager.swift

@@ -1,4 +1,4 @@
-/// This file is generated by Weaver 0.12.0
+/// This file is generated by Weaver 0.12.1
 /// DO NOT EDIT!
 import Foundation
 import UIKit

Sample/API/Generated/Weaver.MovieManager.swift

@@ -1,4 +1,4 @@
-/// This file is generated by Weaver 0.12.0
+/// This file is generated by Weaver 0.12.1
 /// DO NOT EDIT!
 import Foundation
 // MARK: - MovieManager

Sample/Sample/Generated/Weaver.AppDelegate.swift

@@ -1,4 +1,4 @@
-/// This file is generated by Weaver 0.12.0
+/// This file is generated by Weaver 0.12.1
 /// DO NOT EDIT!
 import API
 import UIKit

Sample/Sample/Generated/Weaver.HomeViewController.swift

@@ -1,4 +1,4 @@
-/// This file is generated by Weaver 0.12.0
+/// This file is generated by Weaver 0.12.1
 /// DO NOT EDIT!
 import API
 import Foundation

Sample/Sample/Generated/Weaver.MovieViewController.swift

@@ -1,4 +1,4 @@
-/// This file is generated by Weaver 0.12.0
+/// This file is generated by Weaver 0.12.1
 /// DO NOT EDIT!
 import API
 import Foundation

Sample/Sample/Generated/Weaver.PersonManager.swift

@@ -1,4 +1,4 @@
-/// This file is generated by Weaver 0.12.0
+/// This file is generated by Weaver 0.12.1
 /// DO NOT EDIT!
 import API
 import Foundation

Sample/Sample/Generated/Weaver.ReviewManager.swift

@@ -1,4 +1,4 @@
-/// This file is generated by Weaver 0.12.0
+/// This file is generated by Weaver 0.12.1
 /// DO NOT EDIT!
 import API
 import Foundation

Sample/Sample/Generated/Weaver.WSReviewViewController+Injectable.swift

@@ -1,4 +1,4 @@
-/// This file is generated by Weaver 0.12.0
+/// This file is generated by Weaver 0.12.1
 /// DO NOT EDIT!
 import Foundation
 // MARK: - WSReviewViewController

Sources/WeaverCommand/Configuration.swift

@@ -19,22 +19,25 @@ struct Configuration {
     let ignoredPathStrings: [String]
     let unsafe: Bool
     let singleOutput: Bool
+    let recursiveOff: Bool
 
     private init(inputPathStrings: [String]?,
                  ignoredPathStrings: [String]?,
                  projectPath: Path?,
                  outputPath: Path?,
                  templatePath: Path?,
                  unsafe: Bool?,
-                 singleOutput: Bool?) {
+                 singleOutput: Bool?,
+                 recursiveOff: Bool?) {
 
-        self.inputPathStrings = inputPathStrings ?? []
+        self.inputPathStrings = inputPathStrings ?? Defaults.inputPathStrings
         self.ignoredPathStrings = ignoredPathStrings ?? []
         self.projectPath = projectPath ?? Defaults.projectPath
         self.outputPath = outputPath ?? Defaults.outputPath
         self.templatePath = templatePath ?? Defaults.templatePath
         self.unsafe = unsafe ?? Defaults.unsafe
         self.singleOutput = singleOutput ?? Defaults.singleOuput
+        self.recursiveOff = recursiveOff ?? Defaults.recursiveOff
     }
 
     init(configPath: Path? = nil,
@@ -44,7 +47,8 @@ struct Configuration {
          outputPath: Path? = nil,
          templatePath: Path? = nil,
          unsafe: Bool? = nil,
-         singleOutput: Bool? = nil) throws {
+         singleOutput: Bool? = nil,
+         recursiveOff: Bool? = nil) throws {
 
         let projectPath = projectPath ?? Defaults.projectPath
         let configPath = Configuration.prepareConfigPath(configPath ?? Defaults.configPath,
@@ -65,14 +69,16 @@ struct Configuration {
                                           outputPath: outputPath,
                                           templatePath: templatePath,
                                           unsafe: unsafe,
-                                          singleOutput: singleOutput)
+                                          singleOutput: singleOutput,
+                                          recursiveOff: recursiveOff)
         }
 
         self.inputPathStrings = inputPathStrings ?? configuration.inputPathStrings
         self.ignoredPathStrings = ignoredPathStrings ?? configuration.ignoredPathStrings
         self.projectPath = projectPath
         self.unsafe = unsafe ?? configuration.unsafe
         self.singleOutput = singleOutput ?? configuration.singleOutput
+        self.recursiveOff = recursiveOff ?? configuration.recursiveOff
 
         let outputPath = outputPath ?? configuration.outputPath
         self.outputPath = outputPath.isRelative ? projectPath + configuration.outputPath : outputPath
@@ -93,6 +99,10 @@ struct Configuration {
         }
         return configPath
     }
+    
+    private var recursive: Bool {
+        return !recursiveOff
+    }
 }
 
 // MARK: - Constants
@@ -106,6 +116,8 @@ extension Configuration {
         static let outputPath = Path(".")
         static let unsafe = false
         static let singleOuput = false
+        static let recursiveOff = false
+        static let inputPathStrings = ["."]
 
         static var projectPath: Path {
             if let projectPath = ProcessInfo.processInfo.environment["WEAVER_PROJECT_PATH"] {
@@ -137,6 +149,7 @@ extension Configuration: Decodable {
         case ignoredPaths = "ignored_paths"
         case unsafe
         case singleOutput = "single_output"
+        case recursive
     }
 
     public init(from decoder: Decoder) throws {
@@ -149,10 +162,11 @@ extension Configuration: Decodable {
         projectPath = Defaults.projectPath
         outputPath = try container.decodeIfPresent(Path.self, forKey: .outputPath) ?? Defaults.outputPath
         templatePath = try container.decodeIfPresent(Path.self, forKey: .templatePath) ?? Defaults.templatePath
-        inputPathStrings = try container.decode([String].self, forKey: .inputPaths)
+        inputPathStrings = try container.decodeIfPresent([String].self, forKey: .inputPaths) ?? Defaults.inputPathStrings
         ignoredPathStrings = try container.decodeIfPresent([String].self, forKey: .ignoredPaths) ?? []
         unsafe = try container.decodeIfPresent(Bool.self, forKey: .unsafe) ?? Defaults.unsafe
         singleOutput = try container.decodeIfPresent(Bool.self, forKey: .singleOutput) ?? Defaults.singleOuput
+        recursiveOff = !(try container.decodeIfPresent(Bool.self, forKey: .recursive) ?? !Defaults.recursiveOff)
     }
 }
 
@@ -168,9 +182,18 @@ extension Path: Decodable {
 
 extension Configuration {
 
-    var inputPaths: [Path] {
-        let inputPaths = Set(inputPathStrings.flatMap { projectPath.glob($0) })
-        let ignoredPaths = Set(ignoredPathStrings.flatMap { projectPath.glob($0) })
+    func inputPaths() throws -> [Path]  {
+
+        let inputPaths = try Set(inputPathStrings
+            .map { projectPath + $0 }
+            .flatMap { recursive ? try $0.recursiveChildren() : try $0.children() }
+            .filter { $0.extension == "swift" })
+        
+        let ignoredPaths = try Set(ignoredPathStrings
+            .map { projectPath + $0 }
+            .flatMap { recursive ? try $0.recursiveChildren() : try $0.children() }
+            .filter { $0.extension == "swift" })
+        
         return inputPaths.subtracting(ignoredPaths).sorted()
     }
 }