init

Author: marzvrover

.github/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: [marzvrover]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
+

.github/workflows/codacy-analysis.yml

@@ -0,0 +1,46 @@
+# This workflow checks out code, performs a Codacy security scan
+# and integrates the results with the
+# GitHub Advanced Security code scanning feature.  For more information on
+# the Codacy security scan action usage and parameters, see
+# https://github.com/codacy/codacy-analysis-cli-action.
+# For more information on Codacy Analysis CLI in general, see
+# https://github.com/codacy/codacy-analysis-cli.
+
+name: Codacy Security Scan
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  codacy-security-scan:
+    name: Codacy Security Scan
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout the repository to the GitHub Actions runner
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      # Execute Codacy Analysis CLI and generate a SARIF output with the security issues identified during the analysis
+      - name: Run Codacy Analysis CLI
+        uses: codacy/[email protected]
+        with:
+          # Check https://github.com/codacy/codacy-analysis-cli#project-token to get your project token from your Codacy repository
+          # You can also omit the token and run the tools that support default configurations
+          project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+          verbose: true
+          output: results.sarif
+          format: sarif
+          # Adjust severity of non-security issues
+          gh-code-scanning-compat: true
+          # Force 0 exit code to allow SARIF file generation
+          # This will handover control about PR rejection to the GitHub side
+          max-allowed-issues: 2147483647
+
+      # Upload the SARIF file generated in the previous step
+      - name: Upload SARIF results file
+        uses: github/codeql-action/upload-sarif@v1
+        with:
+          sarif_file: results.sarif

.github/workflows/docs.yml

@@ -0,0 +1,21 @@
+name: docs
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+
+    runs-on: macos-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Get Tag
+      id: get_tag
+      run: echo ::set-output name=tag::${GITHUB_REF#refs/tags/}
+    - name: Run Jazzy
+      uses: swiftpackages/[email protected]
+      with:
+        args: --module_version ${{ steps.get_tag.outputs.tag }} --github_file_prefix https://github.com/swiftpackages/SuperString/tree/${{ steps.get_tag.outputs.tag }} --output docs/${{ steps.get_tag.outputs.tag }}
+        personal_access_token: ${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}

.github/workflows/macOS.yml

@@ -0,0 +1,21 @@
+name: macOS
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: macos-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup Swift
+      uses: fwal/[email protected]
+    - name: Build
+      run: swift build -v
+    - name: Run tests
+      run: swift test -v

.github/workflows/maindocs.yml

@@ -0,0 +1,18 @@
+name: docs
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  build:
+
+    runs-on: macos-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Run Jazzy
+      uses: swiftpackages/[email protected]
+      with:
+        args: --module_version main --github_file_prefix https://github.com/swiftpackages/SuperString/tree/main --output docs/main
+        personal_access_token: ${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}

.github/workflows/ubuntu.yml

@@ -0,0 +1,21 @@
+name: ubuntu
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup Swift
+      uses: fwal/[email protected]
+    - name: Build
+      run: swift build -v
+    - name: Run tests
+      run: swift test -v

.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+/.build
+/Packages
+/*.xcodeproj
+xcuserdata/
+.swiftpm

.swiftlint.yml

@@ -0,0 +1,4 @@
+trailing_comma:
+    mandatory_comma: true
+disabled_rules:
+    - switch_case_alignment

Package.swift

@@ -0,0 +1,28 @@
+// swift-tools-version:5.3
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "SuperString",
+    products: [
+        // Products define the executables and libraries a package produces, and make them visible to other packages.
+        .library(
+            name: "SuperString",
+            targets: ["SuperString"]),
+    ],
+    dependencies: [
+        // Dependencies declare other packages that this package depends on.
+        // .package(url: /* package url */, from: "1.0.0"),
+    ],
+    targets: [
+        // Targets are the basic building blocks of a package. A target can define a module or a test suite.
+        // Targets can depend on other targets in this package, and on products in packages this package depends on.
+        .target(
+            name: "SuperString",
+            dependencies: []),
+        .testTarget(
+            name: "SuperStringTests",
+            dependencies: ["SuperString"]),
+    ]
+)

README.md

@@ -0,0 +1,3 @@
+# SuperString
+
+SuperString provides useful string extensions such as `kebabcased`.

Sources/SuperString/SuperString.swift

@@ -0,0 +1,28 @@
+public extension StringProtocol {
+    /// Turns the string into a kebab-case string
+    /// - returns: String in kebab-case
+    func kebabcased() -> String {
+        guard self.count > 0 else {
+            return ""
+        }
+
+        var output: String = self.first!.lowercased()
+        var previous: Character = output.first!
+
+        for char in self.dropFirst() {
+            if char.isWhitespace {
+                output.append("-")
+            } else if char.isUppercase {
+                if !previous.isWhitespace {
+                    output.append("-")
+                }
+                output.append(char.lowercased())
+            } else {
+                output.append(char)
+            }
+            previous = char
+        }
+
+        return output
+    }
+}

Tests/LinuxMain.swift

@@ -0,0 +1,7 @@
+import XCTest
+
+import SuperStringTests
+
+var tests = [XCTestCaseEntry]()
+tests += SuperStringTests.allTests()
+XCTMain(tests)

Tests/SuperStringTests/SuperStringTests.swift

@@ -0,0 +1,20 @@
+import XCTest
+import SuperString
+// swiftlint:disable
+final class SuperStringTests: XCTestCase {
+    func testKebabcased() {
+        let inputPairs: [(input: String, expected: String)] = [
+            (input: "this is a test", expected: "this-is-a-test"),
+            (input: "this is A test", expected: "this-is-a-test"),
+            (input: "ThisIsATest", expected: "this-is-a-test"),
+            (input: "ThisIs a Test", expected: "this-is-a-test"),
+        ]
+        for inputPair in inputPairs {
+            XCTAssertEqual(inputPair.input.kebabcased(), inputPair.expected)
+        }
+    }
+
+    static var allTests = [
+        ("testKebabcased", testKebabcased),
+    ]
+}

Tests/SuperStringTests/XCTestManifests.swift

@@ -0,0 +1,9 @@
+import XCTest
+
+#if !canImport(ObjectiveC)
+public func allTests() -> [XCTestCaseEntry] {
+    return [
+        testCase(SuperStringTests.allTests),
+    ]
+}
+#endif