longbow 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0474cbb4b0559735ed51cf99fe4c88a2a6cba13
-  data.tar.gz: a93cf3a6c7280fe6aa8ed9e0a9c6e20a019919ec
+  metadata.gz: 15fa151122cbcc2370b29b534deb29ab20963d2b
+  data.tar.gz: fe61af58b2639bc7ccb43bc4ae7a6ed637bad914
 SHA512:
-  metadata.gz: cf807c8b352188c53890b3db79076e2970f1893207d14abe4a31a82f72dbc615d530682fe0bd4a5e8709baa5259b1876eca36729a380b98f8eeaae9347598afa
-  data.tar.gz: cb760751c7aea232dd3ae28870b8592d4a11af53915109ea8443a4572b26af340981e57e7519a9447c27586c17797e2e00713474e15ce484e8ef8145a07b22aa
+  metadata.gz: c12ce676cd115c74872b4830352e5813fce07c487830652fb8870333f64b81fb721893c88ac238bdf9fa032bd2ba18c8c6369d9a34ae171511a37ac30b7ea226
+  data.tar.gz: 29dad19263ce1460376258148047f71fc94fd860f72595d680f5d58ec14dbb1357feacc0b666e4f3af8cab7b855950ad3b5ed0c930b95640b23be78ecfd65c62

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    longbow (0.2.0)
+    longbow (0.4.0)
       bundler (~> 1.3)
       commander (~> 4.1)
       dotenv (~> 0.7)
@@ -17,20 +17,20 @@ GEM
       i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
     colored (1.2)
-    commander (4.1.5)
+    commander (4.2.0)
       highline (~> 1.6.11)
     dotenv (0.11.1)
       dotenv-deployment (~> 0.0.2)
     dotenv-deployment (0.0.2)
     fileutils (0.7)
       rmagick (>= 2.13.1)
-    highline (1.6.20)
+    highline (1.6.21)
     i18n (0.6.9)
     json (1.8.1)
     multi_json (1.9.3)
     rake (10.1.1)
     rmagick (2.13.2)
-    xcodeproj (0.16.1)
+    xcodeproj (0.17.0)
       activesupport (~> 3.0)
       colored (~> 1.2)
 

data/README.md

@@ -2,19 +2,22 @@
 
 **Problem**
 
-One codebase. Multiple App Store submission targets with different icons, launch images, info.plist keys, etc.
+One codebase. Multiple App Store submission targets with different icons, launch images, info.plist keys, screenshots, etc.
 
 **Solution**
 
 ```
 $ longbow install
 $ longbow shoot
+$ longbow aim
 ```
 
 **About**
 
 Longbow is a command-line run ruby gem that duplicates the main target in your `.xcworkspace` or `.xcodeproj` file, then reads from a JSON file to fill out the rest of your new target. It looks for certain keys and does things like taking an icon image and resizing it for the various icons you'll need, and adding keys to the info.plist file for that target. The goal was to be practically autonomous in creating new targets and apps.
 
+Additionally, it can create screenshots for each target app store submission. You write a simple UIAutomation script (it's just JavaScript) and Longbow takes care of taking the screenshots for each combination of target, device, and language.
+
 **Requirements**
 
 Longbow requires Xcode 5+, and your app must use the new .xcassets paradigm for icons, launch screens, etc.
@@ -43,7 +46,7 @@ Run `longbow install` in the directory where your `.xcworkspace` or `.xcodeproj`
 
 Here's a basic gist of how to format your `longbow.json` file:
 
-```
+```json
 {
 	"targets":[
 		{
@@ -115,6 +118,17 @@ If you leave off the `-n` option, it will run for all targets in the `longbow.js
 
 `--help` will fill you in on what you need to do for an action.
 
+## Taking Screenshots
+
+So you've created all your targets and finished the first version of the app - now you need the screen shots to submit it to the App Store.
+
+First you'll need to write a single UIAutomation script to take the screenshots. You can see [Apple's Documentation](https://developer.apple.com/library/ios/documentation/DeveloperTools/Reference/UIAutomationRef/_index.html) for more information on writing the script. The part we're primarily concerned with is the captureLocalizedScreenshot() method provided by Longbow. This method will take the screenshot with a consistent naming scheme and place it in a folder for each target.
+
+`captureLocalizedScreenshot("homeScreen");` will create ~/Desktop/screenshots/TargetName/en-US/iOS-4-in\_\_\_portrait\_\_\_homeScreen.png
+
+Once you've created your automation script, you can run it by calling `longbow aim`. This command will generate a variation of your UIAutomation script for each target, then handle running it for each target. Grab a drink, depending on your script and your number of targets, this may take a while.
+
+
 ## The Future
 
 * Unit Tests

data/lib/longbow/commands/aim.rb

@@ -0,0 +1,70 @@
+require 'fileutils'
+require 'longbow/colors'
+require 'longbow/targets'
+require 'longbow/images'
+require 'longbow/json'
+require 'json'
+
+command :aim do |c|
+  c.syntax = 'longbow aim'
+  c.syntax = 'Takes screenshots for each target in your workspace or project based on a UIAutomation script.'
+  c.description = ''
+  c.option '-s', '--script SCRIPT', 'Script used to get the app into the proper state for each screenshot'
+  c.option '-d', '--directory DIRECTORY', 'Path where the .xcodeproj or .xcworkspace file && the longbow.json file live.'
+  c.option '-u', '--url URL', 'URL of a longbow formatted JSON file.'
+  c.option '-n', '--name NAME', 'Name of the target to get a screenshot for.'
+
+  c.action do |args, options|
+    # Check for newer version
+    Longbow::check_for_newer_version unless $nolog
+
+    # Set Up
+    @script = options.script ? options.script : nil
+    @directory = options.directory ? options.directory : Dir.pwd
+    @url = options.url ? options.url : nil
+    @target_name = options.name
+    @targets = []
+
+    # Create JSON object
+    if @url
+      obj = Longbow::json_object_from_url @url
+    else
+      obj = Longbow::json_object_from_directory @directory
+    end
+
+    # Break if Bad
+    unless obj || Longbow::lint_json_object(obj)
+      Longbow::red "\n Invalid JSON. Please lint the file, and try again.\n"
+      next
+    end
+
+    # Check for Target Name
+    if @target_name
+      obj['targets'].each do |t|
+        @targets << t if t['name'] == @target_name
+      end
+
+      if @targets.length == 0
+        Longbow::red "\n  Couldn't find a target named #{@target_name} in the longbow.json file.\n"
+        next
+      end
+    else
+      @targets = obj['targets']
+    end
+
+    resources_path = File.dirname(__FILE__) + '/../../../resources'
+
+    FileUtils.cp "#{resources_path}/capture.js", "capture.js"
+
+    @targets.each do |t|
+      Longbow::blue "  Running screenshooter for #{t['name']}"
+      begin
+        `#{resources_path}/ui-screen-shooter.sh ~/Desktop/screenshots/#{t['name']} #{t['name']} #{@script}`
+      rescue
+        Longbow::red "Failed while running screenshooter for #{t['name']}"
+      end
+    end
+
+    FileUtils.rm "capture.js"
+  end
+end

data/lib/longbow/commands.rb

@@ -1,4 +1,5 @@
 $:.push File.expand_path('../', __FILE__)
 
 require 'commands/shoot'
-require 'commands/install'
+require 'commands/install'
+require 'commands/aim'

data/lib/longbow/version.rb

@@ -2,7 +2,7 @@ $:.push File.expand_path('../', __FILE__)
 require 'colors'
 
 module Longbow
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 
   def self.check_for_newer_version
     unless Gem.latest_version_for('longbow').to_s == VERSION

data/resources/capture.js

@@ -0,0 +1,57 @@
+// Copyright (c) 2012 Jonathan Penn (http://cocoamanifest.net/)
+
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+// captureLocalizedScreenshot(name)
+//
+// Tells the local target to take a screen shot and names the file after the
+// state of the simulator like so:
+//
+//   [model]___[orientation]___[name].png
+//
+// `model` is the model of the device (iphone, iphone5, ipad)
+// `orientation` is...well...duh!
+// `name` is what you passed in to the function
+//
+// Screenshots are saved along with the trace results in UI Automation. See
+// `run_screenshooter.sh` for examples on how to pull those images out and put
+// them wherever you want.
+//
+function captureLocalizedScreenshot(name) {
+  var target = UIATarget.localTarget();
+  var model = target.model();
+  var rect = target.rect();
+
+  var orientation = "portrait";
+  if (rect.size.height < rect.size.width) orientation = "landscape";
+
+  if (model.match(/iPhone/)) {
+    if ((orientation == "portrait" && rect.size.height > 480) || (orientation == "landscape" && rect.size.width > 480)) {
+      model = "iOS-4-in";
+    } else {
+      model = "iOS-3.5-in";
+    }
+  } else {
+    model = "iOS-iPad";
+  }
+
+  var parts = [model, orientation, name];
+  target.captureScreenWithName(parts.join("___"));
+}
+

data/resources/ui-screen-shooter.sh

@@ -0,0 +1,211 @@
+#!/bin/bash
+# Copyright (c) 2012 Jonathan Penn (http://cocoamanifest.net/)
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+
+# Tell bash that we want the whole script to fail if any part fails.
+set -e
+
+# We require a parameter for where to put the results and the test script
+destination="$1"
+scheme_name="$2"
+ui_script="$3"
+
+# The locale identifiers for the languages you want to shoot
+# Use the format like en-US zh-Hans for filenames compatible with iTunes
+# connect upload tool
+# FYI: get the locale names for you existing app with iTMSTransporter and: 
+# grep locale ~/Desktop/*.itmsp/metadata.xml  | grep name | sort -u
+languages="en-US"
+
+# The simulators we want to run the script against, declared as a Bash array.
+# Run `instruments -w help` to get a list of all the possible string values.
+#declare -a simulators=(
+#"iPhone Retina (3.5-inch) - Simulator - iOS 7.1"
+#"iPhone Retina (4-inch) - Simulator - iOS 7.1"
+#"iPad Retina - Simulator - iOS 7.1"
+#)
+declare -a simulators=(
+"iPhone Retina (3.5-inch) - Simulator - iOS 7.1"
+"iPhone Retina (4-inch) - Simulator - iOS 7.1"
+)
+
+function main {
+  _check_destination
+  _check_ui_script
+  _check_scheme_name
+  _xcode clean build
+  _reset_sim
+
+  for simulator in "${simulators[@]}"; do
+    for language in $languages; do
+      _clean_trace_results_dir
+      _run_automation "$ui_script" "$language" "$simulator"
+      _copy_screenshots "$language"
+    done
+  done
+
+  _close_sim
+
+  echo
+  echo "Screenshots complete!"
+}
+
+# Global variables to keep track of where everything goes
+tmp_dir="/tmp"
+build_dir="$tmp_dir/screen_shooter"
+bundle_dir="$build_dir/app.app"
+trace_results_dir="$build_dir/traces"
+
+function _check_destination {
+  # Abort if the destination directory already exists. Better safe than sorry.
+
+  if [ -z "$destination" ]; then
+    destination="$HOME/Desktop/screenshots"
+  fi
+  if [ -d "$destination" ]; then
+    echo "Destination directory \"$destination\" already exists! Moving Directory."
+    mv "$destination" "$HOME/Desktop/screenshots$(date +"%Y%m%d%H%M")"
+  fi
+}
+
+function _check_ui_script {
+  # Abort if the UI script does not exist.
+
+  if [ -z "$ui_script" ]; then
+    ui_script="./shoot_the_screens.js"
+  fi
+  if [ ! -f "$ui_script" ]; then
+    echo "UI script \"$ui_script\" does not exist! Aborting."
+    exit 1
+  fi
+}
+
+function _check_scheme_name {
+  if [ -z "$scheme_name" ]; then
+    scheme_name=$(basename *.xcworkspace .xcworkspace)
+    echo "No scheme name specified, using the default."
+  fi
+}
+
+function _xcode {
+  # A wrapper around `xcodebuild` that tells it to build the app in the temp
+  # directory. If your app uses workspaces or special schemes, you'll need to
+  # specify them here.
+  #
+  # Use `man xcodebuild` for more information on how to build your project.
+  if test -n "$(find . -maxdepth 1 -name '*.xcworkspace' -print -quit)"
+  then
+    base=$(basename *.xcworkspace .xcworkspace)
+    # First build omits PRODUCT_NAME
+    # Do NOT ask me why you need to build this twice for it to work
+    # or how I became to know this fact
+    xcodebuild -sdk "iphonesimulator$ios_version" \
+      CONFIGURATION_BUILD_DIR="$build_dir/build" \
+      -workspace $base.xcworkspace -scheme $scheme_name -configuration AdHoc \
+      DSTROOT=$build_dir \
+      OBJROOT=$build_dir \
+      SYMROOT=$build_dir \
+      ONLY_ACTIVE_ARCH=NO \
+    "$@"
+    xcodebuild -sdk "iphonesimulator$ios_version" \
+      CONFIGURATION_BUILD_DIR="$build_dir/build" \
+      PRODUCT_NAME=app \
+      -workspace $base.xcworkspace -scheme $scheme_name -configuration AdHoc \
+      DSTROOT=$build_dir \
+      OBJROOT=$build_dir \
+      SYMROOT=$build_dir \
+      ONLY_ACTIVE_ARCH=NO \
+    "$@"
+    cp -r "$build_dir/build/app.app" "$build_dir"
+  else
+    xcodebuild -sdk "iphonesimulator$ios_version" \
+      CONFIGURATION_BUILD_DIR=$build_dir \
+      PRODUCT_NAME=app \
+    "$@"
+  fi
+}
+
+function _clean_trace_results_dir {
+  # Removes the trace results directory. We need to do this because Instruments
+  # keeps appending new trace runs and it's simpler for us to always assume
+  # there's just one run recorded where we look for screenshots.
+
+  rm -rf "$trace_results_dir"
+  mkdir -p "$trace_results_dir"
+}
+
+function _run_automation {
+  # Runs the UI Automation JavaScript file that actually takes the screenshots.
+
+  automation_script="$1"
+  language="$2"
+  simulator="$3"
+
+  echo "Running automation script \"$automation_script\"
+          for \"$simulator\"
+          in language \"${language}\"..."
+
+  dev_tools_dir=`xcode-select -print-path`
+  tracetemplate="$dev_tools_dir/../Applications/Instruments.app/Contents/PlugIns/AutomationInstrument.bundle/Contents/Resources/Automation.tracetemplate"
+
+  # Check out the `unix_instruments.sh` script to see why we need this wrapper.
+  DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+  "$DIR"/unix_instruments.sh \
+    -w "$simulator" \
+    -D "$trace_results_dir/trace" \
+    -t "$tracetemplate" \
+    $bundle_dir \
+    -e UIARESULTSPATH "$trace_results_dir" \
+    -e UIASCRIPT "$automation_script" \
+    -AppleLanguages "($language)" \
+    -AppleLocale "$language" \
+    "$@"
+
+  find $trace_results_dir/Run\ 1/ -name *landscape*png -type f -exec sips -r -90 \{\} \;
+}
+
+function _copy_screenshots {
+  # Since we're always clearing out the trace results before every run, we can
+  # assume that any screenshots were saved in the "Run 1" directory. Copy them
+  # to the destination's language folder!
+
+  language="$1"
+
+  mkdir -p "$destination/$language"
+  cp $trace_results_dir/Run\ 1/*.png "$destination/$language"
+}
+
+function _reset_sim {
+  count=`ps aux | grep [l]aunchd_sim | wc -l`
+  if [ $count -ne 0 ]
+  then
+    kill -9 $(ps -ef | grep [l]aunchd_sim | awk {'print $2'})
+  fi
+}
+
+function _close_sim {
+  # I know, I know. It says "iPhone Simulator". For some reason,
+  # that's the only way Applescript can identify it.
+  osascript -e "tell application \"iPhone Simulator\" to quit"
+}
+
+main
+

data/resources/unix_instruments.sh

@@ -0,0 +1,67 @@
+#!/usr/bin/env bash
+#
+# Copyright (c) 2013 Jonathan Penn (http://cocoamanifest.net)
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+
+# unix_instruments
+#
+# A wrapper around `instruments` that returns a proper unix status code
+# depending on whether the run failed or not. Alas, Apple's instruments tool
+# doesn't care about unix status codes, so I must grep for the "Fail:" string
+# and figure it out myself. As long as the command doesn't output that string
+# anywhere else inside it, then it should work.
+#
+# I use a tee pipe to capture the output and deliver it to stdout
+#
+# Author: Jonathan Penn (jonathan@cocoamanifest.net)
+#
+
+set -e  # Bomb on any script errors
+
+run_instruments() {
+  # Pipe to `tee` using a temporary file so everything is sent to standard out
+  # and we have the output to check for errors.
+  output=$(mktemp -t unix-instruments)
+  instruments "$@" 2>&1 | tee $output
+
+  # Process the instruments output looking for anything that resembles a fail
+  # message
+  cat $output | get_error_status
+}
+
+get_error_status() {
+  # Catch "Instruments Trace Error"
+  # Catch "Instruments Usage Error"
+  # Catch "00-00-00 00:00:00 +000 Fail:"
+  # Catch "00-00-00 00:00:00 +000 Error:"
+  # Catch "00-00-00 00:00:00 +000 None: Script threw an uncaught JavaScript error"
+  ruby -e 'exit 1 if STDIN.read =~ /Instruments Usage Error|Instruments Trace Error|^\d+-\d+-\d+ \d+:\d+:\d+ [-+]\d+ (Fail:|Error:|None: Script threw an uncaught JavaScript error)/'
+}
+
+# Running this file with "----test" will try to parse an error out of whatever
+# is handed in to it from stdin. Use this method to double check your work if
+# you need a custom "get_error_status" function above.
+if [[ $1 == "----test" ]]; then
+  get_error_status
+else
+  run_instruments "$@"
+fi

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: longbow
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Intermark Interactive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-13 00:00:00.000000000 Z
+date: 2014-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -134,6 +134,7 @@ files:
 - ./Gemfile
 - ./Gemfile.lock
 - ./lib/longbow/colors.rb
+- ./lib/longbow/commands/aim.rb
 - ./lib/longbow/commands/install.rb
 - ./lib/longbow/commands/shoot.rb
 - ./lib/longbow/commands.rb
@@ -148,6 +149,9 @@ files:
 - ./Rakefile
 - ./README.md
 - ./resources/banner.png
+- ./resources/capture.js
+- ./resources/ui-screen-shooter.sh
+- ./resources/unix_instruments.sh
 - bin/longbow
 homepage: https://github.com/intermark/longbow
 licenses: