snapshot 1.11.1 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c170770aac05bc57d39e39fd2b7cbf1e6b028c5c
-  data.tar.gz: 464bc150daa1faee0c65064203800fe4af5836b7
+  metadata.gz: a7f61f2f3c7aa60d70e206209b8d11396233590a
+  data.tar.gz: eb1d37214aa896123087ee76ad074d03f0852231
 SHA512:
-  metadata.gz: db251e93a1991fa4ea261fe667ea4fa5ef996a4e4891b6a37d30ad0db4e9235807040395dc8659e56b0794dfc0855c98852fed8a1901099e1657efcc36475c1b
-  data.tar.gz: 78d20002241921a55701f8baa750d9737660e9971e1b4f0e9bb4b134b962622e8c8268e5b4fe2a219f2afb428876983acf340585ec14da6d7ef42f4daf1aad5f
+  metadata.gz: dd88feb6567be7d744de8666406162b0241618a542e4a0deaa9bfaa5c7c6188714e745e7ac13f1de5c8f81ca8276623ab68d3431a743ed875d198dab6db71b20
+  data.tar.gz: 6ae65a84f6518243ca080a1c3aebe906e0556bfe6b33175b5737f8a1b2b305f0b3c0ef2a6611e4da9addd8c844a8a5627d7b1d12ed1236f5cf6ca6a4edae6967

data/README.md

@@ -1,24 +1,24 @@
 <h3 align="center">
-  <a href="https://github.com/fastlane/fastlane">
-    <img src="assets/fastlane.png" width="150" />
+  <a href="https://github.com/fastlane/fastlane/tree/master/fastlane">
+    <img src="../fastlane/assets/fastlane.png" width="150" />
     <br />
     fastlane
   </a>
 </h3>
 <p align="center">
-  <a href="https://github.com/fastlane/deliver">deliver</a> &bull; 
-  <b>snapshot</b> &bull; 
-  <a href="https://github.com/fastlane/frameit">frameit</a> &bull; 
-  <a href="https://github.com/fastlane/pem">pem</a> &bull; 
-  <a href="https://github.com/fastlane/sigh">sigh</a> &bull; 
-  <a href="https://github.com/fastlane/produce">produce</a> &bull;
-  <a href="https://github.com/fastlane/cert">cert</a> &bull;
-  <a href="https://github.com/fastlane/spaceship">spaceship</a> &bull;
-  <a href="https://github.com/fastlane/pilot">pilot</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/deliver">deliver</a> &bull;
+  <b>snapshot</b> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/frameit">frameit</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/pem">pem</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/sigh">sigh</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/produce">produce</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/cert">cert</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/spaceship">spaceship</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/pilot">pilot</a> &bull;
   <a href="https://github.com/fastlane/boarding">boarding</a> &bull;
-  <a href="https://github.com/fastlane/gym">gym</a> &bull;
-  <a href="https://github.com/fastlane/scan">scan</a> &bull;
-  <a href="https://github.com/fastlane/match">match</a>
+  <a href="https://github.com/fastlane/fastlane/tree/master/gym">gym</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/scan">scan</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/match">match</a>
 </p>
 -------
 
@@ -30,7 +30,7 @@ snapshot
 ============
 
 [![Twitter: @FastlaneTools](https://img.shields.io/badge/contact-@FastlaneTools-blue.svg?style=flat)](https://twitter.com/FastlaneTools)
-[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/fastlane/snapshot/blob/master/LICENSE)
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/fastlane/fastlane/blob/master/snapshot/LICENSE)
 [![Gem](https://img.shields.io/gem/v/snapshot.svg?style=flat)](http://rubygems.org/gems/snapshot)
 
 ###### Automate taking localized screenshots of your iOS app on every device
@@ -43,7 +43,7 @@ It's hard to get everything right!
 - No loading indicators
 - Same content / screens
 - [Clean Status Bar](#use-a-clean-status-bar)
-- Uploading screenshots ([`deliver`](https://github.com/fastlane/deliver) is your friend)
+- Uploading screenshots ([`deliver`](https://github.com/fastlane/fastlane/tree/master/deliver) is your friend)
 
 More information about [creating perfect screenshots](https://krausefx.com/blog/creating-perfect-app-store-screenshots-of-your-ios-app).
 
@@ -57,7 +57,7 @@ Apple announced a new version of Xcode with support for UI Tests built in right
 
 As a result, `snapshot` was completely rewritten from ground up without changing its public API.
 
-Please check out the [MigrationGuide to 1.0](/MigrationGuide.md) :+1:
+Please check out the [MigrationGuide to 1.0](/snapshot/MigrationGuide.md) :+1:
 
 **Why change to UI Tests?**
 
@@ -69,13 +69,13 @@ Please check out the [MigrationGuide to 1.0](/MigrationGuide.md) :+1:
 
 -------
 <p align="center">
-    <a href="#features">Features</a> &bull; 
-    <a href="#installation">Installation</a> &bull; 
-    <a href="#ui-tests">UI Tests</a> &bull; 
-    <a href="#quick-start">Quick Start</a> &bull; 
-    <a href="#usage">Usage</a> &bull; 
-    <a href="#tips">Tips</a> &bull; 
-    <a href="#how-does-it-work">How?</a> &bull; 
+    <a href="#features">Features</a> &bull;
+    <a href="#installation">Installation</a> &bull;
+    <a href="#ui-tests">UI Tests</a> &bull;
+    <a href="#quick-start">Quick Start</a> &bull;
+    <a href="#usage">Usage</a> &bull;
+    <a href="#tips">Tips</a> &bull;
+    <a href="#how-does-it-work">How?</a> &bull;
     <a href="#need-help">Need help?</a>
 </p>
 
@@ -87,7 +87,7 @@ Please check out the [MigrationGuide to 1.0](/MigrationGuide.md) :+1:
 - Create hundreds of screenshots in multiple languages on all simulators
 - Configure it once, store the configuration in git
 - Do something else, while the computer takes the screenshots for you
-- Integrates with [`fastlane`](https://fastlane.tools) and [`deliver`](https://github.com/fastlane/deliver)
+- Integrates with [`fastlane`](https://fastlane.tools) and [`deliver`](https://github.com/fastlane/fastlane/tree/master/deliver)
 - Generates a beautiful web page, which shows all screenshots on all devices. This is perfect to send to Q&A or the marketing team
 - `snapshot` automatically waits for network requests to be finished before taking a screenshot (we don't want loading images in the App Store screenshots)
 
@@ -120,11 +120,11 @@ Install the gem
 Make sure, you have the latest version of the Xcode command line tools installed:
 
     xcode-select --install
-    
+
 # UI Tests
 
 ## Getting started
-This project uses Apple's newly announced UI Tests. I will not go into detail on how to write scripts. 
+This project uses Apple's newly announced UI Tests. I will not go into detail on how to write scripts.
 
 Here a few links to get started:
 
@@ -141,13 +141,13 @@ Here a few links to get started:
 - Create a new UI Test target in your Xcode project ([top part of this article](https://krausefx.com/blog/run-xcode-7-ui-tests-from-the-command-line))
 - Run `snapshot init` in your project folder
 - Add the ./SnapshotHelper.swift to your UI Test target (You can move the file anywhere you want)
-- (Objective C only) add the bridging header to your test class. 
+- (Objective C only) add the bridging header to your test class.
  - `#import "MYUITests-Swift.h"`
  - The bridging header is named after your test target with -Swift.h appended.
 - In your UI Test class, click the `Record` button on the bottom left and record your interaction
 - To take a snapshot, call the following between interactions
  -  Swift: `snapshot("01LoginScreen")`
- -  Objective C: `[Snapshot snapshot:@"01LoginScreen" waitForLoadingIndicator:YES];` 
+ -  Objective C: `[Snapshot snapshot:@"01LoginScreen" waitForLoadingIndicator:YES];`
 - Add the following code to your `setUp()` method
 
 **Swift**
@@ -193,7 +193,7 @@ There are a lot of options available that define how to build your app, for exam
 
 ```sh
 snapshot --scheme "UITests" --configuration "Release"  --sdk "iphonesimulator"
-``` 
+```
 
 Reinstall the app before running `snapshot`
 
@@ -268,7 +268,7 @@ You can run this command in the terminal to delete and re-create all iOS simulat
 snapshot reset_simulators
 ```
 
-**Warning**: This will delete **all** your simulators and replace by new ones! This is useful, if you run into weird problems when running `snapshot`. 
+**Warning**: This will delete **all** your simulators and replace by new ones! This is useful, if you run into weird problems when running `snapshot`.
 
 You can use the environment variable `SNAPSHOT_FORCE_DELETE` to stop asking for confirmation before deleting.
 
@@ -276,13 +276,13 @@ You can use the environment variable `SNAPSHOT_FORCE_DELETE` to stop asking for
 
 Some updates require the helper files to be updated. `snapshot` will automatically warn you and tell you how to update.
 
-Basically you can run 
+Basically you can run
 
 ```
 snapshot update
 ```
 
-to update your `SnapshotHelper.swift` files. In case you modified your `SnapshotHelper.swift` and want to manually update the file, check out [SnapshotHelper.swift](https://github.com/fastlane/snapshot/blob/master/lib/assets/SnapshotHelper.swift).
+to update your `SnapshotHelper.swift` files. In case you modified your `SnapshotHelper.swift` and want to manually update the file, check out [SnapshotHelper.swift](https://github.com/fastlane/fastlane/blob/master/snapshot/lib/assets/SnapshotHelper.swift).
 
 ## Launch Arguments
 
@@ -325,7 +325,7 @@ When you run unit tests in Xcode, the reporter generates a plist file, documenti
 
 When the user calls `snapshot(...)` in the UI Tests (Swift or Objective C) the script actually does a rotation to `.Unknown` which doesn't have any effect on the actual app, but is enough to trigger a screenshot. It has no effect to the application and is not something you would do in your tests. The goal was to find *some* event that a user would never trigger, so that we know it's from `snapshot`.
 
-`snapshot` then iterates through all test events and check where we did this weird rotation. Once `snapshot` has all events triggered by `snapshot` it collects a ordered list of all the file names of the actual screenshots of the application. 
+`snapshot` then iterates through all test events and check where we did this weird rotation. Once `snapshot` has all events triggered by `snapshot` it collects a ordered list of all the file names of the actual screenshots of the application.
 
 In the test output, the Swift `snapshot` function will print out something like this
 
@@ -347,24 +347,24 @@ Also, feel free to duplicate radar [23062925](https://openradar.appspot.com/rada
 ## [`fastlane`](https://fastlane.tools) Toolchain
 
 - [`fastlane`](https://fastlane.tools): Connect all deployment tools into one streamlined workflow
-- [`deliver`](https://github.com/fastlane/deliver): Upload screenshots, metadata and your app to the App Store
-- [`frameit`](https://github.com/fastlane/frameit): Quickly put your screenshots into the right device frames
-- [`PEM`](https://github.com/fastlane/pem): Automatically generate and renew your push notification profiles
-- [`sigh`](https://github.com/fastlane/sigh): Because you would rather spend your time building stuff than fighting provisioning
-- [`produce`](https://github.com/fastlane/produce): Create new iOS apps on iTunes Connect and Dev Portal using the command line
-- [`cert`](https://github.com/fastlane/cert): Automatically create and maintain iOS code signing certificates
-- [`spaceship`](https://github.com/fastlane/spaceship): Ruby library to access the Apple Dev Center and iTunes Connect
-- [`pilot`](https://github.com/fastlane/pilot): The best way to manage your TestFlight testers and builds from your terminal
-- [`boarding`](https://github.com/fastlane/boarding): The easiest way to invite your TestFlight beta testers 
-- [`gym`](https://github.com/fastlane/gym): Building your iOS apps has never been easier
-- [`scan`](https://github.com/fastlane/scan): The easiest way to run tests of your iOS and Mac app
-- [`match`](https://github.com/fastlane/match): Easily sync your certificates and profiles across your team using git
+- [`deliver`](https://github.com/fastlane/fastlane/tree/master/deliver): Upload screenshots, metadata and your app to the App Store
+- [`frameit`](https://github.com/fastlane/fastlane/tree/master/frameit): Quickly put your screenshots into the right device frames
+- [`PEM`](https://github.com/fastlane/fastlane/tree/master/pem): Automatically generate and renew your push notification profiles
+- [`sigh`](https://github.com/fastlane/fastlane/tree/master/sigh): Because you would rather spend your time building stuff than fighting provisioning
+- [`produce`](https://github.com/fastlane/fastlane/tree/master/produce): Create new iOS apps on iTunes Connect and Dev Portal using the command line
+- [`cert`](https://github.com/fastlane/fastlane/tree/master/cert): Automatically create and maintain iOS code signing certificates
+- [`spaceship`](https://github.com/fastlane/fastlane/tree/master/spaceship): Ruby library to access the Apple Dev Center and iTunes Connect
+- [`pilot`](https://github.com/fastlane/fastlane/tree/master/pilot): The best way to manage your TestFlight testers and builds from your terminal
+- [`boarding`](https://github.com/fastlane/boarding): The easiest way to invite your TestFlight beta testers
+- [`gym`](https://github.com/fastlane/fastlane/tree/master/gym): Building your iOS apps has never been easier
+- [`scan`](https://github.com/fastlane/fastlane/tree/master/scan): The easiest way to run tests of your iOS and Mac app
+- [`match`](https://github.com/fastlane/fastlane/tree/master/match): Easily sync your certificates and profiles across your team using git
 
 ##### [Like this tool? Be the first to know about updates and new fastlane tools](https://tinyletter.com/krausefx)
 
 ## Frame the screenshots
 
-If you want to add frames around the screenshots and even put a title on top, check out [frameit](https://github.com/fastlane/frameit).
+If you want to add frames around the screenshots and even put a title on top, check out [frameit](https://github.com/fastlane/fastlane/tree/master/frameit).
 
 ## Available language codes
 ```ruby
@@ -398,7 +398,7 @@ You can access the language using the `deviceLanguage` variable.
 Please submit an issue on GitHub and provide information about your setup
 
 # Code of Conduct
-Help us keep `snapshot` open and inclusive. Please read and follow our [Code of Conduct](https://github.com/fastlane/code-of-conduct).
+Help us keep `snapshot` open and inclusive. Please read and follow our [Code of Conduct](https://github.com/fastlane/fastlane/blob/master/CODE_OF_CONDUCT.md).
 
 # License
 This project is licensed under the terms of the MIT license. See the LICENSE file.

data/bin/snapshot

@@ -10,6 +10,7 @@ HighLine.track_eof = false
 class SnapshotApplication
   include Commander::Methods
 
+  # rubocop:disable Metrics/MethodLength
   def run
     program :version, Snapshot::VERSION
     program :description, 'CLI for \'snapshot\' - Automate taking localized screenshots of your iOS app on every device'
@@ -29,9 +30,7 @@ class SnapshotApplication
       c.description = 'Take new screenshots based on the Snapfile.'
 
       c.action do |args, options|
-        o = options.__hash__.dup
-        o.delete(:verbose)
-        Snapshot.config = FastlaneCore::Configuration.create(Snapshot::Options.available_options, o)
+        load_config(options)
 
         Snapshot::DependencyChecker.check_simulators
         Snapshot::Runner.new.work
@@ -73,10 +72,37 @@ class SnapshotApplication
       end
     end
 
+    command :clear_derived_data do |c|
+      c.syntax = 'snapshot clear_derived_data -f path'
+      c.description = "Clear the directory where build products and other derived data will go"
+
+      c.action do |args, options|
+        load_config(options)
+        derived_data_path = Snapshot.config[:derived_data_path]
+
+        if !derived_data_path
+          Snapshot::UI.user_error! "No derived_data_path"
+        elsif !Dir.exist?(derived_data_path)
+          Snapshot::UI.important "Path #{derived_data_path} does not exist"
+        else
+          FileUtils.rm_rf(derived_data_path)
+          Snapshot::UI.success "Removed #{derived_data_path}"
+        end
+      end
+    end
+
     default_command :run
 
     run!
   end
+
+  private
+
+  def load_config(options)
+    o = options.__hash__.dup
+    o.delete(:verbose)
+    Snapshot.config = FastlaneCore::Configuration.create(Snapshot::Options.available_options, o)
+  end
 end
 
 begin

data/lib/snapshot/options.rb

@@ -144,7 +144,12 @@ module Snapshot
                                      env_name: 'SNAPSHOT_BREAK_ON_FIRST_ERROR',
                                      description: "Should snapshot stop immediately after the tests completely failed on one device?",
                                      default_value: false,
-                                     is_string: false)
+                                     is_string: false),
+        FastlaneCore::ConfigItem.new(key: :derived_data_path,
+                                     short_option: "-f",
+                                     env_name: "SNAPSHOT_DERIVED_DATA_PATH",
+                                     description: "The directory where build products and other derived data will go",
+                                     optional: true)
       ]
     end
   end

data/lib/snapshot/runner.rb

@@ -14,7 +14,7 @@ module Snapshot
         UI.error "Found old snapshot configuration file 'snapshot.js'"
         UI.error "You updated to snapshot 1.0 which now uses UI Automation"
         UI.error "Please follow the migration guide: https://github.com/fastlane/snapshot/blob/master/MigrationGuide.md"
-        UI.error "And read the updated documentation: https://github.com/fastlane/snapshot"
+        UI.error "And read the updated documentation: https://github.com/fastlane/fastlane/tree/master/snapshot"
         sleep 3 # to be sure the user sees this, as compiling clears the screen
       end
 
@@ -55,7 +55,9 @@ module Snapshot
       ReportsGenerator.new.generate
 
       # Clear the Derived Data
-      FileUtils.rm_rf(TestCommandGenerator.derived_data_path)
+      unless Snapshot.config[:derived_data_path]
+        FileUtils.rm_rf(TestCommandGenerator.derived_data_path)
+      end
     end
 
     # This is its own method so that it can re-try if the tests fail randomly

data/lib/snapshot/setup.rb

@@ -27,7 +27,7 @@ module Snapshot
       puts ""
       puts "3) Add `snapshot(\"0Launch\")` to wherever you want to create the screenshots".yellow
       puts ""
-      puts "More information on GitHub: https://github.com/fastlane/snapshot".green
+      puts "More information on GitHub: https://github.com/fastlane/fastlane/tree/master/snapshot".green
     end
   end
 end

data/lib/snapshot/test_command_generator.rb

@@ -53,7 +53,7 @@ module Snapshot
       end
 
       def pipe
-        ["| tee '#{xcodebuild_log_path}' | xcpretty #{Snapshot.config[:xcpretty_args]}"]
+        ["| tee #{xcodebuild_log_path.shellescape} | xcpretty #{Snapshot.config[:xcpretty_args]}"]
       end
 
       def device_udid(device)
@@ -88,7 +88,7 @@ module Snapshot
       end
 
       def derived_data_path
-        Snapshot.cache[:derived_data_path] ||= Dir.mktmpdir("snapshot_derived")
+        Snapshot.cache[:derived_data_path] ||= (Snapshot.config[:derived_data_path] || Dir.mktmpdir("snapshot_derived"))
       end
     end
   end

data/lib/snapshot/version.rb

@@ -1,4 +1,4 @@
 module Snapshot
-  VERSION = "1.11.1".freeze
+  VERSION = "1.12.0".freeze
   DESCRIPTION = "Automate taking localized screenshots of your iOS app on every device"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snapshot
 version: !ruby/object:Gem::Version
-  version: 1.11.1
+  version: 1.12.0
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-07 00:00:00.000000000 Z
+date: 2016-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastimage
@@ -176,14 +176,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.1
+        version: 0.38.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.1
+        version: 0.38.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement