Merge pull request #6 from polydice/feature/build-scripts

Simpler Project Setup

Author: bcylin

.gitignore

@@ -38,4 +38,3 @@ Carthage/
 ## Production
 icook-tv-top-shelf-image.png
 keys/
-fabric.*

.swiftlint.yml

@@ -2,6 +2,7 @@ disabled_rules:
   - force_try
   - line_length
   - nesting
+  - vertical_whitespace
 type_name:
   excluded:
     - iCookTVKeys

.travis.yml

@@ -1,5 +1,5 @@
 language: objective-c
-osx_image: xcode8
+osx_image: xcode8.1
 cache:
   bundler: true
   directories:

CHANGELOG.md

@@ -4,11 +4,13 @@
 
 #### Added
 
-* A demo API URL
 * Type safe resources generated by R.swift
-* Syntax check with SwiftLint
+* Syntax check with SwiftLint [#3](https://github.com/polydice/iCook-tvOS/pull/3)
 * Code coverage
-* A little help from [DangerCI](http://danger.systems/) in Pull Request [#4](https://github.com/polydice/iCook-tvOS/pull/4)
+* A little help from [Danger](http://danger.systems/) [#4](https://github.com/polydice/iCook-tvOS/pull/4)
+* Protocol extended features
+* Swift 3 syntax updates [#5](https://github.com/polydice/iCook-tvOS/pull/5)
+* Simpler project quick start [#6](https://github.com/polydice/iCook-tvOS/pull/6)
 
 ## v1.0.0
 

Makefile

@@ -1,6 +1,15 @@
-pod-install:
-	bundle exec pod install --no-repo-update
-	xcproj touch iCookTV.xcodeproj
+bootstrap:
+	brew tap homebrew/bundle
+	brew bundle
+	bundle install
+	# pod install
+	bundle exec pod keys set BaseAPIURL "https://polydice.com/iCook-tvOS/demo/"
+	bundle exec pod keys set CrashlyticsAPIKey "-"
+	bundle exec pod keys set TreasureDataAPIKey "-"
+	bundle exec pod install
+	# sh scripts/fabric.sh
+	echo "fabric.apikey" > keys/fabric.apikey
+	echo "fabric.buildsecret" > keys/fabric.buildsecret
 
 coverage:
 	bundle exec slather coverage -s --input-format profdata --scheme iCookTV --workspace iCookTV.xcworkspace iCookTV.xcodeproj

README.md

@@ -10,18 +10,33 @@ A tvOS app that plays [iCook TV](https://tv.icook.tw/) videos.
 
 ## Setup
 
-Install required dependencies using [Homebrew](http://brew.sh/) and [Bundler](http://bundler.io/):
+Install [Homebrew](http://brew.sh/) and [Bundler](http://bundler.io/):
 
 ```
-brew tap homebrew/bundle
-brew bundle
+/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+gem install bundler
 ```
+
+### Quick Start
+
+Run the following commands to install dependencies:
+
+```
+make bootstrap
+```
+
+### Production Setups
+
+If you work at Polydice, instead of `make bootstrap`, set up the project step by step with the following commands. Fill in the credentials and ask admin for required files.
+
 ```
+brew tap homebrew/bundle
+brew bundle
 bundle install
 bundle exec pod install
 ```
 
-### API
+#### API
 
 `pod install` will prompt for the required configuration to run the app:
 
@@ -31,37 +46,34 @@ What is the key for BaseAPIURL
 >
 ```
 
-Input `https://polydice.com/iCook-tvOS/demo/` for `BaseAPIURL`.
-
 > TBD: API details are hidden for now due to proprietary reasons.
 
-### Required Keys
+#### Required Keys
+
+Managed by CocoaPods-Keys:
 
 * CrashlyticsAPIKey
 * TreasureDataAPIKey
 
-Managed by CocoaPods-Keys, they can be real API keys or any arbitrary strings.
-
-### Required Files
-
-```
-./keys/fabric.apikey
-./keys/fabric.buildsecret
-```
+#### Required Files
 
-Required by the Fabric script for the `Release` configuration.
+* Required by the Fabric script for the `Release` configuration:
 
-### Ignored
+  ```
+  ./keys/fabric.apikey
+  ./keys/fabric.buildsecret
+  ```
 
 * `icook-tv-top-shelf-image.png` is not included in the repo due to the license of image.
 
-### Known Issues
+## Known Issues
 
 * Initializing generic `DataSource` will cause `EXC_BAD_ACCESS` in Xcode 8. Fixed in Xcode 8.1.
 
 ## Demo
 
-Install the beta version via <https://testflight.icook.tw>.
+* Install the beta version via <https://testflight.icook.tw>.
+* Download the tvOS app from [App Store](https://itunes.apple.com/tw/app/ai-liao-li/id554065086).
 
 ## Contact
 

iCookTV.xcodeproj/project.pbxproj

@@ -547,7 +547,7 @@
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 			shellPath = /bin/sh;
-			shellScript = "sh ${SRCROOT}/scripts/set-up-fabric.sh";
+			shellScript = "sh ${SRCROOT}/scripts/fabric.sh";
 		};
 		B52DFA9C1CF8006E005B9D67 /* Run Swiftlint */ = {
 			isa = PBXShellScriptBuildPhase;
@@ -561,7 +561,7 @@
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 			shellPath = /bin/sh;
-			shellScript = "if which swiftlint >/dev/null; then swiftlint; fi";
+			shellScript = "sh ${SRCROOT}/scripts/swiftlint.sh";
 		};
 		B5BA3B4A1CF6D19800B0A022 /* Run R.swift Script */ = {
 			isa = PBXShellScriptBuildPhase;
@@ -575,7 +575,7 @@
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 			shellPath = /bin/sh;
-			shellScript = "${PODS_ROOT}/R.swift/rswift ${SRCROOT}/iCookTV";
+			shellScript = "sh ${SRCROOT}/scripts/rswift.sh";
 		};
 		D98BF45783F7971E01068E78 /* [CP] Embed Pods Frameworks */ = {
 			isa = PBXShellScriptBuildPhase;
@@ -797,7 +797,7 @@
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
 				MTL_ENABLE_DEBUG_INFO = NO;
-				OTHER_SWIFT_FLAGS = "";
+				OTHER_SWIFT_FLAGS = "-D TRACKING";
 				SDKROOT = appletvos;
 				SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule";
 				SWIFT_VERSION = 3.0;

iCookTV/AppDelegate.swift

@@ -25,8 +25,6 @@
 //
 
 import UIKit
-import Crashlytics
-import Fabric
 import TreasureData_tvOS_SDK
 
 @UIApplicationMain
@@ -40,7 +38,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
 
   func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
     GroundControl.sync()
-    setUpAnalytics()
+    Tracker.setUpAnalytics()
 
     window = UIWindow(frame: UIScreen.main.bounds)
     window?.rootViewController = TrackableNavigationController(rootViewController: LaunchViewController())
@@ -50,17 +48,19 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
   }
 
   func applicationDidEnterBackground(_ application: UIApplication) {
-    TreasureData.sharedInstance().endSession(Tracker.sessionsTable)
-
-    backgroundTask = application.beginBackgroundTask (expirationHandler: { [weak self] in
-      self?.endBackgroundTask(inApplication: application)
-    })
-
-    TreasureData.sharedInstance().uploadEvents(callback: { [weak self] in
-      self?.endBackgroundTask(inApplication: application)
-    }) { [weak self] _ in
-      self?.endBackgroundTask(inApplication: application)
-    }
+    #if TRACKING
+      TreasureData.sharedInstance().endSession(Tracker.sessionsTable)
+
+      backgroundTask = application.beginBackgroundTask (expirationHandler: { [weak self] in
+        self?.endBackgroundTask(inApplication: application)
+      })
+
+      TreasureData.sharedInstance().uploadEvents(callback: { [weak self] in
+        self?.endBackgroundTask(inApplication: application)
+      }) { [weak self] _ in
+        self?.endBackgroundTask(inApplication: application)
+      }
+    #endif
   }
 
   // MARK: - Private Methods
@@ -70,19 +70,4 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
     backgroundTask = UIBackgroundTaskInvalid
   }
 
-  private func setUpAnalytics() {
-    Crashlytics.start(withAPIKey: iCookTVKeys.CrashlyticsAPIKey)
-    Fabric.with([Crashlytics.self])
-
-    TreasureData.initializeApiEndpoint("https://in.treasuredata.com")
-    TreasureData.initialize(withApiKey: iCookTVKeys.TreasureDataAPIKey)
-    TreasureData.sharedInstance().enableAutoAppendUniqId()
-    TreasureData.sharedInstance().enableAutoAppendModelInformation()
-    TreasureData.sharedInstance().enableAutoAppendAppInformation()
-    TreasureData.sharedInstance().enableAutoAppendLocaleInformation()
-
-    TreasureData.sharedInstance().defaultDatabase = Tracker.defaultDatabase
-    TreasureData.sharedInstance().startSession(Tracker.sessionsTable)
-  }
-
 }

iCookTV/Assets.xcassets/App Icon & Top Shelf Image.brandassets/Contents.json

@@ -12,6 +12,12 @@
       "filename" : "App Icon - Small.imagestack",
       "role" : "primary-app-icon"
     },
+    {
+      "size" : "2320x720",
+      "idiom" : "tv",
+      "filename" : "Top Shelf Image Wide.imageset",
+      "role" : "top-shelf-image-wide"
+    },
     {
       "size" : "1920x720",
       "idiom" : "tv",
@@ -23,4 +29,4 @@
     "version" : 1,
     "author" : "xcode"
   }
-}
+}

iCookTV/Assets.xcassets/App Icon & Top Shelf Image.brandassets/Top Shelf Image Wide.imageset/Contents.json

@@ -0,0 +1,12 @@
+{
+  "images" : [
+    {
+      "idiom" : "tv",
+      "scale" : "1x"
+    }
+  ],
+  "info" : {
+    "version" : 1,
+    "author" : "xcode"
+  }
+}