Merge pull request #90 from janderit/LinuxCompatibility

Linux testing on CI

Author: djbe

.circleci/config.yml

@@ -1,5 +1,5 @@
 defaults:
-  - &default-config
+  - &macos-config
     parallelism: 1
     environment:
       CIRCLE_ARTIFACTS: /tmp/circleci-artifacts
@@ -8,6 +8,14 @@ defaults:
     macos:
       xcode: "9.3.0"
     shell: /bin/bash --login -eo pipefail
+  - &linux-config
+    environment:
+      CIRCLE_ARTIFACTS: /tmp/circleci-artifacts
+      CIRCLE_TEST_REPORTS: /tmp/circleci-test-results
+      BUNDLE_PATH: vendor/bundle
+    docker:
+      - image: norionomura/jazzy:swift-4.1.3
+    shell: /bin/bash --login -eo pipefail
   - &prepare-storage
     run:
       name: Create directories for artifacts and reports
@@ -41,7 +49,7 @@ defaults:
 version: 2
 jobs:
   lint:
-    <<: *default-config
+    <<: *macos-config
     steps:
       - *prepare-storage
       - checkout
@@ -57,7 +65,7 @@ jobs:
       - *store-artifacts
 
   xcode-build-and-test:
-    <<: *default-config
+    <<: *macos-config
     steps:
       - *prepare-storage
       - checkout
@@ -72,8 +80,21 @@ jobs:
       - *fetch-xcode-logs
       - *store-artifacts
 
-  spm-build-and-test:
-    <<: *default-config
+  spm-linux-build-and-test:
+    <<: *linux-config
+    steps:
+      - *prepare-storage
+      - checkout
+      - *restore-gems
+      - *install-gems
+      - *store-gems
+      - run:
+          name: Run all tests
+          command: bundle exec rake spm:test
+      - *store-artifacts
+
+  spm-mac-build-and-test:
+    <<: *macos-config
     steps:
       - *prepare-storage
       - checkout
@@ -86,7 +107,7 @@ jobs:
       - *store-artifacts
 
   check-deploy:
-    <<: *default-config
+    <<: *macos-config
     steps:
       - *prepare-storage
       - checkout
@@ -107,10 +128,12 @@ workflows:
   lint-buildandtest-checkdeploy:
     jobs:
       - lint
-      - spm-build-and-test
+      - spm-linux-build-and-test
+      - spm-mac-build-and-test
       - xcode-build-and-test
       - check-deploy:
           requires:
             - lint
-            - spm-build-and-test
+            - spm-linux-build-and-test
+            - spm-mac-build-and-test
             - xcode-build-and-test

.swiftlint.yml

@@ -48,3 +48,7 @@ line_length:
 nesting:
   type_level:
     warning: 2
+
+# Exclude generated files
+excluded:
+  - XCTestManifests.swift

CHANGELOG.md

@@ -16,7 +16,8 @@
 ### Breaking Changes
 
 * Migrated to PathKit for url filters. The dirname will return '.' for a filename without base directory.  
-  [Rahul Katariya](https://github.com/RahulKatariya) 
+  [Rahul Katariya](https://github.com/RahulKatariya)
+  [Philip Jander](https://github.com/janderit)
   [#94](https://github.com/SwiftGen/StencilSwiftKit/pull/94)
 
 ### New Features
@@ -39,6 +40,9 @@
 * Update to SwiftLint 0.27 and enable some extra SwiftLint rules.  
   [David Jennes](https://github.com/djbe) 
   [#96](https://github.com/SwiftGen/StencilSwiftKit/pull/96)
+* Test Linux SPM support in CI.  
+  [David Jennes](https://github.com/janderit)
+  [#90](https://github.com/SwiftGen/StencilSwiftKit/pull/90)
 
 ## 2.5.0
 

Package.swift

@@ -2,29 +2,26 @@
 import PackageDescription
 
 let package = Package(
-    name: "StencilSwiftKit",
-    products: [
-        .library(name: "StencilSwiftKit", targets: ["StencilSwiftKit"])
-    ],
-    dependencies: [
-        .package(url: "https://github.com/stencilproject/Stencil.git", .upToNextMinor(from: "0.12.0"))
-    ],
-    targets: [
-      .target(
-        name: "StencilSwiftKit",
-        dependencies: [
-          "Stencil"
-        ],
-        path: "",
-        sources: ["Sources"]
-      ),
-      .testTarget(
-        name: "StencilSwiftKitTests",
-        dependencies: [
-          "StencilSwiftKit"
-        ],
-        path: "Tests"
-      )
-    ],
-    swiftLanguageVersions: [4]
+  name: "StencilSwiftKit",
+  products: [
+      .library(name: "StencilSwiftKit", targets: ["StencilSwiftKit"])
+  ],
+  dependencies: [
+      .package(url: "https://github.com/stencilproject/Stencil.git", .upToNextMinor(from: "0.12.0"))
+  ],
+  targets: [
+    .target(
+      name: "StencilSwiftKit",
+      dependencies: [
+        "Stencil"
+      ]
+    ),
+    .testTarget(
+      name: "StencilSwiftKitTests",
+      dependencies: [
+        "StencilSwiftKit"
+      ]
+    )
+  ],
+  swiftLanguageVersions: [4]
 )

Pods/Pods.xcodeproj/project.pbxproj

@@ -45,7 +45,7 @@
 
 ## StencilSwiftTemplate
 
-This framework also contains [a `StencilSwiftTemplate` class](https://github.com/SwiftGen/StencilSwiftKit/blob/master/Sources/StencilSwiftTemplate.swift#L10), which is a subclass of `Stencil.Template` dedicated to remove extra newlines when rendering the template.
+This framework also contains [a `StencilSwiftTemplate` class](https://github.com/SwiftGen/StencilSwiftKit/blob/master/Sources/StencilSwiftKit/StencilSwiftTemplate.swift#L10), which is a subclass of `Stencil.Template` dedicated to remove extra newlines when rendering the template.
 
 Indeed, such extra newlines could otherwise be inserted in the generated output because you want your template to be well formatted, and that can end up with Stencil nodes like `{% for … %}` and `{% if … %}` be alone in some lines of your template and that would render into nothing by themselves, generating empty lines in the output.
 
@@ -54,7 +54,7 @@ This template subclass aims to remove those lines generated by using a simple wo
 
 ## Stencil.Extension & swiftStencilEnvironment
 
-This framework also contains [helper methods for `Stencil.Extension` and `Stencil.Environment`](https://github.com/SwiftGen/StencilSwiftKit/blob/master/Sources/Environment.swift), to easily register all the tags and filters listed above on an existing `Stencil.Extension`, as well as to easily get a `Stencil.Environment` preconfigured with both those tags & filters `Extension` and the `StencilSwiftTemplate`.
+This framework also contains [helper methods for `Stencil.Extension` and `Stencil.Environment`](https://github.com/SwiftGen/StencilSwiftKit/blob/master/Sources/StencilSwiftKit/Environment.swift), to easily register all the tags and filters listed above on an existing `Stencil.Extension`, as well as to easily get a `Stencil.Environment` preconfigured with both those tags & filters `Extension` and the `StencilSwiftTemplate`.
 
 ## Parameters
 

README.md

@@ -14,6 +14,16 @@ CONFIGURATION = 'Debug'.freeze
 POD_NAME = 'StencilSwiftKit'.freeze
 MIN_XCODE_VERSION = 9.2
 
+## [ Generate SPM files ] #####################################################
+
+namespace :spm do
+  desc 'Generate the tests manifest for SPM'
+  task :generate_test_manifests do |task|
+    File.delete("Tests/#{WORKSPACE}Tests/XCTestManifests.swift")
+    Utils.run('swift test --generate-linuxmain', task, xcrun: true)
+  end
+end
+
 ## [ Release a new version ] ##################################################
 
 namespace :release do

Rakefile

@@ -5,8 +5,8 @@ SWIFTLINT="${PROJECT_DIR}/Pods/SwiftLint/swiftlint"
 CONFIG="${PROJECT_DIR}/.swiftlint.yml"
 
 # possible paths
-paths_sources="Sources"
-paths_tests="Tests"
+paths_sources="Sources/StencilSwiftKit"
+paths_tests="Tests/StencilSwiftKitTests"
 
 # load selected group
 if [ $# -gt 0 ]; then

Scripts/SwiftLint.sh

@@ -305,7 +305,15 @@ extension Filters.Strings {
   /// - Throws: FilterError.invalidInputType if the value parameter isn't a string
   static func dirname(_ value: Any?) throws -> Any? {
     let string = try Filters.parseString(from: value)
+    #if os(Linux)
+    var result = NSString(string: string).deletingLastPathComponent
+    if result.isEmpty {
+      result = "."
+    }
+    return result
+    #else
     return Path(string).parent().normalize().string
+    #endif
   }
 
   /// Removes newlines and other whitespace from a string. Takes an optional Mode argument:

Sources/CallMacroNodes.swift renamed to Sources/StencilSwiftKit/CallMacroNodes.swift

@@ -28,6 +28,12 @@ enum Filters {
     if let string = value as? String {
         return string
     }
+    #if os(Linux)
+    if let string = value as? NSString {
+      return String(describing: string)
+    }
+    #endif
+
     throw Error.invalidInputType
   }
 

Sources/Context.swift renamed to Sources/StencilSwiftKit/Context.swift

@@ -0,0 +1,8 @@
+import XCTest
+
+import StencilSwiftKitTests
+
+var tests = [XCTestCaseEntry]()
+tests += StencilSwiftKitTests.__allTests()
+
+XCTMain(tests)