longbow-fdv 0.1.0

data/lib/longbow/targets.rb

@@ -0,0 +1,121 @@
+require 'xcodeproj'
+require 'colors'
+require 'plist'
+require 'utilities'
+
+module Longbow
+
+  def self.update_target directory, target, global_keys, info_keys, icon, launch
+    unless directory && target
+      Longbow::red '  Invalid parameters. Could not create/update target named: ' + target
+      return false
+    end
+
+    # Find Project File
+    project_paths = []
+    Dir.foreach(directory) do |fname|
+      project_paths << fname if fname.include? '.xcodeproj'
+    end
+
+    # Open The Project
+    return false if project_paths.length == 0
+    proj = Xcodeproj::Project.open(project_paths[0])
+
+    # Get Main Target's Basic Info
+    @target = nil
+    proj.targets.each do |t|
+      if t.to_s == target
+        @target = t
+        Longbow::blue '  ' + target + ' found.' unless $nolog
+        break
+      end
+    end
+
+    #puts proj.pretty_print
+
+    # Create Target if Necessary
+    main_target = proj.targets.first
+    @target = create_target(proj, target) unless @target
+
+    # Plist Creating/Adding
+    main_plist = main_target.build_configurations[0].build_settings['INFOPLIST_FILE']
+
+    main_plist.sub! '$(SRCROOT)/', ''
+    main_plist_contents = File.read(directory + '/' + main_plist)
+    target_plist_path = directory + '/' + main_plist.split('/')[0] + '/' + target + '-info.plist'
+    plist_text = Longbow::create_plist_from_old_plist main_plist_contents, info_keys, global_keys
+    File.open(target_plist_path, 'w') do |f|
+      f.write(plist_text)
+    end
+    Longbow::green '  - ' + target + '-info.plist Updated.' unless $nolog
+    
+    # Add Build Settings
+    @target.build_configurations.each do |b|
+      # Main Settings
+      main_settings = nil
+      base_config = nil
+      main_target.build_configurations.each do |bc|
+        main_settings = bc.build_settings if bc.to_s == b.to_s
+        base_config = bc.base_configuration_reference if bc.to_s == b.to_s
+      end
+      settings = b.build_settings
+
+      if main_settings
+        main_settings.each_key do |key|
+          settings[key] = main_settings[key]
+        end
+      end
+      # Plist & Icons
+      settings['INFOPLIST_FILE'] = main_plist.split('/')[0] + '/' + target + '-info.plist'
+      settings['ASSETCATALOG_COMPILER_APPICON_NAME'] = Longbow::stripped_text(target) if icon
+      settings['ASSETCATALOG_COMPILER_LAUNCHIMAGE_NAME'] = Longbow::stripped_text(target) if launch
+      settings['SKIP_INSTALL'] = 'NO'
+
+      if File.exists? directory + '/Pods'
+        b.base_configuration_reference = base_config
+        settings['PODS_ROOT'] = '${SRCROOT}/Pods'
+      end
+    end
+
+    # Save The Project
+    proj.save
+  end
+
+  def self.create_target project, target
+    main_target = project.targets.first
+    deployment_target = main_target.deployment_target
+
+    # Create New Target
+    new_target = Xcodeproj::Project::ProjectHelper.new_target project, :application, target, :ios, deployment_target, project.products_group, 'en'
+    if new_target
+      # Add Build Phases
+      main_target.build_phases.objects.each do |b|
+        if b.isa == 'PBXSourcesBuildPhase'
+          b.files_references.each do |f|
+            new_target.source_build_phase.add_file_reference f
+          end
+        elsif b.isa == 'PBXFrameworksBuildPhase'
+          b.files_references.each do |f|
+            new_target.frameworks_build_phase.add_file_reference f
+          end
+        elsif b.isa == 'PBXResourcesBuildPhase'
+          b.files_references.each do |f|
+            new_target.resources_build_phase.add_file_reference f
+          end
+        elsif b.isa == 'PBXShellScriptBuildPhase'
+          phase = new_target.new_shell_script_build_phase(name = b.display_name)
+          phase.shell_script = b.shell_script
+        end
+      end
+
+      Longbow::blue '  ' + target + ' created.' unless $nolog
+    else
+      puts
+      Longbow::red '  Target Creation failed for target named: ' + target
+      puts
+    end
+
+    return new_target
+  end
+
+end

data/lib/longbow/utilities.rb

@@ -0,0 +1,8 @@
+$:.push File.expand_path('../', __FILE__)
+
+module Longbow
+  # Strip Non-Alphanumerics
+  def self.stripped_text text
+    return text.gsub(/[^0-9a-z ]/i, '')
+  end
+end

data/lib/longbow/version.rb

@@ -0,0 +1,12 @@
+$:.push File.expand_path('../', __FILE__)
+require 'colors'
+
+module Longbow
+  VERSION = '0.1.0'
+
+  def self.check_for_newer_version
+    unless Gem.latest_version_for('longbow').to_s == VERSION
+      Longbow::purple "\n  A newer version of longbow is available. Run '[sudo] gem update longbow'."
+    end
+  end
+end

data/resources/aim.sh

@@ -0,0 +1,31 @@
+#!/bin/bash
+set -e  # Bomb on any script errors
+target_string="$1"
+verbose=false
+if [ -n "$2" ]; then
+  verbose=true
+fi
+
+function main {
+	# Get targets into an array, run 'em
+	IFS=',' read -a targets <<< "$target_string"
+	for target in "${targets[@]}"; do
+		_run_target $target;
+	done
+	# Remove files added by ruby script
+	rm "capture.js"
+	rm "config-screenshots.sh"
+	rm "ui-screen-shooter.sh"
+	rm "unix_instruments.sh"
+}
+
+function _run_target {
+	echo "  Running $1"
+	if [ "$verbose" = true ]; then
+		source ui-screen-shooter.sh "$HOME/Desktop/screenshots/$1" "$1"
+	else
+		source ui-screen-shooter.sh "$HOME/Desktop/screenshots/$1" "$1" >/dev/null 2>/dev/null
+	fi
+}
+
+main

data/resources/capture.js

@@ -0,0 +1,84 @@
+// 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.
+
+var kPortraitString = "portrait"
+var kLandscapeString = "landscape"
+
+var kMaxDimension4inch = 568;
+var kMaxDimension4point7inch = 667;
+var kMaxDimension5point5inch = 736;
+
+// rectMaxSizeMatchesPhoneWithMaxDimensionForOrientation(rect, maxDimension, orientation)
+//
+// Returns whether the given rect matches a given max dimension in a particular orientation.
+//
+// `rect` is the rectangle representing the image size you want to check
+// `maxDimension` is the size of the longest side of the screen on a given device
+// `orientation` is...well...duh!
+//
+function rectMaxSizeMatchesPhoneWithMaxDimensionForOrientation(rect, maxDimension, orientation) {
+  return (orientation == kPortraitString && rect.size.height == maxDimension) || (orientation == kLandscapeString && rect.size.width == maxDimension)
+}
+
+// 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 = kPortraitString;
+  if (rect.size.height < rect.size.width) {
+    orientation = kLandscapeString;
+  }
+
+  if (model.match(/iPhone/)) {
+    if (rectMaxSizeMatchesPhoneWithMaxDimensionForOrientation(rect, kMaxDimension4inch, orientation)) {
+      model = "iOS-4-in";
+    }
+    else if (rectMaxSizeMatchesPhoneWithMaxDimensionForOrientation(rect, kMaxDimension4point7inch, orientation)) {
+      model = "iOS-4.7-in";
+    }
+    else if (rectMaxSizeMatchesPhoneWithMaxDimensionForOrientation(rect, kMaxDimension5point5inch, orientation)) {
+      model = "iOS-5.5-in";
+    }
+    else {
+      model = "iOS-3.5-in";
+    }
+  } else {
+    model = "iOS-iPad";
+  }
+
+  var parts = [model, orientation, name];
+  target.captureScreenWithName(parts.join("___"));
+}

data/resources/config-screenshots.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+# This is an example configuration file to be used with ui-screen-shooter
+# It is designed to work with the Hello World International application
+# Please copy to config-screenshots.sh and edit for your needs
+
+
+# LOCALE
+# ======
+# Set the locales here in which your screenshots should be made.
+# Use format like en-US zh-Hans for filenames compatible with iTMSTransporter
+# Note: to get the locale names for your existing app:
+#  - Download .itmsp file with iTMSTransporter
+#  - Run `grep locale ~/Desktop/*.itmsp/metadata.xml  | grep name | sort -u`
+
+export languages="en-US"
+
+
+# SIMULATORS
+# ==========
+# The simulators we want to run the script against, declared as a Bash array.
+# Run `instruments -s devices` to get a list of all the possible string values.
+
+declare -xa simulators=(
+"iPhone 6 (8.1 Simulator)",
+"iPhone 6 Plus (8.1 Simulator)",
+"iPhone 5S (8.1 Simulator)",
+"iPhone 4S (8.1 Simulator)"
+)

data/resources/ui-screen-shooter.sh

@@ -0,0 +1,206 @@
+#!/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"
+
+function main {
+  # Load configuration
+  # Not in a separate function because you can't exort arrays
+  # https://stackoverflow.com/questions/5564418/exporting-an-array-in-bash-script
+  # Will export languages and simulators bash variables
+  export UISS_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+  if [ -f "$UISS_DIR"/config-screenshots.sh ]; then
+    source "$UISS_DIR"/config-screenshots.sh
+  else
+    if [ -f "$UISS_DIR"/config-screenshots.example.sh ]; then
+      source "$UISS_DIR"/config-screenshots.example.sh
+      echo "WARNING: Using example config-screenshots file, you should create your own"
+    else
+      echo "Configuration \"config-screenshots.sh\" does not exist! Aborting."
+      exit 1
+    fi
+  fi
+
+  _check_destination
+  _check_ui_script
+  _check_scheme_name
+  _xcode clean build
+
+  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="./config-automation.js"
+  fi
+  if [ ! -f "$ui_script" ]; then
+    if [ -f "./config-automation.example.js" ]; then
+      ui_script="./config-automation.js"
+      echo "WARNING: Using example config-automation, please create your own"
+    else
+      echo "Config-automation does not exist! Aborting."
+      exit 1
+    fi
+  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 Debug \
+      PRODUCT_NAME="$scheme_name" \
+      DSTROOT=$build_dir \
+      OBJROOT=$build_dir \
+      SYMROOT=$build_dir \
+      ONLY_ACTIVE_ARCH=NO \
+    "$@"
+    xcodebuild -sdk "iphonesimulator$ios_version" \
+      CONFIGURATION_BUILD_DIR="$build_dir/build" \
+      -workspace "$base.xcworkspace" -scheme "$scheme_name" -configuration Debug \
+      PRODUCT_NAME="$scheme_name" \
+      DSTROOT=$build_dir \
+      OBJROOT=$build_dir \
+      SYMROOT=$build_dir \
+      ONLY_ACTIVE_ARCH=NO \
+    "$@"
+    cp -r "$build_dir/build/$scheme_name.app" "$build_dir"
+    bundle_dir="$build_dir/$scheme_name.app"
+  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="Automation"
+
+  # 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 _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
+