Automatically download swiftlint / xcbeautifier, lint fixes

jberkel · jberkel · commit 85f1d443e9b7 · 2023-05-21T15:09:30.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -22,6 +22,9 @@ DerivedData
 # Carthage
 /Carthage/
 
+# Makefile
+bin/
+
 # Swift Package Manager
 .build
 Packages/
diff --git a/.swiftlint.yml b/.swiftlint.yml
@@ -4,6 +4,7 @@ disabled_rules: # rule identifiers to exclude from running
   - large_tuple
   - closure_parameter_position
   - inclusive_language  # sqlite_master etc.
+  - blanket_disable_command
 included: # paths to include during linting. `--path` is ignored if present. takes precendence over `excluded`.
   - Sources
   - Tests
@@ -26,8 +27,8 @@ identifier_name:
     - SQLITE_TRANSIENT
 
 type_body_length:
-  warning: 260
-  error: 260
+  warning: 350
+  error: 350
 
 function_body_length:
   warning: 60
diff --git a/Makefile b/Makefile
@@ -1,41 +1,76 @@
-BUILD_TOOL = xcodebuild
+XCODEBUILD = xcodebuild
 BUILD_SCHEME = SQLite Mac
-IOS_SIMULATOR = iPhone 12
-IOS_VERSION = 15.0
+IOS_SIMULATOR = iPhone 14
+IOS_VERSION = 16.4
+
+# tool settings
+SWIFTLINT_VERSION=0.52.2
+SWIFTLINT=bin/swiftlint-$(SWIFTLINT_VERSION)
+SWIFTLINT_URL=https://github.com/realm/SwiftLint/releases/download/$(SWIFTLINT_VERSION)/portable_swiftlint.zip
+XCBEAUTIFY_VERSION=0.20.0
+XCBEAUTIFY=bin/xcbeautify-$(XCBEAUTIFY_VERSION)
+ifeq ($(shell uname), Linux)
+	XCBEAUTIFY_PLATFORM=x86_64-unknown-linux-gnu.tar.xz
+else
+	XCBEAUTIFY_PLATFORM=universal-apple-macosx.zip
+endif
+XCBEAUTIFY_URL=https://github.com/tuist/xcbeautify/releases/download/$(XCBEAUTIFY_VERSION)/xcbeautify-$(XCBEAUTIFY_VERSION)-$(XCBEAUTIFY_PLATFORM)
+CURL_OPTS=--fail --silent -L --retry 3
+
 ifeq ($(BUILD_SCHEME),SQLite iOS)
 	BUILD_ARGUMENTS = -scheme "$(BUILD_SCHEME)" -destination "platform=iOS Simulator,name=$(IOS_SIMULATOR),OS=$(IOS_VERSION)"
 else
 	BUILD_ARGUMENTS = -scheme "$(BUILD_SCHEME)"
 endif
 
-XCPRETTY := $(shell command -v xcpretty)
-TEST_ACTIONS := clean build build-for-testing test-without-building
+test: $(XCBEAUTIFY)
+	set -o pipefail; \
+	$(XCODEBUILD) $(BUILD_ARGUMENTS) test | $(XCBEAUTIFY)
 
-default: test
+build: $(XCBEAUTIFY)
+	set -o pipefail; \
+	$(XCODEBUILD) $(BUILD_ARGUMENTS) | $(XCBEAUTIFY)
 
-build:
-	$(BUILD_TOOL) $(BUILD_ARGUMENTS)
+lint: $(SWIFTLINT)
+	$< --strict
 
-lint:
-	swiftlint --strict
-lint-fix:
-	swiftlint lint fix
-
-test:
-ifdef XCPRETTY
-	@set -o pipefail && $(BUILD_TOOL) $(BUILD_ARGUMENTS) $(TEST_ACTIONS) | $(XCPRETTY) -c
-else
-	$(BUILD_TOOL) $(BUILD_ARGUMENTS) $(TEST_ACTIONS)
-endif
+lint-fix: $(SWIFTLINT)
+	$< lint fix
 
 clean:
-	$(BUILD_TOOL) $(BUILD_ARGUMENTS) clean
+	$(XCODEBUILD) $(BUILD_ARGUMENTS) clean
 
 repl:
-	@$(BUILD_TOOL) $(BUILD_ARGUMENTS) -derivedDataPath $(TMPDIR)/SQLite.swift > /dev/null && \
-		swift -F '$(TMPDIR)/SQLite.swift/Build/Products/Debug'
+	@$(XCODEBUILD) $(BUILD_ARGUMENTS) -derivedDataPath $(TMPDIR)/SQLite.swift > /dev/null && \
+		swift repl -F '$(TMPDIR)/SQLite.swift/Build/Products/Debug'
 
 sloc:
-	@zsh -c "grep -vE '^ *//|^$$' Sources/**/*.{swift,h,m} | wc -l"
+	@zsh -c "grep -vE '^ *//|^$$' Sources/**/*.{swift,h} | wc -l"
+
+$(SWIFTLINT):
+	set -e ; \
+	curl $(CURL_OPTS) $(SWIFTLINT_URL) -o swiftlint.zip; \
+	unzip -o swiftlint.zip swiftlint; \
+	mkdir -p bin; \
+	mv swiftlint $@ && rm -f swiftlint.zip
+
+$(XCBEAUTIFY):
+	set -e; \
+	FILE=$(XCBEAUTIFY_PLATFORM); \
+	curl $(CURL_OPTS) $(XCBEAUTIFY_URL) -o $$FILE; \
+	case "$${FILE#*.}" in \
+	  "zip") \
+		unzip -o $$FILE xcbeautify; \
+		;; \
+	  "tar.xz") \
+	  	tar -xvf $$FILE xcbeautify; \
+		;; \
+	  *) \
+		echo "unknown extension $${FILE#*.}!"; \
+		exit 1; \
+		;; \
+	esac; \
+	mkdir -p bin; \
+	mv xcbeautify $@ && rm -f $$FILE;
 
 .PHONY: test clean repl sloc
diff --git a/Sources/SQLite/Core/Backup.swift b/Sources/SQLite/Core/Backup.swift
@@ -140,7 +140,7 @@ public final class Backup {
     /// - Parameter pagesToCopy: The maximal number of pages to copy in one step
     ///
     /// - Throws: `Result.Error` if step fails.
-    //
+    ///
     /// See: <https://www.sqlite.org/c3ref/backup_finish.html#sqlite3backupstep>
     public func step(pagesToCopy pages: Pages = .all) throws {
         let status = sqlite3_backup_step(handle, pages.number)
diff --git a/Sources/SQLite/Helpers.swift b/Sources/SQLite/Helpers.swift
@@ -38,6 +38,7 @@ public func *(_: Expression<Binding>?, _: Expression<Binding>?) -> Expression<Vo
     Expression(literal: "*")
 }
 
+// swiftlint:disable:next type_name
 public protocol _OptionalType {
 
     associatedtype WrappedType
diff --git a/Sources/SQLite/Schema/SchemaReader.swift b/Sources/SQLite/Schema/SchemaReader.swift
@@ -13,7 +13,7 @@ public class SchemaReader {
     // column name, data type, whether or not the column can be NULL, and the default value for the column. The
     // "pk" column in the result set is zero for columns that are not part of the primary key, and is the
     // index of the column in the primary key for columns that are part of the primary key.
-    public func columnDefinitions(table: String) throws  -> [ColumnDefinition] {
+    public func columnDefinitions(table: String) throws -> [ColumnDefinition] {
         func parsePrimaryKey(column: String) throws -> ColumnDefinition.PrimaryKey? {
             try createTableSQL(name: table).flatMap { .init(sql: $0) }
         }
diff --git a/Sources/SQLite/Typed/Query.swift b/Sources/SQLite/Typed/Query.swift
@@ -1105,7 +1105,7 @@ extension Connection {
         return value(try scalar(expression.template, expression.bindings))
     }
 
-    public func scalar<V: Value>(_ query: Select<V?>) throws ->  V.ValueType? {
+    public func scalar<V: Value>(_ query: Select<V?>) throws -> V.ValueType? {
         let expression = query.expression
         guard let value = try scalar(expression.template, expression.bindings) as? V.Datatype else { return nil }
         return V.fromDatatypeValue(value)
diff --git a/Tests/.swiftlint.yml b/Tests/.swiftlint.yml
@@ -6,8 +6,8 @@ disabled_rules:
   - identifier_name
 
 type_body_length:
-  warning: 800
-  error: 800
+  warning: 1000
+  error: 1000
 
 function_body_length:
   warning: 200
diff --git a/Tests/SQLiteTests/Schema/SchemaTests.swift b/Tests/SQLiteTests/Schema/SchemaTests.swift
@@ -72,6 +72,7 @@ class SchemaTests: XCTestCase {
     }
 
     // thoroughness test for ambiguity
+    // swiftlint:disable:next function_body_length
     func test_column_compilesColumnDefinitionExpression() {
         XCTAssertEqual(
             "CREATE TABLE \"table\" (\"int64\" INTEGER NOT NULL)",
@@ -390,6 +391,7 @@ class SchemaTests: XCTestCase {
         )
     }
 
+    // swiftlint:disable:next function_body_length
     func test_column_withStringExpression_compilesCollatedColumnDefinitionExpression() {
         XCTAssertEqual(
             "CREATE TABLE \"table\" (\"string\" TEXT NOT NULL COLLATE RTRIM)",
diff --git a/Tests/SQLiteTests/Typed/CustomFunctionsTests.swift b/Tests/SQLiteTests/Typed/CustomFunctionsTests.swift
@@ -5,8 +5,8 @@ import SQLite
 #if !os(Linux)
 
 class CustomFunctionNoArgsTests: SQLiteTestCase {
-    typealias FunctionNoOptional              = ()  -> Expression<String>
-    typealias FunctionResultOptional          = ()  -> Expression<String?>
+    typealias FunctionNoOptional              = () -> Expression<String>
+    typealias FunctionResultOptional          = () -> Expression<String?>
 
     func testFunctionNoOptional() throws {
         let _: FunctionNoOptional = try db.createFunction("test", deterministic: true) {
@@ -26,9 +26,9 @@ class CustomFunctionNoArgsTests: SQLiteTestCase {
 }
 
 class CustomFunctionWithOneArgTests: SQLiteTestCase {
-    typealias FunctionNoOptional              = (Expression<String>)  -> Expression<String>
+    typealias FunctionNoOptional              = (Expression<String>) -> Expression<String>
     typealias FunctionLeftOptional            = (Expression<String?>) -> Expression<String>
-    typealias FunctionResultOptional          = (Expression<String>)  -> Expression<String?>
+    typealias FunctionResultOptional          = (Expression<String>) -> Expression<String?>
     typealias FunctionLeftResultOptional      = (Expression<String?>) -> Expression<String?>
 
     func testFunctionNoOptional() throws {
@@ -65,12 +65,12 @@ class CustomFunctionWithOneArgTests: SQLiteTestCase {
 }
 
 class CustomFunctionWithTwoArgsTests: SQLiteTestCase {
-    typealias FunctionNoOptional              = (Expression<String>, Expression<String>)  -> Expression<String>
-    typealias FunctionLeftOptional            = (Expression<String?>, Expression<String>)  -> Expression<String>
+    typealias FunctionNoOptional              = (Expression<String>, Expression<String>) -> Expression<String>
+    typealias FunctionLeftOptional            = (Expression<String?>, Expression<String>) -> Expression<String>
     typealias FunctionRightOptional           = (Expression<String>, Expression<String?>) -> Expression<String>
-    typealias FunctionResultOptional          = (Expression<String>, Expression<String>)  -> Expression<String?>
+    typealias FunctionResultOptional          = (Expression<String>, Expression<String>) -> Expression<String?>
     typealias FunctionLeftRightOptional       = (Expression<String?>, Expression<String?>) -> Expression<String>
-    typealias FunctionLeftResultOptional      = (Expression<String?>, Expression<String>)  -> Expression<String?>
+    typealias FunctionLeftResultOptional      = (Expression<String?>, Expression<String>) -> Expression<String?>
     typealias FunctionRightResultOptional     = (Expression<String>, Expression<String?>) -> Expression<String?>
     typealias FunctionLeftRightResultOptional = (Expression<String?>, Expression<String?>) -> Expression<String?>
 

Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,7 @@ public func *(_: Expression<Binding>?, _: Expression<Binding>?) -> Expression<Vo`
`38`	`38`	`Expression(literal: "*")`
`39`	`39`	`}`
`40`	`40`
	`41`	`+// swiftlint:disable:next type_name`
`41`	`42`	`public protocol _OptionalType {`
`42`	`43`
`43`	`44`	`associatedtype WrappedType`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ public class SchemaReader {`
`13`	`13`	`// column name, data type, whether or not the column can be NULL, and the default value for the column. The`
`14`	`14`	`// "pk" column in the result set is zero for columns that are not part of the primary key, and is the`
`15`	`15`	`// index of the column in the primary key for columns that are part of the primary key.`
`16`		`- public func columnDefinitions(table: String) throws -> [ColumnDefinition] {`
	`16`	`+ public func columnDefinitions(table: String) throws -> [ColumnDefinition] {`
`17`	`17`	`func parsePrimaryKey(column: String) throws -> ColumnDefinition.PrimaryKey? {`
`18`	`18`	`try createTableSQL(name: table).flatMap { .init(sql: $0) }`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1105,7 +1105,7 @@ extension Connection {`
`1105`	`1105`	`return value(try scalar(expression.template, expression.bindings))`
`1106`	`1106`	`}`
`1107`	`1107`
`1108`		`- public func scalar<V: Value>(_ query: Select<V?>) throws -> V.ValueType? {`
	`1108`	`+ public func scalar<V: Value>(_ query: Select<V?>) throws -> V.ValueType? {`
`1109`	`1109`	`let expression = query.expression`
`1110`	`1110`	`guard let value = try scalar(expression.template, expression.bindings) as? V.Datatype else { return nil }`
`1111`	`1111`	`return V.fromDatatypeValue(value)`
Original file line number	Diff line number	Diff line change
`@@ -72,6 +72,7 @@ class SchemaTests: XCTestCase {`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`// thoroughness test for ambiguity`
	`75`	`+ // swiftlint:disable:next function_body_length`
`75`	`76`	`func test_column_compilesColumnDefinitionExpression() {`
`76`	`77`	`XCTAssertEqual(`
`77`	`78`	`"CREATE TABLE \"table\" (\"int64\" INTEGER NOT NULL)",`
`@@ -390,6 +391,7 @@ class SchemaTests: XCTestCase {`
`390`	`391`	`)`
`391`	`392`	`}`
`392`	`393`
	`394`	`+ // swiftlint:disable:next function_body_length`
`393`	`395`	`func test_column_withStringExpression_compilesCollatedColumnDefinitionExpression() {`
`394`	`396`	`XCTAssertEqual(`
`395`	`397`	`"CREATE TABLE \"table\" (\"string\" TEXT NOT NULL COLLATE RTRIM)",`