Merge pull request #8 from tigerpixel/development

Swift 5.1 and Xcode11

Author: tigerpixel

.swift-version

@@ -1,4 +1,4 @@
-osx_image: xcode9
+osx_image: xcode11
 language: objective-c
 
 before_install:
@@ -15,8 +15,7 @@ script:
 
 - swiftlint
 
-- xcodebuild test -workspace PGNParser.xcworkspace -scheme PGNParser-iOS -destination 'platform=iOS Simulator,OS=latest,name=iPhone 7'
+- xcodebuild test -workspace PGNParser.xcworkspace -scheme PGNParser-iOS -destination 'platform=iOS Simulator,OS=latest,name=iPhone 8'
 - xcodebuild test -workspace PGNParser.xcworkspace -scheme PGNParser-macOS -destination 'platform=macOS,arch=x86_64'
-- xcodebuild test -workspace PGNParser.xcworkspace -scheme PGNParser-tvOS -destination 'platform=tvOS Simulator,name=Apple TV 1080p'
-
+- xcodebuild test -workspace PGNParser.xcworkspace -scheme PGNParser-tvOS -destination 'platform=tvOS Simulator,OS=latest,name=Apple TV 4K'
 - xcodebuild -workspace PGNParser.xcworkspace -scheme PGNParser-watchOS

.travis.yml

@@ -9,9 +9,29 @@
 * Give the project targets for iOS, Mac, tvOS and watchOS.
 * Make the project available to Cocoapods, Carthage and the SPM.
 
+## Version 0.2.0
+
 ### *Released 2017-10-01*
 
 * Swift 4 and Xcode 9 updates.
 * Swiftlint version update to 0.22.0
 * Add failure messages to all XCFail test cases.
 * Neaten markdown files.
+
+## Version 0.3.0
+
+### *Released 2019-8-20*
+
+* Swift 5 and Xcode 10.3 updates.
+* Swiftlint version update to 0.34.0
+* Update to Swift Package Manager to make compatible with Swift 5.
+
+## Version 0.4.0
+
+### *Released 2019-9-31*
+
+* Swift 5.1 and Xcode 11 updates.
+* Added all Apple platforms to Swift Package Manager build.
+* Promoted Swift Package Manager in the README file.
+* Removed unnecessary return statements.
+* Swiftlint version update to 0.35.0

CHANGELOG.md

@@ -6,7 +6,7 @@
 
 Pod::Spec.new do |s|
   s.name             = 'PGNParser'
-  s.version          = '0.2.0'
+  s.version          = '0.4.0'
   s.summary          = 'A simple way to parse Portable Game Notation into Swift objects.'
   s.description      = <<-DESC
 A simple way to parse Portable Game Notation into Swift objects. Easily parse game strings into Swift objects with just a single call. More work is required to fully suppourt the format. Pull requests for improvements are welcome.
@@ -22,8 +22,9 @@ A simple way to parse Portable Game Notation into Swift objects. Easily parse ga
   s.watchos.deployment_target = '2.0'
   s.osx.deployment_target = '10.9'
   s.tvos.deployment_target = '9.0'
+  s.swift_version = '5.1'
 
-  s.source_files = 'Source/**/*.swift'
+  s.source_files = 'Sources/**/*.swift'
 
   s.dependency 'Currier'
   s.dependency 'ParserCombinator'

PGNParser.podspec

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0900"
+   LastUpgradeVersion = "1030"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
@@ -26,7 +26,6 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      language = ""
       shouldUseLaunchSchemeArgsEnv = "YES">
       <Testables>
          <TestableReference
@@ -56,7 +55,6 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      language = ""
       launchStyle = "0"
       useCustomWorkingDirectory = "NO"
       ignoresPersistentStateOnLaunch = "NO"

PGNParser.xcodeproj/project.pbxproj

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0900"
+   LastUpgradeVersion = "1030"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
@@ -26,7 +26,6 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      language = ""
       shouldUseLaunchSchemeArgsEnv = "YES">
       <Testables>
          <TestableReference
@@ -56,7 +55,6 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      language = ""
       launchStyle = "0"
       useCustomWorkingDirectory = "NO"
       ignoresPersistentStateOnLaunch = "NO"

PGNParser.xcodeproj/xcshareddata/xcschemes/PGNParser-iOS.xcscheme

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0900"
+   LastUpgradeVersion = "1030"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
@@ -26,7 +26,6 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      language = ""
       shouldUseLaunchSchemeArgsEnv = "YES">
       <Testables>
          <TestableReference
@@ -56,7 +55,6 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      language = ""
       launchStyle = "0"
       useCustomWorkingDirectory = "NO"
       ignoresPersistentStateOnLaunch = "NO"

PGNParser.xcodeproj/xcshareddata/xcschemes/PGNParser-macOS.xcscheme

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0900"
+   LastUpgradeVersion = "1030"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
@@ -26,7 +26,6 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      language = ""
       shouldUseLaunchSchemeArgsEnv = "YES">
       <Testables>
          <TestableReference
@@ -56,7 +55,6 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      language = ""
       launchStyle = "0"
       useCustomWorkingDirectory = "NO"
       ignoresPersistentStateOnLaunch = "NO"

PGNParser.xcodeproj/xcshareddata/xcschemes/PGNParser-tvOS.xcscheme

@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>0.2.0</string>
+	<string>$(MARKETING_VERSION)</string>
 	<key>CFBundleVersion</key>
 	<string>$(CURRENT_PROJECT_VERSION)</string>
 	<key>NSHumanReadableCopyright</key>

PGNParser.xcodeproj/xcshareddata/xcschemes/PGNParser-watchOS.xcscheme

@@ -1,4 +1,4 @@
-//
+// swift-tools-version:5.1
 //  Package.swift
 //  PGNParser
 //
@@ -12,10 +12,19 @@ import PackageDescription
 
 let package = Package(
     name: "PGNParser",
+    platforms: [
+        // Other platforms compile as far back as possible by default.
+        .macOS(.v10_10)
+    ],
+    products: [
+        .library(name: "PGNParser", targets: ["PGNParser"])
+    ],
     dependencies: [
-        .Package(url: "https://github.com/tigerpixel/Currier.git",
-                  majorVersion: 1),
-        .Package(url: "https://github.com/tigerpixel/ParserCombinator.git",
-                 majorVersion: 1)
-        ]
+        .package(url: "https://github.com/tigerpixel/Currier.git", from: "1.3.0"),
+        .package(url: "https://github.com/tigerpixel/ParserCombinator.git", from: "2.1.0")
+        ],
+    targets: [
+        .target(name: "PGNParser", dependencies: ["Currier", "ParserCombinator"]),
+        .testTarget(name: "PGNParserTests", dependencies: ["PGNParser"])
+    ]
 )

PGNParser/Info.plist

@@ -1,15 +1,20 @@
 PODS:
-  - Currier (1.1.0)
-  - ParserCombinator (1.1.0)
+  - Currier (1.2.0)
+  - ParserCombinator (2.0.0)
 
 DEPENDENCIES:
   - Currier
   - ParserCombinator
 
+SPEC REPOS:
+  https://github.com/cocoapods/specs.git:
+    - Currier
+    - ParserCombinator
+
 SPEC CHECKSUMS:
-  Currier: 3c7592a2f357400608bc5d0c3a691be4ef93c249
-  ParserCombinator: 9534a29a7bd765f8a424c52c387b7fa562bd3cef
+  Currier: fed45beb4ae89757c0286a19c6ad042999f5016d
+  ParserCombinator: 40e377856046169e09acf6ed98114cf41a27a58d
 
-PODFILE CHECKSUM: 752c88f8c29aae8e024fe8d9672533814561a0b4
+PODFILE CHECKSUM: badfbff585e0968cf3cec556f0a7b7eead3701b3
 
-COCOAPODS: 1.3.1
+COCOAPODS: 1.7.5

Package.swift

@@ -10,13 +10,13 @@ PGNParser is designed to parse [Portable Game Notation](https://en.wikipedia.org
 
 Currently, only the draughts game strings have been implemented. Pull requests are welcome for further features.
 
-Parsing can be enacted by simply making a single call on the draughts move objects.
+Parsing can be enacted by simply making a single 'parse' call on the draughts move struct.
 
 A result type will be returned which will contain the resulting move array or details of any failure.
 
 A failure contains an enumeration describing the reason for the failure and usually the token which failed.
 
-The following will parse to on DraughtsMove structure containing a black and a white move.
+The following PGN string will parse to a DraughtsMove structure containing a black and a white move.
 
 ```swift
 let sinlgeMoveTwoPlayers = "1. 9-14 23-18"
@@ -35,14 +35,29 @@ case .failure(let reason):
 There are 2 external requirements for this project. Both by Tigerpixel, the same authors.
 
 [Currier](https://github.com/tigerpixel/Currier.git) - A helper for currying functions and initializers which is used with the project.
+
 [ParserCombinator](https://github.com/tigerpixel/ParserCombinator.git) - A General parser combinator which is extended to build PGNParser.
 
 - iOS 8.0+ / macOS 10.9+ / tvOS 9.0+ / watchOS 2.0+
-- Xcode 9.0+
-- Swift 4.0+
+- Xcode 11+
+- Swift 5.1+
 
 ## Installation
 
+### Swift Package Manager
+
+The [Swift Package Manager](https://swift.org/package-manager) is the official tool for managing the distribution of Swift code. It is currently available for all Apple platforms. It can also be used with Linux but this project does not fully support Linux at this point in time.
+
+If you use it to manage your dependencies, simply add PGNParser to the dependencies value of your Package.swift file.
+
+```swift
+dependencies: [
+.package(url: "https://github.com/Tigerpixel/PGNParser.git", from: "0.4.0"),
+]
+```
+
+The Swift Package Manager can resolve sub-dependencies.
+
 ### Cocoapods
 
 PGNParser is available through [CocoaPods](http://cocoapods.org). To install it, simply add the following line to your Podfile:
@@ -63,20 +78,6 @@ github "tigerpixel/ParserCombinator"
 
 If you use Carthage to build your dependencies, make sure you have added `PGNParser.framework`, `Currier.framework` and `ParserCombinator.framework`  to the "_Linked Frameworks and Libraries_" section of your target, and have included them in your Carthage framework copying build phase.
 
-### Swift Package Manager
-
-The [Swift Package Manager](https://swift.org/package-manager) is the official tool for managing the distribution of Swift code. It is currently available for macOS. It can also be used with Linux but this project does not fully support Linux at this point in time.
-
-If you use it to manage your dependencies, simply add PGNParser to the dependencies value of your Package.swift file.
-
-```swift
-dependencies: [
-.Package(url: "https://github.com/Tigerpixel/PGNParser.git", majorVersion: 0)
-]
-```
-
-The Swift Package Manager can resolve sub-dependencies.
-
 ### Git Submodule
 
 1. Add the PGNParser repository as a [submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) of your application’s repository.

Podfile.lock

@@ -8,7 +8,7 @@
 
 import ParserCombinator
 
-/// The positions on the board conform to an interger number.
+/// The positions on the board conform to an integer number.
 typealias BoardPosition = Int
 
 /**
@@ -81,7 +81,7 @@ extension DraughtsMove {
      */
     public static func parse(fromPortableGameNotation notation: String) -> ParseResult<[DraughtsMove]> {
 
-        return DraughtsNotationParser.portableGameNotation().run(withInput: notation)
+        DraughtsNotationParser.portableGameNotation().run(withInput: notation)
     }
 
 }

README.md

@@ -398,7 +398,7 @@ class DraughtsMoveTests: XCTestCase {
 
     func testNoMoves() {
 
-        switch DraughtsMove.parse(fromPortableGameNotation:"") {
+        switch DraughtsMove.parse(fromPortableGameNotation: "") {
         case .success:
             XCTFail("The parser should fail")
 

Source/DraughtsMove.swift renamed to Sources/PGNParser/DraughtsMove.swift

@@ -7,7 +7,7 @@
 set -e
 
 SWIFTLINT_PKG_PATH="/tmp/SwiftLint.pkg"
-SWIFTLINT_PKG_URL="https://github.com/realm/SwiftLint/releases/download/0.16.1/SwiftLint.pkg"
+SWIFTLINT_PKG_URL="https://github.com/realm/SwiftLint/releases/download/0.35.0/SwiftLint.pkg"
 
 wget --output-document=$SWIFTLINT_PKG_PATH $SWIFTLINT_PKG_URL
 

Source/DraughtsNotationParser.swift renamed to Sources/PGNParser/DraughtsNotationParser.swift

@@ -1,13 +1,11 @@
 
-use_frameworks!
-
 def shared_pods
     pod 'Currier'
     pod 'ParserCombinator'
 end
 
 target 'PGNParser-iOS' do
-    
+  
     platform :ios, '8.0'
     shared_pods