Merge pull request stephencelis#560 from stephencelis/package-manager

Swift Package Manager

Author: jberkel

.gitignore

@@ -21,3 +21,7 @@ DerivedData
 
 # Carthage
 Carthage
+
+# Swift Package Manager
+.build
+Packages/

.travis.yml

@@ -12,6 +12,7 @@ matrix:
     - env: VALIDATOR_SUBSPEC="standard"
     - env: VALIDATOR_SUBSPEC="standalone"
     - env: VALIDATOR_SUBSPEC="SQLCipher"
+    - env: PACKAGE_MANAGER_COMMAND="test -Xlinker -lsqlite3"
 before_install:
   - gem update bundler
   - gem install xcpretty --no-document

CHANGELOG.md

@@ -2,6 +2,7 @@
 ========================================
 
 * Fixed SQLCipher integration with read-only databases ([#559][])
+* Preliminary Swift Package Manager support ([#548][], [#560][])
 * Fixed null pointer when fetching an empty BLOB ([#561][])
 
 0.11.1 (06-12-2016), [diff][diff-0.11.1]
@@ -24,6 +25,8 @@
 
 [#532]: https://github.com/stephencelis/SQLite.swift/issues/532
 [#546]: https://github.com/stephencelis/SQLite.swift/issues/546
+[#548]: https://github.com/stephencelis/SQLite.swift/pull/548
 [#553]: https://github.com/stephencelis/SQLite.swift/pull/553
 [#559]: https://github.com/stephencelis/SQLite.swift/pull/559
+[#560]: https://github.com/stephencelis/SQLite.swift/pull/560
 [#561]: https://github.com/stephencelis/SQLite.swift/issues/561

CocoaPodsTests/integration_test.rb

@@ -13,7 +13,7 @@ def test_validate_project
 
   def validator
     @validator ||= TestRunningValidator.new(podspec, []).tap do |validator|
-        validator.test_files = Dir["#{project_test_dir}/*.swift"]
+        validator.test_files = Dir["#{project_test_dir}/**/*.swift"]
         validator.test_resources = Dir["#{project_test_dir}/fixtures"]
         validator.config.verbose = true
         validator.no_clean = true
@@ -38,6 +38,6 @@ def podspec
   end
 
   def project_test_dir
-    File.expand_path(File.dirname(__FILE__) + '/../SQLiteTests')
+    File.expand_path(File.dirname(__FILE__) + '/../Tests/SQLiteTests')
   end
 end

Documentation/Index.md

@@ -3,8 +3,8 @@
   - [Installation](#installation)
     - [Carthage](#carthage)
     - [CocoaPods](#cocoapods)
+    - [Swift Package Manager](#swift-package-manager)
     - [Manual](#manual)
-    - [Frameworkless Targets](#frameworkless-targets)
   - [Getting Started](#getting-started)
     - [Connecting to a Database](#connecting-to-a-database)
       - [Read-Write Databases](#read-write-databases)
@@ -162,6 +162,30 @@ try db.rekey("another secret")
 [sqlite3pod]: https://github.com/clemensg/sqlite3pod
 [SQLCipher]: https://www.zetetic.net/sqlcipher/
 
+### Swift Package Manager
+
+The [Swift Package Manager][] is a tool for managing the distribution of Swift code.
+It’s integrated with the Swift build system to automate the process of
+downloading, compiling, and linking dependencies.
+
+It is the recommended approach for using SQLite.swift in OSX CLI applications.
+
+ 1. Add the following to your `Package.swift` file:
+
+  ``` swift
+  dependencies: [
+    .Package(url: "https://github.com/stephencelis/SQLite.swift.git", majorVersion: 0, minor: 11)
+  ]
+  ```
+
+ 2. Build your project:
+
+  ``` sh
+  $ swift build -Xlinker -lsqlite3
+  ```
+
+[Swift Package Manager]: https://swift.org/package-manager
+
 ### Manual
 
 To install SQLite.swift as an Xcode sub-project:
@@ -186,24 +210,6 @@ Some additional steps are required to install the application on an actual devic
 
  7. **Add**.
 
-### Frameworkless Targets
-
-It’s possible to use SQLite.swift in a target that doesn’t support frameworks, including iOS 7 apps and OS X command line tools, though it takes a little extra work.
-
- 1. In your target’s **Build Phases**, add **libsqlite3.dylib** to the **Link Binary With Libraries** build phase.
-
- 2. Copy the SQLite.swift source files (from its **SQLite** directory) into your Xcode project.
-
- 3. Add the following lines to your project’s [bridging header](https://developer.apple.com/library/prerelease/ios/documentation/Swift/Conceptual/BuildingCocoaApps/MixandMatch.html#//apple_ref/doc/uid/TP40014216-CH10-XID_79) (a file usually in the form of `$(TARGET_NAME)-Bridging-Header.h`).
-
-    ``` swift
-    #import <sqlite3.h>
-    #import "SQLite-Bridging.h"
-    ```
-
-> _Note:_ Adding SQLite.swift source files directly to your application will both remove the `SQLite` module namespace (no need—or ability—to `import SQLite`) and expose internal functions and variables. You will need to rename anything that conflicts with code of your own. Please [report any bugs](https://github.com/stephencelis/SQLite.swift/issues/new) (_e.g._, segfaults) you encounter.
-
-
 ## Getting Started
 
 To use SQLite.swift classes or structures in your target’s source file, first import the `SQLite` module.

Documentation/Planning.md

@@ -11,15 +11,10 @@ _Lists agreed upon next steps in approximate priority order._
 
 _A gathering point for ideas for new features. In general, the corresponding issue will be closed once it is added here, with the assumption that it will be referred to when it comes time to add the corresponding feature._
 
-### Packaging
-
- * linux support via Swift Package Manager, per [#315](https://github.com/stephencelis/SQLite.swift/issues/315), _in progress_: [#548](https://github.com/stephencelis/SQLite.swift/pull/548)
-
 ### Features
 
  * encapsulate ATTACH DATABASE / DETACH DATABASE as methods, per [#30](https://github.com/stephencelis/SQLite.swift/issues/30)
  * provide separate threads for update vs read, so updates don't block reads, per [#236](https://github.com/stephencelis/SQLite.swift/issues/236)
- * expose more FTS4 options, e.g. virtual table support per [#164](https://github.com/stephencelis/SQLite.swift/issues/164)
  * expose triggers, per [#164](https://github.com/stephencelis/SQLite.swift/issues/164)
 
 ## Suspended Feature Requests

Package.swift

@@ -0,0 +1,16 @@
+import PackageDescription
+
+let package = Package(
+    name: "SQLite",
+    targets: [
+        Target(
+            name: "SQLite",
+            dependencies: [
+                .Target(name: "SQLiteObjc")
+            ]),
+        Target(name: "SQLiteObjc")
+    ],
+    dependencies: [
+        .Package(url: "https://github.com/jberkel/CSQLite.git", majorVersion: 0)
+    ]
+)

README.md

@@ -112,12 +112,6 @@ For a more comprehensive example, see [this article](http://masteringswift.blogs
 > _Note:_ SQLite.swift requires Swift 3 (and [Xcode][] 8) or greater. If you absolutely
 > need compatibility with Swift 2.3 you can use the [swift-2.3][] branch or older
 > released versions. New development will happen exclusively on the master/Swift 3 branch.
->
-> The following instructions apply to targets that support embedded
-> Swift frameworks. To use SQLite.swift in iOS 7 or an OS X command line
-> tool, please read the [Frameworkless Targets][] section of the
-> documentation.
-
 
 ### Carthage
 
@@ -174,6 +168,19 @@ SQLite.swift with CocoaPods:
 [CocoaPods]: https://cocoapods.org
 [CocoaPods Installation]: https://guides.cocoapods.org/using/getting-started.html#getting-started
 
+### Swift Package Manager
+
+The [Swift Package Manager][] is a tool for managing the distribution of Swift code.
+
+1. Add the following to your `Package.swift` file:
+
+```swift
+dependencies: [
+    .Package(url: "https://github.com/stephencelis/SQLite.swift.git", majorVersion: 0, minor: 11)
+]
+```
+
+[Swift Package Manager]: https://swift.org/package-manager
 
 ### Manual
 
@@ -200,7 +207,6 @@ Some additional steps are required to install the application on an actual devic
  7. **Add**.
 
 
-[Frameworkless Targets]: Documentation/Index.md#frameworkless-targets
 [Xcode]: https://developer.apple.com/xcode/downloads/
 [Submodule]: http://git-scm.com/book/en/Git-Tools-Submodules
 [download]: https://github.com/stephencelis/SQLite.swift/archive/master.zip

SQLite.swift.podspec

@@ -25,9 +25,9 @@ Pod::Spec.new do |s|
   }
 
   s.subspec 'standard' do |ss|
-    ss.source_files = 'SQLite/**/*.{c,h,m,swift}'
-    ss.exclude_files = 'SQLite/Extensions/Cipher.swift'
-    ss.private_header_files = 'SQLite/Core/fts3_tokenizer.h'
+    ss.source_files = 'Sources/{SQLite,SQLiteObjc}/**/*.{c,h,m,swift}'
+    ss.exclude_files = 'Sources/**/Cipher.swift'
+    ss.private_header_files = 'Sources/SQLiteObjc/*.h'
 
     ss.library = 'sqlite3'
     ss.preserve_paths = 'CocoaPods/**/*'
@@ -47,9 +47,9 @@ Pod::Spec.new do |s|
   end
 
   s.subspec 'standalone' do |ss|
-    ss.source_files = 'SQLite/**/*.{c,h,m,swift}'
-    ss.exclude_files = 'SQLite/Extensions/Cipher.swift'
-    ss.private_header_files = 'SQLite/Core/fts3_tokenizer.h'
+    ss.source_files = 'Sources/{SQLite,SQLiteObjc}/**/*.{c,h,m,swift}'
+    ss.exclude_files = 'Sources/**/Cipher.swift'
+    ss.private_header_files = 'Sources/SQLiteObjc/*.h'
     ss.xcconfig = {
       'OTHER_SWIFT_FLAGS' => '$(inherited) -DSQLITE_SWIFT_STANDALONE'
     }
@@ -58,8 +58,8 @@ Pod::Spec.new do |s|
   end
 
   s.subspec 'SQLCipher' do |ss|
-    ss.source_files = 'SQLite/**/*.{c,h,m,swift}'
-    ss.private_header_files = 'SQLite/Core/fts3_tokenizer.h'
+    ss.source_files = 'Sources/{SQLite,SQLiteObjc}/**/*.{c,h,m,swift}'
+    ss.private_header_files = 'Sources/SQLiteObjc/*.h'
     ss.xcconfig = {
       'OTHER_SWIFT_FLAGS' => '$(inherited) -DSQLITE_SWIFT_SQLCIPHER',
       'GCC_PREPROCESSOR_DEFINITIONS' => '$(inherited) SQLITE_HAS_CODEC=1'