Merge branch 'master' of https://github.com/stephencelis/SQLite.swift

Author: willhbr

.travis.yml

@@ -1,9 +1,13 @@
 language: objective-c
-env:
-  - BUILD_SCHEME="SQLite iOS"
-  - BUILD_SCHEME="SQLite Mac"
+matrix:
+  include:
+    - env: BUILD_SCHEME="SQLite iOS"
+    - env: BUILD_SCHEME="SQLite Mac"
+    - env: VALIDATOR_SUBSPEC="none"
+    - env: VALIDATOR_SUBSPEC="standard"
+    - env: VALIDATOR_SUBSPEC="standalone"
 before_install:
   - gem install xcpretty --no-document
 script:
-  - make test
+  - ./run-tests.sh
 osx_image: xcode7.3

CocoaPodsTests/.gitignore

@@ -0,0 +1 @@
+gems/

CocoaPodsTests/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'cocoapods'
+gem 'minitest'

CocoaPodsTests/Gemfile.lock

@@ -0,0 +1,65 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    claide (1.0.0)
+    cocoapods (1.0.0)
+      activesupport (>= 4.0.2)
+      claide (>= 1.0.0, < 2.0)
+      cocoapods-core (= 1.0.0)
+      cocoapods-deintegrate (>= 1.0.0, < 2.0)
+      cocoapods-downloader (>= 1.0.0, < 2.0)
+      cocoapods-plugins (>= 1.0.0, < 2.0)
+      cocoapods-search (>= 1.0.0, < 2.0)
+      cocoapods-stats (>= 1.0.0, < 2.0)
+      cocoapods-trunk (>= 1.0.0, < 2.0)
+      cocoapods-try (>= 1.0.0, < 2.0)
+      colored (~> 1.2)
+      escape (~> 0.0.4)
+      fourflusher (~> 0.3.0)
+      molinillo (~> 0.4.5)
+      nap (~> 1.0)
+      xcodeproj (>= 1.0.0, < 2.0)
+    cocoapods-core (1.0.0)
+      activesupport (>= 4.0.2)
+      fuzzy_match (~> 2.0.4)
+      nap (~> 1.0)
+    cocoapods-deintegrate (1.0.0)
+    cocoapods-downloader (1.0.0)
+    cocoapods-plugins (1.0.0)
+      nap
+    cocoapods-search (1.0.0)
+    cocoapods-stats (1.0.0)
+    cocoapods-trunk (1.0.0)
+      nap (>= 0.8, < 2.0)
+      netrc (= 0.7.8)
+    cocoapods-try (1.0.0)
+    colored (1.2)
+    escape (0.0.4)
+    fourflusher (0.3.0)
+    fuzzy_match (2.0.4)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.4)
+    molinillo (0.4.5)
+    nap (1.1.0)
+    netrc (0.7.8)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    xcodeproj (1.0.0)
+      activesupport (>= 3)
+      claide (>= 1.0.0, < 2.0)
+      colored (~> 1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cocoapods
+  minitest

CocoaPodsTests/Makefile

@@ -0,0 +1,10 @@
+test: install
+	@set -e; \
+	for test in *_test.rb; do \
+		bundle exec ./$$test; \
+	done
+
+install:
+	@bundle install --path gems
+
+.PHONY: test install

CocoaPodsTests/integration_test.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+require 'minitest/autorun'
+require_relative 'test_running_validator'
+
+class IntegrationTest < Minitest::Test
+
+  def test_validate_project
+    assert validator.validate, "validation failed: #{validator.failure_reason}"
+  end
+
+  private
+
+  def validator
+    @validator ||= TestRunningValidator.new(podspec, []).tap do |validator|
+    	subspec = ENV["VALIDATOR_SUBSPEC"]
+        validator.test_files = Dir["#{project_test_dir}/*.swift"]
+        validator.config.verbose = true
+        validator.no_clean = true
+        validator.use_frameworks = true
+        validator.fail_fast = true
+        validator.local = true
+        validator.allow_warnings = true
+        if subspec == "none"
+          validator.no_subspecs = true
+        else
+          validator.only_subspec = subspec
+        end
+    end
+  end
+
+  def podspec
+    File.expand_path(File.dirname(__FILE__) + '/../SQLite.swift.podspec')
+  end
+
+  def project_test_dir
+    File.expand_path(File.dirname(__FILE__) + '/../SQLiteTests')
+  end
+end

CocoaPodsTests/test_running_validator.rb

@@ -0,0 +1,91 @@
+require 'cocoapods'
+require 'cocoapods/validator'
+require 'fileutils'
+
+class TestRunningValidator < Pod::Validator
+  APP_TARGET = 'App'
+  TEST_TARGET = 'Tests'
+
+  attr_accessor :test_files
+
+  def create_app_project
+    super.tap do
+      project = Xcodeproj::Project.open(validation_dir + "#{APP_TARGET}.xcodeproj")
+      create_test_target(project)
+    end
+  end
+
+  def install_pod
+    super.tap do
+      if local?
+        FileUtils.ln_s file.dirname, validation_dir + "Pods/#{spec.name}"
+      end
+    end
+  end
+
+  def podfile_from_spec(*args)
+    super(*args).tap do |pod_file|
+      add_test_target(pod_file)
+    end
+  end
+
+  def build_pod
+    super
+    Pod::UI.message "\Testing with xcodebuild.\n".yellow do
+      run_tests
+    end
+  end
+
+  private
+  def create_test_target(project)
+    test_target = project.new_target(:unit_test_bundle, TEST_TARGET, consumer.platform_name, deployment_target)
+    group = project.new_group(TEST_TARGET)
+    test_target.add_file_references(test_files.map { |file| group.new_file(file) })
+    project.save
+    create_test_scheme(project, test_target)
+    project
+  end
+
+  def create_test_scheme(project, test_target)
+    project.recreate_user_schemes
+    test_scheme = Xcodeproj::XCScheme.new(test_scheme_path(project))
+    test_scheme.add_test_target(test_target)
+    test_scheme.save!
+  end
+
+  def test_scheme_path(project)
+    Xcodeproj::XCScheme.user_data_dir(project.path) + "#{TEST_TARGET}.xcscheme"
+  end
+
+  def add_test_target(pod_file)
+    app_target = pod_file.target_definitions[APP_TARGET]
+    Pod::Podfile::TargetDefinition.new(TEST_TARGET, app_target)
+  end
+
+  def run_tests
+    command = %W(clean test -workspace #{APP_TARGET}.xcworkspace -scheme #{TEST_TARGET} -configuration Debug)
+    case consumer.platform_name
+    when :ios
+      command += %w(CODE_SIGN_IDENTITY=- -sdk iphonesimulator)
+      command += Fourflusher::SimControl.new.destination('iPhone 4s', deployment_target)
+    when :osx
+      command += %w(LD_RUNPATH_SEARCH_PATHS=@loader_path/../Frameworks)
+    when :tvos
+      command += %w(CODE_SIGN_IDENTITY=- -sdk appletvsimulator)
+      command += Fourflusher::SimControl.new.destination('Apple TV 1080p', deployment_target)
+    else
+      return # skip watchos
+    end
+
+    output, status = Dir.chdir(validation_dir) { _xcodebuild(command) }
+    unless status.success?
+      message = 'Returned an unsuccessful exit code.'
+      if config.verbose?
+        message += "\nXcode output: \n#{output}\n"
+      else
+        message += ' You can use `--verbose` for more information.'
+      end
+      error('xcodebuild', message)
+    end
+  end
+end

Documentation/Index.md

@@ -11,6 +11,7 @@
       - [Read-Only Databases](#read-only-databases)
       - [In-Memory Databases](#in-memory-databases)
       - [Thread-Safety](#thread-safety)
+    - [Connection Pools](#connection-pools)
   - [Building Type-Safe SQL](#building-type-safe-sql)
     - [Expressions](#expressions)
       - [Compound Expressions](#compound-expressions)
@@ -111,8 +112,26 @@ install SQLite.swift with Carthage:
 
  3. Run `pod install`.
 
+ #### Requiring a specific version of SQLite
+
+ If you want to use a more recent version of SQLite than what is provided with the OS you can require the `standalone` subspec:
+
+``` ruby
+    pod 'SQLite.swift/standalone', '~> 0.10.1'
+```
+
+By default this will use the most recent version of SQLite without any extras. If you want you can further customize this by adding another dependency to sqlite3 or one of its subspecs:
+
+``` ruby
+    pod 'SQLite.swift/standalone', '~> 0.10.1'
+    pod 'sqlite3/fts5', '= 3.11.1'  # SQLite 3.11.1 with FTS5 enabled
+```
+
+See the [sqlite3 podspec][sqlite3pod] for more details.
+
 [CocoaPods]: https://cocoapods.org
 [CocoaPods Installation]: https://guides.cocoapods.org/using/getting-started.html#getting-started
+[sqlite3pod]: https://github.com/clemensg/sqlite3pod
 
 
 ### Manual
@@ -233,7 +252,7 @@ Every Connection comes equipped with its own serial queue for statement executio
 
 If you maintain multiple connections for a single database, consider setting a timeout (in seconds) and/or a busy handler:
 
-```swift
+``` swift
 db.busyTimeout = 5
 
 db.busyHandler({ tries in
@@ -247,6 +266,33 @@ db.busyHandler({ tries in
 > _Note:_ The default timeout is 0, so if you see `database is locked` errors, you may be trying to access the same database simultaneously from multiple connections.
 
 
+### Connection Pools
+
+Connection pools use SQLite WAL mode to allow concurrent reads and writes, which can increase performance. Connection pools are created similar to connections:
+
+``` swift
+let pool = try ConnectionPool("path/to/db.sqlite3")
+```
+
+Writes are done inside of a readWrite block:
+
+``` swift
+pool.readWrite { connection in
+    try connection.run(users.insert(email <- "[email protected]", name <- "Alice"))
+}
+```
+
+Reads are done inside of a read block:
+
+``` swift
+pool.read { connection in
+    for user in try connection.prepare(users) {
+        print("id: \(user[id]), email: \(user[email]), name: \(user[name])")
+    }
+}
+```
+
+
 ## Building Type-Safe SQL
 
 SQLite.swift comes with a typed expression layer that directly maps [Swift types](https://developer.apple.com/library/prerelease/ios/documentation/General/Reference/SwiftStandardLibraryReference/) to their [SQLite counterparts](https://www.sqlite.org/datatype3.html).
@@ -1381,6 +1427,22 @@ try db.run(emails.create(.FTS4([subject, body], tokenize: .Porter)))
 // CREATE VIRTUAL TABLE "emails" USING fts4("subject", "body", tokenize=porter)
 ```
 
+We can set the full range of parameters by creating a `FTS4Config` object.
+
+``` swift
+let emails = VirtualTable("emails")
+let subject = Expression<String>("subject")
+let body = Expression<String>("body")
+let config = FTS4Config()
+    .column(subject)
+    .column(body, [.unindexed])
+    .languageId("lid")
+    .order(.Desc)
+
+try db.run(emails.create(.FTS4(config))
+// CREATE VIRTUAL TABLE "emails" USING fts4("subject", "body", notindexed="body", languageid="lid", order="desc")
+```
+
 Once we insert a few rows, we can search using the `match` function, which takes a table or column as its first argument and a query string as its second.
 
 ``` swift
@@ -1396,6 +1458,22 @@ let replies = emails.filter(subject.match("Re:*"))
 // SELECT * FROM "emails" WHERE "subject" MATCH 'Re:*'
 ```
 
+### FTS5
+
+When linking against a version of SQLite with [FTS5](http://www.sqlite.org/fts5.html) enabled we can create the virtual table
+in a similar fashion.
+
+```swift
+let emails = VirtualTable("emails")
+let subject = Expression<String>("subject")
+let body = Expression<String>("body")
+let config = FTS5Config()
+    .column(subject)
+    .column(body, [.unindexed])
+
+try db.run(emails.create(.FTS5(config))
+// CREATE VIRTUAL TABLE "emails" USING fts5("subject", "body" UNINDEXED)
+```
 
 ## Executing Arbitrary SQL
 

Makefile

@@ -1,6 +1,10 @@
 BUILD_TOOL = xcodebuild
 BUILD_SCHEME = SQLite Mac
-BUILD_ARGUMENTS = -scheme "$(BUILD_SCHEME)"
+ifeq ($(BUILD_SCHEME),SQLite iOS)
+	BUILD_ARGUMENTS = -scheme "$(BUILD_SCHEME)" -sdk iphonesimulator
+else
+	BUILD_ARGUMENTS = -scheme "$(BUILD_SCHEME)"
+endif
 
 XCPRETTY := $(shell command -v xcpretty)
 SWIFTCOV := $(shell command -v swiftcov)

README.md

@@ -230,7 +230,7 @@ These projects enhance or use SQLite.swift:
 Looking for something else? Try another Swift wrapper (or [FMDB][]):
 
  - [Camembert](https://github.com/remirobert/Camembert)
- - [EonilSQLite3](https://github.com/Eonil/SQLite3)
+ - [GRDB](https://github.com/groue/GRDB.swift)
  - [SQLiteDB](https://github.com/FahimF/SQLiteDB)
  - [Squeal](https://github.com/nerdyc/Squeal)
  - [SwiftData](https://github.com/ryanfowler/SwiftData)