Merge pull request #143 from brightdigit/release/3.0.0

Release/3.0.0

.github/workflows/macOS.yml

@@ -0,0 +1,43 @@
+name: macOS
+
+on: [push]
+
+jobs:
+  build:
+    env:
+      PACKAGE_NAME: Speculid
+
+    runs-on: macos-latest
+    if: "!contains(github.event.head_commit.message, 'ci skip')"
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Prepare Build
+      run: brew bundle
+    #- name: Build
+    #  run: swift build
+    - name: Lint
+      run: swiftformat --lint . && swiftlint
+    #- name: Run tests
+    #  run: swift test -v --enable-code-coverage
+    #- name: Prepare Code Coverage
+    #  run: xcrun llvm-cov export -format="lcov" .build/debug/${{ env.PACKAGE_NAME }}PackageTests.xctest/Contents/MacOS/${{ env.PACKAGE_NAME }}PackageTests -instr-profile .build/debug/codecov/default.profdata > info.lcov
+    #- name: Upload to CodeCov.io
+    #  run: bash <(curl https://codecov.io/bash) -F github -F macOS -n ${{ github.sha }}
+    #  env:
+    #      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+    #- name: Build Documentation
+    #  run: sourcedocs generate --spm-module ${{ env.PACKAGE_NAME }}
+    #- name: Verify Valid Swift Package
+    #  run: swift package dump-package | jq -e ".products | length > 0"
+    #- name: CocoaPods Action
+    #  run: pod lib lint
+
+    #- name: Commit files
+    #  run: |
+    #    git config --local user.email "[email protected]"
+    #    git config --local user.name "GitHub Action"
+    #    git status
+    #    git add Documentation
+    #    git diff-index --quiet HEAD || git commit -m "[github action] Update Docs"
+    #    git push

.gitignore

@@ -1,7 +1,6 @@
 
-# Created by https://www.gitignore.io/api/macos,swift,xcode,objective-c,jekyll
-
-### Jekyll ###
+# Created by https://www.gitignore.io/api/xcode,macos,swift
+# Edit at https://www.gitignore.io/?templates=xcode,macos,swift
 _site/
 .sass-cache/
 .jekyll-cache/
@@ -35,7 +34,7 @@ Network Trash Folder
 Temporary Items
 .apdisk
 
-### Objective-C ###
+### Swift ###
 # Xcode
 #
 # gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore
@@ -66,26 +65,34 @@ xcuserdata/
 *.dSYM.zip
 *.dSYM
 
+## Playgrounds
+timeline.xctimeline
+playground.xcworkspace
+
+# Swift Package Manager
+# Add this line if you want to avoid checking in source code from Swift Package Manager dependencies.
+# Packages/
+# Package.pins
+# Package.resolved
+.build/
+# Add this line if you want to avoid checking in Xcode SPM integration.
+# .swiftpm/xcode
+
 # CocoaPods
-#
 # We recommend against adding the Pods directory to your .gitignore. However
 # you should judge for yourself, the pros and cons are mentioned at:
 # https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
 # Pods/
-#
 # Add this line if you want to avoid checking in source code from the Xcode workspace
 # *.xcworkspace
 
 # Carthage
-#
 # Add this line if you want to avoid checking in source code from Carthage dependencies.
 # Carthage/Checkouts
 
 Carthage/Build
 
 # fastlane
-#
 # It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the
 # screenshots whenever they are needed.
 # For more information about the recommended setup visit:
@@ -97,67 +104,13 @@ fastlane/screenshots/**/*.png
 fastlane/test_output
 
 # Code Injection
-#
 # After new code Injection tools there's a generated folder /iOSInjectionProject
 # https://github.com/johnno1962/injectionforxcode
 
 iOSInjectionProject/
 
-### Objective-C Patch ###
-
-### Swift ###
-# Xcode
-#
-# gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore
-
-## Build generated
-
-## Various settings
-
-## Other
-
-## Obj-C/Swift specific
-
-## Playgrounds
-timeline.xctimeline
-playground.xcworkspace
-
-# Swift Package Manager
-#
-# Add this line if you want to avoid checking in source code from Swift Package Manager dependencies.
-# Packages/
-# Package.pins
-# Package.resolved
-.build/
-
-# CocoaPods
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-Pods/
-#
-# Add this line if you want to avoid checking in source code from the Xcode workspace
-# *.xcworkspace
-
-# Carthage
-#
-# Add this line if you want to avoid checking in source code from Carthage dependencies.
-# Carthage/Checkouts
-
-
-# fastlane
-#
-# It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the
-# screenshots whenever they are needed.
-# For more information about the recommended setup visit:
-# https://docs.fastlane.tools/best-practices/source-control/#source-control
-
-
 ### Xcode ###
 # Xcode
-#
 # gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore
 
 ## User settings
@@ -166,7 +119,7 @@ Pods/
 
 ## compatibility with Xcode 3 and earlier (ignoring not required starting Xcode 4)
 
-### Xcode Patch ###
+## Xcode Patch
 *.xcodeproj/*
 !*.xcodeproj/project.pbxproj
 !*.xcodeproj/xcshareddata/
@@ -191,16 +144,17 @@ certs/*.p12
 *.toc.*
 *.orig.*
 
-examples/**/*.xcassets/**/*.png
-examples/**/*.xcassets/**/*.pdf
+examples/*/*.xcassets/*/*.png
+examples/*/*.xcassets/*/*.pdf
+
+### Xcode Patch ###
+**/xcshareddata/WorkspaceSettings.xcsettings
 
-#examples/sample/**/*.xcassets/***/*.png
-#examples/sample/**/*.xcassets/*/*.pdf
+# End of https://www.gitignore.io/api/xcode,macos,swift
 
-playgrounds
 
-.version
-*.coverage.txt
-**/fastlane/report.xml 
+!scripts/github-markdown-toc
 
-examples/samples
+**/*.xcassets/**/*.png
+**/*.xcassets/**/*.pdf
+**/*.xcassets/**/*.svg

.gitmodules

@@ -1,9 +1,7 @@
 [submodule "scripts/github-markdown-toc"]
 	path = scripts/github-markdown-toc
 	url = https://github.com/ekalinin/github-markdown-toc.git
-[submodule "packages/homebrew"]
-	path = packages/homebrew
-	url = https://github.com/brightdigit/homebrew-speculid.git
-[submodule "packages/fastlane"]
-	path = packages/fastlane
-	url = https://github.com/brightdigit/fastlane-plugin-speculid.git
+[submodule "packages/SpeculidKit"]
+	path = packages/SpeculidKit
+	url = https://github.com/brightdigit/SpeculidKit.git
+  branch = release/3.0.0-alpha.2

.hound.yml

@@ -0,0 +1,2 @@
+swiftlint:
+  config_file: .swiftlint.yml

.swift-version

@@ -1 +1 @@
-5.1
+5

.swiftformat

@@ -0,0 +1,4 @@
+--indent 2
+--header strip
+--commas inline
+--exclude _archive, DerivedData, packages

.swiftlint.yml

@@ -1,6 +1,16 @@
-excluded: # paths to ignore during linting. Takes precedence over `included`.
-  - Pods
-  - __archive
-  - frameworks/speculid/Models/VCS.swift
+cyclomatic_complexity: 12
+file_length: 550
+function_body_length: 80
+function_parameter_count: 8
+line_length: 150
+type_body_length: 300
+identifier_name:
+  excluded: # excluded via string array
+    - id
+excluded:
+  - Tests/*/XCTestManifests.swift
   - DerivedData
-  - examples/setup/DerivedData
+  - .build
+  - _archive
+  - vendor
+  - packages

.travis.yml

@@ -1,42 +1,6 @@
-language: objective-c
-env:
-  global:
-  - secure: hVl7EFbdJhUsIzMXOZ0BESzmcMwro5fSHoFD33xCoWF+4Ov5TtiW5iy02Z4096fbgziD5SBdNG/4y87Z0kqRPPJgcGOObfwE3VWkIYj6dIHaXXnGlmieTEMRkq4a4GOjXJFpJODkKPmMSL1NLqdxUYFmn3rvCyBEQjiRQzygTj4=
-branches:
-  except:
-  - develop
-  - release/v2.0.0-beta.1
-git:
-  quiet: true
-osx_image: xcode11
-xcode_workspace: Speculid.xcworkspace
-xcode_scheme: Speculid-Mac-App
-xcode_destination: platform=macOS
-install:
-- bundle install
-- pod repo update --silent
-- pod install --silent
+os: osx
+osx_image: xcode12.2
+before_install:
+  - bash -e ./Scripts/before_install.sh
 script:
-- ./scripts/decrypt-certs.sh 
-- ./scripts/build-keychain.sh 
-- xcodebuild test -enableCodeCoverage YES -quiet -workspace speculid.xcworkspace -scheme "Speculid-Mac-App"
-- xcodebuild archive -quiet -workspace speculid.xcworkspace -scheme "Speculid-Mac-App" -configuration Release -derivedDataPath ./build -archivePath ./build/Products/Speculid.xcarchive
-- xcodebuild -quiet -exportArchive -archivePath ./build/Products/Speculid.xcarchive -exportOptionsPlist ./exportOptions.plist -exportPath ./build/Products/App
-- ditto -c -k --sequesterRsrc --keepParent ./build/Products/App/Speculid.app build/Speculid.zip
-- open Build/Products/App/Speculid.app
-- osascript -e 'tell application "Speculid" to quit'
-- diff examples/shasum <(./scripts/shasum.sh)
-- ./build/Products/App/Speculid.app/Contents/SharedSupport/speculid --version --useLocation ./build/Products/App/Speculid.app
-after_success:
-- bash <(curl -s https://codecov.io/bash) -J "Speculid"
-after_failure:
-- "./scripts/shasum.sh"
-- find "examples/Assets/." -type f \( -iname \*.icns -o -iname \*.png -o -iname \*.pdf
-  \) -print0 | sort -z | xargs -0 shasum -a 512
-notifications:
-  webhooks:
-    urls:
-    - https://webhooks.gitter.im/e/f596466e5c30701b566d
-    on_success: change
-    on_failure: always
-    on_start: never
+  - bash -e ./Scripts/script.sh

Brewfile

@@ -0,0 +1,5 @@
+brew "swiftformat"
+brew "swiftlint"
+brew "sourcedocs"
+brew "carthage"
+brew "jq"

Documentation/README.md

@@ -0,0 +1,4 @@
+
+# Reference Documentation
+This reference documentation was generated with
+[SourceDocs](https://github.com/eneko/SourceDocs).

Documentation/Reference/README.md

@@ -0,0 +1,4 @@
+
+# Reference Documentation
+This reference documentation was generated with
+[SourceDocs](https://github.com/eneko/SourceDocs).