Move Fastlane to Project Root

.circleci/config.yml

@@ -66,7 +66,7 @@ jobs:
           command: rake dependencies
       - run:
           name: Build for Testing
-          command: cd ./Scripts && bundle exec fastlane build_for_testing device:'<< parameters.device >>' ios-version:'<< parameters.ios-version >>'
+          command: bundle exec fastlane build_for_testing device:'<< parameters.device >>' ios-version:'<< parameters.ios-version >>'
       - persist_to_workspace:
           root: ./
           paths:
@@ -94,7 +94,6 @@ jobs:
           command: bundle --path vendor/bundle
       - run:
           name: Run Unit Tests
-          working_directory: Scripts
           command: bundle exec fastlane test_without_building name:WordPressUnitTests try_count:3 device:'<< parameters.device >>' ios-version:'<< parameters.ios-version >>'
       - ios/save-xcodebuild-artifacts:
           result-bundle-path: build/results
@@ -127,7 +126,6 @@ jobs:
           background: true
       - run:
           name: Run UI Tests
-          working_directory: Scripts
           command: bundle exec fastlane test_without_building name:WordPressUITests try_count:3 device:'<< parameters.device >>' ios-version:'<< parameters.ios-version >>'
       - ios/save-xcodebuild-artifacts:
           result-bundle-path: build/results
@@ -161,13 +159,12 @@ jobs:
           command: bundle exec fastlane run configure_apply
       - run:
           name: Build
-          working_directory: Scripts
           command: "bundle exec fastlane build_and_upload_installable_build build_number:$CIRCLE_BUILD_NUM"
       - run:
           name: Prepare Artifacts
           command: |
             mkdir -p Artifacts
-            mv "Scripts/fastlane/comment.json" "Artifacts/comment.json"
+            mv "fastlane/comment.json" "Artifacts/comment.json"
       - store_artifacts:
           path: Artifacts
           destination: Artifacts
@@ -199,7 +196,6 @@ jobs:
             curl -sL https://sentry.io/get-cli/ | bash
       - run:
           name: Build
-          working_directory: Scripts
           command: |
             APP_VERSION=$(cat ../config/Version.Public.xcconfig | grep "^VERSION_LONG" | cut -d "=" -f2)
             echo "export SLACK_FAILURE_MESSAGE=':red_circle: Build for WordPress iOS $APP_VERSION failed!'" >> $BASH_ENV
@@ -232,28 +228,20 @@ jobs:
       - run: 
           name: Install other tools
           command: |
-            brew unlink python@2
             brew install imagemagick
             brew install ghostscript
             curl -sL https://sentry.io/get-cli/ | bash
       - run:
           name: Build
-          working_directory: Scripts
           command: | 
-            orig_version=`cat ../config/Version.internal.xcconfig | grep VERSION_SHORT | cut -d'=' -f2`
-            sed -i '' "$(awk '/^VERSION_SHORT/{ print NR; exit }' "../config/Version.internal.xcconfig")s/=.*/="${orig_version}"-`date +"%Y%d%m"`-"${CIRCLE_BUILD_NUM}"/" "../config/Version.internal.xcconfig"
-            bundle exec fastlane build_for_translation_review
+            orig_version=`cat config/Version.internal.xcconfig | grep VERSION_SHORT | cut -d'=' -f2`
+            sed -i '' "$(awk '/^VERSION_SHORT/{ print NR; exit }' "config/Version.internal.xcconfig")s/=.*/="${orig_version}"-`date +"%Y%d%m"`-"${CIRCLE_BUILD_NUM}"/" "config/Version.internal.xcconfig"
 
             VERSION_NAME="all-lang-build-${CIRCLE_BUILD_NUM}"
             echo "export VERSION_NAME=$VERSION_NAME" >> $BASH_ENV
 
-            mkdir -p ../Artifacts
-            mv /var/tmp/Debug-iphonesimulator/WordPress.zip "../Artifacts/WordPress-${VERSION_NAME}.zip"
+            bundle exec fastlane build_for_translation_review version_name:$VERSION_NAME
           no_output_timeout: 60m
-      - run: 
-          name: Upload APP
-          command: |
-            curl --http1.1 https://${APPET_TOKEN}@api.appetize.io/v1/apps/${APPET_APPID} -F "file=@Artifacts/WordPress-${VERSION_NAME}.zip" -F "platform=ios"
       - store_artifacts:
           path: Artifacts
           destination: Artifacts

.gitignore

@@ -63,27 +63,29 @@ WordPress/Derived Sources/
 WordPress/Images.xcassets/AppIcon-Internal.appiconset
 
 # Bundler
-/vendor/bundle/
-.bundle/
+.bundle
 
 # Dependencies
-/vendor/
+vendor
 
 # Fastlane
-Scripts/fastlane/Preview.html
-Scripts/fastlane/report.xml
-Scripts/fastlane/README.md
-Scripts/Preview.html
-Scripts/fastlane/test_output/
-Scripts/fastlane/google_cloud_keys.json
-Scripts/fastlane/promo_screenshots
-/Scripts/fastlane/metadata/review_information
-/Scripts/default.profraw
+fastlane/Preview.html
+fastlane/report.xml
+fastlane/README.md
+Preview.html
+fastlane/test_output/
+fastlane/google_cloud_keys.json
+fastlane/promo_screenshots
+fastlane/metadata/review_information
+default.profraw
 derived-data/
 
+# CI Artifacts Location
+Artifacts
+
 # Generated Internal Icons
-/WordPress/Resources/AppImages.xcassets/AppIcon-Internal.appiconset
-/WordPress/Resources/Icons-Internal
+WordPress/Resources/AppImages.xcassets/AppIcon-Internal.appiconset
+WordPress/Resources/Icons-Internal
 
 # All secrets should be stored under .configure-files
 # Everything without a .enc extension is ignored

Gemfile

@@ -8,5 +8,5 @@ source 'https://rubygems.org' do
   gem 'commonmarker'
 end
 
-plugins_path = File.join(File.dirname(__FILE__), 'Scripts/fastlane', 'Pluginfile')
+plugins_path = File.join(File.dirname(__FILE__), 'fastlane', 'Pluginfile')
 eval_gemfile(plugins_path) if File.exist?(plugins_path)

Gemfile.lock

@@ -158,8 +158,8 @@ GEM
       xcpretty (~> 0.3.0)
       xcpretty-travis-formatter (>= 0.0.3)
     fastlane-plugin-appcenter (1.11.0)
-    fastlane-plugin-sentry (1.7.0)
-    fastlane-plugin-test_center (3.14.8)
+    fastlane-plugin-sentry (1.8.0)
+    fastlane-plugin-test_center (3.15.2)
       colorize
       json
       plist
@@ -230,7 +230,7 @@ GEM
     octokit (4.19.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
-    oj (3.10.18)
+    oj (3.11.1)
     optimist (3.0.1)
     options (2.3.2)
     os (1.1.1)

Scripts/extract-framework-translations.swift

@@ -3,25 +3,33 @@
 import Foundation
 
 let fileManager = FileManager.default
-let cwd = fileManager.currentDirectoryPath
-let script = CommandLine.arguments[0]
 
-let base = cwd
-let projectDir = base.appending("/WordPress")
-let resources = projectDir.appending("/Resources")
+let projectRoot = findProjectRoot()
+let projectDir = projectRoot.appendingPathComponent("WordPress")
+let resources = projectDir.appendingPathComponent("Resources")
 let frameworkRoots = [
     "WordPressTodayWidget",
     "WordPressShareExtension"
-    ].map({ projectDir.appending("/\($0)") })
+].map({ projectDir.appendingPathComponent($0).path })
 
-guard fileManager.fileExists(atPath: projectDir) else {
+guard fileManager.fileExists(atPath: projectDir.path) else {
     print("Must run script from project root folder")
     exit(1)
 }
 
+/// Crawl our way up the project tree until we find the root
+func findProjectRoot() -> URL {
+    var candidate = URL(fileURLWithPath: fileManager.currentDirectoryPath)
+
+    while !fileManager.fileExists(atPath: candidate.appendingPathComponent(".git").path) && candidate.path != "/" {
+        candidate.deleteLastPathComponent()
+    }
+
+    return candidate
+}
 
 func projectLanguages() -> [String] {
-    return (try? fileManager.contentsOfDirectory(atPath: resources)
+    return (try? fileManager.contentsOfDirectory(atPath: resources.path)
         .filter({ $0.hasSuffix(".lproj") })
         .map({ $0.replacingOccurrences(of: ".lproj", with: "") })
         .filter({ $0 != "en" })
@@ -45,7 +53,7 @@ func sourceStrings(framework: String) -> [String: String] {
 }
 
 func readProjectTranslations(for language: String) -> [String: String] {
-    let path = resources.appending("/\(language).lproj/Localizable.strings")
+    let path = resources.appendingPathComponent("\(language).lproj/Localizable.strings").path
     return readStrings(path: path)
 }
 

Scripts/update-translations.rb

@@ -1,6 +1,8 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
 
+require 'fileutils'
+
 # Supported languages:
 # ar,ca,cs,cy,da,de,el,en,en-CA,en-GB,es,fi,fr,he,hr,hu,id,it,ja,ko,ms,nb,nl,pl,pt,pt-PT,ro,ru,sk,sv,th,tr,uk,vi,zh-Hans,zh-Hant
 # * Arabic
@@ -40,11 +42,6 @@
 # * Chinese (Taiwan) [zh-Hant]
 # * Welsh
 
-if Dir.pwd =~ /Scripts/
-  puts "Must run script from root folder"
-  exit
-end
-
 ALL_LANGS={
   'ar' => 'ar',         # Arabic
   'bg' => 'bg',         # Bulgarian
@@ -124,27 +121,48 @@
   langs = ALL_LANGS
 end
 
-langs.each do |code,local|
-  lang_dir = File.join('WordPress', 'Resources', "#{local}.lproj")
-  puts "Updating #{code}"
-  system "mkdir -p #{lang_dir}"
+script_root = __dir__
+project_dir = File.dirname(script_root)
 
-  # Download for production
-  system "if [ -e #{lang_dir}/Localizable#{strings_file_ext}.strings ]; then cp #{lang_dir}/Localizable#{strings_file_ext}.strings #{lang_dir}/Localizable#{strings_file_ext}.strings.bak; fi"
+langs.each do |code,local|
+  lang_dir = File.join(project_dir, 'WordPress', 'Resources', "#{local}.lproj")
+  puts "Updating #{code} in #{lang_dir}"
+  system "mkdir", "-p", lang_dir
 
-  url = "#{download_url}/#{code}/default/export-translations?#{strings_filter}format=strings"
   destination = "#{lang_dir}/Localizable#{strings_file_ext}.strings"
+  backup_destination = "#{destination}.bak"
 
-  system "curl -fLso #{destination} \"#{url}\"" or begin
-    puts "Error downloading #{code}"
+  # Step 2 – Download the new strings
+  if File.exist? destination
+    FileUtils.copy destination, backup_destination
   end
 
-  if File.size(destination).to_f == 0
-    abort("\e[31mFatal Error: #{destination} appears to be empty. Exiting.\e[0m")
+  url = "#{download_url}/#{code}/default/export-translations?#{strings_filter}format=strings"
+
+  system("curl", "-fgsLo", destination, url) or raise "Error downloading #{url}"
+
+  # Step 3 – Validate the new file
+  if !File.exist?(destination) or File.size(destination).to_f == 0
+    puts "\e[31mFatal Error: #{destination} appears to be empty. Exiting.\e[0m"
+    abort()
   end
 
-  system "./Scripts/fix-translation #{lang_dir}/Localizable#{strings_file_ext}.strings"
-  system "plutil -lint #{lang_dir}/Localizable#{strings_file_ext}.strings" and system "rm #{lang_dir}/Localizable#{strings_file_ext}.strings.bak"
-  system "grep -a '\\x00\\x20\\x00\\x22\\x00\\x22\\x00\\x3b$' #{lang_dir}/Localizable#{strings_file_ext}.strings"
+  fix_script_path = File.join(script_root, 'fix-translation')
+
+  # References a file like: "#{lang_dir}.Localizable-old.strings" where strings_file_ext == "old"
+  strings_file_path = File.join(lang_dir, "Localizable#{strings_file_ext}.strings")
+
+  system fix_script_path, strings_file_path
+  system "plutil", "-lint", strings_file_path
+  # The fix-translations script is supposed to have replaced all strings with empty translations, to use the key (aka English copy)
+  # as the translation instead, as a fallback. So after that pass we should not have any more empty translations left,
+  # but just as a control, let's grep for lines ending with the UTF-16 sequence ` "";` to ensure there's none left.
+  system "grep", "-a", "\\x00\\x20\\x00\\x22\\x00\\x22\\x00\\x3b$", strings_file_path
+
+  # Clean up after ourselves
+  FileUtils.rm_f backup_destination
 end
-system "Scripts/extract-framework-translations.swift" if strings_filter.empty? 
+
+extract_framework_translations_script_path = File.join(script_root, 'extract-framework-translations.swift')
+
+system extract_framework_translations_script_path if strings_filter.empty?