snapshot 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1fe56d81aa604485820010eadd10d664dc2e074b
-  data.tar.gz: 0bf22a8fe033bf484bd05ea35524ce6ae549e157
+  metadata.gz: e7362693e9f1c922a699d79e0d24fc6f5ec122ff
+  data.tar.gz: ac6413d4502074b7ddd4fb140228cb97dc2cb7b3
 SHA512:
-  metadata.gz: ba23be45519c941df5c1a9eeaf8376cda8afeb5a1caaefcc5faa9f6a7188c7be595ed3b55e57ab5cf16730e45b26bc1329f4d7aa9fc8c5083975476c61096957
-  data.tar.gz: 70a024e17730c0ada7b14679b07de7bf3281257d776554a8c8509378b4edd922663c692b51054321f553aa8bb4e6c06864e507896d69d1dee34e2934bfb9ecde
+  metadata.gz: c0e83d4693307a5f46e9b7f120cc76c42ad7ee6aa7a3642db09b178c8bc756889b17565c93c2ce549311cd3a38b47ece61623bd9e17f9dea554d65c39190a6ff
+  data.tar.gz: 811d67b6f62e29423c84222269805b7e3e2effa328711933ab9447818aaa966fdd928be623199cf70542b966d132eda40e6d5ced86cdc439fbe38328aea3fb92

data/README.md

@@ -225,6 +225,8 @@ js_file './path/file.js'
 
 You can add a custom script for iPads: `./path/file-iPad.js` and it will automatically be used if found. Just append the `-iPad` to your existing file.
 
+If you want to overwrite the JS path using environment variables, use `SNAPSHOT_JS_FILE`.
+
 ### Scheme
 To not be asked which scheme to use, just set it like this:
 ```ruby
@@ -252,15 +254,31 @@ I'll try to keep the script up to date. If you need to change the iOS version, y
 ios_version "9.0"
 ```
 
+### HTML Title
+
+If you want to change the title of the generated HTML page, you can use:
+
+```ruby
+html_title 'Example'
+```
+
 ### Custom Args for the build command
 Use the ```custom_args``` directive to prepend custom statements to the build command.
 
 Add a ```custom_build_args``` line to your ```Snapfile``` to add custom arguments to the build command.
 
-Here is an example for adding a preprocessor macro `SNAPSHOT` and  a custom build setting `SNAPSHOT_ENABLE`.
+Here is an example for adding a preprocessor macro `SNAPSHOT`:
 
 ```ruby
-custom_build_args "GCC_PREPROCESSOR_DEFINITIONS='$(inherited) SNAPSHOT=1' SNAPSHOT_ENABLE = YES"
+custom_build_args "GCC_PREPROCESSOR_DEFINITIONS='$(inherited) SNAPSHOT=1'"
+```
+
+In your Objective-C code, use the following code to detect the `snapshot` mode:
+
+```objective-c
+#ifdef SNAPSHOT
+// Your Code here
+#endif
 ```
 
 ### Custom Args for the run command
@@ -286,6 +304,8 @@ This can be used to
 - Reset all user defaults
 - Pre-fill the database
 
+The `setup_for_device_change` will be called **before** the app is installed on the simulator.
+
 To run a shell script, just use ```system('./script.sh')```.
 ```ruby
 setup_for_device_change do |device, udid, language|
@@ -299,8 +319,6 @@ teardown_device do |language, device|
 end
 ```
 
-If you want to run a script before each run of the app, it's enough to only implement the `setup_for_language_change` callback.
-
 ### Skip alpha removal from screenshots
 In case you want to skip this process, just add ```skip_alpha_removal``` to your ```Snapfile```.
 
@@ -345,6 +363,10 @@ You can use the environment variable `SNAPSHOT_FORCE_DELETE` to stop asking for
 
 ##### [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).
+
 ## Run in Continuous Integration
 If you want to run `snapshot` on your `Jenkins` machine (or any other CI-system), you might run into an `authorization` popup coming up.
 
@@ -405,6 +427,13 @@ Unfortunately, Xamarin command line tool is only available for Business Edition
 
 If building via command-line doesn't work for your project or you don't want to build every time, you can run the tool with ```snapshot --nobuild``` to skip the build process and use a pre-built ```.app``` under your ```build_dir```.
 
+### Simulator doesn't launch the application
+
+When the app dies directly after the application is launched there might be 2 problems
+
+- The simulator is somehow in a broken state and you need to re-create it. You can use `snapshot reset_simulators` to reset all simulators (this will remove all installed apps)
+- You haven't enabled the correct architectures. Make sure you have the same architectures as in the example project of this repository. 
+
 ## Determine language in UI Automation script
 
 To detect the currently used localization in your Javascript file, use the following code:

data/bin/snapshot

@@ -19,12 +19,12 @@ class SnapshotApplication
     program :help, 'Author', 'Felix Krause <snapshot@krausefx.com>'
     program :help, 'Website', 'https://fastlane.tools'
     program :help, 'GitHub', 'https://github.com/krausefx/snapshot'
-    # program :help_formatter, :compact # https://github.com/commander-rb/commander/issues/12
+    program :help_formatter, :compact
 
     global_option '--snapfile PATH', String, 'Custom path for your Snapfile.'
     global_option '--nobuild', 'Skips the build process when running snapshot.'
     global_option '--noclean', 'Skips the clean process of the build command when running snapshot.'
-    global_option('--verbose', 'Shows all output printed by Instruments.') { $verbose = true }
+    global_option('--verbose', 'Shows more output including all output printed by Instruments.') { $verbose = true }
 
     always_trace!
 

data/lib/assets/SnapshotHelper.js

@@ -14,6 +14,11 @@ function wait_for_loading_indicator_to_be_finished()
   } catch (e) {}
 }
 
+function isTablet()
+{
+  return !(UIATarget.localTarget().model().match(/iPhone/))
+}
+
 function captureLocalizedScreenshot(name) {
   wait_for_loading_indicator_to_be_finished();
 
@@ -38,7 +43,7 @@ function captureLocalizedScreenshot(name) {
   } 
   else 
   {
-    model = "iOS-iPad";
+    model = "iPad";
   }
 
   var orientation = "portrait";

data/lib/snapshot/dependency_checker.rb

@@ -19,7 +19,7 @@ module Snapshot
     end
 
     def self.check_simulators
-      Helper.log.debug "Found #{Simulators.available_devices.count} simulators."
+      Helper.log.debug "Found #{Simulators.available_devices.count} simulators." if $verbose
       if Simulators.available_devices.count < 1
         Helper.log.fatal '#############################################################'
         Helper.log.fatal "# You have to add new simulators using Xcode"

data/lib/snapshot/page.html.erb

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
   <head>
-    <title>KrauseFx/snapshot</title>
+    <title><%= @title %></title>
     <meta charset="UTF-8">
     <style type="text/css">
       * {
@@ -83,10 +83,7 @@
             <% screens.each do |screen_path| %>
               <% next if screen_path.include?"_framed.png" %>
               <td>
-                <% screen_size = FastImage.size(File.join(SnapshotConfig.shared_instance.screenshots_path, screen_path)) %>
-                <% width = ((screen_size[0] / divide_size_by).round rescue 0) %>
-                <% width = [width, max_width].min %>
-                <% style = (width > 0 ? "width: #{width}px;" : '') %>
+                <% style = "width: 100%;" %>
                 <% image_counter += 1 %>
                 <a href="<%= screen_path %>" target="_blank" class="screenshotLink">
                   <img class="screenshot"
@@ -136,7 +133,7 @@
             tmpImg.src = img.src;
             imageDisplay.style.height     = 'auto';
             imageDisplay.style.width     = 'auto';
-            imageDisplay.style.paddingTop   = '0px';
+            imageDisplay.style.paddingTop   = '20px';
             if (window.innerHeight < tmpImg.height) {
               imageDisplay.style.height = document.documentElement.clientHeight+'px';
             } else if (window.innerWidth < tmpImg.width) {
@@ -182,7 +179,6 @@
       document.onkeypress = function(e) {
         e = e || window.event;
         var charCode = e.keyCode || e.which;
-
         switch(charCode) {
           case 27: // Esc
             overlay.style.display = "none";

data/lib/snapshot/reports_generator.rb

@@ -4,8 +4,11 @@ require 'fastimage'
 module Snapshot
   class ReportsGenerator
     def generate
-      screens_path = SnapshotConfig.shared_instance.screenshots_path
 
+      config = SnapshotConfig.shared_instance
+      screens_path = config.screenshots_path
+
+      @title = config.html_title    
       @data = {}
 
       Dir["#{screens_path}/*"].sort.each do |language_path|
@@ -57,7 +60,8 @@ module Snapshot
           'iPhone6' => "iPhone 6",
           'iPhone5' => "iPhone 5",
           'iPhone4' => "iPhone 4",
-          'iOS-iPad' => "iPad"
+          'iPad' => "iPad",
+          'Mac' => "Mac"
         }
       end
   end

data/lib/snapshot/runner.rb

@@ -14,7 +14,10 @@ module Snapshot
       counter = 0
       errors = []
 
-      FileUtils.rm_rf SnapshotConfig.shared_instance.screenshots_path if (SnapshotConfig.shared_instance.clear_previous_screenshots and take_snapshots)
+      if (SnapshotConfig.shared_instance.clear_previous_screenshots and take_snapshots)
+        path_to_clear = (SnapshotConfig.shared_instance.screenshots_path + "/*-*/*.png") # languages always contain a `-`
+        Dir[path_to_clear].each { |a| File.delete(a) } # no idea why rm_rf doesn't work
+      end
 
       SnapshotConfig.shared_instance.devices.each do |device|
         SnapshotConfig.shared_instance.languages.each do |language_item|
@@ -26,17 +29,20 @@ module Snapshot
             (language, locale) = language_item            
           end
 
-          reinstall_app(device, language, locale) unless ENV["SNAPSHOT_SKIP_UNINSTALL"]
 
           prepare_simulator(device, language)
+
+          reinstall_app(device, language, locale) unless ENV["SNAPSHOT_SKIP_UNINSTALL"]
           
           begin
             errors.concat(run_tests(device, language, locale))
-            counter += copy_screenshots(language) if take_snapshots
           rescue => ex
             Helper.log.error(ex)
           end
 
+          # we also want to see the screenshots when something went wrong
+          counter += copy_screenshots(language) if take_snapshots 
+
           teardown_simulator(device, language)
 
           break if errors.any? && ENV["SNAPSHOT_BREAK_ON_FIRST_ERROR"]
@@ -87,14 +93,15 @@ module Snapshot
     end
 
     def reinstall_app(device, language, locale)
+      Helper.log.info "Reinstalling app...".yellow unless $verbose
 
       app_identifier = ENV["SNAPSHOT_APP_IDENTIFIER"]
       app_identifier ||= @app_identifier
 
       def com(cmd)
-        puts cmd.magenta
-        result = `#{cmd}`
-        puts result if result.to_s.length > 0
+        puts cmd.magenta if $verbose
+        result = `#{cmd} 2>&1` # to now show errors
+        puts result if (result.to_s.length > 0 and $verbose)
       end
 
       udid = udid_for_simulator(device)
@@ -161,7 +168,7 @@ module Snapshot
       end
 
       if retry_run
-        Helper.log.error "Instruments tool failed again. Re-trying..."
+        Helper.log.error "Instruments tool failed again. Re-trying..." if $verbose
         sleep 2 # We need enough sleep... that's an instruments bug
         errors = run_tests(device, language, locale)
       end
@@ -173,16 +180,19 @@ module Snapshot
       # Determine the path to the actual app and not the WatchKit app
       build_dir = SnapshotConfig.shared_instance.build_dir || '/tmp/snapshot'
       Dir.glob("#{build_dir}/**/*.app/*.plist").each do |path|
-        watchkit_enabled = `/usr/libexec/PlistBuddy -c 'Print WKWatchKitApp' '#{path}'`.strip
+        # `2>&1` to hide the error if it's not there: http://stackoverflow.com/a/4783536/445598
+        watchkit_enabled = `/usr/libexec/PlistBuddy -c 'Print WKWatchKitApp' '#{path}' 2>&1`.strip
         next if watchkit_enabled == 'true' # we don't care about WatchKit Apps
 
-        app_identifier = `/usr/libexec/PlistBuddy -c 'Print CFBundleIdentifier' '#{path}'`.strip
+        app_identifier = `/usr/libexec/PlistBuddy -c 'Print CFBundleIdentifier' '#{path}' 2>&1`.strip
         if app_identifier and app_identifier.length > 0
           # This seems to be the valid Info.plist
           @app_identifier = app_identifier
           return File.expand_path("..", path) # the app
         end
       end
+
+      raise "Could not find app in '#{build_dir}'. Make sure you're following the README and set the build directory to the correct path.".red
     end
 
     def parse_test_line(line)

data/lib/snapshot/screenshot_flatten.rb

@@ -9,7 +9,7 @@ module Snapshot
 
     def flatten(path)
       Dir.glob([path, '/**/*.png'].join('/')).each do |file|
-        Helper.log.info "Removing alpha channel from '#{file}'"
+        Helper.log.info "Removing alpha channel from '#{file}'" if $verbose
         `sips -s format bmp '#{file}' &> /dev/null ` # &> /dev/null because there is warning because of the extension
         `sips -s format png '#{file}'`
       end

data/lib/snapshot/screenshot_rotate.rb

@@ -11,7 +11,7 @@ module Snapshot
 
     def rotate(path)
       Dir.glob([path, '/**/*.png'].join('/')).each do |file|
-        Helper.log.debug "Rotating '#{file}'"
+        Helper.log.debug "Rotating '#{file}'" if $verbose
 
         command = nil
         if file.end_with? "landscapeleft.png"

data/lib/snapshot/snapshot_config.rb

@@ -49,6 +49,8 @@ module Snapshot
     # @return (Hash) All the blocks, which are called on specific actions
     attr_accessor :blocks
 
+    attr_accessor :html_title
+
 
     # A shared singleton
     def self.shared_instance(path = nil)
@@ -62,7 +64,7 @@ module Snapshot
       set_defaults
 
       if File.exists?path
-        Helper.log.info "Using '#{path}'".green
+        Helper.log.info "Using '#{path}'".green if $verbose
         self.snapshot_file = SnapshotFile.new(path, self)
 
         self.verify_devices
@@ -105,6 +107,9 @@ module Snapshot
         setup_for_language_change: empty,
         teardown_language: empty
       }
+
+      self.html_title = self.project_name || 'KrauseFx/snapshot'
+
     end
 
     # This has to be done after parsing the Snapfile (iOS version)
@@ -149,6 +154,8 @@ module Snapshot
 
     # The JavaScript UIAutomation file
     def js_file(ipad = false)
+      return ENV["SNAPSHOT_JS_FILE"] if ENV["SNAPSHOT_JS_FILE"]
+      
       result = manual_js_file
 
       unless result
@@ -178,10 +185,11 @@ module Snapshot
         project_key = 'project'
         project_key = 'workspace' if project_path.end_with?'.xcworkspace'
         command = "xcodebuild -#{project_key} '#{project_path}' -list"
-        Helper.log.debug command
+        Helper.log.debug command if $verbose
         
         schemes = `#{command}`.split("Schemes:").last.split("\n").each { |a| a.strip! }.delete_if { |a| a == '' }
-        Helper.log.debug "Found available schemes: #{schemes}"
+        
+        Helper.log.debug "Found available schemes: #{schemes}" if $verbose
 
         self.manual_scheme = schemes.first if schemes.count == 1
 

data/lib/snapshot/snapshot_file.rb

@@ -76,6 +76,9 @@ module Snapshot
           raise "#{method_sym} needs to have a block provided." unless block_given?
           Helper.log.warn("'setup_for_language_change' and 'teardown_language' are deprecated.".yellow) if [:setup_for_language_change, :teardown_language].include?method_sym
           @config.blocks[method_sym] = block
+        when :html_title 
+          raise "html_title has to be an String".red unless value.kind_of?String
+          @config.html_title = value
         else
           Helper.log.error "Unknown method #{method_sym}"
         end

data/lib/snapshot/version.rb

@@ -1,3 +1,3 @@
 module Snapshot
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snapshot
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-03 00:00:00.000000000 Z
+date: 2015-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastimage
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.7.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement